@ledgerhq/coin-tron 0.0.1

package/lib-es/types/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/types/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAE1D,MAAM,CAAC,MAAM,wBAAwB,GAAG,sBAAsB,CAAC,0BAA0B,CAAC,CAAC;AAC3F,MAAM,CAAC,MAAM,qBAAqB,GAAG,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;AACrF,MAAM,CAAC,MAAM,sBAAsB,GAAG,sBAAsB,CAAC,wBAAwB,CAAC,CAAC;AACvF,MAAM,CAAC,MAAM,4BAA4B,GAAG,sBAAsB,CAAC,8BAA8B,CAAC,CAAC;AACnG,MAAM,CAAC,MAAM,gBAAgB,GAAG,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;AAC3E,MAAM,CAAC,MAAM,oBAAoB,GAAG,sBAAsB,CAAC,sBAAsB,CAAC,CAAC;AACnF,MAAM,CAAC,MAAM,sBAAsB,GAAG,sBAAsB,CAAC,wBAAwB,CAAC,CAAC;AACvF,MAAM,CAAC,MAAM,YAAY,GAAG,sBAAsB,CAAC,cAAc,CAAC,CAAC;AACnE,MAAM,CAAC,MAAM,uBAAuB,GAAG,sBAAsB,CAAC,yBAAyB,CAAC,CAAC;AACzF,MAAM,CAAC,MAAM,kCAAkC,GAAG,sBAAsB,CACtE,oCAAoC,CACrC,CAAC;AACF,MAAM,CAAC,MAAM,kBAAkB,GAAG,sBAAsB,CAAC,oBAAoB,CAAC,CAAC;AAC/E,MAAM,CAAC,MAAM,sBAAsB,GAAG,sBAAsB,CAAC,wBAAwB,CAAC,CAAC;AACvF,MAAM,CAAC,MAAM,sBAAsB,GAAG,sBAAsB,CAAC,wBAAwB,CAAC,CAAC;AACvF,MAAM,CAAC,MAAM,mBAAmB,GAAG,sBAAsB,CAAC,qBAAqB,CAAC,CAAC;AACjF,MAAM,CAAC,MAAM,sBAAsB,GAAG,sBAAsB,CAAC,wBAAwB,CAAC,CAAC;AACvF,MAAM,CAAC,MAAM,mCAAmC,GAAG,sBAAsB,CACvE,qCAAqC,CACtC,CAAC"}

package/lib-es/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./bridge";
+export * from "./errors";
+export * from "./signer";
+//# sourceMappingURL=index.d.ts.map

package/lib-es/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AAEzB,cAAc,UAAU,CAAC"}

package/lib-es/types/index.js

@@ -0,0 +1,5 @@
+export * from "./bridge";
+export * from "./errors";
+// export * from "./model";
+export * from "./signer";
+//# sourceMappingURL=index.js.map

package/lib-es/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,2BAA2B;AAC3B,cAAc,UAAU,CAAC"}

package/lib-es/types/signer.d.ts

@@ -0,0 +1,10 @@
+export type TronAddress = {
+    publicKey: string;
+    address: string;
+};
+export type TronSignature = string;
+export interface TronSigner {
+    getAddress(path: string, boolDisplay?: boolean): Promise<TronAddress>;
+    sign(path: string, rawTxHex: string, tokenSignatures: string[]): Promise<TronSignature>;
+}
+//# sourceMappingURL=signer.d.ts.map

package/lib-es/types/signer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../../src/types/signer.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AACF,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AACnC,MAAM,WAAW,UAAU;IACzB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACtE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;CACzF"}

package/lib-es/types/signer.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=signer.js.map

