@ledgerhq/live-common 21.20.0 → 21.21.0-rc.2

package/src/families/solana/transaction.ts

@@ -0,0 +1,146 @@
+import { BigNumber } from "bignumber.js";
+import type {
+  Command,
+  TokenCreateATACommand,
+  TokenTransferCommand,
+  Transaction,
+  TransactionRaw,
+  TransferCommand,
+} from "./types";
+import {
+  fromTransactionCommonRaw,
+  toTransactionCommonRaw,
+} from "../../transaction/common";
+import type { Account } from "../../types";
+import { findSubAccountById, getAccountUnit } from "../../account";
+import { formatCurrencyUnit, getTokenById } from "../../currencies";
+import { assertUnreachable } from "./utils";
+import { toTokenId } from "./logic";
+
+export const fromTransactionRaw = (tr: TransactionRaw): Transaction => {
+  const common = fromTransactionCommonRaw(tr);
+  const { family, model, feeCalculator } = tr;
+  return {
+    ...common,
+    family,
+    model: JSON.parse(model),
+    feeCalculator,
+  };
+};
+
+export const toTransactionRaw = (t: Transaction): TransactionRaw => {
+  const common = toTransactionCommonRaw(t);
+  const { family, model, feeCalculator } = t;
+  return {
+    ...common,
+    family,
+    model: JSON.stringify(model),
+    feeCalculator,
+  };
+};
+
+const lamportsToSOL = (account: Account, amount: number) => {
+  return formatCurrencyUnit(getAccountUnit(account), new BigNumber(amount), {
+    showCode: true,
+    disableRounding: true,
+  });
+};
+
+export const formatTransaction = (
+  tx: Transaction,
+  mainAccount: Account
+): string => {
+  if (tx.model.commandDescriptor === undefined) {
+    throw new Error("can not format unprepared transaction");
+  }
+  const { commandDescriptor } = tx.model;
+  switch (commandDescriptor.status) {
+    case "valid":
+      return formatCommand(mainAccount, tx, commandDescriptor.command);
+    case "invalid":
+      throw new Error("can not format invalid transaction");
+    default:
+      return assertUnreachable(commandDescriptor);
+  }
+};
+
+function formatCommand(
+  mainAccount: Account,
+  tx: Transaction,
+  command: Command
+) {
+  switch (command.kind) {
+    case "transfer":
+      return formatTransfer(mainAccount, tx, command);
+    case "token.transfer":
+      return formatTokenTransfer(mainAccount, tx, command);
+    case "token.createATA":
+      return formatCreateATA(mainAccount, tx, command);
+    default:
+      return assertUnreachable(command);
+  }
+}
+
+function formatTransfer(
+  mainAccount: Account,
+  tx: Transaction,
+  command: TransferCommand
+) {
+  const amount = lamportsToSOL(mainAccount, command.amount);
+  const str = [
+    `  SEND: ${amount}${tx.useAllAmount ? " (ALL)" : ""}`,
+    `  TO: ${command.recipient}`,
+    command.memo ? `  MEMO: ${command.memo}` : "",
+  ]
+    .filter(Boolean)
+    .join("\n");
+
+  return "\n" + str;
+}
+
+function formatTokenTransfer(
+  mainAccount: Account,
+  tx: Transaction,
+  command: TokenTransferCommand
+) {
+  if (!tx.subAccountId) {
+    throw new Error("expected subaccountId on transaction");
+  }
+  const subAccount = findSubAccountById(mainAccount, tx.subAccountId);
+  if (!subAccount || subAccount.type !== "TokenAccount") {
+    throw new Error("token subaccount expected");
+  }
+  const amount = formatCurrencyUnit(
+    getAccountUnit(subAccount),
+    new BigNumber(command.amount),
+    {
+      showCode: true,
+      disableRounding: true,
+    }
+  );
+  const recipient = command.recipientDescriptor.walletAddress;
+  const str = [
+    `  SEND: ${amount}${tx.useAllAmount ? " (ALL)" : ""}`,
+    `  TO: ${recipient}`,
+    command.memo ? `  MEMO: ${command.memo}` : "",
+  ]
+    .filter(Boolean)
+    .join("\n");
+  return "\n" + str;
+}
+
+function formatCreateATA(
+  mainAccount: Account,
+  tx: Transaction,
+  command: TokenCreateATACommand
+) {
+  const token = getTokenById(toTokenId(command.mint));
+  const str = [`  OPT IN TOKEN: ${token.ticker}`].filter(Boolean).join("\n");
+  return "\n" + str;
+}
+
+export default {
+  formatTransaction,
+  fromTransactionRaw,
+  toTransactionRaw,
+};

