@meterio/sumer-js 0.0.13 → 0.1.1

package/src/gov.ts

@@ -1,209 +0,0 @@
-/**
- * @file Governance
- * @desc These methods facilitate interactions with the Governor smart contract.
- */
-
-import * as eth from './eth';
-import { netId } from './helpers';
-import { address, abi } from './constants';
-import { sign } from './EIP712';
-import {
-  CallOptions,
-  TrxResponse,
-  Signature,
-  VoteSignatureMessage,
-  VoteTypes,
-  EIP712Domain
- } from './types';
-
-/**
- * Submit a vote on a Sumer Governance proposal.
- *
- * @param {string} proposalId The ID of the proposal to vote on. This is an
- *     auto-incrementing integer in the Governor Alpha contract.
- * @param {boolean} support A boolean of true for 'yes' or false for 'no' on the
- *     proposal vote.
- * @param {CallOptions} [options] Options to set for a transaction and Ethers.js
- *     method overrides.
- *
- * @returns {object} Returns an Ethers.js transaction object of the vote
- *     transaction.
- *
- * @example
- *
- * ```
- * const sumer = new Sumer(window.ethereum);
- * 
- * (async function() {
- *   const castVoteTx = await sumer.castVote(12, true);
- *   console.log('Ethers.js transaction object', castVoteTx);
- * })().catch(console.error);
- * ```
- */
-export async function castVote(
-  proposalId: number,
-  support: boolean,
-  options: CallOptions = {}
-) : Promise<TrxResponse> {
-  await netId(this);
-
-  const errorPrefix = 'Sumer [castVote] | ';
-
-  if (typeof proposalId !== 'number') {
-    throw Error(errorPrefix + 'Argument `proposalId` must be an integer.');
-  }
-
-  if (typeof support !== 'boolean') {
-    throw Error(errorPrefix + 'Argument `support` must be a boolean.');
-  }
-
-  const governorAddress = address[this._network.name].GovernorAlpha;
-  const trxOptions: CallOptions = options;
-  trxOptions._compoundProvider =  this._provider;
-  trxOptions.abi =  abi.GovernorAlpha;
-  const parameters = [ proposalId, support ];
-  const method = 'castVote';
-
-  return eth.trx(governorAddress, method, parameters, trxOptions);
-}
-
-/**
- * Submit a vote on a Sumer Governance proposal using an EIP-712 signature.
- *
- * @param {string} proposalId The ID of the proposal to vote on. This is an
- *     auto-incrementing integer in the Governor Alpha contract.
- * @param {boolean} support A boolean of true for 'yes' or false for 'no' on the
- *     proposal vote.
- * @param {object} signature An object that contains the v, r, and, s values of
- *     an EIP-712 signature.
- * @param {CallOptions} [options] Options to set for a transaction and Ethers.js
- *     method overrides.
- *
- * @returns {object} Returns an Ethers.js transaction object of the vote
- *     transaction.
- *
- * @example
- * ```
- * const sumer = new Sumer(window.ethereum);
- * 
- * (async function() {
- *   const castVoteTx = await sumer.castVoteBySig(
- *     12,
- *     true,
- *     {
- *       v: '0x1b',
- *       r: '0x130dbcd2faca07424c033b4479687cc1deeb65f08509e3ab397988cc4c6f2e78',
- *       s: '0x1debcb8250262f23906b1177161f0c7c9aa3641e6bff5b6f5c88a6bb78d5d8cd'
- *     }
- *   );
- *   console.log('Ethers.js transaction object', castVoteTx);
- * })().catch(console.error);
- * ```
- */
-export async function castVoteBySig(
-  proposalId: number,
-  support: boolean,
-  signature: Signature,
-  options: CallOptions = {}
-) : Promise<TrxResponse> {
-  await netId(this);
-
-  const errorPrefix = 'Sumer [castVoteBySig] | ';
-
-  if (typeof proposalId !== 'number') {
-    throw Error(errorPrefix + 'Argument `proposalId` must be an integer.');
-  }
-
-  if (typeof support !== 'boolean') {
-    throw Error(errorPrefix + 'Argument `support` must be a boolean.');
-  }
-
-  if (
-    !Object.isExtensible(signature) ||
-    !signature.v ||
-    !signature.r ||
-    !signature.s
-  ) {
-    throw Error(errorPrefix + 'Argument `signature` must be an object that ' + 
-      'contains the v, r, and s pieces of an EIP-712 signature.');
-  }
-
-  const governorAddress = address[this._network.name].GovernorAlpha;
-  const trxOptions: CallOptions = options;
-  trxOptions._compoundProvider = this._provider;
-  trxOptions.abi = abi.GovernorAlpha;
-  const { v, r, s } = signature;
-  const parameters = [ proposalId, support, v, r, s ];
-  const method = 'castVoteBySig';
-
-  return eth.trx(governorAddress, method, parameters, trxOptions);
-}
-
-/**
- * Create a vote signature for a Sumer Governance proposal using EIP-712.
- *     This can be used to create an 'empty ballot' without burning gas. The 
- *     signature can then be sent to someone else to post to the blockchain. 
- *     The recipient can post one signature using the `castVoteBySig` method.
- *
- * @param {string} proposalId The ID of the proposal to vote on. This is an
- *     auto-incrementing integer in the Governor Alpha contract.
- * @param {boolean} support A boolean of true for 'yes' or false for 'no' on the
- *     proposal vote. To create an 'empty ballot' call this method twice using
- *     `true` and then `false` for this parameter.
- *
- * @returns {object} Returns an object that contains the `v`, `r`, and `s` 
- *     components of an Ethereum signature as hexadecimal strings.
- *
- * @example
- * ```
- * const sumer = new Sumer(window.ethereum);
- *
- * (async () => {
- *
- *   const voteForSignature = await sumer.createVoteSignature(20, true);
- *   console.log('voteForSignature', voteForSignature);
- *
- *   const voteAgainstSignature = await sumer.createVoteSignature(20, false);
- *   console.log('voteAgainstSignature', voteAgainstSignature);
- *
- * })().catch(console.error);
- * ```
- */
-export async function createVoteSignature(
-  proposalId: number,
-  support: boolean
-) : Promise<Signature> {
-  await netId(this);
-
-  const provider = this._provider;
-  const governorAddress = address[this._network.name].GovernorAlpha;
-  const chainId = this._network.id;
-
-  const domain: EIP712Domain = {
-    name: 'Sumer Governor Alpha',
-    chainId,
-    verifyingContract: governorAddress
-  };
-
-  const primaryType = 'Ballot';
-
-  const message: VoteSignatureMessage = { proposalId, support };
-
-  const types: VoteTypes = {
-    EIP712Domain: [
-      { name: 'name', type: 'string' },
-      { name: 'chainId', type: 'uint256' },
-      { name: 'verifyingContract', type: 'address' },
-    ],
-    Ballot: [
-      { name: 'proposalId', type: 'uint256' },
-      { name: 'support', type: 'bool' }
-    ]
-  };
-
-  const signer = provider.getSigner ? provider.getSigner() : provider;
-
-  const signature = await sign(domain, primaryType, message, types, signer);
-
-  return signature;
-}

