Skip to content

Commit a727082

Browse files
committed
Merge branch 'main' into restructure-how-to
# Conflicts: # docs/whats-new.md # wallet-sidebar.js # wallet/connect/3rd-party-libraries/wagmi.md # wallet/connect/metamask-sdk/javascript/index.md # wallet/connect/metamask-sdk/javascript/nodejs.md # wallet/connect/metamask-sdk/javascript/other-web-frameworks.md # wallet/connect/metamask-sdk/javascript/pure-js.md # wallet/connect/metamask-sdk/javascript/react/index.md # wallet/connect/metamask-sdk/javascript/react/react-ui.md # wallet/how-to/javascript/display/custom-modals.md # wallet/how-to/javascript/sign-data/index.md # wallet/how-to/javascript/use-non-evm-networks/starknet/.create-a-simple-starknet-dapp.md # wallet/how-to/javascript/use-non-evm-networks/starknet/create-a-simple-starknet-dapp.md # wallet/how-to/use-non-evm-networks/starknet/.create-a-simple-starknet-dapp.md # wallet/index.md # wallet/reference/sdk-js-options.md
2 parents 2eea728 + cf68789 commit a727082

File tree

933 files changed

+3456
-2967
lines changed

Some content is hidden

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

933 files changed

+3456
-2967
lines changed

.github/CODEOWNERS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ docusaurus.config.js @MetaMask/activation @MetaMask/tech-writers
1010
# GitHub workflows and templates
1111
/.github/ @MetaMask/activation @MetaMask/tech-writers
1212

13+
# Static image and video files
14+
/static/ @MetaMask/activation @MetaMask/tech-writers
15+
1316
# Vercel configuration
1417
vercel.json @MetaMask/activation @MetaMask/tech-writers
1518

.github/workflows/lint.yml

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ env:
2121

2222
jobs:
2323
lint:
24-
name: Lint Code Base, Spelling, Link Check
24+
name: Lint Code Base
2525
runs-on: ubuntu-latest
2626
permissions:
2727
contents: read
@@ -30,8 +30,19 @@ jobs:
3030

3131
- name: Lint
3232
uses: ConsenSys/docs-gha/lint@cc8b9d9065f5f20b105954f8e806f55c1e235ecd
33+
34+
spelling:
35+
name: Spelling
36+
runs-on: ubuntu-latest
37+
strategy:
38+
matrix:
39+
file-extensions: [".md", ".mdx"]
40+
steps:
41+
- uses: actions/checkout@v4
42+
- name: Vale
43+
uses: Consensys/docs-gha/spelling@main
3344
with:
34-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
45+
FILEPATHS: "snaps,services,wallet,developer-tools,docs"
3546

3647
linkCheck:
3748
name: Link Checking

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
.docusaurus
99
.cache-loader
1010
.idea
11+
.yarn
1112

1213
# Misc
1314
.DS_Store

