Interface ContractApi

Contract API

This module provides methods about the smart contracts

Hierarchy

ContractApi

Index

Properties

Properties

callContractMethod

callContractMethod: function

Calls a public method of smart contract

param: The argument object
returns: The transaction id in case of success

Type declaration

- (args: CallContractMethodArgs): Promise<TransactionId>
- Parameters
  - args: CallContractMethodArgs
  Returns Promise<TransactionId>

getAllContractIds

getAllContractIds: function

Get all contract Ids of the blockchain

returns: The list of contract ids

Type declaration

- (id: string): Promise<ContractIdList>
- Parameters
  - id: string
  Returns Promise<ContractIdList>

getContract

getContract: function

Get a contract by its Id

param: The ID of the contract
returns: The contract

Type declaration

- (id: string): Promise<Contract>
- Parameters
  - id: string
  Returns Promise<Contract>

getContractsByAccount

getContractsByAccount: function

Get all contracts of given account

param: The account id (not RS address)
returns: A list of contracts

Type declaration

- (accountId: string): Promise<ContractList>
- Parameters
  - accountId: string
  Returns Promise<ContractList>

publishContract

publishContract: function

Publishes a smart contract to the blockchain

param: The argument object
returns: The transaction id in case of success

Type declaration

- (args: PublishContractArgs): Promise<TransactionId>
- Parameters
  - args: PublishContractArgs
  Returns Promise<TransactionId>