Skip to content

Commit 4a99db1

Browse files
committed
Merge branch 'main' into ACT-1464-reference-page-object-type
2 parents 073501e + 2548bde commit 4a99db1

File tree

175 files changed

+5299
-598
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

175 files changed

+5299
-598
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
> :warning: **Temporary pause on contributions to the MetaMask docs repository**
2+
>
3+
> Starting August 3, 2024, contributions to this repository will be temporarily paused.
4+
> Pull requests submitted during this period will not be reviewed or merged until after the pause.
5+
> Thank you for your understanding.
6+
17
# MetaMask developer documentation
28

39
This is the MetaMask developer documentation repository.

docs/whats-new.md

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

1212
## July 2024
1313

14-
- Documented [Celo WebSocket support](/services/reference/celo/). ([#1446](https://github.com/MetaMask/metamask-docs/pull/1446))
15-
- Documented [ZKsync Era WebSocket support](/services/reference/zksync). ([#1438](https://github.com/MetaMask/metamask-docs/pull/1438))
14+
- Documented [Binance Smart Chain](/services/reference/bnb-smart-chain/) support. ([#1458](https://github.com/MetaMask/metamask-docs/pull/1458))
15+
- Documented [Celo WebSocket](/services/reference/celo/) support. ([#1446](https://github.com/MetaMask/metamask-docs/pull/1446))
16+
- Documented [ZKsync Era WebSocket](/services/reference/zksync) support. ([#1438](https://github.com/MetaMask/metamask-docs/pull/1438))
1617
- Documented support for the [ZKsync Era network API service](/services/reference/zksync). ([#1372](https://github.com/MetaMask/metamask-docs/pull/1372))
1718
- Added [Services](/services) and [Developer tools](/developer-tools) to MetaMask documentation. ([#1325](https://github.com/MetaMask/metamask-docs/pull/1325))
1819

1920
## June 2024
2021

22+
- Documented [Snaps custom UI with JSX](/snaps/features/custom-ui/with-jsx).
23+
([#1348](https://github.com/MetaMask/metamask-docs/pull/1348))
2124
- Updated [React dapp with global state tutorial](/wallet/tutorials/react-dapp-global-state) with
2225
instructions for EIP-6963.
2326
([#1330](https://github.com/MetaMask/metamask-docs/pull/1330))

services/concepts/archive-data.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,25 +56,21 @@ Infura applies [rate limits](../how-to/avoid-rate-limiting.md) to ensure network
5656

5757
Requests for Ethereum archive data are more expensive and are therefore subject to different rate limits.
5858

59-
**Free plan**
59+
### Free plan
6060

61-
- 25,000 archive requests per day.
62-
- 100,000 total requests per day.
63-
64-
Rate limits kick in on archive requests after 25,000 per day. 75,000 standard requests are still available after this point.
61+
You can make up to 25,000 archive requests and 100,000 total requests per day.
62+
After reaching 25,000 archive requests, you can still make 75,000 additional standard requests.
6563

6664
:::info
6765

6866
If you need more archive requests, upgrade to the Developer plan.
6967

7068
:::
7169

72-
**Developer plan**
73-
74-
- 100,000 archive requests per day.
75-
- 200,000 total requests per day.
70+
### Developer plan
7671

77-
Rate limits kick in on archive requests after 100,000 per day. 100,000 standard requests are still available after this point.
72+
You can make up to 100,000 archive requests and 200,000 total requests per day.
73+
After reaching 100,000 archive requests, you can still make 100,000 additional standard requests.
7874

7975
:::info
8076

services/get-started/endpoints.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,14 @@ request to `support@infura.io` and we will assess if your request can be accommo
4747
| Mainnet | JSON-RPC over HTTPS | `https://blast-mainnet.infura.io/v3/<API-KEY>` |
4848
| Testnet (Sepolia) | JSON-RPC over HTTPS | `https://blast-sepolia.infura.io/v3/<API-KEY>` |
4949

50+
## Binance Smart Chain
51+
52+
| Network | Transport type | URL |
53+
|-------------------|-------------------------|-----------------------------------------------|
54+
| Mainnet | JSON-RPC over HTTPS | `https://bsc-mainnet.infura.io/v3/<API-KEY>` |
55+
| Mainnet | JSON-RPC over WebSocket | `wss://bsc-mainnet.infura.io/ws/v3/<API-KEY>` |
56+
| Testnet (Sepolia) | JSON-RPC over HTTPS | `https://bsc-testnet.infura.io/v3/<API-KEY>` |
57+
5058
## Celo
5159

5260
| Network | Description | URL |
@@ -139,7 +147,7 @@ Sepolia instead.
139147
| Testnet (Amoy) | JSON-RPC over HTTPS | `https://polygon-amoy.infura.io/v3/<API-KEY>` |
140148
| Testnet (Amoy) | JSON-RPC over WebSocket | `wss://polygon-amoy.infura.io/ws/v3/<API-KEY>` |
141149

142-
## StarkNet
150+
## Starknet
143151

144152
| Network | Description | URL |
145153
| ----------------- | ------------------- | ------------------------------------------------- |

services/get-started/infura.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,11 @@ For more information refer to the [Infura pricing information](https://www.infur
2929

3030
## 2. Configure your API key
3131

32-
Once verified, youll be taken to the [Infura dashboard](../../../developer-tools/dashboard) where you can configure your
32+
After verification, you'll be directed to the [Infura dashboard](../../../developer-tools/dashboard) to configure your
3333
auto-generated API key.
3434

35-
:::info
36-
37-
Infura will automatically generate the **My First Key** API key for you.
35+
Infura will automatically generate the **My First Key** API key.
3836

39-
:::
4037

4138
<div class="left-align-container">
4239
<div class="img-large">
@@ -46,10 +43,10 @@ Infura will automatically generate the **My First Key** API key for you.
4643
</div>
4744
</div>
4845

49-
In the API key page that appears, select **My First Key** to access your API key settings. In the **All Endpoints** tab, select
50-
the networks that you wish to connect to, and select **Save Changes**.
46+
In the API key page that displays, select **My First Key** to access your API key settings. In the **All Endpoints** tab, select
47+
the networks that you want to connect to, and select **Save Changes**.
5148

52-
In this example, we've selected the Ethereum mainnet and Linea mainnet networks.
49+
In the following example, Ethereum mainnet and Linea mainnet networks are selected.
5350

5451
<div class="left-align-container">
5552
<div class="img-large">
@@ -61,7 +58,7 @@ In this example, we've selected the Ethereum mainnet and Linea mainnet networks.
6158

6259
## 3. Send requests
6360

64-
Use the API key when sending requests. The following examples interact with the Ethereum network by sending requests using HTTP.
61+
Use the API key when sending requests. The following examples interact with the Ethereum network by sending requests using HTTP:
6562

6663
:::info
6764

@@ -70,7 +67,13 @@ Use the API key when sending requests. The following examples interact with the
7067

7168
:::
7269

73-
Use a tool such as the [Client Uniform Resource Locator (curl)](../concepts/curl.md) or [Postman](https://www.postman.com/downloads/) to make requests. We recommend using Postman if you're a Windows user.
70+
Use a tool such as the [Client Uniform Resource Locator (curl)](../concepts/curl.md) or [Postman](https://www.postman.com/downloads/) to make requests.
71+
72+
:::info
73+
74+
We recommend using Postman if you're a Windows user.
75+
76+
:::
7477

7578
### 3.1 Get the current block number
7679

services/how-to/enable-api-forwarding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Enable API forwarding
3-
sidebar_position: 6
3+
sidebar_position: 7
44
---
55

66
import Tabs from "@theme/Tabs";

services/how-to/interact-with-erc-20-tokens.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Interact with ERC 20 tokens
3-
sidebar_position: 2
3+
sidebar_position: 3
44
---
55

66
import Tabs from "@theme/Tabs";

services/how-to/javascript-dotenv.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Use dotenv to load environment variables from a file.
3-
sidebar_position: 7
3+
sidebar_position: 8
44
---
55

66
# Use JavaScript dotenv

services/how-to/json-web-token-jwt.md

Lines changed: 26 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Use JSON Web Tokens to secure data exchange.
3-
sidebar_position: 8
3+
sidebar_position: 9
44
---
55

66
import Tabs from "@theme/Tabs";
@@ -74,51 +74,49 @@ Upload the contents of the public key file that you [generated earlier](json-web
7474

7575
1. Go to the **SECURITY** section in your project settings.
7676

77-
![Security settings](../images/security-page.png)
77+
![Security settings](../images/security-page.png)
7878

79-
:::info
79+
:::info
8080

81-
You must implement separate security settings for each project.
81+
You must implement separate security settings for each project.
8282

83-
:::
83+
:::
8484

85-
2. Check the **Require JWT for all requests** box to enforce JWT on all requests. This is optional.
85+
2. (Optional) Check the **Require JWT for all requests** box to enforce JWT on all requests.
8686

87-
:::info
87+
:::info
8888

89-
Use allowlists to specify a subset of requests that must use JWTs.
89+
Use allowlists to specify a subset of requests that must use JWTs.
9090

91-
:::
91+
:::
9292

9393
3. Give the public key a name.
9494

9595
4. Paste the public key into the **JWT PUBLIC KEY** input box. It looks something like this:
9696

97-
```
98-
-----BEGIN PUBLIC KEY-----
99-
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAr7VlNytvNFt9wVkjJ8vG
100-
L4F0+id4kS1CpG7UMh1kghrLg9KMb8gauy7Bxk6PRz5Ckv1FnG4FL+Z3Cdzwd6c8
101-
jJlzJxbRTYvNi3elqAyItE3tRl6CatRur49t9nGepgFOrwmPP5We52G5O0BsW6Mx
102-
w/neqQH+Y/bXqs0PG/0ZbpTyr044Lh+p9grSuPIogIGIY5JM4AI+fpdH6hVnA7od
103-
PkinkWhQqAW+F8jngwZK+JCFS1GAeobTZVbvsiHZQGuP/T7hqE8z5Q8HYO4ymnkI
104-
MPH6zSKhSxsQRs/kWU5lXqY67ORC3DIMA+I/AJujLuoqC+YaMP0fO81XjrwXPf2j
105-
4wIDAQAB
106-
-----END PUBLIC KEY-----
107-
```
108-
109-
5. Click **ADD** to add the key to the settings.
97+
```
98+
-----BEGIN PUBLIC KEY-----
99+
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAr7VlNytvNFt9wVkjJ8vG
100+
L4F0+id4kS1CpG7UMh1kghrLg9KMb8gauy7Bxk6PRz5Ckv1FnG4FL+Z3Cdzwd6c8
101+
jJlzJxbRTYvNi3elqAyItE3tRl6CatRur49t9nGepgFOrwmPP5We52G5O0BsW6Mx
102+
w/neqQH+Y/bXqs0PG/0ZbpTyr044Lh+p9grSuPIogIGIY5JM4AI+fpdH6hVnA7od
103+
PkinkWhQqAW+F8jngwZK+JCFS1GAeobTZVbvsiHZQGuP/T7hqE8z5Q8HYO4ymnkI
104+
MPH6zSKhSxsQRs/kWU5lXqY67ORC3DIMA+I/AJujLuoqC+YaMP0fO81XjrwXPf2j
105+
4wIDAQAB
106+
-----END PUBLIC KEY-----
107+
```
110108

111-
6. The key is added to security settings.
109+
5. Click **ADD** to add the key to the settings. After the key is added, the security settings look like the following:
112110

113-
![JWT set up](../images/jwt-set-up.png)
111+
![JWT set up](../images/jwt-set-up.png)
114112

115-
7. The key has a **NAME**, **ID**, **FINGERPRINT**. These are used for creating and verifying JWTs. You'll need the **ID** to [generate the JWT](json-web-token-jwt.md#generate-a-jwt).
113+
6. The key has a **NAME**, **ID**, **FINGERPRINT**. These are used for creating and verifying JWTs. You'll need the **ID** to [generate the JWT](json-web-token-jwt.md#generate-a-jwt).
116114

117-
:::info
115+
:::info
118116

119-
For key rotation, upload up to three keys for each project.
117+
For key rotation, upload up to three keys for each project.
120118

121-
:::
119+
:::
122120

123121
## Send requests with JWTs
124122

services/how-to/make-batch-requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Make batch requests
3-
sidebar_position: 3
3+
sidebar_position: 4
44
---
55

66
# Make batch requests

0 commit comments

Comments
 (0)