@ledgerhq/coin-tezos 0.4.0-next.0

package/src/test/cli.ts

@@ -0,0 +1,137 @@
+import { from, Observable } from "rxjs";
+import { map } from "rxjs/operators";
+import invariant from "invariant";
+import { BigNumber } from "bignumber.js";
+import flatMap from "lodash/flatMap";
+import type { Account, AccountLike, AccountLikeArray, SubAccount } from "@ledgerhq/types-live";
+import type { Transaction, Baker } from "../types";
+import { listBakers, fetchAllBakers } from "../api/bakers";
+import defaultList from "../api/bakers.whitelist-default";
+
+const options = [
+  {
+    name: "mode",
+    type: String,
+    desc: "mode of transaction",
+  },
+  {
+    name: "storageLimit",
+    type: String,
+    desc: "how much storageLimit. default is estimated with the recipient",
+  },
+  {
+    name: "subAccount",
+    type: String,
+    desc: "use a sub account instead of the parent by index",
+    multiple: true,
+  },
+  {
+    name: "fees",
+    type: String,
+    desc: "how much fees",
+  },
+  {
+    name: "gasLimit",
+    type: String,
+    desc: "how much gasLimit. default is estimated with the recipient",
+  },
+];
+
+function inferAccounts(account: Account, opts: Record<string, any>): AccountLikeArray {
+  invariant(account.currency.family === "tezos", "tezos family");
+
+  if (!opts.subAccount) {
+    const accounts: Account[] = [account];
+    return accounts;
+  }
+
+  const { subAccounts } = account;
+  invariant(subAccounts, "no sub accounts");
+  return opts.subAccount.map((i: number) => {
+    const acc = (subAccounts as SubAccount[])[i];
+    invariant(acc, "sub account not found (index %s)", i);
+    return acc;
+  });
+}
+
+function inferTransactions(
+  transactions: Array<{
+    account: AccountLike;
+    transaction: Transaction;
+  }>,
+  opts: Record<string, any>,
+  { inferAmount }: any,
+): Transaction[] {
+  return flatMap(transactions, ({ transaction, account }) => {
+    invariant(transaction.family === "tezos", "tezos family");
+    let subAccountId;
+
+    return {
+      ...transaction,
+      mode: opts.mode || "send",
+      subAccountId,
+      fees: opts.fees ? inferAmount(account, opts.fees) : null,
+      gasLimit: opts.gasLimit ? new BigNumber(opts.gasLimit) : null,
+      storageLimit: opts.storageLimit ? new BigNumber(opts.storageLimit) : null,
+    };
+  });
+}
+
+const bakersFormatters = {
+  json: (list: Baker[]) => JSON.stringify(list),
+  default: (list: Baker[]) =>
+    list
+      .map(b => `${b.address} "${b.name}" ${b.nominalYield} ${b.capacityStatus} ${b.logoURL}`)
+      .join("\n"),
+};
+const tezosListBakers = {
+  args: [
+    {
+      name: "whitelist",
+      desc: "filter whitelist",
+      type: Boolean,
+    },
+    {
+      name: "format",
+      desc: Object.keys(bakersFormatters).join(" | "),
+      type: String,
+    },
+  ],
+  job: ({
+    whitelist,
+    format,
+  }: Partial<{
+    whitelist: boolean;
+    format: "json" | "default";
+  }>): Observable<string> =>
+    from(whitelist ? listBakers(defaultList) : fetchAllBakers()).pipe(
+      map((list: Baker[]) => {
+        const f = (format && bakersFormatters[format]) || bakersFormatters.default;
+        return f(list);
+      }),
+    ),
+};
+
+export type CliTools = {
+  options: typeof options;
+  inferTransactions: (
+    transactions: Array<{
+      account: AccountLike;
+      transaction: Transaction;
+    }>,
+    opts: Record<string, any>,
+    { inferAmount }: any,
+  ) => Transaction[];
+  commands: { tezosListBakers: typeof tezosListBakers };
+};
+
+export default function makeCliTools() {
+  return {
+    options,
+    inferAccounts,
+    inferTransactions,
+    commands: {
+      tezosListBakers,
+    },
+  };
+}

package/src/test/index.ts

@@ -0,0 +1 @@
+export * from "./bridgeDatasetTest";

package/src/types/errors.ts

@@ -0,0 +1,5 @@
+import { createCustomErrorClass } from "@ledgerhq/errors";
+
+export const InvalidAddressBecauseAlreadyDelegated = createCustomErrorClass(
+  "InvalidAddressBecauseAlreadyDelegated",
+);

package/src/types/index.ts

@@ -0,0 +1,3 @@
+export * from "./errors";
+export * from "./model";
+export * from "./signer";

