@meterio/sumer-js 0.0.12 → 0.1.0

package/src/vToken.ts

@@ -1,419 +0,0 @@
-/**
- * @file sdrToken
- * @desc These methods facilitate interactions with the sdrToken smart
- *     contracts.
- */
-
-import { ethers } from 'ethers';
-import * as eth from './eth';
-import { netId } from './helpers';
-import {
-  constants, address, abi, decimals, underlyings, cTokens
-} from './constants';
-import { BigNumber } from '@ethersproject/bignumber/lib/bignumber';
-import { CallOptions, TrxResponse } from './types';
-
-/**
- * Supplies the user's Heco Smart Chain asset to the Sumer Protocol.
- *
- * @param {string} asset A string of the asset to supply.
- * @param {number | string | BigNumber} amount A string, number, or BigNumber
- *     object of the amount of an asset to supply. Use the `mantissa` boolean in
- *     the `options` parameter to indicate if this value is scaled up (so there 
- *     are no decimals) or in its natural scale.
- * @param {boolean} noApprove Explicitly prevent this method from attempting an 
- *     HRC-20 `approve` transaction prior to sending the `mint` transaction.
- * @param {CallOptions} [options] Call options and Ethers.js overrides for the 
- *     transaction. A passed `gasLimit` will be used in both the `approve` (if 
- *     not supressed) and `mint` transactions.
- *
- * @returns {object} Returns an Ethers.js transaction object of the supply
- *     transaction.
- *
- * @example
- *
- * ```
- * const sumer = new Sumer(window.ethereum);
- *
- * // Ethers.js overrides are an optional 3rd parameter for `supply`
- * // const trxOptions = { gasLimit: 250000, mantissa: false };
- * 
- * (async function() {
- * 
- *   console.log('Supplying SXP to the Sumer Protocol...');
- *   const trx = await sumer.supply(Sumer.SXP, 1);
- *   console.log('Ethers.js transaction object', trx);
- * 
- * })().catch(console.error);
- * ```
- */
-export async function supply(
-  asset: string,
-  amount: string | number | BigNumber,
-  noApprove = false,
-  options: CallOptions = {}
-) : Promise<TrxResponse> {
-  await netId(this);
-  const errorPrefix = 'Sumer [supply] | ';
-
-  const isNative = (asset === address[this._network.name]["nativeToken"]);
-  const sdrTokenName = 'sdr' + asset;
-  const sdrTokenAddress = address[this._network.name][sdrTokenName];
-
-  if (!sdrTokenAddress || !underlyings.includes(asset)) {
-    throw Error(errorPrefix + 'Argument `asset` cannot be supplied.');
-  }
- if (
-    typeof amount !== 'number' &&
-    typeof amount !== 'string' &&
-    !ethers.BigNumber.isBigNumber(amount)
-  ) {
-    throw Error(errorPrefix + 'Argument `amount` must be a string, number, or BigNumber.');
-  }
-
-  let amountBN: ethers.BigNumber;
-  if (typeof amount == 'number' || typeof amount == 'string'){
-    amountBN = ethers.BigNumber.from(amount);
-  } else{
-    amountBN = ethers.BigNumber.from(amount.toString());
-  }
- 
-  if (!options.mantissa) {
-    amountBN = amountBN.abs();
-    amountBN = amountBN.mul( ethers.BigNumber.from(10).pow(decimals[asset]));
-  }
-
-  console.log("AMOUNT: ",  amountBN.toString())
-
-  // if (sdrTokenName === constants.cETH) {
-  //   options.abi = abi.cEther;
-  // } else {
-  //   options.abi = abi.cErc20;
-  // }
-  if (isNative) {
-    options.abi = abi.sdrNative;
-  } else {
-    options.abi = abi.sdrHrc20;
-  }
-
-  options._compoundProvider = this._provider;
-
-  if (!isNative && noApprove !== true) {
-    const underlyingAddress = address[this._network.name][asset];
-    const userAddress = this._originalProvider.selectedAddress;
-
-    // Check allowance
-    const allowance = await eth.read(
-      underlyingAddress,
-      'allowance',
-      [ userAddress, sdrTokenAddress ],
-      options
-    );
-    const notEnough = allowance.lt(amountBN);
-    
-    if (notEnough) {
-      // ERC-20 approve transaction
-      await eth.trx(
-        underlyingAddress,
-        'approve',
-        [ sdrTokenAddress, amountBN ],
-        options
-      );
-    }
-  }
-
-  const parameters = [];
-  if (isNative) {
-    options.value = amountBN;
-  } else {
-    parameters.push(amountBN);
-  }
-
-  return eth.trx(sdrTokenAddress, 'mint', parameters, options);
-}
-
-/**
- * Redeems the user's Binance Smart Chain asset from the Sumer Protocol.
- *
- * @param {string} asset A string of the asset to redeem, or its sdrToken name.
- * @param {number | string | BigNumber} amount A string, number, or BigNumber
- *     object of the amount of an asset to redeem. Use the `mantissa` boolean in
- *     the `options` parameter to indicate if this value is scaled up (so there 
- *     are no decimals) or in its natural scale. This can be an amount of 
- *     sdrTokens or underlying asset (use the `asset` parameter to specify).
- * @param {CallOptions} [options] Call options and Ethers.js overrides for the 
- *     transaction.
- *
- * @returns {object} Returns an Ethers.js transaction object of the redeem
- *     transaction.
- *
- * @example
- *
- * ```
- * const sumer = new Sumer(window.ethereum);
- * 
- * (async function() {
- * 
- *   console.log('Redeeming SXP...');
- *   const trx = await sumer.redeem(Sumer.SXP, 1); // also accepts sdrToken args
- *   console.log('Ethers.js transaction object', trx);
- * 
- * })().catch(console.error);
- * ```
- */
-export async function redeem(
-  asset: string,
-  amount: string | number | BigNumber,
-  options: CallOptions = {}
-): Promise<TrxResponse> {
-  await netId(this);
-  const errorPrefix = 'Sumer [redeem] | ';
-
-  if (typeof asset !== 'string' || asset.length < 1) {
-    throw Error(errorPrefix + 'Argument `asset` must be a non-empty string.');
-  }
-
-  const assetIsVToken = asset.startsWith('sdr')
-  const isNative = (asset === address[this._network.name]["nativeToken"]);
-  const sdrTokenName = assetIsVToken ? asset : 'sdr' + asset;
-  const sdrTokenAddress = address[this._network.name][sdrTokenName];
-
-  const underlyingName = assetIsVToken ? asset.slice(1, asset.length) : asset;
-
-  if (!cTokens.includes(sdrTokenName) || !underlyings.includes(underlyingName)) {
-    throw Error(errorPrefix + 'Argument `asset` is not supported.');
-  }
-
-  if (
-    typeof amount !== 'number' &&
-    typeof amount !== 'string' &&
-    !ethers.BigNumber.isBigNumber(amount)
-  ) {
-    throw Error(errorPrefix + 'Argument `amount` must be a string, number, or BigNumber.');
-  }
-
-  let amountBN: ethers.BigNumber;
-  if (typeof amount == 'number' || typeof amount == 'string'){
-    amountBN = ethers.BigNumber.from(amount);
-  } else{
-    amountBN = ethers.BigNumber.from(amount.toString());
-  }
-
-  if (!options.mantissa) {
-    amountBN = amountBN.abs();
-    amountBN = amountBN.mul( ethers.BigNumber.from(10).pow(decimals[asset]));
-  }
-
-  const trxOptions: CallOptions = {
-    ...options,
-    _compoundProvider: this._provider,
-    abi: isNative ? abi.sdrNative : abi.sdrHrc20,
-  };
-  const parameters = [ amountBN ];
-  const method = assetIsVToken ? 'redeem' : 'redeemUnderlying';
-
-  return eth.trx(sdrTokenAddress, method, parameters, trxOptions);
-}
-
-/**
- * Borrows an Binance Smart Chain asset from the Sumer Protocol for the user.
- *     The user's address must first have supplied collateral and entered a 
- *     corresponding market.
- *
- * @param {string} asset A string of the asset to borrow (must be a supported 
- *     underlying asset).
- * @param {number | string | BigNumber} amount A string, number, or BigNumber
- *     object of the amount of an asset to borrow. Use the `mantissa` boolean in
- *     the `options` parameter to indicate if this value is scaled up (so there 
- *     are no decimals) or in its natural scale.
- * @param {CallOptions} [options] Call options and Ethers.js overrides for the 
- *     transaction.
- *
- * @returns {object} Returns an Ethers.js transaction object of the borrow
- *     transaction.
- *
- * @example
- *
- * ```
- * const sumer = new Sumer(window.ethereum);
- * 
- * (async function() {
- * 
- *   const sxpScaledUp = '32000000000000000000';
- *   const trxOptions = { mantissa: true };
- * 
- *   console.log('Borrowing 32 SXP...');
- *   const trx = await sumer.borrow(Sumer.SXP, sxpScaledUp, trxOptions);
- * 
- *   console.log('Ethers.js transaction object', trx);
- * 
- * })().catch(console.error);
- * ```
- */
-export async function borrow(
-  asset: string,
-  amount: string | number | BigNumber,
-  options: CallOptions = {}
-) : Promise<TrxResponse> {
-  await netId(this);
-  const errorPrefix = 'Sumer [borrow] | ';
-  const isNative = (asset === address[this._network.name]["nativeToken"]);
-  const sdrTokenName = 'sdr' + asset;
-  const sdrTokenAddress = address[this._network.name][sdrTokenName];
-
-  if (!sdrTokenAddress || !underlyings.includes(asset)) {
-    throw Error(errorPrefix + 'Argument `asset` cannot be borrowed.');
-  }
-
-  if (
-    typeof amount !== 'number' &&
-    typeof amount !== 'string' &&
-    !ethers.BigNumber.isBigNumber(amount)
-  ) {
-    throw Error(errorPrefix + 'Argument `amount` must be a string, number, or BigNumber.');
-  }
-
-  let amountBN: ethers.BigNumber;
-  if (typeof amount == 'number' || typeof amount == 'string'){
-    amountBN = ethers.BigNumber.from(amount);
-  } else{
-    amountBN = ethers.BigNumber.from(amount.toString());
-  }
-
-  if (!options.mantissa) {
-    amountBN = amountBN.abs();
-    amountBN = amountBN.mul( ethers.BigNumber.from(10).pow(decimals[asset]));
-  }
-
-  const trxOptions: CallOptions = {
-    ...options,
-    _compoundProvider: this._provider,
-  };
-  const parameters = [ amountBN ];
-  trxOptions.abi = isNative ? abi.sdrNative : abi.sdrHrc20;
-
-  return eth.trx(sdrTokenAddress, 'borrow', parameters, trxOptions);
-}
-
-/**
- * Repays a borrowed Binance Smart Chain asset for the user or on behalf of 
- *     another Binance Smart Chain address.
- *
- * @param {string} asset A string of the asset that was borrowed (must be a 
- *     supported underlying asset).
- * @param {number | string | BigNumber} amount A string, number, or BigNumber
- *     object of the amount of an asset to borrow. Use the `mantissa` boolean in
- *     the `options` parameter to indicate if this value is scaled up (so there 
- *     are no decimals) or in its natural scale.
- * @param {string | null} [borrower] The Binance Smart Chain address of the borrower 
- *     to repay an open borrow for. Set this to `null` if the user is repaying
- *     their own borrow.
- * @param {boolean} noApprove Explicitly prevent this method from attempting an 
- *     ERC-20 `approve` transaction prior to sending the subsequent repayment 
- *     transaction.
- * @param {CallOptions} [options] Call options and Ethers.js overrides for the 
- *     transaction. A passed `gasLimit` will be used in both the `approve` (if 
- *     not supressed) and `repayBorrow` or `repayBorrowBehalf` transactions.
- *
- * @returns {object} Returns an Ethers.js transaction object of the repayBorrow
- *     or repayBorrowBehalf transaction.
- *
- * @example
- *
- * ```
- * const sumer = new Sumer(window.ethereum);
- * 
- * (async function() {
- * 
- *   console.log('Repaying SXP borrow...');
- *   const address = null; // set this to any address to repayBorrowBehalf
- *   const trx = await sumer.repayBorrow(Sumer.SXP, 32, address);
- * 
- *   console.log('Ethers.js transaction object', trx);
- * 
- * })().catch(console.error);
- * ```
- */
-export async function repayBorrow(
-  asset: string,
-  amount: string | number | BigNumber,
-  borrower: string,
-  noApprove = false,
-  options: CallOptions = {}
-) : Promise<TrxResponse> {
-  await netId(this);
-  const errorPrefix = 'Sumer [repayBorrow] | ';
-  const isNative = (asset === address[this._network.name]["nativeToken"]);
-  const sdrTokenName = 'sdr' + asset;
-  const sdrTokenAddress = address[this._network.name][sdrTokenName];
-
-  if (!sdrTokenAddress || !underlyings.includes(asset)) {
-    throw Error(errorPrefix + 'Argument `asset` is not supported.');
-  }
-
-  if (
-    typeof amount !== 'number' &&
-    typeof amount !== 'string' &&
-    !ethers.BigNumber.isBigNumber(amount)
-  ) {
-    throw Error(errorPrefix + 'Argument `amount` must be a string, number, or BigNumber.');
-  }
-
-  const method = ethers.utils.isAddress(borrower) ? 'repayBorrowBehalf' : 'repayBorrow';
-  if (borrower && method === 'repayBorrow') {
-    throw Error(errorPrefix + 'Invalid `borrower` address.');
-  }
-
-  let amountBN: ethers.BigNumber;
-  if (typeof amount == 'number' || typeof amount == 'string'){
-    amountBN = ethers.BigNumber.from(amount);
-  } else{
-    amountBN = ethers.BigNumber.from(amount.toString());
-  }
-
-  if (!options.mantissa) {
-    amountBN = amountBN.abs();
-    amountBN = amountBN.mul( ethers.BigNumber.from(10).pow(decimals[asset]));
-  }
-
-  const trxOptions: CallOptions = {
-    ...options,
-    _compoundProvider: this._provider,
-  };
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const parameters: any[] = method === 'repayBorrowBehalf' ? [ borrower ] : [];
-  if (isNative) {
-    trxOptions.value = amountBN;
-    trxOptions.abi = abi.sdrNative;
-  } else {
-    parameters.push(amountBN);
-    trxOptions.abi = abi.sdrHrc20;
-  }
-
-  if (!isNative && noApprove !== true) {
-    const underlyingAddress = address[this._network.name][asset];
-    const userAddress = this._originalProvider.selectedAddress;
-    // Check allowance
-    const allowance = await eth.read(
-      underlyingAddress,
-      'allowance',
-      [ userAddress, sdrTokenAddress ],
-      trxOptions
-    );
-
-    const notEnough = allowance.lt(amountBN);
-
-    if (notEnough) {
-      // ERC-20 approve transaction
-      await eth.trx(
-        underlyingAddress,
-        'approve',
-        [ sdrTokenAddress, amountBN ],
-        trxOptions
-      );
-    }
-  }
-
-  return eth.trx(sdrTokenAddress, method, parameters, trxOptions);
-}

