Skip to content

Latest commit

 

History

History
173 lines (135 loc) · 7.7 KB

DOCUMENTATION.md

File metadata and controls

173 lines (135 loc) · 7.7 KB
Raw

Classes

Coin
Driver
SupplyModifier
Supply

Coin

Kind: global class
Properties

Name Type Description
options object The parameters of the coin.
options.reference string The unique identifier of a coin. Usually a smart contract address.
options.name string The name of the coin.
options.symbol string The symbol of the coin. Most of the time three characters long. E.g. BTC.
options.decimals number The amount of precision this coin uses. For most blockchains, this defaults to 18.
options.modifiers Array.<string> List of addresses of which the balance should be substracted from the supply to get the circulating supply. E.g. for ethereum the balance of address 0x0000000000000000000000000000000000000000 is substracted, because tokens are sent there to get 'burned'. See SupplyModifier.

new Coin()

Coin model provided to drivers that support multiple coins.

Example

const coin = new Coin({
  // Lets take the Basic Attention Token (BAT) for example.
  // The reference is the unique id for a specific driver;
  // which is a smart contract address in this case.
  name: 'Basic Attention Token',
  symbol: 'BAT',
  reference: '0x0d8775f648430679a709e98d2b0cb6250d2887ef',
  // Modifiers are blockchain addresses that get subtracted from the
  // total supply to get the circulating supply.
  modifiers: [
    '0x0000000000000000000000000000000000000000', // Burned address
    '0x0000000000000000000000000000000000000001', // Burned address
    '0x185f19b43d818e10a31be68f445ef8edcb8afb83', // Multisig address
    '0x67fa2c06c9c6d4332f330e14a66bdf1873ef3d2b', // Team Lock up address
    '0x7c31560552170ce96c4a7b018e93cddc19dc61b6', // UGP reserve address
  ],
  // Some drivers like Etherscan require decimals
  decimals: 18,
});

Driver

Kind: global class

new Driver()

Driver parent class, to be extended by drivers for specific block explorers.

Driver.fetchTotalSupply ⇒ number

Fetch the total supply of a coin.

Kind: static namespace of Driver
Returns: number - All the currently mined coins.

Driver.fetchCirculatingSupply ⇒ number

Fetch the circulating supply of a coin.

Kind: static namespace of Driver
Returns: number - The total supply minus coins not in circulation, such as burned, premined or escrowed coins.

Driver.fetchMaxSupply ⇒ number

Fetch the maximum supply of a coin.

Kind: static namespace of Driver
Returns: number - The maximum possible amount of supply ever to be reached.

Driver.fetchBalance ⇒ number

Fetch the balance on a specific address.

Kind: static namespace of Driver
Returns: number - The amount of coins on a specific address, which can be used as a modifier. to determine the circulating supply.

Driver.fetchTokenTotalSupply ⇒ number

Fetch the total supply of an token.

Kind: static namespace of Driver
Returns: number - Total amount of a token.

Driver.fetchTokenBalance ⇒ number

Fetch token balance.

Kind: static namespace of Driver
Returns: number - Balance of a specific token on a specific address, to be used as supply modifier in order to calculate the circulating supply.

Driver.getSupply ⇒ Promise.<Supply>

Drivers must include a getSupplies method. This method will call supported supply data such as methods to fetch total, circulating and max supply.

Kind: static namespace of Driver
Returns: Promise.<Supply> - Returns a promise of a supply model.

Param Type Description
[coin] Coin The getSupply method gets called with an coin instance.

SupplyModifier

Kind: global class
Properties

Name Type Description
options object The parameters of the supply modifier
options.reference string A unique identifier. An address that holds a balance.
options.balance number The balance of the adress.

new SupplyModifier()

One or more supply modifiers are used to calculate the circulating supply. A supply modifier is a balance on a specific address, that holds a balance. E.g. for ethereum the balance of address 0x0000000000000000000000000000000000000000 is substracted, because tokens are sent there to get 'burned'. These burned tokens do exist on the blockchain, but because they are not available to the public they are 'circulating'. So the 'total supply' minus these supply modifiers result in the 'circulating supply'. Also see Supply.

Supply

Kind: global class
Properties

Name Type Description
options object The parameters of the supply.
options.total number The amount of coins that is currently available on the blockchain, through either mining or pre-mined.
options.circulating number The total amount of coins, minus coins that are withold from the public. Coins can be withold by means of burning, escrowing or being pre-mined and undistributed. The circulating supply is fetched directly from a source or calculated by fetching modifiers, see options.modifiers in Coin.
options.max number In contrast to the total supply, the max supply is not only the currently available supply, but also the amount of coins that can be reached in the future. It's relevance differs per blockchain. E.g. Bitcoin has a fixed maximum supply of 21 million coins, upon which all it's coins are mined. Ethereum can also be mined, but for now there is an indefinite amount and thus no max supply. Other blockchains come pre-mined or might be completely mined already, which means the max supply equals the total supply.
options.modifiers Array.<SupplyModifier> Consists of a list of suply modifiers. See SupplyModifier.

new Supply()

Supply model, returned from all drivers.