Bee Version 2.3.0 - Pre-release Notice

Updated December 12th, 2024 - Bee v2.3.0 Guide: Section 2A was added to address the relation between reversing reserve doubling and withdrawable stake.

Bee Version 2.3.0 - Reserve Doubling

We’re thrilled to announce that Bee Version 2.3.0 is scheduled for release on December 4th, 2024! The newest version of the Bee client includes exciting new features and improvements to existing features. Among these changes are the new reserve doubling feature, the new GSOC feature, and enhancements to the price oracle.

Reserve Doubling for Optimized Node Rewards

The reserve doubling feature allows nodes to store chunks from a “sister” neighborhood, effectively doubling their reserve size. By storing chunks from its sister neighborhood, a node gains the opportunity to participate in the redistribution game whenever its sister neighborhood is selected, doubling its chances of participating in the redistribution game.

While reserve doubling requires twice the disk space and will consume more bandwidth (double the bandwidth utilization for chunk syncing, no increase in bandwidth for chunk forwarding), its impact on CPU and RAM usage is minimal. This feature enables a single node to earn rewards as if it were two nodes operating in different neighborhoods, without the need for all the additional resources typically required to operate a second node. Reserve doubling gives node operators more flexibility in optimizing their nodes to maximize the ratio of rewards to resources used.

GSOC Enables New Dynamic Content on Swarm

The new GSOC (Graffiti Several Owner Chunks) feature (GSOC SWIP) is inspired by the Graffiti Feed feature which was originally specified by the Fair Data Society last year. One of the main objectives of both the Graffiti Feed and GSOC features are to allow for multiple users to write to a single SOC (single owner chunk). However, the Graffiti feed was held back by several significant limitations that reduced the utility of the feature. GSOC addresses these issues and opens up a new world of possibilities for dynamic content on Swarm. GSOC will enable the construction of applications such as multi-user forums, social media sites, chat applications, and much more. It also offers an alternative and cheaper option for secure messaging when compared with PSS.

Further details about GSOC architecture and a usage guide are coming soon! Make sure you’re following Swarm on Twitter and have joined the official Discord group to stay up to date.

Oracle Enhancement Brings More Responsive Pricing

When the price oracle was first introduced, limits were placed on the rate at which it could change the price of storage in order to protect against events where rapid price changes could result in data loss. Now that the oracle has been functioning smoothly for quite some time, these limits are being relaxed in order to enhance the functioning of the price oracle. The enhancement made to the price oracle will make pricing more dynamic and responsive to changes in network utilization. The update increases the rate at which postage price changes, allowing for storage pricing to more rapidly adjust to current network conditions.

Bee v2.3.0 Guide

The Bee v2.3.0 guide is divided into two sections. Section 1 contains a detailed guide for upgrading from Bee v2.2.0 to v2.3.0. Section 2 contains instructions for enabling the new reserve doubling feature.

Section 1: Updating to 2.3.0

Since the v2.3.0 update includes a new staking contract, node operators must manually withdraw and re-stake their xBZZ before updating their nodes, as they did for the v2.2.0 update.

Step 1.1: Withdraw xBZZ

When Bee v2.3.0 is released, the previous staking contract will be disabled, and stake withdrawals will be enabled.

Once the contract is disabled, stake can be withdrawn by calling the /stake endpoint with the DELETE method:

curl -X DELETE http://localhost:1633/stake

This command will withdraw all stake from the node to the node’s Gnosis Chain address.

Confirm that the stake was withdrawn:

 curl -s  http://localhost:1633/stake | jq

The value for stakedAmount should now be zero:

{
  "stakedAmount": "0"
}

Step 1.2: Stop node

This step will vary depending on how the node was set up:

sudo systemctl stop bee

or

docker compose down

or

docker stop <container_name_or_id>

Step 1.3: Update to 2.3.0 & Restart

After withdrawing stake and stopping the node, update the node to v2.3.0. The installation method will vary depending on the node setup. After updating, restart the node.

The specific restart command will depend on your installation method (Docker, install script, package installer, etc.)