developer-tools/dashboard/get-started/create-api.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -20,27 +20,18 @@ For more information, see to the [Infura pricing page](https://www.infura.io/pri
2020
Infura allows you to enable multiple network endpoints and expansion APIs for your API key. If calls are
2121
made to a disabled network or service, then all requests to that network or service will fail.
2222

23-
To keep your account secure and cost effective, add only the necessary endpoints, as some have usage limits or charges based
24-
on request volume.
23+
To keep your account secure and cost effective, add only the necessary endpoints, as some have usage
24+
limits or charges based on request volume.
2525

2626
To create an API key:
2727

28-
1. Open the [Infura dashboard](https://infura.io/dashboard). Enter your login details, if required.
29-
1. Select **CREATE NEW API KEY**.
30-
31-
<div class="left-align-container">
32-
<div class="img-large">
33-
<img
34-
src={require("../../images/create_key.png").default}
35-
/>
36-
</div>
37-
</div>
38-
39-
1. From the pop-up window, provide a name, then click **CREATE**.
28+
1. Open the [MetaMask Developer dashboard](https://infura.io/dashboard). Enter your login details, if required.
29+
1. In the top right corner, select **Create new API key**.
30+
1. From the pop-up window, provide a name, then click **Create**.
4031
1. Select the networks that you want your API key to access, and select **Save Changes**.
4132

42-
You can [configure additional security](../how-to/secure-an-api/api-key-secret.md) for your API key by requiring an API key secret or JWTs with
43-
each API request.
33+
You can [configure additional security](../how-to/secure-an-api/api-key-secret.md) for your API key by
34+
requiring an API key secret or JWTs with each API request.
4435

4536
## Best practices for configuring API key endpoints
4637

developer-tools/dashboard/how-to/credit-usage.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,10 @@ description: View your Infura credit usage stats.
44

55
# View credit usage
66

7-
:::info
8-
9-
The [credit pricing model](/services/get-started/pricing) replaces request-based billing for free-tier (Core)
10-
customers. Customers on Developer and Team plans will be transitioned to the credit model on
11-
September 30, 2024.
12-
13-
**Existing customers on Growth and Custom plans will remain on request-based billing**.
14-
:::
15-
167
You can view your daily credit usage in relation to your daily credit quota limit. Daily credit usage
178
counts are reset everyday at 00:00 UTC for all customers.
189

19-
Select **View Usage** from the **Daily Credit Usage** section on the Infura dashboard, or select
10+
Select **View Usage** from the **Daily Credit Usage** section on the dashboard, or select
2011
the **Usage** tab from the **Settings** > **Billing** dropdown.
2112

2213
View your usage for the previous 24 hours, 7 days, or 30 days by methods used, networks, or API key.

developer-tools/dashboard/how-to/dashboard-stats.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This data is crucial for optimizing your applications and ensuring they run smoo
1111

1212
## Specify stats to view
1313

14-
1. In the top menu of the [Infura dashboard](https://app.infura.io/), select **Stats**.
14+
1. In the left menu of the [MetaMask Developer dashboard](https://developer.metamask.io/), select **Stats**.
1515
The stats page displays the total volume of requests sent to Infura over the specified time period.
1616
By default, data is shown from the last 24 hours from all Web3 API keys.
1717

@@ -40,13 +40,13 @@ You can view your Web3 API usage stats in the following charts and tables.
4040

4141
### Requests Volume chart
4242

43-
This chart displays the total volume of requests sent to Infura using the selected API key(s) over
43+
This chart displays the total volume of requests sent to Infura using the selected API keys over
4444
the selected time period.
4545

4646
### Product Request Volumes
4747

4848
This chart displays the aggregate request volumes for the top five API methods called using the
49-
selected API key(s) over the selected time period.
49+
selected API keys over the selected time period.
5050
To view stats for a particular product (network) instead of the default of all products, make a
5151
selection from the products dropdown.
5252
This change will impact what API methods are displayed in the
@@ -55,14 +55,14 @@ This change will impact what API methods are displayed in the
5555
### Method Request Volumes
5656

5757
This chart displays the aggregate request volumes for requests made on the top five networks using
58-
the selected API key(s) over the selected time period.
58+
the selected API keys over the selected time period.
5959
To view stats for a particular method instead of the default of all methods, make a selection from
6060
the methods dropdown.
6161

6262
### Requests Activity
6363

6464
This table displays the total request volumes and successful and failed requests, based on each
65-
product (network) and method called using the selected API key(s) over the selected time period.
65+
product (network) and method called using the selected API keys over the selected time period.
6666

6767
For more details about the failure status codes, select the two diagonal arrows to the right of the
6868
**FAILED REQUESTS (%)** values.
@@ -72,7 +72,7 @@ requests, grouped by the returned status codes.
7272
### Eth_call activity
7373

7474
This table displays the activities made on the `eth_call` method, including contract addresses that
75-
interacted with the selected API key(s).
75+
interacted with the selected API keys.
7676
This table only shows the `eth_call` activity for the last 30 minutes, and is not impacted by any
7777
time period selection.
7878

@@ -85,15 +85,15 @@ You can view your IPFS usage stats in the following charts.
8585

8686
### Data Transfer Up
8787

88-
This chart displays the amount of data sent to the IPFS service using the selected API key(s) over
88+
This chart displays the amount of data sent to the IPFS service using the selected API keys over
8989
the selected time period.
9090

9191
### Data Transfer Down
9292

93-
This chart displays the amount of data retrieved from the IPFS service using the selected API key(s)
93+
This chart displays the amount of data retrieved from the IPFS service using the selected API keys
9494
over the selected time period.
9595

9696
### Total Storage
9797

98-
This chart displays the total amount of data stored by the selected API key(s) over the selected
98+
This chart displays the total amount of data stored by the selected API keys over the selected
9999
time period.

developer-tools/dashboard/how-to/network-status.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ sidebar_position: 8
55

66
# View the network status
77

8-
View the [Infura status page](https://status.infura.io/) to check for service outages and other incidents, as well as
8+
View the [Infura status page](https://status.infura.io/) to check for service outages, incidents, and
99
scheduled maintenance notices. You can also subscribe to status updates via email, SMS, webhook, Slack, and Atom/RSS.
1010

11-
You can also select the **Status** link at the top of the Infura dashboard to view the status page.
11+
You can also select the **Status** link on the left of the MetaMask Developer dashboard to view the status page.
1212

1313
<div class="left-align-container">
1414
<div class="img-medium">

developer-tools/dashboard/how-to/project-sharing.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ You can share access to your Infura API keys by inviting existing Infura account
1111

1212
To share an API key:
1313

14-
1. In the Infura dashboard, select the API that you want to share.
14+
1. In the dashboard, select the API that you want to share.
1515
1. Select the **API Key Sharing** tab.
16-
1. Select **INVITE MEMBERS** in the top right.
16+
1. Select **Invite Members** in the top right.
1717

1818
<div class="left-align-container">
1919
<div class="img-large">
@@ -23,8 +23,8 @@ To share an API key:
2323
</div>
2424
</div>
2525

26-
1. Input one or more user emails, select the [user role](#user-roles), and select **SUBMIT**.
27-
1. Confirm your email address and select **CONFIRM**.
26+
1. Input one or more user emails, select the [user role](#user-roles), and select **Submit**.
27+
1. Confirm your email address and select **Confirm**.
2828

2929
:::note
3030

@@ -72,28 +72,20 @@ You can view all keys that you own, and all keys shared with you, by selecting *
7272

7373
## Update user role or remove user
7474

75-
1. In the Infura dashboard, select the API key that the user is assigned to.
75+
1. In the dashboard, select the API key that the user is assigned to.
7676
1. Select the **API Key Sharing** tab.
7777
1. Select the vertical ellipsis icon next to the relevant user.
7878

7979
- To remove a user, select **Remove Member**. They are removed immediately.
8080
- To update a user's role, select **Update Role**.
8181

82-
<div class="left-align-container">
83-
<div class="img-large">
84-
<img
85-
src={require("../../images/update-role.png").default}
86-
/>
87-
</div>
88-
</div>
89-
90-
1. Upgrade or downgrade accordingly and select **UPDATE ROLE**.
82+
1. Upgrade or downgrade accordingly and select **Update Role**.
9183

9284
## Revoke or resend an invite
9385

9486
While invitations remain in a pending state, they can be revoked or sent again.
9587

96-
1. In the Infura dashboard, select the API key for the user.
88+
1. In the dashboard, select the API key for the user.
9789

9890
1. Select the **API Key Sharing** tab.
9991

developer-tools/dashboard/how-to/secure-an-api/api-key-secret.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ If your dapp operates solely on the client side without a server, use only the A
2222
The API key is exposed in client-side code, so you should secure it using [allowlists](use-an-allowlist.md).
2323

2424
:::tip
25-
For customers on the Developer tier or higher, Infura supports [overriding your allowlist](use-an-allowlist.md#overide-your-allowlist-settings)
25+
For customers on the Developer tier or higher, Infura supports [overriding your allowlist](use-an-allowlist.md#override-your-allowlist-settings)
2626
when you specify an API key secret. This allows you to apply the principle of least privilege on the
2727
client side while allowing unrestricted access on the server side.
2828
:::
@@ -34,7 +34,7 @@ In the API key's **Settings** tab, select **Require API Key secret for all reque
3434
<div class="left-align-container">
3535
<div class="img-large">
3636
<img
37-
src={require("../../../images/security-page.png").default}
37+
src={require("../../../images/settings-tab.png").default}
3838
/>
3939
</div>
4040
</div>

developer-tools/dashboard/how-to/secure-an-api/api-key.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ A request will fail if it does not have a valid API key appended to the request
1313

1414
:::
1515

16-
Select the API key in the Infura dashboard to view the key's details. The API key to include in your requests can be
16+
Select the API key in the dashboard to view the key's details. The API key to include in your requests can be
1717
copied at the top of the page.
1818

1919
Apply the principle of least privilege. Add only the endpoints that you plan to use, and then use the other

0 commit comments

Comments
 (0)