Class BaseContract<T>

Represents the base contract class.

Type Parameters

T extends BaseContractProperties

Hierarchy (view full)

IBaseContract<T>
- BaseContract

Index

Constructors

Properties

[internal] address from? interface provider

Methods

decodeEvent decodeEvents encodeCalldata getFunction setSender

Constructors

constructor

new BaseContract<T>(address, abi, provider, sender?): BaseContract<T>
Type Parameters
- T extends BaseContractProperties
Parameters
- address: BitcoinAddressLike
- abi: BitcoinInterface | BitcoinInterfaceAbi
- provider: AbstractRpcProvider
- Optionalsender: string
Returns BaseContract<T>
Overrides IBaseContract.constructor
- Defined in src/contracts/Contract.ts:507

Properties

`Protected` `Readonly`[internal]

[internal]: undefined | keyof T

The internal functions of the contract.

`Readonly`address

address: BitcoinAddressLike

The address of the contract.

`Optional`from

from?: string

Who is sending the transaction.

`Readonly`interface

interface: BitcoinInterface

The interface of the contract.

`Readonly`provider

provider: AbstractRpcProvider

A generic provider for the contract.

Methods

decodeEvent

decodeEvent(event): OPNetEvent<{}>
Parameters
- event: NetEvent
Returns OPNetEvent<{}>
Inherited from IBaseContract.decodeEvent
- Defined in src/contracts/Contract.ts:107

decodeEvents

decodeEvents(events): OPNetEvent<{}>[]
Parameters
- events: ContractEvents | NetEvent[]
Returns OPNetEvent<{}>[]
Inherited from IBaseContract.decodeEvents
- Defined in src/contracts/Contract.ts:89

encodeCalldata

encodeCalldata(functionName, args): Buffer
Encodes the calldata for a function.
Parameters
- functionName: string
  The name of the function.
- args: unknown[]
  The arguments for the function.
Returns Buffer
The encoded calldata.
Inherited from IBaseContract.encodeCalldata
- Defined in src/contracts/Contract.ts:132

`Protected`getFunction

getFunction(name):
    | undefined
    | string
    | number
    | symbol
    | BaseContractProperty
    | ((functionName: string, args: unknown[]) => Buffer)
Parameters
- name: string | symbol
Returns
    | undefined
    | string
    | number
    | symbol
    | BaseContractProperty
    | ((functionName: string, args: unknown[]) => Buffer)
Inherited from IBaseContract.getFunction
- Defined in src/contracts/Contract.ts:143

setSender

setSender(sender): void
Sets the sender of the transaction.
Parameters
- sender: string
  The sender of the transaction.
Returns void
Inherited from IBaseContract.setSender
- Defined in src/contracts/Contract.ts:85