ethersphere/bzz-token-service repository overview

⁠BZZ Token Service

Webservice for providing token price and supply information to token websites like Coinmarketcap⁠ and Coingecko⁠.

The project is a Node.js webservice providing certain endpoints⁠.

For accessing the bonding curve for the total supply the default mainnet Infura is used because the amount of request is expected to be around one per hour from the token websites.

⁠Installation

npm install

⁠Starting the webservice

npm start

⁠Environment variables

• TOKEN_CONTRACT_ADDRESS: the address of the BZZ token on the mainnet (default: 0x19062190b1925b5b6689d7073fdfc8c2976ef8cb)
• TOKEN_SERVICE_PORT: the port of the token webservice (default: 8765)
• INFURA_MAINNET_KEY: optional Infura API key (default: undefined)

⁠Endpoints

• /health: returns 200 OK when the service is ready
• /readiness: returns 200 OK when the service is ready
• /token_price: returns the token price in DAI
• /circulating_supply: returns the token supply in BZZ

⁠Maintainers

• vojtechsimetka⁠
• auhau⁠

See what "Maintainer" means here⁠.