tornado-packages/ethers.js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: updates for EIP-1559 (#1777).

Browse Source
This commit is contained in:
Richard Moore 2021-08-09 15:40:37 -03:00
parent 1b4bc7a6a6
commit e80f8dd4e6
No known key found for this signature in database
GPG Key ID: 665176BE8E9DC651
1 changed files with 47 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
docs.wrm/api/providers/types.wrm
View File

@ -183,18 +183,46 @@ _property: transactionRequest.nonce => number | Promise<number>
The nonce for this transaction. This should be set to the number of The nonce for this transaction. This should be set to the number of
transactions ever sent **from** this address. transactions ever sent **from** this address.
_property: transactionRequest.gasLimit => [[BigNumber]] | Promise<[[BigNumber]]>
The maximum amount of gas this transaction is permitted to use.
_property: transactionRequest.gasPrice => [[BigNumber]] | Promise<[[BigNumber]]>
The price (in wei) per unit of gas this transaction will pay.
_property: transactionRequest.data => [[DataHexString]] | Promise<[[DataHexString]]> _property: transactionRequest.data => [[DataHexString]] | Promise<[[DataHexString]]>
The transaction data. The transaction data.
_property: transactionRequest.value => [[BigNumber]] | Promise<[[BigNumber]]> _property: transactionRequest.value => [[BigNumber]] | Promise<[[BigNumber]]>
The amount (in wei) this transaction is sending. The amount (in wei) this transaction is sending.
_property: transactionRequest.gasLimit => [[BigNumber]] | Promise<[[BigNumber]]>
The maximum amount of gas this transaction is permitted to use.
If left unspecified, ethers will use ``estimateGas`` to determine the value
to use. For transactions with unpredicatable gas estiamtes, this may be required
to specify explicitly.
_property: transactionRequest.gasPrice => [[BigNumber]] | Promise<[[BigNumber]]>
The price (in wei) per unit of gas this transaction will pay.
This may not be specified for transactions with ``type`` set to ``1`` or ``2``, or
if ``maxFeePerGas`` or ``maxPriorityFeePerGas`` is given.
_property: transactionRequest.maxFeePerGas => [[BigNumber]] | Promise<[[BigNumber]]>
The maximum price (in wei) per unit of gas this transaction will pay for the
[[link-eip-1559]] base fee.
Most developers should leave this unspecified and use the default value that
ethers determines from the network.
This may not be specified for transactions with ``type`` set to ``0`` or if ``gasPrice``
is specified..
_property: transactionRequest.maxPriorityFeePerGas => [[BigNumber]] | Promise<[[BigNumber]]>
The price (in wei) per unit of gas this transaction will pay for the
[[link-eip-1559]] priority fee. This is **included in** the ``maxFeePerGass``,
so this will **not affect** the total maximum cost set with ``maxFeePerGas``.
Most developers should leave this unspecified and use the default value that
ethers determines from the network.
This may not be specified for transactions with ``type`` set to ``0`` or if ``gasPrice``
is specified.
_property: transactionRequest.chainId => number | Promise<number> _property: transactionRequest.chainId => number | Promise<number>
The chain ID this transaction is authorized on, as specified by The chain ID this transaction is authorized on, as specified by
[EIP-155](link-eip-155). [EIP-155](link-eip-155).
@ -208,12 +236,13 @@ on recent versions of Geth and require configuration to enable.
_property: transactionRequest.type => null | number _property: transactionRequest.type => null | number
The [[link-eip-2718]] type of this transaction envelope, or ``null`` The [[link-eip-2718]] type of this transaction envelope, or ``null``
for legacy transactions that do not have an envelope. for to use the network default. To force using a lagacy transaction
without an envelope, use type ``0``.
_property: transactionRequest.accessList => [[providers-AccessListish]] _property: transactionRequest.accessList => [[providers-AccessListish]]
The [[providers-AccessList]] to include in an [[link-eip-2930]] transaction, which will The [[providers-AccessList]] to include; only available for [[link-eip-2930]]
include a ``type`` of ``1``. and [[link-eip-1559]] transactions.
_heading: TransactionResponse @<providers-TransactionResponse> @INHERIT<[[Transaction]]> _heading: TransactionResponse @<providers-TransactionResponse> @INHERIT<[[Transaction]]>
@ -267,15 +296,13 @@ send a new transaction from the same account with the original ``nonce``.
This is usually to speed up a transaction or to cancel one, by bribing This is usually to speed up a transaction or to cancel one, by bribing
miners with additional fees to prefer the new transaction over the original one. miners with additional fees to prefer the new transaction over the original one.
_property: transactionRequest.type => null | number _property: transactionRequest.type => number
The [[link-eip-2718]] type of this transaction. If the transaction
The [[link-eip-2718]] type of this transaction envelope, or ``null`` is a legacy transaction without an envelope, it will have the type ``0``.
for legacy transactions that do not have an envelope.
_property: transactionRequest.accessList => [[providers-AccessList]] _property: transactionRequest.accessList => [[providers-AccessList]]
The [[providers-AccessList]] included, or null for transaction types which
The [[providers-AccessList]] included in an [[link-eip-2930]] transaction, which will do not support access lists.
also have its ``type`` equal to ``1``.
_heading: TransactionReceipt @<providers-TransactionReceipt> _heading: TransactionReceipt @<providers-TransactionReceipt>
@ -299,6 +326,10 @@ _property: receipt.transactionIndex => number
The index of this transaction in the list of transactions included in The index of this transaction in the list of transactions included in
the block this transaction was mined in. the block this transaction was mined in.
_property: receipt.type => number
The [[link-eip-2718]] type of this transaction. If the transaction
is a legacy transaction without an envelope, it will have the type ``0``.
_property: receipt.root => string _property: receipt.root => string
The intermediate state root of a receipt. The intermediate state root of a receipt.