Add working ledger signature and broadcast implementation

Author: Fabrice Bascoulergue

jest.config.js

@@ -13,5 +13,5 @@ module.exports = {
             tsconfig: 'tsconfig.spec.json',
         },
     },
-    testTimeout: 30000,
+    testTimeout: 60000,
 };

src/client/LumClient.ts

@@ -250,7 +250,7 @@ export class LumClient {
         if (!account) {
             throw new Error('Account not found');
         }
-        const signDoc = LumUtils.generateSignDoc(doc, wallet.getPublicKey());
+        const signDoc = LumUtils.generateSignDoc(doc, wallet.getPublicKey(), wallet.signingMode());
         const signature = await wallet.signTransaction(doc);
         return LumUtils.generateTxBytes(signDoc, signature);
     };

src/index.ts

@@ -2,8 +2,8 @@ import * as LumUtils from './utils';
 import * as LumConstants from './constants';
 import * as LumTypes from './types';
 import * as LumMessages from './messages';
-import { LumRegistry } from './registry';
+import { LumRegistry, LumAminoRegistry } from './registry';
 import { LumWallet, LumWalletFactory } from './wallet';
 import { LumClient } from './client';
 
-export { LumWallet, LumWalletFactory, LumClient, LumTypes, LumUtils, LumConstants, LumMessages, LumRegistry };
+export { LumWallet, LumWalletFactory, LumClient, LumTypes, LumUtils, LumConstants, LumMessages, LumRegistry, LumAminoRegistry };

src/registry/index.ts

@@ -1,4 +1,5 @@
 import { Registry, GeneratedType } from '@cosmjs/proto-signing';
+import { AminoTypes } from '@cosmjs/stargate';
 
 import { Tx } from '../codec/cosmos/tx/v1beta1/tx';
 import { PubKey } from '../codec/cosmos/crypto/secp256k1/keys';
@@ -26,5 +27,5 @@ class ExtendedRegistry extends Registry {
         return Tx.decode(tx);
     };
 }
-
+export const LumAminoRegistry = new AminoTypes();
 export const LumRegistry = new ExtendedRegistry(registryTypes);

src/utils/transactions.ts

@@ -4,6 +4,7 @@ import { Secp256k1, Secp256k1Signature } from '@cosmjs/crypto';
 import { makeAuthInfoBytes, makeSignBytes } from '@cosmjs/proto-signing';
 
 import { TxRaw } from '../codec/cosmos/tx/v1beta1/tx';
+import { SignMode } from '../codec/cosmos/tx/signing/v1beta1/signing';
 
 import { sha256 } from './encoding';
 import { Fee, Doc, SignDoc } from '../types';
@@ -17,19 +18,20 @@ import { LumRegistry } from '../registry';
  * @param fee requested fee
  * @param sequence account sequence number
  */
