Class: Contract

Implements

• ContractInterface

Indexable

▪ [key: string]: AsyncContractFunction | any

Constructors

constructor

• new Contract(abi, address, providerOrAccount?)

Contract class to handle contract methods

Parameters

Name	Type	Default value	Description
abi	Abi	undefined	Abi of the contract object
address	string	undefined	(optional) - address to connect to
providerOrAccount	ProviderInterface | AccountInterface	defaultProvider	(optional) - Provider or Account to attach to

Defined in

src/contract/default.ts:148

Properties

abi

• abi: Abi

Implementation of

ContractInterface.abi

Defined in

src/contract/default.ts:117

---

address

• address: string

Implementation of

ContractInterface.address

Defined in

src/contract/default.ts:119

---

providerOrAccount

• providerOrAccount: ProviderInterface | AccountInterface

Implementation of

ContractInterface.providerOrAccount

Defined in

src/contract/default.ts:121

---

deployTransactionHash

• Optional deployTransactionHash: string

Implementation of

ContractInterface.deployTransactionHash

Defined in

src/contract/default.ts:123

---

structs

• Protected Readonly structs: Object

Index signature

▪ [name: string]: StructAbi

Defined in

src/contract/default.ts:125

---

events

• Protected Readonly events: AbiEvents

Defined in

src/contract/default.ts:127

---

functions

• Readonly functions: Object

Index signature

▪ [name: string]: AsyncContractFunction

Implementation of

ContractInterface.functions

Defined in

src/contract/default.ts:129

---

callStatic

• Readonly callStatic: Object

Index signature

▪ [name: string]: AsyncContractFunction

Implementation of

ContractInterface.callStatic

Defined in

src/contract/default.ts:131

---

populateTransaction

• Readonly populateTransaction: Object

Index signature

▪ [name: string]: ContractFunction

Implementation of

ContractInterface.populateTransaction

Defined in

src/contract/default.ts:133

---

estimateFee

• Readonly estimateFee: Object

Index signature

▪ [name: string]: ContractFunction

Implementation of

ContractInterface.estimateFee

Defined in

src/contract/default.ts:135

---

callData

• Private callData: CallData

Defined in

src/contract/default.ts:139

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

Implementation of

ContractInterface.attach

Defined in

src/contract/default.ts:204

---

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

Implementation of

ContractInterface.connect

Defined in

src/contract/default.ts:208

---

deployed

▸ deployed(): Promise<Contract>

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

Throws

When deployment fails

Returns

Promise<Contract>

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

Implementation of

ContractInterface.deployed

Defined in

src/contract/default.ts:212

---

call

▸ call(method, args?, «destructured»?): Promise<Result>

Calls a method on a contract

Parameters

Name	Type	Default value	Description
method	string	undefined	name of the method
args	ArgsOrCalldata	[]	Array of the arguments for the call
«destructured»	CallOptions	{}	optional blockIdentifier

Returns

Promise<Result>

Result of the call as an array with key value pars

Implementation of

ContractInterface.call

Defined in

src/contract/default.ts:220

---

invoke

▸ invoke(method, args?, «destructured»?): Promise<InvokeFunctionResponse>

Invokes a method on a contract

Parameters

Name	Type	Default value	Description
method	string	undefined	name of the method
args	ArgsOrCalldata	[]	Array of the arguments for the invoke or Calldata
«destructured»	InvokeOptions	{}

Returns

Promise<InvokeFunctionResponse>

Add Transaction Response

Implementation of

ContractInterface.invoke

Defined in

src/contract/default.ts:262

---

estimate

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

Estimates a method on a contract

Parameters

Name	Type	Default value	Description
method	string	undefined	name of the method
args	ArgsOrCalldata	[]	Array of the arguments for the call or Calldata

Returns

Promise<EstimateFeeResponse>

Implementation of

ContractInterface.estimate

Defined in

src/contract/default.ts:306

---

populate

▸ populate(method, args?): Call

Calls a method on a contract

Parameters

Name	Type	Default value	Description
method	string	undefined	name of the method
args	RawArgs	[]	Array of the arguments for the call or Calldata

Returns

Call

Invocation object

Implementation of

ContractInterface.populate

Defined in

src/contract/default.ts:320

---

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

Implementation of

ContractInterface.parseEvents

Defined in

src/contract/default.ts:329

---

isCairo1

▸ isCairo1(): boolean

tells if the contract comes from a Cairo 1 contract

Example

const isCairo1: boolean = myContract.isCairo1();

Returns

boolean

TRUE if the contract comes from a Cairo1 contract

Implementation of

ContractInterface.isCairo1

Defined in

src/contract/default.ts:341

---

typed

▸ typed<TAbi>(tAbi): TypedContract<TAbi>

Type parameters

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

Parameters

Name	Type
tAbi	TAbi

Returns

TypedContract<TAbi>

Implementation of

ContractInterface.typed

Defined in

src/contract/default.ts:345