"use strict"; import { getAddress } from "@ethersproject/address"; import { BigNumber, BigNumberish } from "@ethersproject/bignumber"; import { arrayify, BytesLike, DataOptions, hexDataSlice, hexlify, hexZeroPad, isBytesLike, SignatureLike, splitSignature, stripZeros, } from "@ethersproject/bytes"; import { Zero } from "@ethersproject/constants"; import { keccak256 } from "@ethersproject/keccak256"; import { checkProperties } from "@ethersproject/properties"; import * as RLP from "@ethersproject/rlp"; import { computePublicKey, recoverPublicKey } from "@ethersproject/signing-key"; import { Logger } from "@ethersproject/logger"; import { version } from "./_version"; const logger = new Logger(version); /////////////////////////////// // Exported Types export type UnsignedTransaction = { to?: string; nonce?: number; gasLimit?: BigNumberish; gasPrice?: BigNumberish; data?: BytesLike; value?: BigNumberish; chainId?: number; } export interface Transaction { hash?: string; to?: string; from?: string; nonce: number; gasLimit: BigNumber; gasPrice: BigNumber; data: string; value: BigNumber; chainId: number; r?: string; s?: string; v?: number; } /////////////////////////////// function handleAddress(value: string): string { if (value === "0x") { return null; } return getAddress(value); } function handleNumber(value: string): BigNumber { if (value === "0x") { return Zero; } return BigNumber.from(value); } const transactionFields = [ { name: "nonce", maxLength: 32, numeric: true }, { name: "gasPrice", maxLength: 32, numeric: true }, { name: "gasLimit", maxLength: 32, numeric: true }, { name: "to", length: 20 }, { name: "value", maxLength: 32, numeric: true }, { name: "data" }, ]; const allowedTransactionKeys: { [ key: string ]: boolean } = { chainId: true, data: true, gasLimit: true, gasPrice:true, nonce: true, to: true, value: true } export function computeAddress(key: BytesLike | string): string { const publicKey = computePublicKey(key); return getAddress(hexDataSlice(keccak256(hexDataSlice(publicKey, 1)), 12)); } export function recoverAddress(digest: BytesLike, signature: SignatureLike): string { return computeAddress(recoverPublicKey(arrayify(digest), signature)); } export function serialize(transaction: UnsignedTransaction, signature?: SignatureLike): string { checkProperties(transaction, allowedTransactionKeys); const raw: Array = []; transactionFields.forEach(function(fieldInfo) { let value = (transaction)[fieldInfo.name] || ([]); const options: DataOptions = { }; if (fieldInfo.numeric) { options.hexPad = "left"; } value = arrayify(hexlify(value, options)); // Fixed-width field if (fieldInfo.length && value.length !== fieldInfo.length && value.length > 0) { logger.throwArgumentError("invalid length for " + fieldInfo.name, ("transaction:" + fieldInfo.name), value); } // Variable-width (with a maximum) if (fieldInfo.maxLength) { value = stripZeros(value); if (value.length > fieldInfo.maxLength) { logger.throwArgumentError("invalid length for " + fieldInfo.name, ("transaction:" + fieldInfo.name), value ); } } raw.push(hexlify(value)); }); let chainId = 0; if (transaction.chainId != null) { // A chainId was provided; if non-zero we'll use EIP-155 chainId = transaction.chainId; if (typeof(chainId) !== "number") { logger.throwArgumentError("invalid transaction.chainId", "transaction", transaction); } } else if (signature && !isBytesLike(signature) && signature.v > 28) { // No chainId provided, but the signature is signing with EIP-155; derive chainId chainId = Math.floor((signature.v - 35) / 2); } // We have an EIP-155 transaction (chainId was specified and non-zero) if (chainId !== 0) { raw.push(hexlify(chainId)); // @TODO: hexValue? raw.push("0x"); raw.push("0x"); } // Requesting an unsigned transation if (!signature) { return RLP.encode(raw); } // The splitSignature will ensure the transaction has a recoveryParam in the // case that the signTransaction function only adds a v. const sig = splitSignature(signature); // We pushed a chainId and null r, s on for hashing only; remove those let v = 27 + sig.recoveryParam if (chainId !== 0) { raw.pop(); raw.pop(); raw.pop(); 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); } raw.push(hexlify(v)); raw.push(stripZeros(arrayify(sig.r))); raw.push(stripZeros(arrayify(sig.s))); return RLP.encode(raw); } export function parse(rawTransaction: BytesLike): Transaction { const transaction = RLP.decode(rawTransaction); if (transaction.length !== 9 && transaction.length !== 6) { logger.throwArgumentError("invalid raw transaction", "rawTransaction", rawTransaction); } const tx: Transaction = { nonce: handleNumber(transaction[0]).toNumber(), gasPrice: handleNumber(transaction[1]), gasLimit: handleNumber(transaction[2]), to: handleAddress(transaction[3]), value: handleNumber(transaction[4]), data: transaction[5], chainId: 0 }; // Legacy unsigned transaction if (transaction.length === 6) { return tx; } try { tx.v = BigNumber.from(transaction[6]).toNumber(); } catch (error) { console.log(error); return tx; } tx.r = hexZeroPad(transaction[7], 32); tx.s = hexZeroPad(transaction[8], 32); if (BigNumber.from(tx.r).isZero() && BigNumber.from(tx.s).isZero()) { // EIP-155 unsigned transaction tx.chainId = tx.v; tx.v = 0; } else { // Signed Tranasaction tx.chainId = Math.floor((tx.v - 35) / 2); if (tx.chainId < 0) { tx.chainId = 0; } let recoveryParam = tx.v - 27; const raw = transaction.slice(0, 6); if (tx.chainId !== 0) { raw.push(hexlify(tx.chainId)); raw.push("0x"); raw.push("0x"); recoveryParam -= tx.chainId * 2 + 8; } const digest = keccak256(RLP.encode(raw)); try { tx.from = recoverAddress(digest, { r: hexlify(tx.r), s: hexlify(tx.s), recoveryParam: recoveryParam }); } catch (error) { console.log(error); } tx.hash = keccak256(rawTransaction); } return tx; }