Class: Contract
Implements
Indexable
▪ [key: string]: AsyncContractFunction | any
Constructors
constructor
• new Contract(abi, address, providerOrAccount?): Contract
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 |
Returns
Defined in
Properties
abi
• abi: Abi
Implementation of
Defined in
address
• address: string
Implementation of
Defined in
providerOrAccount
• providerOrAccount: ProviderInterface | AccountInterface
Implementation of
ContractInterface.providerOrAccount
Defined in
deployTransactionHash
• Optional deployTransactionHash: string
Implementation of
ContractInterface.deployTransactionHash
Defined in
structs
• Protected Readonly structs: Object
Index signature
▪ [name: string]: AbiStruct
Defined in
events
• Protected Readonly events: AbiEvents
Defined in
functions
• Readonly functions: Object
Index signature
▪ [name: string]: AsyncContractFunction
Implementation of
Defined in
callStatic
• Readonly callStatic: Object
Index signature
▪ [name: string]: AsyncContractFunction
Implementation of
Defined in
populateTransaction
• Readonly populateTransaction: Object
Index signature
▪ [name: string]: ContractFunction
Implementation of
ContractInterface.populateTransaction
Defined in
estimateFee
• Readonly estimateFee: Object
Index signature
▪ [name: string]: ContractFunction
Implementation of
Defined in
callData
• Private callData: CallData
Defined in
contractOptions
• Optional contractOptions: ContractOptions
Defined in
Methods
withOptions
▸ withOptions(options): Contract
Parameters
| Name | Type |
|---|---|
options | ContractOptions |
Returns
Defined in
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
Defined in
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
Defined in
deployed
▸ deployed(): Promise<Contract>
Resolves when contract is deployed on the network or when no deployment transaction is found
Returns
Promise<Contract>
Promise that resolves when contract is deployed on the network or when no deployment transaction is found
Throws
When deployment fails
Implementation of
Defined in
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
Defined in
invoke
▸ invoke(method, args?, «destructured»?): Promise<{ transaction_hash: string }>
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» | ContractOptions | {} |
Returns
Promise<{ transaction_hash: string }>
Add Transaction Response
Implementation of
Defined in
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
Defined in
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
Invocation object
Implementation of
Defined in
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
Events parsed
Implementation of
Defined in
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();
Implementation of
Defined in
getVersion
▸ getVersion(): Promise<ContractVersion>
Retrieves the version of the contract (cairo version & compiler version)
Returns
Promise<ContractVersion>
Implementation of
Defined in
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.