@ledgerhq/coin-ton 0.7.0 → 0.8.0-next.0

package/src/__tests__/unit/utils.unit.test.ts

@@ -1,4 +1,5 @@
 import { Address, toNano } from "@ton/core";
+import { setCoinConfig } from "../../config";
 import {
   TOKEN_TRANSFER_FORWARD_AMOUNT,
   TOKEN_TRANSFER_MAX_FEE,
@@ -13,6 +14,7 @@ import {
   getTransferExpirationTime,
   isAddressValid,
 } from "../../utils";
+import mockServer, { API_TON_ENDPOINT } from "../fixtures/api.fixtures";
 import {
   account,
   transaction as baseTransaction,
@@ -90,6 +92,7 @@ describe("TON transfers", () => {
     customPayload: null,
     forwardAmount: BigInt(0),
     forwardPayload: null,
+    knownJetton: null,
   };
 
   const nftPayload: TonPayloadFormat = {
@@ -139,6 +142,23 @@ describe("Get TON paths", () => {
 });
 
 describe("Build TON transaction", () => {
+  beforeAll(() => {
+    setCoinConfig(() => ({
+      status: {
+        type: "active",
+      },
+      infra: {
+        API_TON_ENDPOINT: API_TON_ENDPOINT,
+        KNOWN_JETTONS: [],
+      },
+    }));
+    mockServer.listen();
+  });
+
+  afterAll(() => {
+    mockServer.close();
+  });
+
   const seqno = 22;
 
   test("Build TON transaction with an specific amount", () => {
@@ -184,7 +204,7 @@ describe("Build TON transaction", () => {
       to: jettonTransfer.to.toString(),
       payload: undefined,
     }).toStrictEqual({
-      to: Address.parse(account.subAccounts?.[0].token.contractAddress ?? "").toString(),
+      to: Address.parse(account.subAccounts?.[0].jettonWallet ?? "").toString(),
       seqno,
       amount: toNano(TOKEN_TRANSFER_MAX_FEE),
       bounce: true,
@@ -213,6 +233,7 @@ describe("Build TON transaction", () => {
       customPayload: null,
       forwardAmount: TOKEN_TRANSFER_FORWARD_AMOUNT.toString(),
       forwardPayload: null,
+      knownJetton: null,
     });
   });
 });

package/src/bridge/js.ts

@@ -1,9 +1,9 @@
 import getAddressWrapper from "@ledgerhq/coin-framework/bridge/getAddressWrapper";
 import {
   getSerializedAddressParameters,
-  updateTransaction,
   makeAccountBridgeReceive,
   makeScanAccounts,
+  updateTransaction,
 } from "@ledgerhq/coin-framework/bridge/jsHelpers";
 import { SignerContext } from "@ledgerhq/coin-framework/signer";
 
@@ -18,7 +18,7 @@ import prepareTransaction from "../prepareTransaction";
 import { buildSignOperation } from "../signOperation";
 import { TonSigner } from "../signer";
 import { getAccountShape, sync } from "../synchronisation";
-import type { Transaction } from "../types";
+import type { TonAccount, Transaction } from "../types";
 
 export function buildCurrencyBridge(signerContext: SignerContext<TonSigner>): CurrencyBridge {
   const getAddress = resolver(signerContext);
@@ -37,7 +37,7 @@ export function buildCurrencyBridge(signerContext: SignerContext<TonSigner>): Cu
 
 export function buildAccountBridge(
   signerContext: SignerContext<TonSigner>,
-): AccountBridge<Transaction> {
+): AccountBridge<Transaction, TonAccount> {
   const getAddress = resolver(signerContext);
 
   const receive = makeAccountBridgeReceive(getAddressWrapper(getAddress));

package/src/config.ts

@@ -1,8 +1,10 @@
 import { CurrencyConfig } from "@ledgerhq/coin-framework/config";
+import { KnownJetton } from "./types";
 
 export type TonCoinConfig = () => CurrencyConfig & {
   infra: {
     API_TON_ENDPOINT: string;
+    KNOWN_JETTONS: KnownJetton[];
   };
 };
 

package/src/constants.ts

@@ -26,6 +26,10 @@ export const TOKEN_TRANSFER_QUERY_ID = 0;
  */
 export const MAX_COMMENT_BYTES = 120;
 
+/**
+ * Operation codes for Jetton (TON token standard) transactions.
+ * These codes are used to identify different types of token operations.
+ */
 export enum JettonOpCode {
   Transfer = 0xf8a7ea5,
   TransferNotification = 0x7362d09c,
@@ -34,3 +38,19 @@ export enum JettonOpCode {
   Burn = 0x595f07bc,
   BurnNotification = 0x7bdd97de,
 }
+
+/**
+ * TON blockchain workchain identifiers.
+ * MasterChain (-1) is used for validator operations and governance.
+ * BaseChain (0) is the main workchain used for regular accounts and smart contracts.
+ */
+export enum Workchain {
+  MasterChain = -1,
+  BaseChain = 0,
+}
+
+/**
+ * Default workchain used for TON addresses.
+ * BaseChain (0) is the standard workchain for user accounts and transactions.
+ */
+export const WORKCHAIN = Workchain.BaseChain;

package/src/deviceTransactionConfig.ts

@@ -1,6 +1,9 @@
-import { isTokenAccount } from "@ledgerhq/coin-framework/account/index";
+import { getAccountCurrency, isTokenAccount } from "@ledgerhq/coin-framework/account/index";
+import { formatCurrencyUnit } from "@ledgerhq/coin-framework/currencies/index";
 import { CommonDeviceTransactionField as DeviceTransactionField } from "@ledgerhq/coin-framework/transaction/common";
 import type { Account, AccountLike } from "@ledgerhq/types-live";
+import { toNano } from "@ton/core";
+import { BigNumber } from "bignumber.js";
 import { TOKEN_TRANSFER_MAX_FEE } from "./constants";
 import type { Transaction, TransactionStatus } from "./types";
 
@@ -22,13 +25,29 @@ function getDeviceTransactionConfig(input: {
   if (tokenTransfer) {
     fields.push({
       type: "text",
-      label: "Jetton units",
-      value: input.transaction.amount.toString(),
+      label: "Jetton amount",
+      value: formatCurrencyUnit(
+        getAccountCurrency(input.account).units[0],
+        input.transaction.amount,
+        {
+          showCode: true,
+          disableRounding: true,
+        },
+      ),
     });
     fields.push({
       type: "text",
       label: "Amount",
-      value: TOKEN_TRANSFER_MAX_FEE,
+      value: input.parentAccount
+        ? formatCurrencyUnit(
+            getAccountCurrency(input.parentAccount).units[0],
+            BigNumber(toNano(TOKEN_TRANSFER_MAX_FEE).toString()),
+            {
+              showCode: true,
+              disableRounding: true,
+            },
+          )
+        : TOKEN_TRANSFER_MAX_FEE,
     });
   } else {
     if (input.transaction.useAllAmount) {

package/src/estimateMaxSpendable.ts

@@ -1,15 +1,14 @@
-import {
-  findSubAccountById,
-  getMainAccount,
-  isTokenAccount,
-} from "@ledgerhq/coin-framework/account/index";
+import { getMainAccount, isTokenAccount } from "@ledgerhq/coin-framework/account/index";
 import type { Account, AccountBridge, AccountLike, TokenAccount } from "@ledgerhq/types-live";
 import { BigNumber } from "bignumber.js";
 import { fetchAccountInfo } from "./bridge/bridgeHelpers/api";
-import type { Transaction } from "./types";
-import { buildTonTransaction, getTonEstimatedFees } from "./utils";
+import type { TonAccount, Transaction } from "./types";
+import { buildTonTransaction, findSubAccountById, getTonEstimatedFees } from "./utils";
 
-const estimateMaxSpendable: AccountBridge<Transaction, Account>["estimateMaxSpendable"] = async ({
+const estimateMaxSpendable: AccountBridge<
+  Transaction,
+  TonAccount
+>["estimateMaxSpendable"] = async ({
   account,
   parentAccount,
   transaction,
@@ -18,7 +17,7 @@ const estimateMaxSpendable: AccountBridge<Transaction, Account>["estimateMaxSpen
   parentAccount?: Account | null | undefined;
   transaction?: Transaction | null | undefined;
 }): Promise<BigNumber> => {
-  const mainAccount = getMainAccount(account, parentAccount);
+  const mainAccount = getMainAccount(account, parentAccount) as TonAccount;
   let balance = mainAccount.spendableBalance;
 
   if (balance.eq(0)) return balance;
@@ -45,14 +44,11 @@ const estimateMaxSpendable: AccountBridge<Transaction, Account>["estimateMaxSpen
     return subAccount.spendableBalance;
   }
 
-  const estimatedFees = transaction
-    ? transaction.fees ??
-      (await getTonEstimatedFees(
-        mainAccount,
-        accountInfo.status === "uninit",
-        buildTonTransaction(transaction, accountInfo.seqno, mainAccount),
-      ))
-    : BigNumber(0);
+  let estimatedFees = BigNumber(0);
+  if (transaction) {
+    const tonTx = buildTonTransaction(transaction, accountInfo.seqno, mainAccount);
+    estimatedFees = await getTonEstimatedFees(mainAccount, accountInfo.status === "uninit", tonTx);
+  }
 
   if (balance.lte(estimatedFees)) return new BigNumber(0);
 

package/src/getTransactionStatus.ts

@@ -1,4 +1,4 @@
-import { findSubAccountById, isTokenAccount } from "@ledgerhq/coin-framework/account/index";
+import { isTokenAccount } from "@ledgerhq/coin-framework/account/index";
 import {
   AmountRequired,
   InvalidAddress,
@@ -6,7 +6,7 @@ import {
   NotEnoughBalance,
   RecipientRequired,
 } from "@ledgerhq/errors";
-import { Account, AccountBridge } from "@ledgerhq/types-live";
+import { AccountBridge } from "@ledgerhq/types-live";
 import { toNano } from "@ton/core";
 import BigNumber from "bignumber.js";
 import { MINIMUM_REQUIRED_BALANCE, TOKEN_TRANSFER_MAX_FEE } from "./constants";
@@ -16,8 +16,8 @@ import {
   TonMinimumRequired,
   TonNotEnoughBalanceInParentAccount,
 } from "./errors";
-import { Transaction, TransactionStatus } from "./types";
-import { addressesAreEqual, commentIsValid, isAddressValid } from "./utils";
+import { TonAccount, Transaction, TransactionStatus } from "./types";
+import { addressesAreEqual, commentIsValid, findSubAccountById, isAddressValid } from "./utils";
 
 type ValidatedTransactionFields = "recipient" | "sender" | "amount" | "transaction";
 type ValidationIssues = Partial<Record<ValidatedTransactionFields, Error>>;
@@ -25,7 +25,7 @@ type ValidationIssues = Partial<Record<ValidatedTransactionFields, Error>>;
 /**
  * Validate an address for account transaction
  */
-const validateRecipient = (account: Account, tx: Transaction): Array<ValidationIssues> => {
+const validateRecipient = (account: TonAccount, tx: Transaction): Array<ValidationIssues> => {
   const errors: ValidationIssues = {};
 
   if (tx.recipient) {
@@ -52,7 +52,7 @@ const validateRecipient = (account: Account, tx: Transaction): Array<ValidationI
 /**
  * Validate the sender address for account transaction
  */
-const validateSender = (account: Account): Array<ValidationIssues> => {
+const validateSender = (account: TonAccount): Array<ValidationIssues> => {
   const errors: ValidationIssues = {};
 
   // Check if sender is matching the format of account valid ton address or not
@@ -68,7 +68,7 @@ const validateSender = (account: Account): Array<ValidationIssues> => {
 };
 
 const validateAmount = (
-  account: Account,
+  account: TonAccount,
   transaction: Transaction,
   totalSpent: BigNumber,
 ): Array<ValidationIssues> => {
@@ -120,10 +120,10 @@ const validateComment = (transaction: Transaction): Array<ValidationIssues> => {
 
 export const getTransactionStatus: AccountBridge<
   Transaction,
-  Account,
+  TonAccount,
   TransactionStatus
 >["getTransactionStatus"] = async (
-  account: Account,
+  account: TonAccount,
   transaction: Transaction,
 ): Promise<TransactionStatus> => {
   const subAccount = findSubAccountById(account, transaction.subAccountId ?? "");

package/src/prepareTransaction.ts

@@ -1,12 +1,11 @@
-import { findSubAccountById } from "@ledgerhq/coin-framework/account/index";
 import { updateTransaction } from "@ledgerhq/coin-framework/bridge/jsHelpers";
-import { Account, AccountBridge } from "@ledgerhq/types-live";
+import { AccountBridge } from "@ledgerhq/types-live";
 import { fetchAccountInfo } from "./bridge/bridgeHelpers/api";
-import type { Transaction } from "./types";
-import { buildTonTransaction, getTonEstimatedFees } from "./utils";
+import type { TonAccount, Transaction } from "./types";
+import { buildTonTransaction, findSubAccountById, getTonEstimatedFees } from "./utils";
 
-const prepareTransaction: AccountBridge<Transaction, Account>["prepareTransaction"] = async (
-  account: Account,
+const prepareTransaction: AccountBridge<Transaction, TonAccount>["prepareTransaction"] = async (
+  account: TonAccount,
   transaction: Transaction,
 ): Promise<Transaction> => {
   const accountInfo = await fetchAccountInfo(account.freshAddress);

package/src/signOperation.ts

@@ -8,7 +8,7 @@ import { Observable } from "rxjs";
 import { fetchAccountInfo } from "./bridge/bridgeHelpers/api";
 import { TOKEN_TRANSFER_MAX_FEE } from "./constants";
 import type { TonSigner } from "./signer";
-import type { TonCell, TonOperation, Transaction } from "./types";
+import type { TonAccount, TonCell, TonOperation, Transaction } from "./types";
 import { buildTonTransaction, getLedgerTonPath } from "./utils";
 
 const packTransaction = (account: Account, needsInit: boolean, signature: TonCell): string => {
@@ -30,13 +30,15 @@ const packTransaction = (account: Account, needsInit: boolean, signature: TonCel
  * Sign Transaction with Ledger hardware
  */
 export const buildSignOperation =
-  (signerContext: SignerContext<TonSigner>): AccountBridge<Transaction>["signOperation"] =>
+  (
+    signerContext: SignerContext<TonSigner>,
+  ): AccountBridge<Transaction, TonAccount>["signOperation"] =>
   ({
     account,
     transaction,
     deviceId,
   }: {
-    account: Account;
+    account: TonAccount;
     transaction: Transaction;
     deviceId: DeviceId;
   }): Observable<SignOperationEvent> =>
@@ -87,7 +89,7 @@ export const buildSignOperation =
     });
 
 export const buildOptimisticOperation = (
-  account: Account,
+  account: TonAccount,
   transaction: Transaction,
 ): TonOperation => {
   const { recipient, amount, fees, comment, useAllAmount, subAccountId } = transaction;

package/src/synchronisation.ts

@@ -14,7 +14,6 @@ import {
 import { decodeOperationId } from "@ledgerhq/coin-framework/operation";
 import { log } from "@ledgerhq/logs";
 import { TokenCurrency } from "@ledgerhq/types-cryptoassets";
-import { Account, SubAccount } from "@ledgerhq/types-live";
 import BigNumber from "bignumber.js";
 import flatMap from "lodash/flatMap";
 import {
@@ -30,9 +29,12 @@ import {
   mapTxToOps,
 } from "./bridge/bridgeHelpers/txn";
 import { getSyncHash } from "./logic";
-import { TonOperation } from "./types";
+import { TonAccount, TonOperation, TonSubAccount } from "./types";
 
-export const getAccountShape: GetAccountShape<Account> = async (info, { blacklistedTokenIds }) => {
+export const getAccountShape: GetAccountShape<TonAccount> = async (
+  info,
+  { blacklistedTokenIds },
+) => {
   const { address, rest, currency, derivationMode, initialAccount } = info;
 
   const publicKey = reconciliatePubkey(rest?.publicKey, initialAccount);
@@ -85,6 +87,7 @@ export const getAccountShape: GetAccountShape<Account> = async (info, { blacklis
     mapJettonTxToOps(accountId, address, newTxs.address_book),
   );
   const operations = shouldSyncFromScratch ? newOps : mergeOps(oldOps, newOps);
+
   const subAccounts = await getSubAccounts(
     info,
     accountId,
@@ -103,7 +106,7 @@ export const getAccountShape: GetAccountShape<Account> = async (info, { blacklis
     blockHeight,
     xpub: publicKey,
     lastSyncDate: new Date(),
-  } as Partial<Account>;
+  } as Partial<TonAccount>;
   return toReturn;
 };
 
@@ -113,14 +116,15 @@ const getSubAccountShape = async (
   token: TokenCurrency,
   ops: TonOperation[],
   shouldSyncFromScratch: boolean,
-): Promise<Partial<SubAccount>> => {
-  const tokenAccountId = encodeTokenAccountId(parentId, token);
+): Promise<Partial<TonSubAccount>> => {
   const walletsInfo = await fetchJettonWallets({
     address: info.address,
     jettonMaster: token.contractAddress,
   });
+
   if (walletsInfo.length !== 1) throw new Error("[ton] unexpected api response");
-  const { balance, address: jettonWalletAddress } = walletsInfo[0];
+  const { balance, address: jettonWallet } = walletsInfo[0];
+  const tokenAccountId = encodeTokenAccountId(parentId, token);
   const oldOps = info.initialAccount?.subAccounts?.find(a => a.id === tokenAccountId)?.operations;
   const operations = !oldOps || shouldSyncFromScratch ? ops : mergeOps(oldOps, ops);
   const maybeExistingSubAccount =
@@ -132,7 +136,7 @@ const getSubAccountShape = async (
     type: "TokenAccount",
     id: tokenAccountId,
     parentId,
-    token: { ...token, contractAddress: jettonWalletAddress }, // the contract address is replaced for the jetton wallet address, it will be use for the token transfer
+    token,
     balance: new BigNumber(balance),
     spendableBalance: new BigNumber(balance),
     operations,
@@ -141,6 +145,7 @@ const getSubAccountShape = async (
     creationDate: operations.length > 0 ? operations[operations.length - 1].date : new Date(),
     balanceHistoryCache: emptyHistoryCache, // calculated in the jsHelpers
     swapHistory: [],
+    jettonWallet, // Address of the jetton wallet contract that holds the token balance and handles transfers
   };
 };
 
@@ -150,7 +155,7 @@ async function getSubAccounts(
   newOps: TonOperation[],
   blacklistedTokenIds: string[] = [],
   shouldSyncFromScratch: boolean,
-): Promise<Partial<SubAccount>[]> {
+): Promise<Partial<TonSubAccount>[]> {
   const opsPerToken = newOps.reduce((acc, op) => {
     const { accountId: tokenAccountId } = decodeOperationId(op.id);
     const { token } = decodeTokenAccountId(tokenAccountId);
@@ -159,7 +164,7 @@ async function getSubAccounts(
     acc.get(token)?.push(op);
     return acc;
   }, new Map<TokenCurrency, TonOperation[]>());
-  const subAccountsPromises: Promise<Partial<SubAccount>>[] = [];
+  const subAccountsPromises: Promise<Partial<TonSubAccount>>[] = [];
   for (const [token, ops] of opsPerToken.entries()) {
     subAccountsPromises.push(
       getSubAccountShape(info, accountId, token, ops, shouldSyncFromScratch),
@@ -168,7 +173,7 @@ async function getSubAccounts(
   return Promise.all(subAccountsPromises);
 }
 
-const postSync = (initial: Account, synced: Account): Account => {
+const postSync = (initial: TonAccount, synced: TonAccount): TonAccount => {
   // Set of ids from the already existing subAccount from previous sync
   const initialSubAccountsIds = new Set();
   for (const subAccount of initial.subAccounts || []) {
@@ -206,7 +211,7 @@ const postSync = (initial: Account, synced: Account): Account => {
   };
 };
 
-function reconciliatePubkey(publicKey?: string, initialAccount?: Account): string {
+function reconciliatePubkey(publicKey?: string, initialAccount?: TonAccount): string {
   if (publicKey?.length === 64) return publicKey;
   if (initialAccount) {
     if (initialAccount.xpub?.length === 64) return initialAccount.xpub;

package/src/types.ts

@@ -1,5 +1,7 @@
 import {
+  Account,
   Operation,
+  TokenAccount,
   TransactionCommon,
   TransactionCommonRaw,
   TransactionStatusCommon,
@@ -43,6 +45,10 @@ export type TonPayloadJettonTransfer = {
   customPayload: TonCell | null;
   forwardAmount: bigint;
   forwardPayload: TonCell | null;
+  knownJetton: {
+    jettonId: number;
+    workchain: number;
+  } | null;
 };
 
 export type TonPayloadNftTransfer = {
@@ -60,7 +66,91 @@ export type TonPayloadComment = {
   text: string;
 };
 
-export type TonPayloadFormat = TonPayloadComment | TonPayloadJettonTransfer | TonPayloadNftTransfer;
+export type TonPayloadUnsafe = {
+  type: "unsafe";
+  message: TonCell;
+};
+
+export type TonPayloadJettonBurn = {
+  type: "jetton-burn";
+  queryId: bigint | null;
+  amount: bigint;
+  responseDestination: Address;
+  customPayload: TonCell | Buffer | null;
+};
+
+export type TonPayloadAddWhitelist = {
+  type: "add-whitelist";
+  queryId: bigint | null;
+  address: Address;
+};
+
+export type TonPayloadSingleNominatorWithdraw = {
+  type: "single-nominator-withdraw";
+  queryId: bigint | null;
+  amount: bigint;
+};
+
+export type TonPayloadSingleNominatorChangeValidator = {
+  type: "single-nominator-change-validator";
+  queryId: bigint | null;
+  address: Address;
+};
+
+export type TonPayloadTonStakersDeposit = {
+  type: "tonstakers-deposit";
+  queryId: bigint | null;
+  appId: bigint | null;
+};
+
+export type TonPayloadVoteForProposal = {
+  type: "vote-for-proposal";
+  queryId: bigint | null;
+  votingAddress: Address;
+  expirationDate: number;
+  vote: boolean;
+  needConfirmation: boolean;
+};
+
+export type TonPayloadChangeDnsRecord = {
+  type: "change-dns-record";
+  queryId: bigint | null;
+  record:
+    | {
+        type: "wallet";
+        value: {
+          address: Address;
+          capabilities: {
+            isWallet: boolean;
+          } | null;
+        } | null;
+      }
+    | {
+        type: "unknown";
+        key: Buffer;
+        value: TonCell | null;
+      };
+};
+
+export type TonPayloadTokenBridgePaySwap = {
+  type: "token-bridge-pay-swap";
+  queryId: bigint | null;
+  swapId: Buffer;
+};
+
+export type TonPayloadFormat =
+  | TonPayloadComment
+  | TonPayloadJettonTransfer
+  | TonPayloadNftTransfer
+  | TonPayloadUnsafe
+  | TonPayloadJettonBurn
+  | TonPayloadAddWhitelist
+  | TonPayloadSingleNominatorWithdraw
+  | TonPayloadSingleNominatorChangeValidator
+  | TonPayloadTonStakersDeposit
+  | TonPayloadVoteForProposal
+  | TonPayloadChangeDnsRecord
+  | TonPayloadTokenBridgePaySwap;
 
 export interface TonTransaction {
   to: Address;
@@ -80,3 +170,15 @@ export type TonOperationExtra = {
   lt: string;
   explorerHash: string;
 };
+
+export type KnownJetton = {
+  symbol: string;
+  masterAddress: Address;
+};
+
+export type TonSubAccount = TokenAccount & {
+  jettonWallet: string;
+};
+export type TonAccount = Omit<Account, "subAccounts"> & {
+  subAccounts?: TonSubAccount[];
+};