Interface Handler

interface Handler {
    onBatchFailed?(event: BatchFailedEvent): Promise<void>;
    onBatchFinalization(
        event: BatchFinalizationEvent,
        vtxoTree?: TxTree,
        connectorTree?: TxTree,
    ): Promise<void>;
    onBatchFinalized?(event: BatchFinalizedEvent): Promise<void>;
    onBatchStarted(event: BatchStartedEvent): Promise<{ skip: boolean }>;
    onTreeNonces(event: TreeNoncesEvent): Promise<{ fullySigned: boolean }>;
    onTreeSignatureEvent?(event: TreeSignatureEvent): Promise<void>;
    onTreeSigningStarted(
        event: TreeSigningStartedEvent,
        vtxoTree: TxTree,
    ): Promise<{ skip: boolean }>;
    onTreeTxEvent?(event: TreeTxEvent): Promise<void>;
}

Index

Methods

onBatchFailed? onBatchFinalization onBatchFinalized? onBatchStarted onTreeNonces onTreeSignatureEvent? onTreeSigningStarted onTreeTxEvent?

Methods

`Optional`onBatchFailed

onBatchFailed?(event: BatchFailedEvent): Promise<void>
Called when batch processing fails.
Parameters
- event: BatchFailedEvent
  Batch failed event
Returns Promise<void>
- Defined in wallet/batch.ts:91

onBatchFinalization

onBatchFinalization(
    event: BatchFinalizationEvent,
    vtxoTree?: TxTree,
    connectorTree?: TxTree,
): Promise<void>
Called during batch finalization.
Parameters
- event: BatchFinalizationEvent
  The batch finalization event.
- OptionalvtxoTree: TxTree
  The signed virtual output tree, reconstructed from the TreeTxEvent events.
- OptionalconnectorTree: TxTree
  The connector transaction tree, reconstructed from the TreeTxEvent events.
Returns Promise<void>
- Defined in wallet/batch.ts:73

`Optional`onBatchFinalized

onBatchFinalized?(event: BatchFinalizedEvent): Promise<void>
Called when batch finalization completes successfully.
Parameters
- event: BatchFinalizedEvent
  Batch finalized event
Returns Promise<void>
- Defined in wallet/batch.ts:84

onBatchStarted

onBatchStarted(event: BatchStartedEvent): Promise<{ skip: boolean }>
Called on BatchStarted event.
Parameters
- event: BatchStartedEvent
Returns Promise<{ skip: boolean }>
indicating whether the batch should be skipped or not.
- Defined in wallet/batch.ts:50

onTreeNonces

onTreeNonces(event: TreeNoncesEvent): Promise<{ fullySigned: boolean }>
Called when tree nonces are received.
Parameters
- event: TreeNoncesEvent
  The tree nonces event.
Returns Promise<{ fullySigned: boolean }>
Promise resolving to a boolean indicating whether signing is complete.
- Defined in wallet/batch.ts:66

`Optional`onTreeSignatureEvent

onTreeSignatureEvent?(event: TreeSignatureEvent): Promise<void>
Called for each tree signature event received during batch processing.
Parameters
- event: TreeSignatureEvent
  Tree signature event
Returns Promise<void>
- Defined in wallet/batch.ts:105

onTreeSigningStarted

onTreeSigningStarted(
event: TreeSigningStartedEvent,
vtxoTree: TxTree,
): Promise<{ skip: boolean }>
Called when tree signing starts.
Parameters
- event: TreeSigningStartedEvent
  The tree signing started event.
- vtxoTree: TxTree
  The unsigned virtual output tree, reconstructed from the TreeTxEvent events.
Returns Promise<{ skip: boolean }>
Promise resolving to a boolean indicating whether to continue processing.
- Defined in wallet/batch.ts:57

`Optional`onTreeTxEvent

onTreeTxEvent?(event: TreeTxEvent): Promise<void>
Called for each virtual output tree transaction chunk received during batch processing.
Parameters
- event: TreeTxEvent
  Tree transaction event
Returns Promise<void>
- Defined in wallet/batch.ts:98