@ledgerhq/types-live 6.22.0

package/src/portfolio.ts

@@ -0,0 +1,118 @@
+import type { BigNumber } from "bignumber.js";
+import type { AccountLike, AccountLikeArray } from "./account";
+import type {
+  CryptoCurrency,
+  TokenCurrency,
+} from "@ledgerhq/types-cryptoassets";
+
+/**
+ *
+ */
+export type BalanceHistoryData = {
+  date: Date;
+  value: BigNumber;
+};
+/**
+ *
+ */
+export type BalanceHistory = BalanceHistoryData[];
+/**
+ *
+ */
+export type BalanceHistoryRaw = Array<[string, string]>;
+
+/**
+ *
+ */
+export type BalanceHistoryWithCountervalue = Array<{
+  date: Date;
+  value: BigNumber;
+  countervalue: BigNumber;
+}>;
+
+/**
+ *
+ */
+export type ValueChange = {
+  percentage: BigNumber | null | undefined;
+  // value from 0 to 1. not defined if not meaningful
+  value: BigNumber; // delta of change
+};
+
+/**
+ *
+ */
+export type AccountPortfolio = {
+  history: BalanceHistoryWithCountervalue;
+  countervalueAvailable: boolean;
+  countervalueReceiveSum: BigNumber;
+  countervalueSendSum: BigNumber;
+  cryptoChange: ValueChange;
+  // how much the account changes. value is in the account currency
+  countervalueChange: ValueChange; // calculates the ROI. value in the countervalue unit.
+};
+
+/**
+ *
+ */
+export type CurrencyPortfolio = {
+  history: BalanceHistoryWithCountervalue;
+  countervalueAvailable: boolean;
+  histories: BalanceHistoryWithCountervalue[];
+  accounts: AccountLikeArray;
+  cryptoChange: ValueChange;
+  // how much the account changes. value is in the account currency
+  countervalueChange: ValueChange; // calculates the ROI. value in the countervalue unit.
+};
+
+/**
+ *
+ */
+export type Portfolio = {
+  balanceHistory: BalanceHistory;
+  balanceAvailable: boolean;
+  availableAccounts: AccountLike[];
+  unavailableCurrencies: (CryptoCurrency | TokenCurrency)[];
+  accounts: AccountLike[];
+  range: PortfolioRange;
+  histories: BalanceHistoryWithCountervalue[];
+  countervalueReceiveSum: BigNumber;
+  countervalueSendSum: BigNumber;
+  countervalueChange: ValueChange; // calculates the ROI. value in the countervalue unit.
+};
+
+/**
+ *
+ */
+export type PortfolioRangeConfig = {
+  count: number;
+  granularityId: "HOUR" | "DAY" | "WEEK";
+  // only supported here atm
+  startOf: (arg0: Date) => Date;
+  increment: number;
+};
+
+/**
+ *
+ */
+export type PortfolioRange = "year" | "month" | "week" | "day";
+
+/**
+ *
+ */
+export type AssetsDistribution = {
+  // false if no distribution can be done (sum is zero)
+  isAvailable: boolean;
+  // a sorted list of assets with data
+  list: Array<{
+    currency: CryptoCurrency | TokenCurrency;
+    distribution: number;
+    // % of the total (normalized in 0-1)
+    amount: BigNumber;
+    countervalue: BigNumber; // countervalue of the amount that was calculated based of the rate provided
+  }>;
+  // number of accounts to show first (before the see all)
+  showFirst: number;
+  // sum of all countervalues
+  sum: BigNumber;
+};

package/src/swap.ts

@@ -0,0 +1,29 @@
+import { BigNumber } from "bignumber.js";
+
+/**
+ *
+ */
+export type SwapOperation = {
+  provider: string;
+  swapId: string;
+  status: string;
+  receiverAccountId: string;
+  tokenId?: string;
+  operationId: string;
+  fromAmount: BigNumber;
+  toAmount: BigNumber;
+};
+
+/**
+ *
+ */
+export type SwapOperationRaw = {
+  provider: string;
+  swapId: string;
+  status: string;
+  receiverAccountId: string;
+  tokenId?: string;
+  operationId: string;
+  fromAmount: string;
+  toAmount: string;
+};

package/src/transaction.ts

@@ -0,0 +1,188 @@
+import type { BigNumber } from "bignumber.js";
+import type { Operation, OperationRaw } from "./operation";
+import type { Unit } from "@ledgerhq/types-cryptoassets";
+
+/**
+ *
+ */
+export type BitcoinInput = {
+  address: string | null | undefined;
+  value: BigNumber | null | undefined;
+  previousTxHash: string | null | undefined;
+  previousOutputIndex: number;
+};
+
+/**
+ *
+ */
+export type BitcoinInputRaw = [
+  string | null | undefined,
+  string | null | undefined,
+  string | null | undefined,
+  number
+];
+
+/**
+ *
+ */
+export type BitcoinOutput = {
+  hash: string;
+  outputIndex: number;
+  blockHeight: number | null | undefined;
+  address: string | null | undefined;
+  path: string | null | undefined; // DEPRECATED - used only by legacy libcore implementation
+  value: BigNumber;
+  rbf: boolean;
+  isChange: boolean;
+};
+
+/**
+ *
+ */
+export type BitcoinOutputRaw = [
+  string,
+  number,
+  number | null | undefined,
+  string | null | undefined,
+  string | null | undefined,
+  string,
+  number, // rbf 0/1 for compression
+  number
+];
+
+/**
+ *
+ */
+export type SignedOperation = {
+  // prepared version of Operation before it's even broadcasted
+  // .id/.hash is potentially not settled yet
+  operation: Operation;
+  // usually the device signature hex OR anything that is needed to broadcast (can be an inline JSON)
+  signature: string;
+  // sometimes a coin needs the raw object (it must be serializable)
+  signatureRaw?: Record<string, any>;
+  // date calculated as expiring
+  expirationDate: Date | null | undefined;
+};
+
+/**
+ *
+ */
+export type SignedOperationRaw = {
+  operation: OperationRaw;
+  signature: string;
+  signatureRaw?: Record<string, any>;
+  expirationDate: string | null | undefined;
+};
+
+/**
+ *
+ */
+export type SignOperationEvent = // Used when lot of exchange is needed with the device to visually express a progress
+  // It can be used before and/or after the signature
+  // only used if it can takes >1s to show a visual progress to user (typically UTXO streaming)
+  | {
+      type: "device-streaming";
+      progress: number;
+      index: number;
+      total: number;
+    } // optional
+  // REQUIRED Indicates that a signature is now appearing and awaited on the device to confirm
+  | {
+      type: "device-signature-requested";
+    } // REQUIRED Indicates user have confirmed the transaction
+  | {
+      type: "device-signature-granted";
+    } // REQUIRED payload of the resulting signed operation
+  | {
+      type: "signed";
+      signedOperation: SignedOperation;
+    };
+
+/**
+ *
+ */
+export type SignOperationEventRaw =
+  | {
+      type: "device-streaming";
+      progress: number;
+      index: number;
+      total: number;
+    }
+  | {
+      type: "device-signature-requested";
+    }
+  | {
+      type: "device-signature-granted";
+    }
+  | {
+      type: "signed";
+      signedOperation: SignedOperationRaw;
+    };
+/**
+ * Transaction is a generic object that holds all state for all transactions
+ * there are generic fields and coin specific fields. That's why almost all fields are optionals
+ */
+export type TransactionCommon = {
+  amount: BigNumber;
+  recipient: string;
+  useAllAmount?: boolean;
+  subAccountId?: string | null | undefined;
+  feesStrategy?: "slow" | "medium" | "fast" | "custom" | null;
+};
+
+/**
+ *
+ */
+export type TransactionCommonRaw = {
+  amount: string;
+  recipient: string;
+  useAllAmount?: boolean;
+  subAccountId?: string | null | undefined;
+  feesStrategy?: "slow" | "medium" | "fast" | "custom" | null;
+};
+
+/**
+ * User can have 3 differents choice for their fee
+ * Most of the time mid is low * 1.25 and high is low * 1.5
+ * They are some exception as eth that got his own meter
+ */
+export type FeeStrategy = {
+  amount: BigNumber;
+  displayedAmount?: BigNumber;
+  label: string;
+  unit?: Unit;
+};
+/**
+ * TransactionStatus is a view of Transaction with general info to be used on the UI and status info.
+ */
+export type TransactionStatus = {
+  // potential error for each (user) field of the transaction
+  errors: Record<string, Error>;
+  // potential warning for each (user) field for a transaction
+  warnings: Record<string, Error>;
+  // estimated total fees the tx is going to cost. (in the mainAccount currency)
+  estimatedFees: BigNumber;
+  // actual amount that the recipient will receive (in account currency)
+  amount: BigNumber;
+  // total amount that the sender will spend (in account currency)
+  totalSpent: BigNumber;
+  // should the recipient be non editable
+  recipientIsReadOnly?: boolean;
+  txInputs?: BitcoinInput[];
+  txOutputs?: BitcoinOutput[];
+};
+/**
+ *
+ */
+export type TransactionStatusRaw = {
+  errors: Record<string, string>;
+  warnings: Record<string, string>;
+  estimatedFees: string;
+  amount: string;
+  totalSpent: string;
+  useAllAmount?: boolean;
+  recipientIsReadOnly?: boolean;
+  txInputs?: BitcoinInputRaw[];
+  txOutputs?: BitcoinOutputRaw[];
+};

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "lib"
+  },
+  "include": ["src/**/*"]
+}