Module client

Low-level client API

Index

Functions

Functions

createLockTransaction

createLockTransaction(id: string, amount: number, hours: number, minutes: number): Transaction

- Defined in client.ts:254
Parameters
- id: string
- amount: number
- hours: number
- minutes: number
Returns Transaction

createSendTransaction

createSendTransaction(from: string, to: string, amount: number, note: any, timeStamp?: undefined | number): Transaction

- Defined in client.ts:214
Create a Transaction instance

Parameters
- from: string
- to: string
- amount: number
- note: any
- Optional timeStamp: undefined | number
Returns Transaction

createUnlockTransaction

createUnlockTransaction(id: string, poolId: string): Transaction

- Defined in client.ts:297
Parameters
- id: string
- poolId: string
Returns Transaction

getBalance

getBalance(network: Network, id: string): Promise<number>

- Defined in client.ts:167
Parameters
- network: Network
- id: string
Returns Promise<number>

getLockStatus

getLockStatus(network: Network, id: string): Promise<any>

- Defined in client.ts:192
Parameters
- network: Network
- id: string
Returns Promise<any>

lock

lock(network: Network, keys: Keypair, id: string, amount: number, hours: number, minutes: number): Promise<TransactionResponse>

- Defined in client.ts:277
Parameters
- network: Network
- keys: Keypair
- id: string
- amount: number
- hours: number
- minutes: number
Returns Promise<TransactionResponse>

register

register(network: Network, id: string, pubKey: Buffer): Promise<RegisterClientResponse>

- Defined in client.ts:148
Parameters
- network: Network
- id: string
- pubKey: Buffer
Returns Promise<RegisterClientResponse>

send

send(network: Network, keys: Keypair, from: string, to: string, amount: number, note: any, timeStamp?: undefined | number): Promise<TransactionResponse>

- Defined in client.ts:232
Parameters
- network: Network
- keys: Keypair
- from: string
- to: string
- amount: number
- note: any
- Optional timeStamp: undefined | number
Returns Promise<TransactionResponse>

unlock

unlock(network: Network, keys: Keypair, id: string, poolId: string): Promise<TransactionResponse>

- Defined in client.ts:318
Parameters
- network: Network
- keys: Keypair
- id: string
- poolId: string
Returns Promise<TransactionResponse>