サブスクリプション

別のサーバー

On a deployment behind a reverse proxy, both /ws and /ws/ are served as two separate locations with no redirect between them: a WebSocket client mostly does not follow a 301 on its handshake, so whichever spelling was redirected would simply fail to connect.

ハンドシェイク

eth_subscribe と pickle_subscribe はどちらも同じように 受け付けられ、同じようにふるまいます。

// ->
{"jsonrpc":"2.0","id":1,"method":"pickle_subscribe","params":["miniBlocks"]}

// <-
{"jsonrpc":"2.0","id":1,"result":"0x1"}

// <- then, per event
{"jsonrpc":"2.0","method":"eth_subscription","params":{"subscription":"0x1","result":{…}}}

• Subscription ids come from a per-connection counter starting at 1, so two connections both see 0x1. Do not treat an id as globally unique.
• Notifications always arrive under the method name eth_subscription, even for a subscription opened as pickle_subscribe. Unwrap the payload at params.result.
• eth_unsubscribe and pickle_unsubscribe both return a boolean: true if the id was found on this connection, false otherwise.

四つの種類

通しの例

ミニブロックのストリームと、ファーストパーティのフィードが使っている代替経路です。この 代替経路が効きます。ソケットが切れるのは普通のことで、取りこぼしなく追いつく方法が ポーリングの経路です。

// WS_URL: wss://rpc.picklechain.xyz/ws/ on the public testnet, or a node of your own.
// The /ws path is required - an upgrade at the bare origin answers 405.
const socket = new WebSocket(WS_URL);

socket.addEventListener("open", () => {
  socket.send(JSON.stringify({
    jsonrpc: "2.0", id: 1, method: "pickle_subscribe", params: ["miniBlocks"],
  }));
});

socket.addEventListener("message", (event) => {
  const message = JSON.parse(event.data);
  // The subscribe reply carries an id; notifications carry params.result.
  if (!message.params) return;
  const mini = message.params.result;

  // Decimal numbers, not hex quantities - and microseconds, not seconds.
  console.log(mini.number, mini.transactions.length, mini.timestampUs);
});

// A slow handler is DROPPED from the stream rather than buffered, so do the
// work elsewhere and keep this callback cheap.

ソケットが閉じたら、pickle_miniBlockNumber を問い合わせ、最後に見た高さから pickle_getMiniBlockByNumber を取ってください。追いつきには上限を設けること。 参照クライアントは 1 回のパスにつき最大 100 件を取得します。さもないと長い切断が、共有の 重い読み取り予算に対する大量のリクエストに変わります。

制限と切り離しの方針

これらの制限はどれも環境変数で調整できず、接続数の上限は accept の時点で適用されます。 257 番目の接続はエラーのフレームなしに閉じられるので、拒否ではなくネットワーク障害のように 見えます。

ソケット上の通常の呼び出し

Any frame that is not a subscribe or unsubscribe is forwarded to the same handler the HTTP port uses, so every method in the reference is callable over the socket.