@meterio/sumer-js 0.0.12 → 0.1.0

package/dist/nodejs/comp.d.ts

@@ -1,420 +1,25 @@
 /**
  * @file COMP
- * @desc These methods facilitate interactions with the suUSD token smart
+ * @desc These methods facilitate interactions with the COMP token smart
  *     contract.
  */
-import { CallOptions, TrxResponse, Signature, Provider } from './types';
-import { BigNumber } from '@ethersproject/bignumber/lib/bignumber';
+export {};
 /**
- * Get the balance of Sumer tokens held by an address.
+ * Get the balance of COMP tokens held by an address.
  *
- * @param {string} _address The address in which to find the SUMER balance.
+ * @param {string} _address The address in which to find the COMP balance.
  * @param {Provider | string} [_provider] An Ethers.js provider or valid network
  *     name string.
  *
- * @returns {string} Returns a string of the numeric balance of SUMER. The value
+ * @returns {string} Returns a string of the numeric balance of COMP. The value
  *     is scaled up by 18 decimal places.
  *
  * @example
  *
  * ```
  * (async function () {
- *   const bal = await Sumer.sumer.getSumerBalance('0x2775b1c75658Be0F640272CCb8c72ac986009e38');
+ *   const bal = await Sumer.comp.getCompBalance('0x2775b1c75658Be0F640272CCb8c72ac986009e38');
  *   console.log('Balance', bal);
  * })().catch(console.error);
  * ```
  */
