From 570230fa19282256e16b42f29392e02995e6e2b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20N=C3=BA=C3=B1ez?= Date: Thu, 12 Nov 2020 16:52:55 +0100 Subject: [PATCH] Remove docs for staking via preallocation contracts --- .../guides/network_node/staking_guide.rst | 74 ------------------- 1 file changed, 74 deletions(-) diff --git a/docs/source/guides/network_node/staking_guide.rst b/docs/source/guides/network_node/staking_guide.rst index 012c5d3bc..c0f34e7f3 100644 --- a/docs/source/guides/network_node/staking_guide.rst +++ b/docs/source/guides/network_node/staking_guide.rst @@ -540,80 +540,6 @@ staking compensation if you use a hardware wallet. .. note:: If you want to withdraw all tokens when all of them are unlocked - make sure to call ``nucypher stake mint`` first to ensure the last reward is included -Staking using a preallocation contract ---------------------------------------- - -Each NuCypher staker with a preallocation will have some amount of tokens locked -in a preallocation contract named ``PreallocationEscrow``, which is used to stake and -perform other staker-related operations. -From the perspective of the main NuCypher contracts, each ``PreallocationEscrow`` -contract represents a staker, no different from "regular" stakers. -However, from the perspective of the preallocation user, things are different -since the contract can't perform transactions, and it's the preallocation user -(also known as the "`beneficiary`" of the contract) -who has to perform staking operations. - -As part of the preallocation process, beneficiaries receive an allocation file, -containing the ETH addresses of their beneficiary account and corresponding -preallocation contract. - -In general, preallocation users can use all staking-related operations offered -by the CLI in the same way as described above, except that they have to specify -the path to the allocation file using the option ``--allocation-filepath PATH``. - -For example, to create a stake: - -.. code:: bash - - (nucypher)$ nucypher stake create --hw-wallet --allocation-filepath PATH - - -Or to bond a worker: - -.. code:: bash - - (nucypher)$ nucypher stake bond-worker --hw-wallet --allocation-filepath PATH - - -As an alternative to the ``--allocation-filepath`` flag, preallocation users -can directly specify their beneficiary and staking contract addresses with the -``--beneficiary-address ADDRESS`` and ``--staking-address ADDRESS``, respectively. - -Finally, note that collected staking rewards are always placed in the original -staking account, which for preallocation users is the staking contract. -Run the following command to view the balance of the ``PreallocationEscrow`` contract: - -.. code:: bash - - (nucypher)$ nucypher stake preallocation --status --allocation-filepath PATH - - -------------------------- Addresses --------------------------- - Staking contract: ... 0x0f4Ebe8a28a8eF33bEcD6A3782D74308FC35D021 - Beneficiary: ........ 0x4f5e87f833faF9a747463f7E4387a0d9323a3979 - - ------------------------ Locked Tokens ------------------------- - Initial locked amount: 35000 NU - Current locked amount: 35000 NU - Locked until: ........ 2020-12-31 16:33:37+00:00 - - ---------------------- NU and ETH Balance ---------------------- - NU balance: .......... 17.345 NU - Available: ....... 12.345 NU - ETH balance: ......... 0 ETH - - -To withdraw the unlocked tokens, you need to retrieve them from the -``PreallocationEscrow`` contract using the following command: - -.. code:: bash - - (nucypher)$ nucypher stake preallocation --withdraw-tokens --allocation-filepath PATH - - -.. note:: If you're a preallocation user, recall that you're using a contract to stake. - Replace ```` with the contract address when configuring your node. - If you don't know this address, you'll find it in the preallocation file. - One-Liners --------------