Commit Graph

505 Commits (b1da0270c9045cefc83afbfd9272194a92b6d977)

Author SHA1 Message Date
derekpierre b7100c411a Separate documentation for running eth nodes, and for running clef as an external transaction signer. 2020-05-28 17:29:58 -04:00
derekpierre 6816c7fae3 Document Ursula Status and Prometheus endpoints. 2020-05-28 17:29:58 -04:00
derekpierre f7110f5e53 Add order of precedence when evaluating values 2020-05-28 17:29:58 -04:00
derekpierre b9b8b9850c Document nucypher environment variables 2020-05-28 17:29:58 -04:00
derekpierre 2fcb0d0810 Use pathlib instead of os.path
Use loop for file/folder exclusions from command

Co-Authored-By: Kieran R. Prasch <kieranprasch@gmail.com>
2020-05-28 17:25:24 -04:00
derekpierre 3b4c566db1 Allow api files to be auto-generated on readthedocs via sphinx apidoc
Fix docs makefile clean to remove previously generated autodoc files
2020-05-28 17:25:21 -04:00
derekpierre 2e254485cb Reword obtaining of tokens since WorkLock is temporary 2020-05-28 17:24:02 -04:00
derekpierre fea8131ba1 Remove references to "CASI" and "[incentivized] testnet" 2020-05-28 17:24:02 -04:00
derekpierre af09d55a34 Respond to RFCs in #1945.
Co-Authored-By: MacLane S Wilkison <maclane@nucypher.com>
Co-Authored-By: Kieran R. Prasch <kieranprasch@gmail.com>
2020-05-28 17:24:02 -04:00
derekpierre 5ea7dc743b Cleanup of Gorli reference.
General cleanup
2020-05-28 17:24:02 -04:00
derekpierre 923013f289 Fix mainnet staking procedure wording. 2020-05-28 17:24:02 -04:00
derekpierre d6d4a47962 Modify examples to be based on mainnet settings and limit goerli, gemini, and other testnet specific references 2020-05-28 17:23:59 -04:00
derekpierre 4f5b6c6d36 Update clef URIs to use the "clef://" scheme prefix 2020-05-28 17:21:24 -04:00
derekpierre 8d7416dd6e Remove "Goerli testnet" from provider examples. Clarify currently allowed providers in FAQ 2020-05-28 17:21:24 -04:00
derekpierre 891a028b0d Add troubleshooting item regarding misconfiguration of signer as provider 2020-05-28 17:21:24 -04:00
Derek Pierre 5f988ddd9d
Merge pull request #2038 from arjunhassard/master
Slashing protocol documentation
2020-05-28 13:11:33 -04:00
arjunhassard c522402f3d kfrag_verify() update 2020-05-28 10:57:57 -06:00
arjunhassard 864a5eeba9 png -> svg 2020-05-28 10:23:14 -06:00
Arjun Hassard ec11b68a46
Apply suggestions from code review
Co-authored-by: MacLane S Wilkison <maclane@nucypher.com>
Co-authored-by: David Núñez <david@nucypher.com>
2020-05-28 10:09:20 -06:00
David Núñez 61ef1994e7 Bump version: 2.1.0-beta.8 → 2.1.0-beta.9 2020-05-28 02:25:45 +02:00
David Núñez c89b3c69ea Bump version: 2.1.0-beta.7 → 2.1.0-beta.8 2020-05-28 02:01:11 +02:00
Kieran Prasch f00584237a
Bump version: 2.1.0-beta.6 → 2.1.0-beta.7 2020-05-26 15:11:29 -07:00
Arjun Hassard 2e7646ca08
Fix max penalty leviable per period @derekpierre
Co-authored-by: Derek Pierre <derek.pierre@gmail.com>
2020-05-26 10:58:04 -06:00
arjunhassard d358ea8355 removed delegated token based punishments & other rewording 2020-05-26 10:55:03 -06:00
arjunhassard 0f297f4efb link to ethereum contracts and style change @derekpierre suggestion 2020-05-25 16:03:27 -06:00
Arjun Hassard 884509b211
Apply suggestions from code review
Co-authored-by: Derek Pierre <derek.pierre@gmail.com>
2020-05-25 13:51:30 -06:00
arjunhassard b74fe5b3bc correctness verification schematic 2020-05-25 13:20:43 -06:00
arjunhassard 90f307d21d fixed errors 2020-05-24 22:44:21 -06:00
arjunhassard e55fb50551 documentation for genesis slashing protocol inc. correctness verification protocol 2020-05-24 22:20:43 -06:00
derekpierre 668f25bc38 Add pre-commit hook to ensure that AGPL license is included in python source files 2020-05-22 08:55:06 -04:00
derekpierre c1d93d8941 Add "end-of-file-fixer" to pre-commit hooks 2020-05-19 14:28:29 -04:00
Harry Arjun Hassard dfb9e11a33 1st attempt at clarifying universal fee range and limited service-provider control over their acceptable fee rates 2020-05-13 17:56:33 -07:00
Victoria 7b7198ef79 Apply suggestions from code review #1959
Co-authored-by: Derek Pierre <derek.pierre@gmail.com>
Co-authored-by: MacLane S Wilkison <maclane@nucypher.com>
2020-05-13 23:09:50 +03:00
vzotova 66ac1acb1d Rename detach-worker -> unbond-worker 2020-05-13 20:21:53 +03:00
vzotova c228c388c3 Rename `set worker` to `bond worker` everywhere 2020-05-13 20:21:53 +03:00
vzotova 4a0b79b2ca StakingEscrow: confirmActivity -> commitToNextPeriod, lastActivePeriod -> lastCommittedPeriod 2020-05-13 20:21:52 +03:00
vzotova 6039002408 Rename policy reward to policy fee 2020-05-13 20:21:51 +03:00
Kieran Prasch 5d80b5166e
Bump version: 2.1.0-beta.5 → 2.1.0-beta.6 2020-05-08 10:02:31 -07:00
Kieran Prasch 767b205983
Bump version: 2.1.0-beta.4 → 2.1.0-beta.5 2020-05-04 08:55:21 -07:00
Kieran Prasch 69fd86f965
remove pre-commit hook for pushing to master to allow for bumpversion to do its thing. 2020-05-04 08:55:04 -07:00
derekpierre f54dca70e8 Random update to docs: update link to node providers, building docs 2020-04-30 10:33:09 -04:00
David Núñez cb390b81f1
Merge pull request #1934 from cygnusv/rinkeby
Adapt `nucypher-deploy` to Clef+Infura. New IBEX testnet 🐐
2020-04-29 18:01:39 +02:00
David Núñez 1610921623
Rewording of Clef guide
Co-Authored-By: Derek Pierre <derek.pierre@gmail.com>
2020-04-28 22:42:50 +02:00
K Prasch 888deffe1f
Apply suggestions from code review
Co-Authored-By: Derek Pierre <derek.pierre@gmail.com>
2020-04-28 13:08:38 -07:00
K Prasch c448198b4b
Apply suggestions from code review 2020-04-28 10:07:34 -07:00
derekpierre 25e019c0f0 Random fixes for PR #1932 as we transition the remaining md files to rst 2020-04-28 12:56:57 -04:00
David Núñez cb1a164cac Docs: using a ruleset file for Clef 2020-04-28 05:12:07 +02:00
Kieran Prasch 38056c681d
Respond to RFCs in PR #1932 2020-04-27 19:22:34 -07:00
Kieran Prasch 6f1e1b39b0
Cleanup APIdoc TOCs 2020-04-27 19:22:34 -07:00
Kieran Prasch 414da104d4
Configure apidoc templates. 2020-04-27 19:22:34 -07:00
Kieran Prasch 5045b93262
Keep modules.rst lingering fpr git tracking 2020-04-27 19:22:34 -07:00
Kieran R. Prasch 2b601f55a9
Reconfigure sphinx; Remove unused extensions. 2020-04-27 19:21:11 -07:00
Kieran R. Prasch 7da1d0ee3c
Convert all documentation to RST 2020-04-27 19:21:11 -07:00
Kieran R. Prasch 546578197d
Remove manual API doc toctrees 2020-04-27 19:21:11 -07:00
Kieran R. Prasch 27d8e9557b Bump version: 2.1.0-beta.2 → 2.1.0-beta.3 2020-04-24 17:24:51 -07:00
Kieran Prasch 3982a05483
Top off initial steps for pre-commit intro. 2020-04-23 17:23:43 -07:00
Kieran Prasch 785a07c17b
Goodbye aafigure. 2020-04-23 13:15:38 -07:00
Kieran Prasch c3e0d763f1
Relock deps; Extricate documentation requirements. 2020-04-23 11:00:00 -07:00
derekpierre fbc96227e2 Split WorkLock Guide into an architecture document and the remaining CLI guide. 2020-04-21 15:20:28 -04:00
derekpierre d11a94782c Reinforce that the WorkLock properties specified for the scenarios are hypothetical. 2020-04-21 09:31:23 -04:00
derekpierre 6eee89e9b2 Remove "most probably that's what you need" from provider uri example 2020-04-21 09:02:07 -04:00
derekpierre 7e4420d4bc Final cleanup of WorkLock doc - ensure consistency of terms used 2020-04-20 14:38:01 -04:00
Derek Pierre 4430edee00
Apply suggestions from code review for #1892
Co-Authored-By: MacLane S Wilkison <maclane@nucypher.com>
2020-04-20 13:39:35 -04:00
derekpierre 7da674f418 Respond to RFCs from PR #1892.
Co-authored-by: vzotova <vikki.zta@gmail.com>
2020-04-20 13:27:07 -04:00
derekpierre af7ca0c2c5 Modify worklock output for bidder depending on whether tokens have been already claimed or not
Cleanup output of refunds
Update docs to reflect updated output
Add tests for base deposit and refund rate methods added to WorkLockAgent
2020-04-20 11:52:11 -04:00
derekpierre 13fcc479ff Clarify values displayed when worklock `status` CLI command is used
Rethink how boosting refund / slowing refund is displayed - simply display them as a refund rate multiple
2020-04-17 16:51:22 -04:00
derekpierre 88807d90c8 Add `math` directive to make calculations and fractions clearer. 2020-04-17 13:58:19 -04:00
derekpierre cc7af27a71 Initial musings about a write-up for WorkLock v4 including hypothetical scenarios. 2020-04-17 13:58:19 -04:00
David Núñez 50fb513043
Merge pull request #1887 from mswilkison/staking-as-a-service
Add list of node-as-a-service providers
2020-04-16 22:47:42 +02:00
MacLane Wilkison c456122019 Add list of node as a service providers 2020-04-15 08:11:26 -07:00
David Núñez b9f8440a04
Merge pull request #1865 from cygnusv/no-secrets
Remove deployment secrets
2020-04-15 00:38:25 +02:00
David Núñez 120e66fbcf Remove --poa flag from docs, as it's not needed by default 2020-04-10 15:26:40 +02:00
David Núñez e1dc124317 Adapt everything else to no secrets: deployers, tests, CLI, docs, etc 2020-04-09 17:59:56 +02:00
K Prasch 0c6d08b6b8
Merge pull request #1856 from derekpierre/sphinx-update
Enable docs to build with latest version of sphinx
2020-04-07 20:17:23 -07:00
derekpierre 0264351abc Enable docs to build with latest version of sphinx. Recomoonmark needed to be specified differently in the configuration 2020-04-07 10:16:02 -04:00
Kieran Prasch 2da817ae1a
Bump version: 2.1.0-beta.1 → 2.1.0-beta.2 2020-04-06 13:59:30 -07:00
djskinner 5d1c995948
Remove <YOUR STAKER ADDRESS>
Since --staker-address is no loner required it does not refer to anything
2020-04-04 08:37:24 +01:00
K Prasch 0b3865d09d
Merge pull request #1815 from KPrasch/signer
External signer documentation for staking CLI
2020-04-03 09:31:57 -07:00
Kieran Prasch a31dc30ec2
Bump version: 2.0.0-beta.11 → 2.1.0-beta.0 2020-04-01 18:24:54 -07:00
David Núñez 6a0c2a4379 Change some missing cassandras to gemini 2020-04-02 02:32:18 +02:00
Kieran Prasch d4b5e164ac
Mention the usage of --hw-wallet in tandem with clef. 2020-04-01 16:30:48 -07:00
derekpierre 610357a3fa Update link 2-phase economics documement 2020-04-01 13:51:45 -04:00
K Prasch 728a001c97
Apply suggestions from code review
Co-Authored-By: Derek Pierre <derek.pierre@gmail.com>
2020-04-01 10:22:20 -07:00
Kieran Prasch 1d26d3a12e
Be a bit more precise when using 'on' a wallet. 2020-03-31 14:19:54 -07:00
K Prasch 7b3013ae2d
Merge pull request #1806 from derekpierre/ravital-faq-edits
Documentation/FAQ Edits
2020-03-31 14:14:54 -07:00
Kieran Prasch 299f29e565
Respond to RFCs in PR #1815; Further describe internal v external signers in the scope of staking. 2020-03-31 13:55:03 -07:00
Kieran Prasch a0368606b0
Moe generalized guidance regarding local v. remote ethereum nodes for staking. 2020-03-31 13:23:45 -07:00
Kieran Prasch 5d15641566
Second pass on external clef signer docs embedded in staking guide. 2020-03-31 12:50:51 -07:00
Kieran Prasch a2fc72fb5f
Drafting eternal signer and clef documentation. 2020-03-27 15:28:19 -07:00
Igor Line 7375473ded
Remove staker address flag from ursula init
Related to 891dd04d2a (diff-9baeffadd2f996b1479a4332a067fa0d)
2020-03-27 22:25:40 +01:00
derekpierre 85d18a5716 Expand 'ms' to 'milliseconds' 2020-03-27 14:12:50 -04:00
derekpierre cf18ba8af9 Add Arj's two-phase minting" paper to the economics section of the docs home page 2020-03-27 14:12:50 -04:00
Derek Pierre c3b41708c9 Apply suggestions from code review for #1806
Co-Authored-By: MacLane S Wilkison <maclane@nucypher.com>
2020-03-27 14:12:50 -04:00
derekpierre fe5b6b236d Additional FAQ questions from #829 2020-03-27 14:12:50 -04:00
derekpierre 6844b2318e Slight re-organization of questions based on "General", "Using the Network", and "Running a Node" sections. 2020-03-27 14:12:50 -04:00
derekpierre abac0e2bee Add missing `--poa` issue to troubleshooting page. 2020-03-27 14:12:50 -04:00
derekpierre c255fb5b97 Cleanup suggestions from #1781 - fix header and link to Character Concepts
Change "cassnadra" to "gemini" for new incentivized testnet network name
2020-03-27 14:12:50 -04:00
K Prasch 8783f5bd62
Merge pull request #1781 from nucypher/ravital-faq
Documentation - Update FAQ support
2020-03-27 09:27:48 -07:00
Derek Pierre 034969b5c8
Apply suggestions from code review for #1781
Co-Authored-By: Arjun Hassard <arjunhassard@gmail.com>
2020-03-26 09:23:10 -04:00
Kieran Prasch b575211293
Bump version: 2.0.0-beta.10 → 2.0.0-beta.11 2020-03-25 09:45:33 -07:00
Kieran Prasch 35c47ce57a
Bump version: 2.0.0-beta.9 → 2.0.0-beta.10 2020-03-24 12:34:24 -07:00
Kieran Prasch f60735afad
Use tertiary heading for linkable FAQ questions. 2020-03-24 10:25:15 -07:00
David Núñez cd67f5e55f Apply suggestions from code review
Co-Authored-By: Derek Pierre <derek.pierre@gmail.com>
Co-Authored-By: K Prasch <kieranprasch@gmail.com>
2020-03-23 17:58:54 +01:00
David Núñez 62f54d9b75 Update WorkLock guide to latest distribution model and commands 2020-03-22 16:32:05 +01:00
ravital cf008b29d1
Update faq.rst 2020-03-19 14:26:06 -07:00
ravital 2e2fafe20f
Update faq.rst 2020-03-19 14:01:52 -07:00
ravital 289b82db51
Documentation - Update FAQ support 2020-03-19 13:27:20 -07:00
Kieran Prasch c8b781c738
Bump version: 2.0.0-beta.8 → 2.0.0-beta.9 2020-03-19 10:25:25 -07:00
K Prasch 280874b47b
Merge pull request #1757 from alinaloseva/patch-1
Add refund command description to worklock guide
2020-03-12 11:07:25 -07:00
Kieran Prasch 489c048712
KeyStore -> Datastore 2020-03-09 14:50:18 -07:00
David Núñez afa4fe83bd Bump version: 2.0.0-beta.7 → 2.0.0-beta.8 2020-03-05 16:18:33 +01:00
David Núñez ae221701ea Touches to the documentation on publishing a new release 2020-03-05 16:17:15 +01:00
alinaloseva 0b3ed5461e
Fix title underline length 2020-03-03 23:04:40 +01:00
alinaloseva fb59768e49
Add refund command description to worklock guide 2020-03-03 17:25:58 +01:00
David Núñez d7c42495b7 Bump version: 2.0.0-beta.6 → 2.0.0-beta.7 2020-02-27 16:43:59 -08:00
K Prasch da8a8eec94
Merge pull request #1731 from derekpierre/docs-layout
Reorganize Docs Layout
2020-02-23 17:53:50 -07:00
K Prasch 733fce8bcb
Merge pull request #1728 from derekpierre/docs-blitz
Documentation Blitz
2020-02-23 17:53:29 -07:00
Derek Pierre 68904d2503 Update spelling 2020-02-21 20:20:37 -05:00
jMyles 02b6521dc6 Some revisions which may or may not be useful. 2020-02-21 20:20:37 -05:00
Derek Pierre a90e12d809 Respond to RFCs for #1731
Co-Authored-By: MacLane S Wilkison <maclane@nucypher.com>
2020-02-21 20:20:37 -05:00
derekpierre 09d93035e0 Reorganize our doc's table of contents - hopefully, this makes the docs a bit easier to follow.
Categorize guides by running a node vs application development
Add a blurb about WorkLock
Utilize rst reference linking where applicable to reduce URL issues when pages are moved/renamed
Remove 'NuCypher' from page titles since it is redundant
2020-02-21 20:20:37 -05:00
derekpierre a7aba21037 Respond to RFCs in #1728. 2020-02-21 20:08:05 -05:00
derekpierre b7a24d71cc A gamut of docs updates. 2020-02-20 16:46:59 -05:00
jMyles 2a7883e080 Bump version: 2.0.0-beta.5 → 2.0.0-beta.6 2020-02-20 10:03:24 -07:00
derekpierre b862db20db Add FAQ item about checking `nucypher status stakers` settings
General cleanup
2020-02-19 17:02:03 -05:00
derekpierre 19bff9cf59 Updates to FAQ and Troubleshooting docs. 2020-02-19 15:39:57 -05:00
jMyles e296785867 Bump version: 2.0.0-beta.4 → 2.0.0-beta.5 2020-02-13 17:07:25 -07:00
Kieran R. Prasch c46ff3f28b Bump version: 2.0.0-beta.3 → 2.0.0-beta.4 2020-02-13 12:40:41 -07:00
David Núñez d128069abc Apply suggestions from code review
Co-Authored-By: Derek Pierre <derek.pierre@gmail.com>
2020-02-13 11:19:55 -07:00
David Núñez f2989880d0 Add WorkLock guide to the docs ToC 2020-02-13 11:19:55 -07:00
David Núñez 1a1d7f5289 Fix account selection problems in `nucypher worklock` and successful claim output 2020-02-13 11:19:55 -07:00
David Núñez 232a171506 Skeleton for WorkLock guide 2020-02-13 11:19:55 -07:00
wjdfx 4f29224cb4
Update staking_guide.rst 2020-02-12 20:03:39 +08:00
Kieran R. Prasch b61ad503af Bump version: 2.0.0-beta.2 → 2.0.0-beta.3 2020-02-03 13:55:04 -08:00
MacLane S Wilkison 5eaa3dc698
Merge pull request #1639 from derekpierre/support-docs
Initial Support docs
2020-02-03 14:08:56 -05:00
derekpierre e069bd8c35 Fixed Geth capitalization. 2020-02-03 10:41:27 -05:00
derekpierre 792237f55f Changed label of configuration guide link. 2020-02-03 10:11:44 -05:00
Kieran R. Prasch 232cbc7f40 Docker Installation docs formatting and syntax fixes..
(cherry picked from commit 0cc7742b5fc4245c05c21336d42082d68437a923)
2020-02-03 10:08:50 -05:00
derekpierre 1ebbb1721a Respond to RFCs in #1639 2020-02-03 10:07:18 -05:00
Derek Pierre 09dcc2b933 Apply suggestions from code review for #1639
Co-Authored-By: K Prasch <kieranprasch@gmail.com>
Co-Authored-By: damon c <gdamon@gmail.com>
Co-Authored-By: Arjun Hassard <arjunhassard@gmail.com>
Co-Authored-By: Arjun Hassard <arjunhassard@gmail.com>
2020-02-03 10:07:18 -05:00
derekpierre 8e11bcbf4b Response to RFCs in #1639 2020-02-03 10:07:18 -05:00
Derek Pierre 01efdbceb7 Apply suggestions from #1639
Co-Authored-By: David Núñez <david@nucypher.com>
2020-02-03 10:07:18 -05:00
derekpierre c3782d02be Respond to comments in #1639. 2020-02-03 10:07:18 -05:00
Derek Pierre e3da0fe1a6 Apply suggestions from code review #1639
Co-Authored-By: MacLane S Wilkison <maclane@nucypher.com>
2020-02-03 10:07:18 -05:00
derekpierre b19d7cbacd Add image to community page. 2020-02-03 10:07:18 -05:00
derekpierre 2b52af339f Initial Support docs that includes Community Resources, Troubleshooting and FAQ pages. 2020-02-03 10:07:18 -05:00
Petabyte2020 cda57f4a35
update command from apt to apt-get 2020-02-01 21:28:12 -08:00
David Núñez 33bf49757c
Merge pull request #1631 from rk-p2p/patch-1
Update installation_guide.md
2020-01-30 12:22:15 +00:00
Kieran R. Prasch e945964adf Bump version: 2.0.0-beta.1 → 2.0.0-beta.2 2020-01-29 15:09:33 -08:00
Ruslan Khanenko 65841ab944
Update installation_guide.md 2020-01-29 19:07:03 +05:00