Class Client

constructor

• new Client(options?): Client

• Parameters

  • options: Partial<Client> = {}

  Returns Client

Optional address

Optional agent

Optional codeHash

Optional codeId

Optional fee

fees

log

meta

asContractCode

• get asContractCode(): ContractCode

• The contract template represented in factory format ({code_id, code_hash})

  Returns ContractCode

asContractLink

• get asContractLink(): ContractLink

• The contract represented in ICC format ({address, code_hash})

  Returns ContractLink

chain

• get chain(): undefined | Chain

• The chain on which this contract exists.

  Returns undefined | Chain

execute

• execute(msg, opt?): Promise<unknown>

• Execute a transaction on the specified contract as the specified Agent.

  Parameters

  • msg: Message

  • opt: ExecOpts = {}

  Returns Promise<unknown>

fetchCodeHash

• fetchCodeHash(expected?): Promise<Client>

• Fetch code hash from address.

  Parameters

  • expected: undefined | string = ...

  Returns Promise<Client>

  Promise

getFee

• getFee(msg?): undefined | IFee

• Get the recommended fee for a specific transaction.

  Parameters

  • Optional msg: string | Record<string, unknown>

  Returns undefined | IFee

query

• query<U>(msg): Promise<U>

• Execute a query on the specified contract as the specified Agent.

  Type Parameters

  • U

  Parameters

  • msg: Message

  Returns Promise<U>

withAgent

• withAgent(agent?): Client

• Parameters

  • agent: undefined | Agent = ...

  Returns Client

  a copy of this Client that will execute the transactions as a different Agent.

withFee

• withFee(fee): Client

• Use the specified fee for all transactions by this Client.

  Parameters

  • fee: IFee

  Returns Client

withFees

• withFees(fees): Client

• Use the specified fee table for all subsequent transactions by this Client.

  Parameters

  • fees: Record<string, IFee>

  Returns Client