Skip to content

Commit

Permalink
Merge pull request #645 from ethersphere/typo-9-24-24
Browse files Browse the repository at this point in the history
fixed typos
  • Loading branch information
NoahMaizels authored Sep 24, 2024
2 parents e860680 + 0562689 commit a03d065
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 17 deletions.
8 changes: 4 additions & 4 deletions docs/bee/installation/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ To obtain xDAI and fund your node, you can [follow the instructions](https://doc
To add stake, make a POST request to the `/stake` endpoint and input the amount you wish to stake in PLUR as a parameter after `/stake`. For example, to stake an amount equal to 10 xBZZ:

```bash
curl -XPOST localhost:1633/stake/100000000000000000
curl -X POST localhost:1633/stake/100000000000000000
```

Note that since we have mapped our host and container to the same port, we can use the default `1633` port to make our request. If you are running multiple nodes, make sure to update this command for other nodes which will be mapped to different ports on the host machine.
Expand Down Expand Up @@ -599,7 +599,7 @@ The Bee API will not be available while your node is warming up, so wait until y
:::

```bash
curl -XPOST localhost:1633/stake/100000000000000000
curl -X POST localhost:1633/stake/100000000000000000
```

Note that since we have mapped our host and container to the same port, we can use the default `1633` port to make our request. If you are running multiple Bees, make sure to update this command for other nodes which will be mapped to different ports on the host machine.
Expand Down Expand Up @@ -767,13 +767,13 @@ In order to stake you simply need to call the `/stake` endpoint with an amount o
For bee-node_01:

```bash
curl -XPOST localhost:1633/stake/100000000000000000
curl -X POST localhost:1633/stake/100000000000000000
```

And for bee-node_02, note that we updated the port to match the one for the Bee API address we mapped to in the Docker Compose file:

```bash
curl -XPOST localhost:1636/stake/100000000000000000
curl -X POST localhost:1636/stake/100000000000000000
```

You may also wish to make use of the [node-funder](https://github.com/ethersphere/node-funder) tool, which in addition to allowing you to fund multiple addresses at once, also allows you to stake multiple addresses at once.
2 changes: 1 addition & 1 deletion docs/bee/installation/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -818,7 +818,7 @@ Once your node is up and running, make sure to [back up your keys](/docs/bee/wor
While depositing stake is not required to run a Bee node, it is required in order for a node to receive rewards for sharing storage with the network. You will need to [deposit xBZZ to the staking contract](/docs/bee/working-with-bee/staking) for your node. To do this, send a minimum of 10 xBZZ to your nodes' wallet and run:
```bash
curl -XPOST localhost:1633/stake/100000000000000000
curl -X POST localhost:1633/stake/100000000000000000
```
This will initiate a transaction on-chain which deposits the specified amount of xBZZ into the staking contract.
Expand Down
6 changes: 3 additions & 3 deletions docs/bee/working-with-bee/cashing-out.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ As our node's participation in the network increases, we will begin to see more
To do this, we simply POST the relevant peer's address to the `cashout` endpoint.

```bash
curl -XPOST http://localhost:1633/chequebook/cashout/d7881307e793e389642ea733451db368c4c9b9e23f188cca659c8674d183a56b
curl -X POST http://localhost:1633/chequebook/cashout/d7881307e793e389642ea733451db368c4c9b9e23f188cca659c8674d183a56b
```

```json
Expand Down Expand Up @@ -185,13 +185,13 @@ Success, we earned our first xBZZ! 🐝
Now we have earned tokens, to withdraw our xBZZ from the chequebook contract back into our node's own wallet, we simply POST a request to the chequebook withdraw endpoint.

```bash
curl -XPOST http://localhost:1633/chequebook/withdraw\?amount\=1000 | jq
curl -X POST http://localhost:1633/chequebook/withdraw\?amount\=1000 | jq
```

And conversely, if we have used more services than we have provided, we may deposit extra xBZZ into the chequebook contract by sending a POST request to the deposit endpoint.

```bash
curl -XPOST http://localhost:1633/chequebook/deposit\?amount\=1000 | jq
curl -X POST http://localhost:1633/chequebook/deposit\?amount\=1000 | jq
```

```json
Expand Down
2 changes: 1 addition & 1 deletion docs/bee/working-with-bee/staking.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Bee has builtin endpoints for depositing the stake. Currently the minimum stakin
Then you can run the following command to stake 10 xBZZ. The amount is given in PLUR which is the smallest denomination of xBZZ and `1 xBZZ == 1e16 PLUR`.

```bash
curl -XPOST localhost:1633/stake/100000000000000000
curl -X POST localhost:1633/stake/100000000000000000
```

If the command executed successfully it returns a transaction hash that you can use to verify on a block explorer.
Expand Down
4 changes: 2 additions & 2 deletions docs/develop/access-the-swarm/buy-a-stamp-batch.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ xDAI can be obtained from a wide range of centralized and decentralized exchange
When interacting with the Bee API directly, `amount` and `depth` are passed as path parameters:

```bash
curl -s -XPOST http://localhost:1633/stamps/<amount>/<depth>
curl -s -X POST http://localhost:1633/stamps/<amount>/<depth>
```

And with Swarm CLI, they are set using option flags:
Expand All @@ -47,7 +47,7 @@ values={[
#### API

```bash
curl -s -XPOST http://localhost:1633/stamps/100000000/20
curl -s -X POST http://localhost:1633/stamps/100000000/20
```

```bash
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/access-the-swarm/pinning.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ The previous example showed how we can pin content upon upload. It is also possi
To do so, we can send a `POST` request including the swarm reference to the files pinning endpoint.
```bash
curl -XPOST http://localhost:1633/pins/7b344ea68c699b0eca8bb4cfb3a77eb24f5e4e8ab50d38165e0fb48368350e8f
curl -X POST http://localhost:1633/pins/7b344ea68c699b0eca8bb4cfb3a77eb24f5e4e8ab50d38165e0fb48368350e8f
```
```json
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/access-the-swarm/upload-and-download.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Here, you must specify your _Batch ID_ in the `Swarm-Postage-Batch-Id` header, t
You may also wish to employ the erasure coding feature to add greater protection for your data, see [erasure coding page](/docs/develop/access-the-swarm/erasure-coding) for more details on its usage.

```bash
curl -XPOST -H "Swarm-Postage-Batch-Id: 54ba8e39a4f74ccfc7f903121e4d5d0fc40732b19efef5c8894d1f03bdd0f4c5" -H "Content-Type: text/plain" -H "Swarm-Encrypt: false" -v --data-binary "@test.txt" localhost:1633/bzz
curl -X POST -H "Swarm-Postage-Batch-Id: 54ba8e39a4f74ccfc7f903121e4d5d0fc40732b19efef5c8894d1f03bdd0f4c5" -H "Content-Type: text/plain" -H "Swarm-Encrypt: false" -v --data-binary "@test.txt" localhost:1633/bzz
```

:::danger
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/contribute/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Make sure addresses are configured as in examples above.
And use that address in the API call on another node, for example, local node 1:

```bash
curl -XPOST localhost:1735/pingpong/d4440baf2d79e481c3c6fd93a2014d2e6fe0386418829439f26d13a8253d04f1
curl -X POST localhost:1735/pingpong/d4440baf2d79e481c3c6fd93a2014d2e6fe0386418829439f26d13a8253d04f1
```

## Generating protobuf
Expand Down
6 changes: 3 additions & 3 deletions docs/develop/tools-and-features/pss.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ For example, if we want to send a PSS message with **topic** `test-topic` to a n
...we must include the **target** `7bc5` and the public key itself as a query argument.

```bash
curl -H "Swarm-Postage-Batch-Id: 78a26be9b42317fe6f0cbea3e47cbd0cf34f533db4e9c91cf92be40eb2968264" -XPOST \
curl -H "Swarm-Postage-Batch-Id: 78a26be9b42317fe6f0cbea3e47cbd0cf34f533db4e9c91cf92be40eb2968264" -X POST \
localhost:1833/pss/send/test-topic/7bc5?recipient=0349f7b9a6fa41b3a123c64706a072014d27f56accd9a0e92b06fe8516e470d8dd \
--data "Hello Swarm"
```
Expand Down Expand Up @@ -138,7 +138,7 @@ curl -s localhost:1935/peers | jq
Let's connect node 2 to node 1 using the localhost (127.0.0.1) underlay address for node 1 that we have noted earlier.

```bash
curl -XPOST \
curl -X POST \
localhost:1935/connect/ip4/127.0.0.1/tcp/1834/p2p/16Uiu2HAmP9i7VoEcaGtHiyB6v7HieoiB9v7GFVZcL2VkSRnFwCHr
```

Expand Down Expand Up @@ -188,7 +188,7 @@ Since our first node has a 2 byte address prefix of `a231`, we will specify this
```bash
curl \
-H "Swarm-Postage-Batch-Id: 78a26be9b42317fe6f0cbea3e47cbd0cf34f533db4e9c91cf92be40eb2968264"
-XPOST "localhost:1933/pss/send/test-topic/7bc5?recipient=0349f7b9a6fa41b3a123c64706a072014d27f56accd9a0e92b06fe8516e470d8dd" \
-X POST "localhost:1933/pss/send/test-topic/7bc5?recipient=0349f7b9a6fa41b3a123c64706a072014d27f56accd9a0e92b06fe8516e470d8dd" \
--data "Hello Swarm"
```

Expand Down

0 comments on commit a03d065

Please sign in to comment.