This repository is now deprecated and any and all current or future PRs and issues will be ignored and won't be merged. Please use minswap-tokens repository from now on.
Transparent, accurate and open-sourced circulating supply and market cap calculation for Cardano's native tokens.
This package doesn't expose market cap by itself, but only circulating supply and total supply.
Market cap = Circulating supply * Market price
Fully-diluted market cap = Total supply * Market price
You can use Blockfrost Adapter to query market price from Minswap.
- NPM:
npm install @minswap/market-cap - Yarn:
yarn add @minswap/market-cap
import { supplyFetchers } from "@minswap/market-cap"; const minInfo = await supplyFetchers[ "29d222ce763455e3d7a09a665ce554f00ac89d2e99a1a83d267170c64d494e" ](); console.log(minInfo); // { circulating: '240813714.66121483', total: '5000000000' }
- Create a file in
src/tokenswith your token's name and export default a function of typeSupplyFetcher. - Import the function into
src/index.tsand add the corresponding entry insupplyFetchersmap with the key being the concatenation of your token's policyID and assetName - Test your function:
# only if you use Blockfrost export BLOCKFROST_PROJECT_ID=<your_blockfrost_key> ONLY_TEST=<your_policy_id_concat_with_asset_name> npm test
- Run format:
npm run format
- MIN token fetcher: src/tokens/min.ts
- Add entry to
index.ts:
import minFetcher from "./tokens/min"; export const supplyFetchers: Record<string, SupplyFetcher> = { "29d222ce763455e3d7a09a665ce554f00ac89d2e99a1a83d267170c64d494e": minFetcher, ... };
- Run test:
export BLOCKFROST_PROJECT_ID=<your_blockfrost_key> ONLY_TEST=29d222ce763455e3d7a09a665ce554f00ac89d2e99a1a83d267170c64d494e npm test