signatureSubscribe

Subscribe to receive status notifications for the transaction with the given signature.

Source

signature_subscribe

This subscription ends after the terminal confirmation notification. If enableReceivedNotification is true, the RPC node may send an earlier receivedSignature notification first and keep the subscription active until the signature reaches the requested commitment.

params

stringrequired

Transaction signature, as a base-58 encoded string.

The signature must be the first signature from the transaction.

objectoptional

Optional configuration object.

result

integer

Subscription id. Pass this to signatureUnsubscribe if you cancel the subscription before it fires.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "signatureSubscribe",
  "params": [
    "2EBVM6cB8vAAD93Ktr6Vd8p67XPbQzCJX47MpReuiCXJAtcjaxpvWpcg9Ege1Nr5Tk3a2GFrByT7WPBjdsTycY9b",
    {
      "commitment": "finalized",
      "enableReceivedNotification": false
    }
  ]
}

Response

{
  "jsonrpc": "2.0",
  "result": 0,
  "id": 1
}

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "signatureSubscribe",
  "params": [
    "2EBVM6cB8vAAD93Ktr6Vd8p67XPbQzCJX47MpReuiCXJAtcjaxpvWpcg9Ege1Nr5Tk3a2GFrByT7WPBjdsTycY9b",
    {
      "commitment": "finalized",
      "enableReceivedNotification": false
    }
  ]
}

params

stringrequired

Transaction signature, as a base-58 encoded string.

The signature must be the first signature from the transaction.

objectoptional

Optional configuration object.

result

Response

{
  "jsonrpc": "2.0",
  "result": 0,
  "id": 1
}

integer

Subscription id. Pass this to signatureUnsubscribe if you cancel the subscription before it fires.

Notification format

Notifications are delivered as signatureNotification. The payload includes params.result.context and params.result.value, where value is either:

{ "err": null | <transaction error> } when the signature reaches the requested commitment
"receivedSignature" when enableReceivedNotification is true and the RPC first receives the signature

Terminal confirmation notification:

{
  "jsonrpc": "2.0",
  "method": "signatureNotification",
  "params": {
    "result": {
      "context": {
        "slot": 306
      },
      "value": {
        "err": null
      }
    },
    "subscription": 0
  }
}

jsonrpc

string

Always "2.0".

method

string

Always "signatureNotification".

params

object

Notification wrapper with the signature status payload and the subscription id.

This early notification is only emitted when enableReceivedNotification: true.

{
  "jsonrpc": "2.0",
  "method": "signatureNotification",
  "params": {
    "result": {
      "context": {
        "slot": 1
      },
      "value": "receivedSignature"
    },
    "subscription": 0
  }
}

jsonrpc

string

Always "2.0".

method

string

Always "signatureNotification".

params

object

Notification wrapper with the early received-signature payload and the subscription id.