Class ViewingKeyClient

A contract's viewing key methods.

Hierarchy

Client
- ViewingKeyClient

Index

Constructors

Properties

address? agent? codeHash? fee? fees log meta

Accessors

asContractCode asContractLink chain

Methods

create execute fetchCodeHash getFee query set validate withAgent withFee withFees

Constructors

constructor

new ViewingKeyClient(options?: Partial<Client>): Scrt.ViewingKeyClient
Parameters
- options: Partial<Client> = {}
Returns Scrt.ViewingKeyClient
Inherited from Client.constructor
- Defined in agent/agent-client.ts:51

Properties

`Optional` address

address?: string

Address of the contract on the chain.

`Optional` agent

agent?: Agent

Agent that will interact with the contract.

`Optional` codeHash

codeHash?: string

Code hash confirming the contract's integrity.

`Optional` fee

fee?: IFee

Default fee for all contract transactions.

fees

fees: Record<string, IFee> = {}

Default fee for specific transactions.

log

log: Console = ...

meta

meta: Contract<any>

Contract metadata.

Accessors

asContractCode

get asContractCode(): ContractCode
The contract template represented in factory format ({code_id, code_hash})

Returns ContractCode
Inherited from Client.asContractCode
- Defined in agent/agent-client.ts:68

asContractLink

get asContractLink(): ContractLink
The contract represented in ICC format ({address, code_hash})

Returns ContractLink
Inherited from Client.asContractLink
- Defined in agent/agent-client.ts:64

chain

get chain(): undefined | Chain
The chain on which this contract exists.

Returns undefined | Chain
Inherited from Client.chain
- Defined in agent/agent-client.ts:60

Methods

create

create(entropy?: string): Promise<Uint8Array>
Create a random viewing key.
Parameters
- entropy: string = ...
Returns Promise<Uint8Array>
- Defined in connect/scrt/scrt-token.ts:252

execute

execute(msg: Message, opt?: ExecOpts): Promise<unknown>
Execute a transaction on the specified contract as the specified Agent.
Parameters
- msg: Message
- opt: ExecOpts = {}
Returns Promise<unknown>
Inherited from Client.execute
- Defined in agent/agent-client.ts:83

fetchCodeHash

fetchCodeHash(expected?: undefined | string): Promise<Scrt.ViewingKeyClient>
Fetch code hash from address.

Returns
Promise
Parameters
- expected: undefined | string = ...
Returns Promise<Scrt.ViewingKeyClient>
Inherited from Client.fetchCodeHash
- Defined in agent/agent-client.ts:73

getFee

getFee(msg?: string | Record<string, unknown>): undefined | IFee
Get the recommended fee for a specific transaction.
Parameters
- Optional msg: string | Record<string, unknown>
Returns undefined | IFee
Inherited from Client.getFee
- Defined in agent/agent-client.ts:89

query

query<U>(msg: Message): Promise<U>
Execute a query on the specified contract as the specified Agent.
Type Parameters
- U
Parameters
- msg: Message
Returns Promise<U>
Inherited from Client.query
- Defined in agent/agent-client.ts:79

set

set(key: string): Promise<unknown>
Set a user-specified viewing key.
Parameters
- key: string
Returns Promise<unknown>
- Defined in connect/scrt/scrt-token.ts:262

`Protected` validate

validate(kind: string, expected: any, actual: any): void
Throw if fetched metadata differs from configured.
Parameters
- kind: string
- expected: any
- actual: any
Returns void
Inherited from Client.validate
- Defined in agent/agent-client.ts:120

withAgent

withAgent(agent?: undefined | Agent): Scrt.ViewingKeyClient
Returns
a copy of this Client that will execute the transactions as a different Agent.
Parameters
- agent: undefined | Agent = ...
Returns Scrt.ViewingKeyClient
Inherited from Client.withAgent
- Defined in agent/agent-client.ts:113

withFee

withFee(fee: IFee): Scrt.ViewingKeyClient
Use the specified fee for all transactions by this Client.
Parameters
- fee: IFee
Returns Scrt.ViewingKeyClient
Inherited from Client.withFee
- Defined in agent/agent-client.ts:102

withFees

withFees(fees: Record<string, IFee>): Scrt.ViewingKeyClient
Use the specified fee table for all subsequent transactions by this Client.
Parameters
- fees: Record<string, IFee>
Returns Scrt.ViewingKeyClient
Inherited from Client.withFees
- Defined in agent/agent-client.ts:108

Generated using TypeDoc