curvance 1.0.7 → 1.0.8

package/README.md

@@ -12,4 +12,56 @@ Note: All values are returned in either BigInt or [Decimals](https://www.npmjs.c
 
 ```
 $ npm install --save curvance
+```
+
+## ❯ Usage
+
+### Grab general information
+This is very RPC efficient as it uses 1-3 RPC call's to setup all the data you need.
+```js
+const { markets, reader, faucet } = await setupChain("monad-testnet", wallet);
+```
+
+You can then explore the data pretty easily like so:
+```js
+let count = 0;
+console.log(`Market summaries in USD:`);
+for(const market of markets) {
+    console.log(`[${count}] tvl: ${market.tvl.toFixed(18)} | totalDebt: ${market.totalDebt.toFixed(18)} | totalCollateral: ${market.totalCollateral.toFixed(18)}`);
+    for(const token of market.tokens) {
+        console.log(`\tToken: ${token.symbol} | Price: ${token.getPrice()} | Amount: ${token.getTvl(false)}`);
+    }
+    count++;
+}
+```
+
+### Grab individaul classes
+```js
+const test_1 = new ERC20(signer, `0x123`);
+await test_1.approve(someGuy, BigInt(50e18));
+```
+
+Some of these classes use preloaded cache to prevent RPC calls s for example
+```js
+const test_1 = new ERC20(signer, `0x123`);
+console.log(test_1.name); // Attempts to use cache for name, so this returns undefined
+const name = await test_1.fetchName();
+console.log(name); // My Test Token
+console.log(test_1.name); // My Test Token
+```
+
+Note: Protocol reader will populate things like `test_1.name` for underlying assets from the first preload RPC call and wont need to be fetched.
+
+
+### Helpers
+- `getContractAddresses` - Grab the contracts addresses for a given chain
+- `AdaptorTypes` - Adaptor identifier enums
+- `WAD` - WAD amount
+- `WAD_DECIMAL` - WAD amount as Decimal.js type
+- `contractSetup` - Used to initialize contract & attach typescript interface
+- `handleTransactionWithOracles` - Depending on what adaptor is being used to execute the function we choose to run a multi-call that will write-price on-chain with the given function -- but only if the adaptor is the type of adaptor that requires this (pull oracle)
+
+```js
+const contracts = getContractAddresses('monad-testnet');
+console.log(contracts.ProtocolReader);
 ```

package/dist/helpers.d.ts

@@ -12,8 +12,6 @@ export declare enum AdaptorTypes {
     REDSTONE_CLASSIC = 3,
     MOCK = 1337
 }
-export declare function toDecimal(amount: bigint, decimals?: bigint): bigint;
-export declare function toInteger(amount: bigint, decimals?: bigint): bigint;
 export declare function contractSetup<I>(signer: JsonRpcSigner | Wallet, contractAddress: address, abi: any): Contract & I;
 export declare function getContractAddresses(chain: ChainRpcPrefix): never[] | {
     CentralRegistry: string;

package/dist/helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAGlC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,eAAO,MAAM,GAAG,QAAqB,CAAC;AACtC,eAAO,MAAM,WAAW,SAAmB,CAAC;AAE5C,oBAAY,YAAY;IACpB,SAAS,IAAI;IACb,aAAa,IAAI;IACjB,gBAAgB,IAAI;IACpB,IAAI,OAAO;CACd;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,SAAM,GAAG,MAAM,CAEhE;AAED,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,SAAM,GAAG,MAAM,CAEhE;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,aAAa,GAAG,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,GAAG,QAAQ,GAAG,CAAC,CAMjH;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQzD;AAED,wBAAgB,4BAA4B,CAAC,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,gBAAgB,EAAE,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC,CAOxI;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,MAAM,CAAC"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,eAAO,MAAM,GAAG,QAAqB,CAAC;AACtC,eAAO,MAAM,WAAW,SAAmB,CAAC;AAE5C,oBAAY,YAAY;IACpB,SAAS,IAAI;IACb,aAAa,IAAI;IACjB,gBAAgB,IAAI;IACpB,IAAI,OAAO;CACd;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,aAAa,GAAG,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,GAAG,QAAQ,GAAG,CAAC,CAMjH;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQzD;AAED,wBAAgB,4BAA4B,CAAC,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,gBAAgB,EAAE,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,CAAC,CAAC,CAOxI;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,MAAM,CAAC"}

package/dist/helpers.js

@@ -1,8 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AdaptorTypes = exports.WAD_DECIMAL = exports.WAD = void 0;
-exports.toDecimal = toDecimal;
-exports.toInteger = toInteger;
 exports.contractSetup = contractSetup;
 exports.getContractAddresses = getContractAddresses;
 exports.handleTransactionWithOracles = handleTransactionWithOracles;
@@ -18,12 +16,6 @@ var AdaptorTypes;
     AdaptorTypes[AdaptorTypes["REDSTONE_CLASSIC"] = 3] = "REDSTONE_CLASSIC";
     AdaptorTypes[AdaptorTypes["MOCK"] = 1337] = "MOCK";
 })(AdaptorTypes || (exports.AdaptorTypes = AdaptorTypes = {}));
