A JavaScript SDK for Ethereum and the Compound Protocol. Wraps around Ethers.js. Works in the web browser and Node.js.
- +A JavaScript SDK for Ethereum and the Venus Protocol. Wraps around Ethers.js. Works in the web browser and Node.js.
+This SDK is in open beta, and is constantly under development. USE AT YOUR OWN RISK.
const Compound = require('@compound-finance/compound-js'); // in Node.js
-const cUsdtAddress = Compound.util.getAddress(Compound.cUSDT);
+ const Venus = require('@swipewallet/venus-js'); // in Node.js
+const cUsdtAddress = Venus.util.getAddress(Venus.vUSDT);
(async function() {
- let supplyRatePerBlock = await Compound.eth.read(
+ let supplyRatePerBlock = await Venus.eth.read(
cUsdtAddress,
'function supplyRatePerBlock() returns (uint)',
[], // [optional] parameters
@@ -97,32 +97,32 @@ Write
(async function() {
- const trx = await Compound.eth.trx(
+ const trx = await Venus.eth.trx(
toAddress,
'function send() external payable',
[],
{
- value: Compound._ethers.utils.parseEther('1.0'), // 1 ETH
+ value: Venus._ethers.utils.parseEther('1.0'), // 1 ETH
provider: window.ethereum, // in a web browser
}
);
- const toAddressEthBalance = await Compound.eth.getBalance(toAddress);
+ const toAddressEthBalance = await Venus.eth.getBalance(toAddress);
})().catch(console.error);
-
- Compound Protocol
+
+ Venus Protocol
- Simple methods for using the Compound protocol.
- const compound = new Compound(window.ethereum); // in a web browser
+ Simple methods for using the Venus protocol.
+ const venus = new Venus(window.ethereum); // in a web browser
// Ethers.js overrides are an optional 3rd parameter for `supply`
// const trxOptions = { gasLimit: 250000, mantissa: false };
(async function() {
- console.log('Supplying ETH to the Compound protocol...');
- const trx = await compound.supply(Compound.ETH, 1);
+ console.log('Supplying ETH to the Venus protocol...');
+ const trx = await venus.supply(Venus.ETH, 1);
console.log('Ethers.js transaction object', trx);
})().catch(console.error);
@@ -130,61 +130,65 @@ Compound Protocol
Install / Import
Web Browser
- <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@compound-finance/compound-js@latest/dist/browser/compound.min.js"></script>
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@swipewallet/venus-js@latest/dist/browser/venus.min.js"></script>
<script type="text/javascript">
- window.Compound; // or `Compound`
+ window.Venus; // or `Venus`
</script>
Node.js
- npm install @compound-finance/compound-js
- const Compound = require('@compound-finance/compound-js');
+ npm install @swipewallet/venus-js
+ const Venus = require('@swipewallet/venus-js');
+
+// or, when using ES6
+
+import Venus from '@swipewallet/venus-js';
More Code Examples
- - Node.js
- - Web Browser
+ - Node.js
+ - Web Browser
- To run, boot Ganache fork of mainnet locally
+ To run, boot Ganache fork of mainnet locally
Instance Creation
The following are valid Ethereum providers for initialization of the SDK.
- var compound = new Compound(window.ethereum); // web browser
+ var venus = new Venus(window.ethereum); // web browser
-var compound = new Compound('http://127.0.0.1:8545'); // HTTP provider
+var venus = new Venus('http://127.0.0.1:8545'); // HTTP provider
-var compound = new Compound(); // Uses Ethers.js fallback mainnet (for testing only)
+var venus = new Venus(); // Uses Ethers.js fallback mainnet (for testing only)
-var compound = new Compound('ropsten'); // Uses Ethers.js fallback (for testing only)
+var venus = new Venus('ropsten'); // Uses Ethers.js fallback (for testing only)
// Init with private key (server side)
-var compound = new Compound('https://mainnet.infura.io/v3/_your_project_id_', {
+var venus = new Venus('https://mainnet.infura.io/v3/_your_project_id_', {
privateKey: '0x_your_private_key_', // preferably with environment variable
});
// Init with HD mnemonic (server side)
-var compound = new Compound('mainnet' {
+var venus = new Venus('mainnet' {
mnemonic: 'clutch captain shoe...', // preferably with environment variable
});
Constants and Contract Addresses
Names of contracts, their addresses, ABIs, token decimals, and more can be found in /src/constants.ts. Addresses, for all networks, can be easily fetched using the getAddress function, combined with contract name constants.
- console.log(Compound.DAI, Compound.ETH, Compound.cETH);
-// DAI, ETH, cETH
+ console.log(Venus.DAI, Venus.BNB, Venus.vSXP);
+// DAI, BNB, vSXP
-const cUsdtAddress = Compound.util.getAddress(Compound.cUSDT);
+const cUsdtAddress = Venus.util.getAddress(Venus.vUSDT);
// Mainnet cUSDT address. Second parameter can be a network like 'ropsten'.
Mantissas
Parameters of number values can be plain numbers or their scaled up mantissa values. There is a transaction option boolean to tell the SDK what the developer is passing.
// 1 Dai
-await compound.borrow(Compound.DAI, '1000000000000000000', { mantissa: true });
+await venus.borrow(Venus.DAI, '1000000000000000000', { mantissa: true });
// `mantissa` defaults to false if it is not specified or if an options object is not passed
-await compound.borrow(Compound.DAI, 1, { mantissa: false });
+await venus.borrow(Venus.DAI, 1, { mantissa: false });
Transaction Options
@@ -196,26 +200,26 @@ Transaction Options
provider, // JSON RPC string, Web3 object, or Ethers.js fallback network (string)
network, // Ethers.js fallback network provider, "provider" has precedence over "network"
from, // Address that the Ethereum transaction is send from
- gasPrice, // Ethers.js override `Compound_ethers.utils.parseUnits('10.0', 'gwei')`
+ gasPrice, // Ethers.js override `Venus._ethers.utils.parseUnits('10.0', 'gwei')`
gasLimit, // Ethers.js override - see https://docs.ethers.io/ethers.js/v5-beta/api-contract.html#overrides
value, // Number or string
data, // Number or string
chainId, // Number
nonce, // Number
- privateKey, // String, meant to be used with `Compound.eth.trx` (server side)
- mnemonic, // String, meant to be used with `Compound.eth.trx` (server side)
+ privateKey, // String, meant to be used with `Venus.eth.trx` (server side)
+ mnemonic, // String, meant to be used with `Venus.eth.trx` (server side)
};
API
- The Compound API is accessible from Compound.js. The corresponding services are defined in the api namespace on the class.
+ The Venus API is accessible from Venus.js. The corresponding services are defined in the api namespace on the class.
- Compound.api.accountCompound.api.cTokenCompound.api.marketHistoryCompound.api.governanceVenus.api.accountVenus.api.cTokenVenus.api.marketHistoryVenus.api.governance
- The governance method requires a second parameter (string) for the corresponding endpoint shown in the documentation.
+ The governance method requires a second parameter (string) for the corresponding endpoint shown in the documentation.
proposalsvoteReceiptsAPI
Here is an example for using the account endpoint. The network parameter in the request body is optional and defaults to mainnet.
const main = async () => {
- const account = await Compound.api.account({
+ const account = await Venus.api.account({
"addresses": "0xB61C5971d9c0472befceFfbE662555B78284c307",
"network": "ropsten"
});
- let daiBorrowBalance = 0;
+ let sxpBorrowBalance = 0;
if (Object.isExtensible(account) && account.accounts) {
account.accounts.forEach((acc) => {
acc.tokens.forEach((tok) => {
- if (tok.symbol === Compound.cDAI) {
+ if (tok.symbol === Venus.vSXP) {
daiBorrowBalance = +tok.borrow_balance_underlying.value;
}
});
});
}
- console.log('daiBorrowBalance', daiBorrowBalance);
+ console.log('sxpBorrowBalance', sxpBorrowBalance);
}
main().catch(console.error);
Build for Node.js & Web Browser
- git clone git@github.com:compound-finance/compound-js.git
-cd compound-js/
-npm install
-npm run build
+ git clone git@github.com:SwipeWallet/venus-js.git
+cd venus-js/
+npm install
+npm run build
Web Browser Build
<!-- Local build (do `npm install` first) -->
-<script type="text/javascript" src="./dist/browser/compound.min.js"></script>
+<script type="text/javascript" src="./dist/browser/venus.min.js"></script>
<!-- Public NPM -> jsdeliver build -->
-<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@compound-finance/compound-js@latest/dist/browser/compound.min.js"></script>
+<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@swipewallet/venus-js@latest/dist/browser/venus.min.js"></script>
Node.js Build
// Local build (do `npm install` first)
-const Compound = require('./dist/nodejs/index.js');
+const Venus = require('./dist/nodejs/index.js');
// Public NPM build
-const Compound = require('@compound-finance/compound-js');
+const Venus = require('@swipewallet/venus-js');
Makes a request to the AccountService API. The Account API retrieves information for various accounts which have interacted with the protocol. - For more details, see the Compound API documentation.
+ For more details, see the Venus API documentation.- example
@@ -128,44 +128,44 @@(async function() { - const account = await Compound.api.account({ + const account = await Venus.api.account({ "addresses": "0xB61C5971d9c0472befceFfbE662555B78284c307", "network": "ropsten" }); - let daiBorrowBalance = 0; + let sxpBorrowBalance = 0; if (Object.isExtensible(account) && account.accounts) { account.accounts.forEach((acc) => { acc.tokens.forEach((tok) => { - if (tok.symbol === Compound.cDAI) { - daiBorrowBalance = +tok.borrow_balance_underlying.value; + if (tok.symbol === Venus.vSXP) { + sxpBorrowBalance = +tok.borrow_balance_underlying.value; } }); }); } - console.log('daiBorrowBalance', daiBorrowBalance); + console.log('sxpBorrowBalance', sxpBorrowBalance); })().catch(console.error);account
Parameters
-
-
-options: object
+options: AccountServiceRequest
A JavaScript object of API request parameters.
Returns Promise<unknown>
+Returns Promise<APIResponse>
Returns the HTTP response body or error.
cToken
+ +governance
-- c
Token(options: object): Promise<unknown>
+ - governance(options: GovernanceServiceRequest, endpoint: string): Promise<APIResponse>
Makes a request to the CTokenService API. The cToken API retrieves - information about cToken contract interaction. For more details, see the - Compound API documentation.
+Makes a request to the GovernanceService API. The Governance Service includes + three endpoints to retrieve information about COMP accounts. For more + details, see the Venus API documentation.
- example
@@ -173,44 +173,55 @@(async function() { - const cDaiData = await Compound.api.cToken({ - "addresses": Compound.util.getAddress(Compound.cDAI) - }); + const proposal = await Venus.api.governance( + { "proposal_ids": [ 20 ] }, 'proposals' + ); - console.log('cDaiData', cDaiData); // JavaScript Object + console.log('proposal', proposal); // JavaScript Object })().catch(console.error);cToken
Parameters
-
-
+ -
+
+
+
-options: object
+options: GovernanceServiceRequest
A JavaScript object of API request parameters.
endpoint: string
+A string of the name of the corresponding governance + service endpoint. Valid values are
+proposals,voteReceipts, or +accounts.Returns Promise<unknown>
+Returns Promise<APIResponse>
Returns the HTTP response body or error.
governance
+ +marketHistory
-- governance(options: object, endpoint: string): Promise<unknown>
+ - market
History(options: MarketHistoryServiceRequest): Promise<APIResponse>
Makes a request to the GovernanceService API. The Governance Service includes - three endpoints to retrieve information about COMP accounts. For more - details, see the Compound API documentation.
+Makes a request to the MarketHistoryService API. The market history service + retrieves information about a market. For more details, see the Venus + API documentation.
- example
@@ -218,55 +229,44 @@(async function() { - const proposal = await Compound.api.governance( - { "proposal_ids": [ 20 ] }, 'proposals' - ); + const vUsdcMarketData = await Venus.api.marketHistory({ + "asset": Venus.util.getAddress(Venus.vUSDC), + "min_block_timestamp": 1559339900, + "max_block_timestamp": 1598320674, + "num_buckets": 10, + }); - console.log('proposal', proposal); // JavaScript Object + console.log('vUsdcMarketData', vUsdcMarketData); // JavaScript Object })().catch(console.error);governance
Parameters
-
-
- -
-
-
-
-options: object
+options: MarketHistoryServiceRequest
A JavaScript object of API request parameters.
endpoint: string
-A string of the name of the corresponding governance - service endpoint. Valid values are
-proposals,voteReceipts, or -accounts.Returns Promise<unknown>
+Returns Promise<APIResponse>
Returns the HTTP response body or error.
marketHistory
+ +vToken
-- market
History(options: object): Promise<unknown>
+ - v
Token(options: CTokenServiceRequest): Promise<APIResponse>
-
-
diff --git a/docs/modules/_comp_.html b/docs/modules/_comp_.html
index 5ed205f..316dcd4 100644
--- a/docs/modules/_comp_.html
+++ b/docs/modules/_comp_.html
@@ -3,8 +3,8 @@
- "comp" | Compound.js - v0.1.2
-
+ "comp" | Venus.js - v0.0.1
+
@@ -22,7 +22,7 @@
- Preparing search index...
- The search index is not available
- Compound.js - v0.1.2 + Venus.js - v0.0.1Makes a request to the MarketHistoryService API. The market history service - retrieves information about a market. For more details, see the Compound - API documentation.
+Makes a request to the CTokenService API. The vToken API retrieves + information about vToken contract interaction. For more details, see the + Venus API documentation.
- example
@@ -274,13 +274,13 @@(async function() { - const cUsdcMarketData = await Compound.api.marketHistory({ - "asset": Compound.util.getAddress(Compound.cUSDC), - "min_block_timestamp": 1559339900, - "max_block_timestamp": 1598320674, - "num_buckets": 10, + const vSxpData = await Venus.api.vToken({ + "addresses": Venus.util.getAddress(Venus.vSXP) }); - console.log('cUsdcMarketData', cUsdcMarketData); // JavaScript Object + console.log('vSxpData', vSxpData); // JavaScript Object })().catch(console.error);marketHistory
Parameters
-
-
-options: object
+options: CTokenServiceRequest
A JavaScript object of API request parameters.
Returns Promise<unknown>
+Returns Promise<APIResponse>
Returns the HTTP response body or error.
@@ -327,15 +327,15 @@Returns Promise account --
- c
Token
-
-
governance
-
market
History
+ -
+ v
Token
+
Index
Functions
-- claim
Comp
+ - claim
Venus
- create
DelegateSignature
- delegate
- delegate
BySig
- - get
CompAccrued
- - get
CompBalance
+ - get
VenusAccrued
+ - get
VenusBalance
- to
ChecksumAddress
Functions
Functions
claimComp
+ +claimVenus
-- claim
Comp(options?: any): Promise<any>
+ - claim
Venus(options?: CallOptions): Promise<TrxResponse>
Create a transaction to claim accrued COMP tokens for the user.
+Create a transaction to claim accrued VENUS tokens for the user.
const compound = new Compound(window.ethereum); +-
@@ -119,10 +119,10 @@
claimComp
Parameters
-
-
-Default value options: any = {}
+Default value options: CallOptions = {}
Returns Promise<any>
+Returns Promise<TrxResponse>
Returns an Ethers.js transaction object of the vote transaction.
@@ -132,28 +132,28 @@Returns Promise-
-
- example
-
createDelegateSignature
-- create
DelegateSignature(delegatee: string, expiry?: number): Promise<any>
+ - create
DelegateSignature(delegatee: string, expiry?: number): Promise<Signature>
Create a delegate signature for Compound Governance using EIP-712. The +
Create a delegate signature for Venus Governance using EIP-712. The signature can be created without burning gas. Anyone can post it to the blockchain using the
delegateBySigmethod, which does have gas costs.