Class Contract<Abi>

Type Parameters

Abi

Hierarchy

Contract

Index

Properties

methodsAbi eventsAbi fieldsAbi

Constructors

Accessors

methods fields address abi

Methods

getFullState getFields transactions events waitForEvent getPastEvents decodeTransaction decodeTransactionEvents decodeInputMessage decodeOutputMessage decodeEvent

Properties

`Readonly` methodsAbi

methodsAbi: { [ K in never]: Extract<AbiFunctions<Abi>, {
name: K;
}> }

`Readonly` eventsAbi

eventsAbi: { [ K in never]: Extract<AbiEvents<Abi>, {
name: K;
}> }

`Readonly` fieldsAbi

fieldsAbi: AbiFields<Abi>

Constructors

constructor

new Contract<Abi>(provider: ProviderRpcClient, abi: Abi, address: Address): Contract<Abi>
Type Parameters
- Abi
Parameters
- provider: ProviderRpcClient
- abi: Abi
- address: Address
Returns Contract<Abi>
- Defined in src/contract.ts:44

Accessors

methods

get methods(): ContractMethods<Abi>
Returns ContractMethods<Abi>
- Defined in src/contract.ts:122

fields

get fields(): ContractFields<Abi>
Returns ContractFields<Abi>
- Defined in src/contract.ts:126

address

get address(): Address
Returns Address
- Defined in src/contract.ts:130

abi

get abi(): string
Returns string
- Defined in src/contract.ts:134

Methods

getFullState

getFullState(): Promise<{
state: undefined | FullContractState;
}>
Requests contract data

Required permissions: basic

Returns Promise<{
state: undefined | FullContractState;
}>
- Defined in src/contract.ts:144

getFields

getFields(args?: GetContractFieldsParams): Promise<{
fields?: DecodedAbiFields<Abi>;
state?: FullContractState;
}>
Unpacks all fields from the contract state using the specified ABI

Required permissions: basic
Parameters
- args: GetContractFieldsParams = {}
Returns Promise<{
fields?: DecodedAbiFields<Abi>;
state?: FullContractState;
}>
- Defined in src/contract.ts:157

transactions

transactions(subscriber: Subscriber): Stream<unknown, Transaction<Address>, false>
Creates new contract transactions stream
Parameters
- subscriber: Subscriber
Returns Stream<unknown, Transaction<Address>, false>
- Defined in src/contract.ts:180

events

events(subscriber: Subscriber): Stream<unknown, DecodedEventWithTransaction<Abi, AbiEventName<Abi>>, false>
Creates new contract events stream
Parameters
- subscriber: Subscriber
Returns Stream<unknown, DecodedEventWithTransaction<Abi, AbiEventName<Abi>>, false>
- Defined in src/contract.ts:189

waitForEvent

waitForEvent<E>(args?: WaitForEventParams<Abi, E>): Promise<undefined | DecodedEvent<Abi, E>>
Type Parameters
- E extends never = AbiEventName<Abi>
Parameters
- args: WaitForEventParams<Abi, E> = {}
Returns Promise<undefined | DecodedEvent<Abi, E>>
- Defined in src/contract.ts:201

getPastEvents

getPastEvents<E>(args: GetPastEventParams<Abi, E>): Promise<EventsBatch<Abi, E>>
Type Parameters
- E extends never = AbiEventName<Abi>
Parameters
- args: GetPastEventParams<Abi, E>
Returns Promise<EventsBatch<Abi, E>>
- Defined in src/contract.ts:249

decodeTransaction

decodeTransaction(args: DecodeTransactionParams<Abi>): Promise<undefined | DecodedTransaction<Abi, AbiFunctionName<Abi>>>
Parameters
- args: DecodeTransactionParams<Abi>
Returns Promise<undefined | DecodedTransaction<Abi, AbiFunctionName<Abi>>>
- Defined in src/contract.ts:324

decodeTransactionEvents

decodeTransactionEvents(args: DecodeTransactionEventsParams): Promise<DecodedEvent<Abi, AbiEventName<Abi>>[]>
Parameters
- args: DecodeTransactionEventsParams
Returns Promise<DecodedEvent<Abi, AbiEventName<Abi>>[]>
- Defined in src/contract.ts:352

decodeInputMessage

decodeInputMessage(args: DecodeInputParams<Abi>): Promise<undefined | DecodedInput<Abi, AbiFunctionName<Abi>>>
Parameters
- args: DecodeInputParams<Abi>
Returns Promise<undefined | DecodedInput<Abi, AbiFunctionName<Abi>>>
- Defined in src/contract.ts:379

decodeOutputMessage

decodeOutputMessage(args: DecodeOutputParams<Abi>): Promise<undefined | DecodedOutput<Abi, AbiFunctionName<Abi>>>
Parameters
- args: DecodeOutputParams<Abi>
Returns Promise<undefined | DecodedOutput<Abi, AbiFunctionName<Abi>>>
- Defined in src/contract.ts:407

decodeEvent

decodeEvent(args: DecodeEventParams<Abi>): Promise<undefined | DecodedEvent<Abi, AbiEventName<Abi>>>
Parameters
- args: DecodeEventParams<Abi>
Returns Promise<undefined | DecodedEvent<Abi, AbiEventName<Abi>>>
- Defined in src/contract.ts:434