@alephium/ledger-app 0.3.0 → 0.4.0

package/dist/test/{speculos.test.js → wallet.test.js}

@@ -26,54 +26,59 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const hw_transport_node_speculos_1 = __importDefault(require("@ledgerhq/hw-transport-node-speculos"));
 const src_1 = __importStar(require("../src"));
-const node_fetch_1 = __importDefault(require("node-fetch"));
 const web3_1 = require("@alephium/web3");
 const web3_test_1 = require("@alephium/web3-test");
 const web3_wallet_1 = require("@alephium/web3-wallet");
-function sleep(ms) {
-    return new Promise((resolve) => setTimeout(resolve, ms));
-}
-async function pressButton(button) {
-    await sleep(500);
-    return (0, node_fetch_1.default)(`http://localhost:25000/button/${button}`, {
-        method: 'POST',
-        body: JSON.stringify({ action: 'press-and-release' })
-    });
-}
-function getRandomInt(min, max) {
-    min = Math.ceil(min);
-    max = Math.floor(max);
-    return Math.floor(Math.random() * (max - min) + min); // The maximum is exclusive and the minimum is inclusive
-}
-describe('sdk', () => {
-    const apduPort = 9999;
+const blakejs_1 = __importDefault(require("blakejs"));
+const utils_1 = require("./utils");
+describe('ledger wallet', () => {
     const nodeProvider = new web3_1.NodeProvider("http://127.0.0.1:22973");
     web3_1.web3.setCurrentNodeProvider(nodeProvider);
     let pathIndex;
     let path;
     beforeEach(() => {
-        pathIndex = getRandomInt(0, 1000000);
+        pathIndex = (0, utils_1.getRandomInt)(0, 1000000);
         path = `m/44'/1234'/0'/0/` + pathIndex;
     });
+    async function transferToAddress(address, amount = web3_1.ONE_ALPH * 10n) {
+        const balance0 = await getALPHBalance(address);
+        const fromAccount = await (0, web3_test_1.getSigner)();
+        const transferResult = await (0, web3_test_1.transfer)(fromAccount, address, web3_1.ALPH_TOKEN_ID, amount);
+        await (0, web3_1.waitForTxConfirmation)(transferResult.txId, 1, 1000);
+        const balance1 = await getALPHBalance(address);
+        expect(balance1 - balance0).toEqual(amount);
+    }
+    async function getALPHBalance(address) {
+        const balances = await nodeProvider.addresses.getAddressesAddressBalance(address);
+        return BigInt(balances.balance);
+    }
     it('should get version', async () => {
-        const transport = await hw_transport_node_speculos_1.default.open({ apduPort });
+        const transport = await (0, utils_1.createTransport)();
         const app = new src_1.default(transport);
         const version = await app.getVersion();
-        expect(version).toBe('0.2.0');
+        expect(version).toBe('0.4.0');
         await app.close();
     });
     it('should get public key', async () => {
-        const transport = await hw_transport_node_speculos_1.default.open({ apduPort });
+        const transport = await (0, utils_1.createTransport)();
         const app = new src_1.default(transport);
         const [account, hdIndex] = await app.getAccount(path);
         expect(hdIndex).toBe(pathIndex);
         console.log(account);
         await app.close();
     });
+    it('should get public key and confirm address', async () => {
+        const transport = await (0, utils_1.createTransport)();
+        const app = new src_1.default(transport);
+        (0, utils_1.approveAddress)();
+        const [account, hdIndex] = await app.getAccount(path, undefined, undefined, true);
+        expect(hdIndex).toBe(pathIndex);
+        console.log(account);
+        await app.close();
+    }, 30000);
     it('should get public key for group', async () => {
-        const transport = await hw_transport_node_speculos_1.default.open({ apduPort });
+        const transport = await (0, utils_1.createTransport)();
         const app = new src_1.default(transport);
         for (let group = 0; group < src_1.GROUP_NUM; group++) {
             const [account, hdIndex] = await app.getAccount(path, group);
@@ -84,33 +89,27 @@ describe('sdk', () => {
         await app.close();
     });
     it('should get public key for group for Schnorr signature', async () => {
-        const transport = await hw_transport_node_speculos_1.default.open({ apduPort });
+        const transport = await (0, utils_1.createTransport)();
         const app = new src_1.default(transport);
         for (let group = 0; group < src_1.GROUP_NUM; group++) {
             await expect(app.getAccount(path, group, 'bip340-schnorr')).rejects.toThrow('BIP340-Schnorr is not supported yet');
         }
         await app.close();
     });
-    async function transferToAddress(address, amount = web3_1.ONE_ALPH * 10n) {
-        const balance0 = await getALPHBalance(address);
-        const fromAccount = await (0, web3_test_1.getSigner)();
-        const transferResult = await (0, web3_test_1.transfer)(fromAccount, address, web3_1.ALPH_TOKEN_ID, amount);
-        await (0, web3_1.waitForTxConfirmation)(transferResult.txId, 1, 1000);
-        const balance1 = await getALPHBalance(address);
-        expect(balance1 - balance0).toEqual(amount);
-    }
-    async function getALPHBalance(address) {
-        const balances = await nodeProvider.addresses.getAddressesAddressBalance(address);
-        return BigInt(balances.balance);
-    }
-    async function clickAndApprove(times) {
-        for (let i = 0; i < times; i++) {
-            await pressButton('right');
-        }
-        await pressButton('both');
-    }
-    it('should transfer alph to p2pkh address', async () => {
-        const transport = await hw_transport_node_speculos_1.default.open({ apduPort });
+    it('should sign hash', async () => {
+        const transport = await (0, utils_1.createTransport)();
+        const app = new src_1.default(transport);
+        const [account] = await app.getAccount(path);
+        console.log(account);
+        const hash = Buffer.from(blakejs_1.default.blake2b(Buffer.from([0, 1, 2, 3, 4]), undefined, 32));
+        (0, utils_1.approveHash)();
+        const signature = await app.signHash(path, hash);
+        console.log(signature);
+        await app.close();
+        expect((0, web3_1.transactionVerifySignature)(hash.toString('hex'), account.publicKey, signature)).toBe(true);
+    }, 10000);
+    it('shoudl transfer alph to one address', async () => {
+        const transport = await (0, utils_1.createTransport)();
         const app = new src_1.default(transport);
         const [testAccount] = await app.getAccount(path);
         await transferToAddress(testAccount.address);
@@ -120,30 +119,40 @@ describe('sdk', () => {
                 {
                     address: '1BmVCLrjttchZMW7i6df7mTdCKzHpy38bgDbVL1GqV6P7',
                     attoAlphAmount: (web3_1.ONE_ALPH * 2n).toString(),
-                },
+                }
+            ]
+        });
+        (0, utils_1.approveTx)([utils_1.OutputType.Base]);
+        const signature = await app.signUnsignedTx(path, Buffer.from(buildTxResult.unsignedTx, 'hex'));
+        expect((0, web3_1.transactionVerifySignature)(buildTxResult.txId, testAccount.publicKey, signature)).toBe(true);
+        const submitResult = await nodeProvider.transactions.postTransactionsSubmit({
+            unsignedTx: buildTxResult.unsignedTx,
+            signature: signature
+        });
+        await (0, web3_1.waitForTxConfirmation)(submitResult.txId, 1, 1000);
+        const balance = await getALPHBalance(testAccount.address);
+        expect(balance < (web3_1.ONE_ALPH * 8n)).toEqual(true);
+        await app.close();
+    }, 120000);
+    it('should transfer alph to multiple addresses', async () => {
+        const transport = await (0, utils_1.createTransport)();
+        const app = new src_1.default(transport);
+        const [testAccount] = await app.getAccount(path);
+        await transferToAddress(testAccount.address);
+        const buildTxResult = await nodeProvider.transactions.postTransactionsBuild({
+            fromPublicKey: testAccount.publicKey,
+            destinations: [
                 {
                     address: '1BmVCLrjttchZMW7i6df7mTdCKzHpy38bgDbVL1GqV6P7',
+                    attoAlphAmount: (web3_1.ONE_ALPH * 2n).toString(),
+                },
+                {
+                    address: '1F1fu6GjuN9yUVRFVcgQKWwiTg8RMzKFv1BZFDwFcfWJq',
                     attoAlphAmount: (web3_1.ONE_ALPH * 3n).toString(),
                 },
             ]
         });
-        function approve(index) {
-            if (index >= 7)
-                return;
-            if (index >= 3) { // outputs and signature
-                setTimeout(async () => {
-                    await clickAndApprove(6);
-                    approve(index + 1);
-                }, 1000);
-            }
-            else {
-                setTimeout(async () => {
-                    await clickAndApprove(3);
-                    approve(index + 1);
-                }, 1000);
-            }
-        }
-        approve(0);
+        (0, utils_1.approveTx)(Array(2).fill(utils_1.OutputType.Base));
         const signature = await app.signUnsignedTx(path, Buffer.from(buildTxResult.unsignedTx, 'hex'));
         expect((0, web3_1.transactionVerifySignature)(buildTxResult.txId, testAccount.publicKey, signature)).toBe(true);
         const submitResult = await nodeProvider.transactions.postTransactionsSubmit({
@@ -156,7 +165,7 @@ describe('sdk', () => {
         await app.close();
     }, 120000);
     it('should transfer alph to multisig address', async () => {
-        const transport = await hw_transport_node_speculos_1.default.open({ apduPort });
+        const transport = await (0, utils_1.createTransport)();
         const app = new src_1.default(transport);
         const [testAccount] = await app.getAccount(path);
         await transferToAddress(testAccount.address);
@@ -167,36 +176,10 @@ describe('sdk', () => {
                 {
                     address: multiSigAddress,
                     attoAlphAmount: (web3_1.ONE_ALPH * 2n).toString(),
-                },
-                {
-                    address: multiSigAddress,
-                    attoAlphAmount: (web3_1.ONE_ALPH * 3n).toString(),
-                },
+                }
             ]
         });
-        function approve(index) {
-            if (index >= 7)
-                return;
-            if (index == 3 || index == 4) { // multi-sig outputs
-                setTimeout(async () => {
-                    await clickAndApprove(11);
-                    approve(index + 1);
-                }, 1000);
-            }
-            else if (index > 4) { // change output and signature
-                setTimeout(async () => {
-                    await clickAndApprove(6);
-                    approve(index + 1);
-                }, 1000);
-            }
-            else {
-                setTimeout(async () => {
-                    await clickAndApprove(3);
-                    approve(index + 1);
-                }, 1000);
-            }
-        }
-        approve(0);
+        (0, utils_1.approveTx)([utils_1.OutputType.Multisig]);
         const signature = await app.signUnsignedTx(path, Buffer.from(buildTxResult.unsignedTx, 'hex'));
         expect((0, web3_1.transactionVerifySignature)(buildTxResult.txId, testAccount.publicKey, signature)).toBe(true);
         const submitResult = await nodeProvider.transactions.postTransactionsSubmit({
@@ -205,11 +188,11 @@ describe('sdk', () => {
         });
         await (0, web3_1.waitForTxConfirmation)(submitResult.txId, 1, 1000);
         const balance1 = await getALPHBalance(testAccount.address);
-        expect(balance1 < (web3_1.ONE_ALPH * 5n)).toEqual(true);
+        expect(balance1 < (web3_1.ONE_ALPH * 8n)).toEqual(true);
         await app.close();
     }, 120000);
     it('should transfer token to multisig address', async () => {
-        const transport = await hw_transport_node_speculos_1.default.open({ apduPort });
+        const transport = await (0, utils_1.createTransport)();
         const app = new src_1.default(transport);
         const [testAccount] = await app.getAccount(path);
         await transferToAddress(testAccount.address);
@@ -230,41 +213,7 @@ describe('sdk', () => {
                 }
             ]
         });
-        function approve(index) {
-            if (index > 7)
-                return;
-            if (index <= 2) {
-                setTimeout(async () => {
-                    await clickAndApprove(3);
-                    approve(index + 1);
-                }, 1000);
-            }
-            else if (index === 3) { // multi-sig token output
-                setTimeout(async () => {
-                    await clickAndApprove(17);
-                    approve(index + 1);
-                }, 1000);
-            }
-            else if (index === 4) { // multi-sig alph output
-                setTimeout(async () => {
-                    await clickAndApprove(11);
-                    approve(index + 1);
-                }, 1000);
-            }
-            else if (index === 5) { // token change output
-                setTimeout(async () => {
-                    await clickAndApprove(12);
-                    approve(index + 1);
-                }, 1000);
-            }
-            else if (index >= 6) { // alph change output and signature
-                setTimeout(async () => {
-                    await clickAndApprove(6);
-                    approve(index + 1);
-                }, 1000);
-            }
-        }
-        approve(0);
+        (0, utils_1.approveTx)([utils_1.OutputType.MultisigAndToken, utils_1.OutputType.Multisig]);
         const signature = await app.signUnsignedTx(path, Buffer.from(buildTxResult.unsignedTx, 'hex'));
         expect((0, web3_1.transactionVerifySignature)(buildTxResult.txId, testAccount.publicKey, signature)).toBe(true);
         const submitResult = await nodeProvider.transactions.postTransactionsSubmit({
@@ -282,7 +231,7 @@ describe('sdk', () => {
         await app.close();
     }, 120000);
     it('should transfer from multiple inputs', async () => {
-        const transport = await hw_transport_node_speculos_1.default.open({ apduPort });
+        const transport = await (0, utils_1.createTransport)();
         const app = new src_1.default(transport);
         const [testAccount] = await app.getAccount(path);
         for (let i = 0; i < 20; i += 1) {
@@ -297,23 +246,7 @@ describe('sdk', () => {
                 }
             ]
         });
-        function approve(index) {
-            if (index >= 6)
-                return;
-            if (index >= 3) { // outputs and signature
-                setTimeout(async () => {
-                    await clickAndApprove(6);
-                    approve(index + 1);
-                }, 1000);
-            }
-            else {
-                setTimeout(async () => {
-                    await clickAndApprove(3);
-                    approve(index + 1);
-                }, 1000);
-            }
-        }
-        approve(0);
+        (0, utils_1.approveTx)([utils_1.OutputType.Base]);
         const signature = await app.signUnsignedTx(path, Buffer.from(buildTxResult.unsignedTx, 'hex'));
         expect((0, web3_1.transactionVerifySignature)(buildTxResult.txId, testAccount.publicKey, signature)).toBe(true);
         const submitResult = await nodeProvider.transactions.postTransactionsSubmit({
@@ -335,8 +268,8 @@ describe('sdk', () => {
         const unlockScript = '02' + `0101000000000458144020${account.publicKey}8685` + '00';
         return { account, unlockScript };
     }
-    it('should transfer from different input addresses', async () => {
-        const transport = await hw_transport_node_speculos_1.default.open({ apduPort });
+    it('should test external inputs', async () => {
+        const transport = await (0, utils_1.createTransport)();
         const app = new src_1.default(transport);
         const [testAccount] = await app.getAccount(path);
         const { account: newAccount, unlockScript: unlockScript0 } = getAccount(testAccount.group);
@@ -369,7 +302,7 @@ describe('sdk', () => {
                     hint: 0,
                     key: '',
                     attoAlphAmount: (web3_1.ONE_ALPH * 3n).toString(),
-                    address: testAccount.address,
+                    address: newAccount.address,
                     tokens: [],
                     lockTime: 0,
                     message: ''
@@ -380,29 +313,7 @@ describe('sdk', () => {
             signerAddress: newAccount.address,
             unsignedTx: (0, web3_1.binToHex)(txBytes)
         });
-        function approve(index) {
-            if (index > 6)
-                return;
-            if (index === 3 || index === 4) { // inputs
-                setTimeout(async () => {
-                    await clickAndApprove(5);
-                    approve(index + 1);
-                }, 1000);
-            }
-            else if (index >= 5) { // outputs and tx id
-                setTimeout(async () => {
-                    await clickAndApprove(6);
-                    approve(index + 1);
-                }, 1000);
-            }
-            else {
-                setTimeout(async () => {
-                    await clickAndApprove(3);
-                    approve(index + 1);
-                }, 1000);
-            }
-        }
-        approve(0);
+        (0, utils_1.approveTx)([utils_1.OutputType.Base], true);
         const signature1 = await app.signUnsignedTx(path, Buffer.from(txBytes));
         expect((0, web3_1.transactionVerifySignature)(signResult0.txId, testAccount.publicKey, signature1)).toBe(true);
         const submitResult = await nodeProvider.multisig.postMultisigSubmit({
@@ -410,8 +321,63 @@ describe('sdk', () => {
             signatures: [signResult0.signature, signature1]
         });
         await (0, web3_1.waitForTxConfirmation)(submitResult.txId, 1, 1000);
-        const balance = await getALPHBalance(testAccount.address);
+        const balance = await getALPHBalance(newAccount.address);
         expect(balance).toEqual(web3_1.ONE_ALPH * 3n);
         await app.close();
     }, 120000);
+    it('should test self transfer tx', async () => {
+        const transport = await (0, utils_1.createTransport)();
+        const app = new src_1.default(transport);
+        const [testAccount] = await app.getAccount(path);
+        await transferToAddress(testAccount.address);
+        const buildTxResult = await nodeProvider.transactions.postTransactionsBuild({
+            fromPublicKey: testAccount.publicKey,
+            destinations: [
+                {
+                    address: testAccount.address,
+                    attoAlphAmount: (web3_1.ONE_ALPH * 2n).toString(),
+                }
+            ]
+        });
+        (0, utils_1.approveTx)([]);
+        const signature = await app.signUnsignedTx(path, Buffer.from(buildTxResult.unsignedTx, 'hex'));
+        expect((0, web3_1.transactionVerifySignature)(buildTxResult.txId, testAccount.publicKey, signature)).toBe(true);
+        const submitResult = await nodeProvider.transactions.postTransactionsSubmit({
+            unsignedTx: buildTxResult.unsignedTx,
+            signature: signature
+        });
+        await (0, web3_1.waitForTxConfirmation)(submitResult.txId, 1, 1000);
+        const balance = await getALPHBalance(testAccount.address);
+        expect(balance > (web3_1.ONE_ALPH * 9n)).toEqual(true);
+        await app.close();
+    }, 12000);
+    it('should test script execution tx', async () => {
+        const transport = await (0, utils_1.createTransport)();
+        const app = new src_1.default(transport);
+        const [testAccount] = await app.getAccount(path);
+        await transferToAddress(testAccount.address);
+        const buildTxResult = await nodeProvider.contracts.postContractsUnsignedTxDeployContract({
+            fromPublicKey: testAccount.publicKey,
+            bytecode: '00010c010000000002d38d0b3636020000'
+        });
+        setTimeout(() => (0, utils_1.skipBlindSigningWarning)(), 1000);
+        await expect(app.signUnsignedTx(path, Buffer.from(buildTxResult.unsignedTx, 'hex'))).rejects.toThrow();
+        await (0, utils_1.enableBlindSigning)();
+        if ((0, utils_1.needToAutoApprove)()) {
+            (0, utils_1.staxFlexApproveOnce)().then(() => (0, utils_1.approveTx)([]));
+        }
+        else {
+            // waiting for blind signing setting to be enabled
+            await (0, web3_1.sleep)(20000);
+        }
+        const signature = await app.signUnsignedTx(path, Buffer.from(buildTxResult.unsignedTx, 'hex'));
+        const submitResult = await nodeProvider.transactions.postTransactionsSubmit({
+            unsignedTx: buildTxResult.unsignedTx,
+            signature: signature
+        });
+        await (0, web3_1.waitForTxConfirmation)(submitResult.txId, 1, 1000);
+        const details = await nodeProvider.transactions.getTransactionsDetailsTxid(submitResult.txId);
+        expect(details.scriptExecutionOk).toEqual(true);
+        await app.close();
+    }, 120000);
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/ledger-app",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "license": "GPL",
   "types": "dist/src/index.d.ts",
   "exports": {
@@ -12,7 +12,8 @@
     "clean:windows": "node -e \"if (process.platform === 'win32') process.exit(1)\" || , if exist dist rmdir /Q /S dist",
     "lint": "eslint . --ext ts",
     "lint:fix": "eslint . --fix --ext ts",
-    "test": "jest -i --config ./jest-config.json",
+    "speculos-test": "BACKEND=speculos jest -i --config ./jest-config.json",
+    "device-test": "BACKEND=device jest -i --config ./jest-config.json",
     "pub": "npm run build && npm publish --access public"
   },
   "prettier": {
@@ -26,15 +27,14 @@
   },
   "dependencies": {
     "@alephium/web3": "^1.2.0",
-    "@alephium/web3-wallet": "^1.2.0",
-    "@ledgerhq/hw-transport": "^6.31.0"
+    "@ledgerhq/hw-transport": "6.31.0"
   },
   "devDependencies": {
     "@alephium/web3-test": "^1.2.0",
+    "@alephium/web3-wallet": "^1.2.0",
     "@alephium/cli": "^1.2.0",
-    "@ledgerhq/hw-transport-node-hid": "^6.29.1",
-    "@ledgerhq/hw-transport-node-speculos": "^6.29.0",
-    "@ledgerhq/logs": "^6.10.1",
+    "@ledgerhq/hw-transport-node-hid": "6.29.1",
+    "@ledgerhq/hw-transport-node-speculos": "6.29.0",
     "@types/elliptic": "^6.4.13",
     "@types/jest": "^27.5.1",
     "@types/node": "^20.8.10",

package/src/index.ts

@@ -9,7 +9,8 @@ export const CLA = 0x80
 export enum INS {
   GET_VERSION = 0x00,
   GET_PUBLIC_KEY = 0x01,
-  SIGN_TX = 0x02
+  SIGN_HASH = 0x02,
+  SIGN_TX = 0x03
 }
 
 export const GROUP_NUM = 4
@@ -32,8 +33,7 @@ export default class AlephiumApp {
     return `${response[0]}.${response[1]}.${response[2]}`
   }
 
-  // TODO: make address display optional
-  async getAccount(startPath: string, targetGroup?: number, keyType?: KeyType): Promise<readonly [Account, number]> {
+  async getAccount(startPath: string, targetGroup?: number, keyType?: KeyType, display = false): Promise<readonly [Account, number]> {
     if ((targetGroup ?? 0) >= GROUP_NUM) {
       throw Error(`Invalid targetGroup: ${targetGroup}`)
     }
@@ -44,7 +44,8 @@ export default class AlephiumApp {
 
     const p1 = targetGroup === undefined ? 0x00 : GROUP_NUM
     const p2 = targetGroup === undefined ? 0x00 : targetGroup
-    const response = await this.transport.send(CLA, INS.GET_PUBLIC_KEY, p1, p2, serde.serializePath(startPath))
+    const payload = Buffer.concat([serde.serializePath(startPath), Buffer.from([display ? 1 : 0])]);
+    const response = await this.transport.send(CLA, INS.GET_PUBLIC_KEY, p1, p2, payload)
     const publicKey = ec.keyFromPublic(response.slice(0, 65)).getPublic(true, 'hex')
     const address = addressFromPublicKey(publicKey)
     const group = groupOfAddress(address)
@@ -53,6 +54,19 @@ export default class AlephiumApp {
     return [{ publicKey: publicKey, address: address, group: group, keyType: keyType ?? 'default' }, hdIndex] as const
   }
 
+  async signHash(path: string, hash: Buffer): Promise<string> {
+    if (hash.length !== HASH_LEN) {
+      throw new Error('Invalid hash length')
+    }
+
+    const data = Buffer.concat([serde.serializePath(path), hash])
+    console.log(`data ${data.length}`)
+    const response = await this.transport.send(CLA, INS.SIGN_HASH, 0x00, 0x00, data, [StatusCodes.OK])
+    console.log(`response ${response.length} - ${response.toString('hex')}`)
+
+    return decodeSignature(response)
+  }
+
   async signUnsignedTx(path: string, unsignedTx: Buffer): Promise<string> {
     console.log(`unsigned tx size: ${unsignedTx.length}`)
     const encodedPath = serde.serializePath(path)