Skip to content

Commit dc1e974

Browse files
authored
feat: create server overrides for eth_subscribe/unsubscribe (#832)
1 parent 2dc8261 commit dc1e974

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

src/openrpc/chains/_components/evm/methods.yaml

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -990,7 +990,15 @@ components:
990990
# Subscription methods
991991
eth_subscribe:
992992
name: eth_subscribe
993-
description: Subscribes to specific event types and returns a subscription ID to receive asynchronous notifications via the `eth_subscription` method.
993+
summary: Subscribe to Ethereum events via WebSocket (WSS required)
994+
description: |
995+
Subscribes to specific event types and returns a subscription ID to receive asynchronous notifications via the `eth_subscription` method.
996+
997+
⚠️ **WARNING: WebSocket-Only Method** ⚠️
998+
999+
> This method REQUIRES a WebSocket connection using `wss://` protocol. It will NOT work with standard HTTP/HTTPS requests or `curl`.
1000+
> See the [WebSocket documentation](https://docs.alchemy.com/reference/subscription-api) for examples.
1001+
x-fern-explorer: false
9941002
params:
9951003
- name: Subscription Type
9961004
description: The type of event to subscribe to (e.g., "newHeads", "logs", "newPendingTransactions", "syncing").
@@ -1017,7 +1025,15 @@ components:
10171025

10181026
eth_unsubscribe:
10191027
name: eth_unsubscribe
1020-
description: Cancels an active subscription given its subscription ID.
1028+
summary: Cancel a WebSocket subscription (WSS required)
1029+
description: |
1030+
Cancels an active subscription given its subscription ID.
1031+
1032+
⚠️ **WARNING: WebSocket-Only Method** ⚠️
1033+
1034+
> This method REQUIRES a WebSocket connection using `wss://` protocol. It will NOT work with standard HTTP/HTTPS requests or `curl`.
1035+
> See the [WebSocket documentation](https://docs.alchemy.com/reference/subscription-api) for examples.
1036+
x-fern-explorer: false
10211037
params:
10221038
- name: Subscription ID
10231039
description: The identifier of the subscription to cancel.

0 commit comments

Comments
 (0)