-function toDecimal(amount, decimals = 18n) {
-    return amount / BigInt(10n ** BigInt(decimals));
-}
-function toInteger(amount, decimals = 18n) {
-    return amount * BigInt(10n ** BigInt(decimals));
-}
 function contractSetup(signer, contractAddress, abi) {
     const contract = new ethers_1.Contract(contractAddress, abi, signer);
     if (contract == undefined || contract == null) {

package/dist/helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":";;;AAmBA,8BAEC;AAED,8BAEC;AAED,sCAMC;AAED,oDAQC;AAED,oEAOC;AAlDD,mCAAkC;AAClC,2CAAqC;AAIrC,qCAAkC;AAErB,QAAA,GAAG,GAAG,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC;AACzB,QAAA,WAAW,GAAG,IAAI,oBAAO,CAAC,WAAG,CAAC,CAAC;AAE5C,IAAY,YAKX;AALD,WAAY,YAAY;IACpB,yDAAa,CAAA;IACb,iEAAiB,CAAA;IACjB,uEAAoB,CAAA;IACpB,kDAAW,CAAA;AACf,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AAED,SAAgB,SAAS,CAAC,MAAc,EAAE,QAAQ,GAAG,GAAG;IACpD,OAAO,MAAM,GAAG,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;AACpD,CAAC;AAED,SAAgB,SAAS,CAAC,MAAc,EAAE,QAAQ,GAAG,GAAG;IACpD,OAAO,MAAM,GAAG,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;AACpD,CAAC;AAED,SAAgB,aAAa,CAAI,MAA8B,EAAE,eAAwB,EAAE,GAAQ;IAC/F,MAAM,QAAQ,GAAG,IAAI,iBAAQ,CAAC,eAAe,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IAC5D,IAAG,QAAQ,IAAI,SAAS,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;QAC3C,MAAM,IAAI,KAAK,CAAC,sCAAsC,eAAe,GAAG,CAAC,CAAC;IAC9E,CAAC;IACD,OAAO,QAAwB,CAAC;AACpC,CAAC;AAED,SAAgB,oBAAoB,CAAC,KAAqB;IACtD,MAAM,MAAM,GAAG,eAAM,CAAC,KAAK,CAAC,CAAC;IAE7B,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,oCAAoC,KAAK,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,SAAgB,4BAA4B,CAAI,SAAmB,EAAE,KAAgC,EAAE,OAAqB;IACxH,IAAG,OAAO,IAAI,YAAY,CAAC,aAAa,EAAE,CAAC;QACvC,QAAQ;QACR,sCAAsC;IAC1C,CAAC;IAED,OAAO,SAAS,EAAgB,CAAC;AACrC,CAAC"}
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":";;;AAiBA,sCAMC;AAED,oDAQC;AAED,oEAOC;AAxCD,mCAAkC;AAClC,2CAAqC;AAErC,qCAAkC;AAErB,QAAA,GAAG,GAAG,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC;AACzB,QAAA,WAAW,GAAG,IAAI,oBAAO,CAAC,WAAG,CAAC,CAAC;AAE5C,IAAY,YAKX;AALD,WAAY,YAAY;IACpB,yDAAa,CAAA;IACb,iEAAiB,CAAA;IACjB,uEAAoB,CAAA;IACpB,kDAAW,CAAA;AACf,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AAED,SAAgB,aAAa,CAAI,MAA8B,EAAE,eAAwB,EAAE,GAAQ;IAC/F,MAAM,QAAQ,GAAG,IAAI,iBAAQ,CAAC,eAAe,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IAC5D,IAAG,QAAQ,IAAI,SAAS,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;QAC3C,MAAM,IAAI,KAAK,CAAC,sCAAsC,eAAe,GAAG,CAAC,CAAC;IAC9E,CAAC;IACD,OAAO,QAAwB,CAAC;AACpC,CAAC;AAED,SAAgB,oBAAoB,CAAC,KAAqB;IACtD,MAAM,MAAM,GAAG,eAAM,CAAC,KAAK,CAAC,CAAC;IAE7B,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,oCAAoC,KAAK,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,SAAgB,4BAA4B,CAAI,SAAmB,EAAE,KAAgC,EAAE,OAAqB;IACxH,IAAG,OAAO,IAAI,YAAY,CAAC,aAAa,EAAE,CAAC;QACvC,QAAQ;QACR,sCAAsC;IAC1C,CAAC;IAED,OAAO,SAAS,EAAgB,CAAC;AACrC,CAAC"}

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export * from './classes/Faucet';
 export * from './classes/OracleManager';
 export * from './classes/Market';
 export * from './classes/CToken';
+export * from './classes/ERC20';
 export * from './helpers';
 export * from './setup';
 export * from './types';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./classes/Faucet"), exports);
 __exportStar(require("./classes/OracleManager"), exports);
 __exportStar(require("./classes/Market"), exports);
 __exportStar(require("./classes/CToken"), exports);
+__exportStar(require("./classes/ERC20"), exports);
 __exportStar(require("./helpers"), exports);
 __exportStar(require("./setup"), exports);
 __exportStar(require("./types"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC;AACzC,mDAAiC;AACjC,0DAAwC;AACxC,mDAAiC;AACjC,mDAAiC;AACjC,4CAA0B;AAC1B,0CAAwB;AACxB,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC;AACzC,mDAAiC;AACjC,0DAAwC;AACxC,mDAAiC;AACjC,mDAAiC;AACjC,kDAAgC;AAChC,4CAA0B;AAC1B,0CAAwB;AACxB,0CAAwB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "curvance",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [