@ledgerhq/coin-stellar 0.2.0-next.0

package/src/transaction.ts

@@ -0,0 +1,99 @@
+import { BigNumber } from "bignumber.js";
+import { formatTransactionStatus } from "@ledgerhq/coin-framework/formatters";
+import {
+  fromTransactionCommonRaw,
+  fromTransactionStatusRawCommon as fromTransactionStatusRaw,
+  toTransactionCommonRaw,
+  toTransactionStatusRawCommon as toTransactionStatusRaw,
+} from "@ledgerhq/coin-framework/serialization";
+import type { Account } from "@ledgerhq/types-live";
+import { formatCurrencyUnit } from "@ledgerhq/coin-framework/currencies/formatCurrencyUnit";
+import { getAccountCurrency } from "@ledgerhq/coin-framework/account/helpers";
+import { getAssetCodeIssuer } from "./logic";
+import type { Transaction, TransactionRaw } from "./types";
+
+export function formatTransaction(
+  { amount, recipient, fees, memoValue, useAllAmount, subAccountId }: Transaction,
+  mainAccount: Account,
+): string {
+  const account =
+    (subAccountId && (mainAccount.subAccounts || []).find(a => a.id === subAccountId)) ||
+    mainAccount;
+
+  return `
+    SEND ${
+      useAllAmount
+        ? "MAX"
+        : formatCurrencyUnit(getAccountCurrency(account).units[0], amount, {
+            showCode: true,
+            disableRounding: true,
+          })
+    }
+    TO ${recipient}
+    with fees=${
+      !fees
+        ? "?"
+        : formatCurrencyUnit(getAccountCurrency(account).units[0], fees, {
+            showCode: true,
+            disableRounding: true,
+          })
+    }${memoValue ? "\n  memo=" + memoValue : ""}`;
+}
+
+function fromTransactionRaw(tr: TransactionRaw): Transaction {
+  const common = fromTransactionCommonRaw(tr);
+  const { networkInfo } = tr;
+  const [assetCode, assetIssuer] = getAssetCodeIssuer(tr);
+
+  return {
+    ...common,
+    family: tr.family,
+    fees: tr.fees ? new BigNumber(tr.fees) : null,
+    baseReserve: tr.baseReserve ? new BigNumber(tr.baseReserve) : null,
+    memoValue: tr.memoValue ? tr.memoValue : null,
+    memoType: tr.memoType ? tr.memoType : null,
+    networkInfo: networkInfo && {
+      family: networkInfo.family,
+      fees: new BigNumber(networkInfo.fees),
+      baseFee: new BigNumber(networkInfo.baseFee),
+      baseReserve: new BigNumber(networkInfo.baseReserve),
+      networkCongestionLevel: networkInfo.networkCongestionLevel,
+    },
+    mode: tr.mode,
+    assetCode,
+    assetIssuer,
+  };
+}
+
+function toTransactionRaw(transaction: Transaction): TransactionRaw {
+  const common = toTransactionCommonRaw(transaction);
+  const { networkInfo } = transaction;
+  const [assetCode, assetIssuer] = getAssetCodeIssuer(transaction);
+  return {
+    ...common,
+    family: transaction.family,
+    fees: transaction.fees ? transaction.fees.toString() : null,
+    baseReserve: transaction.baseReserve ? transaction.baseReserve.toString() : null,
+    memoValue: transaction.memoValue ? transaction.memoValue.toString() : null,
+    memoType: transaction.memoType ? transaction.memoType.toString() : null,
+    networkInfo: networkInfo && {
+      family: networkInfo.family,
+      fees: networkInfo.fees.toString(),
+      baseFee: networkInfo.baseFee.toString(),
+      baseReserve: networkInfo.baseReserve.toString(),
+      networkCongestionLevel: networkInfo.networkCongestionLevel,
+    },
+    mode: transaction.mode,
+    assetCode,
+    assetIssuer,
+  };
+}
+
+export default {
+  formatTransaction,
+  fromTransactionRaw,
+  toTransactionRaw,
+  fromTransactionStatusRaw,
+  toTransactionStatusRaw,
+  formatTransactionStatus,
+};

package/src/types/index.ts

@@ -0,0 +1,112 @@
+import { Horizon } from "@stellar/stellar-sdk";
+import type { BigNumber } from "bignumber.js";
+import type {
+  Account,
+  Operation,
+  OperationType,
+  TransactionCommon,
+  TransactionCommonRaw,
+  TransactionStatusCommon,
+  TransactionStatusCommonRaw,
+} from "@ledgerhq/types-live";
+
+export type NetworkInfo = {
+  family: "stellar";
+  fees: BigNumber;
+  baseFee: BigNumber;
+  baseReserve: BigNumber;
+  networkCongestionLevel?: NetworkCongestionLevel | undefined;
+};
+
+export type NetworkInfoRaw = {
+  family: "stellar";
+  fees: string;
+  baseFee: string;
+  baseReserve: string;
+  networkCongestionLevel?: NetworkCongestionLevel | undefined;
+};
+
+export enum NetworkCongestionLevel {
+  LOW = "LOW",
+  MEDIUM = "MEDIUM",
+  HIGH = "HIGH",
+}
+
+export const StellarMemoType = ["NO_MEMO", "MEMO_TEXT", "MEMO_ID", "MEMO_HASH", "MEMO_RETURN"];
+
+export type StellarTransactionMode = "send" | "changeTrust";
+
+export type Transaction = TransactionCommon & {
+  family: "stellar";
+  networkInfo?: NetworkInfo | null | undefined;
+  fees?: BigNumber | null;
+  baseReserve?: BigNumber | null;
+  memoType?: string | null;
+  memoValue?: string | null;
+  mode: StellarTransactionMode;
+  assetCode?: string;
+  assetIssuer?: string;
+};
+
+export type TransactionRaw = TransactionCommonRaw & {
+  family: "stellar";
+  networkInfo?: NetworkInfoRaw | null | undefined;
+  fees?: string | null;
+  baseReserve?: string | null;
+  memoType?: string | null;
+  memoValue?: string | null;
+  mode: StellarTransactionMode;
+  assetCode?: string;
+  assetIssuer?: string;
+};
+
+export type BalanceAsset = {
+  balance: string;
+  limit: string;
+  buying_liabilities: string;
+  selling_liabilities: string;
+  last_modified_ledger: number;
+  is_authorized: boolean;
+  is_authorized_to_maintain_liabilities: boolean;
+  asset_type: string;
+  asset_code: string;
+  asset_issuer: string;
+  liquidity_pool_id?: string;
+};
+
+export type RawOperation = Horizon.ServerApi.OperationRecord & {
+  asset_code?: string;
+  asset_issuer?: string;
+  from?: string;
+  to?: string;
+  to_muxed?: string;
+  funder?: string;
+  trustor?: string;
+  account?: string;
+  transaction_successful: boolean;
+};
+
+export type Signer = {
+  weight: number;
+  key: string;
+  type: string;
+};
+
+export type TransactionStatus = TransactionStatusCommon;
+
+export type TransactionStatusRaw = TransactionStatusCommonRaw;
+
+export type StellarOperation = Operation<StellarOperationExtra>;
+
+export type StellarOperationExtra = {
+  pagingToken?: string;
+  assetCode?: string;
+  assetIssuer?: string;
+  assetAmount?: string | undefined;
+  ledgerOpType: OperationType;
+  memo?: string;
+};
+
+export type StellarAccount = Account;
+
+export * from "./signer";

package/src/types/signer.ts

@@ -0,0 +1,9 @@
+export interface StellarSigner {
+  getPublicKey(path: string, display?: boolean): Promise<{ rawPublicKey: Buffer }>;
+  signTransaction(
+    path: string,
+    transaction: Buffer,
+  ): Promise<{
+    signature: Buffer;
+  }>;
+}

package/tsconfig.json

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