@meterio/sumer-js 0.0.12 → 0.1.0

package/README.md

@@ -1,25 +1,28 @@
 # Sumer.js
 
-A JavaScript SDK for Binance Smart Chain and the Sumer Protocol. Wraps around [Ethers.js](https://github.com/ethers-io/ethers.js/). Works in the **web browser** and **Node.js**.
+[![Build Status](https://github.com/meterio/sumer-js/workflows/Build/badge.svg)](https://github.com/meterio/sumer-js/actions)
+[![codecov](https://codecov.io/gh/meterio/sumer-js/branch/master/graph/badge.svg?token=85IDEVM3U0)](https://codecov.io/gh/meterio/sumer-js)
 
-Sumer.js Documentation
+A JavaScript SDK for Ethereum and the Sumer Protocol. Wraps around [Ethers.js](https://github.com/ethers-io/ethers.js/). Works in the **web browser** and **Node.js**.
+
+[Sumer.js Documentation](https://docs.meter.io/sumer-js)
 
 This SDK is in **open beta**, and is constantly under development. **USE AT YOUR OWN RISK**.
 
-## Binance Smart Chain Read & Write
+## Ethereum Read & Write
 
-JSON RPC based Binance Smart Chain **read** and **write**.
+JSON RPC based Ethereum **read** and **write**.
 
 ### Read
 
 ```js
 const Sumer = require('@meterio/sumer-js'); // in Node.js
-const vUsdtAddress = Sumer.util.getAddress(Sumer.vUSDT);
+const cUsdtAddress = Sumer.util.getAddress(Sumer.cUSDT);
 
 (async function() {
 
   let supplyRatePerBlock = await Sumer.eth.read(
-    vUsdtAddress,
+    cUsdtAddress,
     'function supplyRatePerBlock() returns (uint)',
     [], // [optional] parameters
     {}  // [optional] call options, provider, network, ethers.js "overrides"
@@ -42,7 +45,7 @@ const toAddress = '0xa0df350d2637096571F7A701CBc1C5fdE30dF76A';
     'function send() external payable',
     [],
     {
-      value: Sumer._ethers.utils.parseEther('1.0'), // 1 ETH
+      value: Sumer._ethers.parseEther('1.0'), // 1 ETH
       provider: window.ethereum, // in a web browser
     }
   );
@@ -99,14 +102,11 @@ import Sumer from '@meterio/sumer-js';
 
 ## More Code Examples
 
-- [Node.js](https://github.com/meterio/sumer-js/tree/master/examples)
-- [Web Browser](https://github.com/meterio/sumer-js/examples/web/)
-
-[To run, boot Ganache fork of mainnet locally](https://github.com/meterio/sumer-js/tree/master/examples)
+See the docblock comments above each function definition or the official [Sumer.js Documentation](https://sumer.finance/docs/sumer-js).
 
 ## Instance Creation
 
-The following are valid Binance Smart Chain providers for initialization of the SDK.
+The following are valid Ethereum providers for initialization of the SDK.
 
 ```js
 var sumer = new Sumer(window.ethereum); // web browser
@@ -115,10 +115,10 @@ var sumer = new Sumer('http://127.0.0.1:8545'); // HTTP provider
 
 var sumer = new Sumer(); // Uses Ethers.js fallback mainnet (for testing only)
 
-var sumer = new Sumer('testnet'); // Uses Ethers.js fallback (for testing only)
+var sumer = new Sumer('ropsten'); // Uses Ethers.js fallback (for testing only)
 
 // Init with private key (server side)
-var sumer = new Sumer('http://127.0.0.1:8545', {
+var sumer = new Sumer('https://mainnet.infura.io/v3/_your_project_id_', {
   privateKey: '0x_your_private_key_', // preferably with environment variable
 });
 
@@ -133,11 +133,11 @@ var sumer = new Sumer('mainnet' {
 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.
 
 ```js
-console.log(Sumer.BUSD, Sumer.BNB, Sumer.vSXP);
-// BUSD, BNB, vSXP
+console.log(Sumer.DAI, Sumer.ETH, Sumer.cETH);
+// DAI, ETH, cETH
 
-const vUsdtAddress = Sumer.util.getAddress(Sumer.vUSDT);
-// Mainnet vUSDT address. Second parameter can be a network like 'testnet'.
+const cUsdtAddress = Sumer.util.getAddress(Sumer.cUSDT);
+// Mainnet cUSDT address. Second parameter can be a network like 'ropsten'.
 ```
 
 ## Mantissas
@@ -145,11 +145,11 @@ const vUsdtAddress = Sumer.util.getAddress(Sumer.vUSDT);
 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.
 
 ```js
-// 1 BUSD
-await sumer.borrow(Sumer.BUSD, '1000000000000000000', { mantissa: true });
+// 1 Dai
+await sumer.borrow(Sumer.DAI, '1000000000000000000', { mantissa: true });
 
 // `mantissa` defaults to false if it is not specified or if an options object is not passed
-await sumer.borrow(Sumer.BUSD, 1, { mantissa: false });
+await sumer.borrow(Sumer.DAI, 1, { mantissa: false });
 ```
 
 ## Transaction Options
@@ -162,7 +162,7 @@ const trxOptions = {
   abi,        // Definition string or an ABI array from a solc build
   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 Binance Smart Chain transaction is send from
+  from,       // Address that the Ethereum transaction is send from
   gasPrice,   // Ethers.js override `Sumer._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
@@ -176,14 +176,14 @@ const trxOptions = {
 
 ## API
 
-The [Sumer API](https://docs.sumer.io/docs/api) is accessible from Sumer.js. The corresponding services are defined in the `api` namespace on the class.
+The [Sumer API](https://sumer.finance/docs/api) is accessible from Sumer.js. The corresponding services are defined in the `api` namespace on the class.
 
 - `Sumer.api.account`
-- `Sumer.api.vToken`
+- `Sumer.api.cToken`
 - `Sumer.api.marketHistory`
 - `Sumer.api.governance`
 
-The governance method requires a second parameter (string) for the corresponding endpoint shown in the [documentation](https://docs.sumer.io/docs/api#GovernanceService).
+The governance method requires a second parameter (string) for the corresponding endpoint shown in the [documentation](https://sumer.finance/docs/api#GovernanceService).
 
 - `proposals`
 - `voteReceipts`
@@ -195,26 +195,38 @@ Here is an example for using the `account` endpoint. The `network` parameter in
 const main = async () => {
   const account = await Sumer.api.account({
     "addresses": "0xB61C5971d9c0472befceFfbE662555B78284c307",
-    "network": "testnet"
+    "network": "ropsten"
   });
 
-  let sxpBorrowBalance = 0;
+  let daiBorrowBalance = 0;
   if (Object.isExtensible(account) && account.accounts) {
     account.accounts.forEach((acc) => {
       acc.tokens.forEach((tok) => {
-        if (tok.symbol === Sumer.vSXP) {
-          sxpBorrowBalance = +tok.borrow_balance_underlying.value;
+        if (tok.symbol === Sumer.cDAI) {
+          daiBorrowBalance = +tok.borrow_balance_underlying.value;
         }
       });
     });
   }
 
-  console.log('sxpBorrowBalance', sxpBorrowBalance);
+  console.log('daiBorrowBalance', daiBorrowBalance);
 }
 
 main().catch(console.error);
 ```
 
+## Test
+
+Tests are available in `./test/*.test.js`. The tests are configured in `./test/index.js`. Methods are tested using a forked chain using ganache-core. A JSON RPC provider URL needs to be configured as an environment variable before running the tests (`MAINNET_PROVIDER_URL`). Archive state must be available to run the tests. For free archive node access, get a provider URL from [Alchemy](http://alchemy.com/).
+
+```
+## Run all tests
+npm test
+
+## Run a single test (Mocha JS grep option)
+npm test -- -g 'runs eth.getBalance'
+```
+
 ## Build for Node.js & Web Browser
 
 ```
@@ -224,7 +236,6 @@ npm install
 npm run build
 ```
 
-
 ### Web Browser Build
 ```html
 <!-- Local build (do `npm install` first) -->
@@ -234,15 +245,6 @@ npm run build
 <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@meterio/sumer-js@latest/dist/browser/sumer.min.js"></script>
 ```
 
-#### Start HTTP Server
-
-```
-npm install -g http-server
-http-server
-```
-
-Then you could go to `http://localhost:8080/examples/web`
-
 ### Node.js Build
 ```js
 // Local build (do `npm install` first)