Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add ZKsync WebSocket support. #1438

Merged
merged 7 commits into from
Jul 23, 2024
Merged

Add ZKsync WebSocket support. #1438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c69295b
Add ZKsync WebSocket support.
bgravenorst Jul 23, 2024
8ab5b52
Add What's new.
bgravenorst Jul 23, 2024
a2fda90
Apply suggestions from code review
joaniefromtheblock Jul 23, 2024
37b4037
update spacing
joaniefromtheblock Jul 23, 2024
a727b49
Update all endpoints topic.
bgravenorst Jul 23, 2024
6d69968
Merge remote-tracking branch 'origin/zksync-websockets' into zksync-w…
bgravenorst Jul 23, 2024
7c70d96
Update code sample
joaniefromtheblock Jul 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/whats-new.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ of the [MetaMask developer page](https://metamask.io/developer/).

## July 2024

- Documented [ZKsync Era WebSocket support](/services/reference/zksync). ([#1438](https://github.com/MetaMask/metamask-docs/pull/1438))
- Documented support for the [ZKsync Era network API service](/services/reference/zksync). ([#1372](https://github.com/MetaMask/metamask-docs/pull/1372))
- Added [Services](/services) and [Developer tools](/developer-tools) to MetaMask documentation. ([#1325](https://github.com/MetaMask/metamask-docs/pull/1325))

Expand Down
1 change: 1 addition & 0 deletions services/concepts/websockets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Infura support subscriptions over WebSockets for the following networks:
- [Linea](../reference/linea/index.md)
- [Optimism](../reference/optimism/index.md)
- [Polygon](../reference/polygon-pos/index.md)
- [ZKsync Era](../reference/zksync/index.md)

:::info

Expand Down
15 changes: 11 additions & 4 deletions services/get-started/endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,10 +146,17 @@ Sepolia instead.

## ZKsync Era

| Network | Description | URL |
| ----------------- | ------------------- | ----------------------------------------------- |
| Mainnet | JSON-RPC over HTTPS | `https://zksync-mainnet.infura.io/v3/<API-KEY>` |
| Testnet (Sepolia) | JSON-RPC over HTTPS | `https://zksync-sepolia.infura.io/v3/<API-KEY>` |
:::info

ZKsync Era WebSockets are supported on Mainnet only.

:::

| Network | Description | URL |
|-------------------|-------------------------|--------------------------------------------------|
| Mainnet | JSON-RPC over HTTPS | `https://zksync-mainnet.infura.io/v3/<API-KEY>` |
| Mainnet | JSON-RPC over WebSocket | `wss://zksync-mainnet.infura.io/ws/v3/<API-KEY>` |
| Testnet (Sepolia) | JSON-RPC over HTTPS | `https://zksync-sepolia.infura.io/v3/<API-KEY>` |

## Gas API

Expand Down
4 changes: 2 additions & 2 deletions services/reference/_partials/_eth_getblockreceipts-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs>
<TabItem value="cURL">
Expand Down
4 changes: 2 additions & 2 deletions services/reference/_partials/_eth_getblockreceipts-response.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs>
<TabItem value="JSON">
Expand Down
4 changes: 2 additions & 2 deletions services/reference/arbitrum/json-rpc-methods/_eth_getblockreceipts-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs>
<TabItem value="cURL">
Expand Down
4 changes: 2 additions & 2 deletions services/reference/arbitrum/json-rpc-methods/eth_getblockreceipts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: "eth_getBlockReceipts"
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

import Description from "/services/reference/_partials/_eth_getblockreceipts-description.mdx";

Expand Down
4 changes: 2 additions & 2 deletions .../reference/avalanche-c-chain/json-rpc-methods/_eth_getblockreceipts-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs>
<TabItem value="cURL">
Expand Down
4 changes: 2 additions & 2 deletions services/reference/avalanche-c-chain/json-rpc-methods/eth_getblockreceipts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: "eth_getBlockReceipts"
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

import Description from "/services/reference/_partials/_eth_getblockreceipts-description.mdx";

Expand Down
4 changes: 2 additions & 2 deletions services/reference/blast/json-rpc-methods/eth_getblockreceipts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: "eth_getBlockReceipts"
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

import Description from "/services/reference/_partials/_eth_getblockreceipts-description.mdx";

Expand Down
4 changes: 2 additions & 2 deletions services/reference/celo/json-rpc-methods/_eth_getblockreceipts-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs>
<TabItem value="cURL">
Expand Down
4 changes: 2 additions & 2 deletions services/reference/celo/json-rpc-methods/eth_getblockreceipts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: "eth_getBlockReceipts"
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

import Description from "/services/reference/_partials/_eth_getblockreceipts-description.mdx";

Expand Down
4 changes: 2 additions & 2 deletions services/reference/ethereum/json-rpc-methods/eth_getblockreceipts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: "eth_getBlockReceipts"
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

import Description from "/services/reference/_partials/_eth_getblockreceipts-description.mdx";

Expand Down
4 changes: 2 additions & 2 deletions services/reference/linea/json-rpc-methods/_eth_getblockreceipts-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs>
<TabItem value="cURL">
Expand Down
4 changes: 2 additions & 2 deletions services/reference/linea/json-rpc-methods/eth_getblockreceipts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: "eth_getBlockReceipts"
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

import Description from "/services/reference/_partials/_eth_getblockreceipts-description.mdx";

Expand Down
4 changes: 2 additions & 2 deletions services/reference/optimism/json-rpc-methods/_eth_getblockreceipts-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs>
<TabItem value="cURL">
Expand Down
4 changes: 2 additions & 2 deletions services/reference/optimism/json-rpc-methods/eth_getblockreceipts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: "eth_getBlockReceipts"
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

import Description from "/services/reference/_partials/_eth_getblockreceipts-description.mdx";

Expand Down
4 changes: 2 additions & 2 deletions services/reference/polygon-pos/json-rpc-methods/_eth_getblockreceipts-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs>
<TabItem value="cURL">
Expand Down
4 changes: 2 additions & 2 deletions services/reference/polygon-pos/json-rpc-methods/eth_getblockreceipts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: "eth_getBlockReceipts"
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

import Description from "/services/reference/_partials/_eth_getblockreceipts-description.mdx";

Expand Down
12 changes: 10 additions & 2 deletions services/reference/zksync/json-rpc-methods/_eth_accounts-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from "@theme/Tabs"
import TabItem from "@theme/TabItem"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs>
<TabItem value="cURL">
Expand All @@ -11,5 +11,13 @@ curl https://zksync-mainnet.infura.io/v3/YOUR-API-KEY \
-d '{"jsonrpc": "2.0", "method": "eth_accounts", "params": [], "id": 1}'
```

</TabItem>
<TabItem value="WSS">

```bash
wscat -c wss://zksync-mainnet.infura.io/ws/v3/YOUR-API-KEY -x '{"jsonrpc": "2.0", "method": "eth_accounts", "params": [], "id": 1}'
```

</TabItem>
</Tabs>

12 changes: 10 additions & 2 deletions services/reference/zksync/json-rpc-methods/_eth_blocknumber-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from "@theme/Tabs"
import TabItem from "@theme/TabItem"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs>
<TabItem value="cURL">
Expand All @@ -11,5 +11,13 @@ curl https://zksync-mainnet.infura.io/v3/YOUR-API-KEY \
-d '{"jsonrpc": "2.0", "method": "eth_blockNumber", "params": [], "id": 1}'
```

</TabItem>
<TabItem value="WSS">

```bash
wscat -c wss://zksync-mainnet.infura.io/ws/v3/YOUR-API-KEY -x '{"jsonrpc": "2.0", "method": "eth_blockNumber", "params": [], "id": 1}'
```

</TabItem>
</Tabs>

20 changes: 14 additions & 6 deletions services/reference/zksync/json-rpc-methods/_eth_call-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
import Tabs from "@theme/Tabs"
import TabItem from "@theme/TabItem"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs>
<TabItem value="cURL">

```bash
curl https://zksync-mainnet.infura.io/v3/YOUR-API-KEY \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc": "2.0", "method": "eth_call", "params": [{"from": "0xb60e8dd61c5d32be8058bb8eb970870f07233155", "to": "0xd46e8dd67c5d32be8058bb8eb970870f07244567", "gas": "0x76c0", "gasPrice": "0x9184e72a000", "value": "0x9184e72a", "data": "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675"}, "latest"], "id": 1}'
```

</TabItem>
<TabItem value="WSS">

```bash
curl https://zksync-mainnet.infura.io/v3/YOUR-API-KEY \
-X POST \
-H "Content-Type: application/json" \
-d '{"jsonrpc": "2.0", "method": "eth_call", "params": [{"from": "0xb60e8dd61c5d32be8058bb8eb970870f07233155", "to": "0xd46e8dd67c5d32be8058bb8eb970870f07244567", "gas": "0x76c0", "gasPrice": "0x9184e72a000", "value": "0x9184e72a", "data": "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675"}, "latest"], "id": 1}'
wscat -c wss://zksync-mainnet.infura.io/ws/v3/YOUR-API-KEY -x '{"jsonrpc": "2.0", "method": "eth_call", "params": [{"from": "0xb60e8dd61c5d32be8058bb8eb970870f07233155", "to": "0xd46e8dd67c5d32be8058bb8eb970870f07244567", "gas": "0x76c0", "gasPrice": "0x9184e72a000", "value": "0x9184e72a", "data": "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675"}, "latest"], "id": 1}'
```

</TabItem>
</Tabs>

12 changes: 10 additions & 2 deletions services/reference/zksync/json-rpc-methods/_eth_chainid-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from "@theme/Tabs"
import TabItem from "@theme/TabItem"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs>
<TabItem value="cURL">
Expand All @@ -11,5 +11,13 @@ curl https://zksync-mainnet.infura.io/v3/YOUR-API-KEY \
-d '{"jsonrpc": "2.0", "method": "eth_chainId", "params": [], "id": 1}'
```

</TabItem>
<TabItem value="WSS">

```bash
wscat -c wss://zksync-mainnet.infura.io/ws/v3/YOUR-API-KEY -x '{"jsonrpc": "2.0", "method": "eth_chainId", "params": [], "id": 1}'
```

</TabItem>
</Tabs>

12 changes: 10 additions & 2 deletions services/reference/zksync/json-rpc-methods/_eth_estimategas-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from "@theme/Tabs"
import TabItem from "@theme/TabItem"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs>
<TabItem value="cURL">
Expand All @@ -11,5 +11,13 @@ curl https://zksync-mainnet.infura.io/v3/YOUR-API-KEY \
-d '{"jsonrpc": "2.0", "method": "eth_estimateGas", "params": [{"from": "0x9cE564c7d09f88E7d8233Cdd3A4d7AC42aBFf3aC", "to": "0xd46e8dd67c5d32be8058bb8eb970870f07244567", "value": "0x9184e72a"}], "id": 1}'
```

</TabItem>
<TabItem value="WSS">

```bash
wscat -c wss://zksync-mainnet.infura.io/ws/v3/YOUR-API-KEY -x '{"jsonrpc": "2.0", "method": "eth_estimateGas", "params": [{"from": "0x9cE564c7d09f88E7d8233Cdd3A4d7AC42aBFf3aC", "to": "0xd46e8dd67c5d32be8058bb8eb970870f07244567", "value": "0x9184e72a"}], "id": 1}'
```

</TabItem>
</Tabs>

14 changes: 11 additions & 3 deletions services/reference/zksync/json-rpc-methods/_eth_feehistory-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from "@theme/Tabs"
import TabItem from "@theme/TabItem"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs>
<TabItem value="cURL">
Expand All @@ -8,8 +8,16 @@ import TabItem from "@theme/TabItem"
curl https://zksync-mainnet.infura.io/v3/YOUR-API-KEY \
-X POST \
-H "Content-Type: application/json" \
-d '{"id": 1, "jsonrpc": "2.0", "method": "eth_feeHistory", "params": ["0x5", "latest", [20,30]] }'
-d '{"id": 1, "jsonrpc": "2.0", "method": "eth_feeHistory", "params": ["0x5", "latest", [20,30]]}'
```

</TabItem>
<TabItem value="WSS">

```bash
wscat -c wss://zksync-mainnet.infura.io/ws/v3/YOUR-API-KEY -x '{"id": 1, "jsonrpc": "2.0", "method": "eth_feeHistory", "params": ["0x5", "latest", [20,30]]}'
```

</TabItem>
</Tabs>

12 changes: 10 additions & 2 deletions services/reference/zksync/json-rpc-methods/_eth_gasprice-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from "@theme/Tabs"
import TabItem from "@theme/TabItem"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs>
<TabItem value="cURL">
Expand All @@ -11,5 +11,13 @@ curl https://zksync-mainnet.infura.io/v3/YOUR-API-KEY \
-d '{"jsonrpc": "2.0", "method": "eth_gasPrice", "params": [], "id": 1}'
```

</TabItem>
<TabItem value="WSS">

```bash
wscat -c wss://zksync-mainnet.infura.io/ws/v3/YOUR-API-KEY -x '{"jsonrpc": "2.0", "method": "eth_gasPrice", "params": [], "id": 1}'
```

</TabItem>
</Tabs>

12 changes: 10 additions & 2 deletions services/reference/zksync/json-rpc-methods/_eth_getbalance-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from "@theme/Tabs"
import TabItem from "@theme/TabItem"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs>
<TabItem value="cURL">
Expand All @@ -11,5 +11,13 @@ curl https://zksync-mainnet.infura.io/v3/YOUR-API-KEY \
-d '{"jsonrpc": "2.0", "method": "eth_getBalance", "params": ["0xc94770007dda54cF92009BFF0dE90c06F603a09f", "latest"], "id": 1}'
```

</TabItem>
<TabItem value="WSS">

```bash
wscat -c wss://zksync-mainnet.infura.io/ws/v3/YOUR-API-KEY -x '{"jsonrpc": "2.0", "method": "eth_getBalance", "params": ["0xc94770007dda54cF92009BFF0dE90c06F603a09f", "latest"], "id": 1}'
```

</TabItem>
</Tabs>

12 changes: 10 additions & 2 deletions services/reference/zksync/json-rpc-methods/_eth_getblockbyhash-request.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from "@theme/Tabs"
import TabItem from "@theme/TabItem"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

<Tabs>
<TabItem value="cURL">
Expand All @@ -11,5 +11,13 @@ curl https://zksync-mainnet.infura.io/v3/YOUR-API-KEY \
-d '{"jsonrpc": "2.0", "method": "eth_getBlockByHash", "params": ["0xb3b20624f8f0f86eb50dd04688409e5cea4bd02d700bf6e79e9384d47d6a5a35", false], "id": 1}'
```

</TabItem>
<TabItem value="WSS">

```bash
wscat -c wss://zksync-mainnet.infura.io/ws/v3/YOUR-API-KEY -x '{"jsonrpc": "2.0", "method": "eth_getBlockByHash", "params": ["0xb3b20624f8f0f86eb50dd04688409e5cea4bd02d700bf6e79e9384d47d6a5a35", false], "id": 1}'
```

</TabItem>
</Tabs>

Loading
Loading