Skip to content

Commit 4b0bac9

Browse files
Merge branch 'main' into trivy-cache-workflow
2 parents f575c56 + 715480a commit 4b0bac9

File tree

924 files changed

+2428
-2843
lines changed

Some content is hidden

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

924 files changed

+2428
-2843
lines changed

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

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,33 +20,24 @@ 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

4738
We recommend the following best practices when creating your API keys:
4839

49-
- Group API key endpoints by environment. For example, create seperate API keys for production or development environments.
40+
- Group API key endpoints by environment. For example, create separate API keys for production or development environments.
5041
- Group API key endpoints by groups or individuals [sharing the API key](../how-to/project-sharing.md).
5142
- Limit the number of networks or services per API key only to the necessary endpoints.
5243
- Group the API key endpoints based on shared security considerations such as

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: View your Infura credit usage stats.
77
You can view your daily credit usage in relation to your daily credit quota limit. Daily credit usage
88
counts are reset everyday at 00:00 UTC for all customers.
99

10-
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
1111
the **Usage** tab from the **Settings** > **Billing** dropdown.
1212

1313
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

developer-tools/dashboard/how-to/secure-an-api/set-rate-limits.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ Set rate limiting in the API key's **Settings** tab **Key Credit Limits** sectio
1515
</div>
1616
</div>
1717

18-
- **PER SECOND CREDIT RATE-LIMITING** restricts credits per second (throughput) for the API key. Set
18+
- **Per second credit rate-limiting** restricts credits per second (throughput) for the API key. Set
1919
the maximum number of credits per second in whole numbers. When credits per second rate exceeds
2020
this value, requests are rejected. When the credit rate drops below the limit, requests
2121
are accepted again.
2222

2323
The value `0` means default limits are applied.
2424

25-
- **PER DAY TOTAL CREDITS** restricts total daily credit usage for the API key. Set a limit on number of
26-
credits per day in integers, e.g. 20000. The value `0` means default limits are applied.
25+
- **Per day total credits** restricts total daily credit usage for the API key. Set a limit on number of
26+
credits per day in integers, for example, 20000. The value `0` means default limits are applied.
2727

2828
When the number of used credits reach this limit, all requests will be rejected until the next day (00:00 UTC).

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

Lines changed: 20 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,17 @@ Add the restriction details in the **ALLOWLISTS** section of your API key's **Se
2929
#### Allowlist behavior
3030

3131
- If an API key has no allowlists, all requests are accepted.
32-
- As soon as an API key has an allowlist definition, all requests must pass it.
32+
- When an API key has an allowlist definition, all requests must pass the definition.
3333
- Each API key has a maximum of 30 allowlist entries per type.
3434
- Each allowlist type is "AND"ed together.
3535
- Multiple entries of the same type are "OR"ed.
3636

3737
## Contract addresses
3838

39-
If your application only queries data from specific Ethereum smart contracts or addresses, add those addresses to the **CONTRACT ADDRESSES** allowlist.
39+
If your application only queries data from specific Ethereum smart contracts or addresses, add those
40+
addresses to the **Contract Addresses** allowlist.
4041

41-
Any requests which query addresses that are not in the allowlist are rejected.
42+
Any requests which query addresses that aren't in the allowlist are rejected.
4243

4344
The following RPC methods take an Ethereum address parameter and are compatible with this type of allowlisting.
4445

@@ -52,7 +53,8 @@ The following RPC methods take an Ethereum address parameter and are compatible
5253

5354
#### Example request
5455

55-
To allow a specific Ethereum address, click **ADD** and input it into the **CONTRACT ADDRESSES** allowlist.
56+
To allow a specific Ethereum address, input it into the **Contract Addresses** field and select **Add**.
57+
In the following example we'll use `0xfe05a3e72235c9f92fd9f2282f41a8154`.
5658

5759
<div class="left-align-container">
5860
<div class="img-medium">
@@ -62,7 +64,7 @@ To allow a specific Ethereum address, click **ADD** and input it into the **CONT
6264
</div>
6365
</div>
6466

65-
Test with a method from the list.
67+
You can test using a method that supports this type of allowlisting.
6668

