better r,s & v handling when using hsm for signing

Author: mauri-rsk

federator/src/lib/HSM.js

@@ -1,20 +1,17 @@
 const net = require('net');
-const utils = require('./utils');
 
-const payloadBuilder =
-    (
-        command,
-        keyId,
-        txnHash
-    ) => `{"command":"${command}","keyId":"${keyId}","message":{"hash":"${txnHash}"},"version":2}`;
+function hsmPayloadBuilder(command, keyId, txnHash) {
+    return `{"command":"${command}","keyId":"${keyId}","message":{"hash":"${txnHash}"},"version":2}`;
+}
 
 module.exports = class HSM {
     constructor({
         host = '127.0.0.1',
         port = 6000,
-    }) {
+    }, logger) {
         this.host = host;
         this.port = port;
+        this.logger = logger;
         this.client = null;
     }
 
@@ -36,7 +33,7 @@ module.exports = class HSM {
     }
 
     send(msgToSign = '') {
-        const payload = utils.hsmPayloadBuilder(`sign`, `m/44'/137'/0'/0/0`, msgToSign);
+        const payload = hsmPayloadBuilder(`sign`, `m/44'/137'/0'/0/0`, msgToSign);
         return this.client.write(`${payload}\n`);
     }
 
@@ -46,7 +43,8 @@ module.exports = class HSM {
             this.send(msgToSign);
             return this.receive();
         } catch(err) {
-            console.log(`HSM (connectSendAndReceive)`, err);
+            this.logger.error(`HSM (connectSendAndReceive)`, err);
+            throw err;
         }
     }
 }

federator/src/lib/TransactionSender.js

@@ -16,7 +16,7 @@ module.exports = class TransactionSender {
         this.hsm = new HSM({
             port: config.hsmPort,
             host: config.hsmHost
-        })
+        }, this.logger);
     }
 
     async getNonce(address) {
@@ -135,26 +135,22 @@ module.exports = class TransactionSender {
         if(!useHSM) {
             tx.sign(utils.hexStringToBuffer(privateKey));
         } else {
-            const txHash = tx.hash(false).toString();
-            const { 
+            const txHash = tx.hash(false).toString('hex');
+            const {
                 errorcode,
                 signature: {
                     r,
                     s
-                }
+                } = { r: '0x0', s: '0x0' }
             } = JSON.parse(await this.hsm.connectSendAndReceive(txHash));
 
             if(errorcode != 0) {
                 throw new Error(`error while signing txn with HSM`)
             }
-            
-            tx = {
-                ...tx,
-                r,
-                s,
-                v: this.getChainId() * 2 + 8
-            }
-            
+
+            tx.r = Buffer.from(r, 'hex');
+            tx.s = Buffer.from(s, 'hex');
+            tx.v = Buffer.from((this.getChainId() * 2 + 8).toString());
         }
         return tx;
     }

federator/src/lib/utils.js

@@ -176,9 +176,7 @@ async function evm_mine(iterations, web3Instance = null) {
         await asyncMine(web3Instance);
     };
 };
-function hsmPayloadBuilder(command, keyId, txnHash) {
-    return `{"command":"${command}","keyId":"${keyId}","message":{"hash":"${txnHash}"},"version":2}`;
-}
+
 
 module.exports = {
     asyncMine,
@@ -197,5 +195,4 @@ module.exports = {
     retry,
     retry3Times,
     getHeartbeatPollingInterval,
-    hsmPayloadBuilder
 }

federator/test/TransactionSender.test.js

@@ -74,4 +74,40 @@ describe('TransactionSender module tests', () => {
         expect(result).toEqual(expectedAddr.toLocaleLowerCase());
     });
 
-});
+    it('should sign the same with HSM and web3', async () => {
+        const rawTx = {
+          chainId: 5777,
+          gasPrice: '0x6fc23ac00',
+          value: '0x0',
+          to: '0x557b77f7B280006f7732dCc123C3A966F5Fe1372',
+          data: '0x7ff4657e000000000000000000000000de451f57d061b915525736937d0f5d24c551edd1000000000000000000000000000000000000000000000000000000000000004000000000000000000000000013263f73dcbe9b123a9ea32c13040b2becfe1e5c00000000000000000000000013263f73dcbe9b123a9ea32c13040b2becfe1e5c000000000000000000000000000000000000000000000000125195019f840000157f354383710432cdc131e73815a179a4e858ea304e4916b0f4d1db6553a7a70612db9f2ee9b8d7078e8f00338f600080ebc2a1e27f39376f54f0f6d7fb73750000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000001200000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000014000000000000000000000000000000000000000000000000000000000000000044d41494e00000000000000000000000000000000000000000000000000000000',
+          from: '0x57093C0C2aFEACaF7D677356c3eAC3E99933F7C0',
+          nonce: '0x49',
+          r: 0,
+          s: 0,
+          gas: '0x284d8'
+        }
+
+        const pk  = `3f28f888373e9ad1651a1227a5efdc0d7ea55bce6de3b5448de56c8588c6bd4d`;
+        const pk2 = `dfac7a2bfe2cd7f7fc8caffd65995300eb0e1a652502147da8d7a9e5bce16ac2`;
+        const from = `0x3444f14CbC7081ADEd7203E32E65304D17fe3bdA`;
+        const sender = new TransactionSender(web3Mock, logger, {
+          hsmPort: 6000,
+          hsmHost: '127.0.0.1'
+        });
+
+        const signedRawTransaction = await sender.signRawTransaction(rawTx, pk2, false);
+        const r = signedRawTransaction.r.toString('hex');
+        const s = signedRawTransaction.s.toString('hex');
+        const v = signedRawTransaction.v.toString('hex');
+
+        const signedHsmRawTransaction = await sender.signRawTransaction(rawTx, pk2, true);
+        const rHSM = signedHsmRawTransaction.r.toString('hex');
+        const sHSM = signedHsmRawTransaction.s.toString('hex');
+        const vHSM = signedHsmRawTransaction.v.toString('hex');
+
+        expect(rHSM).toEqual(r);
+        expect(sHSM).toEqual(s);
+    });
+
+});