Class: Contract<Abi> ​

Type parameters ​

Table of contents ​

Constructors ​

• constructor

Accessors ​

• methods
• fields
• address
• abi

Methods ​

• getFullState
• getFields
• transactions
• events
• waitForEvent
• getPastEvents
• decodeTransaction
• decodeTransactionEvents
• decodeInputMessage
• decodeOutputMessage
• decodeEvent

Constructors ​

constructor ​

• new Contract<Abi>(provider, abi, address)

Type parameters ​

Parameters ​

Defined in ​

src/contract.ts:40

Accessors ​

methods ​

• get methods(): ContractMethods<Abi>

Returns ​

ContractMethods<Abi>

Defined in ​

src/contract.ts:106

fields ​

• get fields(): ContractFields<Abi>

Returns ​

ContractFields<Abi>

Defined in ​

src/contract.ts:110

address ​

• get address(): Address

Returns ​

Address

Defined in ​

src/contract.ts:114

abi ​

• get abi(): string

Returns ​

string

Defined in ​

src/contract.ts:118

Methods ​

getFullState ​

▸ getFullState(): Promise<{ state: undefined | FullContractState }>

Requests contract data

Required permissions: basic

Returns ​

Promise<{ state: undefined | FullContractState }>

Defined in ​

src/contract.ts:128

getFields ​

▸ getFields(args?): Promise<{ fields?: DecodedAbiFields<Abi> ; state?: FullContractState }>

Unpacks all fields from the contract state using the specified ABI

Required permissions: basic

Parameters ​

Returns ​

Promise<{ fields?: DecodedAbiFields<Abi> ; state?: FullContractState }>

Defined in ​

src/contract.ts:141

transactions ​

▸ transactions(subscriber): Stream<unknown, Transaction<Address>, false>

Creates new contract transactions stream

Parameters ​

Returns ​

Stream<unknown, Transaction<Address>, false>

Defined in ​

src/contract.ts:163

events ​

▸ events(subscriber): Stream<unknown, DecodedEventWithTransaction<Abi, AbiEventName<Abi>>, false>

Creates new contract events stream

Parameters ​

Returns ​

Stream<unknown, DecodedEventWithTransaction<Abi, AbiEventName<Abi>>, false>

Defined in ​

src/contract.ts:172

waitForEvent ​

▸ waitForEvent<E>(args?): Promise<undefined | DecodedEvent<Abi, E>>

Type parameters ​

Parameters ​

Returns ​

Promise<undefined | DecodedEvent<Abi, E>>

Defined in ​

src/contract.ts:184

getPastEvents ​

▸ getPastEvents<E>(args): Promise<EventsBatch<Abi, E>>

Type parameters ​

Parameters ​

Returns ​

Promise<EventsBatch<Abi, E>>

Defined in ​

src/contract.ts:232

decodeTransaction ​

▸ decodeTransaction(args): Promise<undefined | DecodedTransaction<Abi, AbiFunctionName<Abi>>>

Parameters ​

Returns ​

Promise<undefined | DecodedTransaction<Abi, AbiFunctionName<Abi>>>

Defined in ​

src/contract.ts:307

decodeTransactionEvents ​

▸ decodeTransactionEvents(args): Promise<DecodedEvent<Abi, AbiEventName<Abi>>[]>

Parameters ​

Returns ​

Promise<DecodedEvent<Abi, AbiEventName<Abi>>[]>

Defined in ​

src/contract.ts:335

decodeInputMessage ​

▸ decodeInputMessage(args): Promise<undefined | DecodedInput<Abi, AbiFunctionName<Abi>>>

Parameters ​

Returns ​

Promise<undefined | DecodedInput<Abi, AbiFunctionName<Abi>>>

Defined in ​

src/contract.ts:362

decodeOutputMessage ​

▸ decodeOutputMessage(args): Promise<undefined | DecodedOutput<Abi, AbiFunctionName<Abi>>>

Parameters ​

Returns ​

Promise<undefined | DecodedOutput<Abi, AbiFunctionName<Abi>>>

Defined in ​

src/contract.ts:390

decodeEvent ​

▸ decodeEvent(args): Promise<undefined | DecodedEvent<Abi, AbiEventName<Abi>>>

Parameters ​

Returns ​

Promise<undefined | DecodedEvent<Abi, AbiEventName<Abi>>>

Defined in ​

src/contract.ts:417