WIP add support for EIP1559 and CIP42 to ContractKit (wallet-base)

.circleci/config.yml

@@ -10,13 +10,13 @@ orbs:
 parameters:
   run-workflow-general:
     type: boolean
-    default: false 
+    default: false
   run-workflow-npm-install:
     type: boolean
-    default: false 
+    default: false
   run-workflow-protocol-coverage:
     type: boolean
-    default: false 
+    default: false
   # When you need to force a rebuild of the node modules cache then bump this version
   node-modules-cache-version:
     type: integer
@@ -910,7 +910,7 @@ workflows:
   version: 2
   celo-monorepo-build:
     # Contitionally triggered
-    when: 
+    when:
       or: [<< pipeline.parameters.run-workflow-general >>]
     jobs:
       - install_dependencies
@@ -1015,15 +1015,15 @@ workflows:
             - lint-checks
   npm-install-testing-cron-workflow:
     # Contitionally triggered
-    when: 
+    when:
       or: [<< pipeline.parameters.run-workflow-npm-install >>]
     jobs:
       - test-typescript-npm-package-install
       - test-utils-npm-package-install
       - test-contractkit-npm-package-install
       - test-celocli-npm-package-install
   protocol-testing-with-code-coverage-cron-workflow:
-    when: 
+    when:
       or: [<< pipeline.parameters.run-workflow-protocol-coverage >>]
     jobs:
       - install_dependencies

.github/workflows/circleci.yml

@@ -8,7 +8,10 @@ on:
   push:
     branches:
       - master
-  pull_request:
+      # TODO (soloseng): remove before merge
+      - soloseng/ganache-upgrade
+  # TODO(jcortejoso): Replace by pull_request
+  pull_request_target:
     branches:
       - master
 

packages/cli/src/base.ts