package/src/helpers.ts

@@ -1,19 +0,0 @@
-import { CompoundInstance } from './types';
-
-/**
- * This function acts like a decorator for all methods that interact with the
- *     blockchain. In order to use the correct Sumer Protocol addresses, the
- *     Sumer.js SDK must know which network its provider points to. This
- *     function holds up a transaction until the main constructor has determined
- *     the network ID.
- *
- * @hidden
- *
- * @param {Sumer} _compound The instance of the Sumer.js SDK.
- *
- */
-export async function netId(_compound: CompoundInstance): Promise<void> {
-  if (_compound._networkPromise) {
-    await _compound._networkPromise;
-  }
-}

package/src/index.ts

@@ -1,117 +0,0 @@
-/**
- * @file Sumer
- * @desc This file defines the constructor of the `Sumer` class.
- * @hidden
- */
-
-import { ethers } from 'ethers';
-import * as eth from './eth';
-import * as util from './util';
-import * as comptroller from './comptroller';
-import * as vToken from './vToken';
-import * as priceFeed from './priceFeed';
-import * as comp from './comp';
-import * as gov from './gov';
-import * as api from './api';
-import { abi, constants, decimals } from './constants';
-import { Provider, CompoundOptions, CompoundInstance } from './types';
-
-// 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('testnet'); // 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: Provider | string = 'mainnet', options: CompoundOptions = {}
-) : CompoundInstance {
-  const originalProvider = provider;
-
-  options.provider = provider || options.provider;
-  provider = eth._createProvider(options);
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const instance: any = {
-    _originalProvider: originalProvider,
-    _provider: provider,
-    ...comptroller,
-    ...vToken,
-    ...priceFeed,
-    ...gov,
-    claimSumer: comp.claimSumer,
-    delegate: comp.delegate,
-    delegateBySig: comp.delegateBySig,
-    createDelegateSignature: comp.createDelegateSignature,
-    getMintablesuUSD: comp.getMintablesuUSD,
-    getsuUSDMintRate: comp.getsuUSDMintRate,
-    mintsuUSDGuardianPaused: comp.mintsuUSDGuardianPaused,
-    repaysuUSDGuardianPaused: comp.repaysuUSDGuardianPaused,
-    mintedsuUSDOf: comp.mintedsuUSDOf,
-    mintedsuUSDs: comp.mintedsuUSDs,
-    suusdController: comp.suusdController,
-    suusdMintRate: comp.suusdMintRate,
-    mintsuUSD: comp.mintsuUSD,
-    repaysuUSD: comp.repaysuUSD,
-  };
-
-  // Instance needs to know which network the provider connects to, so it can
-  //     use the correct contract addresses.
-  instance._networkPromise = eth.getProviderNetwork(provider).then((network) => {    
-    instance.decimals = decimals;
-    if (network.id === 56 || network.name === "mainnet") {
-      instance.decimals.USDC = 18;
-      instance.decimals.USDT = 18;
-    }
-    if (network.id === 128){
-      network.name = 'HECO-mainnet'
-    }
-    if (network.id === 256){
-      network.name = 'HECO-testnet'
-    }
-    delete instance._networkPromise;
-    instance._network = network;
-  });
-
-  return instance;
-};
-
-Sumer.eth = eth;
-Sumer.api = api;
-Sumer.abi = abi;
-Sumer.util = util;
-Sumer._ethers = ethers;
-Sumer.decimals = decimals;
-Sumer.sumer = {
-  getSumerBalance: comp.getSumerBalance,
-  getSumerAccrued: comp.getSumerAccrued,
-};
-Object.assign(Sumer, constants);
-
-export = Sumer;

