Skip to content

Commit

Permalink
V0.5.0 dev (#126)
Browse files Browse the repository at this point in the history
* bump version number

* update banner

* add bee support channel

* add debug api info

* updates funding

* amend b-clef version
  • Loading branch information
significance authored Feb 9, 2021
1 parent e5e5788 commit 3b86bd8
Show file tree
Hide file tree
Showing 8 changed files with 94 additions and 56 deletions.
4 changes: 4 additions & 0 deletions docs/api-reference/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ Detailed information about Bee API endpoint can be found here:
## Debug API
The debug-API is disabled by default but be enabled by setting the `enable-debug-api` configuration option to `true`. The debug-API exposes functionality to inspect the state of your Bee node while it is running, as well as some other features that should not be exposed to the public internet. The Debug API runs on port `:1635` by default.

:::info
For a new installation of Bee, the debug API endpoint is not yet exposed for security reasons. To enable the debug API endpoints, set `debug-api-enable` to `true` in your [configuration file](/docs/installation/configuration#configuring-bee-installed-using-a-package-manager) and restart your Bee service.
:::

- <a href="../../debug-api" target="_blank" rel="noopener noreferrer">Debug API reference.</a>,

:::danger
Expand Down
24 changes: 12 additions & 12 deletions docs/installation/bee-clef.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,49 +20,49 @@ Bee clef can be installed automatically using your system's package manager.
#### AMD64

```sh
wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.2/bee-clef_0.4.2_amd64.deb
sudo dpkg -i bee-clef_0.4.4_amd64.deb
wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.7/bee-clef_0.4.7_amd64.deb
sudo dpkg -i bee-clef_0.4.7_amd64.deb
```

#### ARM (Raspberry Pi)

##### ARMv7

```sh
wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.2/bee-clef_0.4.2_armv7.deb
sudo dpkg -i bee-clef_0.4.4_armv7.deb
wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.7/bee-clef_0.4.7_armv7.deb
sudo dpkg -i bee-clef_0.4.7_armv7.deb
```

##### ARM64

```sh
wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.2/bee-clef_0.4.2_arm64.deb
sudo dpkg -i bee-clef_0.4.4_arm64.deb
wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.7/bee-clef_0.4.7_arm64.deb
sudo dpkg -i bee-clef_0.4.7_arm64.deb
```

### CentOS

#### AMD64

```sh
wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.2/bee-clef_0.4.2_amd64.rpm
sudo rpm -i bee-clef_0.4.4_amd64.rpm
wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.7/bee-clef_0.4.7_amd64.rpm
sudo rpm -i bee-clef_0.4.7_amd64.rpm
```

#### ARM (Raspberry Pi)

##### ARMv7

```sh
wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.2/bee-clef_0.4.2_armv7.rpm
sudo rpm -i bee-clef_0.4.4_armv7.rpm
wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.7/bee-clef_0.4.7_armv7.rpm
sudo rpm -i bee-clef_0.4.7_armv7.rpm
```

##### ARM64

```sh
wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.2/bee-clef_0.4.2_arm64.rpm
sudo rpm -i bee-clef_0.4.4_arm64.rpm
wget https://github.com/ethersphere/bee-clef/releases/download/v0.4.7/bee-clef_0.4.7_arm64.rpm
sudo rpm -i bee-clef_0.4.7_arm64.rpm
```

### MacOS
Expand Down
4 changes: 2 additions & 2 deletions docs/installation/build-from-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ git describe --tags
3) Checkout the required version:

```sh
git checkout v0.4.2
git checkout v0.5.0
```

4) Build the binary:
Expand All @@ -47,7 +47,7 @@ dist/bee version
```

```
0.4.2
0.5.0
```

6) (optional) Additionally, you may also like to move the Bee binary to somewhere in your `$PATH`
Expand Down
6 changes: 3 additions & 3 deletions docs/installation/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ docker pull ethersphere/bee:beta
#### Specific Versions

```sh
docker pull ethersphere/bee:0.4.2
docker pull ethersphere/bee:0.5.0
```

#### Edge
Expand All @@ -91,13 +91,13 @@ Configuration files for Bee and Bee Clef are provided to enable quick and easy i
First, retrieve the current `docker-compose.yaml` file.

```sh
wget -q https://raw.githubusercontent.com/ethersphere/bee/v0.4.2/packaging/docker/docker-compose.yml
wget -q https://raw.githubusercontent.com/ethersphere/bee/v0.5.0/packaging/docker/docker-compose.yml
```

Next, create a `.env` file using the example file provided. This file will be responsible for storing configuration and secrets for our Bee and Bee Clef applications.

```sh
wget -q https://raw.githubusercontent.com/ethersphere/bee/v0.4.2/packaging/docker/env -O .env
wget -q https://raw.githubusercontent.com/ethersphere/bee/v0.5.0/packaging/docker/env -O .env
```

There are some important configuration parameters which must be set in order for our projects to work. To affect configuration in the `.env` file, we first remove the `#` at the beginning of the line and then change the value after `=` to our desired config.
Expand Down
6 changes: 3 additions & 3 deletions docs/installation/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ To install the binary using our quick install script, run either one of the foll

