Merge pull request #55 from BitGo/CT-698-eos

CT-698 Add EOS signing logic

Author: dannydeezy

app/sign.js

@@ -27,6 +27,7 @@ const utxoNetworks = {
 const coinDecimals = {
   btc: 8,
   eth: 18,
+  eos: 4,
   xrp: 6,
   bch: 8,
   bsv: 8,
@@ -36,6 +37,7 @@ const coinDecimals = {
   xlm: 7,
   tbtc: 8,
   teth: 18,
+  teos: 4,
   txrp: 6,
   tltc: 8,
   txlm: 7,
@@ -48,6 +50,9 @@ const coinDecimals = {
 const BCH_COINS = ['bch', 'tbch', 'bsv', 'tbsv'];
 const TEN = new BN(10);
 
+const EOS_MAINNET_CHAIN_ID = 'aca376f206b8fc25a6ed44dbdc66547c36c6c33e3a119ffbeaef943642f0e906';
+const EOS_TESTNET_CHAIN_ID = 'e70aaab8997e1dfce58fbfac80cbbb8fecec7b99cf982a9444273cbc64c41473';
+
 const confirmRecovery = function(backupKey, outputs, customMessage, skipConfirm) {
   console.log('Sign Recovery Transaction');
   console.log('=========================');
@@ -199,6 +204,49 @@ const handleSignEthereum = function(recoveryRequest, key, skipConfirm) {
   return transaction.serialize().toString('hex');
 };
 
+const handleSignEos = function(recoveryRequest, key, skipConfirm) {
+  const EosJs = require('eosjs');
+  const ecc = require('eosjs-ecc');
+  let chainId;
+  if (recoveryRequest.coin === 'eos') {
+    chainId = EOS_MAINNET_CHAIN_ID;
+  } else {
+    chainId = EOS_TESTNET_CHAIN_ID;
+  }
+
+  const sendableTxJsonString = getTransactionHexFromRequest(recoveryRequest);
+  const eosTx = JSON.parse(sendableTxJsonString);
+  const packed_trx = eosTx.packed_trx;
+
+  const { recipient, amount } = utils.deserializeEOSTransaction(EosJs, packed_trx);
+
+  const customMessage = recoveryRequest.custom ? recoveryRequest.custom.message : 'None';
+
+  const outputs = [{
+    address: recipient,
+    amount: new BN(amount)
+  }];
+
+  confirmRecovery(recoveryRequest.backupKey, outputs, customMessage, skipConfirm);
+
+  if (!key) {
+    console.log('Please enter the xprv of the wallet for signing: ');
+    key = prompt();
+  }
+
+  const backupKeyNode = getHDNodeAndVerify(key, recoveryRequest.backupKey);
+
+  const dataToSign = utils.getEOSSignatureData(packed_trx, chainId);
+  const signBuffer = Buffer.from(dataToSign, 'hex');
+  const privateKeyBuffer = backupKeyNode.keyPair.getPrivateKeyBuffer();
+  const signature = ecc.Signature.sign(signBuffer, privateKeyBuffer).toString();
+
+  eosTx.signatures.push(signature);
+
+  // EOS txHex is a stringified JSON containing the signatures array
+  return JSON.stringify(eosTx);
+};
+
 const handleSignXrp = function(recoveryRequest, key, skipConfirm) {
   const rippleLib = require('ripple-lib');
   const rippleApi = new rippleLib.RippleAPI();
@@ -403,6 +451,9 @@ const handleSign = function(args) {
         }
       }
       break;
+    case 'eos':
+      txHex = handleSignEos(recoveryRequest, key, args.confirm);
+      break;
     case 'xrp':
       txHex = handleSignXrp(recoveryRequest, key, args.confirm);
       break;
@@ -438,4 +489,4 @@ const handleSign = function(args) {
   return finalRecovery;
 };
 
-module.exports = { handleSign, handleSignUtxo, handleSignEthereum, handleSignXrp, handleSignXlm, handleSignErc20, parseKey };
+module.exports = { handleSign, handleSignUtxo, handleSignEthereum, handleSignXrp, handleSignXlm, handleSignErc20, handleSignEos, parseKey };

app/utils.js

@@ -193,3 +193,51 @@ exports.halfSignEthTransaction = function(basecoin, recoveryRequest, key) {
   }
   return outFile;
 }
+
+
+/**
+ * Deserialize an EOS transaction
+ * @param {ObjectConstructor} EosJs The EosJs class
+ * @param {String} serializedTransaction The EOS transaction returned from `serializeTransaction` above as hex string
+ * @return {Object} Deserialized transaction, including recipient and amount
+ */
+exports.deserializeEOSTransaction = function(EosJs, serializedTransaction) {
+  const eosClient = new EosJs({ });
+  const eosTxStruct = eosClient.fc.structs.transaction;
+  const serializedBuffer = Buffer.from(serializedTransaction, 'hex');
+
+  const transaction = EosJs.modules.Fcbuffer.fromBuffer(eosTxStruct, serializedBuffer);
+
+  // Get transfer action values
+  // Only support transactions with one action: transfer
+  if (transaction.actions.length !== 1) {
+    throw new Error(`invalid number of actions: ${transaction.actions.length}`);
+  }
+  const txAction = transaction.actions[0];
+  if (!txAction) {
+    throw new Error('missing transaction action');
+  }
+  if (txAction.name !== 'transfer') {
+    throw new Error(`invalid action: ${txAction.name}`);
+  }
+  const transferStruct = eosClient.fc.abiCache.abi('eosio.token').structs.transfer;
+  const serializedTransferDataBuffer = Buffer.from(txAction.data, 'hex');
+  const transferActionData = EosJs.modules.Fcbuffer.fromBuffer(transferStruct, serializedTransferDataBuffer);
+  transaction.address = transferActionData.to;
+  transaction.amount = transferActionData.quantity.split(' ')[0];;
+  return { recipient: transaction.address, amount: transaction.amount };
+};
+
+/**
+ * Get the data that actually has to be signed for the tx
+ * @param {Object} tx The serialized EOS transaction to get signature data for
+ * @return {String} The data that needs to be signed for this tx
+ */
+exports.getEOSSignatureData = function(tx, chainId) {
+  return Buffer.concat([
+    Buffer.from(chainId, 'hex'),              // The ChainID representing the chain that we are on
+    Buffer.from(tx, 'hex'),                   // The serialized unsigned tx
+    Buffer.from(new Uint8Array(32)),  // Some padding
+  ]).toString('hex');
+};
+

config.js

@@ -6,6 +6,8 @@ module.exports = {
     tbtc: 'xpub',
     eth: 'xpub',
     teth: 'xpub',
+    eos: 'xpub',
+    teos: 'xpub',
     erc: 'xpub',
     terc: 'xpub',
     ltc: 'xpub',

package.json

@@ -22,6 +22,8 @@
     "bitgo-utxo-lib": "^1.2.1",
     "body-parser": "^1.18.3",
     "dotenv": "^6.1.0",
+    "eosjs": "^16.0.9",
+    "eosjs-ecc": "^4.0.4",
     "ethereumjs-tx": "^1.3.7",
     "express": "^4.16.3",
     "jsrender": "^0.9.90",

test/sign.js

@@ -0,0 +1,6 @@
+{
+  "id": "27b5fe65c239efc9674c6ade77edbd00e5dc9c4d0f059866a7e388b072b57d1d",
+  "tx": "{\"compression\":\"none\",\"packed_trx\":\"d3ca235dbed650bc3a64000000000100a6823403ea3055000000572d3ccdcd01507551997772734c00000000a8ed323221507551997772734c9052d3d42ec9b071a08601000000000004454f53000000000000\",\"signatures\":[\"SIG_K1_JzpSv5pkpzuzg5FqYUAVsrEtPooVCDx5Ls3qkpyuSpsZozj6cMCxgz2jYuuqBoLBTRPet62QFoaVVJ6Rrh1YDp64yRMBBy\"]}",
+  "backupKey": "xpub661MyMwAqRbcEvM8SrtkWnXB9knYvwZP3FsSL8a5P1KPknFj4in2ne2arrzHAG3sUD7VxTDUfaxuPb78vnGVzaUBJMoo4pt2oYez6cgr46Y",
+  "coin": "teos"
+}