UNPKG

check-ethereum-scanner

Version:

Safety checks for new Ethereum tokens

168 lines (167 loc) 6.46 kB
/// <reference types="bn.js" /> /// <reference types="node" /> import { BN } from 'ethereumjs-util'; import Common from '@ethereumjs/common'; import { BaseTransaction } from './baseTransaction'; import { AccessList, AccessListBuffer, FeeMarketEIP1559TxData, FeeMarketEIP1559ValuesArray, JsonTx, TxOptions } from './types'; /** * Typed transaction with a new gas fee market mechanism * * - TransactionType: 2 * - EIP: [EIP-1559](https://eips.ethereum.org/EIPS/eip-1559) */ export default class FeeMarketEIP1559Transaction extends BaseTransaction<FeeMarketEIP1559Transaction> { readonly chainId: BN; readonly accessList: AccessListBuffer; readonly AccessListJSON: AccessList; readonly maxPriorityFeePerGas: BN; readonly maxFeePerGas: BN; readonly common: Common; /** * The default HF if the tx type is active on that HF * or the first greater HF where the tx is active. * * @hidden */ protected DEFAULT_HARDFORK: string; /** * EIP-2930 alias for `r` * * @deprecated use `r` instead */ get senderR(): BN | undefined; /** * EIP-2930 alias for `s` * * @deprecated use `s` instead */ get senderS(): BN | undefined; /** * EIP-2930 alias for `v` * * @deprecated use `v` instead */ get yParity(): BN | undefined; /** * Instantiate a transaction from a data dictionary. * * Format: { chainId, nonce, maxPriorityFeePerGas, maxFeePerGas, gasLimit, to, value, data, * accessList, v, r, s } * * Notes: * - `chainId` will be set automatically if not provided * - All parameters are optional and have some basic default values */ static fromTxData(txData: FeeMarketEIP1559TxData, opts?: TxOptions): FeeMarketEIP1559Transaction; /** * Instantiate a transaction from the serialized tx. * * Format: `0x02 || rlp([chainId, nonce, maxPriorityFeePerGas, maxFeePerGas, gasLimit, to, value, data, * accessList, signatureYParity, signatureR, signatureS])` */ static fromSerializedTx(serialized: Buffer, opts?: TxOptions): FeeMarketEIP1559Transaction; /** * Instantiate a transaction from the serialized tx. * (alias of {@link FeeMarketEIP1559Transaction.fromSerializedTx}) * * Note: This means that the Buffer should start with 0x01. * * @deprecated this constructor alias is deprecated and will be removed * in favor of the {@link FeeMarketEIP1559Transaction.fromSerializedTx} constructor */ static fromRlpSerializedTx(serialized: Buffer, opts?: TxOptions): FeeMarketEIP1559Transaction; /** * Create a transaction from a values array. * * Format: `[chainId, nonce, maxPriorityFeePerGas, maxFeePerGas, gasLimit, to, value, data, * accessList, signatureYParity, signatureR, signatureS]` */ static fromValuesArray(values: FeeMarketEIP1559ValuesArray, opts?: TxOptions): FeeMarketEIP1559Transaction; /** * This constructor takes the values, validates them, assigns them and freezes the object. * * It is not recommended to use this constructor directly. Instead use * the static factory methods to assist in creating a Transaction object from * varying data types. */ constructor(txData: FeeMarketEIP1559TxData, opts?: TxOptions); /** * The amount of gas paid for the data in this tx */ getDataFee(): BN; /** * The up front amount that an account must have for this transaction to be valid * @param baseFee The base fee of the block (will be set to 0 if not provided) */ getUpfrontCost(baseFee?: BN): BN; /** * Returns a Buffer Array of the raw Buffers of the EIP-1559 transaction, in order. * * Format: `[chainId, nonce, maxPriorityFeePerGas, maxFeePerGas, gasLimit, to, value, data, * accessList, signatureYParity, signatureR, signatureS]` * * Use {@link FeeMarketEIP1559Transaction.serialize} to add a transaction to a block * with {@link Block.fromValuesArray}. * * For an unsigned tx this method uses the empty Buffer values for the * signature parameters `v`, `r` and `s` for encoding. For an EIP-155 compliant * representation for external signing use {@link FeeMarketEIP1559Transaction.getMessageToSign}. */ raw(): FeeMarketEIP1559ValuesArray; /** * Returns the serialized encoding of the EIP-1559 transaction. * * Format: `0x02 || rlp([chainId, nonce, maxPriorityFeePerGas, maxFeePerGas, gasLimit, to, value, data, * accessList, signatureYParity, signatureR, signatureS])` * * Note that in contrast to the legacy tx serialization format this is not * valid RLP any more due to the raw tx type preceding and concatenated to * the RLP encoding of the values. */ serialize(): Buffer; /** * Returns the serialized unsigned tx (hashed or raw), which can be used * to sign the transaction (e.g. for sending to a hardware wallet). * * Note: in contrast to the legacy tx the raw message format is already * serialized and doesn't need to be RLP encoded any more. * * ```javascript * const serializedMessage = tx.getMessageToSign(false) // use this for the HW wallet input * ``` * * @param hashMessage - Return hashed message if set to true (default: true) */ getMessageToSign(hashMessage?: boolean): Buffer; /** * Computes a sha3-256 hash of the serialized tx. * * This method can only be used for signed txs (it throws otherwise). * Use {@link FeeMarketEIP1559Transaction.getMessageToSign} to get a tx hash for the purpose of signing. */ hash(): Buffer; /** * Computes a sha3-256 hash which can be used to verify the signature */ getMessageToVerifySignature(): Buffer; /** * Returns the public key of the sender */ getSenderPublicKey(): Buffer; _processSignature(v: number, r: Buffer, s: Buffer): FeeMarketEIP1559Transaction; /** * Returns an object with the JSON representation of the transaction */ toJSON(): JsonTx; /** * Return a compact error string representation of the object */ errorStr(): string; /** * Internal helper function to create an annotated error message * * @param msg Base error message * @hidden */ protected _errorMsg(msg: string): string; }