@@ -201,9 +201,6 @@ export abstract class BaseCommand extends Command {
 
     const setStableTokenGas = async (stable: StableToken) => {
       await this.kit.setFeeCurrency(stableTokenInfos[stable].contract)
-      await this.kit.updateGasPriceInConnectionLayer(
-        await this.kit.registry.addressFor(stableTokenInfos[stable].contract)
-      )
     }
     if (Object.keys(StableToken).includes(gasCurrencyConfig)) {
       await setStableTokenGas(StableToken[gasCurrencyConfig as keyof typeof StableToken])

packages/cli/src/transfer-stable-base.ts

@@ -7,6 +7,7 @@ import { BaseCommand } from './base'
 import { newCheckBuilder } from './utils/checks'
 import { displaySendTx, failWith } from './utils/cli'
 import { Flags } from './utils/command'
+import { stableTokenInfos } from '@celo/contractkit/src/celo-tokens'
 
 export abstract class TransferStableBase extends BaseCommand {
   static flags = {
@@ -35,7 +36,7 @@ export abstract class TransferStableBase extends BaseCommand {
     } catch {
       failWith(`The ${this._stableCurrency} token was not deployed yet`)
     }
-    await this.kit.updateGasPriceInConnectionLayer(stableToken.address)
+    await this.kit.setFeeCurrency(stableTokenInfos[this._stableCurrency].contract)
 
     const tx = res.flags.comment
       ? stableToken.transferWithComment(to, value.toFixed(), res.flags.comment)
@@ -48,11 +49,7 @@ export abstract class TransferStableBase extends BaseCommand {
         this.kit.connection.defaultFeeCurrency === stableToken.address,
         async () => {
           const gas = await tx.txo.estimateGas({ feeCurrency: stableToken.address })
-          // TODO: replace with gasPrice rpc once supported by min client version
-          const { gasPrice } = await this.kit.connection.fillGasPrice({
-            gasPrice: '0',
-            feeCurrency: stableToken.address,
-          })
+          const gasPrice = await this.kit.connection.gasPrice(stableToken.address)
           const gasValue = new BigNumber(gas).times(gasPrice as string)
           const balance = await stableToken.balanceOf(from)
           return balance.gte(value.plus(gasValue))

packages/sdk/base/src/address.ts

@@ -12,7 +12,8 @@ export const normalizeAddressWith0x = (a: Address) => ensureLeading0x(a).toLower
 
 export const trimLeading0x = (input: string) => (input.startsWith('0x') ? input.slice(2) : input)
 
-export const ensureLeading0x = (input: string) => (input.startsWith('0x') ? input : `0x${input}`)
+export const ensureLeading0x = (input: string): `0x${string}` =>
+  input.startsWith('0x') ? (input as `0x${string}`) : (`0x${input}` as const)
 
 // Turns '0xce10ce10ce10ce10ce10ce10ce10ce10ce10ce10'
 // into ['ce10','ce10','ce10','ce10','ce10','ce10','ce10','ce10','ce10','ce10']

packages/sdk/cip42changees

@@ -0,0 +1,46 @@
+TopLine Changes
+
+* Add support for CIP42 and EIP1559 Transactions
+* Prefer EIP1559 if no feeCurrency and CIP42 if using feeCurrency, Old CeloLegacy transations still supported (set the gasPrice explicitly) but discouraged
+* upgrade Web3 dependency
+
+## @celo/connect
+
+* gasPrice is no longer an option on config. setting 0 (or any empty value) for gasPrice in transaction will result in maxFeePerGas and maxPriorityFee per gas being set on the transaction
+
+* likewise gasPrice is no longer settable on the connection itself
+
+* (note that the gasPrice function for fetching price from node is NOT affected)
+
+* replace connection.fillGasPrice  with connection.setFeeMarketGas
+
+* add inputAccessListFormatter
+
+* remove deprecated setGasPriceForCurrency
+
+* EncodedTransaction Type now supports CIp42 and EIP1559 transactions
+
+* inputCeloTxFormater now returns type FormattedCeloTx although apart from support for cip42 and eip1559 tx the data returned hasnt changed
+
+* numberToHex, ensureLeading0x, inputAddressFormatter now are typed to return `0x{string}` instead of just string
+
+* added parseAccessList and inputAccessListFormatter for converting accessList from json to array of array and back
+
+* RLPEncodedTx now types its transaction field as FormattedTransaction this is more accurate than the CeloTX type it previously had
+
+## kit
+
+* removed gasPriceSuggestionMultiplier == gas price from rpc no longer multipled by 5
+
+* remove kit.fillGasPrice
+
+* remove updateGasPriceInConnectionLayer
+
+* remove kit.gasPrice
+
+## @celo/wallet-base
+
+* extractSignature now throws if the length of provided tx is not correct
+* extractSignature was incorrectly typed to return Buffers for r and s values
+
+* ensureLeading0x now types output to be `0x{string}`

packages/sdk/connect/src/celo-provider.test.ts

@@ -29,8 +29,9 @@ class MockWallet implements ReadOnlyWallet {
   }
   signTransaction(_txParams: CeloTx): Promise<EncodedTransaction> {
     return Promise.resolve({
-      raw: 'mock',
+      raw: '0xmock',
       tx: {
+        type: 'celo-legacy',
         nonce: 'nonce',
         gasPrice: 'gasPrice',
         gas: 'gas',
@@ -193,7 +194,7 @@ describe('CeloProvider', () => {
 
     describe('but tries to use it with a different account', () => {
       interceptedByCeloProvider.forEach((method: string) => {
-        test(`fowards the call to '${method}' to the original provider`, (done) => {
+        test(`forwards the call to '${method}' to the original provider`, (done) => {
           const payload: JsonRpcPayload = {
             id: 0,
             jsonrpc: '2.0',

packages/sdk/connect/src/connection.ts

@@ -5,7 +5,7 @@ import { bufferToHex } from '@ethereumjs/util'
 import debugFactory from 'debug'
 import Web3 from 'web3'
 import { AbiCoder } from './abi-types'
-import { assertIsCeloProvider, CeloProvider } from './celo-provider'
+import { CeloProvider, assertIsCeloProvider } from './celo-provider'
 import {
   Address,
   Block,
@@ -34,15 +34,14 @@ import {
 import { hasProperty } from './utils/provider-utils'
 import { getRandomId, HttpRpcCaller, RpcCaller } from './utils/rpc-caller'
 import { TxParamsNormalizer } from './utils/tx-params-normalizer'
-import { toTxResult, TransactionResult } from './utils/tx-result'
+import { TransactionResult, toTxResult } from './utils/tx-result'
 import { ReadOnlyWallet } from './wallet'
 
 const debugGasEstimation = debugFactory('connection:gas-estimation')
 
 type BN = ReturnType<Web3['utils']['toBN']>
 export interface ConnectionOptions {
   gasInflationFactor: number
-  gasPrice: string
   feeCurrency?: Address
   from?: Address
 }
@@ -58,16 +57,11 @@ export class Connection {
   readonly paramsPopulator: TxParamsNormalizer
   rpcCaller!: RpcCaller
 
-  /** @deprecated no longer needed since gasPrice is available on node rpc */
-  private currencyGasPrice: Map<Address, string> = new Map<Address, string>()
-
   constructor(readonly web3: Web3, public wallet?: ReadOnlyWallet, handleRevert = true) {
     web3.eth.handleRevert = handleRevert
 
     this.config = {
       gasInflationFactor: 1.3,
-      // gasPrice:0 means the node will compute gasPrice on its own
-      gasPrice: '0',
     }
 
     const existingProvider: Provider = web3.currentProvider as Provider
@@ -125,14 +119,6 @@ export class Connection {
     return this.config.gasInflationFactor
   }
 
-  set defaultGasPrice(price: number) {
-    this.config.gasPrice = price.toString(10)
-  }
-
-  get defaultGasPrice() {
-    return parseInt(this.config.gasPrice, 10)
-  }
-
   /**
    * Set the ERC20 address for the token to use to pay for transaction fees.
    * The ERC20 must be whitelisted for gas.
@@ -224,7 +210,7 @@ export class Connection {
    */
   sendTransaction = async (tx: CeloTx): Promise<TransactionResult> => {
     tx = this.fillTxDefaults(tx)
-    tx = this.fillGasPrice(tx)
+    tx = await this.setFeeMarketGas(tx)
 
     let gas = tx.gas
     if (gas == null) {
@@ -244,7 +230,7 @@ export class Connection {
     tx?: Omit<CeloTx, 'data'>
   ): Promise<TransactionResult> => {
     tx = this.fillTxDefaults(tx)
-    tx = this.fillGasPrice(tx)
+    tx = await this.setFeeMarketGas(tx)
 
     let gas = tx.gas
     if (gas == null) {
@@ -341,20 +327,27 @@ export class Connection {
   sendSignedTransaction = async (signedTransactionData: string): Promise<TransactionResult> => {
     return toTxResult(this.web3.eth.sendSignedTransaction(signedTransactionData))
   }
+  // if neither gas price nor feeMarket fields are present set them.
+  async setFeeMarketGas(tx: CeloTx): Promise<CeloTx> {
+    // default to the current values
+    const calls = [Promise.resolve(tx.maxFeePerGas), Promise.resolve(tx.maxPriorityFeePerGas)]
 
-  /** @deprecated no longer needed since gasPrice is available on node rpc */
-  fillGasPrice(tx: CeloTx): CeloTx {
-    if (tx.feeCurrency && tx.gasPrice === '0' && this.currencyGasPrice.has(tx.feeCurrency)) {
-      return {
-        ...tx,
-        gasPrice: this.currencyGasPrice.get(tx.feeCurrency),
+    if ((isEmpty(tx.gasPrice) && isEmpty(tx.maxFeePerGas)) || isEmpty(tx.maxPriorityFeePerGas)) {
+      if (isEmpty(tx.maxFeePerGas)) {
+        calls[0] = this.gasPrice(tx.feeCurrency)
+      }
+      if (isEmpty(tx.maxPriorityFeePerGas)) {
+        calls[1] = this.rpcCaller.call('eth_maxPriorityFeePerGas', []).then((rpcResponse) => {
+          return rpcResponse.result
+        })
       }
     }
-    return tx
-  }
-  /** @deprecated no longer needed since gasPrice is available on node rpc */
-  async setGasPriceForCurrency(address: Address, gasPrice: string) {
-    this.currencyGasPrice.set(address, gasPrice)
+    const [maxFeePerGas, maxPriorityFeePerGas] = await Promise.all(calls)
+    return {
+      ...tx,
+      maxFeePerGas,
+      maxPriorityFeePerGas,
+    }
   }
 
   estimateGas = async (
@@ -508,7 +501,6 @@ export class Connection {
     const defaultTx: CeloTx = {
       from: this.config.from,
       feeCurrency: this.config.feeCurrency,
-      gasPrice: this.config.gasPrice,
     }
 
     return {
@@ -522,3 +514,18 @@ export class Connection {
     this.web3.currentProvider.stop()
   }
 }
+
+function isEmpty(value: string | undefined | number | BN) {
+  return (
+    value === 0 ||
+    value === undefined ||
+    value === null ||
+    value === '0' ||
+    (typeof value === 'string' &&
+      (value.toLowerCase() === '0x' || value.toLowerCase() === '0x0')) ||
+    Web3.utils.toBN(value.toString()).eq(Web3.utils.toBN(0))
+  )
+}
+export function isPresent(value: string | undefined | number | BN) {
+  return !isEmpty(value)
+}