Kit
Type aliases

SignatureNotificationsApi

SignatureNotificationsApi = object

Methods

signatureNotifications()

Call Signature

signatureNotifications(signature, config): Readonly<{ context: Readonly<{ slot: Slot; }>; value: TValue; }> | Readonly<{ context: Readonly<{ slot: Slot; }>; value: TValue; }>

Subscribe to a receive a notification when the transaction identified by the given signature is received by the cluster, then again when it reaches the specified level of commitment.

This subscription will not issue notifications for events that have already happened. To fetch the commitment status of any transaction at a point in time use the GetSignatureStatusesApi.getSignatureStatuses | getSignatureStatuses method of the RPC API.

Parameters
ParameterTypeDescription
signatureSignatureTransaction signature as base-58 encoded string
configReadonly<{ enableReceivedNotification: true; }> & Readonly<{ commitment?: Commitment; enableReceivedNotification?: boolean; }>-
Returns

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

See

https://solana.com/docs/rpc/websocket/signaturesubscribe

Call Signature

signatureNotifications(signature, config?): SignatureNotificationsApiNotificationProcessed

Subscribe to a receive a notification when the transaction identified by the given signature reaches the specified level of commitment.

This subscription will not issue notifications for events that have already happened. To fetch the commitment status of any transaction at a point in time use the GetSignatureStatusesApi.getSignatureStatuses | getSignatureStatuses method of the RPC API.

Parameters
ParameterTypeDescription
signatureSignatureTransaction signature as base-58 encoded string
config?Readonly<{ enableReceivedNotification?: false; }> & Readonly<{ commitment?: Commitment; enableReceivedNotification?: boolean; }>-
Returns

SignatureNotificationsApiNotificationProcessed

See

https://solana.com/docs/rpc/websocket/signaturesubscribe

On this page