TevmNode
TevmNode<
TMode
,TExtended
>:object
&EIP1193EventEmitter
&TExtended
The base client used by Tevm. Add extensions to add additional functionality
Type declaration
deepCopy()
readonly
deepCopy: () =>Promise
<TevmNode
<TMode
,TExtended
>>
Copies the current client state into a new client
Returns
Promise
<TevmNode
<TMode
, TExtended
>>
extend()
readonly
extend: <TExtension
>(decorator
) =>TevmNode
<TMode
,TExtended
&TExtension
>
Extends the base client with additional functionality. This enables optimal code splitting and extensibility
Type Parameters
• TExtension extends Record
<string
, any
>
Parameters
• decorator
Returns
TevmNode
<TMode
, TExtended
& TExtension
>
forkTransport?
readonly
optional
forkTransport:object
Client to make json rpc requests to a forked node
Example
forkTransport.request
forkTransport.request:
EIP1193RequestFn
getFilters()
Gets all registered filters mapped by id
Returns
getImpersonatedAccount()
readonly
getImpersonatedAccount: () =>Address
|undefined
The currently impersonated account. This is only used in fork
mode
Returns
Address
| undefined
getReceiptsManager()
readonly
getReceiptsManager: () =>Promise
<ReceiptsManager
>
Interface for querying receipts and historical state
Returns
Promise
<ReceiptsManager
>
getTxPool()
readonly
getTxPool: () =>Promise
<TxPool
>
Gets the pool of pending transactions to be included in next block
Returns
Promise
<TxPool
>
getVm()
readonly
getVm: () =>Promise
<Vm
>
Internal instance of the VM. Can be used for lower level operations. Normally not recomended to use unless building libraries or extensions on top of Tevm.
Returns
Promise
<Vm
>
logger
readonly
logger:Logger
The logger instance
miningConfig
readonly
miningConfig:MiningConfig
The configuration for mining. Defaults to ‘auto'
- 'auto’ will mine a block on every transaction
- ’interval’ will mine a block every
interval
milliseconds - ’manual’ will not mine a block automatically and requires a manual call to
mineBlock
mode
readonly
mode:TMode
The mode the current client is running in
fork
mode will fetch and cache all state from the block forked from the provided URL
normal
mode will not fetch any state and will only run the EVM in memory
Example
ready()
readonly
ready: () =>Promise
<true
>
Returns promise that resulves when the client is ready The client is usable without calling this method but may have extra latency on the first call from initialization
Example
Returns
Promise
<true
>
removeFilter()
readonly
removeFilter: (id
) =>void
Removes a filter by id
Parameters
• id: Hex
Returns
void
setFilter()
readonly
setFilter: (filter
) =>void
Creates a new filter to watch for logs events and blocks
Parameters
• filter: Filter
Returns
void
setImpersonatedAccount()
readonly
setImpersonatedAccount: (address
) =>void
Sets the account to impersonate. This will allow the client to act as if it is that account On Ethereum JSON_RPC endpoints. Pass in undefined to stop impersonating
Parameters
• address: Address
| undefined
Returns
void
status
status:
"INITIALIZING"
|"READY"
|"SYNCING"
|"MINING"
|"STOPPED"
Returns status of the client
- INITIALIZING: The client is initializing
- READY: The client is ready to be used
- SYNCING: The client is syncing with the forked node
- MINING: The client is mining a block
Type Parameters
• TMode extends "fork"
| "normal"
= "fork"
| "normal"
• TExtended = object