6769
```bash
6870
curl https://mainnet.infura.io/v3/<YOUR-API-KEY> \
@@ -83,7 +85,7 @@ Result:
8385

8486
## User agents
8587

86-
To limit access to your application to specific user agents, add them to the **USER AGENTS** allowlist.
88+
To limit access to your application to specific user agents, add them to the **User agents** allowlist.
8789

8890
:::info
8991

@@ -95,15 +97,15 @@ When you add a User-Agent to an allowlist, any API requests originating from oth
9597

9698
:::info
9799

98-
The **USER AGENTS** allowlist uses partial string matching. If the allowlisted string is present in the
99-
request's full User-Agent, it is registered as a match.
100+
The **User agents** allowlist uses partial string matching, meaning if the string is present in the
101+
request's full User-Agent, it's registered as a match.
100102

101103
:::
102104

103105
#### Example request
104106

105-
For example, to allow requests from Android phones alone, select **ADD** and input `Android` into
106-
the **USER AGENTS** allowlist.
107+
For example, to allow requests from Android phones alone, input `Android` into
108+
the **User agent** field, and select **Add**.
107109

108110
<div class="left-align-container">
109111
<div class="img-medium">
@@ -113,7 +115,7 @@ the **USER AGENTS** allowlist.
113115
</div>
114116
</div>
115117

116-
Test with a simple call from a desktop terminal.
118+
Test with a call from a desktop terminal.
117119

118120
```bash
119121
curl https://mainnet.infura.io/v3/<YOUR-API-KEY> \
@@ -136,7 +138,7 @@ Result:
136138

137139
## Origins
138140

139-
To limit access to your application to specific URLs, add them to the **ORIGINS** allowlist.
141+
To limit access to your application to specific URLs, add them to the **Origins** allowlist.
140142

141143
:::info
142144

@@ -148,7 +150,7 @@ When you add an origin to an allowlist, any API requests originating from other
148150

149151
Origin allowlists support wildcard subdomain patterns.
150152

151-
For example, allowlist entry `https://*.example.com` matches `https://your-app.example.com` ,
153+
For example, allowlist entry `https://*.example.com` matches `https://your-app.example.com`,
152154
`https://our-app.example.com`, and `https://their-app.example.com`, etc.
153155

154156
The origin scheme (HTTPS in the example above) is optional. However, if you include it, it must match.
@@ -161,25 +163,14 @@ An entry with _only_ a scheme allows requests coming from that scheme alone.
161163

162164
#### Example request
163165

164-
To limit requests to your hosted web3 application, click **ADD** and input `mydapp.example.com` into the **ORIGINS** allowlist.
165-
166-
Any requests that do not include `Origin: mydapp.example.com` are rejected.
166+
To limit requests to your hosted Web3 application, input `mydapp.example.com` into the **Origins**
167+
field, and select **Add**. Any requests that don't include `Origin: mydapp.example.com` are rejected.
167168

168169
## API request method
169170

170-
To limit the methods allowed, add them to the **API REQUEST METHOD** allowlist.
171-
172-
If the list is not empty, any method calls not specified in the list are rejected.
173-
174-
Use the dropdown list to select a method.
171+
To limit the methods allowed, select them from the **API request method** drop down.
175172

176-
<div class="left-align-container">
177-
<div class="img-medium">
178-
<img
179-
src={require("../../../images/api-request-method.png").default}
180-
/>
181-
</div>
182-
</div>
173+
If the list isn't empty, any method calls not specified in the list are rejected.
183174

184175
## Override your allowlist settings
185176

@@ -188,7 +179,7 @@ This functionality is only available to customers on the Developer tier or highe
188179
[upgrade your plan](../upgrade-your-plan.md) if you're currently on the free Core tier.
189180
:::
190181

191-
The **OVERIDE ALLOWLIST** switch lets you overide your allowlist settings when a request includes an
182+
The **OVERRIDE ALLOWLIST** switch lets you override your allowlist settings when a request includes an
192183
[API key secret](api-key-secret.md). This means requests will be accepted even if an IP address or
193184
URL isn't on your allowlist, provided they include both the API key and the API key secret.
194185

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ description: Use JSON Web Tokens to authorize users and external parties.
44

55
# JWTs
66

7-
Enable JSON Web Tokens (JWTs) for all requests in the **REQUIREMENTS** section of your API key's security settings.
7+
Enable JSON Web Tokens (JWTs) for all requests in the API key's **Settings** tab.
88

9-
Input the **JWT PUBLIC KEY NAME** and the key and select **ADD**.
9+
Input the **JWT Public key name** and the key and select **Add**.
1010

1111
<div class="left-align-container">
1212
<div class="img-medium">

0 commit comments

Comments
 (0)