Class Client

High-level client API

Hierarchy

Client

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Client(network: Network, keys: Keypair): Client

- Defined in client.ts:31
Create a new Client instance

Parameters
- network: Network
- keys: Keypair
Returns Client

Properties

id

id: string

keys

network

network: Network

Methods

getBalance

getBalance(): Promise<number>

- Defined in client.ts:62
Retrieve the Client balance

Returns Promise<number>

getLockStatus

getLockStatus(): Promise<any>

- Defined in client.ts:69
Returns Promise<any>

lock

lock(amount: number, hours: number, minutes: number): Promise<TransactionResponse>

- Defined in client.ts:113
Parameters
- amount: number
- hours: number
- minutes: number
Returns Promise<TransactionResponse>

register

register(): Promise<RegisterClientResponse>

- Defined in client.ts:51
Register the Client on the network

Returns Promise<RegisterClientResponse>

send

send(to: string, amount: number, note?: any): Promise<TransactionResponse>

- Defined in client.ts:83
Send ZCN to a client

Parameters
- to: string
- amount: number
- Optional note: any
Returns Promise<TransactionResponse>

unlock

unlock(poolId: string): Promise<TransactionResponse>

- Defined in client.ts:129
Parameters
- poolId: string
Returns Promise<TransactionResponse>

Static fromMnemonic

fromMnemonic(network: Network, phrase: string): Client

- Defined in client.ts:104
Create a Client instance using a mnemonic phrase

Parameters
- network: Network
- phrase: string
Returns Client