#### wget
```sh
wget -q -O - https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v0.4.2 bash
wget -q -O - https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v0.5.0 bash
```

#### curl
```sh
curl -s https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v0.4.2 bash
curl -s https://raw.githubusercontent.com/ethersphere/bee/master/install.sh | TAG=v0.5.0 bash
```

### Bee Clef External Signer
Expand All @@ -34,7 +34,7 @@ bee version
```

```
0.4.2
0.5.0
```

Now your Bee node is installed, you can fund your node with gBZZ join us in the swarm! 🐝 🐝 🐝 🐝 🐝
Expand Down
103 changes: 68 additions & 35 deletions docs/installation/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ If your system is not supported, please see the [manual installation](/docs/inst
The overview of the installation process:
1. (Recommended) set up an external signer for Bee (i.e. install *bee-clef*)
2. install the Bee application package
3. fund your node with gETH and gBZZ
3. [fund your node](/docs/installation/quick-start#fund-your-node) with gETH and gBZZ

## Install Bee Clef

Expand All @@ -33,49 +33,49 @@ Follow post install guide in terminal for initial configuration and how to start
#### AMD64

```sh
wget https://github.com/ethersphere/bee/releases/download/v0.4.2/bee_0.4.2_amd64.deb
sudo dpkg -i bee_0.4.2_amd64.deb
wget https://github.com/ethersphere/bee/releases/download/v0.5.0/bee_0.5.0_amd64.deb
sudo dpkg -i bee_0.5.0_amd64.deb
```

#### ARM (Raspberry Pi)

##### ARMv7

```sh
wget https://github.com/ethersphere/bee/releases/download/v0.4.2/bee_0.4.2_armv7.deb
sudo dpkg -i bee_0.4.2_armv7.deb
wget https://github.com/ethersphere/bee/releases/download/v0.5.0/bee_0.5.0_armv7.deb
sudo dpkg -i bee_0.5.0_armv7.deb
```

##### ARM64

```sh
wget https://github.com/ethersphere/bee/releases/download/v0.4.2/bee_0.4.2_arm64.deb
sudo dpkg -i bee_0.4.2_arm64.deb
wget https://github.com/ethersphere/bee/releases/download/v0.5.0/bee_0.5.0_arm64.deb
sudo dpkg -i bee_0.5.0_arm64.deb
```

### CentOS

#### AMD64

```sh
wget https://github.com/ethersphere/bee/releases/download/v0.4.2/bee_0.4.2_amd64.rpm
sudo rpm -i bee_0.4.2_amd64.rpm
wget https://github.com/ethersphere/bee/releases/download/v0.5.0/bee_0.5.0_amd64.rpm
sudo rpm -i bee_0.5.0_amd64.rpm
```

#### ARM (Raspberry Pi)

##### ARMv7

```sh
wget https://github.com/ethersphere/bee/releases/download/v0.4.2/bee_0.4.2_armv7.rpm
sudo rpm -i bee_0.4.2_armv7.rpm
wget https://github.com/ethersphere/bee/releases/download/v0.5.0/bee_0.5.0_armv7.rpm
sudo rpm -i bee_0.5.0_armv7.rpm
```

##### ARM64

```sh
wget https://github.com/ethersphere/bee/releases/download/v0.4.2/bee_0.4.2_arm64.rpm
sudo rpm -i bee_0.4.2_arm64.rpm
wget https://github.com/ethersphere/bee/releases/download/v0.5.0/bee_0.5.0_arm64.rpm
sudo rpm -i bee_0.5.0_arm64.rpm
```

### MacOS
Expand Down Expand Up @@ -137,14 +137,15 @@ journalctl --lines=100 --follow --unit bee
```

