BaseContractMethod
A Contract method can be called directly, or used in various ways.
Extended by
Type parameters
| Type parameter | Value |
|---|---|
A extends any[] | any[] |
R | any |
D extends R | ContractTransactionResponse | R | ContractTransactionResponse |
interface BaseContractMethod(...args): Promise<D>
Call the contract method with arguments.
Parameters
| Parameter | Type | Description |
|---|---|---|
…args | ContractMethodArgs<A> | The arguments to call the method with. |
Returns
Promise<D>
A promise resolving to the result of the call.
Source
Properties
| Property | Type | Description |
|---|---|---|
fragment | FunctionFragment | The fragment of the Contract method. This will throw on ambiguous method names. |
name | string | The name of the Contract method. |
Methods
estimateGas()
estimateGas(...args): Promise<bigint>
Estimate the gas to send the contract method with args.
Parameters
| Parameter | Type | Description |
|---|---|---|
…args | ContractMethodArgs<A> | The arguments to call the method with. |
Returns
Promise<bigint>
A promise resolving to the estimated gas.
Source
getFragment()
getFragment(...args): FunctionFragment
Returns the fragment constrained by args. This can be used to resolve ambiguous method names.
Parameters
| Parameter | Type | Description |
|---|---|---|
…args | ContractMethodArgs<A> | The arguments to constrain the fragment by. |
Returns
The constrained fragment.
Source
populateTransaction()
populateTransaction(...args): Promise<ContractTransaction>
Returns a populated transaction that can be used to perform the contract method with args.
Parameters
| Parameter | Type | Description |
|---|---|---|
…args | ContractMethodArgs<A> | The arguments to populate the transaction with. |
Returns
Promise<ContractTransaction>
A promise resolving to the populated transaction.
Source
send()
send(...args): Promise<ContractTransactionResponse>
Send a transaction for the contract method with args.
Parameters
| Parameter | Type | Description |
|---|---|---|
…args | ContractMethodArgs<A> | The arguments to call the method with. |
Returns
Promise<ContractTransactionResponse>
A promise resolving to the transaction response.
Source
staticCall()
staticCall(...args): Promise<R>
Call the contract method with args and return the value.
If the return value is a single type, it will be dereferenced and returned directly, otherwise the full Result will be returned.
Parameters
| Parameter | Type | Description |
|---|---|---|
…args | ContractMethodArgs<A> | The arguments to call the method with. |
Returns
Promise<R>
A promise resolving to the result of the static call.
Source
staticCallResult()
staticCallResult(...args): Promise<Result>
Call the contract method with args and return the Result without any dereferencing.
Parameters
| Parameter | Type | Description |
|---|---|---|
…args | ContractMethodArgs<A> | The arguments to call the method with. |
Returns
Promise<Result>
A promise resolving to the Result of the static call.
Source
Was this page helpful?