@munityclubs/verifiable-token-transparency

Public transparency endpoint schema and supply math helpers for token projects.

Munity uses this pattern for public, no-auth endpoints that reviewers, wallets, exchanges, and grant programs can verify without private dashboard access.

Install

npm install @munityclubs/verifiable-token-transparency

Endpoint Pattern

Recommended public endpoints:

• /api/transparency/stats
• /api/transparency/circulating-supply
• /api/transparency/total-supply

Supply endpoints should use bare exchange-friendly shapes:

{ "totalSupply": 1000000000 }

{ "circulatingSupply": 287634900 }

Stats endpoints may use either a bare object or { "success": true, "data": {} }.

Usage

import {
  computeCirculatingSupply,
  normalizeStatsResponse,
  validateCirculatingSupplyResponse,
  validateTotalSupplyResponse,
} from "@munityclubs/verifiable-token-transparency";

const circulatingSupply = computeCirculatingSupply({
  totalSupply: 1_000_000_000,
  lockedAmount: 712_365_100,
  unlocksAt: "2027-05-12T00:00:00Z",
});

validateTotalSupplyResponse({ totalSupply: 1_000_000_000 });
validateCirculatingSupplyResponse({ circulatingSupply });
const normalized = normalizeStatsResponse(statsApiJson);

Why This Exists

Grant and exchange reviewers need facts they can fetch:

• holder counts
• daily active addresses
• 30-day fee revenue
• circulating supply
• public lock contract references

The package keeps those response shapes explicit and reusable so token projects can expose transparent, machine-checkable metrics instead of only screenshots or marketing copy.

Development

yarn install
yarn test

License

MIT