Interface TransactionRequestInput

Type for transaction input

Note

Types of the properties can differ WRT ethers.TransactionRequest

interface TransactionRequestInput {
    accessList?: any;
    blockRef?: string;
    blockTag?: string;
    chainId?: string;
    chainTag?: number;
    clauses?: TransactionClause[];
    comment?: string;
    customData?: unknown;
    data?: string;
    delegationUrl?: string;
    dependsOn?: string;
    enableCcipRead?: boolean;
    expiration?: number;
    from?: string;
    gas?: string | number;
    gasLimit?: string;
    gasPayer?: string;
    gasPrice?: string;
    gasPriceCoef?: number;
    maxFeePerGas?: string | number;
    maxPriorityFeePerGas?: string | number;
    nonce?: string | number;
    provedWork?: string;
    reserved?: {
        features?: number;
        unused?: Uint8Array[];
    };
    to?: string;
    type?: number;
    value?: string | number;
}

Properties

accessList? blockRef? blockTag? chainId? chainTag? clauses? comment? customData? data? delegationUrl? dependsOn? enableCcipRead? expiration? from? gas? gasLimit? gasPayer? gasPrice? gasPriceCoef? maxFeePerGas? maxPriorityFeePerGas? nonce? provedWork? reserved? to? type? value?

Properties

OptionalaccessList

accessList?: any

The [[link-eip-2930]] access list. Storage slots included in the access list are //warmed// by preloading them, so their initial cost to fetch is guaranteed, but then each additional access is cheaper.

OptionalblockRef

blockRef?: string

8 bytes prefix of some block's ID

OptionalblockTag

blockTag?: string

When using call or estimateGas, this allows a specific block to be queried. Many backends do not support this and when unsupported errors are silently squelched and "latest" is used.

OptionalchainId

chainId?: string

The chain ID for the network this transaction is valid on.

OptionalchainTag

chainTag?: number

Last byte of genesis block ID

Optionalclauses

clauses?: TransactionClause[]

Add clauses to ethers.TransactionRequest

Optionalcomment

comment?: string

A comment describing the transaction request.

OptionalcustomData

customData?: unknown

A custom object, which can be passed along for network-specific values.

Optionaldata

data?: string

The transaction data.

OptionaldelegationUrl

delegationUrl?: string

The delegation URL to use to sponsor the transaction.

OptionaldependsOn

dependsOn?: string

The ID of the transaction that this transaction depends on.

OptionalenableCcipRead

enableCcipRead?: boolean

When using call, this enables CCIP-read, which permits the provider to be redirected to web-based content during execution, which is then further validated by the contract.

There are potential security implications allowing CCIP-read, as it could be used to expose the IP address or user activity during the fetch to unexpected parties.

Optionalexpiration

expiration?: number

The expiration time of the transaction. The transaction will expire after the number of blocks specified by this value.

Optionalfrom

from?: string

The sender of the transaction.

Optionalgas

gas?: string | number

Transaction gas.

OptionalgasLimit

gasLimit?: string

The maximum amount of gas to allow this transaction to consume.

OptionalgasPayer

gasPayer?: string

The address that pays for the gas fee of the transaction simulation. If different from the caller, then a delegated transaction is simulated.

OptionalgasPrice

gasPrice?: string

The gas price to use for legacy transactions or transactions on legacy networks.

Most of the time the max*FeePerGas is preferred.

OptionalgasPriceCoef

gasPriceCoef?: number

Coefficient used to calculate the gas price for the transaction. Value must be between 0 and 255.

OptionalmaxFeePerGas

maxFeePerGas?: string | number

The [[link-eip-1559]] maximum total fee to pay per gas. The actual value used is protocol enforced to be the block's base fee.

OptionalmaxPriorityFeePerGas

maxPriorityFeePerGas?: string | number

The [[link-eip-1559]] maximum priority fee to pay per gas.

Optionalnonce

nonce?: string | number

Nonce value for various purposes. Basic is to prevent replay attack by make transaction unique. Every transaction with same chainTag, blockRef, ... must have different nonce.

OptionalprovedWork

provedWork?: string

The VeChainThor blockchain allows for transaction-level proof of work (PoW) and converts the proved work into extra gas price that will be used by the system to generate more reward to the block generator, the Authority Masternode, that validates the transaction. In other words, users can utilize their local computational power to make their transactions more likely to be included in a new block.

Link

VeChainThor Proof of Work

Optionalreserved

reserved?: {
    features?: number;
    unused?: Uint8Array[];
}

A reserved field intended for features use.

In standard EVM transactions, this reserved field typically is not present. However, it's been designed to cater to VIP-191, which deals with fee delegation.

If the features within the reserved field is set as 1111...111, it indicates that the transaction has been delegated. The method to check if the transaction is delegated is:

reserved.features & 1 === 1

Type declaration

  • Optionalfeatures?: number

    Tx feature bits

  • Optionalunused?: Uint8Array[]

    Unused

Example

feature = 111101;
isDelegated = (111101 & 111111) === 111101; // false (not delegated)

feature = 111111;
isDelegated = (111111 & 111111) === 111111; // true (delegated)

Remarks

For more information on the subject, refer to VIP-191.

Optionalto

to?: string

The target of the transaction.

Optionaltype

type?: number

The transaction type.

Optionalvalue

value?: string | number

The transaction value (in wei).

Settings

Member Visibility

On This Page

Properties