Skip to content

Commit 96a850d

Browse files
alexandratranalexandratran
authored
Sidebar config adjustments (#1726)
* Sidebar config adjustments * more edits
1 parent 87610a1 commit 96a850d

File tree

103 files changed

+117
-206
lines changed

Some content is hidden

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

103 files changed

+117
-206
lines changed

‎services/how-to/use-ipfs/authenticate-requests.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ page after you [register your Infura account](https://infura.io/register) and
2929
For example, to authenticate and upload a file to IPFS using curl, you would use the following command:
3030

3131
```bash
32-
curl -X POST -F file=@myfile -u "<API_KEY>:<API_KEY_SECRET>" "https://ipfs.infura.io:5001/api/v0/add"
32+
curl -X POST -F file=@myfile -u "<YOUR-API-KEY>:<YOUR-API-KEY-SECRET>" "https://ipfs.infura.io:5001/api/v0/add"
3333
```
3434

3535
curl automatically generates the authorization header and encodes your credentials.

‎services/how-to/use-ipfs/manage-files.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Infura doesn't currently support remote pinning services on IPFS Desktop.
1717

1818
```bash
1919
curl -X POST -F file=@myfile \
20-
-u "<API_KEY>:<API_KEY_SECRET>" \
20+
-u "<YOUR-API-KEY>:<YOUR-API-KEY-SECRET>" \
2121
"https://ipfs.infura.io:5001/api/v0/add"
2222

2323
> {
@@ -64,7 +64,7 @@ Infura's [ipfs-upload-client](https://github.com/INFURA/ipfs-upload-client) is a
6464
Upload your files and directories to IPFS using the following syntax:
6565

6666
```
67-
./ipfs-upload-client --id <API_KEY> --secret <API_KEY_SECRET> </path/to/data>
67+
./ipfs-upload-client --id <YOUR-API-KEY> --secret <YOUR-API-KEY-SECRET> </path/to/data>
6868
```
6969

7070
By default, the tool also pins your uploaded file. You can override this default by setting `--pin false`. Read more
@@ -85,7 +85,7 @@ IPFS pinning allows you to retain and persist data on IPFS nodes. Pinning assure
8585
not removed during the [IPFS garbage collection process](https://docs.ipfs.io/concepts/persistence/#garbage-collection).
8686

8787
```bash
88-
curl -X POST -u "<API_KEY>:<API_KEY_SECRET>" \
88+
curl -X POST -u "<YOUR-API-KEY>:<YOUR-API-KEY-SECRET>" \
8989
"https://ipfs.infura.io:5001/api/v0/pin/add?arg=QmeGAVddnBSnKc1DLE7DLV9uuTqo5F7QbaveTjr45JUdQn"
9090
```
9191

@@ -101,14 +101,14 @@ To unpin a file in the Infura UI, select the file in the IPFS dashboard for your
101101
Alternatively, use the IPFS API to unpin content.
102102

103103
```bash
104-
curl -X POST -u "<API_KEY>:<API_KEY_SECRET>" \
104+
curl -X POST -u "<YOUR-API-KEY>:<YOUR-API-KEY-SECRET>" \
105105
"https://ipfs.infura.io:5001/api/v0/pin/rm?arg=QmeGAVddnBSnKc1DLE7DLV9uuTqo5F7QbaveTjr45JUdQn"
106106
```
107107

108108
### Read a file
109109

110110
```bash
111-
curl -X POST -u "<API_KEY>:<API_KEY_SECRET>" \
111+
curl -X POST -u "<YOUR-API-KEY>:<YOUR-API-KEY-SECRET>" \
112112
"https://ipfs.infura.io:5001/api/v0/cat?arg=QmeGAVddnBSnKc1DLE7DLV9uuTqo5F7QbaveTjr45JUdQn"
113113

114114
> Infura IPFS - Getting started demo.

‎services/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ dapps and Snaps.
2121
Infura offers a robust set of features designed to enhance the development, deployment, and management of dapps. These features
2222
include:
2323

24-
- **Broad access to major networks** - Infura supports the major networks, allowing you to take advantage of Ethereums's smart
24+
- **Broad access to major networks** - Infura supports the major networks, allowing you to take advantage of Ethereum's smart
2525
contracts, IPFS's distributed file system, or high performing layer 2 networks.
2626
- **Failover support for APIs** - Currently available on select networks for customers on Growth or Custom plans; if an Infura API
2727
endpoint becomes unavailable for any reason, requests can be forwarded to a partner to fulfill the request.
@@ -30,7 +30,7 @@ include:
3030
block height. This is an invaluable feature for those who need to perform deep analyses of past transactions, contract
3131
states, or balances. With this feature, developers can build applications that are not only data-rich but also comprehensive.
3232
- **Expansion APIs** -
33-
[Access Infura's multi-chain Gas API](reference/gas-api/api-reference/index.md). Use the Gas API used by the MetaMask wallet to analyze and
33+
[Access Infura's multichain Gas API](reference/gas-api/api-reference/index.md). Use the Gas API used by the MetaMask wallet to analyze and
3434
optimize gas costs on EIP-1559 compatible chains.
3535

3636
<head>

‎services/reference/_partials/_eth_estimategas-description.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ Generates and returns an estimate of how much gas is necessary to allow the tran
22

33
:::warning Gas parameter is capped
44

5-
To prevent abuse of the API, the `gas` parameter in this `eth_estimateGas` method and in [`eth_call`](../ethereum/json-rpc-methods/eth_call.mdx) is capped at 10x (1000%) the current block gas limit. You can recreate this behavior in your local test environment (besu, geth, or other client) via the [`rpc.gascap`](https://geth.ethereum.org/docs/fundamentals/command-line-options#commands) command-line option.
5+
To prevent abuse of the API, the `gas` parameter in this `eth_estimateGas` method and in [`eth_call`](../ethereum/json-rpc-methods/eth_call.mdx) is capped at 10x (1000%) the current block gas limit. You can recreate this behavior in your local test environment (Besu, geth, or other client) using the [`rpc.gascap`](https://geth.ethereum.org/docs/fundamentals/command-line-options#commands) command line option.
66
:::

‎services/reference/_partials/_eth_getwork-description.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Returns the hash of the current block, the seedHash, and the boundary condition to be met ("target").
1+
Returns the hash of the current block, the seed hash, and the boundary condition to be met ("target").

‎services/reference/gas-api/api-reference/basefeehistory.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ instead of using the curl authentication option (`-u`).
4545

4646
```bash
4747
curl -X "GET" \
48-
-u <API_KEY>:<API_KEY_SECRET> \
48+
-u <YOUR-API-KEY>:<YOUR-API-KEY-SECRET> \
4949
"https://gas.api.infura.io/networks/1/baseFeeHistory"
5050
```
5151

‎services/reference/gas-api/api-reference/basefeepercentile.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ instead of using the curl authentication option (`-u`).
4646

4747
```bash
4848
curl -X "GET" \
49-
-u <API_KEY>:<API_KEY_SECRET> \
49+
-u <YOUR-API-KEY>:<YOUR-API-KEY-SECRET> \
5050
"https://gas.api.infura.io/networks/1/baseFeeHistory"
5151
```
5252

‎services/reference/gas-api/api-reference/busythreshold.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ instead of using the curl authentication option (`-u`).
4545

4646
```bash
4747
curl -X "GET" \
48-
-u <API_KEY>:<API_KEY_SECRET> \
48+
-u <YOUR-API-KEY>:<YOUR-API-KEY-SECRET> \
4949
"https://gas.api.infura.io/networks/1/busyThreshold"
5050
```
5151

‎services/reference/gas-api/api-reference/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ You can call the Gas APIs in two ways:
2828
<TabItem value="API key only" label="Use an API key only" default>
2929

3030
```bash
31-
curl -X "GET" "https://gas.api.infura.io/v3/<API_KEY>/networks/1/suggestedGasFees"
31+
curl -X "GET" "https://gas.api.infura.io/v3/<YOUR-API-KEY>/networks/1/suggestedGasFees"
3232
```
3333

3434
</TabItem>
3535
<TabItem value="API key and API key secret" label="Use an API key and API key secret" >
3636

3737
```bash
38-
curl -X "GET" -u <API_KEY>:<API_KEY_SECRET> "https://gas.api.infura.io/networks/1/suggestedGasFees"
38+
curl -X "GET" -u <YOUR-API-KEY>:<YOUR-API-KEY-SECRET> "https://gas.api.infura.io/networks/1/suggestedGasFees"
3939
```
4040

4141
</TabItem>

‎services/reference/ipfs/http-api-methods/add.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Add a file or directory to IPFS.
1515
```bash
1616
curl "https://ipfs.infura.io:5001/api/v0/add?recursive=false&quiet=<value>&quieter=<value>&silent=<value>&progress=<value>&trickle=<value>&only-hash=<value>&wrap-with-directory=<value>&hidden=<value>&chunker=<value>&pin=true&raw-leaves=<value>&nocopy=<value>&fscache=<value>&cid-version=0&hash=sha2-256" \
1717
-X POST \
18-
-u "<API_KEY>:<API_KEY_SECRET>" \
18+
-u "<YOUR-API-KEY>:<YOUR-API-KEY-SECRET>" \
1919
-H "Content-Type: multipart/form-data" \
2020
-F file=@"<file>"
2121
```

0 commit comments

Comments
 (0)