@ton-community/ton-ledger 4.0.0 → 4.1.0

package/CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [4.1.0] - 2023-06-16
+
+### Added
+
+- Added `signData` method along with `SignDataRequest` type
+
+## [4.0.1] - 2023-06-16
+
+### Fixed
+
+- Fixed the address flags communication
+
 ## [4.0.0] - 2023-06-09
 
 ### Added

package/dist/TonTransport.d.ts

@@ -27,6 +27,16 @@ export type TonPayloadFormat = {
     forwardAmount: bigint;
     forwardPayload: Cell | null;
 };
+export type SignDataRequest = {
+    type: 'plaintext';
+    text: string;
+} | {
+    type: 'app-data';
+    address?: Address;
+    domain?: string;
+    data: Cell;
+    ext?: Cell;
+};
 export declare class TonTransport {
     #private;
     readonly transport: Transport;
@@ -61,6 +71,13 @@ export declare class TonTransport {
         signature: Buffer;
         hash: Buffer;
     }>;
+    signData(path: number[], req: SignDataRequest, opts?: {
+        timestamp?: number;
+    }): Promise<{
+        signature: Buffer;
+        cell: Cell;
+        timestamp: number;
+    }>;
     signTransaction: (path: number[], transaction: {
         to: Address;
         sendMode: SendMode;

package/dist/TonTransport.js

@@ -10,7 +10,9 @@ const LEDGER_SYSTEM = 0xB0;
 const LEDGER_CLA = 0xe0;
 const INS_VERSION = 0x03;
 const INS_ADDRESS = 0x05;
+const INS_SIGN_TX = 0x06;
 const INS_PROOF = 0x08;
+const INS_SIGN_DATA = 0x09;
 function chunks(buf, n) {
     const nc = Math.ceil(buf.length / n);
     const cs = [];
@@ -19,6 +21,19 @@ function chunks(buf, n) {
     }
     return cs;
 }
+function processAddressFlags(opts) {
+    const bounceable = opts?.bounceable ?? true;
+    const testOnly = opts?.testOnly ?? false;
+    const chain = opts?.chain ?? 0;
+    let flags = 0x00;
+    if (testOnly) {
+        flags |= 0x01;
+    }
+    if (chain === -1) {
+        flags |= 0x02;
+    }
+    return { bounceable, testOnly, chain, flags };
+}
 class TonTransport {
     transport;
     #lock = new teslabot_1.AsyncLock();
@@ -57,27 +72,7 @@ class TonTransport {
         // Check path
         validatePath(path);
         // Resolve flags
-        let bounceable = true;
-        let chain = 0;
-        let test = false;
-        let flags = 0x00;
-        if (opts && opts.bounceable !== undefined && !opts.bounceable) {
-            flags |= 0x01;
-            bounceable = false;
-        }
-        if (opts && opts.testOnly) {
-            flags |= 0x02;
-            test = true;
-        }
-        if (opts && opts.chain !== undefined) {
-            if (opts.chain !== 0 && opts.chain !== -1) {
-                throw Error('Invalid chain');
-            }
-            chain = opts.chain;
-            if (opts.chain === -1) {
-                flags |= 0x04;
-            }
-        }
+        const { bounceable, testOnly, chain } = processAddressFlags(opts);
         // Get public key
         let response = await this.#doRequest(INS_ADDRESS, 0x00, 0x00, pathElementsToBuffer(path.map((v) => v + 0x80000000)));
         if (response.length !== 32) {
@@ -86,33 +81,13 @@ class TonTransport {
         // Contract
         const contract = (0, getInit_1.getInit)(chain, response);
         const address = (0, ton_core_1.contractAddress)(chain, contract);
-        return { address: address.toString({ bounceable: bounceable, testOnly: test }), publicKey: response };
+        return { address: address.toString({ bounceable, testOnly }), publicKey: response };
     }
     async validateAddress(path, opts) {
         // Check path
         validatePath(path);
         // Resolve flags
-        let bounceable = true;
-        let chain = 0;
-        let test = false;
-        let flags = 0x00;
-        if (opts && opts.bounceable !== undefined && !opts.bounceable) {
-            flags |= 0x01;
-            bounceable = false;
-        }
-        if (opts && opts.testOnly) {
-            flags |= 0x02;
-            test = true;
-        }
-        if (opts && opts.chain !== undefined) {
-            if (opts.chain !== 0 && opts.chain !== -1) {
-                throw Error('Invalid chain');
-            }
-            chain = opts.chain;
-            if (opts.chain === -1) {
-                flags |= 0x04;
-            }
-        }
+        const { bounceable, testOnly, chain, flags } = processAddressFlags(opts);
         // Get public key
         let response = await this.#doRequest(INS_ADDRESS, 0x01, flags, pathElementsToBuffer(path.map((v) => v + 0x80000000)));
         if (response.length !== 32) {
@@ -121,34 +96,14 @@ class TonTransport {
         // Contract
         const contract = (0, getInit_1.getInit)(chain, response);
         const address = (0, ton_core_1.contractAddress)(chain, contract);
-        return { address: address.toString({ bounceable: bounceable, testOnly: test }), publicKey: response };
+        return { address: address.toString({ bounceable, testOnly }), publicKey: response };
     }
     async getAddressProof(path, params, opts) {
         // Check path
         validatePath(path);
         let publicKey = (await this.getAddress(path)).publicKey;
         // Resolve flags
-        let bounceable = true;
-        let chain = 0;
-        let test = false;
-        let flags = 0x00;
-        if (opts && opts.bounceable !== undefined && !opts.bounceable) {
-            flags |= 0x01;
-            bounceable = false;
-        }
-        if (opts && opts.testOnly) {
-            flags |= 0x02;
-            test = true;
-        }
-        if (opts && opts.chain !== undefined) {
-            if (opts.chain !== 0 && opts.chain !== -1) {
-                throw Error('Invalid chain');
-            }
-            chain = opts.chain;
-            if (opts.chain === -1) {
-                flags |= 0x04;
-            }
-        }
+        const { flags } = processAddressFlags(opts);
         const domainBuf = Buffer.from(params.domain, 'utf-8');
         const reqBuf = Buffer.concat([
             pathElementsToBuffer(path.map((v) => v + 0x80000000)),
@@ -166,6 +121,98 @@ class TonTransport {
         }
         return { signature, hash };
     }
+    async signData(path, req, opts) {
+        validatePath(path);
+        const publicKey = (await this.getAddress(path)).publicKey;
+        const timestamp = opts?.timestamp ?? Math.floor(Date.now() / 1000);
+        let schema;
+        let data;
+        let cell;
+        switch (req.type) {
+            case 'plaintext': {
+                schema = 0x754bf91b;
+                data = Buffer.from(req.text, 'ascii');
+                cell = (0, ton_core_1.beginCell)().storeStringTail(req.text).endCell();
+                break;
+            }
+            case 'app-data': {
+                if (req.address === undefined && req.domain === undefined) {
+                    throw new Error('At least one of `address` and `domain` must be set when using \'app-data\' request');
+                }
+                schema = 0x54b58535;
+                let b = (0, ton_core_1.beginCell)();
+                let dp = [];
+                if (req.address !== undefined) {
+                    b.storeBit(1);
+                    b.storeAddress(req.address);
+                    dp.push((0, ledgerWriter_1.writeUint8)(1), (0, ledgerWriter_1.writeAddress)(req.address));
+                }
+                else {
+                    b.storeBit(0);
+                    dp.push((0, ledgerWriter_1.writeUint8)(0));
+                }
+                if (req.domain !== undefined) {
+                    b.storeBit(1);
+                    let inner = (0, ton_core_1.beginCell)();
+                    req.domain.split('.').reverse().forEach(p => {
+                        inner.storeBuffer(Buffer.from(p, 'ascii'));
+                        inner.storeUint(0, 8);
+                    });
+                    b.storeRef(inner);
+                    const db = Buffer.from(req.domain, 'ascii');
+                    dp.push((0, ledgerWriter_1.writeUint8)(1), (0, ledgerWriter_1.writeUint8)(db.length), db);
+                }
+                else {
+                    b.storeBit(0);
+                    dp.push((0, ledgerWriter_1.writeUint8)(0));
+                }
+                b.storeRef(req.data);
+                dp.push((0, ledgerWriter_1.writeCellRef)(req.data));
+                if (req.ext !== undefined) {
+                    b.storeBit(1);
+                    b.storeRef(req.ext);
+                    dp.push((0, ledgerWriter_1.writeUint8)(1), (0, ledgerWriter_1.writeCellRef)(req.ext));
+                }
+                else {
+                    b.storeBit(0);
+                    dp.push((0, ledgerWriter_1.writeUint8)(0));
+                }
+                data = Buffer.concat(dp);
+                cell = b.endCell();
+                break;
+            }
+            default: {
+                throw new Error(`Sign data request type '${req.type}' not supported`);
+            }
+        }
+        const commonPart = Buffer.concat([
+            (0, ledgerWriter_1.writeUint32)(schema),
+            (0, ledgerWriter_1.writeUint64)(BigInt(timestamp)),
+        ]);
+        const pkg = Buffer.concat([
+            commonPart,
+            data,
+        ]);
+        await this.#doRequest(INS_SIGN_DATA, 0x00, 0x03, pathElementsToBuffer(path.map((v) => v + 0x80000000)));
+        const pkgCs = chunks(pkg, 255);
+        for (let i = 0; i < pkgCs.length - 1; i++) {
+            await this.#doRequest(INS_SIGN_DATA, 0x00, 0x02, pkgCs[i]);
+        }
+        const res = await this.#doRequest(INS_SIGN_DATA, 0x00, 0x00, pkgCs[pkgCs.length - 1]);
+        let signature = res.subarray(1, 1 + 64);
+        let hash = res.subarray(2 + 64, 2 + 64 + 32);
+        if (!hash.equals(cell.hash())) {
+            throw Error('Hash mismatch. Expected: ' + cell.hash().toString('hex') + ', got: ' + hash.toString('hex'));
+        }
+        if (!(0, ton_crypto_1.signVerify)(Buffer.concat([commonPart, hash]), signature, publicKey)) {
+            throw Error('Received signature is invalid');
+        }
+        return {
+            signature,
+            cell,
+            timestamp,
+        };
+    }
     signTransaction = async (path, transaction) => {
         // Check path
         validatePath(path);
@@ -304,12 +351,12 @@ class TonTransport {
         //
         // Send package
         //
-        await this.#doRequest(0x06, 0x00, 0x03, pathElementsToBuffer(path.map((v) => v + 0x80000000)));
+        await this.#doRequest(INS_SIGN_TX, 0x00, 0x03, pathElementsToBuffer(path.map((v) => v + 0x80000000)));
         const pkgCs = chunks(pkg, 255);
         for (let i = 0; i < pkgCs.length - 1; i++) {
-            await this.#doRequest(0x06, 0x00, 0x02, pkgCs[i]);
+            await this.#doRequest(INS_SIGN_TX, 0x00, 0x02, pkgCs[i]);
         }
-        let res = await this.#doRequest(0x06, 0x00, 0x00, pkgCs[pkgCs.length - 1]);
+        let res = await this.#doRequest(INS_SIGN_TX, 0x00, 0x00, pkgCs[pkgCs.length - 1]);
         //
         // Parse response
         //

package/dist/index.d.ts

@@ -1 +1 @@
-export { TonPayloadFormat, TonTransport } from './TonTransport';
+export { TonPayloadFormat, TonTransport, SignDataRequest } from './TonTransport';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ton-community/ton-ledger",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "repository": "https://github.com/ton-community/ton-ledger-ts",
   "author": "Steve Korshakov <steve@korshakov.com>",
   "license": "MIT",