package/lib-es/types/signer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signer.js","sourceRoot":"","sources":["../../src/types/signer.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,133 @@
+{
+  "name": "@ledgerhq/coin-tron",
+  "version": "0.0.1",
+  "description": "Ledger Tron Coin integration",
+  "keywords": [
+    "Ledger",
+    "LedgerWallet",
+    "trx",
+    "Tron",
+    "Hardware Wallet"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/LedgerHQ/ledger-live.git"
+  },
+  "bugs": {
+    "url": "https://github.com/LedgerHQ/ledger-live/issues"
+  },
+  "homepage": "https://github.com/LedgerHQ/ledger-live/tree/develop/libs/coin-modules/coin-tron",
+  "publishConfig": {
+    "access": "public"
+  },
+  "typesVersions": {
+    "*": {
+      "lib/*": [
+        "lib/*"
+      ],
+      "lib-es/*": [
+        "lib-es/*"
+      ],
+      "bridge": [
+        "lib/bridge/index"
+      ],
+      "deviceTransactionConfig": [
+        "lib/bridge/deviceTransactionConfig"
+      ],
+      "network": [
+        "lib/network/index"
+      ],
+      "specs": [
+        "lib/test/bot-specs"
+      ],
+      "signer": [
+        "lib/signer/index"
+      ],
+      "transaction": [
+        "lib/bridge/transaction"
+      ],
+      "types": [
+        "lib/types/index"
+      ],
+      "*": [
+        "lib/*"
+      ]
+    }
+  },
+  "exports": {
+    "./lib/*": "./lib/*.js",
+    "./lib-es/*": "./lib-es/*.js",
+    "./bridge": {
+      "require": "./lib/bridge/index.js",
+      "default": "./lib-es/bridge/index.js"
+    },
+    "./deviceTransactionConfig": {
+      "require": "./lib/bridge/deviceTransactionConfig.js",
+      "default": "./lib-es/bridge/deviceTransactionConfig.js"
+    },
+    "./network": {
+      "require": "./lib/network/index.js",
+      "default": "./lib-es/network/index.js"
+    },
+    "./signer": {
+      "require": "./lib/signer/index.js",
+      "default": "./lib-es/signer/index.js"
+    },
+    "./specs": {
+      "require": "./lib/test/bot-specs.js",
+      "default": "./lib-es/bridge/transaction.js"
+    },
+    "./transaction": {
+      "require": "./lib/bridge/transaction.js",
+      "default": "./lib-es/bridge/transaction.js"
+    },
+    "./*": {
+      "require": "./lib/*.js",
+      "default": "./lib-es/*.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "license": "Apache-2.0",
+  "dependencies": {
+    "bignumber.js": "^9.1.2",
+    "bs58check": "^2.1.2",
+    "expect": "^27.4.6",
+    "invariant": "^2.2.2",
+    "lodash": "^4.17.21",
+    "rxjs": "^7.8.1",
+    "tronweb": "^5.3.2",
+    "@ledgerhq/coin-framework": "^0.14.0",
+    "@ledgerhq/cryptoassets": "^13.1.0",
+    "@ledgerhq/devices": "^8.4.0",
+    "@ledgerhq/errors": "^6.17.0",
+    "@ledgerhq/live-env": "^2.1.0",
+    "@ledgerhq/live-network": "^1.3.0",
+    "@ledgerhq/live-promise": "^0.1.0",
+    "@ledgerhq/logs": "^6.12.0",
+    "@ledgerhq/types-live": "^6.48.0"
+  },
+  "devDependencies": {
+    "@agrozyme/types-tronweb": "^5.3.2",
+    "@types/bs58check": "^2.1.0",
+    "@types/invariant": "^2.2.2",
+    "@types/jest": "^29.5.10",
+    "@types/lodash": "^4.14.191",
+    "jest": "^29.7.0",
+    "msw": "^2.0.11",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.4.5"
+  },
+  "scripts": {
+    "clean": "rimraf lib lib-es",
+    "build": "tsc && tsc -m ES6 --outDir lib-es",
+    "coverage": "jest --coverage --testPathIgnorePatterns='/bridge.integration.test.ts|node_modules|lib-es|lib/' --passWithNoTests && mv coverage/coverage-final.json coverage/coverage-tron.json",
+    "prewatch": "pnpm build",
+    "watch": "tsc --watch",
+    "doc": "documentation readme src/** --section=API --pe ts --re ts --re d.ts",
+    "lint": "eslint ./src --no-error-on-unmatched-pattern --ext .ts,.tsx --cache",
+    "lint:fix": "pnpm lint --fix",
+    "test": "jest",
+    "test-integ": "jest --config=jest.integ.config.js",
+    "unimported": "unimported"
+  }
+}

package/src/bridge/broadcast.ts

@@ -0,0 +1,24 @@
+import { Account, Operation, SignedOperation } from "@ledgerhq/types-live";
+import { broadcastTron } from "../network";
+
+const broadcast = async ({
+  signedOperation: { signature, operation, rawData },
+}: {
+  account: Account;
+  signedOperation: SignedOperation;
+}): Promise<Operation> => {
+  const transaction = {
+    raw_data: rawData,
+    txID: operation.hash,
+    signature: [signature],
+  };
+  const submittedTransaction = await broadcastTron(transaction);
+
+  if (submittedTransaction.result !== true) {
+    throw new Error(submittedTransaction.resultMessage);
+  }
+
+  return operation;
+};
+
+export default broadcast;

package/src/bridge/buildOptimisticOperation.ts

@@ -0,0 +1,133 @@
+import { encodeOperationId } from "@ledgerhq/coin-framework/operation";
+import { TokenAccount } from "@ledgerhq/types-live";
+import BigNumber from "bignumber.js";
+import get from "lodash/get";
+import { getOperationTypefromMode } from "../logic/utils";
+import {
+  Transaction,
+  TronAccount,
+  TronOperation,
+  TronResource,
+  TrongridExtraTxInfo,
+} from "../types";
+
+const getValue = (
+  account: TronAccount,
+  subAccount: TokenAccount | undefined,
+  transaction: Transaction,
+  fee: BigNumber,
+): BigNumber => {
+  switch (transaction.mode) {
+    case "send":
+      return subAccount ? fee : new BigNumber(transaction.amount || 0).plus(fee);
+
+    case "claimReward": {
+      return account.tronResources ? account.tronResources.unwithdrawnReward : new BigNumber(0);
+    }
+
+    default:
+      return new BigNumber(0);
+  }
+};
+
+const getExtra = (
+  account: TronAccount,
+  transaction: Transaction,
+  resource: TronResource,
+): TrongridExtraTxInfo | null | undefined => {
+  switch (transaction.mode) {
+    case "freeze":
+      return {
+        frozenAmount: transaction.amount,
+      };
+
+    case "unfreeze":
+      return {
+        unfreezeAmount: transaction.amount,
+      };
+
+    case "vote":
+      return {
+        votes: transaction.votes,
+      };
+
+    case "unDelegateResource":
+      return {
+        unDelegatedAmount: transaction.amount,
+        receiverAddress: transaction.recipient,
+      };
+
+    case "legacyUnfreeze":
+      return {
+        unfreezeAmount: get(
+          account.tronResources,
+          `frozen.${resource.toLocaleLowerCase()}.amount`,
+          new BigNumber(0),
+        ),
+      };
+
+    default:
+      return undefined;
+  }
+};
+
+export const buildOptimisticOperation = (
+  account: TronAccount,
+  subAccount: TokenAccount | undefined,
+  transaction: Transaction,
+  fee: BigNumber,
+  hash: string,
+): TronOperation => {
+  const value = getValue(account, subAccount, transaction, fee);
+  const operationType = getOperationTypefromMode(transaction.mode);
+  const resource = transaction.resource || "BANDWIDTH";
+  const extra = getExtra(account, transaction, resource) || {};
+
+  /**
+   * FIXME
+   *
+   * This is not working and cannot work simply because this "NONE" type doesn't exist during a sync,
+   * as well as subOperations which are never created either.
+   *
+   * And even after fixing this,  we're getting wrong fee estimation for TRC20 transactions
+   * which are considered as 0 all the time, while it always being between 1 and 10 TRX.
+   */
+  const operation: TronOperation = {
+    id: encodeOperationId(account.id, hash, operationType),
+    hash,
+    // if it's a token op and there is no fee, this operation does not exist and is a "NONE"
+    type: subAccount && value.eq(0) ? "NONE" : operationType,
+    value,
+    fee,
+    blockHash: null,
+    blockHeight: null,
+    senders: [account.freshAddress],
+    recipients: [transaction.recipient],
+    accountId: account.id,
+    date: new Date(),
+    extra,
+    subOperations: subAccount
+      ? [
+          {
+            id: encodeOperationId(subAccount.id, hash, "OUT"),
+            hash,
+            type: "OUT",
+            value:
+              transaction.useAllAmount && subAccount
+                ? subAccount.balance
+                : new BigNumber(transaction.amount || 0),
+            fee: new BigNumber(0),
+            blockHash: null,
+            blockHeight: null,
+            senders: [account.freshAddress],
+            recipients: [transaction.recipient],
+            accountId: subAccount.id,
+            date: new Date(),
+            extra: {},
+          },
+        ]
+      : [],
+  };
+
+  return operation;
+};

package/src/bridge/createTransaction.ts

@@ -0,0 +1,16 @@
+import BigNumber from "bignumber.js";
+import { Transaction } from "../types";
+
+const createTransaction = (): Transaction => ({
+  family: "tron",
+  amount: new BigNumber(0),
+  useAllAmount: false,
+  mode: "send",
+  duration: 3,
+  recipient: "",
+  networkInfo: null,
+  resource: null,
+  votes: [],
+});
+
+export default createTransaction;

package/src/bridge/deviceTransactionConfig.ts

@@ -0,0 +1,99 @@
+import type { AccountLike, Account } from "@ledgerhq/types-live";
+import { getMainAccount } from "@ledgerhq/coin-framework/account";
+import type { CommonDeviceTransactionField } from "@ledgerhq/coin-framework/transaction/common";
+import type { Transaction, TransactionStatus } from "../types";
+
+export type ExtraDeviceTransactionField =
+  | {
+      type: "tron.resource";
+      label: string;
+      value: string;
+    }
+  | {
+      type: "tron.votes";
+      label: string;
+    };
+
+type DeviceTransactionField = CommonDeviceTransactionField | ExtraDeviceTransactionField;
+
+function getDeviceTransactionConfig({
+  transaction: { votes, resource, mode, recipient },
+  account,
+  parentAccount,
+  status: { amount },
+}: {
+  account: AccountLike;
+  parentAccount: Account | null | undefined;
+  transaction: Transaction;
+  status: TransactionStatus;
+}): Array<DeviceTransactionField> {
+  const mainAccount = getMainAccount(account, parentAccount);
+  const fields: Array<DeviceTransactionField> = [];
+
+  if (resource) {
+    fields.push({
+      type: "tron.resource",
+      label: "Resource",
+      value: resource.slice(0, 1).toUpperCase() + resource.slice(1).toLowerCase(),
+    });
+  }
+
+  if (votes && votes.length > 0) {
+    // NB in future if we unify UI with other coin, we could converge to a "votes" top level
+    fields.push({
+      type: "tron.votes",
+      label: "Votes",
+    });
+  }
+
+  if (!amount.isZero()) {
+    fields.push({
+      type: "amount",
+      label: "Amount",
+    });
+  }
+
+  if (mode === "freeze") {
+    fields.push({
+      type: "address",
+      label: "Freeze To",
+      address: mainAccount.freshAddress,
+    });
+  }
+
+  if (mode === "unfreeze" || mode === "legacyUnfreeze") {
+    fields.push({
+      type: "address",
+      label: "Unfreeze To",
+      address: mainAccount.freshAddress,
+    });
+  }
+
+  if (mode === "withdrawExpireUnfreeze") {
+    fields.push({
+      type: "address",
+      label: "Withdraw unfrozen to",
+      address: mainAccount.freshAddress,
+    });
+  }
+
+  if (mode === "unDelegateResource") {
+    fields.push({
+      type: "address",
+      label: "Undelegate from",
+      address: recipient,
+    });
+  }
+
+  if (mode !== "send") {
+    fields.push({
+      type: "address",
+      label: "From Address",
+      address: mainAccount.freshAddress,
+    });
+  }
+
+  return fields;
+}
+
+export default getDeviceTransactionConfig;

package/src/bridge/estimateMaxSpendable.ts

@@ -0,0 +1,32 @@
+import BigNumber from "bignumber.js";
+import { getMainAccount } from "@ledgerhq/coin-framework/account";
+import { AccountBridge } from "@ledgerhq/types-live";
+import { fetchTronContract } from "../network";
+import { Transaction, TronAccount } from "../types";
+import createTransaction from "./createTransaction";
+import getEstimatedFees from "./getEstimateFees";
+
+const estimateMaxSpendable: AccountBridge<
+  Transaction,
+  TronAccount
+>["estimateMaxSpendable"] = async ({ account, parentAccount, transaction }): Promise<BigNumber> => {
+  const mainAccount = getMainAccount(account, parentAccount);
+  const fees = await getEstimatedFees(
+    mainAccount,
+    {
+      ...createTransaction(),
+      subAccountId: account.type === "Account" ? null : account.id,
+      ...transaction,
+      recipient: transaction?.recipient || "0x0000000000000000000000000000000000000000",
+      amount: new BigNumber(0),
+    },
+    transaction && transaction.recipient
+      ? (await fetchTronContract(transaction.recipient)) !== undefined
+      : false,
+  );
+  return account.type === "Account"
+    ? BigNumber.max(0, account.spendableBalance.minus(fees))
+    : account.balance;
+};
+
+export default estimateMaxSpendable;

package/src/bridge/getEstimateFees.ts

@@ -0,0 +1,52 @@
+import BigNumber from "bignumber.js";
+import { Account } from "@ledgerhq/types-live";
+import { Transaction } from "../types";
+import { fetchTronAccount } from "../network";
+import { ACTIVATION_FEES } from "../logic/constants";
+import { getEstimatedBlockSize, extractBandwidthInfo } from "../logic/utils";
+
+// see : https://developers.tron.network/docs/bandwith#section-bandwidth-points-consumption
+// 1. cost around 200 Bandwidth, if not enough check Free Bandwidth
+// 2. If not enough, will cost some TRX
+// 3. normal transfert cost around 0.002 TRX
+const getFeesFromBandwidth = (account: Account, transaction: Transaction): BigNumber => {
+  const { freeUsed, freeLimit, gainedUsed, gainedLimit } = extractBandwidthInfo(
+    transaction.networkInfo,
+  );
+  const available = freeLimit.minus(freeUsed).plus(gainedLimit).minus(gainedUsed);
+  const estimatedBandwidthCost = getEstimatedBlockSize(account, transaction);
+
+  if (available.lt(estimatedBandwidthCost)) {
+    return new BigNumber(2000); // cost is around 0.002 TRX
+  }
+
+  return new BigNumber(0); // no fee
+};
+
+// Special case: If activated an account, cost around 0.1 TRX
+const getFeesFromAccountActivation = async (a: Account, t: Transaction): Promise<BigNumber> => {
+  const recipientAccount = await fetchTronAccount(t.recipient);
+  const { gainedUsed, gainedLimit } = extractBandwidthInfo(t.networkInfo);
+  const available = gainedLimit.minus(gainedUsed);
+  const estimatedBandwidthCost = getEstimatedBlockSize(a, t);
+
+  if (recipientAccount.length === 0 && available.lt(estimatedBandwidthCost)) {
+    return ACTIVATION_FEES; // cost is around 1 TRX
+  }
+
+  return new BigNumber(0); // no fee
+};
+
+const getEstimatedFees = async (a: Account, t: Transaction, isContract: boolean) => {
+  const feesFromAccountActivation =
+    t.mode === "send" && !isContract ? await getFeesFromAccountActivation(a, t) : new BigNumber(0);
+
+  if (feesFromAccountActivation.gt(0)) {
+    return feesFromAccountActivation;
+  }
+
+  const feesFromBandwidth = getFeesFromBandwidth(a, t);
+  return feesFromBandwidth;
+};
+
+export default getEstimatedFees;