-export declare function getSumerBalance(_address: string, _provider?: Provider | string): Promise<string>;
-/**
- * Get the amount of SUMER tokens accrued but not yet claimed by an address.
- *
- * @param {string} _address The address in which to find the SUMER accrued.
- * @param {Provider | string} [_provider] An Ethers.js provider or valid network
- *     name string.
- *
- * @returns {string} Returns a string of the numeric accruement of SUMER. The
- *     value is scaled up by 18 decimal places.
- *
- * @example
- *
- * ```
- * (async function () {
- *   const acc = await Sumer.sumer.getSumerAccrued('0x4Ddc2D193948926D02f9B1fE9e1daa0718270ED5');
- *   console.log('Accrued', acc);
- * })().catch(console.error);
- * ```
- */
-export declare function getSumerAccrued(_address: string, _provider?: Provider | string): Promise<string>;
-/**
- * Create a transaction to claim accrued SUMER tokens for the user.
- *
- * @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() {
- *
- *   console.log('Claiming Sumer...');
- *   const trx = await sumer.claimSumer();
- *   console.log('Ethers.js transaction object', trx);
- *
- * })().catch(console.error);
- * ```
- */
-export declare function claimSumer(options?: CallOptions): Promise<TrxResponse>;
-/**
- * Create a transaction to delegate Sumer Governance voting rights to an
- *     address.
- *
- * @param {string} _address The address in which to delegate voting rights to.
- * @param {CallOptions} [options] Options to set for `eth_call`, optional ABI
- *     (as JSON object), and Ethers.js method overrides. The ABI can be a string
- *     of the single intended method, an array of many methods, or a JSON object
- *     of the ABI generated by a Solidity compiler.
- *
- * @returns {object} Returns an Ethers.js transaction object of the vote
- *     transaction.
- *
- * @example
- *
- * ```
- * const sumer = new Sumer(window.ethereum);
- *
- * (async function() {
- *   const delegateTx = await sumer.delegate('0xa0df350d2637096571F7A701CBc1C5fdE30dF76A');
- *   console.log('Ethers.js transaction object', delegateTx);
- * })().catch(console.error);
- * ```
- */
-export declare function delegate(_address: string, options?: CallOptions): Promise<TrxResponse>;
-/**
- * Delegate voting rights in Sumer Governance using an EIP-712 signature.
- *
- * @param {string} _address The address to delegate the user's voting rights to.
- * @param {number} nonce The contract state required to match the signature.
- *     This can be retrieved from the SUMER contract's public nonces mapping.
- * @param {number} expiry The time at which to expire the signature. A block
- *     timestamp as seconds since the unix epoch.
- * @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 `eth_call`, optional ABI
- *     (as JSON object), and Ethers.js method overrides. The ABI can be a string
- *     of the single intended method, an array of many methods, or a JSON object
- *     of the ABI generated by a Solidity compiler.
- *
- * @returns {object} Returns an Ethers.js transaction object of the vote
- *     transaction.
- *
- * @example
- *
- * ```
- * const sumer = new Sumer(window.ethereum);
- *
- * (async function() {
- *   const delegateTx = await sumer.delegateBySig(
- *     '0xa0df350d2637096571F7A701CBc1C5fdE30dF76A',
- *     42,
- *     9999999999,
- *     {
- *       v: '0x1b',
- *       r: '0x130dbca2fafa07424c033b4479687cc1deeb65f08809e3ab397988cc4c6f2e78',
- *       s: '0x1debeb8250262f23906b1177161f0c7c9aa3641e8bff5b6f5c88a6bb78d5d8cd'
- *     }
- *   );
- *   console.log('Ethers.js transaction object', delegateTx);
- * })().catch(console.error);
- * ```
- */
-export declare function delegateBySig(_address: string, nonce: number, expiry: number, signature?: Signature, options?: CallOptions): Promise<TrxResponse>;
-/**
- * Create a delegate signature for Sumer Governance using EIP-712. The
- *     signature can be created without burning gas. Anyone can post it to the
- *     blockchain using the `delegateBySig` method, which does have gas costs.
- *
- * @param {string} delegatee The address to delegate the user's voting rights
- *     to.
- * @param {number} [expiry] The time at which to expire the signature. A block
- *     timestamp as seconds since the unix epoch. Defaults to `10e9`.
- *
- * @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 delegateSignature = await sumer.createDelegateSignature('0xa0df350d2637096571F7A701CBc1C5fdE30dF76A');
- *   console.log('delegateSignature', delegateSignature);
- *
- * })().catch(console.error);
- * ```
- */
-export declare function createDelegateSignature(delegatee: string, expiry?: number): Promise<Signature>;
-/**
- * Get the mintable suUSD amount of address.
- *
- * @param {string} _address The address in which to get mintable suUSD amount.
- * @param {CallOptions} [options] Options to set for `eth_call`, optional ABI
- *     (as JSON object), and Ethers.js method overrides. The ABI can be a string
- *     of the single intended method, an array of many methods, or a JSON object
- *     of the ABI generated by a Solidity compiler.
- *
- * @returns {string} Returns a string of the numeric amount of mintable suUSD. The
- *     value is scaled up by 18 decimal places.
- *
- * @example
- *
- * ```
- * const sumer = new Sumer(window.ethereum);
- *
- * (async () => {
- *
- *   const amount = await sumer.getMintablesuUSD('0x4Ddc2D193948926D02f9B1fE9e1daa0718270ED5');
- *   console.log('MintablesuUSD amount', amount);
- *
- * })().catch(console.error);
- * ```
- */
-export declare function getMintablesuUSD(_address: string, options?: CallOptions): Promise<string>;
-/**
- * Get the suUSD mint rate.
- *
- * @param {CallOptions} [options] Options to set for `eth_call`, optional ABI
- *     (as JSON object), and Ethers.js method overrides. The ABI can be a string
- *     of the single intended method, an array of many methods, or a JSON object
- *     of the ABI generated by a Solidity compiler.
- *
- * @returns {string} Returns a string of the numeric suUSD mint rate.
- *
- * @example
- *
- * ```
- * const sumer = new Sumer(window.ethereum);
- *
- * (async () => {
- *
- *   const rate = await sumer.getsuUSDMintRate();
- *   console.log('suUSD mint rate', rate);
- *
- * })().catch(console.error);
- * ```
- */
-export declare function getsuUSDMintRate(options?: CallOptions): Promise<string>;
-/**
- * Get the mintsuUSDGuardianPaused.
- *
- * @param {CallOptions} [options] Options to set for `eth_call`, optional ABI
- *     (as JSON object), and Ethers.js method overrides. The ABI can be a string
- *     of the single intended method, an array of many methods, or a JSON object
- *     of the ABI generated by a Solidity compiler.
- *
- * @returns {boolean} Returns a string of the boolean mintsuUSDGuardianPaused.
- *
- * @example
- *
- * ```
- * const sumer = new Sumer(window.ethereum);
- *
- * (async () => {
- *
- *   const _mintsuUSDGuardianPaused = await sumer.mintsuUSDGuardianPaused();
- *   console.log('mintsuUSDGuardianPaused', _mintsuUSDGuardianPaused);
- *
- * })().catch(console.error);
- * ```
- */
-export declare function mintsuUSDGuardianPaused(options?: CallOptions): Promise<string>;
-/**
- * Get the repaysuUSDGuardianPaused.
- *
- * @param {CallOptions} [options] Options to set for `eth_call`, optional ABI
- *     (as JSON object), and Ethers.js method overrides. The ABI can be a string
- *     of the single intended method, an array of many methods, or a JSON object
- *     of the ABI generated by a Solidity compiler.
- *
- * @returns {boolean} Returns a string of the boolean repaysuUSDGuardianPaused.
- *
- * @example
- *
- * ```
- * const sumer = new Sumer(window.ethereum);
- *
- * (async () => {
- *
- *   const _repaysuUSDGuardianPaused = await sumer.repaysuUSDGuardianPaused();
- *   console.log('repaysuUSDGuardianPaused', _repaysuUSDGuardianPaused);
- *
- * })().catch(console.error);
- * ```
- */
-export declare function repaysuUSDGuardianPaused(options?: CallOptions): Promise<string>;
-/**
- * Get the minted suUSD amount of the address.
- *
- * @param {string} _address The address in which to get the minted suUSD amount.
- * @param {CallOptions} [options] Options to set for `eth_call`, optional ABI
- *     (as JSON object), and Ethers.js method overrides. The ABI can be a string
- *     of the single intended method, an array of many methods, or a JSON object
- *     of the ABI generated by a Solidity compiler.
- *
- * @returns {string} Returns a string of the numeric amount of minted suUSD. The
- *     value is scaled up by 18 decimal places.
- *
- * @example
- *
- * ```
- * const sumer = new Sumer(window.ethereum);
- *
- * (async () => {
- *
- *   const amount = await sumer.mintedsuUSDOf('0x4Ddc2D193948926D02f9B1fE9e1daa0718270ED5');
- *   console.log('Minted suUSD amount', amount);
- *
- * })().catch(console.error);
- * ```
- */
-export declare function mintedsuUSDOf(_address: string, options?: CallOptions): Promise<string>;
-/**
- * Get the minted suUSD amount of the address.
- *
- * @param {string} _address The address in which to get the minted suUSD amount.
- * @param {CallOptions} [options] Options to set for `eth_call`, optional ABI
- *     (as JSON object), and Ethers.js method overrides. The ABI can be a string
- *     of the single intended method, an array of many methods, or a JSON object
- *     of the ABI generated by a Solidity compiler.
- *
- * @returns {string} Returns a string of the numeric amount of minted suUSD. The
- *     value is scaled up by 18 decimal places.
- *
- * @example
- *
- * ```
- * const sumer = new Sumer(window.ethereum);
- *
- * (async () => {
- *
- *   const amount = await sumer.mintedsuUSDs('0x4Ddc2D193948926D02f9B1fE9e1daa0718270ED5');
- *   console.log('Minted suUSD amount', amount);
- *
- * })().catch(console.error);
- * ```
- */
-export declare function mintedsuUSDs(_address: string, options?: CallOptions): Promise<string>;
-/**
- * Get the suusdController.
- *
- * @param {CallOptions} [options] Options to set for `eth_call`, optional ABI
- *     (as JSON object), and Ethers.js method overrides. The ABI can be a string
- *     of the single intended method, an array of many methods, or a JSON object
- *     of the ABI generated by a Solidity compiler.
- *
- * @returns {string} Returns a string of the suusdController address.
- *
- * @example
- *
- * ```
- * const sumer = new Sumer(window.ethereum);
- *
- * (async () => {
- *
- *   const suusdControllerAddress = await sumer.suusdController();
- *   console.log('suusdControllerAddress', suusdControllerAddress);
- *
- * })().catch(console.error);
- * ```
- */
-export declare function suusdController(options?: CallOptions): Promise<string>;
-/**
- * Get the suusdMintRate.
- *
- * @param {CallOptions} [options] Options to set for `eth_call`, optional ABI
- *     (as JSON object), and Ethers.js method overrides. The ABI can be a string
- *     of the single intended method, an array of many methods, or a JSON object
- *     of the ABI generated by a Solidity compiler.
- *
- * @returns {string} Returns a string of the numeric suusdMintRate.
- *
- * @example
- *
- * ```
- * const sumer = new Sumer(window.ethereum);
- *
- * (async () => {
- *
- *   const suusdMintRate = await sumer.suusdMintRate();
- *   console.log('suusdMintRate', suusdMintRate);
- *
- * })().catch(console.error);
- * ```
- */
-export declare function suusdMintRate(options?: CallOptions): Promise<string>;
-/**
- * Mint suUSD in the Sumer Protocol.
- *
- * @param {number | string | BigNumber} mintsuUSDAmount A string, number, or BigNumber
- *     object of the amount of an asset to mintsuUSD. 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 mintsuUSD
- *     transaction.
- *
- * @example
- *
- * ```
- * const sumer = new Sumer(window.ethereum);
- *
- * // const trxOptions = { gasLimit: 250000, mantissa: false };
- *
- * (async function() {
- *
- *   console.log('Minting suUSD in the Sumer Protocol...');
- *   const trx = await sumer.mintsuUSD(1);
- *   console.log('Ethers.js transaction object', trx);
- *
- * })().catch(console.error);
- * ```
- */
-export declare function mintsuUSD(mintsuUSDAmount: string | number | BigNumber, options?: CallOptions): Promise<TrxResponse>;
-/**
- * Repay suUSD in the Sumer Protocol.
- *
- * @param {number | string | BigNumber} repaysuUSDAmount A string, number, or BigNumber
- *     object of the amount of an asset to repay. 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 repaysuUSD
- *     transaction.
- *
- * @example
- *
- * ```
- * const sumer = new Sumer(window.ethereum);
- *
- * // const trxOptions = { gasLimit: 250000, mantissa: false };
- *
- * (async function() {
- *
- *   console.log('Repaying suUSD in the Sumer Protocol...');
- *   const trx = await sumer.repaysuUSD(1);
- *   console.log('Ethers.js transaction object', trx);
- *
- * })().catch(console.error);
- * ```
- */
-export declare function repaysuUSD(repaysuUSDAmount: string | number | BigNumber, options?: CallOptions): Promise<TrxResponse>;