Skip to content

Commit

Permalink
fix: cip64 is ALIVE
Browse files Browse the repository at this point in the history
  • Loading branch information
@nicolasbrugneaux
nicolasbrugneaux committed Oct 2, 2023
1 parent caa0b60 commit ddd8d28
Show file tree
Hide file tree
Showing 5 changed files with 176 additions and 72 deletions.
44 changes: 43 additions & 1 deletion src/lib/CeloProvider.ts
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { BigNumber, providers, utils } from "ethers";
import { getNetwork } from "./networks";
import { parseCeloTransaction } from "./transactions";
import { CeloTransactionRequest, parseCeloTransaction } from "./transactions";

const logger = new utils.Logger("CeloProvider");

Expand Down Expand Up @@ -54,6 +54,22 @@ export class CeloProvider extends providers.JsonRpcProvider {
return ["eth_gasPrice", param];
}

if (method === "estimateGas") {
// NOTE: somehow estimategas trims lots of fields
// this overrides it
const tx = {
// @ts-expect-error
...this.constructor.hexlifyTransaction(params.transaction, {
feeCurrency: true,
from: true,
}),
};
if (params.transaction.feeCurrency) {
tx.feeCurrency = params.transaction.feeCurrency;
}
return ["eth_estimateGas", [tx]];
}

return super.prepareRequest(method, params);
}

Expand All @@ -71,4 +87,30 @@ export class CeloProvider extends providers.JsonRpcProvider {
}
return network;
}

async estimateGas(
transaction: utils.Deferrable<CeloTransactionRequest>
): Promise<BigNumber> {
// NOTE: Overrides the ethers method to make sure feeCurrency and from are sent
// to the rpc node
await this.getNetwork();
const params = await utils.resolveProperties({
transaction,
});
const result = await this.perform("estimateGas", params);
try {
return BigNumber.from(result);
} catch (error) {
return logger.throwError(
"bad result from backend",
utils.Logger.errors.SERVER_ERROR,
{
method: "estimateGas",
params,
result,
error,
}
);
}
}
}
14 changes: 10 additions & 4 deletions src/lib/CeloWallet.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
getTxType,
serializeCeloTransaction,
} from "./transactions";
import { adjustForGasInflation } from "./transaction/utils";

const logger = new utils.Logger("CeloWallet");

