Class BaseContract<T>

Represents the base contract class.

Type Parameters

T extends BaseContractProperties

Hierarchy (View Summary)

IBaseContract<T>
- BaseContract

Index

Constructors

Properties

[internal] address from? interface network provider

Accessors

contractAddress p2opOrTweaked

Methods

currentGasParameters decodeEvent decodeEvents encodeCalldata getFunction setAccessList setSender setSimulatedHeight setTransactionDetails

Constructors

constructor

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

Properties

`Protected` `Readonly`[internal]

"[internal]": undefined | keyof T

The internal functions of the contract.

`Readonly`address

address: string | Address

The address of the contract.

`Optional`from

from?: Address

Who is sending the transaction.

`Readonly`interface

interface: BitcoinInterface

The interface of the contract.

`Readonly`network

network: Network

The address of the contract.

`Readonly`provider

provider: AbstractRpcProvider

A generic provider for the contract.

Accessors

contractAddress

get contractAddress(): Promise<Address>
Gets the contract address as an Address object.

Returns Promise<Address>
The contract address as an Address object.
Inherited from IBaseContract.contractAddress
- Defined in src/contracts/Contract.ts:134

p2opOrTweaked

get p2opOrTweaked(): string
The P2OP address of the contract.

Returns string
The P2OP address of the contract.
Inherited from IBaseContract.p2opOrTweaked
- Defined in src/contracts/Contract.ts:122

Methods

currentGasParameters

currentGasParameters(): Promise<BlockGasParameters>
Returns Promise<BlockGasParameters>
Inherited from IBaseContract.currentGasParameters
- Defined in src/contracts/Contract.ts:227

decodeEvent

decodeEvent(event: NetEvent): OPNetEvent
Decodes a single event.
Parameters
- event: NetEvent
  The event to decode.
Returns OPNetEvent
The decoded event.
Inherited from IBaseContract.decodeEvent
- Defined in src/contracts/Contract.ts:195

decodeEvents

decodeEvents(
events: ContractEvents | NetEvent[],
): OPNetEvent<ContractDecodedObjectResult>[]
Decodes the events from the contract.
Parameters
- events: ContractEvents | NetEvent[]
  The events to decode.
Returns OPNetEvent<ContractDecodedObjectResult>[]
The decoded events.
Inherited from IBaseContract.decodeEvents
- Defined in src/contracts/Contract.ts:159

encodeCalldata

encodeCalldata(functionName: string, args: unknown[]): 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:216

`Protected`getFunction

getFunction(
    name: string | symbol,
):
    | undefined
    | string
    | number
    | symbol
    | Address
    | Network
    | CallResult<{}, OPNetEvent<ContractDecodedObjectResult>[]>
    | (() => Promise<BlockGasParameters>)
    | ((functionName: string, args: unknown[]) => Buffer)
Parameters
- name: string | symbol
Returns
    | undefined
    | string
    | number
    | symbol
    | Address
    | Network
    | CallResult<{}, OPNetEvent<ContractDecodedObjectResult>[]>
    | (() => Promise<BlockGasParameters>)
    | ((functionName: string, args: unknown[]) => Buffer)
Inherited from IBaseContract.getFunction
- Defined in src/contracts/Contract.ts:263

setAccessList

setAccessList(accessList: IAccessList): void
Parameters
- accessList: IAccessList
Returns void
Inherited from IBaseContract.setAccessList
- Defined in src/contracts/Contract.ts:255

setSender

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

setSimulatedHeight

setSimulatedHeight(height: undefined | bigint): void
Parameters
- height: undefined | bigint
Returns void
Inherited from IBaseContract.setSimulatedHeight
- Defined in src/contracts/Contract.ts:259

setTransactionDetails

setTransactionDetails(tx: ParsedSimulatedTransaction): void
Parameters
- tx: ParsedSimulatedTransaction
Returns void
Inherited from IBaseContract.setTransactionDetails
- Defined in src/contracts/Contract.ts:243