chore: remove deprecated cip42

jmrossy · Oct 2, 2023 · b3b9a5c · b3b9a5c
1 parent 71ae5fe
commit b3b9a5c
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 76 deletions.
diff --git a/src/lib/CeloProvider.ts b/src/lib/CeloProvider.ts
@@ -57,16 +57,29 @@ export class CeloProvider extends providers.JsonRpcProvider {
     if (method === "estimateGas") {
       // NOTE: somehow estimategas trims lots of fields
       // this overrides it
+      const extraneous_keys = [
+        ["from", (x: string) => x],
+        ["feeCurrency", utils.hexlify],
+        ["gatewayFeeRecipient", (x: string) => x],
+        ["gatewayFee", utils.hexlify],
+      ] as const;
+
       const tx = {
         // @ts-expect-error
-        ...this.constructor.hexlifyTransaction(params.transaction, {
-          feeCurrency: true,
-          from: true,
-        }),
+        ...this.constructor.hexlifyTransaction(
+          params.transaction,
+          extraneous_keys.reduce((acc, [key]) => {
+            acc[key] = true;
+            return acc;
+          }, {} as Record<string, true>)
+        ),
       };
-      if (params.transaction.feeCurrency) {
-        tx.feeCurrency = params.transaction.feeCurrency;
-      }
+      extraneous_keys.forEach(([key, fn]) => {
+        if (params.transaction[key]) {
+          tx[key] = fn(params.transaction[key]);
+        }
+      });
+
       return ["eth_estimateGas", [tx]];
     }
 

diff --git a/src/lib/transactions.ts b/src/lib/transactions.ts
@@ -7,13 +7,7 @@ import {
   Transaction,
   utils,
 } from "ethers";
-import {
-  concatHex,
-  isCIP42,
-  isCIP64,
-  isEIP1559,
-  omit,
-} from "./transaction/utils";
+import { concatHex, isCIP64, isEIP1559, omit } from "./transaction/utils";
 import { accessListify, AccessListish } from "ethers/lib/utils";
 
 // NOTE: Black magic
@@ -45,13 +39,6 @@ export interface CeloTransactionCip64 extends Transaction {
   feeCurrency: string;
 }
 
-export interface CeloTransactionCip42 extends Transaction {
-  type: TxTypeToPrefix.cip42;
-  feeCurrency: string;
-  gatewayFeeRecipient?: string;
-  gatewayFee?: string;
-}
-
 export interface CeloTransactionEip1559 extends Transaction {
   type: TxTypeToPrefix.eip1559;
 }
@@ -66,11 +53,9 @@ export interface LegacyCeloTransaction extends Transaction {
 export type CeloTransaction =
   | LegacyCeloTransaction
   | CeloTransactionCip64
-  | CeloTransactionCip42
   | CeloTransactionEip1559;
 
 export enum TxTypeToPrefix {
-  cip42 = 0x7c,
   cip64 = 0x7b,
   eip1559 = 0x02,
 }
@@ -177,10 +162,6 @@ export function getTxType(tx: CeloTransaction) {
     // @ts-ignore
     delete tx.gasPrice;
     return TxTypeToPrefix.cip64;
-  } else if (isCIP42(tx)) {
-    // @ts-ignore
-    delete tx.gasPrice;
-    return TxTypeToPrefix.cip42;
   } else if (isEIP1559(tx)) {
     // @ts-ignore
     delete tx.feeCurrency;
@@ -219,26 +200,6 @@ function prepareEncodeTx(
         tx.feeCurrency || "0x",
       ];
       break;
-    case TxTypeToPrefix.cip42:
-      // There shall be a typed transaction with the code 0x7c that has the following format:
-      // 0x7c || rlp([chain_id, nonce, max_priority_fee_per_gas, max_fee_per_gas, gas_limit, feecurrency, gatewayFeeRecipient, gatewayfee, destination, amount, data, access_list, signature_y_parity, signature_r, signature_s]).
-      // This will be in addition to the type 0x02 transaction as specified in EIP-1559.
-      raw = [
-        utils.hexlify(tx.chainId!),
-        utils.hexlify(tx.nonce!),
-        tx.maxPriorityFeePerGas ? utils.hexlify(tx.maxPriorityFeePerGas) : "0x",
-        tx.maxFeePerGas ? utils.hexlify(tx.maxFeePerGas) : "0x",
-        tx.gasLimit ? utils.hexlify(tx.gasLimit) : "0x",
-        tx.feeCurrency || "0x",
-        tx.gatewayFeeRecipient || "0x",
-        tx.gatewayFee || "0x",
-        tx.to || "0x",
-        tx.value ? utils.hexlify(tx.value) : "0x",
-        tx.data || "0x",
-        // @ts-expect-error
-        tx.accessList || [],
-      ];
-      break;
     case TxTypeToPrefix.eip1559:
       // https://eips.ethereum.org/EIPS/eip-1559
       // 0x02 || rlp([chain_id, nonce, max_priority_fee_per_gas, max_fee_per_gas, gas_limit, destination, amount, data, access_list, signature_y_parity, signature_r, signature_s]).
@@ -355,7 +316,7 @@ export function serializeCeloTransaction(
 
   let v: number;
   if (txArgs.type) {
-    // cip64,cip42, eip-1559
+    // cip64, eip-1559
     v = sig.v - Y_PARITY_EIP_2098;
   } else {
     // celo-legacy
@@ -411,24 +372,6 @@ export function parseCeloTransaction(
         feeCurrency: handleAddress(transaction[9]),
       } as CeloTransactionCip64;
       break;
-    case TxTypeToPrefix.cip42:
-      // untested
-      tx = {
-        type: TxTypeToPrefix.cip42,
-        chainId: handleNumber(transaction[0]).toNumber(),
-        nonce: handleNumber(transaction[1]).toNumber(),
-        maxPriorityFeePerGas: handleNumber(transaction[2]),
-        maxFeePerGas: handleNumber(transaction[3]),
-        gasLimit: handleNumber(transaction[4]),
-        feeCurrency: handleAddress(transaction[5]),
-        gatewayFeeRecipient: handleAddress(transaction[6]),
-        gatewayFee: transaction[7] as string,
-        to: handleAddress(transaction[8]),
-        value: handleNumber(transaction[9]),
-        data: transaction[10],
-        accessList: handleAccessList(transaction[11]),
-      } as CeloTransactionCip42;
-      break;
     case TxTypeToPrefix.eip1559:
       // untested
       tx = {
@@ -543,7 +486,6 @@ function handleAccessList(value: string): AccessListish | "0x" {
 
 const baseTxLengths = {
   [TxTypeToPrefix.cip64]: { unsigned: 10, signed: 13 },
-  [TxTypeToPrefix.cip42]: { unsigned: 12, signed: 15 },
   [TxTypeToPrefix.eip1559]: { unsigned: 9, signed: 12 },
   "celo-legacy": { unsigned: 12, signed: 12 },
 } as const;
@@ -569,11 +511,7 @@ function splitTypeAndRawTx(
 ): [TxTypeToPrefix | undefined, any[]] {
   let rawStr = rawTransaction.toString();
   let type: TxTypeToPrefix | undefined;
-  for (const _type of [
-    TxTypeToPrefix.cip64,
-    TxTypeToPrefix.cip42,
-    TxTypeToPrefix.eip1559,
-  ]) {
+  for (const _type of [TxTypeToPrefix.cip64, TxTypeToPrefix.eip1559]) {
     const prefix = utils.hexlify(_type);
     if (rawStr.startsWith(prefix)) {
       rawStr = `0x${rawStr.slice(prefix.length)}`;

diff --git a/test/useContract.ts b/test/useContract.ts
@@ -25,17 +25,43 @@ async function main() {
   const txReceipt1 = await txResponse1.wait();
   console.info("Funds sent. Hash:", txReceipt1.transactionHash);
 
-  console.info("Sending 1 CELO wei with cUSD feeCurrency");
-  const txResponse1feeCurrency = await signer.sendTransaction({
+  console.info(
+    "[celo-legacy] Sending 1 CELO wei with cUSD feeCurrency",
+    signer.address
+  );
+  const txResponseLegacy = await signer.sendTransaction({
+    to: signer.address,
+    value: BigNumber.from("1"),
+    feeCurrency: CUSD_ADDRESS,
+  });
+  const txReceiptLegacy = await txResponseLegacy.wait();
+  console.info(
+    `[celo-legacy] CELO w/ feeCurrency payment hash: ${txReceiptLegacy.transactionHash}`
+  );
+
+  console.info("[cip64] Sending 1 CELO wei with cUSD feeCurrency");
+  const txResponseCip64 = await signer.sendTransaction({
     to: signer.address,
     value: BigNumber.from("1"),
     feeCurrency: CUSD_ADDRESS,
     maxFeePerGas: BigNumber.from(5000000000),
     maxPriorityFeePerGas: BigNumber.from(5000000000),
   });
-  const txReceipt1FeeCurency = await txResponse1feeCurrency.wait();
+  const txReceiptCip64 = await txResponseCip64.wait();
+  console.info(
+    `[cip64] CELO w/ feeCurrency payment hash: ${txReceiptCip64.transactionHash}`
+  );
+
+  console.info("[eip1559] Sending 1 CELO wei");
+  const txResponseEip1559 = await signer.sendTransaction({
+    to: signer.address,
+    value: BigNumber.from("1"),
+    maxFeePerGas: BigNumber.from(5000000000),
+    maxPriorityFeePerGas: BigNumber.from(5000000000),
+  });
+  const txReceiptEip1559 = await txResponseEip1559.wait();
   console.info(
-    `CELO w/ feeCurrency payment hash: ${txReceipt1FeeCurency.transactionHash}`
+    `[eip1559] CELO payment hash: ${txReceiptEip1559.transactionHash}`
   );
 
   const stableToken = new Contract(CUSD_ADDRESS, STABLE_TOKEN_ABI, signer);