Zum Hauptinhalt springen

WebSockets verwenden

Alchemy
websockets
abfragen
JavaScript
Anfänger
Elan Halpern
1. Dezember 2020
7 Minuten Lesezeit

Dies ist ein Einstiegsleitfaden zur Verwendung von WebSockets, um Anfragen an die Ethereum-Blockchain zu stellen. Die Beispiele verwenden Standard-JSON-RPC-Methoden, sodass sie mit jedem Knoten oder Knoten-Anbieter funktionieren, der einen WebSocket-Endpunkt anbietet, einschließlich Alchemy.

 (öffnet in einem neuen Tab)WebSockets vs. HTTP

Im Gegensatz zu HTTP müssen Sie bei WebSockets nicht ständig Anfragen stellen, wenn Sie bestimmte Informationen wünschen. WebSockets halten eine Netzwerkverbindung für Sie aufrecht (wenn es richtig gemacht wird) und lauschen auf Änderungen.

Wie bei jeder Netzwerkverbindung sollten Sie nicht davon ausgehen, dass ein WebSocket für immer ohne Unterbrechung geöffnet bleibt. Das korrekte manuelle Behandeln von abgebrochenen Verbindungen und Wiederverbindungen kann jedoch eine Herausforderung sein. Ein weiterer Nachteil von WebSockets ist, dass Sie in der Antwort keine HTTP-Statuscodes erhalten, sondern nur die Fehlernachricht.

Client-Bibliotheken können dies für Sie übernehmen. Zum Beispiel stellt der WebSocket-Transport von Viem (öffnet in einem neuen Tab) bei einem Socket-Fehler standardmäßig die Verbindung wieder her und sendet Keep-Alive-Pings.

Probieren Sie es aus

Sie benötigen eine WebSocket-URL für einen Ethereum-Knoten. Knoten-Anbieter geben Ihnen eine, wenn Sie einen Schlüssel für die Programmierschnittstelle (API) erstellen, normalerweise in der Form wss://<provider-host>/<your-api-key>. Zum Beispiel sieht eine Alchemy-URL für das Ethereum Mainnet wie folgt aus: wss://eth-mainnet.g.alchemy.com/v2/<your-api-key> (melden Sie sich für ein kostenloses Alchemy-Konto an (öffnet in einem neuen Tab)). Siehe Knoten als Dienstleistung für andere Anbieter, oder verwenden Sie den WebSocket-Endpunkt Ihres eigenen Knotens. Öffentliche Endpunkte wie wss://ethereum-rpc.publicnode.com funktionieren auch für schnelle Experimente, sind jedoch ratenlimitiert und unterstützen möglicherweise nicht jeden Abonnementtyp.

Der einfachste Weg, WebSockets zu testen, ist die Installation eines Befehlszeilentools für WebSocket-Anfragen wie wscat (öffnet in einem neuen Tab). Mit wscat können Sie Anfragen wie folgt senden:

npx wscat -c wss://<provider-host>/<your-api-key>

> {"jsonrpc": "2.0", "id": 0, "method": "eth_gasPrice"}

< {"jsonrpc": "2.0", "result": "0x41f9de2", "id": 0}

Zeilen, die mit > beginnen, sind das, was Sie eingeben, und Zeilen, die mit < beginnen, sind das, was der Knoten zurücksendet.

Wie man WebSockets verwendet

