diff --git a/docs/source/architecture/service_fees.rst b/docs/source/architecture/service_fees.rst index c8bea6c9f..ce433a6cb 100644 --- a/docs/source/architecture/service_fees.rst +++ b/docs/source/architecture/service_fees.rst @@ -55,6 +55,10 @@ Given its high enforceability, the presence of an inflexible fee range dictating The Pricing Protocol & Economics paper_ serves as a resource for community debate, proposals for modification, and DAO-driven upgrades/redeployments in the future. The paper discusses the merits and risks of quasi-universal pricing and the enforcement of an upper and lower bound on all offered price points. It introduces a price point analysis from a demand-side, service-side and theoretical standpoint to produce the provisional constraints in absolute terms that the network will launch with (above). +.. note:: + + This Pricing Protocol & Economics paper was originally written when period lengths were 24 hours; period lengths are now 7 days but the core principles still apply. + Setting a discretionary fee rate -------------------------------- diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst index 9dc03daf2..5f8664d4e 100644 --- a/docs/source/glossary.rst +++ b/docs/source/glossary.rst @@ -48,7 +48,7 @@ Glossary 1 NU = 10\ :sup:`18` NuNits. Period - A timeframe of approximately a day in the NuCypher Network. + A timeframe of approximately 7 days in the NuCypher Network. PKE Public-key encryption. diff --git a/docs/source/references/network_events.rst b/docs/source/references/network_events.rst index 0634dae3c..84d03003b 100644 --- a/docs/source/references/network_events.rst +++ b/docs/source/references/network_events.rst @@ -37,10 +37,10 @@ For example, to view the staking rewards received by all Stakers in the current --------- StakingEscrow Events --------- Minted: - - (EventRecord) staker: , period: 18681, value: 1234567890123456789012, block_number: 11916689 - - (EventRecord) staker: , period: 18681, value: 1234567890123456789012, block_number: 11916692 - - (EventRecord) staker: , period: 18681, value: 1234567890123456789012, block_number: 11916692 - - (EventRecord) staker: , period: 18681, value: 1234567890123456789012, block_number: 11916692 + - (EventRecord) staker: , period: 2668, value: 1234567890123456789012, block_number: 11916689 + - (EventRecord) staker: , period: 2668, value: 1234567890123456789012, block_number: 11916692 + - (EventRecord) staker: , period: 2668, value: 1234567890123456789012, block_number: 11916692 + - (EventRecord) staker: , period: 2668, value: 1234567890123456789012, block_number: 11916692 ... The value ``1234567890123456789012`` is in NuNits and equates to approximately 1234.57 NU (1 NU = 10\ :sup:`18` NuNits). @@ -58,10 +58,10 @@ To view the staking rewards received by all Stakers from block number ``11916685 --------- StakingEscrow Events --------- Minted: - - (EventRecord) staker: , period: 18681, value: 1234567890123456789012, block_number: 11916687 - - (EventRecord) staker: , period: 18681, value: 1234567890123456789012, block_number: 11916687 - - (EventRecord) staker: , period: 18681, value: 1234567890123456789012, block_number: 11916687 - - (EventRecord) staker: , period: 18681, value: 1234567890123456789012, block_number: 11916687 + - (EventRecord) staker: , period: 2668, value: 1234567890123456789012, block_number: 11916687 + - (EventRecord) staker: , period: 2668, value: 1234567890123456789012, block_number: 11916687 + - (EventRecord) staker: , period: 2668, value: 1234567890123456789012, block_number: 11916687 + - (EventRecord) staker: , period: 2668, value: 1234567890123456789012, block_number: 11916687 ... @@ -106,10 +106,10 @@ For example, to view all of the commitments ever made by the Worker associated w --------- StakingEscrow Events --------- CommitmentMade: - - (EventRecord) staker: , period: 18551, value: 1234567890123456789012, block_number: 11057641 - - (EventRecord) staker: , period: 18552, value: 1234567890123456789012, block_number: 11063640 - - (EventRecord) staker: , period: 18553, value: 1234567890123456789012, block_number: 11070103 - - (EventRecord) staker: , period: 18554, value: 1234567890123456789012, block_number: 11076964 + - (EventRecord) staker: , period: 2650, value: 1234567890123456789012, block_number: 11057641 + - (EventRecord) staker: , period: 2650, value: 1234567890123456789012, block_number: 11063640 + - (EventRecord) staker: , period: 2650, value: 1234567890123456789012, block_number: 11070103 + - (EventRecord) staker: , period: 2650, value: 1234567890123456789012, block_number: 11076964 ... To view the commitment made by the Worker associated with a specific Staker in period 18552, run: @@ -124,7 +124,7 @@ To view the commitment made by the Worker associated with a specific Staker in p --------- StakingEscrow Events --------- CommitmentMade: - - (EventRecord) staker: , period: 18552, value: 1234567890123456789012, block_number: 11063640 + - (EventRecord) staker: , period: 2650, value: 1234567890123456789012, block_number: 11063640 CSV Output diff --git a/docs/source/staking/remote_worker_cli.rst b/docs/source/staking/remote_worker_cli.rst index cd86f9206..a2730f11c 100644 --- a/docs/source/staking/remote_worker_cli.rst +++ b/docs/source/staking/remote_worker_cli.rst @@ -96,7 +96,7 @@ Some examples: > worker address: 0xe88bF385a6ed8C86aA153f08F999d8698B5326e0 > rest url: https://xxx.xxx.xxx.xxx:9151 > missing commitments: 0 - > last committed period: 18601 + > last committed period: 2657 > ETH: 0.xxx > provider: https://mainnet.infura.io/v3/xxxx > ursula docker image: "nucypher/nucypher:latest" diff --git a/docs/source/staking/stake_initialization.rst b/docs/source/staking/stake_initialization.rst index 274911038..ca634de09 100644 --- a/docs/source/staking/stake_initialization.rst +++ b/docs/source/staking/stake_initialization.rst @@ -165,16 +165,16 @@ the commitment period. Select index of staking account [0]: 1 Selected 1: 0x270b3f8af5ba2B79ea3Bd6a6Efc7ecAB056d3E3f Enter stake value in NU (15000 NU - 30000 NU) [30000]: 30000 - Enter stake duration (30 - 47103) [365]: 30 + Enter stake duration (4 - 44155) [52]: 4 ══════════════════════════════ STAGED STAKE ══════════════════════════════ Staking address: 0x270b3f8af5ba2B79ea3Bd6a6Efc7ecAB056d3E3f ~ Chain -> ID # ~ Value -> 30000 NU (30000000000000000000000 NuNits) - ~ Duration -> 30 Days (30 Periods) - ~ Enactment -> Jun 19 20:00 EDT (period #18433) - ~ Expiration -> Jul 19 20:00 EDT (period #18463) + ~ Duration -> 28 Days (4 Periods) + ~ Enactment -> Jun 19 20:00 EDT (period #2633) + ~ Expiration -> Jul 17 20:00 EDT (period #2637) ═════════════════════════════════════════════════════════════════════════ @@ -187,7 +187,7 @@ the commitment period. - You are obligated to maintain a networked and available Ursula-Worker node bonded to the staker address 0x270b3f8af5ba2B79ea3Bd6a6Efc7ecAB056d3E3f for the duration - of the stake(s) (30 periods). + of the stake(s) (4 periods). - Agree to allow NuCypher network users to carry out uninterrupted re-encryption work orders at-will without interference. @@ -228,7 +228,7 @@ Once you have created one or more stakes, you can view all active stakes for con ╒═══════╤══════════╤═════════════╤═════════════╤═══════════════╕ │ Idx │ Value │ Remaining │ Enactment │ Termination │ ╞═══════╪══════════╪═════════════╪═════════════╪═══════════════╡ - │ 0 │ 30000 NU │ 31 │ Jun 19 2020 │ Jul 19 2020 │ + │ 0 │ 30000 NU │ 5 │ Jun 19 2020 │ Jul 17 2020 │ ╘═══════╧══════════╧═════════════╧═════════════╧═══════════════╛ If the Worker in the list is shown as ``NO_WORKER_BONDED``, it means that you haven't yet diff --git a/docs/source/staking/stake_management.rst b/docs/source/staking/stake_management.rst index c96cebe6d..dfe0dcb63 100644 --- a/docs/source/staking/stake_management.rst +++ b/docs/source/staking/stake_management.rst @@ -121,12 +121,12 @@ To divide an existing stake: Select Stake: 0 Enter target value (15000 NU - 16437.841006996376688377 NU): 15000 - Enter number of periods to extend: 20 + Enter number of periods to extend: 4 ══════════════════════════════ ORIGINAL STAKE ════════════════════════════ Staking address: 0x270b3f8af5ba2B79ea3Bd6a6Efc7ecAB056d3E3f - ~ Original Stake: | - | 0x270b | 0x45D3 | 0 | 31437.841006996376688377 NU | 33 periods . | Jun 19 20:00 EDT - Jul 22 20:00 EDT + ~ Original Stake: | - | 0x270b | 0x45D3 | 0 | 31437.841006996376688377 NU | 4 periods . | Jun 19 20:00 EDT - Jul 17 20:00 EDT ══════════════════════════════ STAGED STAKE ══════════════════════════════ @@ -134,9 +134,9 @@ To divide an existing stake: Staking address: 0x270b3f8af5ba2B79ea3Bd6a6Efc7ecAB056d3E3f ~ Chain -> ID # 4 | Rinkeby ~ Value -> 15000 NU (15000000000000000000000 NuNits) - ~ Duration -> 53 Days (53 Periods) - ~ Enactment -> Jun 19 20:00 EDT (period #18433) - ~ Expiration -> Aug 11 20:00 EDT (period #18486) + ~ Duration -> 56 Days (8 Periods) + ~ Enactment -> Jun 19 20:00 EDT (period #2633) + ~ Expiration -> Aug 12 20:00 EDT (period #2641) ═════════════════════════════════════════════════════════════════════════ Publish stake division to the blockchain? [y/N]: y @@ -162,9 +162,9 @@ To divide an existing stake: ╒═══════╤═════════════════════════════╤═════════════╤═════════════╤═══════════════╕ │ Idx │ Value │ Remaining │ Enactment │ Termination │ ╞═══════╪═════════════════════════════╪═════════════╪═════════════╪═══════════════╡ - │ 0 │ 16437.841006996376688377 NU │ 31 │ Jun 19 2020 │ Jul 22 2020 │ + │ 0 │ 16437.841006996376688377 NU │ 5 │ Jun 19 2020 │ Jul 17 2020 │ ├───────┼─────────────────────────────┼─────────────┼─────────────┼───────────────┤ - │ 1 │ 15000 NU │ 51 │ Jun 19 2020 │ Aug 11 2020 │ + │ 1 │ 15000 NU │ 9 │ Jun 19 2020 │ Aug 12 2020 │ ╘═══════╧═════════════════════════════╧═════════════╧═════════════╧═══════════════╛ @@ -210,9 +210,9 @@ and will be indicated by the ``INACTIVE`` status label. ╒═══════╤═══════════════╤═════════════╤═════════════╤═══════════════╤═══════════╕ │ Idx │ Value │ Remaining │ Enactment │ Termination │ Status │ ╞═══════╪═══════════════╪═════════════╪═════════════╪═══════════════╪═══════════╡ - │ 0 │ 123456.789 NU │ -4 │ Oct 15 2020 │ Nov 19 2020 │ INACTIVE │ + │ 0 │ 123456.789 NU │ -1 │ Oct 15 2020 │ Nov 29 2020 │ INACTIVE │ ├───────┼───────────────┼─────────────┼─────────────┼───────────────┼───────────┤ - │ 1 │ 123456.789 NU │ 27 │ Oct 15 2020 │ Dec 20 2020 │ DIVISIBLE │ + │ 1 │ 123456.789 NU │ 3 │ Oct 15 2020 │ Dec 14 2020 │ DIVISIBLE │ ├───────┼───────────────┼─────────────┼─────────────┼───────────────┼───────────┤ @@ -312,8 +312,8 @@ For example, to view all of the staking rewards received by the Staker thus far, --------- StakingEscrow Events --------- Minted: - - (EventRecord) staker: , period: 18551, value: 1234567890123456789012, block_number: 11070103 - - (EventRecord) staker: , period: 18552, value: 1234567890123456789012, block_number: 11076964 + - (EventRecord) staker: , period: 2650, value: 1234567890123456789012, block_number: 11070103 + - (EventRecord) staker: , period: 2650, value: 1234567890123456789012, block_number: 11076964 ... ``1234567890123456789012`` is in NuNits and equates to approximately 1234.57 NU (1 NU = 10\ :sup:`18` NuNits). @@ -331,8 +331,8 @@ To view staking rewards received by the Staker from block number 11070000 to blo --------- StakingEscrow Events --------- Minted: - - (EventRecord) staker: , period: 18551, value: 1234567890123456789012, block_number: 11070103 - - (EventRecord) staker: , period: 18552, value: 1234567890123456789012, block_number: 11076964 + - (EventRecord) staker: , period: 2650, value: 1234567890123456789012, block_number: 11070103 + - (EventRecord) staker: , period: 2650, value: 1234567890123456789012, block_number: 11076964 ...