package/src/priceFeed.ts

@@ -1,169 +0,0 @@
-/**
- * @file Price Feed
- * @desc These methods facilitate interactions with the Open Price Feed smart
- *     contracts.
- */
-
-import * as eth from './eth';
-import { netId } from './helpers';
-import {
-  constants, address, abi, cTokens, underlyings, decimals, opfAssets
-} from './constants';
-import { BigNumber } from '@ethersproject/bignumber/lib/bignumber';
-import { CallOptions } from './types';
-
-function validateAsset(
-  asset: string,
-  argument: string,
-  errorPrefix: string
-) : (boolean | string | number)[] {
-  if (typeof asset !== 'string' || asset.length < 1) {
-    throw Error(errorPrefix + 'Argument `' + argument + '` must be a non-empty string.');
-  }
-
-  const assetIsVToken = asset[0] === 'sdr';
-
-  const vTokenName = assetIsVToken ? asset : 'sdr' + asset;
-  const vTokenAddress = address[this._network.name][vTokenName];
-
-  let underlyingName = assetIsVToken ? asset.slice(1, asset.length) : asset;
-  const underlyingAddress = address[this._network.name][underlyingName];
-
-  if (
-    (!cTokens.includes(vTokenName) || !underlyings.includes(underlyingName)) &&
-    !opfAssets.includes(underlyingName)
-  ) {
-    throw Error(errorPrefix + 'Argument `' + argument + '` is not supported.');
-  }
-
-  const underlyingDecimals = decimals[underlyingName];
-
-  // The open price feed reveals BTC, not WBTC.
-  underlyingName = underlyingName === 'WBTC' ? 'BTC' : underlyingName;
-
-  return [assetIsVToken, vTokenName, vTokenAddress, underlyingName, underlyingAddress, underlyingDecimals];
-}
-
-async function vTokenExchangeRate(
-  vTokenAddress: string,
-  vTokenName: string,
-  underlyingDecimals: number
-) : Promise<number> {
-  const address = vTokenAddress;
-  const isNative = (vTokenName === 'sdr'+address[this._network.name]["nativeToken"]);
-  const method = 'exchangeRateCurrent';
-  const options = {
-    _compoundProvider: this._provider,
-    abi: isNative ? abi.sdrNative : abi.sdrHrc20,
-  };
-  const exchangeRateCurrent = await eth.read(address, method, [], options);
-  const mantissa = 18 + underlyingDecimals - 8; // vToken always 8 decimals
-  const oneVTokenInUnderlying = exchangeRateCurrent / Math.pow(10, mantissa);
-
-  return oneVTokenInUnderlying;
-}
-
-/**
- * Gets an asset's price from the Sumer Protocol open price feed. The price
- *    of the asset can be returned in any other supported asset value, including
- *    all vTokens and underlyings.
- *
- * @param {string} asset A string of a supported asset in which to find the
- *     current price.
- * @param {string} [inAsset] A string of a supported asset in which to express
- *     the `asset` parameter's price. This defaults to USD.
- *
- * @returns {string} Returns a string of the numeric value of the asset.
- *
- * @example
- * ```
- * const sumer = new Sumer(window.ethereum);
- * let price;
- * 
- * (async function () {
- * 
- *   price = await sumer.getPrice(Sumer.BNB);
- *   console.log('BNB in USD', price);
- * 
- *   price = await sumer.getPrice(Sumer.SXP, Sumer.USDC); // supports vTokens too
- *   console.log('SXP in USDC', price);
- * 
- * })().catch(console.error);
- * ```
- */
-export async function getPrice(
-  asset: string,
-  inAsset: string = constants.USDC
-) : Promise<number> {
-  await netId(this);
-  const errorPrefix = 'Sumer [getPrice] | ';
-
-  const [
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    assetIsVToken, vTokenName, vTokenAddress, underlyingName, underlyingAddress, underlyingDecimals
-  ] = validateAsset.bind(this)(asset, 'asset', errorPrefix);
-
-  const [
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    inAssetIsVToken, inAssetVTokenName, inAssetVTokenAddress, inAssetUnderlyingName, inAssetUnderlyingAddress, inAssetUnderlyingDecimals
-  ] = validateAsset.bind(this)(inAsset, 'inAsset', errorPrefix);
-
-  // const priceFeedAddress = address[this._network.name].PriceFeed;
-  const comptrollerAddress = address[this._network.name].Comptroller;
-
-  const oracleTrxOptions: CallOptions = {
-    _compoundProvider: this._provider,
-    abi: abi.Comptroller,
-  };
-  const priceOracleAddress = await eth.read(comptrollerAddress, 'oracle', [], oracleTrxOptions);
-
-  // const trxOptions: CallOptions = {
-  //   _compoundProvider: this._provider,
-  //   abi: abi.PriceFeed,
-  // };
-
-  // const assetUnderlyingPrice = await eth.read(priceFeedAddress, 'price', [ underlyingName ], trxOptions);
-  // const inAssetUnderlyingPrice =  await eth.read(priceFeedAddress, 'price', [ inAssetUnderlyingName ], trxOptions);
-
-  const trxOptions: CallOptions = {
-    _compoundProvider: this._provider,
-    abi: abi.PriceOracle,
-  };
-  let assetUnderlyingPrice = await eth.read(priceOracleAddress, 'getUnderlyingPrice', [ vTokenAddress ], trxOptions);
-  const inAssetUnderlyingPrice =  await eth.read(priceOracleAddress, 'getUnderlyingPrice', [ inAssetVTokenAddress ], trxOptions);
-
-  const assetDecimal = decimals[asset];
-  const inAssetDecimal = decimals[inAsset];
-  if ((assetDecimal-inAssetDecimal) > 0) {
-    assetUnderlyingPrice = assetUnderlyingPrice.mul(BigNumber.from("10").pow(assetDecimal-inAssetDecimal));
-  } else {
-    assetUnderlyingPrice = assetUnderlyingPrice.div(BigNumber.from("10").pow(inAssetDecimal-assetDecimal));
-  }  
-
-  let assetVTokensInUnderlying, inAssetVTokensInUnderlying;
-
-  if (assetIsVToken) {
-    assetVTokensInUnderlying = await vTokenExchangeRate.bind(this)(vTokenAddress, vTokenName, underlyingDecimals);
-  }
-
-  if (inAssetIsVToken) {
-    inAssetVTokensInUnderlying = await vTokenExchangeRate.bind(this)(inAssetVTokenAddress, inAssetVTokenName, inAssetUnderlyingDecimals);
-  }
-
-  let result;
-  if (!assetIsVToken && !inAssetIsVToken) {
-    result = assetUnderlyingPrice / inAssetUnderlyingPrice;
-  } else if (assetIsVToken && !inAssetIsVToken) {
-    const assetInOther = assetUnderlyingPrice / inAssetUnderlyingPrice;
-    result = assetInOther * assetVTokensInUnderlying;
-  } else if (!assetIsVToken && inAssetIsVToken) {
-    const assetInOther = assetUnderlyingPrice / inAssetUnderlyingPrice;
-    result = assetInOther / inAssetVTokensInUnderlying;
-  } else {
-    const assetInOther = assetUnderlyingPrice / inAssetUnderlyingPrice;
-    const vTokensInUnderlying = assetInOther / assetVTokensInUnderlying;
-    result = inAssetVTokensInUnderlying * vTokensInUnderlying;
-  }
-
-  return result;
-}