@ledgerhq/coin-canton 0.9.0-nightly.3 → 0.9.0-nightly.4

package/src/bridge/getTransactionStatus.ts

@@ -4,21 +4,30 @@ import {
   FeeRequired,
   FeeTooHigh,
   InvalidAddress,
-  InvalidAddressBecauseDestinationIsAlsoSource,
   NotEnoughBalanceBecauseDestinationNotCreated,
   NotEnoughSpendableBalance,
   RecipientRequired,
 } from "@ledgerhq/errors";
 import BigNumber from "bignumber.js";
-import { Account, AccountBridge } from "@ledgerhq/types-live";
+import { AccountBridge } from "@ledgerhq/types-live";
 import { formatCurrencyUnit } from "@ledgerhq/coin-framework/currencies/index";
-import { Transaction, TransactionStatus } from "../types";
+import {
+  Transaction,
+  TransactionStatus,
+  CantonAccount,
+  TooManyUtxosCritical,
+  TooManyUtxosWarning,
+} from "../types";
 import { isRecipientValid } from "../common-logic/utils";
 import coinConfig from "../config";
+import { getAbandonSeedAddress } from "@ledgerhq/cryptoassets/abandonseed";
+
+export const TO_MANY_UTXOS_CRITICAL_COUNT = 100;
+export const TO_MANY_UTXOS_WARNING_COUNT = 10;
 
 export const getTransactionStatus: AccountBridge<
   Transaction,