package/src/types/model.fixture.ts

@@ -0,0 +1,89 @@
+import BigNumber from "bignumber.js";
+import { faker } from "@faker-js/faker";
+import type {
+  TezosAccount,
+  TezosOperation,
+  TezosOperationExtra,
+  TezosResources,
+  Transaction,
+} from "./model";
+import { getAbandonSeedAddress } from "@ledgerhq/cryptoassets/abandonseed";
+import { listCryptoCurrencies } from "@ledgerhq/cryptoassets/currencies";
+import { emptyHistoryCache } from "@ledgerhq/coin-framework/account/index";
+
+const currency = listCryptoCurrencies(true).find(c => c.id === "tezos")!;
+
+export function createFixtureAccount(account?: Partial<TezosAccount>): TezosAccount {
+  const tezosResources: TezosResources = account?.tezosResources || {
+    revealed: account?.tezosResources?.revealed || true,
+    counter: account?.tezosResources?.counter || faker.number.int(),
+  };
+
+  const freshAddress = {
+    // Value coming from taquito.io documentation
+    address: "tz1VSUr8wwNhLAzempoch5d6hLRiTh8Cjcjb",
+    derivationPath: "derivation_path",
+  };
+
+  return {
+    type: "Account",
+    id: faker.string.uuid(),
+    seedIdentifier: faker.string.uuid(),
+    derivationMode: "",
+    index: faker.number.int(),
+    freshAddress: account?.freshAddress || freshAddress.address,
+    freshAddressPath: freshAddress.derivationPath,
+    used: true,
+    balance: account?.balance || new BigNumber(0),
+    spendableBalance: account?.spendableBalance || new BigNumber(0),
+    creationDate: faker.date.past(),
+    blockHeight: faker.number.int({ min: 100_000, max: 200_000 }),
+    currency,
+    operationsCount: account?.operationsCount || 0,
+    operations: account?.operations || [],
+    pendingOperations: account?.pendingOperations || [],
+    lastSyncDate: new Date(),
+    balanceHistoryCache: emptyHistoryCache,
+    swapHistory: [],
+
+    tezosResources,
+  };
+}
+
+export function createFixtureTransaction(tx?: Partial<Transaction>): Transaction {
+  return {
+    amount: tx?.amount || new BigNumber(0),
+    recipient: tx?.recipient || getAbandonSeedAddress("tezos"),
+
+    family: "tezos",
+    mode: tx?.mode || "send",
+    networkInfo: tx?.networkInfo || undefined,
+    fees: tx?.fees || undefined,
+    gasLimit: tx?.gasLimit || undefined,
+    storageLimit: tx?.storageLimit || undefined,
+    estimatedFees: tx?.estimatedFees || undefined,
+    taquitoError: tx?.taquitoError || undefined,
+  };
+}
+
+export function createFixtureOperation(operation?: Partial<TezosOperation>): TezosOperation {
+  const extra: TezosOperationExtra = {
+    id: operation?.extra?.id || 0,
+  };
+
+  return {
+    id: operation?.id || faker.string.uuid(),
+    hash: operation?.hash || faker.string.uuid(),
+    type: operation?.type || "ACTIVATE",
+    value: operation?.value || new BigNumber(faker.string.numeric()),
+    fee: operation?.fee || new BigNumber(0),
+    // senders & recipients addresses
+    senders: operation?.senders || [],
+    recipients: operation?.recipients || [],
+    blockHeight: operation?.blockHeight || undefined,
+    blockHash: operation?.blockHash || undefined,
+    accountId: operation?.accountId || faker.string.uuid(),
+    date: operation?.date || faker.date.past(),
+    extra,
+  };
+}

package/src/types/model.ts

