butterjs-sdk
Version:
Butter Network SDK
60 lines (59 loc) • 2.09 kB
TypeScript
import { Currency } from './Currency';
import { Token } from './Token';
/**
* A currency is any fungible financial instrument, including EVMNativCoin, all ERC20 tokens, and other chain-native currencies
*/
export declare abstract class BaseCurrency {
/**
* Returns whether the currency is native to the chain and must be wrapped (e.g. EVMNativCoin)
*/
abstract readonly isNative: boolean;
/**
* Returns whether the currency is a token that is usable in Butter without wrapping
*/
abstract readonly isToken: boolean;
/**
* The chain ID on which this currency resides
*/
readonly chainId: string;
/**
* The decimals used in representing currency amounts
*/
readonly decimals: number;
/**
* The address of the token, 'ZERO_ADDRESS' when token is native token
*/
readonly address: string;
/**
* The symbol of the currency, i.e. a short textual non-unique identifier
*/
readonly symbol?: string;
/**
* The name of the currency, i.e. a descriptive textual non-unique identifier
*/
readonly name?: string;
/**
* logo of the token, for display only
*/
readonly logo?: string;
/**
* Constructs an instance of the base class `BaseCurrency`.
* @param chainId the chain ID on which this currency resides
* @param decimals decimals of the currency
* @param address address of the currency
* @param symbol symbol of the currency
* @param name of the currency
* @param logo of the currency
*/
protected constructor(chainId: string, decimals: number, address: string, symbol?: string, name?: string, logo?: string);
/**
* Returns whether this currency is functionally equivalent to the other currency
* @param other the other currency
*/
abstract equals(other: Currency): boolean;
/**
* Return the wrapped version of this currency that can be used with the butter contracts. Currencies must
* implement this to be used in butter
*/
abstract get wrapped(): Token;
}