-  Account,
+  CantonAccount,
   TransactionStatus
 >["getTransactionStatus"] = async (account, transaction) => {
   const errors: Record<string, Error> = {};
@@ -63,9 +72,6 @@ export const getTransactionStatus: AccountBridge<
 
   if (!transaction.recipient) {
     errors.recipient = new RecipientRequired("");
-  } else if (account.freshAddress === transaction.recipient) {
-    // we want to prevent user from sending to themselves (even if it's technically feasible)
-    errors.recipient = new InvalidAddressBecauseDestinationIsAlsoSource();
   } else if (!isRecipientValid(transaction.recipient)) {
     // We want to prevent user from sending to an invalid address
     errors.recipient = new InvalidAddress("", {
@@ -78,6 +84,8 @@ export const getTransactionStatus: AccountBridge<
     errors.amount = new AmountRequired();
   }
 
+  validateUtxoCount(account, transaction, warnings);
+
   return {
     errors,
     warnings,
@@ -86,3 +94,30 @@ export const getTransactionStatus: AccountBridge<
     totalSpent,
   };
 };
+
+function validateUtxoCount(
+  account: CantonAccount,
+  transaction: Transaction,
+  warnings: Record<string, Error>,
+): void {
+  const abandonSeedAddress = getAbandonSeedAddress(account.currency.id);
+  const isAbandonSeedAddress = transaction.recipient?.includes(abandonSeedAddress);
+
+  // UTXO count validation - only validate if recipient is valid and not equal to sender
+  // Skip validation for abandon seed addresses
+  if (
+    account?.cantonResources?.instrumentUtxoCounts &&
+    transaction.recipient &&
+    isRecipientValid(transaction.recipient) &&
+    account.xpub !== transaction.recipient &&
+    !isAbandonSeedAddress
+  ) {
+    const { instrumentUtxoCounts } = account.cantonResources;
+    const instrumentUtxoCount = instrumentUtxoCounts[transaction.tokenId] || 0;
+    if (instrumentUtxoCount > TO_MANY_UTXOS_CRITICAL_COUNT) {
+      warnings.tooManyUtxos = new TooManyUtxosCritical();
+    } else if (instrumentUtxoCount > TO_MANY_UTXOS_WARNING_COUNT) {
+      warnings.tooManyUtxos = new TooManyUtxosWarning("families.canton.tooManyUtxos.warning");
+    }
+  }
+}

package/src/bridge/index.ts

@@ -10,7 +10,7 @@ import { SignerContext } from "@ledgerhq/coin-framework/signer";
 import type { AccountBridge } from "@ledgerhq/types-live";
 import cantonCoinConfig, { type CantonCoinConfig } from "../config";
 import resolver from "../signer";
-import { CantonCurrencyBridge, CantonSigner } from "../types";
+import { CantonCurrencyBridge, CantonSigner, CantonAccount } from "../types";
 import type { Transaction } from "../types";
 import { broadcast } from "./broadcast";
 import { createTransaction } from "./createTransaction";
@@ -21,6 +21,7 @@ import { buildSignOperation } from "./signOperation";
 import { makeGetAccountShape } from "./sync";
 import { updateTransaction } from "./updateTransaction";
 import { buildOnboardAccount, buildAuthorizePreapproval } from "./onboard";
+import { assignToAccountRaw, assignFromAccountRaw } from "./serialization";
 
 export function createBridges(
   signerContext: SignerContext<CantonSigner>,
@@ -49,13 +50,11 @@ export function createBridges(
 
   const signOperation = buildSignOperation(signerContext);
   const sync = makeSync({ getAccountShape: makeGetAccountShape(signerContext) });
-  // we want one method per file
-  const accountBridge: AccountBridge<Transaction> = {
+
+  const accountBridge: AccountBridge<Transaction, CantonAccount> = {
     broadcast,
     createTransaction,
     updateTransaction,
-    // NOTE: use updateTransaction: defaultUpdateTransaction<Transaction>,
-    // if you don't need to update the transaction patch object
     prepareTransaction,
     getTransactionStatus,
     estimateMaxSpendable,
@@ -65,6 +64,8 @@ export function createBridges(
     signRawOperation: () => {
       throw new Error("signRawOperation is not supported");
     },
+    assignToAccountRaw,
+    assignFromAccountRaw,
     getSerializedAddressParameters,
   };
 

package/src/bridge/onboard.integ.test.ts

@@ -1,45 +1,22 @@
-import BigNumber from "bignumber.js";
-import { firstValueFrom, toArray } from "rxjs";
 import { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
-import { emptyHistoryCache } from "@ledgerhq/coin-framework/account/index";
-import { generateMockKeyPair, createMockSigner } from "../test/cantonTestUtils";
+import { firstValueFrom, toArray } from "rxjs";
+import coinConfig from "../config";
+import { createMockSigner, generateMockKeyPair } from "../test/cantonTestUtils";
+import { createMockAccount, createMockCantonCurrency } from "../test/fixtures";
 import {
   AuthorizeStatus,
-  OnboardStatus,
   CantonAuthorizeProgress,
   CantonAuthorizeResult,
   CantonOnboardProgress,
   CantonOnboardResult,
+  OnboardStatus,
 } from "../types/onboard";
-import coinConfig from "../config";
-import { buildOnboardAccount, isAccountOnboarded, buildAuthorizePreapproval } from "./onboard";
+import { buildAuthorizePreapproval, buildOnboardAccount, isAccountOnboarded } from "./onboard";
 
 describe("onboard (devnet)", () => {
   const mockDeviceId = "test-device-id";
-  const mockCurrency = {
-    id: "canton_network",
-  } as unknown as CryptoCurrency;
-  const mockAccount = {
-    type: "Account" as const,
-    id: "js:2:canton_network:canton_3f5c9d9a:canton",
-    seedIdentifier: "canton_3f5c9d9a",
-    derivationMode: "canton" as const,
-    index: 0,
-    freshAddress: "canton_3f5c9d9a",
-    freshAddressPath: "44'/6767'/0'/0'/0'",
-    used: false,
-    balance: BigNumber(10000),
-    spendableBalance: BigNumber(10000),
-    creationDate: new Date(),
-    blockHeight: 1,
-    currency: mockCurrency,
-    operationsCount: 0,
-    operations: [],
-    pendingOperations: [],
-    lastSyncDate: new Date(),
-    balanceHistoryCache: emptyHistoryCache,
-    swapHistory: [],
-  };
+  const mockCurrency = createMockCantonCurrency();
+  const mockAccount = createMockAccount();
 
   let onboardedAccount: {
     keyPair: ReturnType<typeof generateMockKeyPair>;

package/src/bridge/prepareTransaction.ts

@@ -11,7 +11,7 @@ export const prepareTransaction: AccountBridge<Transaction>["prepareTransaction"
 ) => {
   const amount = transaction.amount || BigNumber(0);
   const fee = BigNumber(
-    (await estimateFees(account.currency, BigInt(amount.toString()))).toString(),
+    (await estimateFees(account.currency, BigInt(amount.toFixed()))).toString(),
   );
 
   if (!transaction.tokenId) {

package/src/bridge/serialization.ts

@@ -0,0 +1,44 @@
+import type { Account, AccountRaw } from "@ledgerhq/types-live";
+import {
+  type CantonAccount,
+  type CantonAccountRaw,
+  type CantonResources,
+  type CantonResourcesRaw,
+} from "../types";
+
+function isCantonAccount(account: Account): account is CantonAccount {
+  return "cantonResources" in account;
+}
+
+function isCantonAccountRaw(accountRaw: AccountRaw): accountRaw is CantonAccountRaw {
+  return "cantonResources" in accountRaw;
+}
+
+function toResourcesRaw(r: CantonResources): CantonResourcesRaw {
+  const { instrumentUtxoCounts } = r;
+  return {
+    instrumentUtxoCounts,
+  };
+}
+
+function fromResourcesRaw(r: CantonResourcesRaw): CantonResources {
+  return {
+    instrumentUtxoCounts: r.instrumentUtxoCounts,
+  };
+}
+
+export function assignToAccountRaw(account: Account, accountRaw: AccountRaw): void {
+  if (isCantonAccount(account) && isCantonAccountRaw(accountRaw)) {
+    if (account.cantonResources) {
+      accountRaw.cantonResources = toResourcesRaw(account.cantonResources);
+    }
+  }
+}
+
+export function assignFromAccountRaw(accountRaw: AccountRaw, account: Account): void {
+  if (isCantonAccountRaw(accountRaw) && isCantonAccount(account)) {
+    if (accountRaw.cantonResources) {
+      account.cantonResources = fromResourcesRaw(accountRaw.cantonResources);
+    }
+  }
+}

package/src/bridge/signOperation.test.ts

@@ -9,6 +9,7 @@ import { Transaction } from "../types";
 import { craftTransaction } from "../common-logic";
 import prepareTransferMock from "../test/prepare-transfer.json";
 import { buildSignOperation } from "./signOperation";
+import { createMockAccount } from "../test/fixtures";
 
 jest.mock("../common-logic", () => {
   const actual = jest.requireActual("../common-logic");
@@ -54,25 +55,18 @@ class MockCantonSigner implements CantonSigner {
 describe("buildSignOperation", () => {
   const mockDeviceId = "test-device-id";
   const mockDerivationPath = "44'/6767'/0'/0'/0'";
-  const mockPartyId = "alice::1220d466a5d96a3509736c821e25fe81fc8a73f226d92e57e94a65170e58b07fc08e";
 
   beforeEach(() => {
     jest.clearAllMocks();
     mockCraftTransaction.mockReset();
   });
 
-  const mockAccount = {
+  const mockAccount = createMockAccount({
     id: "js:2:canton_network:test-party-id:",
     freshAddress: "test-address",
     freshAddressPath: mockDerivationPath,
     xpub: "test-party-id",
-    currency: {
-      id: "canton_network",
-    },
-    cantonResources: {
-      partyId: mockPartyId,
-    },
-  } as any;
+  });
 
   const mockTransaction: Transaction = {
     family: "canton",

package/src/bridge/sync.test.ts

@@ -52,6 +52,7 @@ describe("makeGetAccountShape", () => {
     mockedCoinConfig.mockReturnValue({
       nativeInstrumentId: "Native",
       minReserve: "0",
+      useGateway: true,
     });
 
     mockedIsAuthorized.mockResolvedValue(true);
@@ -64,6 +65,7 @@ describe("makeGetAccountShape", () => {
         instrument_id: "Native",
         amount: "1000",
         locked: false,
+        utxo_count: 1,
       },
     ]);
     mockedGetOperations.mockResolvedValue({
@@ -113,11 +115,13 @@ describe("makeGetAccountShape", () => {
         instrument_id: "LockedNative",
         amount: "1000",
         locked: true,
+        utxo_count: 1,
       },
       {
         instrument_id: "Native",
         amount: "10",
         locked: false,
+        utxo_count: 1,
       },
     ]);
 

package/src/bridge/sync.ts

@@ -4,7 +4,8 @@ import { encodeAccountId } from "@ledgerhq/coin-framework/account/index";
 import { GetAccountShape, mergeOps } from "@ledgerhq/coin-framework/bridge/jsHelpers";
 import { encodeOperationId } from "@ledgerhq/coin-framework/operation";
 import { SignerContext } from "@ledgerhq/coin-framework/signer";
-import { getBalance, getLedgerEnd, getOperations, type OperationInfo } from "../network/gateway";
+import { getLedgerEnd, getOperations, type OperationInfo } from "../network/gateway";
+import { getBalance, type CantonBalance } from "../common-logic/account/getBalance";
 import coinConfig from "../config";
 import resolver from "../signer";
 import { CantonAccount, CantonSigner } from "../types";
@@ -108,19 +109,26 @@ export function makeGetAccountShape(
     const balances = xpubOrAddress ? await getBalance(currency, xpubOrAddress) : [];
 
     const balancesData = (balances || []).reduce(
-      (acc, { amount, instrument_id, locked }) => {
-        acc[instrument_id] = { amount, locked };
+      (acc, balance) => {
+        acc[balance.instrumentId] = balance;
         return acc;
       },
-      {} as Record<string, { amount: string; locked: boolean }>,
+      {} as Record<string, CantonBalance>,
     );
 
-    const unlockedAmount = new BigNumber(balancesData[nativeInstrumentId]?.amount || "0");
-    const lockedAmount = new BigNumber(balancesData[`Locked${nativeInstrumentId}`]?.amount || "0");
+    const unlockedAmount = new BigNumber(balancesData[nativeInstrumentId]?.value.toString() || "0");
+    const lockedAmount = new BigNumber(
+      balancesData[`Locked${nativeInstrumentId}`]?.value.toString() || "0",
+    );
     const totalBalance = unlockedAmount.plus(lockedAmount);
     const reserveMin = new BigNumber(coinConfig.getCoinConfig(currency).minReserve || 0);
     const spendableBalance = BigNumber.max(0, unlockedAmount.minus(reserveMin));
 
+    const instrumentUtxoCounts: Record<string, number> = {};
+    for (const [instrumentId, balance] of Object.entries(balancesData)) {
+      instrumentUtxoCounts[instrumentId] = balance.utxoCount;
+    }
+
     let operations: Operation[] = [];
     if (xpubOrAddress) {
       const oldOperations = initialAccount?.operations || [];
@@ -159,6 +167,9 @@ export function makeGetAccountShape(
       spendableBalance,
       xpub: xpubOrAddress,
       used,
+      cantonResources: {
+        instrumentUtxoCounts,
+      },
     };
 
     return shape;

package/src/bridge/transaction.ts

@@ -48,7 +48,7 @@ export const toTransactionRaw = (t: Transaction): TransactionRaw => {
   return {
     ...common,
     family: t.family,
-    fee: t.fee ? t.fee.toString() : null,
+    fee: t.fee ? t.fee.toFixed() : null,
     tokenId: t.tokenId,
   };
 };

package/src/common-logic/account/getBalance.ts

@@ -3,12 +3,17 @@ import { getBalance as gatewayGetBalance, type InstrumentBalance } from "../../n
 import coinConfig from "../../config";
 import { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
 
+export type CantonBalance = Balance & {
+  utxoCount: number;
+  instrumentId: string;
+};
+
 const useGateway = (currency: CryptoCurrency) =>
   coinConfig.getCoinConfig(currency).useGateway === true;
 const getNativeId = (currency: CryptoCurrency) =>
   coinConfig.getCoinConfig(currency).nativeInstrumentId;
 
-function adaptInstrument(currency: CryptoCurrency, instrument: InstrumentBalance): Balance {
+function adaptInstrument(currency: CryptoCurrency, instrument: InstrumentBalance): CantonBalance {
   return {
     value: BigInt(instrument.amount),
     locked: instrument.locked === true ? BigInt(instrument.amount) : BigInt(0),
@@ -16,10 +21,15 @@ function adaptInstrument(currency: CryptoCurrency, instrument: InstrumentBalance
       getNativeId(currency) === instrument.instrument_id
         ? { type: "native" }
         : { type: "token", assetReference: instrument.instrument_id },
+    utxoCount: instrument.utxo_count,
+    instrumentId: instrument.instrument_id,
   };
 }
 
-export async function getBalance(currency: CryptoCurrency, partyId: string): Promise<Balance[]> {
+export async function getBalance(
+  currency: CryptoCurrency,
+  partyId: string,
+): Promise<CantonBalance[]> {
   if (useGateway(currency))
     return (await gatewayGetBalance(currency, partyId)).map(instrument =>
       adaptInstrument(currency, instrument),

package/src/common-logic/account/getBalance.unit.test.ts

@@ -29,11 +29,13 @@ describe("getBalance", () => {
       {
         instrument_id: "native-id",
         amount: "1000",
+        utxo_count: 1,
         locked: false,
       },
       {
         instrument_id: "token-123",
         amount: "5000",
+        utxo_count: 1,
         locked: true,
       },
     ];
@@ -43,16 +45,20 @@ describe("getBalance", () => {
     const result = await getBalance(mockCurrency, "party-id");
 
     expect(getBalanceFromNetwork).toHaveBeenCalledWith(mockCurrency, "party-id");
-    expect(result).toEqual<Balance[]>([
+    expect(result).toEqual([
       {
         value: BigInt(1000),
         locked: BigInt(0),
         asset: { type: "native" },
+        utxoCount: 1,
+        instrumentId: "native-id",
       },
       {
         value: BigInt(5000),
         locked: BigInt(5000),
         asset: { type: "token", assetReference: "token-123" },
+        utxoCount: 1,
+        instrumentId: "token-123",
       },
     ]);
   });

package/src/common-logic/transaction/craftTransaction.ts

@@ -27,7 +27,7 @@ export async function craftTransaction(
 }> {
   const params: PrepareTransferRequest = {
     recipient: transaction.recipient || "",
-    amount: transaction.amount.toString(),
+    amount: transaction.amount.toFixed(),
     type: "token-transfer-request" as const,
     execute_before_secs: transaction.expireInSeconds,
     instrument_id: transaction.tokenId,

package/src/network/gateway.ts

@@ -91,6 +91,7 @@ export type InstrumentBalance = {
   instrument_id: string;
   amount: string;
   locked: boolean;
+  utxo_count: number;
 };
 
 type PartyInfo = {

package/src/test/fixtures.ts

@@ -0,0 +1,53 @@
+import BigNumber from "bignumber.js";
+import { Account } from "@ledgerhq/types-live";
+import { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
+import { getDerivationScheme, runDerivationScheme } from "@ledgerhq/coin-framework/derivation";
+import { createEmptyHistoryCache } from "@ledgerhq/coin-framework/account";
+
+export const createMockCantonCurrency = (): CryptoCurrency => {
+  const mockCurrency = {
+    id: "canton_network",
+    name: "Canton",
+    type: "CryptoCurrency",
+    family: "canton",
+    units: [{ name: "Canton", code: "CANTON", magnitude: 38 }],
+    ticker: "CANTON",
+    scheme: "canton",
+    color: "#000000",
+    managerAppName: "Canton",
+    coinType: 6767,
+    explorerViews: [],
+  } satisfies CryptoCurrency;
+  return mockCurrency;
+};
+
+export const createMockAccount = (overrides: Partial<Account> = {}): Account => {
+  const currency = createMockCantonCurrency();
+  const derivationMode = "canton" as const;
+  const scheme = getDerivationScheme({ derivationMode, currency });
+  const freshAddressPath = runDerivationScheme(scheme, currency, { account: 0 });
+
+  return {
+    id: "js:2:canton_network:test-address:canton",
+    type: "Account",
+    used: true,
+    currency,
+    derivationMode,
+    index: 0,
+    freshAddress: "test_address",
+    freshAddressPath,
+    creationDate: new Date(),
+    lastSyncDate: new Date(),
+    balance: new BigNumber(0),
+    spendableBalance: new BigNumber(0),
+    seedIdentifier: "test_seed",
+    blockHeight: 0,
+    operationsCount: 0,
+    operations: [],
+    pendingOperations: [],
+    balanceHistoryCache: createEmptyHistoryCache(),
+    swapHistory: [],
+    subAccounts: [],
+    ...overrides,
+  };
+};

package/src/types/bridge.ts

@@ -48,6 +48,7 @@ export type Transaction = TransactionCommon & {
   fee: BigNumber | null | undefined;
   memo?: string;
   tokenId: string;
+  expireInSeconds?: number;
 };
 
 export type TransactionRaw = TransactionCommonRaw & {
@@ -55,10 +56,22 @@ export type TransactionRaw = TransactionCommonRaw & {
   fee: string | null | undefined;
   memo?: string;
   tokenId: string;
+  expireInSeconds?: number;
 };
 
 export type TransactionStatus = TransactionStatusCommon;
 export type TransactionStatusRaw = TransactionStatusCommonRaw;
 
-export type CantonAccount = Account;
-export type CantonAccountRaw = AccountRaw;
+export type CantonResources = {
+  instrumentUtxoCounts: Record<string, number>;
+};
+export type CantonResourcesRaw = {
+  instrumentUtxoCounts: Record<string, number>;
+};
+
+export type CantonAccount = Account & {
+  cantonResources: CantonResources;
+};
+export type CantonAccountRaw = AccountRaw & {
+  cantonResources: CantonResourcesRaw;
+};

package/src/types/errors.ts

@@ -1,3 +1,6 @@
 import { createCustomErrorClass } from "@ledgerhq/errors";
 
 export const SimulationError = createCustomErrorClass("SimulationError");
+
+export const TooManyUtxosCritical = createCustomErrorClass("TooManyUtxosCritical");
+export const TooManyUtxosWarning = createCustomErrorClass("TooManyUtxosWarning");

package/src/types/index.ts

@@ -1,3 +1,4 @@
 export * from "./bridge";
+export * from "./errors";
 export * from "./onboard";
 export * from "./signer";