feat(abstract-eth): support txn bulding for v4 wallet on eth chain

CODEOWNERS

@@ -31,6 +31,7 @@
 /modules/account-lib/ @BitGo/ethalt-team
 /modules/sdk-coin-celo/ @BitGo/ethalt-team
 /modules/sdk-coin-etc/ @BitGo/ethalt-team
+/modules/abstract-eth/ @BitGo/ethalt-team
 /modules/sdk-coin-eth/ @BitGo/ethalt-team
 /modules/sdk-coin-eth2/ @BitGo/ethalt-team
 /modules/sdk-coin-rbtc/ @BitGo/ethalt-team

modules/abstract-eth/src/lib/transactionBuilder.ts

@@ -626,6 +626,7 @@ export abstract class TransactionBuilder extends BaseTransactionBuilder {
       throw new BuildTransactionError('Missing transfer information');
     }
     const chainId = this._common.chainIdBN().toString();
+    this._transfer.walletVersion(this._walletVersion);
     // This change is made to support new contracts with different encoding type
     return this._transfer.signAndBuild(chainId, this.coinUsesNonPackedEncodingForTxData());
   }

modules/abstract-eth/src/lib/transferBuilder.ts

@@ -20,6 +20,7 @@ export class TransferBuilder {
   private _coin: Readonly<BaseCoin>;
   private _chainId?: string;
   private _coinUsesNonPackedEncodingForTxData?: boolean;
+  private _walletVersion?: number;
 
   constructor(serializedData?: string) {
     if (serializedData) {
@@ -48,6 +49,11 @@ export class TransferBuilder {
     return this;
   }
 
+  walletVersion(version: number): TransferBuilder {
+    this._walletVersion = version;
+    return this;
+  }
+
   data(additionalData: string): TransferBuilder {
     this._signature = this._EMPTY_HEX_VALUE;
     this._data = additionalData;
@@ -95,7 +101,7 @@ export class TransferBuilder {
     throw new InvalidParameterValueError('Invalid expiration time');
   }
 
-  signAndBuild(chainId?: string, coinUsesNonPackedEncodingForTxData?: boolean): string {
+  signAndBuild(chainId: string, coinUsesNonPackedEncodingForTxData?: boolean): string {
     this._chainId = chainId;
 
     // If the coin uses non-packed encoding for tx data, the operation hash is calculated differently
@@ -157,11 +163,12 @@ export class TransferBuilder {
 
   protected getOperationData(): (string | Buffer)[][] {
     let operationData;
+    const prefix = this.getOperationHashPrefix();
     if (this._tokenContractAddress !== undefined) {
       operationData = [
         ['string', 'address', 'uint', 'address', 'uint', 'uint'],
         [
-          this.getTokenOperationHashPrefix(),
+          prefix,
           new BN(ethUtil.stripHexPrefix(this._toAddress), 16),
           this._amount,
           new BN(ethUtil.stripHexPrefix(this._tokenContractAddress), 16),
@@ -176,7 +183,7 @@ export class TransferBuilder {
       operationData = [
         ['string', 'address', 'uint', 'bytes', 'uint', 'uint'],
         [
-          this.getNativeOperationHashPrefix(),
+          prefix,
           toAddress,
           this._amount,
           Buffer.from(ethUtil.padToEven(ethUtil.stripHexPrefix(this._data)) || '', 'hex'),
@@ -188,6 +195,13 @@ export class TransferBuilder {
     return operationData;
   }
 
+  private getOperationHashPrefix(): string {
+    if (this._walletVersion === 4) {
+      return this._tokenContractAddress ? `${this._chainId}-ERC20` : `${this._chainId}`;
+    }
+    return this._tokenContractAddress ? this.getTokenOperationHashPrefix() : this.getNativeOperationHashPrefix();
+  }
+
   /**
    * Get the prefix used in generating an operation hash for sending tokens
    *

modules/abstract-eth/src/lib/transferBuilders/baseNFTTransferBuilder.ts

@@ -17,6 +17,7 @@ export abstract class BaseNFTTransferBuilder {
   protected _coin: Readonly<BaseCoin>;
   protected _nativeCoinOperationHashPrefix?: string;
   protected _chainId?: string;
+  protected _walletVersion?: number;
 
   public abstract build(): string;
 
@@ -38,6 +39,11 @@ export abstract class BaseNFTTransferBuilder {
     throw new InvalidParameterValueError('Invalid expiration time');
   }
 
+  walletVersion(version: number): this {
+    this._walletVersion = version;
+    return this;
+  }
+
   key(signKey: string): this {
     this._signKey = signKey;
     return this;
@@ -101,6 +107,9 @@ export abstract class BaseNFTTransferBuilder {
    * @returns the string prefix
    */
   protected getNativeOperationHashPrefix(): string {
+    if (this._walletVersion === 4) {
+      return this._chainId ?? 'ETHER';
+    }
     return this._nativeCoinOperationHashPrefix ?? this._chainId ?? 'ETHER';
   }
 

modules/abstract-eth/src/lib/transferBuilders/transferBuilderERC1155.ts

@@ -53,7 +53,7 @@ export class ERC1155TransferBuilder extends BaseNFTTransferBuilder {
     return this;
   }
 
-  signAndBuild(chainId?: string): string {
+  signAndBuild(chainId: string): string {
     this._chainId = chainId;
     const hasMandatoryFields = this.hasMandatoryFields();
     if (hasMandatoryFields) {

modules/abstract-eth/src/lib/transferBuilders/transferBuilderERC721.ts

@@ -50,7 +50,7 @@ export class ERC721TransferBuilder extends BaseNFTTransferBuilder {
     return contractCall.serialize();
   }
 
-  signAndBuild(chainId?: string): string {
+  signAndBuild(chainId: string): string {
     this._chainId = chainId;
     if (this.hasMandatoryFields()) {
       this._data = this.build();

modules/abstract-eth/test/unit/transferBuilder.ts

@@ -1,5 +1,6 @@
 import assert from 'assert';
 import should from 'should';
+import { coins, EthereumNetwork as EthLikeNetwork } from '@bitgo/statics';
 import { KeyPair, TransferBuilder } from '../../src';
 
 describe('Eth send multi sig builder', function () {
@@ -19,6 +20,7 @@ describe('Eth send multi sig builder', function () {
 
     ethLikeCoins.forEach((coin) => {
       it('should fail with an invalid key', () => {
+        const staticsCoin = coins.get(coin) as unknown as EthLikeNetwork;
         const builder = new TransferBuilder()
           .coin(coin)
           .expirationTime(1590078260)
@@ -27,7 +29,7 @@ describe('Eth send multi sig builder', function () {
           .contractSequenceId(2)
           .key('invalidkey');
         should(() => {
-          builder.signAndBuild();
+          builder.signAndBuild(`${staticsCoin.chainId}`);
         }).throw('private key length is invalid');
       });
     });
@@ -64,17 +66,17 @@ describe('Eth send multi sig builder', function () {
 
     it('should fail if a sequenceId param is missing', () => {
       const builder = new TransferBuilder().amount(amount).to(toAddress).key(key);
-      assert.throws(() => builder.signAndBuild());
+      assert.throws(() => builder.signAndBuild(''));
     });
 
     it('should fail if a destination param is missing', () => {
       const builder = new TransferBuilder().amount(amount).contractSequenceId(2).key(key);
-      assert.throws(() => builder.signAndBuild());
+      assert.throws(() => builder.signAndBuild(''));
     });
 
     it('should fail if a amount param is missing', () => {
       const builder = new TransferBuilder().to(toAddress).contractSequenceId(2).key(key);
-      assert.throws(() => builder.signAndBuild());
+      assert.throws(() => builder.signAndBuild(''));
     });
   });
 });

modules/sdk-coin-arbeth/test/unit/transferBuilder.ts

@@ -1,4 +1,5 @@
 import should from 'should';
+import { coins, EthereumNetwork as EthLikeNetwork } from '@bitgo/statics';
 import { KeyPair, TransferBuilder } from '../../src';
 import * as testData from '../resources';
 
@@ -8,7 +9,7 @@ describe('Arbeth send multi sig builder', function () {
     'xprv9s21ZrQH143K3D8TXfvAJgHVfTEeQNW5Ys9wZtnUZkqPzFzSjbEJrWC1vZ4GnXCvR7rQL2UFX3RSuYeU9MrERm1XBvACow7c36vnz5iYyj2';
   const key = new KeyPair({ prv: xprv }).getKeys().prv as string;
   const amount = '100000000000000000'; // equivalent to 0.1 ether
-
+  const coin = coins.get('tarbeth') as unknown as EthLikeNetwork;
   describe('should build', () => {
     it('native coin transfer should succeed', async () => {
       const builder = new TransferBuilder()
@@ -19,7 +20,7 @@ describe('Arbeth send multi sig builder', function () {
         .contractSequenceId(2)
         .key(key)
         .data('0x');
-      const result = builder.signAndBuild();
+      const result = builder.signAndBuild(`${coin.chainId}`);
       should.equal(result, testData.SEND_FUNDS_DATA);
     });
 
@@ -32,7 +33,7 @@ describe('Arbeth send multi sig builder', function () {
         .contractSequenceId(0)
         .key(key)
         .data('0x');
-      const result = builder.signAndBuild();
+      const result = builder.signAndBuild(`${coin.chainId}`);
       should.equal(result, testData.SEND_FUNDS_SEQUENCE_ZERO_DATA);
     });
 
@@ -45,7 +46,7 @@ describe('Arbeth send multi sig builder', function () {
         .contractSequenceId(2)
         .key(key)
         .data('0x');
-      const result = builder.signAndBuild();
+      const result = builder.signAndBuild(`${coin.chainId}`);
       should.equal(result, testData.SEND_FUNDS_AMOUNT_ZERO_DATA);
     });
 
@@ -57,7 +58,7 @@ describe('Arbeth send multi sig builder', function () {
         .to(toAddress)
         .contractSequenceId(2)
         .key(key);
-      const result = builder.signAndBuild();
+      const result = builder.signAndBuild(`${coin.chainId}`);
       should.equal(result, testData.SEND_ARBETH_LINK_DATA);
     });
 
@@ -69,7 +70,7 @@ describe('Arbeth send multi sig builder', function () {
         .to(toAddress)
         .contractSequenceId(0)
         .key(key);
-      const result = builder.signAndBuild();
+      const result = builder.signAndBuild(`${coin.chainId}`);
       should.equal(result, testData.SEND_TOKEN_SEQUENCE_ZERO_DATA);
     });
 
@@ -81,7 +82,7 @@ describe('Arbeth send multi sig builder', function () {
         .to(toAddress)
         .contractSequenceId(2)
         .key(key);
-      const result = builder.signAndBuild();
+      const result = builder.signAndBuild(`${coin.chainId}`);
       should.equal(result, testData.SEND_TOKEN_AMOUNT_ZERO_DATA);
     });
 
@@ -92,14 +93,14 @@ describe('Arbeth send multi sig builder', function () {
         .to(toAddress)
         .contractSequenceId(2)
         .data('0x');
-      const result = builder.signAndBuild();
+      const result = builder.signAndBuild(`${coin.chainId}`);
       should.equal(result, testData.SEND_FUNDS_NO_KEY_DATA);
     });
 
     it('should build from a non signed serialized data', () => {
       const builder = new TransferBuilder(testData.SEND_FUNDS_NO_KEY_DATA);
       builder.coin('tarbeth').key(key);
-      const result = builder.signAndBuild();
+      const result = builder.signAndBuild(`${coin.chainId}`);
       should.equal(result, testData.SEND_FUNDS_DATA);
     });
   });

modules/sdk-coin-avaxc/test/unit/transferBuilder.ts

@@ -4,6 +4,7 @@ import { getBuilder } from './getBuilder';
 import * as testData from '../resources/avaxc';
 import { TransactionType } from '@bitgo/sdk-core';
 import { decodeTokenTransferData } from '@bitgo/sdk-coin-eth';
+import { coins, EthereumNetwork as EthLikeNetwork } from '@bitgo/statics';
 
 const amount = '20000';
 const toAddress = '0x7325A3F7d4f9E86AE62Cf742426078C3755730d5';
@@ -20,7 +21,7 @@ const tokensNames = [
   'avaxc:link',
   'tavaxc:link',
 ];
-
+const coin = coins.get('avaxc') as unknown as EthLikeNetwork;
 let txBuilder: TransactionBuilder;
 const contractAddress = testData.TEST_ACCOUNT.ethAddress;
 const initTxBuilder = (): void => {
@@ -44,7 +45,7 @@ describe('AVAXERC20 Tokens', () => {
         .to(toAddress)
         .contractSequenceId(2)
         .key(key);
-      const result = builder.signAndBuild();
+      const result = builder.signAndBuild(`${coin.chainId}`);
       const decode = decodeTokenTransferData(result);
       should.equal(decode.amount, '20000');
       should.equal(decode.expireTime, 1590078260);

modules/sdk-coin-celo/test/unit/transferBuilder.ts

@@ -1,14 +1,15 @@
 import should from 'should';
 import { KeyPair, TransferBuilder } from '../../src';
 import * as testData from '../resources/celo';
+import { coins, EthereumNetwork as EthLikeNetwork } from '@bitgo/statics';
 
 describe('Celo send multi sig builder', function () {
   const toAddress = '0x7325A3F7d4f9E86AE62Cf742426078C3755730d5';
   const xprv =
     'xprv9s21ZrQH143K3D8TXfvAJgHVfTEeQNW5Ys9wZtnUZkqPzFzSjbEJrWC1vZ4GnXCvR7rQL2UFX3RSuYeU9MrERm1XBvACow7c36vnz5iYyj2';
   const key = new KeyPair({ prv: xprv }).getKeys().prv as string;
   const amount = '100000000000000000'; // equivalent to 0.1 ether
-
+  const coin = coins.get('tcelo') as unknown as EthLikeNetwork;
   describe('should build', () => {
     it('celo token transfer should succeed', async () => {
       const builder = new TransferBuilder()
@@ -18,7 +19,7 @@ describe('Celo send multi sig builder', function () {
         .to(toAddress)
         .contractSequenceId(2)
         .key(key);
-      const result = builder.signAndBuild();
+      const result = builder.signAndBuild(`${coin.chainId}`);
       should.equal(result, testData.SEND_TOKEN_DATA);
     });
 
@@ -30,7 +31,7 @@ describe('Celo send multi sig builder', function () {
         .to(toAddress)
         .contractSequenceId(0)
         .key(key);
-      const result = builder.signAndBuild();
+      const result = builder.signAndBuild(`${coin.chainId}`);
       should.equal(result, testData.SEND_TOKEN_SEQUENCE_ZERO_DATA);
     });
 
@@ -42,7 +43,7 @@ describe('Celo send multi sig builder', function () {
         .to(toAddress)
         .contractSequenceId(2)
         .key(key);
-      const result = builder.signAndBuild();
+      const result = builder.signAndBuild(`${coin.chainId}`);
       should.equal(result, testData.SEND_TOKEN_AMOUNT_ZERO_DATA);
     });
 
@@ -54,14 +55,14 @@ describe('Celo send multi sig builder', function () {
         .to(toAddress)
         .contractSequenceId(2)
         .data('0x');
-      const result = builder.signAndBuild();
+      const result = builder.signAndBuild(`${coin.chainId}`);
       should.equal(result, testData.SEND_FUNDS_NO_KEY_DATA);
     });
 
     it('should build from a non signed serialized data', () => {
       const builder = new TransferBuilder(testData.SEND_FUNDS_NO_KEY_DATA);
       builder.key(key);
-      const result = builder.signAndBuild();
+      const result = builder.signAndBuild(`${coin.chainId}`);
       should.equal(result, testData.SEND_FUNDS_DATA);
     });
   });