@swipewallet/venus-js/src/index.ts

A JavaScript SDK for Ethereum and the Venus Protocol.

/**
 * @file Venus
 * @desc This file defines the constructor of the `Venus` 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 { 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 Venus.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 venus = new Venus(window.ethereum); // web browser
 * 
 * var venus = new Venus('http://127.0.0.1:8545'); // HTTP provider
 * 
 * var venus = new Venus(); // Uses Ethers.js fallback mainnet (for testing only)
 * 
 * var venus = new Venus('testnet'); // Uses Ethers.js fallback (for testing only)
 * 
 * // Init with private key (server side)
 * var venus = new Venus('https://mainnet.infura.io/v3/_your_project_id_', {
 *   privateKey: '0x_your_private_key_', // preferably with environment variable
 * });
 * 
 * // Init with HD mnemonic (server side)
 * var venus = new Venus('mainnet' {
 *   mnemonic: 'clutch captain shoe...', // preferably with environment variable
 * });
 * ```
 *
 * @returns {object} Returns an instance of the Venus.js SDK.
 */
const Venus = 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,
    claimVenus: comp.claimVenus,
    delegate: comp.delegate,
    delegateBySig: comp.delegateBySig,
    createDelegateSignature: comp.createDelegateSignature,
    getMintableVAI: comp.getMintableVAI,
    getVAIMintRate: comp.getVAIMintRate,
    mintVAIGuardianPaused: comp.mintVAIGuardianPaused,
    repayVAIGuardianPaused: comp.repayVAIGuardianPaused,
    mintedVAIOf: comp.mintedVAIOf,
    mintedVAIs: comp.mintedVAIs,
    vaiController: comp.vaiController,
    vaiMintRate: comp.vaiMintRate,
    mintVAI: comp.mintVAI,
    repayVAI: comp.repayVAI,
  };

  // 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;
    }
    delete instance._networkPromise;
    instance._network = network;
  });

  return instance;
};

Venus.eth = eth;
Venus.api = api;
Venus.util = util;
Venus._ethers = ethers;
Venus.decimals = decimals;
Venus.venus = {
  getVenusBalance: comp.getVenusBalance,
  getVenusAccrued: comp.getVenusAccrued,
};
Object.assign(Venus, constants);

export = Venus;