Interface MessageHandler<REQ, RES>

ReadonlymessageTag

handleMessage

• handleMessage(message: REQ): Promise<RES | null>

  Handle routed messages from the clients

  Parameters

  • message: REQ

  Returns Promise<RES | null>

OptionalisLongRunning

• isLongRunning?(message: REQ): boolean

  Optional opt-out from the bus-level message timeout.

  Long-running flows (e.g. settlement) surrender control to remote peers and can legitimately sit idle for longer than messageTimeoutMs. When this returns true, the bus awaits handleMessage without a deadline. Defaults to false.

  Parameters

  • message: REQ

  Returns boolean

start

• start(
      services: {
          arkProvider: ArkProvider;
          readonlyWallet: ReadonlyWallet;
          wallet?: Wallet;
      },
      repositories: { walletRepository: WalletRepository },
  ): Promise<void>

  Called once when the SW is starting up

  Parameters

  • services: { arkProvider: ArkProvider; readonlyWallet: ReadonlyWallet; wallet?: Wallet }

    Providers and wallet instances available to the handler.

  • repositories: { walletRepository: WalletRepository }

    Repositories available to the handler.

  Returns Promise<void>

stop

• stop(): Promise<void>

  Called once when the SW is shutting down

  Returns Promise<void>

tick

• tick(now: number): Promise<RES[]>

  Called by the scheduler to perform a tick. Can be used by the updater to perform periodic tasks or return delayed responses (eg: subscriptions).

  Parameters

  • now: number

    The current time in milliseconds since the epoch.

  Returns Promise<RES[]>