@ledgerhq/coin-tezos 0.4.0-nightly.0

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";
+}