@ledgerhq/coin-hypercore 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @ledgerhq/coin-hypercore
 
+## 0.2.1
+
+### Patch Changes
+
+- [#734](https://github.com/LedgerHQ/coin-modules/pull/734) [`fe0b58e`](https://github.com/LedgerHQ/coin-modules/commit/fe0b58ebc0e1ecc2134b4b6fc73d516662de66b9) Thanks [@adussarps](https://github.com/adussarps)! - Add the read-only smart-contract `call` API to `CoinModuleApi`, along with the `CallParams`/`CallResult` types and a shared `notSupported` helper for modules that do not implement optional API methods. Modules without a contract-read primitive (`coin-hypercore`, `coin-stellar`, `coin-xrp`) now stub `call` as unsupported.
+
+- Updated dependencies [[`fe0b58e`](https://github.com/LedgerHQ/coin-modules/commit/fe0b58ebc0e1ecc2134b4b6fc73d516662de66b9)]:
+  - @ledgerhq/coin-module-framework@4.0.0
+
 ## 0.2.0
 
 ### Minor Changes

package/lib/api/index.d.ts

@@ -1,4 +1,4 @@
-import type { CoinModuleApi } from '@ledgerhq/coin-module-framework/api/index';
+import { type CoinModuleApi } from '@ledgerhq/coin-module-framework/api/index';
 import { type HypercoreConfig } from '../config';
 export declare function createApi(config: HypercoreConfig): CoinModuleApi;
 //# sourceMappingURL=index.d.ts.map

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,aAAa,EAAE,MAAM,2CAA2C,CAAA;AAC9E,OAAmB,EAAE,KAAK,eAAe,EAAE,MAAM,WAAW,CAAA;AAM5D,wBAAgB,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,aAAa,CAsBhE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,aAAa,EAAgB,MAAM,2CAA2C,CAAA;AAC5F,OAAmB,EAAE,KAAK,eAAe,EAAE,MAAM,WAAW,CAAA;AAE5D,wBAAgB,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,aAAa,CAuBhE"}

package/lib/api/index.js

@@ -6,30 +6,29 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createApi = createApi;
+const index_1 = require("@ledgerhq/coin-module-framework/api/index");
 const config_1 = __importDefault(require("../config"));
-const notSupported = (name) => () => {
-    throw new Error(`${name} is not supported`);
-};
 function createApi(config) {
     config_1.default.setCoinConfig(() => ({ ...config, status: { type: 'active' } }));
     return {
-        lastBlock: notSupported('lastBlock'),
-        getBlockInfo: notSupported('getBlockInfo'),
-        getBlock: notSupported('getBlock'),
-        getValidators: notSupported('getValidators'),
-        getBalance: notSupported('getBalance'),
-        listOperations: notSupported('listOperations'),
-        getStakes: notSupported('getStakes'),
-        getRewards: notSupported('getRewards'),
-        craftTransaction: notSupported('craftTransaction'),
-        craftRawTransaction: notSupported('craftRawTransaction'),
-        estimateFees: notSupported('estimateFees'),
-        combine: notSupported('combine'),
-        broadcast: notSupported('broadcast'),
-        validateIntent: notSupported('validateIntent'),
-        getNextSequence: notSupported('getNextSequence'),
-        validateAddress: notSupported('validateAddress'),
-        craftTransactionData: notSupported('craftTransactionData'),
+        lastBlock: (0, index_1.notSupported)('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: (0, index_1.notSupported)('getBalance'),
+        listOperations: (0, index_1.notSupported)('listOperations'),
+        getStakes: (0, index_1.notSupported)('getStakes'),
+        getRewards: (0, index_1.notSupported)('getRewards'),
+        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: (0, index_1.notSupported)('validateAddress'),
+        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;;;;;AAStC,8BAsBC;AA5BD,uDAA4D;AAE5D,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,GAAU,EAAE;IACjD,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,mBAAmB,CAAC,CAAA;AAC7C,CAAC,CAAA;AAED,SAAgB,SAAS,CAAC,MAAuB;IAC/C,gBAAU,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAA;IAE3E,OAAO;QACL,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC;QACpC,YAAY,EAAE,YAAY,CAAC,cAAc,CAAC;QAC1C,QAAQ,EAAE,YAAY,CAAC,UAAU,CAAC;QAClC,aAAa,EAAE,YAAY,CAAC,eAAe,CAAC;QAC5C,UAAU,EAAE,YAAY,CAAC,YAAY,CAAC;QACtC,cAAc,EAAE,YAAY,CAAC,gBAAgB,CAAC;QAC9C,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC;QACpC,UAAU,EAAE,YAAY,CAAC,YAAY,CAAC;QACtC,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,YAAY,CAAC,iBAAiB,CAAC;QAChD,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;;;;;AAKtC,8BAuBC;AA1BD,qEAA4F;AAC5F,uDAA4D;AAE5D,SAAgB,SAAS,CAAC,MAAuB;IAC/C,gBAAU,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAA;IAE3E,OAAO;QACL,SAAS,EAAE,IAAA,oBAAY,EAAC,WAAW,CAAC;QACpC,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,IAAA,oBAAY,EAAC,YAAY,CAAC;QACtC,cAAc,EAAE,IAAA,oBAAY,EAAC,gBAAgB,CAAC;QAC9C,SAAS,EAAE,IAAA,oBAAY,EAAC,WAAW,CAAC;QACpC,UAAU,EAAE,IAAA,oBAAY,EAAC,YAAY,CAAC;QACtC,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,IAAA,oBAAY,EAAC,iBAAiB,CAAC;QAChD,oBAAoB,EAAE,IAAA,oBAAY,EAAC,sBAAsB,CAAC;KAC3D,CAAA;AACH,CAAC"}

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

@@ -1,4 +1,4 @@
-import type { CoinModuleApi } from '@ledgerhq/coin-module-framework/api/index';
+import { type CoinModuleApi } from '@ledgerhq/coin-module-framework/api/index';
 import { type HypercoreConfig } from '../config';
 export declare function createApi(config: HypercoreConfig): CoinModuleApi;
 //# sourceMappingURL=index.d.ts.map

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,aAAa,EAAE,MAAM,2CAA2C,CAAA;AAC9E,OAAmB,EAAE,KAAK,eAAe,EAAE,MAAM,WAAW,CAAA;AAM5D,wBAAgB,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,aAAa,CAsBhE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,aAAa,EAAgB,MAAM,2CAA2C,CAAA;AAC5F,OAAmB,EAAE,KAAK,eAAe,EAAE,MAAM,WAAW,CAAA;AAE5D,wBAAgB,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,aAAa,CAuBhE"}

package/lib-es/api/index.js

@@ -1,15 +1,14 @@
 // SPDX-FileCopyrightText: © 2024 LEDGER SAS
 // SPDX-License-Identifier: Apache-2.0
+import { notSupported } from '@ledgerhq/coin-module-framework/api/index';
 import coinConfig from '../config';
-const notSupported = (name) => () => {
-    throw new Error(`${name} is not supported`);
-};
 export function createApi(config) {
     coinConfig.setCoinConfig(() => ({ ...config, status: { type: 'active' } }));
     return {
         lastBlock: notSupported('lastBlock'),
         getBlockInfo: notSupported('getBlockInfo'),
         getBlock: notSupported('getBlock'),
+        call: notSupported('call'),
         getValidators: notSupported('getValidators'),
         getBalance: notSupported('getBalance'),
         listOperations: notSupported('listOperations'),

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;AAGtC,OAAO,UAAoC,MAAM,WAAW,CAAA;AAE5D,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,GAAU,EAAE;IACjD,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,mBAAmB,CAAC,CAAA;AAC7C,CAAC,CAAA;AAED,MAAM,UAAU,SAAS,CAAC,MAAuB;IAC/C,UAAU,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAA;IAE3E,OAAO;QACL,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC;QACpC,YAAY,EAAE,YAAY,CAAC,cAAc,CAAC;QAC1C,QAAQ,EAAE,YAAY,CAAC,UAAU,CAAC;QAClC,aAAa,EAAE,YAAY,CAAC,eAAe,CAAC;QAC5C,UAAU,EAAE,YAAY,CAAC,YAAY,CAAC;QACtC,cAAc,EAAE,YAAY,CAAC,gBAAgB,CAAC;QAC9C,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC;QACpC,UAAU,EAAE,YAAY,CAAC,YAAY,CAAC;QACtC,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,YAAY,CAAC,iBAAiB,CAAC;QAChD,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;AAEtC,OAAO,EAAsB,YAAY,EAAE,MAAM,2CAA2C,CAAA;AAC5F,OAAO,UAAoC,MAAM,WAAW,CAAA;AAE5D,MAAM,UAAU,SAAS,CAAC,MAAuB;IAC/C,UAAU,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAA;IAE3E,OAAO;QACL,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC;QACpC,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,YAAY,CAAC,YAAY,CAAC;QACtC,cAAc,EAAE,YAAY,CAAC,gBAAgB,CAAC;QAC9C,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC;QACpC,UAAU,EAAE,YAAY,CAAC,YAAY,CAAC;QACtC,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,YAAY,CAAC,iBAAiB,CAAC;QAChD,oBAAoB,EAAE,YAAY,CAAC,sBAAsB,CAAC;KAC3D,CAAA;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ledgerhq/coin-hypercore",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Ledger Hypercore Coin integration",
   "keywords": [
     "Ledger",
@@ -65,7 +65,7 @@
   "author": "LEDGER SAS",
   "license": "Apache-2.0",
   "dependencies": {
-    "@ledgerhq/coin-module-framework": "^3.6.0"
+    "@ledgerhq/coin-module-framework": "^4.0.0"
   },
   "devDependencies": {
     "@swc/core": "1.15.11",
@@ -94,7 +94,7 @@
     "test": "jest",
     "test:debug": "node --inspect-brk ./node_modules/jest/bin/jest.js --runInBand",
     "test-watch": "jest --watch",
-    "test-integ": "jest --config=jest.integ.config.js --passWithNoTests",
+    "test-integ": "jest --config=jest.integ.config.js",
     "test-integ:debug": "node --inspect-brk ./node_modules/jest/bin/jest.js --runInBand --config=jest.integ.config.js",
     "typecheck": "tsc --noEmit --customConditions node",
     "unimported": "knip --include=files,dependencies",

package/src/api/index.integ.test.ts

@@ -25,6 +25,6 @@ describe('Hypercore Api (Alpaca stub)', () => {
     'validateAddress',
     'craftTransactionData',
   ])('%s throws "not supported"', (name) => {
-    expect(() => (api[name] as (...args: unknown[]) => unknown)()).toThrow('not supported')
+    expect(api[name]).toThrow('not supported')
   })
 })

package/src/api/index.test.ts

@@ -0,0 +1,29 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
+import { createApi } from '.'
+
+describe('createApi', () => {
+  it('returns all API methods', () => {
+    expect(createApi({ node: 'http://localhost' })).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),
+      validateAddress: expect.any(Function),
+      validateIntent: expect.any(Function),
+    })
+  })
+})

package/src/api/index.ts

@@ -1,13 +1,9 @@
 // SPDX-FileCopyrightText: © 2024 LEDGER SAS
 // SPDX-License-Identifier: Apache-2.0
 
-import type { CoinModuleApi } from '@ledgerhq/coin-module-framework/api/index'
+import { type CoinModuleApi, notSupported } from '@ledgerhq/coin-module-framework/api/index'
 import coinConfig, { type HypercoreConfig } from '../config'
 
-const notSupported = (name: string) => (): never => {
-  throw new Error(`${name} is not supported`)
-}
-
 export function createApi(config: HypercoreConfig): CoinModuleApi {
   coinConfig.setCoinConfig(() => ({ ...config, status: { type: 'active' } }))
 
@@ -15,6 +11,7 @@ export function createApi(config: HypercoreConfig): CoinModuleApi {
     lastBlock: notSupported('lastBlock'),
     getBlockInfo: notSupported('getBlockInfo'),
     getBlock: notSupported('getBlock'),
+    call: notSupported('call'),
     getValidators: notSupported('getValidators'),
     getBalance: notSupported('getBalance'),
     listOperations: notSupported('listOperations'),