-export const generateAuthInfoBytes = (publicKey: Uint8Array, fee: Fee, sequence: number): Uint8Array => {
+export const generateAuthInfoBytes = (publicKey: Uint8Array, fee: Fee, sequence: number, signMode: SignMode): Uint8Array => {
     const pubkeyAny = publicKeyToProto(publicKey);
     const gasLimit = Int53.fromString(fee.gas).toNumber();
-    return makeAuthInfoBytes([pubkeyAny], fee.amount, gasLimit, sequence);
+    return makeAuthInfoBytes([pubkeyAny], fee.amount, gasLimit, sequence, signMode);
 };
 
 /**
  * Generate transaction doc to be signed
  *
  * @param doc document to create the sign version
  * @param publicKey public key used for signature
+ * @param signMode signing mode for the transaction
  */
-export const generateSignDoc = (doc: Doc, publicKey: Uint8Array): SignDoc => {
+export const generateSignDoc = (doc: Doc, publicKey: Uint8Array, signMode: SignMode): SignDoc => {
     const txBody = {
         messages: doc.messages,
         memo: doc.memo,
@@ -41,7 +43,7 @@ export const generateSignDoc = (doc: Doc, publicKey: Uint8Array): SignDoc => {
 
     return {
         bodyBytes,
-        authInfoBytes: generateAuthInfoBytes(publicKey, doc.fee, doc.sequence),
+        authInfoBytes: generateAuthInfoBytes(publicKey, doc.fee, doc.sequence, signMode),
         chainId: doc.chainId,
         accountNumber: Long.fromNumber(doc.accountNumber),
     };

src/wallet/LumLedgerWallet.ts

@@ -1,7 +1,9 @@
 import Transport from '@ledgerhq/hw-transport';
 import Cosmos from '@ledgerhq/hw-app-cosmos';
+import { ExtendedSecp256k1Signature } from '@cosmjs/crypto';
 
-import { LumUtils, LumTypes } from '..';
+import { SignMode } from '../codec/cosmos/tx/signing/v1beta1/signing';
+import { LumUtils, LumTypes, LumAminoRegistry } from '..';
 import { LumWallet } from '.';
 
 export class LumLedgerWallet extends LumWallet {
@@ -13,6 +15,10 @@ export class LumLedgerWallet extends LumWallet {
         this.cosmosApp = new Cosmos(transport, 'CSM'); // TODO: CSM identifier should either be LUM or dynamic depending on our ledger implementation
     }
 
+    signingMode = (): SignMode => {
+        return SignMode.SIGN_MODE_LEGACY_AMINO_JSON;
+    };
+
     canChangeAccount = () => {
         return true;
     };
@@ -37,17 +43,18 @@ export class LumLedgerWallet extends LumWallet {
         // sign call: https://github.com/LedgerHQ/ledgerjs/blob/master/packages/hw-app-cosmos/src/Cosmos.js
         // Expected tx format: https://github.com/cosmos/ledger-cosmos/blob/master/docs/TXSPEC.md
         const msg = {
-            'account_number': doc.accountNumber,
+            'account_number': doc.accountNumber.toString(),
             'chain_id': doc.chainId,
             'fee': doc.fee,
             'memo': doc.memo,
-            'msgs': doc.messages,
-            'sequence': doc.sequence,
+            'msgs': doc.messages.map((msg) => LumAminoRegistry.toAmino(msg)),
+            'sequence': doc.sequence.toString(),
         };
         const { signature, return_code } = await this.cosmosApp.sign(this.hdPath, JSON.stringify(LumUtils.sortJSON(msg)));
         if (!signature || return_code === 0) {
             throw new Error(`Failed to sign message: error code ${return_code}`);
         }
-        return new Uint8Array(signature);
+        const sig = ExtendedSecp256k1Signature.fromDer(signature);
+        return new Uint8Array([...sig.r(32), ...sig.s(32)]);
     };
 }

src/wallet/LumPaperWallet.ts

@@ -1,3 +1,4 @@
+import { SignMode } from '../codec/cosmos/tx/signing/v1beta1/signing';
 import { LumUtils, LumConstants, LumTypes } from '..';
 import { LumWallet } from '.';
 
@@ -21,6 +22,10 @@ export class LumPaperWallet extends LumWallet {
         }
     }
 
+    signingMode = (): SignMode => {
+        return SignMode.SIGN_MODE_DIRECT;
+    };
+
     canChangeAccount = (): boolean => {
         return !!this.mnemonic;
     };
@@ -43,7 +48,7 @@ export class LumPaperWallet extends LumWallet {
         if (!this.privateKey || !this.publicKey) {
             throw new Error('No account selected.');
         }
-        const signDoc = LumUtils.generateSignDoc(doc, this.getPublicKey());
+        const signDoc = LumUtils.generateSignDoc(doc, this.getPublicKey(), this.signingMode());
         const signBytes = LumUtils.generateSignDocBytes(signDoc);
         const hashedMessage = LumUtils.sha256(signBytes);
         const signature = await LumUtils.generateSignature(hashedMessage, this.privateKey);

src/wallet/LumWallet.ts

@@ -1,3 +1,4 @@
+import { SignMode } from '../codec/cosmos/tx/signing/v1beta1/signing';
 import { LumTypes } from '..';
 
 export abstract class LumWallet {
@@ -30,6 +31,11 @@ export abstract class LumWallet {
         return this.publicKey;
     };
 
+    /**
+     * Gets the wallet signin mode
+     */
+    abstract signingMode(): SignMode;
+
     /**
      * Whether or not the wallet support changing account
      * Basically only wallet initialized using a private key should not be able to do so

tests/ledger.test.ts

@@ -13,21 +13,24 @@ describe('Ledger', () => {
         await expect(clt.disconnect()).resolves.toBeTruthy();
     });
 
-    it('Should be able to connect to ledger hardware wallet', async () => {
-        // WIP - manual testing using ledger device
+    it('Manual signature must work', async () => {
+        // Manual testing using ledger device
+        // Ledger device must be unlocked and Cosmos app opened prior to running those tests
         // const transport = await TransportNodeHid.create();
         // const w1 = await LumWalletFactory.fromLedgerTransport(transport, `m/44'/118'/0'/0/0`, 'lum');
+        // expect(w1).toBeTruthy();
         // const acc = await clt.getAccount(w1.getAddress());
         // expect(acc).toBeTruthy();
         // const balance = await clt.getBalance(acc.address, 'lum');
         // expect(parseInt(balance.amount)).toBeGreaterThan(0);
-        // TODO: requires to fixe the ledger signing implementation
+
         // const chainId = await clt.getChainId();
-        // const sendMsg = LumMessages.BuildMsgSend(w1.getAddress(), 'lum1ty3meqzqxq7vkdyp7l7znzvn0t50w92uf6h4px', [{ denom: 'lum', amount: '3' }]);
+        // const sendMsg = LumMessages.BuildMsgSend(w1.getAddress(), 'lum1lsagfzrm4gz28he4wunt63sts5xzmczwjttsr9', [{ denom: 'lum', amount: '3' }]);
         // const fee = {
         //     amount: [{ denom: LumConstants.LumDenom, amount: '1' }],
         //     gas: '100000',
         // };
+
         // const doc = {
         //     accountNumber: acc.accountNumber,
         //     chainId,
@@ -36,6 +39,7 @@ describe('Ledger', () => {
         //     messages: [sendMsg],
         //     sequence: acc.sequence,
         // };
+
         // const res = await clt.signAndBroadcastTx(w1, doc);
         // expect(LumUtils.broadcastTxCommitSuccess(res)).toBeTruthy();
     });