```text
Nov 20 23:50:17 sig-ln bee[55528]: time="2020-11-20T23:50:17Z" level=info msg="using swarm network address through clef: 2c24e02f26f7fdd8c5c3>
Nov 20 23:50:17 sig-ln bee[55528]: time="2020-11-20T23:50:17Z" level=info msg="swarm public key 0269fb8085bf4ac07a5f5050d7a5104a8e623e5379f64>
Nov 20 23:50:17 sig-ln bee[55528]: time="2020-11-20T23:50:17Z" level=info msg="pss public key 02f32c79a2f314afd3263e3cf9478b076acf211be1bfd88>
Nov 20 23:50:17 sig-ln bee[55528]: time="2020-11-20T23:50:17Z" level=info msg="using ethereum address 06c5aefd35d85028d65554660f353defa5ba989>
Nov 20 23:50:18 sig-ln bee[55528]: time="2020-11-20T23:50:18Z" level=info msg="using default factory address for chain id 5: a6b88705036f2a56>
Nov 20 23:50:18 sig-ln bee[55528]: time="2020-11-20T23:50:18Z" level=info msg="no chequebook found, deploying new one."
Nov 20 23:50:18 sig-ln bee[55528]: time="2020-11-20T23:50:18Z" level=warning msg="please make sure there is sufficient eth and bzz available >
Nov 20 23:50:18 sig-ln bee[55528]: time="2020-11-20T23:50:18Z" level=warning msg="on goerli you can get both goerli eth and goerli bzz from https://faucet.ethswarm.org?address=06c5aefd35d85028d65554660f353defa5ba989>
INFO[2021-02-09T18:55:11Z] swarm public key 03379f7aa673b7f03737064fd23ba1453619924a4602e70bbccc133ba67d0968bd
DEBU[2021-02-09T18:55:11Z] using existing libp2p key
DEBU[2021-02-09T18:55:11Z] using existing pss key
INFO[2021-02-09T18:55:11Z] pss public key 03bae655ce94431e1f2c2de8d017f88c8c5c293ef0057379223084aba9e318596e
INFO[2021-02-09T18:55:11Z] using ethereum address 99c9e7868d22244106a5ffbc2f5d6b7c88e2c85a
INFO[2021-02-09T18:55:14Z] using default factory address for chain id 5: f0277caffea72734853b834afc9892461ea18474
INFO[2021-02-09T18:55:14Z] no chequebook found, deploying new one.
WARN[2021-02-09T18:55:15Z] cannot continue until there is sufficient ETH (for Gas) and at least 10 BZZ available on 99c9e7868d22244106a5ffbc2f5d6b7c88e2c85a
WARN[2021-02-09T18:55:15Z] get your Goerli ETH and Goerli BZZ now via the bzzaar at https://bzz.ethswarm.org/?transaction=buy&amount=10&slippage=30&receiver=0x99c9e7868d22244106a5ffbc2f5d6b7c88e2c85a
```

Expand All @@ -164,42 +165,70 @@ tail -f /usr/local/var/log/swarm-bee/bee.log

### Fund Your Node

