Files

Chain 138 Snap — Documentation index

Documentation for the Chain 138 Snap (MetaMask): network params, token list, market data, swap quotes, and CCIP and Trustless bridge routes for Chain 138 and ALL Mainnet.

Doc Description
FEATURES.md All RPC methods and features — method matrix, params, response shapes, blockchains (138 + 651940), flow diagram
CONTRIBUTING.md How to contribute: setup, testing, linting, publishing
FAQ.md Frequently asked questions about the Snap
DEPLOY_COMPANION_SITE.md Build and deploy the companion site to your own host
RUNBOOK.md Build, test, publish quick reference

Root-level docs (repo root)

Doc Description
README Project overview, getting started
INTEGRATORS Integrator guide: Snap ID, apiBaseUrl, RPC methods
TESTING_INSTRUCTIONS Full testing guide: dev server, RPC examples, E2E checklist
E2E_PREPARATION Token-aggregation and companion site setup for E2E
MANUAL_E2E_CHECKLIST Short manual E2E checklist
PUSH_AND_PUBLISH Push to GitHub, publish to npm, allowlist
PACKAGE_MANAGER pnpm vs Yarn
SECURITY Security notes: HTTPS, API, permissions
ALLOWLIST_FORM_FIELDS MetaMask allowlist form fields
ALLOWLIST_SOURCE_AND_COMPLIANCE_CHECKLIST Allowlist compliance checklist
NEXT_STEPS Completed items and future releases

Visual elements

  • Feature overview and method matrix: FEATURES.md includes ASCII feature overview, RPC method matrix (all methods × Chain 138 / ALL Mainnet × params × UI), and a Mermaid request-flow diagram.
  • Screenshots: Optional screenshots (Connect UI, market data dialog, bridge dialog, swap quote dialog) can be added under docs/images/. See the "Screenshots and visuals" section in FEATURES.md for suggested filenames.

Snap package (npm)

The published Snap package has its own README on npm; a copy lives in packages/snap/README.md.