Class SmartContractInterface

constructor

• new SmartContractInterface(address, abi, rpcOptions): SmartContractInterface

• Parameters

  • address: string

    Address of the smart contract

  • abi: ABILike

    Contract ABI

  • rpcOptions: RPCOptions

    RPC options

  Returns SmartContractInterface

abi

address

rpcOptions

callMutableMethod

• callMutableMethod(method, params, options): Promise<TransactionResult<void>>

• Calls a mutable, non-payable method This sends a transaction

  Parameters

  • method: string | FunctionFragment

    The method name (must be in the ABI)

  • params: InputABIParams

    The parameters for the method

  • options: MethodTransactionOptions

    The options for sending the transaction

  Returns Promise<TransactionResult<void>>

  The transaction receipt

callPayableMethod

• callPayableMethod(method, params, value, options): Promise<TransactionResult<void>>

• Calls a mutable, payable method This sends a transaction

  Parameters

  • method: string | FunctionFragment

    The method name (must be in the ABI)

  • params: InputABIParams

    The parameters for the method

  • value: QuantityLike

    The value to send (wei)

  • options: MethodTransactionOptions

    The options for sending the transaction

  Returns Promise<TransactionResult<void>>

  The transaction receipt

callViewMethod

• callViewMethod(method, params, options): Promise<OutputABIParams>

• Calls a view or pure method

  Parameters

  • method: string | FunctionFragment

    The method name (must be in the ABI)

  • params: InputABIParams

    The parameters for the method

  • options: MethodCallingOptions

    The options for calling the method

  Returns Promise<OutputABIParams>

  The decoded method result

encodeMutableMethod

• encodeMutableMethod(method, params): TransactionBuildDetails

• Encodes a mutable, non-payable method

  Parameters

  • method: string | FunctionFragment

    The method name (must be in the ABI)

  • params: InputABIParams

    The parameters for the method

  Returns TransactionBuildDetails

  The details to build the transaction

encodePayableMethod

• encodePayableMethod(method, params, value): TransactionBuildDetails

• Encodes a mutable, payable method

  Parameters

  • method: string | FunctionFragment

    The method name (must be in the ABI)

  • params: InputABIParams

    The parameters for the method

  • value: QuantityLike

    The value to send (wei)

  Returns TransactionBuildDetails

  The details to build the transaction

findEvent

• findEvent(receipt, name): SmartContractEvent

• Finds event in transaction receipt

  Parameters

  • receipt: TransactionReceipt

    Transaction recept

  • name: string

    Event name

  Returns SmartContractEvent

  The event, or null if not found

findEvents

• findEvents(fromBlock, toBlock): Promise<SmartContractEvent[]>

• Finds smart contract events in a block range

  Parameters

  • fromBlock: string | number | bigint

    First block in the range

  • toBlock: string | number | bigint

    Last block in the range

  Returns Promise<SmartContractEvent[]>

  The array of parsed events

parseTransactionLogs

• parseTransactionLogs(logs): SmartContractEvent[]

• Parses transaction logs

  Parameters

  • logs: TransactionLog[]

    Transaction logs

  Returns SmartContractEvent[]

  The smart contract events