@ledgerhq/coin-module-framework 2.1.0 → 3.0.0

package/lib-es/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,qBAAqB,CACnC,SAAgC,EAChC,YAAgB;IAEhB,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;QACtB,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAA;IACpC,CAAC;IACD,OAAO,YAAiB,CAAA;AAC1B,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,EAAqB;IAC3D,OAAO,EAAE,CAAC,UAAU,KAAK,aAAa,CAAA;AACxC,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,EAAqB;IAC9D,OAAO,EAAE,CAAC,UAAU,KAAK,SAAS,CAAA;AACpC,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,sCAAsC;AAKtC,MAAM,UAAU,qBAAqB,CACnC,SAAgC,EAChC,YAAgB;IAEhB,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;QACtB,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAA;IACpC,CAAC;IACD,OAAO,YAAiB,CAAA;AAC1B,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,EAAqB;IAC3D,OAAO,EAAE,CAAC,UAAU,KAAK,aAAa,CAAA;AACxC,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,EAAqB;IAC9D,OAAO,EAAE,CAAC,UAAU,KAAK,SAAS,CAAA;AACpC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ledgerhq/coin-module-framework",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "Ledger framework for Coin integration",
   "keywords": [
     "Ledger",
@@ -49,19 +49,19 @@
     },
     "./package.json": "./package.json"
   },
+  "author": "LEDGER SAS",
   "license": "Apache-2.0",
   "dependencies": {
     "bignumber.js": "^9.1.2"
   },
   "peerDependencies": {
-    "@ledgerhq/errors": "^6.33.0",
-    "@ledgerhq/live-env": "^2.31.0"
+    "@ledgerhq/errors": "^6.33.0"
   },
   "devDependencies": {
     "@types/node": "^24.0.0",
     "@types/jest": "^30.0.0",
     "cross-env": "^7.0.3",
-    "jest": "^30.2.0",
+    "jest": "30.2.0",
     "@swc/jest": "0.2.39",
     "@swc/core": "1.15.11"
   },

