An open source JavaScript library for getting the cryptocurrency total, circulating and max supply from block explorers.
- Node.js 12.13 or higher is required
- Install using NPM
Coinranking Supplies is a Node.js module available through the npm registry.
Before installing, download and install Node.js. Node.js 12.13 or higher is required.
Installation is done using the npm install command:
npm i @coinranking/suppliesList all supported drivers
const { drivers } = require('@coinranking/supplies');
console.log(drivers);List all supported blockchains
const { blockchains } = require('@coinranking/supplies');
console.log(blockchains);List all drivers that support a specific blockchain
const { selectDriversByBlockchain } = require('@coinranking/supplies');
console.log(selectDriversByBlockchain('Ethereum'));Get the supply of specific coin
const { Etherscan, Coin } = require('@coinranking/supplies');
const driver = new Etherscan({
secret: 'freekey',
});
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
.getSupply(coin)
.then((supply) => {
console.log(supply);
});After installation the supplies command will be available in your terminal. The CLI is available under node ./bin/supplies.js when developing.
supplies get <driver name>supplies get <driver name> -r <smart contract address>| Name | Flag | Description |
|---|---|---|
| Decimals |
-d, --decimals
|
Some drivers like Etherscan require decimals. |
| Reference |
-r, --reference
|
Reference is a unique id for a specific driver; for example a smart contract address. |
| Blockchain |
-b, --blockchain
|
Issuance blockchain; the blockchain the coin is issued on. This could be their own blockchain for coins like Bitcoin or Monero. Or for example Ethereum for ERC-20 tokens like Basic Attention Token. Providing the blockchain is required if the driver supports multiple blockchains |
| Modifiers |
-m, --modifiers
|
Wallets addresses to subtract from the total supply; for example wallets hold by the foundation or burn addresses. Split the addresses with a comma and without spaces. |
| Record |
-R, --record
|
Record the requests and coin, and save them as fixtures. This is for developing purposes. |
| API Key |
-k, --key
|
For passing down an API key when the driver requires one. When used in combination with the -r flag the key will be masked in the fixtures. |
| No cache | --nocache |
Skip using the cache. |
Install dependencies
npm run installThe CLI is available under node ./bin/supplies.js when developing
Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.