@ledgerhq/coin-hypercore 2.0.0 → 2.0.2

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @ledgerhq/coin-hypercore
 
+## 2.0.2
+
+### Patch Changes
+
+- [#875](https://github.com/LedgerHQ/coin-modules/pull/875) [`f709960`](https://github.com/LedgerHQ/coin-modules/commit/f709960d0146b2c592be70d3fb0142890e7ecd2c) Thanks [@francois-guerin-ledger](https://github.com/francois-guerin-ledger)! - chore(coin-xrp,coin-stellar,coin-hypercore): remove unused peer deps
+
+## 2.0.1
+
+### Patch Changes
+
+- [#830](https://github.com/LedgerHQ/coin-modules/pull/830) [`9adf9d9`](https://github.com/LedgerHQ/coin-modules/commit/9adf9d9ea1c7397b1fc4a09fbf9bbc4c8a6bdefb) Thanks [@cted-ledger](https://github.com/cted-ledger)! - Build the api from the framework's `notSupportedApi()` instead of listing fifteen
+  `notSupported('…')` stubs by hand. `createApi` spreads the framework value and overrides the four
+  methods this module implements — `lastBlock`, `getBalance`, `listOperations` and
+  `validateAddress` — taking the factory from twenty entries to four.
+
+  Hypercore could not adopt the `CoinModuleImpl` authoring type: it does not implement five of the
+  eight methods that type requires, because it is read-only. It reads a balance, a block and a
+  history, and crafts and broadcasts nothing — so its unsupported methods cannot be expressed by
+  omission. Spreading a fully-stubbed api satisfies the contract statically instead, and makes what
+  the module is readable from the four lines it keeps.
+
+  `getAccountInfo` now resolves the ADR-045 `{ type: 'none' }` sentinel from the module itself
+  rather than being backfilled by the resolver's `withDefaults` — the same value a consumer already
+  received.
+
+  `getBalance` gains a behaviour change. This module reads a plain balance and applies no filtering, so it now routes through the framework's `rejectBalanceOptions`, raising `InvalidParameterError` when options are supplied — the convention `coin-stellar`, `coin-tezos` and `coin-casper` already follow. Previously the annotated type promised to accept `BalanceOptions` while the implementation silently dropped them, so a caller asking for a filtered balance received an unfiltered one.
+
+  Its api test asserted all twenty method names, which only restated that the object was shaped
+  like the contract; the type guarantees that now, so it asserts the split instead: what the module
+  reads with, and the crafting, broadcasting, staking and enrollment it does not do.
+
 ## 2.0.0
 
 ### Major Changes

package/lib/api/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AACpD,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EACnB,MAAM,2CAA2C,CAAA;AAQlD,wBAAgB,SAAS,IAAI,aAAa,CACxC,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,CACnB,CAsBA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AACpD,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EACnB,MAAM,2CAA2C,CAAA;AAclD,wBAAgB,SAAS,IAAI,aAAa,CACxC,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,CACnB,CASA"}

package/lib/api/index.js

@@ -3,33 +3,25 @@
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createApi = createApi;
+const rejectBalanceOptions_1 = require("@ledgerhq/coin-module-framework/api/getBalance/rejectBalanceOptions");
 const index_1 = require("@ledgerhq/coin-module-framework/api/index");
 const getBalance_1 = require("./getBalance");
 const lastBlock_1 = require("./lastBlock");
 const listOperations_1 = require("./listOperations");
 const validateAddress_1 = require("./validateAddress");
 // The caller builds the {@link Context} (config + logger) and passes it to each method (ADR-019).
+//
+// This module is read-only: it reads a balance, a block and a history, and crafts and broadcasts
+// nothing. It cannot declare the `CoinModuleImpl` authoring type, which requires methods it does
+// not implement, so it spreads a fully-stubbed api and overrides the four it does — the contract
+// is satisfied statically, and what the module is stays readable from the four lines below.
 function createApi() {
     return {
+        ...(0, index_1.notSupportedApi)(),
         lastBlock: () => (0, lastBlock_1.lastBlock)(),
-        getBlockInfo: (0, index_1.notSupported)('getBlockInfo'),
-        getBlock: (0, index_1.notSupported)('getBlock'),
-        call: (0, index_1.notSupported)('call'),
-        getValidators: (0, index_1.notSupported)('getValidators'),
-        getBalance: (ctx, address) => (0, getBalance_1.getBalance)(ctx, address),
+        getBalance: (ctx, address, options) => (0, rejectBalanceOptions_1.rejectBalanceOptions)(() => (0, getBalance_1.getBalance)(ctx, address), options),
         listOperations: (ctx, address, options) => (0, listOperations_1.listOperations)(ctx, address, options),
-        getStakes: (0, index_1.notSupported)('getStakes'),
-        getRewards: (0, index_1.notSupported)('getRewards'),
-        register: (0, index_1.notSupported)('register'),
-        craftTransaction: (0, index_1.notSupported)('craftTransaction'),
-        craftRawTransaction: (0, index_1.notSupported)('craftRawTransaction'),
-        estimateFees: (0, index_1.notSupported)('estimateFees'),
-        combine: (0, index_1.notSupported)('combine'),
-        broadcast: (0, index_1.notSupported)('broadcast'),
-        validateIntent: (0, index_1.notSupported)('validateIntent'),
-        getNextSequence: (0, index_1.notSupported)('getNextSequence'),
         validateAddress: (_ctx, address, parameters) => (0, validateAddress_1.validateAddress)(address, parameters),
-        craftTransactionData: (0, index_1.notSupported)('craftTransactionData'),
     };
 }
 //# sourceMappingURL=index.js.map

package/lib/api/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";AAAA,4CAA4C;AAC5C,sCAAsC;;AAetC,8BA0BC;AAjCD,qEAAwE;AACxE,6CAAyC;AACzC,2CAAuC;AACvC,qDAAiD;AACjD,uDAAmD;AAEnD,kGAAkG;AAClG,SAAgB,SAAS;IAKvB,OAAO;QACL,SAAS,EAAE,GAAG,EAAE,CAAC,IAAA,qBAAS,GAAE;QAC5B,YAAY,EAAE,IAAA,oBAAY,EAAC,cAAc,CAAC;QAC1C,QAAQ,EAAE,IAAA,oBAAY,EAAC,UAAU,CAAC;QAClC,IAAI,EAAE,IAAA,oBAAY,EAAC,MAAM,CAAC;QAC1B,aAAa,EAAE,IAAA,oBAAY,EAAC,eAAe,CAAC;QAC5C,UAAU,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,IAAA,uBAAU,EAAC,GAAG,EAAE,OAAO,CAAC;QACtD,cAAc,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,IAAA,+BAAc,EAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC;QAChF,SAAS,EAAE,IAAA,oBAAY,EAAC,WAAW,CAAC;QACpC,UAAU,EAAE,IAAA,oBAAY,EAAC,YAAY,CAAC;QACtC,QAAQ,EAAE,IAAA,oBAAY,EAAC,UAAU,CAAC;QAClC,gBAAgB,EAAE,IAAA,oBAAY,EAAC,kBAAkB,CAAC;QAClD,mBAAmB,EAAE,IAAA,oBAAY,EAAC,qBAAqB,CAAC;QACxD,YAAY,EAAE,IAAA,oBAAY,EAAC,cAAc,CAAC;QAC1C,OAAO,EAAE,IAAA,oBAAY,EAAC,SAAS,CAAC;QAChC,SAAS,EAAE,IAAA,oBAAY,EAAC,WAAW,CAAC;QACpC,cAAc,EAAE,IAAA,oBAAY,EAAC,gBAAgB,CAAC;QAC9C,eAAe,EAAE,IAAA,oBAAY,EAAC,iBAAiB,CAAC;QAChD,eAAe,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,CAAC,IAAA,iCAAe,EAAC,OAAO,EAAE,UAAU,CAAC;QACpF,oBAAoB,EAAE,IAAA,oBAAY,EAAC,sBAAsB,CAAC;KAC3D,CAAA;AACH,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";AAAA,4CAA4C;AAC5C,sCAAsC;;AAqBtC,8BAaC;AA1BD,8GAA0G;AAC1G,qEAA2E;AAC3E,6CAAyC;AACzC,2CAAuC;AACvC,qDAAiD;AACjD,uDAAmD;AAEnD,kGAAkG;AAClG,EAAE;AACF,iGAAiG;AACjG,iGAAiG;AACjG,iGAAiG;AACjG,4FAA4F;AAC5F,SAAgB,SAAS;IAKvB,OAAO;QACL,GAAG,IAAA,uBAAe,GAA6D;QAC/E,SAAS,EAAE,GAAG,EAAE,CAAC,IAAA,qBAAS,GAAE;QAC5B,UAAU,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,OAAQ,EAAE,EAAE,CACrC,IAAA,2CAAoB,EAAC,GAAG,EAAE,CAAC,IAAA,uBAAU,EAAC,GAAG,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAC/D,cAAc,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,IAAA,+BAAc,EAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC;QAChF,eAAe,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,CAAC,IAAA,iCAAe,EAAC,OAAO,EAAE,UAAU,CAAC;KACrF,CAAA;AACH,CAAC"}

package/lib-es/api/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AACpD,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EACnB,MAAM,2CAA2C,CAAA;AAQlD,wBAAgB,SAAS,IAAI,aAAa,CACxC,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,CACnB,CAsBA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AACpD,OAAO,KAAK,EACV,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EACnB,MAAM,2CAA2C,CAAA;AAclD,wBAAgB,SAAS,IAAI,aAAa,CACxC,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,CACnB,CASA"}

package/lib-es/api/index.js

@@ -1,32 +1,24 @@
 // SPDX-FileCopyrightText: © 2024 LEDGER SAS
 // SPDX-License-Identifier: Apache-2.0
-import { notSupported } from '@ledgerhq/coin-module-framework/api/index';
+import { rejectBalanceOptions } from '@ledgerhq/coin-module-framework/api/getBalance/rejectBalanceOptions';
+import { notSupportedApi } from '@ledgerhq/coin-module-framework/api/index';
 import { getBalance } from './getBalance';
 import { lastBlock } from './lastBlock';
 import { listOperations } from './listOperations';
 import { validateAddress } from './validateAddress';
 // The caller builds the {@link Context} (config + logger) and passes it to each method (ADR-019).
+//
+// This module is read-only: it reads a balance, a block and a history, and crafts and broadcasts
+// nothing. It cannot declare the `CoinModuleImpl` authoring type, which requires methods it does
+// not implement, so it spreads a fully-stubbed api and overrides the four it does — the contract
+// is satisfied statically, and what the module is stays readable from the four lines below.
 export function createApi() {
     return {
+        ...notSupportedApi(),
         lastBlock: () => lastBlock(),
-        getBlockInfo: notSupported('getBlockInfo'),
-        getBlock: notSupported('getBlock'),
-        call: notSupported('call'),
-        getValidators: notSupported('getValidators'),
-        getBalance: (ctx, address) => getBalance(ctx, address),
+        getBalance: (ctx, address, options) => rejectBalanceOptions(() => getBalance(ctx, address), options),
         listOperations: (ctx, address, options) => listOperations(ctx, address, options),
-        getStakes: notSupported('getStakes'),
-        getRewards: notSupported('getRewards'),
-        register: notSupported('register'),
-        craftTransaction: notSupported('craftTransaction'),
-        craftRawTransaction: notSupported('craftRawTransaction'),
-        estimateFees: notSupported('estimateFees'),
-        combine: notSupported('combine'),
-        broadcast: notSupported('broadcast'),
-        validateIntent: notSupported('validateIntent'),
-        getNextSequence: notSupported('getNextSequence'),
         validateAddress: (_ctx, address, parameters) => validateAddress(address, parameters),
-        craftTransactionData: notSupported('craftTransactionData'),
     };
 }
 //# sourceMappingURL=index.js.map

package/lib-es/api/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,sCAAsC;AAQtC,OAAO,EAAE,YAAY,EAAE,MAAM,2CAA2C,CAAA;AACxE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD,kGAAkG;AAClG,MAAM,UAAU,SAAS;IAKvB,OAAO;QACL,SAAS,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE;QAC5B,YAAY,EAAE,YAAY,CAAC,cAAc,CAAC;QAC1C,QAAQ,EAAE,YAAY,CAAC,UAAU,CAAC;QAClC,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC;QAC1B,aAAa,EAAE,YAAY,CAAC,eAAe,CAAC;QAC5C,UAAU,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC;QACtD,cAAc,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC;QAChF,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC;QACpC,UAAU,EAAE,YAAY,CAAC,YAAY,CAAC;QACtC,QAAQ,EAAE,YAAY,CAAC,UAAU,CAAC;QAClC,gBAAgB,EAAE,YAAY,CAAC,kBAAkB,CAAC;QAClD,mBAAmB,EAAE,YAAY,CAAC,qBAAqB,CAAC;QACxD,YAAY,EAAE,YAAY,CAAC,cAAc,CAAC;QAC1C,OAAO,EAAE,YAAY,CAAC,SAAS,CAAC;QAChC,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC;QACpC,cAAc,EAAE,YAAY,CAAC,gBAAgB,CAAC;QAC9C,eAAe,EAAE,YAAY,CAAC,iBAAiB,CAAC;QAChD,eAAe,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,CAAC,eAAe,CAAC,OAAO,EAAE,UAAU,CAAC;QACpF,oBAAoB,EAAE,YAAY,CAAC,sBAAsB,CAAC;KAC3D,CAAA;AACH,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,sCAAsC;AAQtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,qEAAqE,CAAA;AAC1G,OAAO,EAAE,eAAe,EAAE,MAAM,2CAA2C,CAAA;AAC3E,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD,kGAAkG;AAClG,EAAE;AACF,iGAAiG;AACjG,iGAAiG;AACjG,iGAAiG;AACjG,4FAA4F;AAC5F,MAAM,UAAU,SAAS;IAKvB,OAAO;QACL,GAAG,eAAe,EAA6D;QAC/E,SAAS,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE;QAC5B,UAAU,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,OAAQ,EAAE,EAAE,CACrC,oBAAoB,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAC/D,cAAc,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC;QAChF,eAAe,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,CAAC,eAAe,CAAC,OAAO,EAAE,UAAU,CAAC;KACrF,CAAA;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ledgerhq/coin-hypercore",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "Ledger Hypercore Coin integration",
   "keywords": [
     "Ledger",
@@ -65,7 +65,7 @@
   "author": "LEDGER SAS",
   "license": "Apache-2.0",
   "dependencies": {
-    "@ledgerhq/coin-module-framework": "^8.0.0"
+    "@ledgerhq/coin-module-framework": "^8.5.0"
   },
   "devDependencies": {
     "@swc/core": "1.15.11",
@@ -78,8 +78,7 @@
     "typescript": "6.0.2"
   },
   "peerDependencies": {
-    "@ledgerhq/live-network": "^3.0.0",
-    "@ledgerhq/logs": "^6.17.0"
+    "@ledgerhq/live-network": "^3.0.0"
   },
   "scripts": {
     "clean": "rimraf lib lib-es",

package/src/api/index.test.ts

@@ -1,30 +1,65 @@
 // SPDX-FileCopyrightText: © 2024 LEDGER SAS
 // SPDX-License-Identifier: Apache-2.0
 
+import { isNotSupportedStub } from '@ledgerhq/coin-module-framework/api/index'
+import { InvalidParameterError } from '@ledgerhq/coin-module-framework/errors'
 import { createApi } from '.'
 
 describe('createApi', () => {
-  it('returns all API methods', () => {
-    expect(createApi()).toEqual({
-      broadcast: expect.any(Function),
-      call: expect.any(Function),
-      combine: expect.any(Function),
-      craftRawTransaction: expect.any(Function),
-      craftTransaction: expect.any(Function),
-      craftTransactionData: expect.any(Function),
-      estimateFees: expect.any(Function),
-      getBalance: expect.any(Function),
-      getBlock: expect.any(Function),
-      getBlockInfo: expect.any(Function),
-      getNextSequence: expect.any(Function),
-      getRewards: expect.any(Function),
-      getStakes: expect.any(Function),
-      getValidators: expect.any(Function),
-      lastBlock: expect.any(Function),
-      listOperations: expect.any(Function),
-      register: expect.any(Function),
-      validateAddress: expect.any(Function),
-      validateIntent: expect.any(Function),
-    })
+  const api = createApi()
+
+  // The contract's shape is guaranteed by the type now that `notSupportedApi()` is spread in, so
+  // what is worth asserting is the split: the four methods this read-only module reads with, and
+  // the crafting and broadcasting it does not do. Listing all twenty method names, as this test
+  // did, only restated that the object was shaped like the contract.
+  it('reads a balance, a block and a history, and validates an address', () => {
+    expect(isNotSupportedStub(api.lastBlock)).toBe(false)
+    expect(isNotSupportedStub(api.getBalance)).toBe(false)
+    expect(isNotSupportedStub(api.listOperations)).toBe(false)
+    expect(isNotSupportedStub(api.validateAddress)).toBe(false)
+  })
+
+  it('crafts and broadcasts nothing', () => {
+    expect(isNotSupportedStub(api.craftTransaction)).toBe(true)
+    expect(isNotSupportedStub(api.craftRawTransaction)).toBe(true)
+    expect(isNotSupportedStub(api.craftTransactionData)).toBe(true)
+    expect(isNotSupportedStub(api.estimateFees)).toBe(true)
+    expect(isNotSupportedStub(api.combine)).toBe(true)
+    expect(isNotSupportedStub(api.broadcast)).toBe(true)
+    expect(isNotSupportedStub(api.validateIntent)).toBe(true)
+    expect(isNotSupportedStub(api.getNextSequence)).toBe(true)
+  })
+
+  it('has no staking, block lookup, contract call or enrollment', () => {
+    expect(isNotSupportedStub(api.getStakes)).toBe(true)
+    expect(isNotSupportedStub(api.getRewards)).toBe(true)
+    expect(isNotSupportedStub(api.getValidators)).toBe(true)
+    expect(isNotSupportedStub(api.getBlock)).toBe(true)
+    expect(isNotSupportedStub(api.getBlockInfo)).toBe(true)
+    expect(isNotSupportedStub(api.call)).toBe(true)
+    expect(isNotSupportedStub(api.register)).toBe(true)
+  })
+
+  // Hypercore reads a plain balance and applies no filtering, so the framework's convention is to
+  // reject the options rather than accept and silently ignore them.
+  it('rejects the getBalance options it does not support', async () => {
+    await expect(
+      api.getBalance(
+        { config: () => Promise.reject(new Error('stub')), logger: () => undefined },
+        'addr',
+        {}
+      )
+    ).rejects.toThrow(InvalidParameterError)
+  })
+
+  // Absent account metadata is an answer, not a missing capability (ADR-045) — the same value
+  // `withDefaults` supplied before, now carried by the module itself.
+  it('answers the sentinel for getAccountInfo rather than throwing', async () => {
+    await expect(
+      api.getAccountInfo?.(
+        { config: () => Promise.reject(new Error('stub')), logger: () => undefined },
+        'addr'
+      )
+    ).resolves.toEqual({ type: 'none' })
   })
 })

package/src/api/index.ts

@@ -7,37 +7,30 @@ import type {
   MemoNotSupported,
   TxDataNotSupported,
 } from '@ledgerhq/coin-module-framework/api/index'
-import { notSupported } from '@ledgerhq/coin-module-framework/api/index'
+import { rejectBalanceOptions } from '@ledgerhq/coin-module-framework/api/getBalance/rejectBalanceOptions'
+import { notSupportedApi } from '@ledgerhq/coin-module-framework/api/index'
 import { getBalance } from './getBalance'
 import { lastBlock } from './lastBlock'
 import { listOperations } from './listOperations'
 import { validateAddress } from './validateAddress'
 
 // The caller builds the {@link Context} (config + logger) and passes it to each method (ADR-019).
+//
+// This module is read-only: it reads a balance, a block and a history, and crafts and broadcasts
+// nothing. It cannot declare the `CoinModuleImpl` authoring type, which requires methods it does
+// not implement, so it spreads a fully-stubbed api and overrides the four it does — the contract
+// is satisfied statically, and what the module is stays readable from the four lines below.
 export function createApi(): CoinModuleApi<
   HypercoreCoinConfig,
   MemoNotSupported,
   TxDataNotSupported
 > {
   return {
+    ...notSupportedApi<HypercoreCoinConfig, MemoNotSupported, TxDataNotSupported>(),
     lastBlock: () => lastBlock(),
-    getBlockInfo: notSupported('getBlockInfo'),
-    getBlock: notSupported('getBlock'),
-    call: notSupported('call'),
-    getValidators: notSupported('getValidators'),
-    getBalance: (ctx, address) => getBalance(ctx, address),
+    getBalance: (ctx, address, options?) =>
+      rejectBalanceOptions(() => getBalance(ctx, address), options),
     listOperations: (ctx, address, options) => listOperations(ctx, address, options),
-    getStakes: notSupported('getStakes'),
-    getRewards: notSupported('getRewards'),
-    register: notSupported('register'),
-    craftTransaction: notSupported('craftTransaction'),
-    craftRawTransaction: notSupported('craftRawTransaction'),
-    estimateFees: notSupported('estimateFees'),
-    combine: notSupported('combine'),
-    broadcast: notSupported('broadcast'),
-    validateIntent: notSupported('validateIntent'),
-    getNextSequence: notSupported('getNextSequence'),
     validateAddress: (_ctx, address, parameters) => validateAddress(address, parameters),
-    craftTransactionData: notSupported('craftTransactionData'),
   }
 }