@keystonehq/hw-app-tron 0.0.1

package/jest.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ['**/__test__/**/*.ts']
+};

package/lib/index.d.ts

@@ -0,0 +1,47 @@
+import Base from '@keystonehq/hw-app-base';
+import { TransportHID } from '@keystonehq/hw-transport-usb';
+import { UR } from '@ngraveio/bc-ur';
+/**
+ * Tron Hardware Wallet Application.
+ * Extends the Base class to reuse common USB transport logic.
+ */
+export default class Tron extends Base {
+    /**
+     * Constructs a new instance of the Tron class.
+     *
+     * @param transport - An object of type TransportHID for USB communication.
+     * @param mfp - Optional parameter for the master fingerprint of the wallet.
+     */
+    constructor(transport: TransportHID, mfp?: string);
+    /**
+     * Signs a Tron transaction using the specified derivation path.
+     */
+    signTransactionBuffer(path: string, rawTx: Buffer, xfp: string, origin: string): Promise<string>;
+    /**
+     * signs a Tron transaction given the raw transaction data in hexadecimal format.
+     * @param path
+     * @param rawTx
+     * @param xfp
+     * @param origin
+     * @returns
+     */
+    signTransaction(path: string, rawTx: string, xfp: string, origin: string): Promise<string>;
+    /**
+     * Constructs a UR-encoded request for Tron signing.
+     *
+     * @param txBuffer - The transaction data to be signed.
+     * @param path - The derivation path.
+     * @param mfp - The master fingerprint of the wallet.
+     * @param origin - The origin of the signing request, used for user confirmation on the device.
+     * @returns A string representing the UR-encoded request in uppercase.
+     */
+    generateSignRequest(txBuffer: Buffer, path: string, mfp: string, origin: string): string;
+    /**
+     * Parses the UR response from the device to extract the Tron signature.
+     *
+     * @param ur - The result UR from the device.
+     * @returns The signature string in hexadecimal format.
+     */
+    parseSignature(ur: UR): string;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,IAA0B,MAAM,yBAAyB,CAAC;AACjE,OAAO,EAAW,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAErE,OAAO,EAAa,EAAE,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,IAAI;IAClC;;;;;OAKG;gBACS,SAAS,EAAE,YAAY,EAAE,GAAG,CAAC,EAAE,MAAM;IAIjD;;OAEG;IACG,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAStG;;;;;;;OAOG;IACG,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIhG;;;;;;;;OAQG;IACI,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;IAe/F;;;;;OAKG;IACI,cAAc,CAAC,EAAE,EAAE,EAAE,GAAG,MAAM;CAIxC"}

package/lib/index.js

@@ -0,0 +1,117 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const uuid = __importStar(require("uuid"));
+const hw_app_base_1 = __importStar(require("@keystonehq/hw-app-base"));
+const hw_transport_usb_1 = require("@keystonehq/hw-transport-usb");
+const bc_ur_registry_tron_1 = require("@keystonehq/bc-ur-registry-tron");
+const bc_ur_1 = require("@ngraveio/bc-ur");
+/**
+ * Tron Hardware Wallet Application.
+ * Extends the Base class to reuse common USB transport logic.
+ */
+class Tron extends hw_app_base_1.default {
+    /**
+     * Constructs a new instance of the Tron class.
+     *
+     * @param transport - An object of type TransportHID for USB communication.
+     * @param mfp - Optional parameter for the master fingerprint of the wallet.
+     */
+    constructor(transport, mfp) {
+        super(transport, mfp);
+    }
+    /**
+     * Signs a Tron transaction using the specified derivation path.
+     */
+    signTransactionBuffer(path, rawTx, xfp, origin) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.precheck();
+            const encodedUR = this.generateSignRequest(rawTx, path, xfp || this.mfp, origin);
+            const response = yield this.sendToDevice(hw_transport_usb_1.Actions.CMD_RESOLVE_UR, encodedUR);
+            const resultUR = (0, hw_app_base_1.parseResponoseUR)(response.payload);
+            return this.parseSignature(resultUR);
+        });
+    }
+    /**
+     * signs a Tron transaction given the raw transaction data in hexadecimal format.
+     * @param path
+     * @param rawTx
+     * @param xfp
+     * @param origin
+     * @returns
+     */
+    signTransaction(path, rawTx, xfp, origin) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.signTransactionBuffer(path, Buffer.from(rawTx, 'hex'), xfp, origin);
+        });
+    }
+    /**
+     * Constructs a UR-encoded request for Tron signing.
+     *
+     * @param txBuffer - The transaction data to be signed.
+     * @param path - The derivation path.
+     * @param mfp - The master fingerprint of the wallet.
+     * @param origin - The origin of the signing request, used for user confirmation on the device.
+     * @returns A string representing the UR-encoded request in uppercase.
+     */
+    generateSignRequest(txBuffer, path, mfp, origin) {
+        const requestId = uuid.v4();
+        const tronUR = bc_ur_registry_tron_1.TronSignRequest.constructTronRequest(txBuffer, path, mfp, requestId, undefined, origin);
+        const ur = tronUR.toUR();
+        return new bc_ur_1.UREncoder(ur, Infinity).nextPart().toUpperCase();
+    }
+    /**
+     * Parses the UR response from the device to extract the Tron signature.
+     *
+     * @param ur - The result UR from the device.
+     * @returns The signature string in hexadecimal format.
+     */
+    parseSignature(ur) {
+        const signature = bc_ur_registry_tron_1.TronSignature.fromCBOR(ur.cbor);
+        return signature.getSignature().toString('hex');
+    }
+    ;
+}
+exports.default = Tron;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA6B;AAC7B,uEAAiE;AACjE,mEAAqE;AACrE,yEAAiF;AACjF,2CAAgD;AAEhD;;;GAGG;AACH,MAAqB,IAAK,SAAQ,qBAAI;IAClC;;;;;OAKG;IACH,YAAY,SAAuB,EAAE,GAAY;QAC7C,KAAK,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACG,qBAAqB,CAAC,IAAY,EAAE,KAAa,EAAE,GAAW,EAAE,MAAc;;YAChF,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,CAAC,GAAI,EAAE,MAAM,CAAC,CAAC;YAClF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,0BAAO,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;YAC5E,MAAM,QAAQ,GAAG,IAAA,8BAAgB,EAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAEpD,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC;KAAA;IAED;;;;;;;OAOG;IACG,eAAe,CAAC,IAAY,EAAE,KAAa,EAAE,GAAW,EAAE,MAAc;;YAC1E,OAAO,MAAM,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;QAC1F,CAAC;KAAA;IAED;;;;;;;;OAQG;IACI,mBAAmB,CAAC,QAAgB,EAAE,IAAY,EAAE,GAAW,EAAE,MAAc;QAClF,MAAM,SAAS,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAG,qCAAe,CAAC,oBAAoB,CAC/C,QAAQ,EACR,IAAI,EACJ,GAAG,EACH,SAAS,EACT,SAAS,EACT,MAAM,CACT,CAAC;QAEF,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC;QACzB,OAAO,IAAI,iBAAS,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,EAAM;QACxB,MAAM,SAAS,GAAG,mCAAa,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAClD,OAAO,SAAS,CAAC,YAAY,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACpD,CAAC;IAAA,CAAC;CACL;AArED,uBAqEC"}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@keystonehq/hw-app-tron",
+  "version": "0.0.1",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "dependencies": {
+    "@keystonehq/bc-ur-registry": "0.7.0",
+    "@keystonehq/bc-ur-registry-tron": "0.4.3",
+    "@ngraveio/bc-ur": "^1.1.6",
+    "@noble/hashes": "^1.5.0",
+    "bech32": "^2.0.0",
+    "uuid": "^8.3.2",
+    "@keystonehq/hw-app-base": "^0.1.7",
+    "@keystonehq/hw-transport-usb": "^0.2.0",
+    "@keystonehq/hw-transport-error": "^0.0.2"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.5.2",
+    "@types/node": "^16.18.52",
+    "eslint": "^8.49.0",
+    "jest": "^27.4.3",
+    "typescript": "^5.2.2"
+  },
+  "scripts": {
+    "build": "tsc --project tsconfig.json",
+    "test": "jest"
+  }
+}

