Onlife/node_modules/@ethereumjs/tx/dist/cjs/eip7702Transaction.d.ts
2025-04-19 15:38:48 +08:00

147 lines
6.2 KiB
TypeScript

import { BaseTransaction } from './baseTransaction.js';
import { TransactionType } from './types.js';
import type { AccessList, AccessListBytes, TxData as AllTypesTxData, TxValuesArray as AllTypesTxValuesArray, AuthorizationList, AuthorizationListBytes, JsonTx, TxOptions } from './types.js';
import type { Common } from '@ethereumjs/common';
declare type TxData = AllTypesTxData[TransactionType.EOACodeEIP7702];
declare type TxValuesArray = AllTypesTxValuesArray[TransactionType.EOACodeEIP7702];
/**
* Typed transaction with the ability to set codes on EOA accounts
*
* - TransactionType: 4
* - EIP: [EIP-7702](https://github.com/ethereum/EIPs/blob/62419ca3f45375db00b04a368ea37c0bfb05386a/EIPS/eip-7702.md)
*/
export declare class EOACodeEIP7702Transaction extends BaseTransaction<TransactionType.EOACodeEIP7702> {
readonly chainId: bigint;
readonly accessList: AccessListBytes;
readonly AccessListJSON: AccessList;
readonly authorizationList: AuthorizationListBytes;
readonly AuthorizationListJSON: AuthorizationList;
readonly maxPriorityFeePerGas: bigint;
readonly maxFeePerGas: bigint;
readonly common: Common;
/**
* 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: TxData, opts?: TxOptions): EOACodeEIP7702Transaction;
/**
* Instantiate a transaction from the serialized tx.
*
* Format: `0x04 || rlp([chainId, nonce, maxPriorityFeePerGas, maxFeePerGas, gasLimit, to, value, data,
* accessList, signatureYParity, signatureR, signatureS])`
*/
static fromSerializedTx(serialized: Uint8Array, opts?: TxOptions): EOACodeEIP7702Transaction;
/**
* Create a transaction from a values array.
*
* Format: `[chainId, nonce, maxPriorityFeePerGas, maxFeePerGas, gasLimit, to, value, data,
* accessList, signatureYParity, signatureR, signatureS]`
*/
static fromValuesArray(values: TxValuesArray, opts?: TxOptions): EOACodeEIP7702Transaction;
/**
* 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: TxData, opts?: TxOptions);
/**
* The amount of gas paid for the data in this tx
*/
getDataFee(): bigint;
/**
* Returns the minimum of calculated priority fee (from maxFeePerGas and baseFee) and maxPriorityFeePerGas
* @param baseFee Base fee retrieved from block
*/
getEffectivePriorityFee(baseFee: bigint): bigint;
/**
* 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?: bigint): bigint;
/**
* Returns a Uint8Array Array of the raw Bytes of the EIP-7702 transaction, in order.
*
* Format: `[chainId, nonce, maxPriorityFeePerGas, maxFeePerGas, gasLimit, to, value, data,
* accessList, authorizationList, signatureYParity, signatureR, signatureS]`
*
* Use {@link EOACodeEIP7702Transaction.serialize} to add a transaction to a block
* with {@link Block.fromValuesArray}.
*
* For an unsigned tx this method uses the empty Bytes values for the
* signature parameters `v`, `r` and `s` for encoding. For an EIP-155 compliant
* representation for external signing use {@link EOACodeEIP7702Transaction.getMessageToSign}.
*/
raw(): TxValuesArray;
/**
* Returns the serialized encoding of the EIP-7702 transaction.
*
* Format: `0x02 || rlp([chainId, nonce, maxPriorityFeePerGas, maxFeePerGas, gasLimit, to, value, data,
* accessList, authorizationList, 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(): Uint8Array;
/**
* Returns the raw serialized unsigned tx, 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() // use this for the HW wallet input
* ```
*/
getMessageToSign(): Uint8Array;
/**
* Returns the hashed serialized unsigned tx, 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.
*/
getHashedMessageToSign(): Uint8Array;
/**
* Computes a sha3-256 hash of the serialized tx.
*
* This method can only be used for signed txs (it throws otherwise).
* Use {@link EOACodeEIP7702Transaction.getMessageToSign} to get a tx hash for the purpose of signing.
*/
hash(): Uint8Array;
/**
* Computes a sha3-256 hash which can be used to verify the signature
*/
getMessageToVerifySignature(): Uint8Array;
/**
* Returns the public key of the sender
*/
getSenderPublicKey(): Uint8Array;
addSignature(v: bigint, r: Uint8Array | bigint, s: Uint8Array | bigint, convertV?: boolean): EOACodeEIP7702Transaction;
/**
* 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;
}
export {};
//# sourceMappingURL=eip7702Transaction.d.ts.map