BaseEVMToolbox
BaseEVMToolbox<
P
,S
>(__namedParameters
):object
Defined in: packages/toolboxes/src/evm/toolbox/baseEVMToolbox.ts:52
Type Parameters
Section titled “Type Parameters”P
extends BrowserProvider
| Provider
S
extends undefined
| ChainSigner
<EVMTransferParams
, string
> & Signer
| JsonRpcSigner
| HDNodeWallet
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”chain?
Section titled “chain?”EVMChain
= Chain.Ethereum
isEIP1559Compatible?
Section titled “isEIP1559Compatible?”boolean
= true
provider
Section titled “provider”P
signer
Section titled “signer”S
Returns
Section titled “Returns”object
approve()
Section titled “approve()”approve: (
__namedParameters
) =>Promise
<string
>
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Promise
<string
>
approvedAmount()
Section titled “approvedAmount()”approvedAmount: (
__namedParameters
) =>Promise
<bigint
>
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Promise
<bigint
>
broadcastTransaction
Section titled “broadcastTransaction”broadcastTransaction: (
signedTx
) =>Promise
<TransactionResponse
> | (signedTx
) =>Promise
<TransactionResponse
> =provider.broadcastTransaction
Type declaration
Section titled “Type declaration”(signedTx
) => Promise
<TransactionResponse
>
Broadcasts the %%signedTx%% to the network, adding it to the memory pool of any node for which the transaction meets the rebroadcast requirements.
Parameters
Section titled “Parameters”signedTx
Section titled “signedTx”string
Returns
Section titled “Returns”Promise
<TransactionResponse
>
(signedTx
) => Promise
<TransactionResponse
>
Broadcasts the %%signedTx%% to the network, adding it to the memory pool of any node for which the transaction meets the rebroadcast requirements.
Parameters
Section titled “Parameters”signedTx
Section titled “signedTx”string
Returns
Section titled “Returns”Promise
<TransactionResponse
>
call()
Section titled “call()”call: <
T
>(__namedParameters
) =>Promise
<T
>
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Promise
<T
>
createApprovalTx()
Section titled “createApprovalTx()”createApprovalTx: (
__namedParameters
) =>Promise
<ContractTransaction
>
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Promise
<ContractTransaction
>
createContract()
Section titled “createContract()”createContract: (
address
,abi
) =>Contract
Parameters
Section titled “Parameters”address
Section titled “address”string
readonly (JsonFragment
| Fragment
)[]
Returns
Section titled “Returns”Contract
createContractTxObject()
Section titled “createContractTxObject()”createContractTxObject: (
__namedParameters
) =>Promise
<ContractTransaction
>
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Promise
<ContractTransaction
>
createTransaction()
Section titled “createTransaction()”createTransaction: (
__namedParameters
) =>Promise
<ContractTransaction
>
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Promise
<ContractTransaction
>
createTransferTx()
Section titled “createTransferTx()”createTransferTx: (
__namedParameters
) =>Promise
<ContractTransaction
>
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Promise
<ContractTransaction
>
EIP1193SendTransaction()
Section titled “EIP1193SendTransaction()”EIP1193SendTransaction: (
__namedParameters
) =>Promise
<string
>
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”EVMTxParams
| ContractTransaction
Returns
Section titled “Returns”Promise
<string
>
estimateCall()
Section titled “estimateCall()”estimateCall: (
__namedParameters
) =>Promise
<bigint
>
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Promise
<bigint
>
estimateGasLimit()
Section titled “estimateGasLimit()”estimateGasLimit: (
__namedParameters
) =>Promise
<bigint
>
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”GenericTransferParams
& object
& object
Returns
Section titled “Returns”Promise
<bigint
>
estimateGasPrices()
Section titled “estimateGasPrices()”estimateGasPrices: () =>
Promise
<{average
: {gasPrice?
:bigint
;l1GasPrice?
:bigint
;maxFeePerGas?
:bigint
;maxPriorityFeePerGas?
:bigint
; };fast
: {gasPrice?
:bigint
;l1GasPrice?
:bigint
;maxFeePerGas?
:bigint
;maxPriorityFeePerGas?
:bigint
; };fastest
: {gasPrice?
:bigint
;l1GasPrice?
:bigint
;maxFeePerGas?
:bigint
;maxPriorityFeePerGas?
:bigint
; }; }>
Returns
Section titled “Returns”Promise
<{ average
: { gasPrice?
: bigint
; l1GasPrice?
: bigint
; maxFeePerGas?
: bigint
; maxPriorityFeePerGas?
: bigint
; }; fast
: { gasPrice?
: bigint
; l1GasPrice?
: bigint
; maxFeePerGas?
: bigint
; maxPriorityFeePerGas?
: bigint
; }; fastest
: { gasPrice?
: bigint
; l1GasPrice?
: bigint
; maxFeePerGas?
: bigint
; maxPriorityFeePerGas?
: bigint
; }; }>
getAddress()
Section titled “getAddress()”getAddress: () =>
undefined
|Promise
<string
>
Returns
Section titled “Returns”undefined
| Promise
<string
>
isApproved()
Section titled “isApproved()”isApproved: (
__namedParameters
) =>Promise
<boolean
>
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Promise
<boolean
>
sendTransaction()
Section titled “sendTransaction()”sendTransaction: (
__namedParameters
) =>Promise
<string
>
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”EVMTxParams
& object
Returns
Section titled “Returns”Promise
<string
>
signMessage
Section titled “signMessage”signMessage:
undefined
| (message
) =>Promise
<string
> | (message
) =>Promise
<string
> | (_message
) =>Promise
<string
> =signer.signMessage
Type declaration
Section titled “Type declaration”undefined
(message
) => Promise
<string
>
Signs an [[link-eip-191]] prefixed personal message.
If the %%message%% is a string, it is signed as UTF-8 encoded bytes. It is not
interpretted as a [[BytesLike]]; so the string "0x1234"
is signed as six
characters, not two bytes.
To sign that example as two bytes, the Uint8Array should be used
(i.e. new Uint8Array([ 0x12, 0x34 ])
).
Parameters
Section titled “Parameters”message
Section titled “message”string
| Uint8Array
<ArrayBufferLike
>
Returns
Section titled “Returns”Promise
<string
>
(message
) => Promise
<string
>
Parameters
Section titled “Parameters”message
Section titled “message”string
| Uint8Array
<ArrayBufferLike
>
Returns
Section titled “Returns”Promise
<string
>
(_message
) => Promise
<string
>
Parameters
Section titled “Parameters”_message
Section titled “_message”string
| Uint8Array
<ArrayBufferLike
>
Returns
Section titled “Returns”Promise
<string
>
transfer()
Section titled “transfer()”transfer: (
__namedParameters
) =>Promise
<string
>
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Promise
<string
>
validateAddress()
Section titled “validateAddress()”validateAddress: (
address
) =>boolean
Parameters
Section titled “Parameters”address
Section titled “address”string
Returns
Section titled “Returns”boolean