A SWAP enabled Bee node requires both ETH and BZZ to begin
A SWAP enabled Bee node requires both gETH and gBZZ to begin
operation. The current version of Swarm incentives is running on the
Ethereum testnet called Goerli. You can acquire free Goerli tokens
from the [Swarm faucet](https://faucet.ethswarm.org).
Ethereum Goerli testnet. To acquire free gBZZ tokens
visit the [Bzzaar](https://bzz.ethswarm.org) and follow the following steps!

#### 1. Find your Bee node's address.

To find a Bee node's Ethereum address you can:
- look into its logs (see above),
- use the handy `bee-get-addr` utility,
- send a request to our Bee node's
[debug API](/docs/api-reference/api-reference) endpoint
called *addresses*.

```sh
bee-get-addr
```

```
Please make sure there is sufficient eth and bzz available on 06c5aefd35d85028d65554660f353defa5ba989 address.
You can get both goerli eth and goerli bzz from https://faucet.ethswarm.org
WARN[2021-02-09T18:55:15Z] get your Goerli ETH and Goerli BZZ now via the bzzaar at https://bzz.ethswarm.org/?transaction=buy&amount=10&slippage=30&receiver=0x99c9e7868d22244106a5ffbc2f5d6b7c88e2c85a
```

:::info
For a new installation of Bee, the debug API endpoint is not yet exposed for security reasons. To enable the debug API endpoints, set `debug-api-enable` to `true` in your [configuration file](/docs/installation/configuration#configuring-bee-installed-using-a-package-manager) and restart your Bee service.
:::

```sh
curl -s localhost:1635/addresses | jq .ethereum
```

- send a request to our Bee node's
[debug API](/docs/api-reference/api-reference) endpoint
called *addresses*.

```json
"0x97a472ff3a28a2e93ef4d2f523ff48e39c4bf579"
```

Visit [https://faucet.ethswarm.org](https://faucet.ethswarm.org) and fill out the form to receive your initial supply of gBZZ and GETH.
#### 2. Come to the [Bzzaar](https://bzz.ethswarm.org) and buy some gBZZ!

*You can get to the Bzzaar by navigating to the link shown in your logs. It should look something like this, note that the Ethereum address of your node is prefilled in the `receiver` query parameter.*

`https://bzz.ethswarm.org/?transaction=buy&amount=10&slippage=30&receiver=0xbee467355...`

*Make sure that your Bee node's correct address is displayed above the transaction modal.*

`You are minting to receiver - 0xbee467355...`

Once this has been credited, we can now watch our logs and watch as Bee automatically deploys a chequebook and makes an initial deposit.
#### 3. Connect your wallet, we recommend [Metamask](https://metamask.io/) or [Portis](https://www.portis.io/).

#### 3. Click the `GET G-ETH` button in the bottom left hand corner of your screen.

#### 4. Wait for the Goerli ETH to arrive in your wallet.

*We will send a small amount of gETH to both your connected wallet, and your Bee's wallet!*

*This can take a couple of minutes, check the [faucet address on Etherscan](https://goerli.etherscan.io/address/0x44f9fda7a5bf504ddf16dd37b8411c3fba34461d) and look for the transactions to your addresses.*

*You may need to reconnect your wallet to see your balance increase once the transaction has completed.*

#### 5. Once you have balance, enter at least 10 in the `gBZZ` field, you may even have enough gETH to buy a little more!

*This is another blockchain transaction, minutes check Metamask to see how your transaction is getting on.*

#### 6. When your transaction is complete, your Bee node should be the proud owner of some freshly minted gBZZ!

#### 7. Check your Bee node, it should now begin deploying your checkbook contract.

*If your node has stopped polling for updates, you may now need to restart it.*

Once your Bee node is fully loaded with gBZZ, we can now watch our logs and watch as Bee automatically deploys a chequebook and makes an initial deposit.

```sh
journalctl --lines=100 --follow --unit bee
Expand All @@ -213,6 +242,10 @@ Nov 20 23:52:44 sig-ln bee[55528]: time="2020-11-20T23:52:44Z" level=info msg="g
...
```

:::info
The Bzzaar is brand new. If you have any issues, please [get in touch](/docs/#community) and let us know! You may also visit our legacy Goerli faucet at [https://faucet.ethswarm.org](https://faucet.ethswarm.org) and fill out the form with your Bee node's address to receive your nodes initial supply of gBZZ and GETH.
:::

If these messages are missing, check out our comprehensive guide to Bee [connectivity](/docs/installation/connectivity).

## Updating Bee
Expand Down
1 change: 1 addition & 0 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ There is a vibrant and buzzing community behind Swarm, get involved in one of ou
- [Orange Lounge](https://t.me/joinchat/GoVG8RHYjUpD_-bEnLC4EQ).
- [Twitter @ethswarm](https://twitter.com/ethswarm).
- [reddit channel](https://www.reddit.com/r/ethswarm/).
- [Swarm Bee Support](https://t.me/joinchat/LTr8vBf8JshNlAD3m9BGJQ)

## Reporting a bug
If your Bee isn't working, [get in touch and let us know!](https://github.com/ethersphere/bee/issues) Every Bee is important to us and we'll get right to work on fixing it for you as soon as possible. 🐝
Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ module.exports = {
announcementBar: {
id: 'bee_announcements',
content:
'⭐️ Happy 2021 from all at Swarm HQ! ⭐️',
'🐝 v0.5.0 is released feat. Swarm Feeds! Update your Bees now! 🐝',
backgroundColor: '#dd7200', // Defaults to `#fff`.
textColor: '#242424', // Defaults to `#000`.
},
Expand Down

0 comments on commit 3b86bd8

Please sign in to comment.