Class Wallet

constructor

• new Wallet(rpc, seed?, index?, 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
  • Optional work_function: WorkFunction

  Returns Wallet

add_do_work

index

Readonly rpc

Readonly seed

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

change_rep

• change_rep(new_representative, work?): Promise<string>

• Parameters

  • new_representative: `ban_${string}` | `nano_${string}`
  • Optional work: boolean

  Returns Promise<string>

change_representative

• change_representative(new_representative?, gen_work?): Promise<string>

• Parameters

  • Optional new_representative: `ban_${string}` | `nano_${string}`

    banano address to change representative to
  • Optional gen_work: boolean

    whether or not to call work function to generate work

  Returns Promise<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>

get_account_receivable

• get_account_receivable(count?, threshold?, source?): Promise<AccountReceivableRPC | AccountReceivableThresholdRPC | AccountReceivableSourceRPC>

• Parameters

  • Optional count: number
  • Optional threshold: `${number}`
  • Optional source: boolean

  Returns Promise<AccountReceivableRPC | AccountReceivableThresholdRPC | AccountReceivableSourceRPC>

receive

• receive(block_hash?, gen_work?, representative?): Promise<string>

• Parameters

  • Optional block_hash: string

    send block to receive
  • Optional gen_work: boolean

    whether or not to call work function to generate work
  • Optional representative: `ban_${string}` | `nano_${string}`

    optionally provide a representative if you do not want to use the current representative receive bananos from a specific send block

  Returns Promise<string>

receive_all

• receive_all(count?, threshold?, gen_work?): Promise<string[]>

• Parameters

  • Optional count: number = 20

    Max amount of blocks to receive receive all (up to count and exceeding threshold if applicable) receivable blocks
  • Optional threshold: `${number}`

    Min amount of Banano to receive in whole
  • Optional gen_work: boolean

    whether or not to call work function to generate work Receive all receivable transactions (up to count, and over threshold

  Returns Promise<string[]>

send

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

• Parameters

  • Optional to: `ban_${string}` | `nano_${string}`

    address to send to
  • Optional amount: `${number}`

    amount in whole bananos to send
  • Optional gen_work: boolean

    whether or not to call work function to generate work
  • 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

    can save one rpc call in some cases. Mostly for internal use. Make sure that in the RPC call, "representative" is "true" Send Bananos

  Returns Promise<string>

send_all

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

• Parameters

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

  Returns Promise<string>

send_fixed_final_bal

• send_fixed_final_bal(to, end_bal, gen_work?, representative?, cached_account_info?): Promise<string>

• Send by passing in a fixed final balance

  Parameters

  • to: `ban_${string}` | `nano_${string}`
  • end_bal: `${number}`
  • Optional gen_work: boolean
  • Optional representative: `ban_${string}` | `nano_${string}`
  • Optional cached_account_info: AccountInfoRPC

  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