Class ViewingKeyClient

A contract's viewing key methods.

Hierarchy

Contract
- ViewingKeyClient

Index

Constructors

Properties

connection? instance? log

Methods

create execute query set

Constructors

constructor

new ViewingKeyClient(properties): ViewingKeyClient
Parameters
- properties: string | Partial<Contract>
Returns ViewingKeyClient
Inherited from Contract.constructor
- Defined in agent/connect.ts:545

Properties

`Optional` connection

connection?: Connection

`Optional` instance

instance?: {
address?: string;
}

Type declaration

Optional address?: string

log

Methods

create

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

execute

execute(message, options?): Promise<unknown>
Execute a transaction on the specified instance as the specified Connection.
Parameters
- message: Message
- options: {
      execFee?: IFee;
      execMemo?: string;
      execSend?: ICoin[];
  } = {}
  - Optional execFee?: IFee
  - Optional execMemo?: string
  - Optional execSend?: ICoin[]
Returns Promise<unknown>
Inherited from Contract.execute
- Defined in agent/connect.ts:568

query

query<Q>(message): Promise<Q>
Execute a query on the specified instance as the specified Connection.
Type Parameters
- Q
Parameters
- message: Message
Returns Promise<Q>
Inherited from Contract.query
- Defined in agent/connect.ts:556

set

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

Generated using TypeDoc