package/src/api/errors.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 export class IncorrectTypeError extends Error {
   constructor(message?: string) {
     super(`IncorrectType: ${message}`)

package/src/api/getBalance/rejectBalanceOptions.test.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 import { InvalidParameterError } from '@ledgerhq/errors'
 import { BalanceOptions } from '../types'
 import { rejectBalanceOptions } from './rejectBalanceOptions'

package/src/api/getBalance/rejectBalanceOptions.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 import { InvalidParameterError } from '@ledgerhq/errors'
 import { Balance, BalanceOptions } from '../types'
 

package/src/api/index.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 /**
  * Module related to all API exposition constraints and helper.
  * One consumer of this API is Alpaca.

package/src/api/types.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 // NOTE: from types-live
 export type BroadcastConfig = {
   mevProtected: boolean
@@ -187,7 +190,7 @@ export type Account = {
 /**
  * A component of an account/address balance, for a single asset.
  *
- * @see AlpacaApi#getBalance
+ * @see CoinModuleApi#getBalance
  */
 export type Balance = {
   /** The balance value, in base unit of {@link asset} (always positive). */
@@ -217,7 +220,7 @@ export type StakeState =
  * as several {@link Stake}.
  *
  * @see Reward
- * @see AlpacaApi#getStakes
+ * @see CoinModuleApi#getStakes
  */
 export type Stake = {
   /** An immutable, globally unique id of the stake. Depending on the blockchain, it could simply be the account address,
@@ -260,7 +263,7 @@ export type Stake = {
  * A staking reward distribution event.
  *
  * @see Stake
- * @see AlpacaApi#getRewards
+ * @see CoinModuleApi#getRewards
  */
 export type Reward = {
   /** {@link Stake#uid} via which this reward was obtained. */
@@ -396,7 +399,7 @@ export type FeeEstimation = {
   parameters?: Record<string, unknown>
 }
 
-/** Response of {@link AlpacaApi#craftTransaction}. */
+/** Response of {@link CoinModuleApi#craftTransaction}. */
 export type CraftedTransaction = {
   /** The serialized transaction (encoding is blockchain dependent). */
   transaction: string
@@ -413,7 +416,7 @@ export type Page<T> = {
   next?: Cursor | undefined
 }
 
-/** Options for {@link AlpacaApi#listOperations}. */
+/** Options for {@link CoinModuleApi#listOperations}. */
 export type ListOperationsOptions = {
   /**
    * The minimum block height for which to fetch operations (inclusive).
@@ -491,7 +494,7 @@ export type BalanceOptions = {
   includeAssets?: (asset: AssetInfo) => Promise<boolean>
 }
 
-export type AlpacaApi<
+export type CoinModuleApi<
   MemoType extends Memo = MemoNotSupported,
   TxDataType extends TxData = TxDataNotSupported,
 > = {
@@ -730,4 +733,13 @@ export type AlpacaApi<
     address: string,
     parameters: Partial<AddressValidationCurrencyParameters>
   ) => Promise<boolean>
+
+  /**
+   * Get a blockchain specific payload. For Ethereum, it would be a calldata,
+   * for Solana, it would be instructions, and so on
+   *
+   * @param intent transaction intent
+   * @returns blockchain-specific {@link TxData} for this module
+   */
+  craftTransactionData: (intent: TransactionIntent<MemoType, TxDataType>) => TxDataType
 }

package/src/config.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 import { MissingCoinConfig } from './errors'
 import type { FeatureConfig } from './features/types'
 

package/src/currencies/BigNumberToLocaleString.test.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 // Forked from @ledgerhq/live-currency-format/src/BigNumberToLocaleString.test.ts
 import { BigNumber } from 'bignumber.js'
 import { toLocaleString } from './BigNumberToLocaleString'

package/src/currencies/BigNumberToLocaleString.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 // Forked from @ledgerhq/live-currency-format/src/BigNumberToLocaleString.ts
 import { BigNumber } from 'bignumber.js'
 import { getSeparators } from './localeUtility'

package/src/currencies/formatCurrencyUnit.test.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 // Forked from @ledgerhq/live-currency-format/src/formatCurrencyUnit.test.ts
 // Snapshot tests using @ledgerhq/cryptoassets removed (not available in this repo)
 import { formatCurrencyUnit, formatCurrencyUnitFragment } from './formatCurrencyUnit'

package/src/currencies/formatCurrencyUnit.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 // Forked from @ledgerhq/live-currency-format/src/formatCurrencyUnit.ts
 import { BigNumber } from 'bignumber.js'
 import { getSeparators } from './localeUtility'

package/src/currencies/index.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 export { parseCurrencyUnit } from './parseCurrencyUnit'
 export {
   formatCurrencyUnit,

package/src/currencies/localeUtility.test.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 // Forked from @ledgerhq/live-currency-format/src/localeUtility.test.ts
 import { getSeparators } from './localeUtility'
 

package/src/currencies/localeUtility.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 // Forked from @ledgerhq/live-currency-format/src/localeUtility.ts
 const memoize = <T extends (arg: string) => ReturnType<T>>(fn: T): T => {
   const cache: Record<string, ReturnType<T>> = {}

package/src/currencies/parseCurrencyUnit.test.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 // Forked from @ledgerhq/live-currency-format/src/parseCurrencyUnit.test.ts
 import { BigNumber } from 'bignumber.js'
 import type { Unit } from '../api/types'

package/src/currencies/parseCurrencyUnit.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 // Forked from @ledgerhq/live-currency-format/src/parseCurrencyUnit.ts
 import type { Unit } from '../api/types'
 import { BigNumber } from 'bignumber.js'

package/src/errors.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 import { createCustomErrorClass } from '@ledgerhq/errors'
 
 /** When a coin-module has no CoinConfig setted */

package/src/features/types.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 /**
  * Feature IDs as defined in https://ledgerhq.atlassian.net/wiki/spaces/CF/pages/6125551933/Coin+modules+-+ADR-003+-+Features+support
  * These represent the capabilities/features a coin module can support

package/src/index.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 import * as api from './api'
 
 export default {

package/src/logic/craftTransactionData.test.ts

@@ -0,0 +1,11 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
+import { TransactionIntent } from '../api'
+import { craftTransactionData } from './craftTransactionData'
+
+describe('craftTransactionData', () => {
+  it('should return not supported tx data', () => {
+    expect(craftTransactionData({} as unknown as TransactionIntent)).toEqual({ type: 'none' })
+  })
+})

package/src/logic/craftTransactionData.ts

@@ -0,0 +1,9 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
+import { TransactionIntent, TxDataNotSupported } from '../api/types'
+
+export function craftTransactionData(intent: TransactionIntent): TxDataNotSupported {
+  void intent
+  return { type: 'none' }
+}

package/src/test/utils.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 /**
  * Recursively makes all properties optional.
  * Arrays keep their element type (but each element is deeply partial).

package/src/utils.test.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 import BigNumber from 'bignumber.js'
 import { fromBigNumberToBigInt } from './utils'
 

package/src/utils.ts

@@ -1,3 +1,6 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
 import BigNumber from 'bignumber.js'
 import { SendTransactionIntent, StakingTransactionIntent, TransactionIntent } from './api'
 

package/lib/setup.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=setup.d.ts.map

package/lib/setup.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":""}

package/lib/setup.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const bignumber_js_1 = require("bignumber.js");
-const live_env_1 = require("@ledgerhq/live-env");
-bignumber_js_1.BigNumber.set({ DECIMAL_PLACES: (0, live_env_1.getEnv)('BIG_NUMBER_DECIMAL_PLACES') });
-//# sourceMappingURL=setup.js.map

package/lib/setup.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"setup.js","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":";;AAAA,+CAAwC;AACxC,iDAA2C;AAE3C,wBAAS,CAAC,GAAG,CAAC,EAAE,cAAc,EAAE,IAAA,iBAAM,EAAC,2BAA2B,CAAC,EAAE,CAAC,CAAA"}

package/lib-es/setup.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=setup.d.ts.map

package/lib-es/setup.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":""}

package/lib-es/setup.js

@@ -1,4 +0,0 @@
-import { BigNumber } from 'bignumber.js';
-import { getEnv } from '@ledgerhq/live-env';
-BigNumber.set({ DECIMAL_PLACES: getEnv('BIG_NUMBER_DECIMAL_PLACES') });
-//# sourceMappingURL=setup.js.map

package/lib-es/setup.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"setup.js","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAE3C,SAAS,CAAC,GAAG,CAAC,EAAE,cAAc,EAAE,MAAM,CAAC,2BAA2B,CAAC,EAAE,CAAC,CAAA"}

package/src/setup.ts

@@ -1,4 +0,0 @@
-import { BigNumber } from 'bignumber.js'
-import { getEnv } from '@ledgerhq/live-env'
-
-BigNumber.set({ DECIMAL_PLACES: getEnv('BIG_NUMBER_DECIMAL_PLACES') })