@arkade-os/sdk Documentation - v0.4.0-next.8
    Preparing search index...

    Interface MessageHandler<REQ, RES>

    interface MessageHandler<
        REQ extends RequestEnvelope = RequestEnvelope,
        RES extends ResponseEnvelope = ResponseEnvelope,
    > {
        messageTag: string;
        handleMessage(message: REQ): Promise<RES | null>;
        start(
            services: {
                arkProvider: ArkProvider;
                readonlyWallet: ReadonlyWallet;
                wallet?: Wallet;
            },
            repositories: { walletRepository: WalletRepository },
        ): Promise<void>;
        stop(): Promise<void>;
        tick(now: number): Promise<RES[]>;
    }

    Type Parameters

    Implemented by

    Index

    Properties

    messageTag: string

    A unique identifier for the updater. This is used to route messages to the correct updater.

    Methods

    • Called once when the SW is shutting down

      Returns Promise<void>

    • 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[]>