package/src/families/solana/types.ts

@@ -0,0 +1,110 @@
+import type {
+  TransactionCommon,
+  TransactionCommonRaw,
+} from "../../types/transaction";
+
+// for legacy reasons export the types
+export type CoreStatics = Record<string, never>;
+export type CoreAccountSpecifics = Record<string, never>;
+export type CoreOperationSpecifics = Record<string, never>;
+export type CoreCurrencySpecifics = Record<string, never>;
+
+export type TransferCommand = {
+  kind: "transfer";
+  sender: string;
+  recipient: string;
+  amount: number;
+  memo?: string;
+};
+
+export type TokenCreateATACommand = {
+  kind: "token.createATA";
+  owner: string;
+  mint: string;
+  associatedTokenAccountAddress: string;
+};
+
+export type TokenRecipientDescriptor = {
+  walletAddress: string;
+  tokenAccAddress: string;
+  shouldCreateAsAssociatedTokenAccount: boolean;
+};
+
+export type TokenTransferCommand = {
+  kind: "token.transfer";
+  ownerAddress: string;
+  ownerAssociatedTokenAccountAddress: string;
+  recipientDescriptor: TokenRecipientDescriptor;
+  amount: number;
+  mintAddress: string;
+  mintDecimals: number;
+  memo?: string;
+};
+
+export type Command =
+  | TransferCommand
+  | TokenTransferCommand
+  | TokenCreateATACommand;
+
+export type ValidCommandDescriptor = {
+  status: "valid";
+  command: Command;
+  fees?: number;
+  warnings?: Record<string, Error>;
+};
+
+export type InvalidCommandDescriptor = {
+  status: "invalid";
+  errors: Record<string, Error>;
+  warnings?: Record<string, Error>;
+};
+
+export type CommandDescriptor<> =
+  | ValidCommandDescriptor
+  | InvalidCommandDescriptor;
+
+export type TransferTransaction = {
+  kind: "transfer";
+  uiState: {
+    memo?: string;
+  };
+};
+
+export type TokenTransferTransaction = {
+  kind: "token.transfer";
+  uiState: {
+    subAccountId: string;
+    memo?: string;
+  };
+};
+
+export type TokenCreateATATransaction = {
+  kind: "token.createATA";
+  uiState: {
+    tokenId: string;
+  };
+};
+
+export type TransactionModel = { commandDescriptor?: CommandDescriptor } & (
+  | TransferTransaction
+  | TokenTransferTransaction
+  | TokenCreateATATransaction
+);
+
+export type Transaction = TransactionCommon & {
+  family: "solana";
+  model: TransactionModel;
+  feeCalculator?: {
+    lamportsPerSignature: number;
+  };
+};
+
+export type TransactionRaw = TransactionCommonRaw & {
+  family: "solana";
+  model: string;
+  feeCalculator?: {
+    lamportsPerSignature: number;
+  };
+};
+
+export const reflect = (_declare: unknown): void => {};

package/src/families/solana/utils.ts

@@ -0,0 +1,80 @@
+import { Cluster } from "@solana/web3.js";
+
+export const assertUnreachable = (_: never): never => {
+  throw new Error("unreachable assertion failed");
+};
+
+export async function drainSeqAsyncGen<T>(
+  ...asyncGens: AsyncGenerator<T>[]
+): Promise<T[]> {
+  const items: T[] = [];
+  for (const gen of asyncGens) {
+    for await (const item of gen) {
+      items.push(item);
+    }
+  }
+  return items;
+}
+
+export function clusterByCurrencyId(currencyId: string): Cluster {
+  const clusters: Record<string, Cluster> = {
+    solana: "mainnet-beta",
+    solana_devnet: "devnet",
+    solana_testnet: "testnet",
+  };
+
+  if (currencyId in clusters) {
+    return clusters[currencyId];
+  }
+
+  throw Error(
+    `unexpected currency id format <${currencyId}>, should be like solana[_(testnet | devnet)]`
+  );
+}
+
+type AsyncQueueEntry<T> = {
+  lazyPromise: () => Promise<T>;
+  resolve: (value: T) => void;
+  reject: (reason?: any) => void;
+};
+
+export function asyncQueue(config: { delayBetweenRuns: number }): {
+  submit: <T>(fn: () => Promise<T>) => Promise<T>;
+} {
+  const { delayBetweenRuns } = config;
+  const q: AsyncQueueEntry<any>[] = [];
+
+  const drain = async () => {
+    if (q.length > 0) {
+      const { lazyPromise, resolve, reject } = q[q.length - 1];
+      try {
+        resolve(await lazyPromise());
+      } catch (e) {
+        reject(e);
+      } finally {
+        void setTimeout(() => {
+          q.pop();
+          void drain();
+        }, delayBetweenRuns);
+      }
+    }
+  };
+
+  const submit = <T>(lazyPromise: () => Promise<T>): Promise<T> => {
+    return new Promise((resolve, reject) => {
+      q.unshift({
+        lazyPromise,
+        resolve,
+        reject,
+      });
+
+      if (q.length === 1) {
+        void drain();
+      }
+    });
+  };
+
+  return {
+    submit,
+  };
+}