package/test/eth.test.js

@@ -1,12 +0,0 @@
-// TODO: Needs babel config in parent dir, that currently messes with the build
-// process so I deleted it.
-// TODO: Get mock working for ethers so we don't make real calls during tests.
-
-import Sumer from '../src/index';
-
-test('Sumer constructor', async () => {
-  const sumer = new Sumer('http://3.10.133.254:8575');
-
-  console.log(sumer.keys);
-  expect(sumer).toBe(true);
-});

package/tsconfig.json

@@ -1,12 +0,0 @@
-{
-  "compilerOptions": {
-    "outDir": "dist/nodejs/",
-    "lib": ["es6", "dom"],
-    "resolveJsonModule": true,
-    "sourceMap": true,
-    "declaration": true
-  },
-  "include": [
-    "src/**/*.ts"
-  ]
-}

package/typedoc.json

@@ -1,9 +0,0 @@
-{
-  "excludeNotDocumented": true,
-  "excludeExternals": true,
-  "excludePrivate": true,
-  "includeDeclarations": true,
-  "hideGenerator": true,
-  "includeVersion": true,
-  "name": "Sumer.js"
-}

package/unitroller.js

@@ -1,45 +0,0 @@
-/** 
- * Example of calling JSON RPC's eth_sendTransaction with Sumer.js
- *
- * Run ganache-cli in another command line window before running this script. Be
- *     sure to fork mainnet.
-
-ganache-cli \
-  -f https://mainnet.infura.io/v3/_YOUR_INFURA_ID_ \
-  -m "clutch captain shoe salt awake harvest setup primary inmate ugly among become" \
-  -i 1
-
- */
-
-const Sumer = require('./dist/nodejs/index.js');
-
-const provider = 'https://http-testnet.hecochain.com/';
-const privateKey = '';
-const account = '0x0205c2D862cA051010698b69b54278cbAf945C0b';
-// const mnemonic = 'clutch captain shoe salt awake harvest setup primary inmate ugly among become';
-const sumer = new Sumer(provider, {privateKey});
-
-// call enterMarkets methods
-(async function () {
-  
-  const options = { from: account, gasLimit: 250000, mantissa: false };
-  const markets = [Sumer.sdrETH, Sumer.sdrHETH, Sumer.sdrHUSD];
-
-  const trx = await sumer.enterMarkets(markets, options); // Use [] for multiple
-   console.log('Ethers.js transaction object', trx);
-})().catch(console.error);
-
-
-// call exitMarkets Methods
-(async function () {
-  
-  const options = { from: account, gasLimit: 250000, mantissa: false };
-  const markets = [Sumer.sdrETH, Sumer.sdrHETH, Sumer.sdrHUSD];
-
-  const trx = await sumer.enterMarkets(markets, options); // Use [] for multiple
-   console.log('Ethers.js transaction object', trx);
-})().catch(console.error);
-
-
-// call callcallatoralfactor
-