@@ -0,0 +1,123 @@
+import type {
+  Account,
+  AccountRaw,
+  Operation,
+  TransactionCommon,
+  TransactionCommonRaw,
+  TransactionStatusCommon,
+  TransactionStatusCommonRaw,
+} from "@ledgerhq/types-live";
+import type { BigNumber } from "bignumber.js";
+
+export type TezosResources = {
+  revealed: boolean;
+  counter: number;
+};
+
+export type TezosResourcesRaw = {
+  revealed: boolean;
+  counter: number;
+};
+
+export type TezosOperationMode = "send" | "delegate" | "undelegate";
+
+export type NetworkInfo = {
+  family: "tezos";
+  fees: BigNumber;
+};
+
+export type NetworkInfoRaw = {
+  family: "tezos";
+  fees: string;
+};
+
+// TODO add a field for indicating if staking
+export type Transaction = TransactionCommon & {
+  family: "tezos";
+  mode: TezosOperationMode;
+  networkInfo: NetworkInfo | null | undefined;
+  fees: BigNumber | null | undefined;
+  gasLimit: BigNumber | null | undefined;
+  storageLimit: BigNumber | null | undefined;
+  estimatedFees: BigNumber | null | undefined;
+  taquitoError: string | null | undefined;
+};
+
+export type TransactionRaw = TransactionCommonRaw & {
+  family: "tezos";
+  mode: TezosOperationMode;
+  networkInfo: NetworkInfoRaw | null | undefined;
+  fees: string | null | undefined;
+  gasLimit: string | null | undefined;
+  storageLimit: string | null | undefined;
+  estimatedFees: string | null | undefined;
+  taquitoError: string | null | undefined;
+};
+
+type CapacityStatus = "normal" | "full";
+
+export type Baker = {
+  address: string;
+  name: string;
+  logoURL: string;
+  nominalYield: `${number} %`;
+  capacityStatus: CapacityStatus;
+};
+
+// type used by UI to facilitate business logic of current delegation data
+export type Delegation = {
+  // delegator address
+  address: string;
+  // if not defined, we need to render "Unknown" on the UI. we don't know who is delegator.
+  baker: Baker | null | undefined;
+  // operation related to delegation (to know the date info)
+  operation: Operation;
+  // true if the delegation is pending (optimistic update)
+  isPending: boolean;
+  // true if a receive should inform it will top up the delegation
+  receiveShouldWarnDelegation: boolean;
+  // true if a send should inform it will top down the delegation
+  sendShouldWarnDelegation: boolean;
+};
+
+export type API_BAKER = {
+  address: string;
+  name: string;
+  logo: string;
+  balance: number;
+  stakingBalance: number;
+  stakingCapacity: number;
+  maxStakingBalance: number;
+  freeSpace: number;
+  fee: number;
+  minDelegation: number;
+  payoutDelay: number;
+  payoutPeriod: number;
+  openForDelegation: true;
+  estimatedRoi: number;
+  serviceType: string;
+  serviceHealth: string;
+  payoutTiming: string;
+  payoutAccuracy: string;
+  audit?: string;
+  insuranceCoverage: number;
+};
+
+export type TezosAccount = Account & { tezosResources: TezosResources };
+export function isTezosAccount(account: Account): account is TezosAccount {
+  return "tezosResources" in account;
+}
+
+export type TezosAccountRaw = AccountRaw & {
+  tezosResources: TezosResourcesRaw;
+};
+
+export type TransactionStatus = TransactionStatusCommon;
+
+export type TransactionStatusRaw = TransactionStatusCommonRaw;
+
+export type TezosOperation = Operation<TezosOperationExtra>;
+
+export type TezosOperationExtra = {
+  id?: number; // Used as most recent operation id for incremental sync
+};

package/src/types/signer.ts

@@ -0,0 +1,48 @@
+export type TezosAddress = {
+  address: string;
+  publicKey: string;
+};
+export type TezosSignature = {
+  signature: string;
+};
+// Type coming from hw-app-tezos
+type TezosCurves = {
+  ED25519: 0x00;
+  SECP256K1: 0x01;
+  SECP256R1: 0x02;
+};
+export type Curve = TezosCurves[keyof TezosCurves];
+
+export type LedgerSigner = {
+  publicKey(): Promise<string>;
+  publicKeyHash(): Promise<string>;
+  sign(
+    bytes: string,
+    watermark?: Uint8Array,
+  ): Promise<{
+    bytes: string;
+    sig: string;
+    prefixSig: string;
+    sbytes: string;
+  }>;
+  secretKey(): Promise<string | undefined>;
+};
+export interface TezosSigner {
+  getAddress(
+    path: string,
+    options: {
+      verify?: boolean;
+      curve?: Curve;
+      ins?: number;
+    },
+  ): Promise<TezosAddress>;
+  signOperation(
+    path: string,
+    rawTxHex: string,
+    options: {
+      curve?: Curve;
+    },
+  ): Promise<TezosSignature>;
+  // Tezos [LedgerSigner](https://www.npmjs.com/package/@taquito/ledger-signer)
+  createLedgerSigner(path: string, prompt: boolean, derivationType: number): LedgerSigner;
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../../../tsconfig.base",
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "module": "commonjs",
+    "downlevelIteration": true,
+    "lib": ["es2020", "dom"],
+    "outDir": "lib",
+    "typeRoots": ["./node_modules/@types", "./types/@taquito"]
+  },
+  "include": ["src/**/*"]
+}

package/types/@taquito/ledger-signer/index.d.ts

@@ -0,0 +1,3 @@
+declare module "@taquito/ledger-signer/dist/lib/utils" {
+  export * from "@taquito/ledger-signer/dist/types/utils";
+}