Interface ISmartContractsClient

Represents a SmartContractClient object.

See

deploySmartContract - deploy smart contract
callSmartContract - call smart contract
readSmartContract - read smart contract
getContractBalance - get contract balance
getFilteredScOutputEvents - get filtered smart contract output events
executeReadOnlySmartContract - execute read only smart contract
getOperationStatus - get operation status
awaitRequiredOperationStatus - await required operation status

interface ISmartContractsClient {
    awaitRequiredOperationStatus(opId, requiredStatus): Promise<EOperationStatus>;
    callSmartContract(callData, executor?): Promise<string>;
    deploySmartContract(contractData, executor?): Promise<string>;
    executeReadOnlySmartContract(contractData): Promise<IExecuteReadOnlyResponse>;
    getContractBalance(address): Promise<IBalance>;
    getFilteredScOutputEvents(eventFilterData): Promise<IEvent[]>;
    getOperationStatus(opId): Promise<EOperationStatus>;
    readSmartContract(readData): Promise<IContractReadOperationResponse>;
}

Implemented by

SmartContractsClient

Index

Methods

awaitRequiredOperationStatus callSmartContract deploySmartContract executeReadOnlySmartContract getContractBalance getFilteredScOutputEvents getOperationStatus readSmartContract

Methods

awaitRequiredOperationStatus

awaitRequiredOperationStatus(opId, requiredStatus): Promise<EOperationStatus>
Await required operation status.
Parameters
- opId: string
  The operation id
- requiredStatus: EOperationStatus
  The required operation status
Returns Promise<EOperationStatus>
The operation status
- Defined in packages/massa-web3/src/interfaces/ISmartContractsClient.ts:109

callSmartContract

callSmartContract(callData, executor?): Promise<string>
Calls a smart contract.
Parameters
- callData: ICallData
  The call data
- Optional executor: IBaseAccount
  The account used to send the transaction (if not set, the base account is used)
Returns Promise<string>
The operation id
- Defined in packages/massa-web3/src/interfaces/ISmartContractsClient.ts:45

deploySmartContract

deploySmartContract(contractData, executor?): Promise<string>
Deploy a smart contract.
Parameters
- contractData: IContractData
  The contract data
- Optional executor: IBaseAccount
  The account used to send the transaction (if not set, the base account is used)
Returns Promise<string>
The operation id
- Defined in packages/massa-web3/src/interfaces/ISmartContractsClient.ts:32

executeReadOnlySmartContract

executeReadOnlySmartContract(contractData): Promise<IExecuteReadOnlyResponse>
Execute read only smart contract.
Parameters
- contractData: IContractData
  The contract data
Returns Promise<IExecuteReadOnlyResponse>
The execute read only response
- Defined in packages/massa-web3/src/interfaces/ISmartContractsClient.ts:88

getContractBalance

getContractBalance(address): Promise<IBalance>
Get contract balance.
Parameters
- address: string
  The contract address
Returns Promise<IBalance>
The contract balance (null if not found)
- Defined in packages/massa-web3/src/interfaces/ISmartContractsClient.ts:68

getFilteredScOutputEvents

getFilteredScOutputEvents(eventFilterData): Promise<IEvent[]>
Get filtered smart contract output events.
Parameters
- eventFilterData: IEventFilter
  The event filter data
Returns Promise<IEvent[]>
The array of corresponding events
- Defined in packages/massa-web3/src/interfaces/ISmartContractsClient.ts:77

getOperationStatus

getOperationStatus(opId): Promise<EOperationStatus>
Get an operation status.
Parameters
- opId: string
  The operation id
Returns Promise<EOperationStatus>
The operation status
- Defined in packages/massa-web3/src/interfaces/ISmartContractsClient.ts:99

readSmartContract

readSmartContract(readData): Promise<IContractReadOperationResponse>
Read a smart contract.
Parameters
- readData: IReadData
  The read data
Returns Promise<IContractReadOperationResponse>
The contract read operation response
- Defined in packages/massa-web3/src/interfaces/ISmartContractsClient.ts:57

Interface ISmartContractsClient

See

Implemented by

Index

Methods

Methods

awaitRequiredOperationStatus

Parameters

opId: string

requiredStatus: EOperationStatus

Returns Promise<EOperationStatus>

callSmartContract

Parameters

callData: ICallData

Optional executor: IBaseAccount

Returns Promise<string>

deploySmartContract

Parameters

contractData: IContractData

Optional executor: IBaseAccount

Returns Promise<string>

executeReadOnlySmartContract

Parameters

contractData: IContractData

Returns Promise<IExecuteReadOnlyResponse>

getContractBalance

Parameters

address: string

Returns Promise<IBalance>

getFilteredScOutputEvents

Parameters

eventFilterData: IEventFilter

Returns Promise<IEvent[]>

getOperationStatus

Parameters

opId: string

Returns Promise<EOperationStatus>

readSmartContract

Parameters

readData: IReadData

Returns Promise<IContractReadOperationResponse>

Settings

Member Visibility

Theme

On This Page

`Optional` executor: IBaseAccount

`Optional` executor: IBaseAccount