Méthode RPC signatureSubscribe

S'abonner pour recevoir une notification lorsque la transaction avec la signature donnée atteint le niveau d'engagement spécifié.

Il s'agit d'un abonnement à une notification unique. Il est automatiquement annulé par le serveur une fois que la notification, signatureNotification, est envoyée par le RPC.

params

stringrequired

signature de transaction, sous forme de chaîne encodée en base-58

La signature de transaction doit être la première signature de la transaction (voir identifiant de transaction pour plus de détails).

objectoptional

Objet de configuration contenant les champs suivants :

result

integer

identifiant d'abonnement (nécessaire pour se désabonner)

{
  "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

signature de transaction, sous forme de chaîne encodée en base-58

La signature de transaction doit être la première signature de la transaction (voir identifiant de transaction pour plus de détails).

objectoptional

Objet de configuration contenant les champs suivants :

result

Response

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

integer

identifiant d'abonnement (nécessaire pour se désabonner)

Format de notification :

La notification sera un objet JSON RpcResponse avec une valeur contenant un objet avec :

slot: <u64> - Le slot correspondant.
value: <object|string> - une valeur de notification de RpcSignatureResult, résultant soit en :
- lorsque enableReceivedNotification est true et que la signature est reçue : la chaîne littérale "receivedSignature", ou
- lorsque la signature est traitée : err: <object|null> :
  - null si la transaction a réussi à être traitée au niveau d'engagement spécifié, ou
  - un TransactionError, si la transaction a échoué

Exemples de réponses :

Voici un exemple de réponse d'une notification pour une transaction traitée avec succès :

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

Voici un exemple de réponse d'une notification pour une signature de transaction reçue avec succès :

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