package/src/generated/bridge/js.ts

@@ -14,6 +14,8 @@ import polkadot from "../../families/polkadot/bridge/js";
 
 import ripple from "../../families/ripple/bridge/js";
 
+import solana from "../../families/solana/bridge/js";
+
 import stellar from "../../families/stellar/bridge/js";
 
 import tezos from "../../families/tezos/bridge/js";
@@ -30,6 +32,7 @@ export default {
   neo,
   polkadot,
   ripple,
+  solana,
   stellar,
   tezos,
   tron,

package/src/generated/bridge/mock.ts

@@ -8,6 +8,8 @@ import ethereum from "../../families/ethereum/bridge/mock";
 
 import ripple from "../../families/ripple/bridge/mock";
 
+import solana from "../../families/solana/bridge/mock";
+
 import stellar from "../../families/stellar/bridge/mock";
 
 import tezos from "../../families/tezos/bridge/mock";
@@ -19,6 +21,7 @@ export default {
   cosmos,
   ethereum,
   ripple,
+  solana,
   stellar,
   tezos,
 };

package/src/generated/cli-transaction.ts

@@ -16,6 +16,8 @@ import polkadot from "../families/polkadot/cli-transaction";
 
 import ripple from "../families/ripple/cli-transaction";
 
+import solana from "../families/solana/cli-transaction";
+
 import stellar from "../families/stellar/cli-transaction";
 
 import tezos from "../families/tezos/cli-transaction";
@@ -33,6 +35,7 @@ export default {
   filecoin,
   polkadot,
   ripple,
+  solana,
   stellar,
   tezos,
   tron,

package/src/generated/deviceTransactionConfig.ts

@@ -12,6 +12,8 @@ import polkadot from "../families/polkadot/deviceTransactionConfig";
 
 import ripple from "../families/ripple/deviceTransactionConfig";
 
+import solana from "../families/solana/deviceTransactionConfig";
+
 import stellar from "../families/stellar/deviceTransactionConfig";
 
 import tezos from "../families/tezos/deviceTransactionConfig";
@@ -27,6 +29,7 @@ export default {
   ethereum,
   polkadot,
   ripple,
+  solana,
   stellar,
   tezos,
   tron,

package/src/generated/hw-getAddress.ts

@@ -18,6 +18,8 @@ import polkadot from "../families/polkadot/hw-getAddress";
 
 import ripple from "../families/ripple/hw-getAddress";
 
+import solana from "../families/solana/hw-getAddress";
+
 import stellar from "../families/stellar/hw-getAddress";
 
 import tezos from "../families/tezos/hw-getAddress";
@@ -36,6 +38,7 @@ export default {
   neo,
   polkadot,
   ripple,
+  solana,
   stellar,
   tezos,
   tron,

package/src/generated/specs.ts

@@ -16,6 +16,8 @@ import polkadot from "../families/polkadot/specs";
 
 import ripple from "../families/ripple/specs";
 
+import solana from "../families/solana/specs";
+
 import stellar from "../families/stellar/specs";
 
 import tezos from "../families/tezos/specs";
@@ -33,6 +35,7 @@ export default {
   filecoin,
   polkadot,
   ripple,
+  solana,
   stellar,
   tezos,
   tron,

package/src/generated/speculos-deviceActions.ts

@@ -16,6 +16,8 @@ import polkadot from "../families/polkadot/speculos-deviceActions";
 
 import ripple from "../families/ripple/speculos-deviceActions";
 
+import solana from "../families/solana/speculos-deviceActions";
+
 import stellar from "../families/stellar/speculos-deviceActions";
 
 import tezos from "../families/tezos/speculos-deviceActions";
@@ -33,6 +35,7 @@ export default {
   filecoin,
   polkadot,
   ripple,
+  solana,
   stellar,
   tezos,
   tron,

package/src/generated/test-dataset.ts

@@ -16,6 +16,8 @@ import polkadot from "../families/polkadot/test-dataset";
 
 import ripple from "../families/ripple/test-dataset";
 
+import solana from "../families/solana/test-dataset";
+
 import stellar from "../families/stellar/test-dataset";
 
 import tezos from "../families/tezos/test-dataset";
@@ -33,6 +35,7 @@ export default {
   filecoin,
   polkadot,
   ripple,
+  solana,
   stellar,
   tezos,
   tron,

package/src/generated/transaction.ts

@@ -18,6 +18,8 @@ import polkadot from "../families/polkadot/transaction";
 
 import ripple from "../families/ripple/transaction";
 
+import solana from "../families/solana/transaction";
+
 import stellar from "../families/stellar/transaction";
 
 import tezos from "../families/tezos/transaction";
@@ -36,6 +38,7 @@ export default {
   neo,
   polkadot,
   ripple,
+  solana,
   stellar,
   tezos,
   tron,

package/src/generated/types.ts

@@ -84,6 +84,13 @@ import { Transaction as rippleTransaction } from "../families/ripple/types";
 import { TransactionRaw as rippleTransactionRaw } from "../families/ripple/types";
 import { NetworkInfo as rippleNetworkInfo } from "../families/ripple/types";
 import { NetworkInfoRaw as rippleNetworkInfoRaw } from "../families/ripple/types";
+import { reflect as solanaReflect } from "../families/solana/types";
+import { CoreStatics as CoreStatics_solana } from "../families/solana/types";
+import { CoreAccountSpecifics as CoreAccountSpecifics_solana } from "../families/solana/types";
+import { CoreOperationSpecifics as CoreOperationSpecifics_solana } from "../families/solana/types";
+import { CoreCurrencySpecifics as CoreCurrencySpecifics_solana } from "../families/solana/types";
+import { Transaction as solanaTransaction } from "../families/solana/types";
+import { TransactionRaw as solanaTransactionRaw } from "../families/solana/types";
 import { reflect as stellarReflect } from "../families/stellar/types";
 import { CoreStatics as CoreStatics_stellar } from "../families/stellar/types";
 import { CoreAccountSpecifics as CoreAccountSpecifics_stellar } from "../families/stellar/types";
@@ -123,6 +130,7 @@ export type SpecificStatics = {}
 & CoreStatics_neo
 & CoreStatics_polkadot
 & CoreStatics_ripple
+& CoreStatics_solana
 & CoreStatics_stellar
 & CoreStatics_tezos
 & CoreStatics_tron
@@ -137,6 +145,7 @@ export type CoreAccountSpecifics = {}
 & CoreAccountSpecifics_neo
 & CoreAccountSpecifics_polkadot
 & CoreAccountSpecifics_ripple
+& CoreAccountSpecifics_solana
 & CoreAccountSpecifics_stellar
 & CoreAccountSpecifics_tezos
 & CoreAccountSpecifics_tron
@@ -151,6 +160,7 @@ export type CoreOperationSpecifics = {}
 & CoreOperationSpecifics_neo
 & CoreOperationSpecifics_polkadot
 & CoreOperationSpecifics_ripple
+& CoreOperationSpecifics_solana
 & CoreOperationSpecifics_stellar
 & CoreOperationSpecifics_tezos
 & CoreOperationSpecifics_tron
@@ -165,6 +175,7 @@ export type CoreCurrencySpecifics = {}
 & CoreCurrencySpecifics_neo
 & CoreCurrencySpecifics_polkadot
 & CoreCurrencySpecifics_ripple
+& CoreCurrencySpecifics_solana
 & CoreCurrencySpecifics_stellar
 & CoreCurrencySpecifics_tezos
 & CoreCurrencySpecifics_tron
@@ -179,6 +190,7 @@ export type Transaction =
   | neoTransaction
   | polkadotTransaction
   | rippleTransaction
+  | solanaTransaction
   | stellarTransaction
   | tezosTransaction
   | tronTransaction
@@ -193,6 +205,7 @@ export type TransactionRaw =
   | neoTransactionRaw
   | polkadotTransactionRaw
   | rippleTransactionRaw
+  | solanaTransactionRaw
   | stellarTransactionRaw
   | tezosTransactionRaw
   | tronTransactionRaw
@@ -231,6 +244,7 @@ export const reflectSpecifics = (declare: any): Array<{ OperationMethods: Record
   neoReflect(declare),
   polkadotReflect(declare),
   rippleReflect(declare),
+  solanaReflect(declare),
   stellarReflect(declare),
   tezosReflect(declare),
   tronReflect(declare),

package/src/nft/helpers.ts

@@ -45,7 +45,7 @@ export const nftsFromOperations = (ops: Operation[]): NFT[] => {
       return acc;
     }, {});
 
-  return Object.values(nftsMap).filter((n) => n.amount.gt(0));
+  return Object.values(nftsMap);
 };
 
 export const nftsByCollections = (