Type Alias SignatureNotificationsApi

Type declaration

• signatureNotifications:function

  • signatureNotifications(
        signature: Signature,
        config: Readonly<{ enableReceivedNotification: true }> & Readonly<
            { commitment?: Commitment },
        >,
    ):
        | Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>
        | Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>

  • Subscribe to a transaction signature to receive notification when a given transaction is committed. On signatureNotification - the subscription is automatically cancelled. The signature must be a txid, the first signature of a transaction.

    Parameters

    • signature: Signature
    • config: Readonly<{ enableReceivedNotification: true }> & Readonly<
          { commitment?: Commitment },
      >

    Returns
        | Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>
        | Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>
  • signatureNotifications(
        signature: Signature,
        config?: Readonly<{ enableReceivedNotification?: false }> & Readonly<
            { commitment?: Commitment },
        >,
    ): Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>

  • Parameters

    • signature: Signature
    • Optionalconfig: Readonly<{ enableReceivedNotification?: false }> & Readonly<
          { commitment?: Commitment },
      >

    Returns Readonly<{ context: Readonly<{ slot: Slot }>; value: TValue }>