coin-modules

# Coin Modules Each blockchain family lives in its own package under `libs/coin-modules/coin-<family>`. Package name: `@ledgerhq/coin-<family>` Coin modules are one of the few things that still belong in legacy `libs/`: they migrate to [LedgerHQ/coin-modules](https://github.com/LedgerHQ/coin-modules), not to the monorepo layers. Do not create a new coin-module if it fits the ecosystem of an existing one. No packages other than coin-modules are allowed in `libs/coin-modules/`. ## Directory Layout | Directory / file | Purpose | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | | `api/` | Coin Module API surface — implements `CoinModuleApi` from `@ledgerhq/coin-module-framework/api/index`; restricted imports apply (see below) | | `logic/` | Core blockchain logic, agnostic of Bridge or API; only depends on `network/` and external libs; restricted imports apply (see below) | | `network/` | Communication with explorer / indexer / node; restricted imports apply (see below) | | `types/` | Model definitions, not related to network | | `bridge/` (legacy) | `CurrencyBridge` + `AccountBridge` implementation | | `signer/` (legacy) | Hardware wallet signer interface and device address resolver | Tests: `*.unit.test.ts` (co-located), `*.test.ts` (integration, no network), `*.integ.test.ts` (real network, separate `jest.integ.config.js`). ## Dependencies Prefer native dependencies from the blockchain foundation and well-established open-source libraries. **Avoid** proprietary third-party SDKs or closed-source vendor packages. In `api/`, `logic/`, and `network/`, the only permitted `@ledgerhq/*` imports are `@ledgerhq/logs`, `@ledgerhq/live-network`, `@ledgerhq/coin-module-framework`, and `@ledgerhq/ledger-wallet-framework` (enforced by `eslint/no-restricted-imports` in `libs/coin-modules/.oxlintrc.json`). Other directories (`bridge/`, `signer/`, `types/`) have no such restriction. ## Integration Paths **1. Coin Module API path (preferred)** — export `createApi(config, currencyId)` returning `CoinModuleApi` (from `@ledgerhq/coin-module-framework/api/index`). Enable the family in `libs/ledger-live-common/src/bridge/generic-coin-framework/genericCoinFrameworkFamilies.json` (checked by `isGenericCoinFrameworkFamily`). For methods that don't apply, `throw new Error("<method> is not supported")`. **2. Classic JS Bridge (legacy, do not use)** — export `createBridges(signerContext, coinConfig)` returning `{ currencyBridge, accountBridge }`. Wired via `libs/ledger-live-common/src/families/<family>/setup.ts`. ## Integ Test Requirements (Coin Module API) - `craftTransaction` / `estimateFees`: cover each transaction type (token transfer, native, memo, delegation, …) - `getBalance` / `listOperations`: cover each asset type in the module - `getBlockInfo` / `getBlock` / `listOperations` / `getStakes`: compare against a reference block/op/stake to validate metadata parsing - `getValidators`: validate metadata against a reference validator - `lastBlock`: block height > 0, valid date, hash with expected length - `getNextSequence`: higher than current nonce for a known account ## live-common Import Rule In `libs/ledger-live-common/src`, runtime imports of coin-specific code (from `@ledgerhq/coin-*` or `../families/*`) are only allowed inside `src/coin-modules/` and `src/families/`. All other shared code must access coin-specific behaviour through `coinModuleLoaders` from `src/coin-modules/loaders.ts`.