Skip to content

Commit 93ac0ad

Browse files
Add Base subscription methods (#1916)
* Add Base subscription methods * Update what's new
1 parent 61142dd commit 93ac0ad

File tree

7 files changed

+134
-8
lines changed

7 files changed

+134
-8
lines changed

docs/whats-new.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,15 @@ of the [MetaMask developer page](https://metamask.io/developer/).
1111

1212
## March 2025
1313

14+
- Documented [Base subscription methods](/services/reference/base/json-rpc-methods/subscription-methods).
15+
([#1916](https://github.com/MetaMask/metamask-docs/pull/1916))
1416
- Added full table for [Gas API supported networks](/services/get-started/endpoints/#gas-api).
1517
([#1914](https://github.com/MetaMask/metamask-docs/pull/1914))
1618

1719
## February 2025
1820

21+
- Relaunched MetaMask documentation site with new branding.
22+
([#1898](https://github.com/MetaMask/metamask-docs/pull/1898))
1923
- Documented [Unichain Mainnet](/services/reference/unichain) support. ([#1878](https://github.com/MetaMask/metamask-docs/pull/1878))
2024

2125
## January 2025
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
import Tabs from "@theme/Tabs"
2+
import TabItem from "@theme/TabItem"
3+
4+
<Tabs>
5+
<TabItem value="newHeads">
6+
7+
```bash
8+
wscat -c wss://base-mainnet.infura.io/ws/v3/<YOUR-API-KEY> -x '{"jsonrpc": "2.0", "id": 1, "method": "eth_subscribe", "params": ["newHeads"]}'
9+
```
10+
11+
</TabItem>
12+
<TabItem value="logs">
13+
14+
```bash
15+
wscat -c wss://base-mainnet.infura.io/ws/v3/<YOUR-API-KEY> -x '{"jsonrpc": "2.0", "id": 1, "method": "eth_subscribe", "params": ["logs", {"address": "0x8320fe7702b96808f7bbc0d4a888ed1468216cfd", "topics": ["0xd78a0cb8bb633d06981248b816e7bd33c2a35a6089241d099fa519e361cab902"]}]}'
16+
```
17+
18+
</TabItem>
19+
</Tabs>
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import Tabs from "@theme/Tabs"
2+
import TabItem from "@theme/TabItem"
3+
4+
<Tabs>
5+
<TabItem value="WSS">
6+
7+
```bash
8+
wscat -c wss://base-mainnet.infura.io/ws/v3/<YOUR-API-KEY> -x '{"jsonrpc": "2.0", "id": 1, "method": "eth_unsubscribe", "params": ["0x9cef478923ff08bf67fde6c64013158d"]}'
9+
```
10+
11+
</TabItem>
12+
</Tabs>
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: "eth_subscribe"
3+
---
4+
5+
import Tabs from "@theme/Tabs"
6+
import TabItem from "@theme/TabItem"
7+
8+
import Description from "/services/reference/_partials/subscription-methods/_eth_subscribe-description.mdx"
9+
10+
<Description />
11+
12+
## Parameters
13+
14+
import Params from "/services/reference/_partials/subscription-methods/_eth_subscribe-parameters-no-pending.mdx"
15+
16+
<Params />
17+
18+
## Returns
19+
20+
import Returns from "/services/reference/_partials/subscription-methods/_eth_subscribe-returns.mdx"
21+
22+
<Returns />
23+
24+
## Example
25+
26+
import Example from "/services/reference/_partials/subscription-methods/_eth_subscribe-example.mdx"
27+
28+
<Example />
29+
30+
### Request
31+
32+
import Request from "./_eth_subscribe-request.mdx"
33+
34+
<Request />
35+
36+
### Response
37+
38+
import Response from "/services/reference/_partials/subscription-methods/_eth_subscribe-response-no-pending.mdx"
39+
40+
<Response />
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: "eth_unsubscribe"
3+
---
4+
5+
import Tabs from "@theme/Tabs"
6+
import TabItem from "@theme/TabItem"
7+
8+
import Description from "/services/reference/_partials/subscription-methods/_eth_unsubscribe-description.mdx"
9+
10+
<Description />
11+
12+
## Parameters
13+
14+
import Params from "/services/reference/_partials/subscription-methods/_eth_unsubscribe-parameters.mdx"
15+
16+
<Params />
17+
18+
## Returns
19+
20+
import Returns from "/services/reference/_partials/subscription-methods/_eth_unsubscribe-returns.mdx"
21+
22+
<Returns />
23+
24+
## Example
25+
26+
import Example from "/services/reference/_partials/subscription-methods/_eth_unsubscribe-example.mdx"
27+
28+
<Example />
29+
30+
### Request
31+
32+
import Request from "./_eth_unsubscribe-request.mdx"
33+
34+
<Request />
35+
36+
### Response
37+
38+
import Response from "/services/reference/_partials/subscription-methods/_eth_unsubscribe-response.mdx"
39+
40+
<Response />
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Subscription methods"
3+
---
4+
5+
# Subscription methods
6+
7+
Subscription methods are available for [WebSocket](../../../../concepts/websockets.md) connections only, and allow you to wait for events instead of polling for them. For example, dapps can subscribe to logs and receive notifications when a specific event occurs.
8+
9+
The following subscription methods are available:
10+
11+
- [`eth_subscribe`](eth_subscribe.mdx) - Create a subscription to a particular event
12+
- [`eth_unsubscribe`](eth_unsubscribe.mdx) - Cancel an active subscription
13+
14+
:::info
15+
16+
We recommend you use the WSS protocol to set up bidirectional stateful subscriptions. Stateless HTTP WebSockets are also
17+
supported.
18+
19+
:::

services/reference/bnb-smart-chain/json-rpc-methods/subscription-methods/_eth_subscribe-request.mdx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,6 @@ wscat -c wss://bsc-mainnet.infura.io/ws/v3/<YOUR-API-KEY> -x '{"jsonrpc": "2.0",
1313

1414
```bash
1515
wscat -c wss://bsc-mainnet.infura.io/ws/v3/<YOUR-API-KEY> -x '{"jsonrpc": "2.0", "id": 1, "method": "eth_subscribe", "params": ["logs", {"address": "0x8320fe7702b96808f7bbc0d4a888ed1468216cfd", "topics":["0xd78a0cb8bb633d06981248b816e7bd33c2a35a6089241d099fa519e361cab902"]}]}'
16-
```
17-
18-
</TabItem>
19-
20-
<TabItem value="newPendingTransactions">
21-
22-
```bash
23-
wscat -c wss://bsc-mainnet.infura.io/ws/v3/<YOUR-API-KEY> -x '{"jsonrpc": "2.0", "id": 1, "method": "eth_subscribe", "params": ["newPendingTransactions"]}'
2416
```
2517

2618
</TabItem>

0 commit comments

Comments
 (0)