Merge pull request #5090 from BitGo/COIN-2046-support-eip1559-for-celo

feat(sdk-coin-celo): support eip1559 for celo

Author: mullapudipruthvik

modules/account-lib/src/index.ts

@@ -157,7 +157,7 @@ const coinBuilderMap = {
   rbtc: Rbtc.TransactionBuilder,
   trbtc: Rbtc.TransactionBuilder,
   celo: Celo.TransactionBuilder,
-  tcelo: Celo.TransactionBuilder,
+  tcelo: Celo.TestnetTransactionBuilder,
   avaxc: AvaxC.TransactionBuilder,
   tavaxc: AvaxC.TransactionBuilder,
   bsc: Bsc.TransactionBuilder,

modules/sdk-coin-celo/src/lib/index.ts

@@ -1,6 +1,7 @@
 export { KeyPair, Interface } from '@bitgo/sdk-coin-eth';
 export { Transaction } from './transaction';
 export { TransactionBuilder } from './transactionBuilder';
+export { TestnetTransactionBuilder } from './testnetTransactionBuilder';
 export { TransferBuilder } from './transferBuilder';
 
 import * as Utils from './utils';

modules/sdk-coin-celo/src/lib/resources.ts

@@ -4,25 +4,23 @@ import EthereumCommon from '@ethereumjs/common';
 /**
  * A Common object defining the chain and the hardfork for CELO Testnet
  */
-export const testnetCommon = EthereumCommon.forCustomChain(
-  'mainnet', // It's a test net based on the main ethereum net
+export const testnetCommon = EthereumCommon.custom(
   {
     name: 'alfajores',
     networkId: (coins.get('tcelo').network as EthereumNetwork).chainId,
     chainId: (coins.get('tcelo').network as EthereumNetwork).chainId,
   },
-  'petersburg'
+  { hardfork: 'london' }
 );
 
 /**
  * A Common object defining the chain and the hardfork for CELO Mainnet
  */
-export const mainnetCommon = EthereumCommon.forCustomChain(
-  'mainnet',
+export const mainnetCommon = EthereumCommon.custom(
   {
     name: 'rc1',
     networkId: (coins.get('celo').network as EthereumNetwork).chainId,
     chainId: (coins.get('celo').network as EthereumNetwork).chainId,
   },
-  'petersburg'
+  { hardfork: 'petersburg' }
 );

modules/sdk-coin-celo/src/lib/testnetTransactionBuilder.ts

@@ -0,0 +1,33 @@
+import * as ethUtil from 'ethereumjs-util';
+import { Transaction } from '@bitgo/abstract-eth';
+import { BaseCoin as CoinConfig } from '@bitgo/statics';
+import { TransactionBuilder } from './transactionBuilder';
+
+export class TestnetTransactionBuilder extends TransactionBuilder {
+  constructor(_coinConfig: Readonly<CoinConfig>) {
+    super(_coinConfig);
+    this.transaction = new Transaction(_coinConfig, this._common);
+  }
+
+  /**
+   * Get the final v value. Final v is described in EIP-155.
+   *
+   * @protected for internal use when the enableFinalVField flag is true.
+   */
+  protected getFinalV(): string {
+    return ethUtil.addHexPrefix(this._common.chainIdBN().muln(2).addn(35).toString(16));
+  }
+
+  /** @inheritdoc */
+  protected fromImplementation(rawTransaction: string): Transaction {
+    let tx: Transaction;
+    if (/^0x?[0-9a-f]{1,}$/.test(rawTransaction.toLowerCase())) {
+      tx = Transaction.fromSerialized(this._coinConfig, this._common, rawTransaction);
+      this.loadBuilderInput(tx.toJson());
+    } else {
+      const txData = JSON.parse(rawTransaction);
+      tx = new Transaction(this._coinConfig, txData);
+    }
+    return tx;
+  }
+}

modules/sdk-coin-celo/src/lib/transactionBuilder.ts

@@ -1,13 +1,13 @@
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
 import EthereumAbi from 'ethereumjs-abi';
+import { addHexPrefix } from 'ethereumjs-util';
 import { TransactionBuilder as EthTransactionBuilder, TxData, walletSimpleConstructor } from '@bitgo/sdk-coin-eth';
 import { BuildTransactionError, TransactionType, StakingOperationTypes } from '@bitgo/sdk-core';
 import { Transaction } from './transaction';
 import { StakingBuilder } from './stakingBuilder';
 import { StakingCall } from './stakingCall';
 import { getCommon, walletSimpleByteCode } from './utils';
 import { TransferBuilder } from './transferBuilder';
-import { addHexPrefix } from 'ethereumjs-util';
 import BigNumber from 'bignumber.js';
 
 export class TransactionBuilder extends EthTransactionBuilder {

modules/sdk-coin-celo/src/tcelo.ts

@@ -2,8 +2,9 @@
  * @prettier
  */
 import { BaseCoin, BitGoBase } from '@bitgo/sdk-core';
-import { BaseCoin as StaticsBaseCoin } from '@bitgo/statics';
+import { BaseCoin as StaticsBaseCoin, coins } from '@bitgo/statics';
 import { Celo } from './celo';
+import { TestnetTransactionBuilder } from './lib';
 
 export class Tcelo extends Celo {
   protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>) {
@@ -13,4 +14,8 @@ export class Tcelo extends Celo {
   static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin {
     return new Tcelo(bitgo, staticsCoin);
   }
+
+  protected getTransactionBuilder(): TestnetTransactionBuilder {
+    return new TestnetTransactionBuilder(coins.get(this.getBaseChain()));
+  }
 }

modules/sdk-coin-celo/test/resources/celo.ts

@@ -1,6 +1,6 @@
-import { TransactionBuilder } from '../../src';
+import { TestnetTransactionBuilder, TransactionBuilder } from '../../src';
 import { coins } from '@bitgo/statics';
 
-export const getBuilder = (coin: string): TransactionBuilder => {
-  return new TransactionBuilder(coins.get(coin));
+export const getBuilder = (coin: string): TestnetTransactionBuilder | TransactionBuilder => {
+  return coin === 'celo' ? new TransactionBuilder(coins.get(coin)) : new TestnetTransactionBuilder(coins.get(coin));
 };

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

@@ -167,6 +167,60 @@ describe('Send transaction', function () {
       should.equal(txJson.from, undefined);
     });
 
+    it('should build txn with eip1559', async function () {
+      const txBuilder = getBuilder('tcelo') as TransactionBuilder;
+      txBuilder.fee({
+        fee: '1000000000',
+        gasLimit: '12100000',
+        eip1559: {
+          maxFeePerGas: '7593123',
+          maxPriorityFeePerGas: '150',
+        },
+      });
+      txBuilder.counter(2);
+      txBuilder.type(TransactionType.Send);
+      txBuilder.contract('0x8f977e912ef500548a0c3be6ddde9899f1199b81');
+      txBuilder
+        .transfer()
+        .coin('tcusd')
+        .amount('1000000000')
+        .to('0x19645032c7f1533395d44a629462e751084d3e4c')
+        .expirationTime(1590066728)
+        .contractSequenceId(5)
+        .key(key);
+      txBuilder.sign({ key: testData.PRIVATE_KEY });
+      const tx = await txBuilder.build();
+      const txJson = tx.toJson();
+      should.equal(txJson.gasLimit, '12100000');
+      should.equal(txJson._type, 'EIP1559');
+      should.equal(txJson.maxFeePerGas, '7593123');
+      should.equal(txJson.maxPriorityFeePerGas, '150');
+    });
+
+    it('should build legacy txn for celo', async function () {
+      const txBuilder = getBuilder('celo') as TransactionBuilder;
+      txBuilder.fee({
+        fee: '1000000000',
+        gasLimit: '12100000',
+      });
+      txBuilder.counter(2);
+      txBuilder.type(TransactionType.Send);
+      txBuilder.contract('0x8f977e912ef500548a0c3be6ddde9899f1199b81');
+      txBuilder
+        .transfer()
+        .coin('celo')
+        .amount('1000000000')
+        .to('0x19645032c7f1533395d44a629462e751084d3e4c')
+        .expirationTime(1590066728)
+        .contractSequenceId(5)
+        .key(key);
+      const tx = await txBuilder.build();
+      const txJson = tx.toJson();
+      should.equal(txJson.gasLimit, '12100000');
+      should.equal(txJson._type, 'Legacy');
+      should.equal(txJson.v, '0xa4ec');
+    });
+
     it('a send token transaction without final v', async () => {
       const recipient = '0x19645032c7f1533395d44a629462e751084d3e4c';
       const contractAddress = '0x8f977e912ef500548a0c3be6ddde9899f1199b81';
@@ -183,7 +237,7 @@ describe('Send transaction', function () {
         .key(key);
       const tx = await txBuilder.build();
       const txJson = tx.toJson();
-      should.equal(txJson.v, '0xaef3');
+      should.equal(txJson.v, '0x015e09');
     });
   });