Nucypher
/
nucypher
mirror of https://github.com/nucypher/nucypher.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #1927 from KPrasch/master 

Deprecate aafigure
pull/1890/head
K Prasch 2020-04-23 13:37:37 -07:00 committed by GitHub
parent 06d978e63e e42e1e63a5
commit 7b11058827
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 20 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/requirements.txt
View File

@ -1,27 +1,17 @@
aafigure==0.6
alabaster==0.7.12
appdirs==1.4.3
Babel==2.8.0
certifi==2020.4.5.1
cfgv==3.1.0
chardet==3.0.4
commonmark==0.9.1
distlib==0.3.0
docutils==0.16
filelock==3.0.12
identify==1.4.14
idna==2.9
imagesize==1.2.0
importlib-metadata==1.6.0
Jinja2==2.11.2
MarkupSafe==1.1.1
nodeenv==1.3.5
packaging==20.3
pre-commit==2.3.0
Pygments==2.6.1
pyparsing==2.4.7
pytz==2019.3
PyYAML==5.3.1
recommonmark==0.6.0
requests==2.23.0
six==1.14.0
@ -34,7 +24,4 @@ sphinxcontrib-htmlhelp==1.0.3
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.4
toml==0.10.0
urllib3==1.25.9
virtualenv==20.0.18
zipp==3.1.0

40
docs/source/architecture/slashing.rst
View File

@ -58,9 +58,7 @@ To reinforce the algorithm, consider the following example stake and different s
* 3rd sub-stake = 100 tokens locked starting from the next period and locked for 5 periods. The 3rd sub-stake is locked for the next period but won't be used as a deposit for "work" until the next period begins.
* 200 tokens in an unlocked state (still staked, but can be freely withdrawn).
.. aafig::
:proportional:
:textual:
.. code::
stake
^
@ -76,7 +74,6 @@ To reinforce the algorithm, consider the following example stake and different s
| 1st |
| | period
+-----------------------------------+--->
Penalty Scenarios:
@ -103,10 +100,8 @@ Penalty Scenarios:
* 4rd sub-stake = 100 tokens for 1 period
* Remaining 0 tokens
.. aafig::
:proportional:
:textual:
.. code::
stake
^
|
@ -122,11 +117,10 @@ Penalty Scenarios:
| | period
+-----------------------------------+--->
stake
^
|
|
|
700- | - - +----+ - - - - - - - - - - - - -
| | 3rd|
600+-----+----+-------------+
@ -136,12 +130,11 @@ Penalty Scenarios:
| 1st |
| | period
+-----------------------------------+--->
stake
^
|
|
|
700- +-----+----+ - - - - - - - - - - - - -
| 4th | 3rd|
600+-----+----+-------------+
@ -164,9 +157,7 @@ Penalty Scenarios:
* 3rd sub-stake = 100 tokens locked starting from the next period
* Remaining 0 tokens
.. aafig::
:proportional:
:textual:
.. code::
stake
^
@ -196,7 +187,7 @@ Penalty Scenarios:
| 1st |
| | period
+-----------------------------------+--->
stake
^
@ -221,9 +212,7 @@ Penalty Scenarios:
* 3rd sub-stake = 0 tokens locked starting from the next period
* Remaining 0 tokens
.. aafig::
:proportional:
:textual:
.. code::
stake
^
@ -239,8 +228,7 @@ Penalty Scenarios:
| 1st |
| | period
+-----------------------------------+--->
stake
^
|
@ -251,8 +239,8 @@ Penalty Scenarios:
| 1st |
| | period
+-----------------------------------+--->
stake
^
|
@ -262,8 +250,8 @@ Penalty Scenarios:
| 1st |
| | period
+-----------------------------------+--->
stake
^
|

22
docs/source/architecture/sub_stakes.rst
View File

@ -38,9 +38,7 @@ To become a staker, NU tokens must be transferred to the ``StakingEscrow`` contr
A staker deposits 900 tokens:
* 1st sub-stake = 900 tokens starting from the next period and a locking duration of 5 periods
.. aafig::
:proportional:
:textual:
.. code::
stake
^
@ -66,9 +64,7 @@ In order to increase the staking reward, as well as the possibility of obtaining
- After:
* 1st sub-stake = 900 tokens with locking duration of 7 periods
.. aafig::
:proportional:
:textual:
.. code::
Before
@ -108,9 +104,7 @@ If necessary, stakers can extend the locking duration for only a portion of thei
* 1st sub-stake = 600 tokens with locking duration of 5 periods
* 2nd sub-stake = 300 tokens with locking duration of 7 periods
.. aafig::
:proportional:
:textual:
.. code::
Before
@ -178,9 +172,7 @@ However, when re-staking is enabled (default) then all staking rewards are re-lo
* 3rd sub-stake = 100 tokens locked starting from the next period and a locking duration of 5 periods
* 100 tokens in an unlocked state
.. aafig::
:proportional:
:textual:
.. code::
Before
@ -241,10 +233,8 @@ An enabled "winding down" parameter means that each call to ``confirmActivity()`
* 1st sub-stake = 400 tokens with locking duration of 7 periods
* 2nd sub-stake = 100 tokens locked starting from the current period and a locking duration of 4 future periods
.. aafig::
:proportional:
:textual:
.. code::
Current period
stake

4
docs/source/conf.py
View File

@ -46,12 +46,8 @@ extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.napoleon',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'aafigure.sphinxext',
'recommonmark',
]

1
setup.py
View File

@ -93,7 +93,6 @@ DOCS_REQUIRE = [
'sphinx',
'sphinx-autobuild',
'recommonmark',
'aafigure',
'sphinx_rtd_theme'
]