Expand All @@ -24,15 +25,21 @@ export class CeloWallet extends Wallet {
transaction: utils.Deferrable<CeloTransactionRequest>
): Promise<CeloTransactionRequest> {
const tx: any = await utils.resolveProperties(transaction);

if (tx.to != null) {
tx.to = Promise.resolve(tx.to).then((to) =>
this.resolveName(to as string)
);
}
if (tx.gasPrice == null) {

if (tx.from == null) {
tx.from = this.address;
}

const type = getTxType(tx);
if (!type && tx.gasPrice == null) {
tx.gasPrice = this.getGasPrice();
}

if (tx.nonce == null) {
tx.nonce = this.getTransactionCount("pending");
}
Expand Down Expand Up @@ -120,8 +127,7 @@ export class CeloWallet extends Wallet {
this._checkProvider("estimateGas");
// @ts-expect-error
const tx: CeloTransaction = await utils.resolveProperties(transaction);
void getTxType(tx);
return await this.provider.estimateGas(tx);
return this.provider.estimateGas(tx).then(adjustForGasInflation);
}

/**
Expand Down
10 changes: 9 additions & 1 deletion src/lib/transaction/utils.ts
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { BigNumberish } from "ethers";
import { BigNumber, BigNumberish } from "ethers";
import { hexlify } from "ethers/lib/utils";

function isEmpty(value: string | BigNumberish | undefined | null) {
Expand Down Expand Up @@ -53,3 +53,11 @@ export function omit<T extends Object, K extends (keyof T)[]>(
return acc;
}, {} as T);
}

export function adjustForGasInflation(gas: BigNumber): BigNumber {
// NOTE: Don't ask me
const GAS_INFLATION_FACTOR = 1.3;

// NOTE: prevent floating point math
return gas.mul(Math.floor(GAS_INFLATION_FACTOR * 100)).div(100);
}
127 changes: 84 additions & 43 deletions src/lib/transactions.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ import {
} from "./transaction/utils";
import { accessListify, AccessListish } from "ethers/lib/utils";

// NOTE: Black magic
const Y_PARITY_EIP_2098 = 27;

// From https://github.com/ethers-io/ethers.js/blob/master/packages/bytes/src.ts/index.ts#L33
// Copied because it doesn't seem to be exported from 'ethers' anywhere
type SignatureLike =
Expand Down Expand Up @@ -274,7 +277,8 @@ function prepareEncodeTx(
if (signature) {
raw.push(
...[
utils.hexlify(signature.v),
// NOTE: Somehow geth cannot parse `0x00` because it's dumb
signature.v ? utils.hexlify(signature.v) : "0x",
utils.stripZeros(utils.arrayify(signature.r)),
utils.stripZeros(utils.arrayify(signature.s)),
]
Expand Down Expand Up @@ -348,27 +352,42 @@ export function serializeCeloTransaction(
// case that the signTransaction function only adds a v.
const sig = utils.splitSignature(signature);

let v = 27 + sig.recoveryParam;
if (chainId !== 0) {
// NOTE: this makes the recoveryParam recovery custom in `parseCeloTransaction`
// see line:
v += chainId * 2 + 8;

// If an EIP-155 v (directly or indirectly; maybe _vs) was provided, check it!
if (sig.v > 28 && sig.v !== v) {
logger.throwArgumentError(
"transaction.chainId/signature.v mismatch",
"signature",
signature
);
}
} else if (sig.v !== v) {
logger.throwArgumentError(
"transaction.chainId/signature.v mismatch",
"signature",
signature
);
let v = sig.v - Y_PARITY_EIP_2098;
if (txArgs.type) {
// cip64,cip42, eip-1559
// noop
} else {
// celo-legacy
v = sig.v + chainId * 2 + 35;
}

// TODO: rossy cleanup nico
// let v = 27 + sig.recoveryParam;
// if (chainId !== 0) {
// // NOTE: this makes the recoveryParam recovery custom in `parseCeloTransaction`
// // see line:
// if (txArgs.type) {
// // cip64,cip42, eip-1559
// } else {
// // celo-legacy
// v += chainId * 2 + 8;
// }

// // If an EIP-155 v (directly or indirectly; maybe _vs) was provided, check it!
// if (sig.v > 28 && sig.v !== v) {
// logger.throwArgumentError(
// "transaction.chainId/signature.v mismatch",
// "signature",
// signature
// );
// }
// } else if (sig.v !== v) {
// logger.throwArgumentError(
// "transaction.chainId/signature.v mismatch",
// "signature",
// signature
// );
// }
// @ts-expect-error
const raw = prepareEncodeTx(txArgs, { ...sig, v });
const encoded = utils.RLP.encode(raw);
Expand All @@ -389,13 +408,13 @@ export function parseCeloTransaction(
type: TxTypeToPrefix.cip64,
chainId: handleNumber(transaction[0]).toNumber(),
nonce: handleNumber(transaction[1]).toNumber(),
maxPriorityFeePerGas: transaction[2],
maxFeePerGas: transaction[3],
maxPriorityFeePerGas: handleNumber(transaction[2]),
maxFeePerGas: handleNumber(transaction[3]),
gasLimit: handleNumber(transaction[4]),
to: handleAddress(transaction[5]),
value: handleNumber(transaction[6]),
data: transaction[7],
// accessList: handleAccessList(transaction[8]),
accessList: handleAccessList(transaction[8]),
feeCurrency: handleAddress(transaction[9]),
} as CeloTransactionCip64;
break;
Expand All @@ -405,8 +424,8 @@ export function parseCeloTransaction(
type: TxTypeToPrefix.cip42,
chainId: handleNumber(transaction[0]).toNumber(),
nonce: handleNumber(transaction[1]).toNumber(),
maxPriorityFeePerGas: transaction[2],
maxFeePerGas: transaction[3],
maxPriorityFeePerGas: handleNumber(transaction[2]),
maxFeePerGas: handleNumber(transaction[3]),
gasLimit: handleNumber(transaction[4]),
feeCurrency: handleAddress(transaction[5]),
gatewayFeeRecipient: handleAddress(transaction[6]),
Expand All @@ -423,8 +442,8 @@ export function parseCeloTransaction(
type: TxTypeToPrefix.eip1559,
chainId: handleNumber(transaction[0]).toNumber(),
nonce: handleNumber(transaction[1]).toNumber(),
maxPriorityFeePerGas: transaction[2],
maxFeePerGas: transaction[3],
maxPriorityFeePerGas: handleNumber(transaction[2]),
maxFeePerGas: handleNumber(transaction[3]),
gasLimit: handleNumber(transaction[4]),
to: handleAddress(transaction[5]),
value: handleNumber(transaction[6]),
Expand Down Expand Up @@ -454,7 +473,7 @@ export function parseCeloTransaction(
}

try {
tx.v = BigNumber.from(transaction.at(-3)).toNumber();
tx.v = handleNumber(transaction.at(-3)).toNumber();
} catch (error) {
console.log(error);
return tx;
Expand All @@ -463,30 +482,43 @@ export function parseCeloTransaction(
tx.r = utils.hexZeroPad(transaction.at(-2), 32);
tx.s = utils.hexZeroPad(transaction.at(-1), 32);

if (BigNumber.from(tx.r).isZero() && BigNumber.from(tx.s).isZero()) {
// EIP-155 unsigned transaction
// EIP-155 unsigned transaction
if (handleNumber(tx.r).isZero() && handleNumber(tx.s).isZero()) {
tx.chainId = tx.v;
tx.v = 0;
} else {
// Signed Transaction
const chainId = Math.max(0, Math.floor((tx.v - 35) / 2));
tx.chainId = chainId;
if (tx.chainId < 0) {
tx.chainId = 0;
}
// Signed Transaction
else {
let chainId: number;
let recoveryParam = tx.v;
if (tx.type) {
// cip64, cip42, eip-1559
// noop, chainId is in tx
chainId = tx.chainId;
} else {
// celo-legacy
chainId = Math.max(0, Math.floor((tx.v - 35) / 2));
tx.chainId = chainId;
recoveryParam = tx.v + Y_PARITY_EIP_2098;
recoveryParam -= tx.chainId * 2 + 35;
}
// // NOTE: is this condition even correct now?
// if (!tx.chainId) {
// const chainId = Math.max(0, Math.floor((tx.v - 35) / 2));
// tx.chainId = chainId;
// }
// let recoveryParam = tx.v - 27;
// if (tx.chainId !== 0) {
// // NOTE: inverse operation that was done in `serializeCeloTransaction`
// recoveryParam -= tx.chainId * 2 + 8;
// }

// NOTE: Serialization needs to happen here because chainId may not populated before
const serialized = serializeCeloTransaction(
omit(tx, "v", "r", "s") as CeloTransactionRequest
);
const digest = utils.keccak256(serialized);

let recoveryParam = tx.v - 27;
if (tx.chainId !== 0) {
// NOTE: inverse operation that was done in `serializeCeloTransaction`
recoveryParam -= tx.chainId * 2 + 8;
}

try {
// TODO there may be an issue here with incorrect from address extraction
tx.from = utils.recoverAddress(digest, {
Expand All @@ -501,6 +533,15 @@ export function parseCeloTransaction(
tx.hash = utils.keccak256(rawTransaction);
}

console.log("---------");
console.log("Raw signed Tx", rawTransaction);
console.log("---------");
console.log("RLP decoded Tx", transaction);
console.log("---------");
console.log("Inferred type", type!);
console.log("---------");
console.log("Parsed TX from raw signed:", tx);
console.log("---------");
return tx;
}

Expand Down
Loading

0 comments on commit ddd8d28

Please sign in to comment.