package/src/index.ts

@@ -0,0 +1,81 @@
+import * as uuid from 'uuid';
+import Base, { parseResponoseUR } from '@keystonehq/hw-app-base';
+import { Actions, TransportHID } from '@keystonehq/hw-transport-usb';
+import { TronSignRequest, TronSignature } from '@keystonehq/bc-ur-registry-tron';
+import { UREncoder, UR } from '@ngraveio/bc-ur';
+
+/**
+ * Tron Hardware Wallet Application.
+ * Extends the Base class to reuse common USB transport logic.
+ */
+export default class Tron extends Base {
+    /**
+     * Constructs a new instance of the Tron class.
+     *
+     * @param transport - An object of type TransportHID for USB communication.
+     * @param mfp - Optional parameter for the master fingerprint of the wallet.
+     */
+    constructor(transport: TransportHID, mfp?: string) {
+        super(transport, mfp);
+    }
+
+    /**
+     * Signs a Tron transaction using the specified derivation path.
+     */
+    async signTransactionBuffer(path: string, rawTx: Buffer, xfp: string, origin: string): Promise<string> {
+        this.precheck();
+        const encodedUR = this.generateSignRequest(rawTx, path, xfp || this.mfp!, origin);
+        const response = await this.sendToDevice(Actions.CMD_RESOLVE_UR, encodedUR);
+        const resultUR = parseResponoseUR(response.payload);
+
+        return this.parseSignature(resultUR);
+    }
+
+    /**
+     * signs a Tron transaction given the raw transaction data in hexadecimal format.
+     * @param path 
+     * @param rawTx 
+     * @param xfp 
+     * @param origin 
+     * @returns 
+     */
+    async signTransaction(path: string, rawTx: string, xfp: string, origin: string): Promise<string> {
+        return await this.signTransactionBuffer(path, Buffer.from(rawTx, 'hex'), xfp, origin);
+    }
+
+    /**
+     * Constructs a UR-encoded request for Tron signing.
+     *
+     * @param txBuffer - The transaction data to be signed.
+     * @param path - The derivation path.
+     * @param mfp - The master fingerprint of the wallet.
+     * @param origin - The origin of the signing request, used for user confirmation on the device.
+     * @returns A string representing the UR-encoded request in uppercase.
+     */
+    public generateSignRequest(txBuffer: Buffer, path: string, mfp: string, origin: string): string {
+        const requestId = uuid.v4();
+        const tronUR = TronSignRequest.constructTronRequest(
+            txBuffer,
+            path,
+            mfp,
+            requestId,
+            undefined,
+            origin
+        );
+
+        const ur = tronUR.toUR();
+        return new UREncoder(ur, Infinity).nextPart().toUpperCase();
+    }
+
+    /**
+     * Parses the UR response from the device to extract the Tron signature.
+     *
+     * @param ur - The result UR from the device.
+     * @returns The signature string in hexadecimal format.
+     */
+    public parseSignature(ur: UR): string {
+        const signature = TronSignature.fromCBOR(ur.cbor);
+        return signature.getSignature().toString('hex');
+    };
+}
+

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "lib",
+    "rootDir": "src"
+  },
+  "include": ["src/**/*", "types/**/*"],
+  "exclude": ["node_modules", "**/*.test.ts", "__tests__"]
+}