Class SmartContractsClient

Smart Contracts Client object enables smart contract deployment, calls and streaming of events.

Hierarchy

BaseClient
- SmartContractsClient

Implements

ISmartContractsClient

Index

Constructors

constructor

new SmartContractsClient(clientConfig: IClientConfig, publicApiClient: PublicApiClient, walletClient: IWalletClient): SmartContractsClient
Constructor for SmartContractsClient objects.
Parameters
- clientConfig: IClientConfig
- publicApiClient: PublicApiClient
- walletClient: IWalletClient
Returns SmartContractsClient
Overrides BaseClient.constructor
- Defined in src/web3/SmartContractsClient.ts:59

Properties

clientConfig

clientConfig: IClientConfig

`Private` `Readonly` publicApiClient

publicApiClient: PublicApiClient

`Private` `Readonly` walletClient

walletClient: IWalletClient

Methods

awaitRequiredOperationStatus

awaitRequiredOperationStatus(opId: string, requiredStatus: EOperationStatus): Promise<EOperationStatus>
Get the status of a specific operation and wait until it reaches the required status.

Returns
A promise that resolves to the status of the operation.
Parameters
- opId: string
  
  The required operation id.
- requiredStatus: EOperationStatus
  
  The required status.
Returns Promise<EOperationStatus>
Implementation of ISmartContractsClient.awaitRequiredOperationStatus
- Defined in src/web3/SmartContractsClient.ts:375

callSmartContract

callSmartContract(callData: ICallData, executor?: IBaseAccount): Promise<string>
Calls a smart contract method.

Remarks
If no executor is provided, the default wallet account will be used.

Returns
A promise that resolves to the operation ID of the call operation as a string.
Parameters
- callData: ICallData
  
  The data required for the smart contract call.
- Optional executor: IBaseAccount
  
  The account that will execute the call (default: the default wallet account from WalletClient).
Returns Promise<string>
Implementation of ISmartContractsClient.callSmartContract
- Defined in src/web3/SmartContractsClient.ts:115

`Protected` compactBytesForOperation

compactBytesForOperation(data: DataType, opTypeId: OperationTypeId, expirePeriod: number): Buffer
Compacts bytes payload per operation.

Returns
The compacted bytes payload.
Parameters
- data: DataType
  
  The operation data.
- opTypeId: OperationTypeId
  
  The operation type id.
- expirePeriod: number
  
  The expire period.
Returns Buffer
Inherited from BaseClient.compactBytesForOperation
- Defined in src/web3/BaseClient.ts:277

deploySmartContract

deploySmartContract(contractData: IContractData, executor?: IBaseAccount): Promise<string>
Deploy a smart contract on the massa blockchain by creating and sending an operation containing byte code.

Remarks
If no executor is provided, the default wallet account from the provided WalletClient will be used.

Returns
A promise that resolves to the operation ID of the deployment operation.
Parameters
- contractData: IContractData
  
  The deployment contract data.
- Optional executor: IBaseAccount
  
  The account to use for the deployment.
Returns Promise<string>
Implementation of ISmartContractsClient.deploySmartContract
- Defined in src/web3/SmartContractsClient.ts:92

executeReadOnlySmartContract

executeReadOnlySmartContract(contractData: IContractData): Promise<IExecuteReadOnlyResponse>
Send a read-only smart contract execution request.

Remarks
This method is used to dry-run a smart contract execution and get the changes of the states that would have happen if the transaction was really executed on chain. This operation does not modify the blockchain state.

Returns
A promise which resolves to an object containing data about the operation.

Throws
- If the contract binary data is missing.
- If the contract contract address is missing.
- If the result is empty.
- If the result contains an error.
Parameters
- contractData: IContractData
  
  The data required for the operation.
Returns Promise<IExecuteReadOnlyResponse>
Implementation of ISmartContractsClient.executeReadOnlySmartContract
- Defined in src/web3/SmartContractsClient.ts:276

getContractBalance

getContractBalance(address: string): Promise<IBalance>
Returns the balance of the smart contract.

Returns
A promise that resolves to the balance of the smart contract.
Parameters
- address: string
  
  The address of the smart contract.
Returns Promise<IBalance>
Implementation of ISmartContractsClient.getContractBalance
- Defined in src/web3/SmartContractsClient.ts:211

getFilteredScOutputEvents

getFilteredScOutputEvents(eventFilterData: IEventFilter): Promise<IEvent[]>
Get filtered smart contract output events.

Returns
A promise that resolves to an array of IEvent objects containing the filtered events.
Parameters
- eventFilterData: IEventFilter
  
  The filter data for the events.
