Files
proxmox/docs/04-configuration/coingecko/CMC_COINGECKO_SUBMISSION_RUNBOOK.md
defiQUG bea1903ac9
Some checks failed
Deploy to Phoenix / deploy (push) Has been cancelled
Sync all local changes: docs, config, scripts, submodule refs, verification evidence
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-02-21 15:46:06 -08:00

5.1 KiB
Raw Blame History

CMC / CoinGecko Submission Runbook

Last Updated: 2026-02-15
Status: Canonical process for Chain 138 and 651940 listing submission
Purpose: Single runbook tying prerequisites, report API export, CoinGecko/CMC submission steps, and "where to update when done."


1. Prerequisites checklist

Before submitting, ensure:

  • Report API reachable: Token Aggregation Service is running and GET /api/v1/report/coingecko and GET /api/v1/report/cmc are reachable (e.g. https://your-api/report/coingecko, or localhost for export-only).
  • Token list export: You can export JSON from the report API (see §2). Optionally use COINGECKO_SUBMISSION_PACKAGE for chain/token tables.
  • Logos: Token logos 512×512 PNG for each token you submit. Chain logo if submitting the chain.
  • Chain details: Chain name, Chain ID, RPC URLs, block explorer, native currency (see COINGECKO_SUBMISSION_PACKAGE).

Note: If CoinGecko/CMC do not yet support ChainID 138 or 651940, keep this runbook for when they do; the report API remains the source of truth and you can submit as soon as the platforms add the chain.


2. Step-by-step submission

2.1 Export data from report API

# Chain 138
curl "https://<your-token-aggregation-url>/api/v1/report/coingecko?chainId=138" -o report-coingecko-138.json
curl "https://<your-token-aggregation-url>/api/v1/report/cmc?chainId=138" -o report-cmc-138.json

# Chain 651940 (ALL Mainnet)
curl "https://<your-token-aggregation-url>/api/v1/report/coingecko?chainId=651940" -o report-coingecko-651940.json
curl "https://<your-token-aggregation-url>/api/v1/report/cmc?chainId=651940" -o report-cmc-651940.json

# Cross-chain (CCIP, Alltra, Trustless) — events between Chain 138, ALL Mainnet, and reporting networks
curl "https://<your-token-aggregation-url>/api/v1/report/cross-chain?chainId=138" -o report-cross-chain-138.json

Use these files to fill CoinGecko/CMC forms or attach if they accept file upload. Response format is described in CMC_COINGECKO_REPORTING.md.

2.2 CoinGecko

  1. Chain submission (if applicable): Use CoinGecko listing request or partner/API. Provide chain name (e.g. "DeFi Oracle Meta Mainnet"), Chain ID (138 or 651940), RPC URLs, explorer, API URL e.g. https://<your-domain>/api/v1/report/coingecko?chainId=138.
  2. Token submission: For each token, provide contract address, symbol, name, decimals; attach logo 512×512. Use data from report-coingecko-138.json / report-coingecko-651940.json or from COINGECKO_SUBMISSION_CUSDT, COINGECKO_SUBMISSION_CUSDC, COINGECKO_SUBMISSION_PACKAGE.
  3. Reference: COINGECKO_SUBMISSION_GUIDE, smom-dbis-138 token-aggregation COINGECKO_SUBMISSION.

2.3 CoinMarketCap (CMC)

  1. Use CMCs listing/submission process (DEX or token form). Provide chain and token data in the format returned by GET /api/v1/report/cmc?chainId=138 (and 651940).
  2. Same token list and logos as for CoinGecko; CMC format includes pairs, volume_24h, market_cap, liquidity_usd as per CMC_COINGECKO_REPORTING.

3. Unsupported chains (138 / 651940)

CoinGecko and CMC may not list ChainID 138 or 651940 until they add the platform. Until then:

  • The report API still returns all our token and pool data.
  • External price/volume for our chains will be empty in their APIs.
  • When they add support, use this runbook and the same report API export to submit.

No code change is required; submission is manual when the platforms accept the chain.


4. When done — where to update

After submission (or when chains are listed), update the following so the rest of the repo stays in sync:

Document What to update
REMAINING_COMPONENTS_TASKS_AND_RECOMMENDATIONS §1.4 task 25 (CoinGecko/CMC) — mark Done or "Submitted on YYYY-MM-DD".
PLACEHOLDERS_AND_TBD CMC / CoinGecko Chain Support section — add "Submitted to CoinGecko on YYYY-MM-DD" and/or "Submitted to CMC on YYYY-MM-DD"; or "Listed on YYYY-MM-DD" when live.
PLACEHOLDERS_AND_COMPLETION_MASTER_LIST §8 Token aggregation — add "Chain 138/651940 submitted to CoinGecko/CMC on YYYY-MM-DD" or "Listed on YYYY-MM-DD".

5. See also