Step 1.4: Re-stake xBZZ

After upgrading to v2.3.0 and restarting, xBZZ should be restaked into the new staking contract so that the node can continue to participate in the redistribution game.

To stake the minimum required 10 xBZZ:

curl -X POST localhost:1633/stake/100000000000000000

Confirm that the staking transaction was successful:

curl -s  http://localhost:1633/stake | jq

The expected output after staking the minimum of 10 xBZZ:

{
  "stakedAmount": "100000000000000000"
}

The expected output after staking the increased minimum of 20 xBZZ required for the reserve doubling feature:

{
  "stakedAmount": "200000000000000000"
}

The upgrade to 2.3.0 is now complete. From here on, the node will continue to participate in the redistribution game as normal.

Section 2: Reserve Doubling Guide

After updating your node to v2.3.0 and manually migrating your stake, you can enable the reserve doubling feature by following the steps below:

Step 2.1: Stake at least 20 xBZZ

The reserve doubling feature comes with an increase in the required minimum xBZZ stake from 10 xBZZ to 20 xBZZ.

For doubling the reserve of a node which already has 10 xBZZ staked, simply stake an additional 10 xBZZ for a total of 20 xBZZ stake:

curl -X POST localhost:1633/stake/100000000000000000

Or for a node with zero staked xBZZ, the entire 20 xBZZ can be staked at once:

curl -X POST localhost:1633/stake/200000000000000000

We can use the GET /stake endpoint to confirm the total stake for our node:

curl -s  http://localhost:1633/stake | jq

{
  "stakedAmount": "200000000000000000"
}

Step 2.2: Set reserve-capacity-doubling to 1.

The reserve doubling feature can be enabled by setting the new reserve-capacity-doubling config option to 1 using the configuration method of your choice.

Step 2.3: Restart node

After ensuring the node has at least 20 xBZZ staked and the reserve-capacity-doubling option has been set to 1, restart the node.

After restarting your node, it should then begin syncing chunks from its sister neighborhood.

The /status/neighborhoods endpoint can be used to confirm that the node has doubled its reserve and is now syncing with its sister neighborhood:

{
  "neighborhoods": [
    {
      "neighborhood": "01111101011",
      "reserveSizeWithinRadius": 1148351,
      "proximity": 10
    },
    {
      "neighborhood": "01111101010",
      "reserveSizeWithinRadius": 1147423,
      "proximity": 11
    }
  ]
}

The expected output should contain two neighborhoods, the node’s original neighborhood along with its sister neighborhood.

We can also check the /status endpoint to confirm our node is syncing new chunks:

curl -s  http://localhost:1633/status | jq

{
  "overlay": "be177e61b13b1caa20690311a909bd674a3c1ef5f00d60414f261856a8ad5c30",
  "proximity": 256,
  "beeMode": "full",
  "reserveSize": 4192792,
  "reserveSizeWithinRadius": 2295023,
  "pullsyncRate": 1.3033333333333332,
  "storageRadius": 10,
  "connectedPeers": 18,
  "neighborhoodSize": 1,
  "batchCommitment": 388104192,
  "isReachable": true,
  "lastSyncedBlock": 6982430
}

We can see that the pullsyncRate value is above zero, meaning that our node is currently syncing chunks, as expected.

Summary of Important Details

• The new reserve-capacity-doubling Bee configuration option is used to double a node’s reserve. The only valid values are 0 and 1.
• In order for a node to be able to participate in the redistribution game for both its own and its sister neighborhood, it must have a total of 20 xBZZ staked (10 xBZZ for each neighborhood).
• A doubling can be reversed by changing reserve-capacity-doubling back to 0 and restarting the node. There is then a two round delay, after which the additional xBZZ over the minimum 10 xBZZ can then be withdrawn.
• After doubling, there will be a delay of two rounds of the redistribution game until the node is able to participate in the game.

Section 2A: Reserve Doubling Reversing & Withdrawable Stake