Returns Promise<IEvent[]>
Implementation of ISmartContractsClient.getFilteredScOutputEvents
- Defined in src/web3/SmartContractsClient.ts:229

getOperationStatus

getOperationStatus(opId: string): Promise<EOperationStatus>
Get the status of a specific operation.

Returns
A promise that resolves to the status of the operation.
Parameters
- opId: string
  
  The operation id.
Returns Promise<EOperationStatus>
Implementation of ISmartContractsClient.getOperationStatus
- Defined in src/web3/SmartContractsClient.ts:332

`Protected` getPrivateProviders

getPrivateProviders(): IProvider[]
Returns all the private providers.

Returns
An array of IProvider containing all the private providers.

Returns IProvider[]
Inherited from BaseClient.getPrivateProviders
- Defined in src/web3/BaseClient.ts:113

`Protected` getPublicProviders

getPublicProviders(): IProvider[]
Returns all the public providers.

Returns
An array of IProvider containing all the public providers.

Returns IProvider[]
Inherited from BaseClient.getPublicProviders
- Defined in src/web3/BaseClient.ts:124

readSmartContract

readSmartContract(readData: IReadData): Promise<IContractReadOperationResponse>
Execute a dry run Smart contract call and returns some data regarding its execution such as the changes of in the states that would have happen if the transaction was really executed on chain.

Returns
A promise that resolves to an object which represents the result of the operation and contains data about its execution.
Parameters
- readData: IReadData
  
  The data required for the a read operation of a smart contract.
Returns Promise<IContractReadOperationResponse>
Implementation of ISmartContractsClient.readSmartContract
- Defined in src/web3/SmartContractsClient.ts:152

`Protected` sendJsonRPCRequest

sendJsonRPCRequest<T>(resource: JSON_RPC_REQUEST_METHOD, params: object): Promise<T>
Sends a post JSON rpc request to the node.

Throws
An error if the rpc method returns an error.

Returns
A promise that resolves as the result of the rpc method.
Type Parameters
- T
Parameters
- resource: JSON_RPC_REQUEST_METHOD
  
  The rpc method to call.
- params: object
  
  The parameters to pass to the rpc method.
Returns Promise<T>
Inherited from BaseClient.sendJsonRPCRequest
- Defined in src/web3/BaseClient.ts:252

setProviders

setProviders(providers: IProvider[]): void
Set new providers as IProvider.

Throws
Will throw an error if no public providers are included in the given array of providers.

Throws
Will throw an error if no private providers are included in the given array of providers.
Parameters
- providers: IProvider[]
  
  The new providers to set as an array of IProvider.
Returns void
Inherited from BaseClient.setProviders
- Defined in src/web3/BaseClient.ts:94

Class SmartContractsClient

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

clientConfig: IClientConfig

publicApiClient: PublicApiClient

walletClient: IWalletClient

Returns SmartContractsClient

Properties

clientConfig

Private Readonly publicApiClient

Private Readonly walletClient

Methods

awaitRequiredOperationStatus

Returns

Parameters

opId: string

requiredStatus: EOperationStatus

Returns Promise<EOperationStatus>

callSmartContract

Remarks

Returns

Parameters

callData: ICallData

Optional executor: IBaseAccount

Returns Promise<string>

Protected compactBytesForOperation

Returns

Parameters

data: DataType

opTypeId: OperationTypeId

expirePeriod: number

Returns Buffer

deploySmartContract

Remarks

Returns

Parameters

contractData: IContractData

Optional executor: IBaseAccount

Returns Promise<string>

executeReadOnlySmartContract

Remarks

Returns

Throws

Parameters

contractData: IContractData

Returns Promise<IExecuteReadOnlyResponse>

getContractBalance

Returns

Parameters

address: string

Returns Promise<IBalance>

getFilteredScOutputEvents

Returns

Parameters

eventFilterData: IEventFilter

Returns Promise<IEvent[]>

getOperationStatus

Returns

Parameters

opId: string

Returns Promise<EOperationStatus>

Protected getPrivateProviders

Returns

Returns IProvider[]

Protected getPublicProviders

Returns

Returns IProvider[]

readSmartContract

Returns

Parameters

readData: IReadData

Returns Promise<IContractReadOperationResponse>

Protected sendJsonRPCRequest

`Private` `Readonly` publicApiClient

`Private` `Readonly` walletClient

`Optional` executor: IBaseAccount

`Protected` compactBytesForOperation

`Optional` executor: IBaseAccount

`Protected` getPrivateProviders

`Protected` getPublicProviders

`Protected` sendJsonRPCRequest