@meterio/sumer-js 0.2.163 → 0.2.165

package/dist/nodejs/index.d.ts

@@ -3,46 +3,37 @@
  * @desc This file defines the constructor of the `Sumer` class.
  * @hidden
  */
-import { ethers, JsonRpcSigner } from 'ethers';
+import { ContractTransactionResponse, ethers, JsonRpcSigner } from 'ethers';
 import * as eth from './eth';
 import * as util from './util';
-import { SumerOptions, SumerInstance } from './types';
-/**
- * Creates an instance of the Sumer.js SDK.
- *
- * @param {Provider | string} [provider] Optional Ethereum network provider.
- *     Defaults to Ethers.js fallback mainnet provider.
- * @param {object} [options] Optional provider options.
- *
- * @example
- * ```
- * var sumer = new Sumer(window.ethereum); // web browser
- *
- * 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('ropsten'); // Uses Ethers.js fallback (for testing only)
- *
- * // Init with private key (server side)
- * var sumer = new Sumer('https://mainnet.infura.io/v3/_your_project_id_', {
- *   privateKey: '0x_your_private_key_', // preferably with environment variable
- * });
- *
- * // Init with HD mnemonic (server side)
- * var sumer = new Sumer('mainnet' {
- *   mnemonic: 'clutch captain shoe...', // preferably with environment variable
- * });
- * ```
- *
- * @returns {object} Returns an instance of the Sumer.js SDK.
- */
-declare const Sumer: {
-    (provider: JsonRpcSigner, options: SumerOptions): SumerInstance;
-    eth: typeof eth;
-    util: typeof util;
-    _ethers: typeof ethers;
-    abi: {
+import * as comptroller from './comptroller';
+import { SumerOptions, CallOptions } from './types';
+declare class Sumer {
+    _provider: JsonRpcSigner;
+    _network: {
+        id: string | number;
+        name: string;
+    };
+    supply: (asset: string, amount: string | number, noApprove?: boolean, options?: CallOptions) => Promise<ContractTransactionResponse>;
+    supplyWithPermit: (asset: string, amount: string | number, options?: CallOptions) => Promise<ContractTransactionResponse>;
+    redeem: (asset: string, amount: string | number, options?: CallOptions) => Promise<ContractTransactionResponse>;
+    borrow: (asset: string, amount: string | number, options?: CallOptions) => Promise<ContractTransactionResponse>;
+    repayBorrow: (asset: string, amount: string | number, borrower: string, noApprove?: false, options?: CallOptions) => Promise<ContractTransactionResponse>;
+    repayBorrowWithPermit: (asset: string, amount: string | number, options?: CallOptions) => Promise<ContractTransactionResponse>;
+    liquidateBorrow: (repayToken: string, borrower: string, amount: string, cTokenCollateral: string) => Promise<ContractTransactionResponse>;
+    calcBorrowAmountForProtectedMint: (asset: string, collateral: string, mintAmount: string | number, options?: CallOptions) => Promise<[bigint, bigint]>;
+    protectedMint: (asset: string, collateral: string, cBorrowAmount: string | number, mintAmount: string | number, options?: CallOptions) => Promise<ContractTransactionResponse>;
+    enterMarkets: (markets: string | string[], options?: CallOptions) => Promise<ContractTransactionResponse>;
+    exitMarket: (market: string, options?: CallOptions) => Promise<ContractTransactionResponse>;
+    redeemFaceValue: (market: string, amount: string | number, providers: string[], deadline: string, signature: string, options?: CallOptions) => Promise<ContractTransactionResponse>;
+    redeemFaceValueWithPermit: (market: string, amount: string | number, providers: string[], providersDeadline: BigInt, providersSignature: string, options?: CallOptions) => Promise<ContractTransactionResponse>;
+    redeemFaceValuePreview: (chainId: string, redeemer: string, market: string, amount: string | number) => Promise<comptroller.SignedRedeemPreview>;
+    calcPlan: (account: string, seizeTokenAddress: string, repayTokenAddress: string) => Promise<comptroller.Plan>;
+    constructor(provider: JsonRpcSigner, options: SumerOptions);
+    static eth: typeof eth;
+    static util: typeof util;
+    static _ethers: typeof ethers;
+    static abi: {
         Multicall2: {
             inputs: ({
                 internalType: string;
@@ -2867,7 +2858,7 @@ declare const Sumer: {
             type: string;
         })[];
     };
-    errorABIs: ({
+    static errorABIs: ({
         inputs: {
             internalType: string;
             name: string;
@@ -2889,10 +2880,52 @@ declare const Sumer: {
         name: string;
         type: string;
     })[];
-    getDecimals: (networkName: string, tokenSym: string) => number;
-    getAddress: (networkName: string, tokenSym: string) => any;
-    getName: (networkName: string, tokenAddress: string) => any;
-    getTokenPairs: (networkName: string) => {
+    static constants: {
+        CompoundLens: string;
+        GovernorBravo: string;
+        Comptroller: string;
+        PriceOracle: string;
+        WhitepaperInterestRate: string;
+    };
+    static getDecimals: (networkName: string, tokenSym: string) => number;
+    static getAddress: (networkName: string, tokenSym: string) => any;
+    static getName: (networkName: string, tokenAddress: string) => any;
+    static getTokenPairs: (networkName: string) => {
+        ctokenSym: string;
+        ctokenAddr: string;
+        ctokenDecimal: number;
+        underlySym: string;
+        underlyAddr: string;
+        underlyDecimal: number;
+        ctokenIsEther: boolean;
+        permitEnabled: boolean;
+        assetGroupId: number;
+    }[];
+    static getNetworkBlocksPerYear: (networkName: string) => any;
+    static getRateModals: (networkName: string) => any;
+    static getTokenPairByAddress: (networkName: string, tokenAddress: string) => {
+        ctokenSym: string;
+        ctokenAddr: string;
+        ctokenDecimal: number;
+        underlySym: string;
+        underlyAddr: string;
+        underlyDecimal: number;
+        ctokenIsEther: boolean;
+        permitEnabled: boolean;
+        assetGroupId: number;
+    };
+    static getTokenPairBySymbol: (networkName: string, symbol: string) => {
+        ctokenSym: string;
+        ctokenAddr: string;
+        ctokenDecimal: number;
+        underlySym: string;
+        underlyAddr: string;
+        underlyDecimal: number;
+        ctokenIsEther: boolean;
+        permitEnabled: boolean;
+        assetGroupId: number;
+    };
+    static getTokenPairsByGroupId: (networkName: string, assetGroupId: number) => {
         ctokenSym: string;
         ctokenAddr: string;
         ctokenDecimal: number;
@@ -2903,9 +2936,10 @@ declare const Sumer: {
         permitEnabled: boolean;
         assetGroupId: number;
     }[];
-    getNetworkBlocksPerYear: (networkName: string) => any;
-    getRateModals: (networkName: string) => any;
-    getTokenPairByAddress: (networkName: string, tokenAddress: string) => {
+    static isUnderlyAllowed: (networkName: string, underlyName: string) => boolean;
+    static isCTokenAllowed: (networkName: string, cToken: string) => boolean;
+    static isEther: (networkName: string, ctokenSym: string) => boolean;
+    getTokenPairBySymbol(symbol: string): {
         ctokenSym: string;
         ctokenAddr: string;
         ctokenDecimal: number;
@@ -2916,7 +2950,7 @@ declare const Sumer: {
         permitEnabled: boolean;
         assetGroupId: number;
     };
-    getTokenPairBySymbol: (networkName: string, symbol: string) => {
+    getTokenPairByAddress(tokenAddress: string): {
         ctokenSym: string;
         ctokenAddr: string;
         ctokenDecimal: number;
@@ -2927,7 +2961,7 @@ declare const Sumer: {
         permitEnabled: boolean;
         assetGroupId: number;
     };
-    getTokenPairsByGroupId: (networkName: string, assetGroupId: number) => {
+    getTokenPairsByGroupId(assetGroupId: number): {
         ctokenSym: string;
         ctokenAddr: string;
         ctokenDecimal: number;
@@ -2938,8 +2972,5 @@ declare const Sumer: {
         permitEnabled: boolean;
         assetGroupId: number;
     }[];
-    isUnderlyAllowed: (networkName: string, underlyName: string) => boolean;
-    isCTokenAllowed: (networkName: string, cToken: string) => boolean;
-    isEther: (networkName: string, ctokenSym: string) => boolean;
-};
+}
 export = Sumer;

package/dist/nodejs/index.js

@@ -33,60 +33,44 @@ const util = __importStar(require("./util"));
 const comptroller = __importStar(require("./comptroller"));
 const cToken = __importStar(require("./cToken"));
 const errorABIs_1 = require("./errorABIs");
-// import * as comp from './comp'
-// import * as gov from './gov'
 const abi_1 = require("./abi");
 const constants_1 = require("./constants");
-// Turn off Ethers.js warnings
-// ethers.utils.Logger.setLogLevel(ethers.utils.Logger.levels.ERROR)
-/**
- * Creates an instance of the Sumer.js SDK.
- *
- * @param {Provider | string} [provider] Optional Ethereum network provider.
- *     Defaults to Ethers.js fallback mainnet provider.
- * @param {object} [options] Optional provider options.
- *
- * @example
- * ```
- * var sumer = new Sumer(window.ethereum); // web browser
- *
- * 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('ropsten'); // Uses Ethers.js fallback (for testing only)
- *
- * // Init with private key (server side)
- * var sumer = new Sumer('https://mainnet.infura.io/v3/_your_project_id_', {
- *   privateKey: '0x_your_private_key_', // preferably with environment variable
- * });
- *
- * // Init with HD mnemonic (server side)
- * var sumer = new Sumer('mainnet' {
- *   mnemonic: 'clutch captain shoe...', // preferably with environment variable
- * });
- * ```
- *
- * @returns {object} Returns an instance of the Sumer.js SDK.
- */
-const Sumer = function (provider, options) {
-    const instance = Object.assign(Object.assign(Object.assign({ _provider: provider }, comptroller), cToken), { _network: {
-            id: options.networkId,
-            name: options.networkName,
-        }, getTokenPairBySymbol: (symbol) => {
-            return (0, constants_1.getTokenPairBySymbol)(options.networkName, symbol);
-        }, getTokenPairByAddress: (tokenAddress) => {
-            return (0, constants_1.getTokenPairBySymbol)(options.networkName, tokenAddress);
-        }, getTokenPairsByGroupId: (assetGroupId) => {
-            return (0, constants_1.getTokenPairsByGroupId)(options.networkName, assetGroupId);
-        } });
-    return instance;
-};
+class Sumer {
+    constructor(provider, options) {
+        this._provider = provider;
+        this._network = { id: options.networkId, name: options.networkName };
+        this.supply = cToken.supply.bind(this);
+        this.supplyWithPermit = cToken.supplyWithPermit.bind(this);
+        this.redeem = cToken.redeem.bind(this);
+        this.borrow = cToken.borrow.bind(this);
+        this.repayBorrow = cToken.repayBorrow.bind(this);
+        this.repayBorrowWithPermit = cToken.repayBorrowWithPermit.bind(this);
+        this.liquidateBorrow = cToken.liquidateBorrow.bind(this);
+        this.calcBorrowAmountForProtectedMint = cToken.calcBorrowAmountForProtectedMint.bind(this);
+        this.protectedMint = cToken.protectedMint.bind(this);
+        this.enterMarkets = comptroller.enterMarkets.bind(this);
+        this.exitMarket = comptroller.exitMarket.bind(this);
+        this.redeemFaceValue = comptroller.redeemFaceValue.bind(this);
+        this.redeemFaceValueWithPermit = comptroller.redeemFaceValueWithPermit.bind(this);
+        this.redeemFaceValuePreview = comptroller.redeemFaceValuePreview.bind(this);
+        this.calcPlan = comptroller.calcPlan.bind(this);
+    }
+    getTokenPairBySymbol(symbol) {
+        return (0, constants_1.getTokenPairBySymbol)(this._network.name, symbol);
+    }
+    getTokenPairByAddress(tokenAddress) {
+        return (0, constants_1.getTokenPairByAddress)(this._network.name, tokenAddress);
+    }
+    getTokenPairsByGroupId(assetGroupId) {
+        return (0, constants_1.getTokenPairsByGroupId)(this._network.name, assetGroupId);
+    }
+}
 Sumer.eth = eth;
 Sumer.util = util;
 Sumer._ethers = ethers_1.ethers;
 Sumer.abi = abi_1.abi;
 Sumer.errorABIs = errorABIs_1.errorABIs;
+Sumer.constants = constants_1.constants;
 Sumer.getDecimals = constants_1.getDecimals;
 Sumer.getAddress = constants_1.getAddress;
 Sumer.getName = constants_1.getName;
@@ -99,10 +83,5 @@ Sumer.getTokenPairsByGroupId = constants_1.getTokenPairsByGroupId;
 Sumer.isUnderlyAllowed = constants_1.isUnderlyAllowed;
 Sumer.isCTokenAllowed = constants_1.isCTokenAllowed;
 Sumer.isEther = constants_1.isEther;
-// Sumer.comp = {
-//   getCompBalance: comp.getCompBalance,
-//   getCompAccrued: comp.getCompAccrued,
-// }
-Object.assign(Sumer, constants_1.constants);
 module.exports = Sumer;
 //# sourceMappingURL=index.js.map

package/dist/nodejs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;;;;;;;;;;;;;;;;;;;AAEH,mCAA8C;AAC9C,2CAA4B;AAC5B,6CAA8B;AAC9B,2DAA4C;AAC5C,iDAAkC;AAClC,2CAAuC;AACvC,iCAAiC;AACjC,+BAA+B;AAC/B,+BAA2B;AAC3B,2CAcoB;AAGpB,8BAA8B;AAC9B,oEAAoE;AAEpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,KAAK,GAAG,UAAU,QAAuB,EAAE,OAAqB;IAEpE,MAAM,QAAQ,+CACZ,SAAS,EAAE,QAAQ,IAChB,WAAW,GACX,MAAM,KACT,QAAQ,EAAE;YACR,EAAE,EAAE,OAAO,CAAC,SAAS;YACrB,IAAI,EAAE,OAAO,CAAC,WAAW;SAC1B,EACD,oBAAoB,EAAE,CAAC,MAAc,EAAE,EAAE;YACvC,OAAO,IAAA,gCAAoB,EAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAA;QAC1D,CAAC,EACD,qBAAqB,EAAE,CAAC,YAAoB,EAAE,EAAE;YAC9C,OAAO,IAAA,gCAAoB,EAAC,OAAO,CAAC,WAAW,EAAE,YAAY,CAAC,CAAA;QAChE,CAAC,EACD,sBAAsB,EAAE,CAAC,YAAoB,EAAE,EAAE;YAC/C,OAAO,IAAA,kCAAsB,EAAC,OAAO,CAAC,WAAW,EAAE,YAAY,CAAC,CAAA;QAClE,CAAC,GACF,CAAA;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAED,KAAK,CAAC,GAAG,GAAG,GAAG,CAAA;AACf,KAAK,CAAC,IAAI,GAAG,IAAI,CAAA;AACjB,KAAK,CAAC,OAAO,GAAG,eAAM,CAAA;AACtB,KAAK,CAAC,GAAG,GAAG,SAAG,CAAA;AACf,KAAK,CAAC,SAAS,GAAG,qBAAS,CAAA;AAE3B,KAAK,CAAC,WAAW,GAAG,uBAAW,CAAA;AAC/B,KAAK,CAAC,UAAU,GAAG,sBAAU,CAAA;AAC7B,KAAK,CAAC,OAAO,GAAG,mBAAO,CAAA;AACvB,KAAK,CAAC,aAAa,GAAG,yBAAa,CAAA;AACnC,KAAK,CAAC,uBAAuB,GAAG,mCAAuB,CAAA;AACvD,KAAK,CAAC,aAAa,GAAG,yBAAa,CAAA;AACnC,KAAK,CAAC,qBAAqB,GAAG,iCAAqB,CAAA;AACnD,KAAK,CAAC,oBAAoB,GAAG,gCAAoB,CAAA;AACjD,KAAK,CAAC,sBAAsB,GAAG,kCAAsB,CAAA;AAErD,KAAK,CAAC,gBAAgB,GAAG,4BAAgB,CAAA;AACzC,KAAK,CAAC,eAAe,GAAG,2BAAe,CAAA;AACvC,KAAK,CAAC,OAAO,GAAG,mBAAO,CAAA;AACvB,iBAAiB;AACjB,yCAAyC;AACzC,yCAAyC;AACzC,IAAI;AACJ,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,qBAAS,CAAC,CAAA;AAE/B,iBAAS,KAAK,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;;;;;;;;;;;;;;;;;;;;;;AAEH,mCAA2E;AAC3E,2CAA4B;AAC5B,6CAA8B;AAC9B,2DAA4C;AAC5C,iDAAkC;AAClC,2CAAuC;AACvC,+BAA2B;AAC3B,2CAcoB;AAGpB,MAAM,KAAK;IAqBT,YAAY,QAAuB,EAAE,OAAqB;QACxD,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAA;QACzB,IAAI,CAAC,QAAQ,GAAG,EAAE,EAAE,EAAE,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE,CAAA;QAEpE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACtC,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC1D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACtC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACtC,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAChD,IAAI,CAAC,qBAAqB,GAAG,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACpE,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACxD,IAAI,CAAC,gCAAgC,GAAG,MAAM,CAAC,gCAAgC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC1F,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEpD,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACvD,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACnD,IAAI,CAAC,eAAe,GAAG,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC7D,IAAI,CAAC,yBAAyB,GAAG,WAAW,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACjF,IAAI,CAAC,sBAAsB,GAAG,WAAW,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC3E,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACjD,CAAC;IAsBD,oBAAoB,CAAC,MAAc;QACjC,OAAO,IAAA,gCAAoB,EAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IACzD,CAAC;IAED,qBAAqB,CAAC,YAAoB;QACxC,OAAO,IAAA,iCAAqB,EAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;IAChE,CAAC;IAED,sBAAsB,CAAC,YAAoB;QACzC,OAAO,IAAA,kCAAsB,EAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;IACjE,CAAC;;AA9BM,SAAG,GAAG,GAAG,CAAA;AACT,UAAI,GAAG,IAAI,CAAA;AACX,aAAO,GAAG,eAAM,CAAA;AAChB,SAAG,GAAG,SAAG,CAAA;AACT,eAAS,GAAG,qBAAS,CAAA;AACrB,eAAS,GAAG,qBAAS,CAAA;AAErB,iBAAW,GAAG,uBAAW,CAAA;AACzB,gBAAU,GAAG,sBAAU,CAAA;AACvB,aAAO,GAAG,mBAAO,CAAA;AACjB,mBAAa,GAAG,yBAAa,CAAA;AAC7B,6BAAuB,GAAG,mCAAuB,CAAA;AACjD,mBAAa,GAAG,yBAAa,CAAA;AAC7B,2BAAqB,GAAG,iCAAqB,CAAA;AAC7C,0BAAoB,GAAG,gCAAoB,CAAA;AAC3C,4BAAsB,GAAG,kCAAsB,CAAA;AAC/C,sBAAgB,GAAG,4BAAgB,CAAA;AACnC,qBAAe,GAAG,2BAAe,CAAA;AACjC,aAAO,GAAG,mBAAO,CAAA;AAe1B,iBAAS,KAAK,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meterio/sumer-js",
-  "version": "0.2.163",
+  "version": "0.2.165",
   "author": "Decentralized Finance Labs",
   "description": "A JavaScript SDK for Ethereum and the Sumer Protocol.",
   "license": "BSD-3-Clause",