@ledgerhq/coin-framework 0.3.0 → 0.3.1-next.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @ledgerhq/coin-framework
 
+## 0.3.1-next.0
+
+### Patch Changes
+
+- [#2817](https://github.com/LedgerHQ/ledger-live/pull/2817) [`d5cf1abc6e`](https://github.com/LedgerHQ/ledger-live/commit/d5cf1abc6eb30d399c83b827452dc4bc61fd2253) Thanks [@thomasrogerlux](https://github.com/thomasrogerlux)! - Add Stax-enabled NFTs in the mock fixtures
+
+- [#3164](https://github.com/LedgerHQ/ledger-live/pull/3164) [`be5589dac6`](https://github.com/LedgerHQ/ledger-live/commit/be5589dac675e2c8c1771b135bd0f330a868ed2d) Thanks [@haammar-ledger](https://github.com/haammar-ledger)! - Add a 'feesCurrency' field to 'Account' type, and use it
+
+- Updated dependencies [[`3242a0a794`](https://github.com/LedgerHQ/ledger-live/commit/3242a0a7948c20fb0100ce3cc73e55e338534d32), [`be5589dac6`](https://github.com/LedgerHQ/ledger-live/commit/be5589dac675e2c8c1771b135bd0f330a868ed2d), [`d5cf1abc6e`](https://github.com/LedgerHQ/ledger-live/commit/d5cf1abc6eb30d399c83b827452dc4bc61fd2253)]:
+  - @ledgerhq/cryptoassets@9.4.0-next.0
+  - @ledgerhq/types-live@6.32.1-next.0
+  - @ledgerhq/live-portfolio@0.0.3-next.0
+
 ## 0.3.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ledgerhq/coin-framework",
-  "version": "0.3.0",
+  "version": "0.3.1-next.0",
   "description": "Ledger framework for Coin integration",
   "keywords": [
     "Ledger",
@@ -61,16 +61,16 @@
     "prando": "^6.0.1",
     "rxjs": "^6.6.7",
     "rxjs-compat": "^6.6.7",
-    "@ledgerhq/cryptoassets": "^9.3.0",
+    "@ledgerhq/cryptoassets": "^9.4.0-next.0",
     "@ledgerhq/devices": "^8.0.1",
     "@ledgerhq/errors": "^6.12.4",
     "@ledgerhq/hw-transport": "^6.28.2",
     "@ledgerhq/live-env": "^0.1.0",
-    "@ledgerhq/live-portfolio": "^0.0.2",
+    "@ledgerhq/live-portfolio": "^0.0.3-next.0",
     "@ledgerhq/live-promise": "^0.0.1",
     "@ledgerhq/logs": "^6.10.1",
     "@ledgerhq/types-cryptoassets": "^7.1.0",
-    "@ledgerhq/types-live": "^6.32.0"
+    "@ledgerhq/types-live": "^6.32.1-next.0"
   },
   "devDependencies": {
     "@types/invariant": "^2.2.2",
@@ -90,7 +90,7 @@
     "prettier": "^2.8.1",
     "timemachine": "^0.3.2",
     "ts-jest": "^28.0.5",
-    "typescript": "^4.9.4"
+    "typescript": "^4.9.5"
   },
   "scripts": {
     "clean": "rm -rf lib lib-es",

package/src/account/helpers.test.ts

@@ -18,6 +18,7 @@ import {
   getAccountName,
   getAccountSpendableBalance,
   getAccountUnit,
+  getFeesCurrency,
 } from ".";
 import {
   isAccountEmpty,
@@ -135,6 +136,65 @@ describe(getAccountUnit.name, () => {
   });
 });
 
+describe(getFeesCurrency.name, () => {
+  describe("given an Account", () => {
+    beforeEach(() => {
+      mockAccount.type = "Account";
+    });
+    describe("without feesCurrency", () => {
+      it("should return the account's currency", () => {
+        const sampleCurrency = { family: "bitcoin" } as CryptoCurrency;
+        mockAccount.currency = sampleCurrency;
+        expect(getFeesCurrency(mockAccount)).toEqual(sampleCurrency);
+      });
+    });
+    describe("with feesCurrency", () => {
+      it("should return the fees currency", () => {
+        const sampleCurrency = { family: "vechain" } as CryptoCurrency;
+        const sampleFeesCurrency = { id: "VTHO" } as TokenCurrency;
+        mockAccount.currency = sampleCurrency;
+        mockAccount.feesCurrency = sampleFeesCurrency;
+        expect(getFeesCurrency(mockAccount)).toEqual(sampleFeesCurrency);
+      });
+    });
+  });
+
+  describe("given a ChildAccount", () => {
+    it("should return the currency", () => {
+      const sampleCurrency = { family: "bitcoin" } as CryptoCurrency;
+      childAccount.currency = sampleCurrency;
+      expect(getFeesCurrency(childAccount)).toEqual(sampleCurrency);
+    });
+  });
+
+  describe("given a TokenAccount", () => {
+    it("should return the token currency", () => {
+      const sampleToken = { id: "tokenId" } as TokenCurrency;
+      tokenAccount.token = sampleToken;
+      expect(getFeesCurrency(tokenAccount)).toEqual(sampleToken);
+    });
+  });
+
+  describe("given an unknown type Account", () => {
+    beforeEach(() => {
+      (mockAccount as any).type = "DefinitelyNotAStandardAccount";
+    });
+
+    it("should throw an error", () => {
+      expect(() => getFeesCurrency(mockAccount)).toThrow(Error);
+    });
+
+    it("should display the account type in the error message", () => {
+      expect.assertions(1);
+      try {
+        getFeesCurrency(mockAccount);
+      } catch (e: unknown) {
+        expect((e as Error).message.includes(mockAccount.type)).toEqual(true);
+      }
+    });
+  });
+});
+
 describe(getAccountName.name, () => {
   describe("given an Account", () => {
     beforeEach(() => {

package/src/account/helpers.ts

@@ -17,9 +17,9 @@ import {
   Unit,
 } from "@ledgerhq/types-cryptoassets";
 
-// by convention, a main account is the top level account
-// in case of an Account is the account itself
-// in case of a TokenAccount it's the parentAccount
+// By convention, a main account is the top level account
+// - in case of an Account is the account itself
+// - in case of a SubAccount it's the parentAccount
 export const getMainAccount = (
   account: AccountLike,
   parentAccount?: Account | null | undefined
@@ -29,6 +29,32 @@ export const getMainAccount = (
   return mainAccount as Account;
 };
 
+// Return the currency in which fees are paid for this account
+export const getFeesCurrency = (
+  account?: AccountLike
+): TokenCurrency | CryptoCurrency => {
+  switch (account?.type) {
+    case "Account":
+      return account.feesCurrency || account.currency;
+
+    case "ChildAccount":
+      return account.currency;
+
+    case "TokenAccount":
+      return account.token;
+
+    default:
+      throw new Error(
+        "invalid account.type=" + (account as unknown as { type: string })?.type
+      );
+  }
+};
+
+// Return the unit to use with the fees currency
+export const getFeesUnit = (currency: TokenCurrency | CryptoCurrency): Unit => {
+  return currency.units[0];
+};
+
 export const getAccountCurrency = (
   account?: AccountLike
 ): TokenCurrency | CryptoCurrency => {

package/src/mocks/account.ts

@@ -65,7 +65,6 @@ const hardcodedMarketcap = [
   "tezos",
   "iota",
   "ethereum/erc20/link_chainlink",
-  "neo",
   "ethereum/erc20/makerdao",
   "ethereum/erc20/usd__coin",
   "ontology",
@@ -391,7 +390,8 @@ export function genAccount(
     ...(withNft && {
       nfts: Array(10)
         .fill(null)
-        .map(() => createFixtureNFT(accountId, currency)),
+        // The index === 0 ensure at least one NFT is a Stax NFT if the currency is Ethereum
+        .map((_, index) => createFixtureNFT(accountId, currency, index === 0)),
     }),
   };
 

package/src/mocks/fixtures/nfts.ts

@@ -307,6 +307,19 @@ export const NFTs = [
   },
 ];
 
+// Ethereum NFTs with the special "staxImage" metadata designed to fit the Ledger Stax screen
+export const NFTs_ETHEREUM_STAX_METADATA = [
+  {
+    id: "js:2:ethereum:0xB98d10d9f6d07bA283bFD21B2dFEc050f9Ae282A:+0xf4ac11a8967bc88c9ce5acf886bce605c9db9d6e+8482",
+    tokenId: "8482",
+    amount: "1",
+    collection: {
+      contract: "0xf4ac11a8967bc88c9ce5acf886bce605c9db9d6e",
+      standard: "ERC721",
+    },
+  },
+];
+
 export const NFTs_POLYGON = [
   {
     id: "js:2:ethereum:0xB98d10d9f6d07bA283bFD21B2dFEc050f9Ae282A:+0x68a0B29526f342de944BBd6bF61D9c644B96b771+7",
@@ -340,9 +353,15 @@ export const NFTs_POLYGON = [
 ];
 export function createFixtureNFT(
   accountId: string,
-  currency: CryptoCurrency = defaultEthCryptoFamily
+  currency: CryptoCurrency = defaultEthCryptoFamily,
+  useStaxNFTs?: boolean
 ): ProtoNFT {
-  const nfts = currency.id === "ethereum" ? NFTs : NFTs_POLYGON;
+  const nfts =
+    currency.id === "ethereum"
+      ? useStaxNFTs
+        ? NFTs_ETHEREUM_STAX_METADATA
+        : NFTs
+      : NFTs_POLYGON;
   const index = Math.floor(Math.random() * nfts.length);
 
   const nft = nfts[index];