Class MoneroWalletListener

Default wallet listener which takes no action on notifications.

Hierarchy

MoneroWalletListener

Index

Constructors

Methods

onBalancesChanged onNewBlock onOutputReceived onOutputSpent onSyncProgress

Constructors

constructor

new MoneroWalletListener(): MoneroWalletListener
Returns MoneroWalletListener

Methods

onBalancesChanged

onBalancesChanged(newBalance, newUnlockedBalance): Promise<void>
Invoked when the wallet's balances change.
Parameters
- newBalance: bigint
  
  new wallet balance
- newUnlockedBalance: bigint
  
  new unlocked wallet balance
Returns Promise<void>

onNewBlock

onNewBlock(height): Promise<void>
Invoked when a new block is added to the chain.
Parameters
- height: number
  
  the height of the new block (i.e. the number of blocks before it).
Returns Promise<void>

onOutputReceived

onOutputReceived(output): Promise<void>
Invoked 3 times per received output: once when unconfirmed, once when confirmed, and once when unlocked.

The notified output includes basic fields only, so the output or its transaction should be fetched to get all available fields.
Parameters
- output: MoneroOutputWallet
  
  the received output
Returns Promise<void>

onOutputSpent

onOutputSpent(output): Promise<void>
Invoked twice per spent output: once when confirmed and once when unlocked.

The notified output includes basic fields only, so the output or its transaction should be fetched to get all available fields.
Parameters
- output: any
  
  the spent output
Returns Promise<void>

onSyncProgress

onSyncProgress(height, startHeight, endHeight, percentDone, message): Promise<void>
Invoked as the wallet is synchronized.
Parameters
- height: number
  
  height of the synced block
- startHeight: number
  
  starting height of the sync request
- endHeight: number
  
  ending height of the sync request
- percentDone: number
  
  sync progress as a percentage
- message: string
  
  human-readable description of the current progress
Returns Promise<void>

Generated using TypeDoc