Due to certain implementation details, the order in which a node’s reserve is doubled and then reversed can have an impact on the amount of withdrawable stake.

When doubling a node’s reserve, stake should be added AFTER setting reserve-capacity-doubling to 1. If instead, xBZZ is first staked with reserve-capacity-doubling set to 0, and the reserve is then doubled by increasing from 0 to 1 without the addition of more stake, this will prevent stake from being withdrawable when the doubling is reversed.

In order to maximize the amount of withdrawable stake after reversing a reserve doubling, follow these steps when doubling:

"time"="2024-11-27 06:55:48.319810" "level"="info" "logger"="node" "msg"="updated new reserve capacity doubling height in the staking contract" "transaction"="0x2040bc865444268c6683bbc74749f5efca9e9e7956f895476d648cb36e8df0d7" "new_height"=1

A. For a node that starts with zero stake:

1. Set reserve-capacity-doubling to 1 and start node
2. Stake 20 xBZZ
3. When ready to reverse doubling, stop node, set reserve-capacity-doubling to 0, and restart node
4. 10 xBZZ will now be withdrawable

B. For a node that starts with 10 xBZZ stake:

1. Set reserve-capacity-doubling to 1 and start node
2. Stake 10 xBZZ (for a total of 20 xBZZ in stake)
3. When ready to reverse doubling, stop node, set reserve-capacity-doubling to 0, and restart node
4. 10 xBZZ will now be withdrawable

How to free up withdrawable stake from a node with >= 20 xBZZ stake that currently has zero withdrawable stake

In the case that a node with 20 xBZZ stake was doubled directly by increasing reserve-capacity-doubling from 0 to 1, the surplus xBZZ over the minimum required 10 xBZZ cannot be made withdrawable by simply reversing the reserve-capacity-doubling from 1 back to 0.

In this case, you will need to first send a very small staking transaction of a single PLUR while reserve-capacity-doubling is set to 1, and after that, change reserve-capacity-doubling from 1 to 0. This works because every time any amount of stake is added, it forces to staking contract to redo its calculations.

The detailed steps are:

1. Issue a staking transaction for 1 PLUR while reserve-capacity-doubling is set to 1.

   curl -X POST localhost:1633/stake/1
   

2. Stop node and set reserve-capacity-doubling to 0.
3. Restart node. The 10 xBZZ should now be withdrawable.

Section 3: Modification to /rchash endpoint

The /rchash endpoint can be used to generate a sample reserve hash and can be used for benchmarking a full node’s processor speed. Previously, the endpoint would allow for random anchor parameters. In Bee v2.3.0, this has been modified to require that the anchor parameters match the prefix bits of the node up to the node’s current storage depth.

In total, the /rchash endpoint has 3 parameters: storage depth, anchor_01, and anchor_02:

 /rchash/{depth}/{anchor_01}/{anchor_02}

The current depth of a node can be found from the /reservestate endpoint:

curl -sX GET http://localhost:1633/reservestate | jq

{
  "radius": 15,
  "storageRadius": 11,
  "commitment": 128332464128
}

The value for storageRadius is your node’s storage depth. Use this value as the depth parameter for /rchash.

For the two anchor values of anchor_01 and anchor_02, they must contain a prefix hex string that matches your own node’s bits up to the current storage depth. So for the current depth of 11, and with 4 bits represented by each hex digit, 3 hex digits is sufficient. We will use 4 just to make sure we are covered in the case of future depth increases. For a node with overlay address e59aa85b5899cd62d54bcd9bf511824883512f7151df196820c0e6d1a02d964b, we will use the first 4 hex digits of e59a:

curl -sX GET http://localhost:1633/rchash/11/e59a/e59a| jq

Conclusion

The reserve doubling feature introduced in the 2.3.0 update offers node operators tools for increasing the efficiency of their setup with minimal increase in overhead, improving the economic viability of running nodes. Node operators will have a new tool to optimize their nodes for both scalability and profitability. For more support and to stay up to date with all the latest Swarm news for node operators, make sure you’re in the node operator Discord channel and follow us on Twitter.