Class Wallet

constructor

• new Wallet(rpc, seed?, index?, try_work?, work_function?): Wallet

• Parameters

  • rpc: RPCInterface
  • Optional seed: string

    Seed for the wallet from which private keys are derived. 64 character hex string (32 bytes)
  • index: number = 0
  • try_work: boolean = false
  • Optional work_function: WorkFunction

  Returns Wallet

add_do_work

index

Readonly rpc

Readonly seed

try_work

Optional work_function

address

• get address(): `ban_${string}` | `nano_${string}`

• Returns `ban_${string}` | `nano_${string}`

private_key

• get private_key(): string

• Returns string

public_key

• get public_key(): string

• Returns string

get_account_info

• get_account_info(include_confirmed?, representative?, weight?, pending?): Promise<AccountInfoRPC>

• Parameters

  • Optional include_confirmed: boolean
  • Optional representative: boolean
  • Optional weight: boolean
  • Optional pending: boolean

  Returns Promise<AccountInfoRPC>

send

• send(to, amount, gen_work?, previous?, representative?, cached_account_info?): Promise<string>

• Parameters

  • to: `ban_${string}` | `nano_${string}`
  • amount: `${number}`
  • Optional gen_work: boolean

    whether or not to call work function to generate work
  • Optional previous: string

    optionally provide a previous if you do not want to use the current frontier
  • Optional representative: `ban_${string}` | `nano_${string}`

    optionally provide a representative if you do not want to use the current representative
  • Optional cached_account_info: AccountInfoRPC

    save one rpc call in some cases. mostly for internal use

  Returns Promise<string>

send_all

• send_all(to, work?, previous?, representative?): Promise<string>

• Parameters

  • to: `ban_${string}` | `nano_${string}`
  • Optional work: boolean
  • Optional previous: string
  • Optional representative: `ban_${string}` | `nano_${string}`

  Returns Promise<string>

send_process

• send_process(block, subtype): Promise<string>

• Parameters

  • block: Block
  • subtype: BlockSubtype

  Returns Promise<string>

sign_message

• sign_message(message): string

• Parameters

  • message: string

  Returns string

Static gen_random_wallet

• gen_random_wallet(rpc): Wallet

• Generate a cryptographically secure random wallet using crypto.getRandomValues

  Parameters

  • rpc: RPCInterface

  Returns Wallet