The signatureUnsubscribe
method in Solana allows a client to unsubscribe from a signature subscription. This method can be used to cancel an existing subscription to transaction signature updates.
See also signatureSubscribe | Solana.
Get your own Solana node endpoint today
Start for free and get your app to production levels immediately. No credit card required.
You can sign up with your GitHub, X, Google, or Microsoft account.
Parameters
integer
- The ID of the subscription that you want to cancel. This is the subscription ID that was returned when callingsignatureSubscribe
.
Response
boolean
- A boolean value indicating if the subscription was removed successfully.true
if removed successfully,false
if not.
signatureUnsubscribe
code examples
signatureUnsubscribe
code examplesNote that subscriptions require a WebSocket connection. You can use a WebSocket client library for your programming language of choice to interact with Solana's WebSocket API.
$ wscat -c YOUR_CHAINSTACK_WEBSOCKET_ENDPOINT
# Wait for the connection to be established
Connected (press CTRL+C to quit)
> {"jsonrpc":"2.0","id":1,"method":"signatureUnsubscribe","params":[0]}
Use case
The signatureUnsubscribe
method is important for proper resource management in applications that use signature subscriptions. Common use cases include:
- Cleanup: Remove signature subscriptions after transaction confirmation
- Resource optimization: Free up resources by unsubscribing from completed transactions
- Connection management: Clean up subscriptions during WebSocket disconnections
- Transaction lifecycle: Automatically unsubscribe after receiving desired confirmation status
By properly managing signature subscriptions through unsubscribe calls, applications can maintain optimal performance and prevent unnecessary resource usage.