> ## Documentation Index
> Fetch the complete documentation index at: https://www.helius.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# S'abonner

> Abonnez-vous aux comptes, transactions, blocs et mises à jour des slots pour recevoir des notifications en temps réel en utilisant l'API gRPC haute performance.

<hide>
  ## Points de terminaison

  Les services gRPC sont disponibles sur le mainnet et le devnet avec les URL suivantes :

  * **Mainnet** `https://laserstream-mainnet.helius-rpc.com:443`
  * **Devnet** `https://laserstream-devnet.helius-rpc.com:443`
</hide>

## Autorisations

<ParamField query="x-token" type="string" required>
  Votre clé API Helius. Vous pouvez en obtenir une gratuitement dans le
  [tableau de bord](https://dashboard.helius.dev/api-keys).
</ParamField>

## Message

L'API gRPC prend en charge plusieurs types d'abonnement qui peuvent être combinés dans une seule requête :

<ParamField body="accounts" type="object">
  Abonnez-vous aux mises à jour de compte. Retourne des données lorsque les comptes spécifiés sont
  modifiés.

  <Expandable title="propriétés" defaultOpen>
    <ParamField body="account" type="array">
      Tableau de pubkeys de compte à surveiller.
    </ParamField>

    <ParamField body="owner" type="array">
      Tableau de pubkeys de propriétaire à surveiller (tous les comptes détenus par ces programmes).
    </ParamField>

    <ParamField body="filters" type="object">
      Filtres optionnels à appliquer.

      <Expandable title="options de filtre">
        <ParamField body="memcmp" type="object">
          Filtre par octets spécifiques à un décalage dans les données de compte.

          <Expandable title="propriétés">
            <ParamField body="offset" type="integer">
              Position en octets pour commencer à comparer les données.
            </ParamField>

            <ParamField body="bytes" type="string">
              Les données à comparer (format octets).
            </ParamField>

            <ParamField body="base58" type="string">
              Les données à comparer (format base58).
            </ParamField>

            <ParamField body="base64" type="string">
              Les données à comparer (format base64).
            </ParamField>
          </Expandable>
        </ParamField>

        <ParamField body="datasize" type="integer">
          Filtre par taille exacte des données de compte en octets.
        </ParamField>

        <ParamField body="token_account_state" type="boolean">
          Filtre uniquement pour les comptes de tokens.
        </ParamField>

        <ParamField body="lamports" type="object">
          Filtre par solde SOL avec comparaisons.

          <Expandable title="opérateurs de comparaison">
            <ParamField body="eq" type="integer">
              Égal à la quantité spécifiée.
            </ParamField>

            <ParamField body="ne" type="integer">
              Différent de la quantité spécifiée.
            </ParamField>

            <ParamField body="lt" type="integer">
              Inférieur à la quantité spécifiée.
            </ParamField>

            <ParamField body="gt" type="integer">
              Supérieur à la quantité spécifiée.
            </ParamField>
          </Expandable>
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField body="nonempty_txn_signature" type="boolean">
      Si `true`, inclure uniquement les mises à jour causées par une transaction. Si `false`, inclure uniquement les mises à jour non causées par une transaction. Si `undefined`, inclure toutes les mises à jour.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="slots" type="object">
  Abonnez-vous aux mises à jour de slot.

  <Expandable title="propriétés" defaultOpen>
    <ParamField body="filter_by_commitment" type="boolean">
      Filtrer les slots par niveau d'engagement.
    </ParamField>

    <ParamField body="interslot_updates" type="boolean">
      Inclure les mises à jour intermédiaires de statut des slots (PROCESSED, CONFIRMED, FINALIZED,
      FIRST\_SHRED\_RECEIVED, COMPLETED, CREATED\_BANK, DEAD).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="transactions" type="object">
  Abonnez-vous aux mises à jour des transactions.

  <Expandable title="propriétés" defaultOpen>
    <ParamField body="vote" type="boolean">
      Inclure les transactions de vote.
    </ParamField>

    <ParamField body="failed" type="boolean">
      Inclure les transactions échouées.
    </ParamField>

    <ParamField body="signature" type="string">
      Surveiller une signature de transaction spécifique.
    </ParamField>

    <ParamField body="account_include" type="array">
      Inclure uniquement les transactions affectant ces comptes.
    </ParamField>

    <ParamField body="account_exclude" type="array">
      Exclure les transactions affectant ces comptes.
    </ParamField>

    <ParamField body="account_required" type="array">
      Les transactions doivent affecter l'ensemble de ces comptes.
    </ParamField>

    <ParamField body="token_accounts" type="enum">
      Expansion optionnelle de compte de token associé (ATA) (tag de champ 30, `TokenAccountExpansionControlFlag`). Lorsqu'il est défini, un portefeuille `account_include` correspond également aux transactions où il **possède** un solde de token SPL — par exemple, les transferts de tokens entrants qui touchent le compte de token du portefeuille plutôt que son pubkey. Deux variantes :

      * `ALL` (**0**) — correspond à toute transaction référencée par un solde de token que le portefeuille possède, même si inchangé. Volume plus élevé.
      * `BALANCE_CHANGED` (**1**) — correspond lorsque le portefeuille possède un solde de token dont le montant a changé (ou dont le compte token a été fermé) dans la transaction.

      Pour désactiver l’expansion, **laissez le champ absent** (`None`) — il n’existe pas de valeur d’énumération « désactivée ». Un entier hors plage est rejeté lors de la construction de la configuration : `Invalid token_accounts value, expected ALL (0) or BALANCE_CHANGED (1)`.

      <Warning>
        `ALL` est la **valeur zéro**. Un client qui définit l'énumération sur `0` en s'attendant à "défaut/désactivé" obtient `ALL` — le mode le plus large, le plus volumineux. La seule façon de signifier "pas d'expansion" est d'omettre complètement le champ.
      </Warning>
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="transactions_status" type="object">
  Abonnez-vous aux mises à jour de statut des transactions.

  <Expandable title="propriétés" defaultOpen>
    <ParamField body="vote" type="boolean">
      Inclure les transactions de vote.
    </ParamField>

    <ParamField body="failed" type="boolean">
      Inclure les transactions échouées.
    </ParamField>

    <ParamField body="signature" type="string">
      Surveiller une signature de transaction spécifique.
    </ParamField>

    <ParamField body="account_include" type="array">
      Inclure uniquement les transactions affectant ces comptes.
    </ParamField>

    <ParamField body="account_exclude" type="array">
      Exclure les transactions affectant ces comptes.
    </ParamField>

    <ParamField body="account_required" type="array">
      Les transactions doivent affecter l'ensemble de ces comptes.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="blocks" type="object">
  Abonnez-vous aux mises à jour des blocs.

  <Expandable title="propriétés" defaultOpen>
    <ParamField body="account_include" type="array">
      Inclure uniquement les blocs avec transactions affectant ces comptes.
    </ParamField>

    <ParamField body="include_transactions" type="boolean">
      Inclure les détails complets des transactions.
    </ParamField>

    <ParamField body="include_accounts" type="boolean">
      Inclure les mises à jour de compte.
    </ParamField>

    <ParamField body="include_entries" type="boolean">
      Inclure les entrées de bloc.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="blocks_meta" type="object">
  Abonnez-vous aux mises à jour des métadonnées des blocs (plus légères que les mises à jour complètes de bloc).

  <Expandable title="retours" defaultOpen>
    <ParamField body="slot" type="integer">
      Numéro de slot.
    </ParamField>

    <ParamField body="blockhash" type="string">
      Blockhash.
    </ParamField>

    <ParamField body="rewards" type="array">
      Informations sur les récompenses.
    </ParamField>

    <ParamField body="block_time" type="integer">
      Heure du bloc.
    </ParamField>

    <ParamField body="block_height" type="integer">
      Hauteur du bloc.
    </ParamField>

    <ParamField body="parent_slot" type="integer">
      Slot parent.
    </ParamField>

    <ParamField body="parent_blockhash" type="string">
      Blockhash parent.
    </ParamField>

    <ParamField body="executed_transaction_count" type="integer">
      Nombre de transactions.
    </ParamField>

    <ParamField body="entries_count" type="integer">
      Nombre d'entrées.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="entry" type="object">
  Abonnez-vous aux mises à jour des entrées.

  <Expandable title="retours" defaultOpen>
    <ParamField body="slot" type="integer">
      Numéro de slot.
    </ParamField>

    <ParamField body="index" type="integer">
      Index d'entrée.
    </ParamField>

    <ParamField body="num_hashes" type="integer">
      Nombre de hachages.
    </ParamField>

    <ParamField body="hash" type="string">
      Hash.
    </ParamField>

    <ParamField body="executed_transaction_count" type="integer">
      Nombre de transactions.
    </ParamField>

    <ParamField body="starting_transaction_index" type="integer">
      Index de départ des transactions.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="commitment" type="enum">
  Le niveau d'engagement pour l'abonnement :

  <Expandable title="niveaux" defaultOpen>
    <ParamField body="PROCESSED" type="integer">
      (0) : Traité par le nœud actuel.
    </ParamField>

    <ParamField body="CONFIRMED" type="integer">
      (1) : Confirmé par la supermajorité du cluster.
    </ParamField>

    <ParamField body="FINALIZED" type="integer">
      (2) : Finalisé par le cluster.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="accounts_data_slice" type="array">
  Spécifie les données de compte partielles à recevoir :

  <Expandable title="propriétés" defaultOpen>
    <ParamField body="offset" type="integer">
      Position en octets pour commencer à lire les données.
    </ParamField>

    <ParamField body="length" type="integer">
      Nombre d'octets à lire.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="ping" type="object">
  Activez les messages ping-pong pour la surveillance de la santé de la connexion.

  <Expandable title="propriétés" defaultOpen>
    <ParamField body="id" type="integer">
      Identifiant numérique pour le ping.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="from_slot" type="integer">
  Slot de départ pour recevoir les mises à jour. Les mises à jour pour les slots avant cette valeur
  seront exclues.
</ParamField>

<RequestExample>
  ```json Accounts Subscription theme={"system"}
  {
    "slots": {
        "slots": {}
    },
    "accounts": {
        "user-defined-label": {
            "account": [
                "DjUF9ASpyMbVpGJmTvzfSbCgUWj6JowwLh8dGAJzSPmu",
                "5U3bH5b6XtG99aVCE9ycvDgBKQx3fVT8WwTNbMToFuEr"
            ],
            "owner": [
                "TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"
            ],
            "filter": {
                "memcmp": {
                    "offset": 0,
                    "bytes": "0102030405"
                },
                "datasize": 165,
                "token_account_state": true,
                "lamports": {
                    "gt": 100000000
                }
            },
            "nonempty_txn_signature": true
        }
    },
    "transactions": {},
    "blocks": {},
    "blocks_meta": {},
    "accounts_data_slice": [],
    "commitment": 1
  }
  ```

  ```json Slots Subscription theme={"system"}
  {
    "slots": {
      "incoming_slots": {}
    },
    "commitment": 1
  }
  ```

  ```json Transactions Subscription theme={"system"}
  {
    "transactions": {
      "vote": false,
      "failed": true,
      "signature": "4RPMxKBhCBubFmZ1r9BC52ztjG3qBTW9Gp1PXfufUSATQaLKTW3Dj6vQBYyVrhfjgJ4PjZLzwYs4Z92KDCPw8Qym",
      "account_include": ["DjUF9ASpyMbVpGJmTvzfSbCgUWj6JowwLh8dGAJzSPmu"],
      "account_exclude": ["TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"],
      "account_required": ["11111111111111111111111111111111"]
    },
    "commitment": 2
  }
  ```

  ```json Wallet + Token Transfers (ATA expansion) theme={"system"}
  {
    "transactions": {
      "wallet": {
        "vote": false,
        "failed": false,
        "account_include": ["DjUF9ASpyMbVpGJmTvzfSbCgUWj6JowwLh8dGAJzSPmu"],
        "account_exclude": [],
        "account_required": [],
        "token_accounts": 1
      }
    },
    "commitment": 1
  }
  ```

  ```json Transaction Status Subscription theme={"system"}
  {
    "transactions_status": {
      "vote": false,
      "failed": true,
      "account_include": ["DjUF9ASpyMbVpGJmTvzfSbCgUWj6JowwLh8dGAJzSPmu"],
      "account_exclude": ["TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"],
      "account_required": ["11111111111111111111111111111111"]
    },
    "commitment": 2
  }
  ```

  ```json Blocks Subscription theme={"system"}
  {
    "blocks": {
      "account_include": ["DjUF9ASpyMbVpGJmTvzfSbCgUWj6JowwLh8dGAJzSPmu"],
      "include_transactions": 1,
      "include_accounts": 1,
      "include_entries": 0
    },
    "commitment": 2
  }
  ```

  ```json Block Metadata Subscription theme={"system"}
  {
    "blocks_meta": {},
    "commitment": 2,
    "from_slot": 139000000
  }
  ```

  ```json Entry Subscription theme={"system"}
  {
    "entry": {},
    "commitment": 1
  }
  ```

  ```json Partial Account Data Subscription theme={"system"}
  {
    "accounts": {
      "account": ["DjUF9ASpyMbVpGJmTvzfSbCgUWj6JowwLh8dGAJzSPmu"]
    },
    "accounts_data_slice": [
      {
        "offset": 0,
        "length": 64
      },
      {
        "offset": 128,
        "length": 32
      }
    ],
    "commitment": 2
  }
  ```

  ```json Ping Subscription theme={"system"}
  {
    "ping": {
      "id": 1
    }
  }
  ```

  ```json Combined Subscription theme={"system"}
  {
    "accounts": {
      "account": ["DjUF9ASpyMbVpGJmTvzfSbCgUWj6JowwLh8dGAJzSPmu"],
      "nonempty_txn_signature": true
    },
    "slots": {
      "filter_by_commitment": 1,
      "interslot_updates": 1
    },
    "commitment": 2,
    "from_slot": 139000000,
    "ping": {
      "id": 123
    }
  }
  ```
</RequestExample>

## Niveaux d'engagement

Tous les abonnements prennent en charge les niveaux d'engagement suivants :

* `PROCESSED` : Traité par le nœud actuel (0)
* `CONFIRMED` : Confirmé par la supermajorité du cluster (1)
* `FINALIZED` : Finalisé par le cluster (2)

## Structure de réponse

Les réponses d'abonnement incluent :

* `filters` : Les noms de filtres qui ont correspondu à cette mise à jour
* Un des types de mise à jour suivants :
  * `account` : Données de compte, propriétaire, lamports, statut exécutable, etc.
  * `slot` : Informations de slot et mises à jour de statut
  * `transaction` : Détails complets de la transaction, signature et métadonnées
  * `transaction_status` : Statut d'exécution de la transaction (succès/erreur)
  * `block` : Données complètes du bloc avec transactions, comptes, récompenses, etc.
  * `block_meta` : Métadonnées légères du bloc sans détails complets de la transaction
  * `entry` : Détails d'entrée dans un bloc
  * `ping`/`pong` : Messages de vérification de santé de connexion
* `created_at` : Horodatage lorsque la mise à jour a été créée

<ResponseExample>
  ```json Account Update theme={"system"}
  {
    "filters": ["accounts"],
    "account": {
      "account": {
        "pubkey": "BASE58_ENCODED_PUBKEY",
        "lamports": 12345678,
        "owner": "BASE58_ENCODED_OWNER",
        "executable": false,
        "rent_epoch": 361,
        "data": "BASE64_ENCODED_DATA",
        "write_version": 123,
        "txn_signature": "BASE58_ENCODED_SIGNATURE"
      },
      "slot": 189554321,
      "is_startup": false
    },
    "created_at": "2023-04-28T12:34:56.789Z"
  }
  ```

  ```json Slot Update theme={"system"}
  {
    "filters": ["slots"],
    "slot": {
      "slot": 189554321,
      "parent": 189554320,
      "status": 2,
      "dead_error": null
    },
    "created_at": "2023-04-28T12:34:56.789Z"
  }
  ```

  ```json Transaction Update theme={"system"}
  {
    "filters": ["transactions"],
    "transaction": {
      "transaction": {
        "signature": "BASE58_ENCODED_SIGNATURE",
        "is_vote": false,
        "transaction": {
          "signatures": ["BASE58_ENCODED_SIGNATURE"],
          "message": {
            "header": {
              "num_required_signatures": 1,
              "num_readonly_signed_accounts": 0,
              "num_readonly_unsigned_accounts": 1
            },
            "account_keys": ["BASE58_ENCODED_PUBKEY1", "BASE58_ENCODED_PUBKEY2"],
            "recent_blockhash": "BASE58_ENCODED_BLOCKHASH",
            "instructions": [
              {
                "program_id_index": 1,
                "accounts": [0],
                "data": "BASE64_ENCODED_INSTRUCTION_DATA"
              }
            ]
          }
        },
        "meta": {
          "err": null,
          "fee": 5000,
          "pre_balances": [10000000, 1],
          "post_balances": [9995000, 1],
          "pre_token_balances": [],
          "post_token_balances": [],
          "log_messages": ["Program log: Instruction executed"],
          "rewards": []
        },
        "index": 2
      },
      "slot": 189554321
    },
    "created_at": "2023-04-28T12:34:56.789Z"
  }
  ```

  ```json Block Metadata Update theme={"system"}
  {
    "filters": ["blocks_meta"],
    "block_meta": {
      "slot": 189554321,
      "blockhash": "BASE58_ENCODED_BLOCKHASH",
      "rewards": [
        {
          "pubkey": "BASE58_ENCODED_PUBKEY",
          "lamports": 1785000,
          "post_balance": 48589432109,
          "reward_type": 0,
          "commission": 10
        }
      ],
      "block_time": 1682684096,
      "block_height": 185432109,
      "parent_slot": 189554320,
      "parent_blockhash": "BASE58_ENCODED_PARENT_BLOCKHASH",
      "executed_transaction_count": 2576,
      "entries_count": 16
    },
    "created_at": "2023-04-28T12:34:56.789Z"
  }
  ```

  ```json Entry Update theme={"system"}
  {
    "filters": ["entry"],
    "entry": {
      "slot": 189554321,
      "index": 5,
      "num_hashes": 8765432,
      "hash": "BASE58_ENCODED_HASH",
      "executed_transaction_count": 128,
      "starting_transaction_index": 1024
    },
    "created_at": "2023-04-28T12:34:56.789Z"
  }
  ```

  ```json Pong Response theme={"system"}
  {
    "filters": [],
    "pong": {
      "id": 1
    },
    "created_at": "2023-04-28T12:34:56.789Z"
  }
  ```
</ResponseExample>