Skip to content

Commit

Permalink
Merge pull request #555 from ethersphere/docusaurus-3-update
Browse files Browse the repository at this point in the history
Updated Docusaurus and other npm packages to newest versions
  • Loading branch information
NoahMaizels authored Feb 7, 2024
2 parents 43a689c + a14e107 commit cca6c9d
Show file tree
Hide file tree
Showing 16 changed files with 6,958 additions and 3,609 deletions.
2 changes: 1 addition & 1 deletion docs/bee/installation/fund-your-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ funded with:
a couple of transactions on the [Gnosis
Chain](/docs/learn/glossary#gnosis-chain).

Take note that xBZZ is the [bridged](/docs/learn/glossary#bridging-tokens) version of BZZ from Ethereum to the Gnosis Chain.
Take note that xBZZ is the [bridged](/docs/learn/glossary#bridged-tokens) version of BZZ from Ethereum to the Gnosis Chain.

### A node's wallet

Expand Down
2 changes: 1 addition & 1 deletion docs/bee/installation/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ While depositing xBZZ is optional, node operators who intend to download or uplo
For nodes which stake xBZZ and participate in the storage incentives system, very small amounts of xDAI will be used regularly to pay for staking related transactions on Gnosis Chain, so xDAI may need to be periodically topped up. See the [staking section](/docs/bee/working-with-bee/staking#check-redistribution-status) for more information.
After sending xDAI and optionally xBZZ to the Gnosis Chain address collected in the previous step, [restart the node](#edit-config-file):
After sending xDAI and optionally xBZZ to the Gnosis Chain address collected in the previous step, restart the node:
<Tabs
defaultValue="linux"
Expand Down
5 changes: 1 addition & 4 deletions docs/bee/working-with-bee/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -701,10 +701,7 @@ Bee service identifier in tracing spans.
_default_ `""`

As a spam prevention measure, for nodes which deployed their
chequebook with v0.5.0 or before, specify `transaction` - [the
transaction hash of any Ethereum transaction on the xDAI
network](/docs/learn/FAQ#how-can-i-find-a-transaction-hash-for-the---transaction-configuration-parameter)
sent from the Bee node's Ethereum address.
chequebook with v0.5.0 or before, specify `transaction`.

#### --verbosity

Expand Down
19 changes: 14 additions & 5 deletions docs/bee/working-with-bee/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Only a subset of endpoints running on `:1633` can be restricted. This is subject
Now that you decided to restrict the access to the APIs you should follow the next steps:

* Pick a password that is strong enough.
* Use a bcrypt utility to hash it (you can use `bee bcrypt` command for this purpose [bcrypt utility](/docs/bee/working-with-bee/bcrypt)
* Use a bcrypt utility to hash it (you can use `bee bcrypt` command for this purpose [bcrypt utility](/docs/bee/working-with-bee/bcrypt))
* Pass the hash to the bee instance using the `--admin-password` command line option (or as a configuration parameter)
* Pick a random string to be used for the `--token-encryption-key` (the same security token can be used against many instances sharing the same encryption key)

Expand Down Expand Up @@ -94,15 +94,21 @@ In the payload you can specify a different role and token lifetime.

There are three major groups:

* technical debug endpoints
#### Technical debug endpoints:

```bash
* /readiness
* /node
* /addresses
* /chainstate
* /debug/pprof
* /debug/vars
* /health
* business related endpoints residing on the debug port
```

#### Business related endpoints residing on the debug port

```bash
* /peers
* /pingpong/{peer-id}
* /reservestate
Expand Down Expand Up @@ -135,7 +141,10 @@ There are three major groups:
* /stamps/dilute/{id}/{depth}
* /batches
* /tags/{id}
* API endpoints
```
#### API endpoints

```bash
* /bytes
* /bytes/{address}
* /chunks
Expand All @@ -155,7 +164,7 @@ There are three major groups:
* /stewardship/{address}
* /auth
* /refresh

```
The user can toggle the debug port by setting the appropriate boolean value on `debug-api-enable` configuration parameter.
If the value is `false` (default) then the first two groups of endpoints will not be available.

Expand Down
2 changes: 1 addition & 1 deletion docs/desktop/postage-stamps.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ And then clicking the ***Buy New Postage Stamp*** button:

### Depth and Amount

Batch [depth and amount](docs/learn/technology/contracts/postage-stamp) are the two required parameters which must be set when purchasing a postage stamp batch. Depth determines how many chunks can be stamped with a batch while amount determines how much xBZZ is assigned per chunk.
Batch [depth and amount](/docs/learn/technology/contracts/postage-stamp) are the two required parameters which must be set when purchasing a postage stamp batch. Depth determines how many chunks can be stamped with a batch while amount determines how much xBZZ is assigned per chunk.

![](/img/stamps3.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/develop/access-the-swarm/erasure-coding.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Do take note that any level of erasure encoding will increase the cost of upload

When downloading erasure encoded data, there are three related headers which may be used—`swarm-redundancy-strategy`, `swarm-redundancy-fallback-mode: <integer>`, and `swarm-chunk-retrieval-timeout`.

* `swarm-redundancy-strategy`: This header allows you to set the retrieval strategy for fetching chunks. The accepted values range from 0 to 3. Each number corresponds to a different chunk retrieval strategy. The numbers stand for the NONE, DATA, PROX and RACE strategies respectively which are described in greater detail in [the API reference](/api/#tag/BZZ/paths/~1bzz~1{reference}/get). With each increasing level, there will be a potentially greater bandwidth cost. Default is `NONE`.
* `swarm-redundancy-strategy`: This header allows you to set the retrieval strategy for fetching chunks. The accepted values range from 0 to 3. Each number corresponds to a different chunk retrieval strategy. The numbers stand for the NONE, DATA, PROX and RACE strategies respectively which are described in greater detail in [the API reference](/api/#tag/BZZ). With each increasing level, there will be a potentially greater bandwidth cost. Default is `NONE`.

* `swarm-redundancy-fallback-mode: <boolean>`: Enables the fallback feature for the redundancy strategies so that if one of the retrieval strategies fails, it will fallback to the more intensive strategy until retrieval is successful or retrieval fails. Default is `true`.

Expand Down
2 changes: 1 addition & 1 deletion docs/develop/access-the-swarm/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Watch as your uploaded data is [synced with the network](/docs/develop/access-th

### Keep Your Data Alive

Learn how to assign xBZZ to your data using postage stamps so that it remains [live on the Swarm network](/docs/develop/access-the-swarm/keep-your-data-alive).
Learn how to assign xBZZ to your data using postage stamps so that it remains [live on the Swarm network](/docs/develop/access-the-swarm/buy-a-stamp-batch).

### Pinning

Expand Down
2 changes: 1 addition & 1 deletion docs/develop/access-the-swarm/store-with-encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ curl -F [email protected] -H "Swarm-Postage-Batch-Id: 78a26be9b42317fe6f0cbea3e47cbd

When successful, the Bee client will return a 64 byte reference, instead of the usual 32 bytes.

More information on how to buy a postage stamp batch and get its batch id can be found [here](/docs/develop/access-the-swarm/keep-your-data-alive).
More information on how to buy a postage stamp batch and get its batch id can be found [here](/docs/develop/access-the-swarm/buy-a-stamp-batch).

```json
{
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/access-the-swarm/syncing.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The `uid` value is your tag:
```

:::info
In order to upload your data to swarm, you must agree to burn some of your xBZZ to signify that the content is important. Before you progress to the next step, you must buy stamps! See this guide on how to [purchase an appropriate batch of stamps](/docs/develop/access-the-swarm/keep-your-data-alive).
In order to upload your data to swarm, you must agree to burn some of your xBZZ to signify that the content is important. Before you progress to the next step, you must buy stamps! See this guide on how to [purchase an appropriate batch of stamps](/docs/develop/access-the-swarm/buy-a-stamp-batch).
:::

Pass the tag along with the upload:
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 @@ -302,7 +302,7 @@ cd ..
Next, simply POST the `tar` file as binary data to Bee's `dir` endpoint, taking care to include the header `Content Type: application/x-tar`.

:::info
In order to upload your data to swarm, you must agree to burn some of your xBZZ to signify to storer and fowarder nodes that the content is important. Before you progress to the next step, you must buy stamps! See this guide on how to [purchase an appropriate batch of stamps](/docs/develop/access-the-swarm/keep-your-data-alive).
In order to upload your data to swarm, you must agree to burn some of your xBZZ to signify to storer and fowarder nodes that the content is important. Before you progress to the next step, you must buy stamps! See this guide on how to [purchase an appropriate batch of stamps](/docs/develop/access-the-swarm/buy-a-stamp-batch).
:::

```bash
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/dapps-on-swarm/pss.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ localhost:1833/pss/send/test-topic/7bc5?recipient=0349f7b9a6fa41b3a123c64706a072
--data "Hello Swarm"
```

More information on how to buy a postage stamp batch and get its batch id can be found [here](/docs/develop/access-the-swarm/keep-your-data-alive).
More information on how to buy a postage stamp batch and get its batch id can be found [here](/docs/develop/access-the-swarm/buy-a-stamp-batch).

### Send Messages in a Test Network

Expand Down
2 changes: 1 addition & 1 deletion docs/learn/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Overlay addresses are a Keccak256 hash of a node’s Gnosis Chain address and th

## Neighborhood

Neighborhoods are nodes which are grouped together based on their overlay addresses and are responsible for storing the same chunks of data. The chunks which each neighborhood are responsible for storing are defined by the proximity order of the nodes and the chunks. See [DISC](/docs/learn/technology/DISC#neighborhoods) for more details.
Neighborhoods are nodes which are grouped together based on their overlay addresses and are responsible for storing the same chunks of data. The chunks which each neighborhood are responsible for storing are defined by the proximity order of the nodes and the chunks. See [DISC](/docs/learn/technology/disc#neighborhoods) for more details.

## Underlay

Expand Down
2 changes: 1 addition & 1 deletion docs/learn/technology/contracts/postage-stamp.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ id: postage-stamp

The [postage stamp contract](https://github.com/ethersphere/storage-incentives/blob/master/src/PostageStamp.sol) is one component in the suite of smart contract orchestrating Swarm's [storage incentives](/docs/learn/technology/incentives) which make up the foundation of Swarm's self-sustaining economic system.

When a node uploads data to Swarm, it 'attaches' postage stamps to each [chunk](/docs/learn/technology/DISC) of data. Postage stamps are purchased in batches rather than one by one. The value assigned to a stamp indicates how much it is worth to persist the associated data on Swarm, which nodes use to prioritize which chunks to remove from their reserve first.
When a node uploads data to Swarm, it 'attaches' postage stamps to each [chunk](/docs/learn/technology/disc) of data. Postage stamps are purchased in batches rather than one by one. The value assigned to a stamp indicates how much it is worth to persist the associated data on Swarm, which nodes use to prioritize which chunks to remove from their reserve first.

The value of a postage stamp decreases over time as if storage rent was regularly deducted from the batch balance. We say that a stamp expires when the batch it is issued from has insufficient balance. A chunk with an expired stamp can not be used in the proof of entitlement storer nodes need to submit in order to get compensated for their contributed storage space, therefore such expired chunks are evicted from nodes' reserves and put into the cache where their continued persistence depends on their popularity.

Expand Down
2 changes: 1 addition & 1 deletion docs/learn/technology/what-is-swarm.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ As the [libp2p](https://libp2p.io/) library meets all these requirements it has

### 2. Overlay Network

The second part of Swarm is an overlay network with protocols powering the [Distributed Immutable Store of Chunks (DISC)](/docs/learn/technology/DISC/). This layer is responsible for storing and retrieving data in a decentralised and secure manner.
The second part of Swarm is an overlay network with protocols powering the [Distributed Immutable Store of Chunks (DISC)](/docs/learn/technology/disc/). This layer is responsible for storing and retrieving data in a decentralised and secure manner.

Swarm's overlay network is built on top of the underlay transport layer and uses [Kademlia](/docs/learn/glossary#kademlia) overlay routing to enable efficient and scalable communication between nodes. Kademlia is a distributed hash table (DHT) algorithm that allows nodes to locate each other in the network based on their unique identifier or hash.

Expand Down
Loading

0 comments on commit cca6c9d

Please sign in to comment.