Öffnen Sie zu Beginn einen WebSocket über die WebSocket-URL Ihres Anbieters. Bei Alchemy finden Sie diese, indem Sie Ihre App im Dashboard (öffnet in einem neuen Tab) öffnen und sich deren Schlüssel für die Programmierschnittstelle (API) ansehen. Beachten Sie, dass sich die URL für WebSockets (wss://) von der URL für HTTP-Anfragen (https://) unterscheidet, obwohl die meisten Anbieter denselben API-Schlüssel für beides verwenden.

Jede der JSON-RPC-Methoden, die Ihr Anbieter unterstützt, kann über WebSocket verwendet werden. Verwenden Sie dazu dieselbe Payload, die als Textkörper einer HTTP-POST-Anfrage gesendet werden würde, senden Sie diese Payload jedoch stattdessen über den WebSocket.

Mit Web3

Der Wechsel zu WebSockets bei der Verwendung einer Client-Bibliothek wie Viem (öffnet in einem neuen Tab) ist einfach. Verwenden Sie den webSocket-Transport mit Ihrer WebSocket-URL anstelle des http-Transports. Speichern Sie dies beispielsweise nach npm install viem als index.mjs und führen Sie node index.mjs aus:

Abonnement-API

Wenn Sie über einen WebSocket verbunden sind, können Sie zwei zusätzliche Methoden verwenden: eth_subscribe und eth_unsubscribe. Diese Methoden ermöglichen es Ihnen, auf bestimmte Ereignisse zu lauschen und sofort benachrichtigt zu werden.

eth_subscribe

Erstellt ein neues Abonnement für bestimmte Ereignisse. Erfahren Sie mehr über eth_subscribe (öffnet in einem neuen Tab).

Parameter

  1. Abonnementtypen
  2. Optionale Parameter

Das erste Argument gibt die Art des Ereignisses an, auf das gelauscht werden soll. Das zweite Argument enthält zusätzliche Optionen, die vom ersten Argument abhängen. Die verschiedenen Beschreibungstypen, ihre Optionen und ihre Ereignis-Payloads werden unten beschrieben.

Rückgabewerte

Die Abonnement-ID: Diese ID wird an alle empfangenen Ereignisse angehängt und kann auch verwendet werden, um das Abonnement mit eth_unsubscribe zu kündigen.

Abonnement-Ereignisse

Solange das Abonnement aktiv ist, erhalten Sie Ereignisse, die Objekte mit den folgenden Feldern sind:

  • jsonrpc: Immer "2.0"
  • method: Immer "eth_subscription"
  • params: Ein Objekt mit den folgenden Feldern:
    • subscription: Die Abonnement-ID, die durch den Aufruf von eth_subscribe zurückgegeben wurde, der dieses Abonnement erstellt hat.
    • result: Ein Objekt, dessen Inhalt je nach Art des Abonnements variiert.

Abonnementtypen

  1. newHeads

Gibt jedes Mal ein Ereignis aus, wenn der Chain ein neuer Header hinzugefügt wird, auch während eines Chain-Reorgs.

Wenn ein Chain-Reorg auftritt, gibt dieses Abonnement ein Ereignis aus, das alle neuen Header für die neue Chain enthält. Insbesondere bedeutet dies, dass Sie möglicherweise mehrere Header sehen, die mit derselben Höhe ausgegeben werden. Wenn dies geschieht, sollte der spätere Header nach einem Reorg als der korrekte angesehen werden.

Beispiel:

  1. logs

Gibt Protokolle (Logs) aus, die Teil neu hinzugefügter Blöcke sind und bestimmten Filterkriterien entsprechen.

Wenn ein Chain-Reorg auftritt, werden Protokolle, die Teil von Blöcken auf der alten Chain sind, erneut ausgegeben, wobei die Eigenschaft removed auf true gesetzt ist. Darüber hinaus werden Protokolle ausgegeben, die Teil der Blöcke auf der neuen Chain sind, was bedeutet, dass es möglich ist, im Falle eines Reorgs Protokolle für dieselbe Transaktion mehrmals zu sehen.

Parameter

  1. Ein Objekt mit den folgenden Feldern:
    • address (optional): entweder ein String, der eine Adresse darstellt, oder ein Array solcher Strings.
      • Nur Protokolle, die von einer dieser Adressen erstellt wurden, werden ausgegeben.
    • topics: ein Array von Topic-Spezifikatoren.
      • Jeder Topic-Spezifikator ist entweder null, ein String, der ein Topic darstellt, oder ein Array von Strings.
      • Jede Position im Array, die nicht null ist, beschränkt die ausgegebenen Protokolle auf diejenigen, die eines der angegebenen Topics an dieser Position haben.

Einige Beispiele für Topic-Spezifikationen:

  • []: Alle Topics erlaubt.
  • [A]: A an erster Position (und alles danach).
  • [null, B]: Alles an erster Position und B an zweiter Position (und alles danach).
  • [A, B]: A an erster Position und B an zweiter Position (und alles danach).
  • [[A, B], [A, B]]: (A oder B) an erster Position und (A oder B) an zweiter Position (und alles danach).

Beispiel:

Dieses Beispiel lauscht auf Deposit-Ereignisse vom WETH-Vertrag (öffnet in einem neuen Tab) im Ethereum Mainnet:

  1. newPendingTransactions

Gibt den Hash jeder Transaktion aus, die dem ausstehenden Zustand (seinem Mempool) des Knotens hinzugefügt wird.

Beispiel:

> {"jsonrpc": "2.0", "id": 1, "method": "eth_subscribe", "params": ["newPendingTransactions"]}

< {"jsonrpc":"2.0","result":"0x1c2365b029179adf1e84b9e327315249","id":1}
< {"jsonrpc":"2.0","method":"eth_subscription","params":{"result":"0x4a62d0ad7c8868fbbfa10604e68638e637c6fc6f64fd1fb4ca042dcd0158c992","subscription":"0x1c2365b029179adf1e84b9e327315249"}}

Einige Anbieter bieten auch ihre eigenen Abonnementtypen an. Zum Beispiel gibt Alchemys alchemy_pendingTransactions (öffnet in einem neuen Tab) vollständige Transaktionsobjekte anstelle von nur Hashes aus und akzeptiert optionale Filter wie fromAddress, toAddress und hashesOnly. Diese sind nicht Teil der Standard-JSON-RPC-Programmierschnittstelle (API), sodass sie nur mit diesem Anbieter funktionieren.

eth_unsubscribe

Kündigt ein bestehendes Abonnement, sodass keine weiteren Ereignisse gesendet werden.

Parameter

  1. Abonnement-ID, wie zuvor von einem eth_subscribe-Aufruf zurückgegeben.

Rückgabewerte

true, wenn ein Abonnement erfolgreich gekündigt wurde, oder false, wenn kein Abonnement mit der angegebenen ID existierte.

Ein Abonnement existiert nur auf der WebSocket-Verbindung, die es erstellt hat, daher muss eth_unsubscribe über dieselbe Verbindung gesendet werden. Es kann nicht als separate HTTP-Anfrage gesendet werden. Das Schließen der Verbindung kündigt auch alle ihre Abonnements.

Beispiel:

> {"jsonrpc": "2.0", "id": 2, "method": "eth_unsubscribe", "params": ["0xe0d4abf5caf333fbf94c5f02182e6469"]}

< {"jsonrpc":"2.0","result":true,"id":2}

Melden Sie sich kostenlos bei Alchemy an (öffnet in einem neuen Tab), sehen Sie sich die Dokumentation von Alchemy (öffnet in einem neuen Tab) an und folgen Sie Alchemy auf Twitter (öffnet in einem neuen Tab) für die neuesten Nachrichten.