Class: ContractInterface

Implemented by

• Contract

Indexable

▪ [key: string]: AsyncContractFunction | any

Constructors

constructor

• new ContractInterface(): ContractInterface

Returns

ContractInterface

Properties

abi

• Abstract abi: Abi

Defined in

src/contract/interface.ts:49

---

address

• Abstract address: string

Defined in

src/contract/interface.ts:51

---

providerOrAccount

• Abstract providerOrAccount: ProviderInterface | AccountInterface

Defined in

src/contract/interface.ts:53

---

deployTransactionHash

• Optional Abstract deployTransactionHash: string

Defined in

src/contract/interface.ts:55

---

functions

• Readonly functions: Object

Index signature

▪ [name: string]: AsyncContractFunction

Defined in

src/contract/interface.ts:57

---

callStatic

• Readonly callStatic: Object

Index signature

▪ [name: string]: AsyncContractFunction

Defined in

src/contract/interface.ts:59

---

populateTransaction

• Readonly populateTransaction: Object

Index signature

▪ [name: string]: ContractFunction

Defined in

src/contract/interface.ts:61

---

estimateFee

• Readonly estimateFee: Object

Index signature

▪ [name: string]: ContractFunction

Defined in

src/contract/interface.ts:63

Methods

attach

▸ attach(address): void

Saves the address of the contract deployed on network that will be used for interaction

Parameters

Name	Type	Description
address	string	address of the contract

Returns

void

Defined in

src/contract/interface.ts:72

---

connect

▸ connect(providerOrAccount): void

Attaches to new Provider or Account

Parameters

Name	Type	Description
providerOrAccount	ProviderInterface | AccountInterface	new Provider or Account to attach to

Returns

void

Defined in

src/contract/interface.ts:79

---

deployed

▸ deployed(): Promise<ContractInterface>

Resolves when contract is deployed on the network or when no deployment transaction is found

Returns

Promise<ContractInterface>

Promise that resolves when contract is deployed on the network or when no deployment transaction is found

Throws

When deployment fails

Defined in

src/contract/interface.ts:87

---

call

▸ call(method, args?, options?): Promise<Result>

Calls a method on a contract

Parameters

Name	Type	Description
method	string	name of the method
args?	ArgsOrCalldata	Array of the arguments for the call
options?	CallOptions	optional blockIdentifier

Returns

Promise<Result>

Result of the call as an array with key value pars

Defined in

src/contract/interface.ts:97

---

invoke

▸ invoke(method, args?, options?): Promise<{ transaction_hash: string }>

Invokes a method on a contract

Parameters

Name	Type	Description
method	string	name of the method
args?	ArgsOrCalldata	Array of the arguments for the invoke or Calldata
options?	InvokeOptions

Returns

Promise<{ transaction_hash: string }>

Add Transaction Response

Defined in

src/contract/interface.ts:111

---

estimate

▸ estimate(method, args?, options?): Promise<EstimateFeeResponse>

Estimates a method on a contract

Parameters

Name	Type	Description
method	string	name of the method
args?	ArgsOrCalldata	Array of the arguments for the call or Calldata
options?	Object	optional blockIdentifier
options.blockIdentifier?	BlockIdentifier	-

Returns

Promise<EstimateFeeResponse>

Defined in

src/contract/interface.ts:124

---

populate

▸ populate(method, args?): Invocation

Calls a method on a contract

Parameters

Name	Type	Description
method	string	name of the method
args?	ArgsOrCalldata	Array of the arguments for the call or Calldata

Returns

Invocation

Invocation object

Defined in

src/contract/interface.ts:139

---

parseEvents

▸ parseEvents(receipt): ParsedEvents

Parse contract events of a GetTransactionReceiptResponse received from waitForTransaction. Based on contract's abi

Parameters

Name	Type	Description
receipt	GetTransactionReceiptResponse	transaction receipt

Returns

ParsedEvents

Events parsed

Defined in

src/contract/interface.ts:147

---

isCairo1

▸ isCairo1(): boolean

tells if the contract comes from a Cairo 1 contract

Returns

boolean

TRUE if the contract comes from a Cairo1 contract

Example

const isCairo1: boolean = myContract.isCairo1();

Defined in

src/contract/interface.ts:158

---

getVersion

▸ getVersion(): Promise<ContractVersion>

Retrieves the version of the contract (cairo version & compiler version)

Returns

Promise<ContractVersion>

Defined in

src/contract/interface.ts:163

---

typedv2

▸ typedv2<TAbi>(tAbi): TypedContractV2<TAbi>

Returns a typed instance of ContractV2 based on the supplied ABI.

Type parameters

Name	Type
TAbi	extends readonly (AbiImpl | AbiFunction | AbiInterface | AbiConstructor | AbiEvent | AbiStruct | AbiEnum)[]

Parameters

Name	Type	Description
tAbi	TAbi	The ABI (Abstract Binary Interface) of the ContractV2.

Returns

TypedContractV2<TAbi>

• A typed instance of ContractV2.

Defined in

src/contract/interface.ts:171