Commit Graph

837 Commits (8e40988fa2e7729b4e20ad7cff5922715bbc51dc)

Author SHA1 Message Date
vzotova ecac8017ed Removes PolicyManager and StakingInterface 2022-02-09 14:24:26 +03:00
derekpierre b46432ab6d Purge Aragon/NuCypher DAO specific code. 2022-02-08 15:13:51 -05:00
Kieran Prasch 62291021ba Respond to RFCs for PR #2857 Pt. II 2022-02-08 11:04:34 -08:00
derekpierre d7dadbc929 Update Porter docs. 2022-02-08 11:04:27 -08:00
Kieran Prasch 3f6c770f02 Includes payment method CLI flags in Ursula docs. 2022-02-08 11:01:24 -08:00
derekpierre 46748a5dac Improve wording of a few labels.
Co-authored-by: K Prasch <kieranprasch@gmail.com>
2021-12-14 14:21:20 -05:00
Derek Pierre daa6693306
Apply RFCs from #2833
Co-authored-by: Arjun Hassard <arjunhassard@gmail.com>
2021-12-13 13:43:58 -05:00
derekpierre 8d867d0311 Update documentation to accomodate new treasure map con kFrags dynamic. Remove references to Ursulas storing kFrags and Arrangements. 2021-12-09 16:20:21 -05:00
derekpierre 9f2775c001 Update NuCypher process diagrams to account for TMapConKFrags paradigm. 2021-12-09 14:13:46 -05:00
Kieran R. Prasch 7cefdf9f91 Bump version: 5.3.2 → 5.3.3 2021-11-24 12:55:15 -08:00
derekpierre f6b429c195 Add release notes for 5.3.2. 2021-10-19 15:49:35 -04:00
Kieran Prasch 04edeff0aa Bump version: 5.3.1 → 5.3.2 2021-10-18 09:38:18 -04:00
Bogdan Opanchuk ef0e619684 Bundle policy encrypting key with TreasureMap 2021-10-15 15:19:19 -07:00
derekpierre 21212653f9 Allow more flexibility for CORS origins to be specified. CLI takes a comma-separated list, that can include regexes, and Porter with NGINX can configure conditionals for allowing origins. 2021-10-13 13:13:52 -04:00
derekpierre 801a68fd32 Add docs for porter usage with nginx reverse proxy. 2021-10-08 11:32:47 -04:00
derekpierre 1edfd50522 RFC for #2768 - update documentation. 2021-09-17 13:02:13 -04:00
derekpierre a653751d13 Document cleanup regarding retrieval results format, and improve testing for mutliple retrieval kits. 2021-09-17 11:12:48 -04:00
derekpierre 8ff0932b1d Add documentation about retrieval kit parameter expected format. 2021-09-16 15:09:21 -04:00
derekpierre 2434fe093d Update Bob character control docs, and newsfragment. 2021-09-14 15:58:08 -04:00
derekpierre 90408c1768 Publisher verifying key is no longer an argument for RetrievalClient - remove usage from Porter. 2021-09-14 15:58:08 -04:00
derekpierre 27fe5daf7d Deserialization of MessageKit field now produces a MessageKit object instead of bytes.
Minor update to Porter docs for retrieval endpoint.
2021-09-14 15:58:08 -04:00
derekpierre dfa65a2976 Code cleanup after rebase over retrieval protocol work in #2730. 2021-09-14 15:58:08 -04:00
derekpierre c5d62ba771 Replace exec_work_order docs with retrieve_cfrags. 2021-09-14 15:58:08 -04:00
Bogdan Opanchuk 66175a04da Rename Bob.retrieve_cfrags()/retrieve() to avoid confusion with RetrievalClient.retrieve_cfrags() 2021-09-08 08:21:04 -07:00
Bogdan Opanchuk da816586fa Remove "enrico" as a parameter to Bob.retrieve(); make "policy_encrypting_key" mandatory. 2021-09-08 08:21:04 -07:00
Bogdan Opanchuk 0f85435ac7 Require encrypted_treasure_map in retrieve() 2021-09-08 08:21:04 -07:00
Bogdan Opanchuk 5632d523c4 Minor RFCs 2021-09-08 08:21:04 -07:00
Bogdan Opanchuk a338ff1a69 Don't return the signature along with the MessageKit from MessageKit.author() 2021-09-07 11:58:55 -07:00
Bogdan Opanchuk 17353ddf55 Fix some remainders of `m` and `n` 2021-09-07 11:58:55 -07:00
Kieran R. Prasch a3f8df66fc RFCs for PR #2780 pt. II 2021-08-25 12:08:35 -07:00
Bogdan Opanchuk 6164137610 Rename m -> threshold, num_kfrags -> shares 2021-08-20 19:26:56 -04:00
Bogdan Opanchuk 5b5cd4bd84 Use HRAC as treasure map ID at all times instead of just in the blockchain case 2021-08-19 17:06:45 -04:00
KPrasch 79631124b5
Merge pull request #2771 from derekpierre/aug12-hotfix
Include changes and release notes from v5.3.1 hotfix in `main`
2021-08-17 15:47:32 -07:00
Derek Pierre 3b61f2172b
Merge pull request #2776 from derekpierre/period-commitment-docs
Add a section to the docs about how period commitment works.
2021-08-17 15:23:28 -04:00
derekpierre e66aa974a5 Add a section to the docs about how period commitment works. 2021-08-17 12:21:00 -04:00
Damon Ciarelli 374e1d20c6 Bump version: 5.3.0 → 5.3.1
Signed-off-by: Damon Ciarelli <damon@nucypher.com>
2021-08-13 13:53:40 -04:00
Bogdan Opanchuk e5c0bb079e Fix the remainders of Alice/Publisher separation 2021-08-12 16:32:02 -07:00
derekpierre def9ef1116 Ensure that url query parameters in tests are url encoded. Added note about url encoding in docs.
Add unit test for Base64BytesRepresentation field.
Cleanup imports.
2021-07-26 15:14:43 -04:00
derekpierre 6ca5292105 Clarify format of "work_order_result" returned as the result of Porter /exec_work_order. Documentation cleanup: use version 6.0.0 in output, 401 error status code. 2021-07-26 15:14:43 -04:00
derekpierre 42a42b7fe4 Initial documentation of Porter '/exec_work_order' endpoint. 2021-07-26 15:14:43 -04:00
derekpierre ece5c97f81 Add note about the vagaries of the url character limit. 2021-07-26 15:14:43 -04:00
derekpierre c77de789c8 Allow URL query parameters for all HTTP methods. Add documentation about URL query parameters and the usage. 2021-07-26 15:14:43 -04:00
derekpierre 26968e05bc Rename docker image to nucypher/porter instead of nucypher/nucypher-porter.
Update documentation regarding the port that the Porter service runs on.
2021-07-26 15:14:43 -04:00
derekpierre 00f38e7b35 Build and publish separate nucypher/nucypher-porter docker image.
Minor cleanups including docker-compose container names, and documentation updates.
2021-07-26 15:14:43 -04:00
derekpierre 3faf1de19b Fix broken docker-compose for porter. 2021-07-26 15:14:43 -04:00
derekpierre f384c7e87a Properly handle pagination sizes when getting active stakers from StakingEscrow, and standardize porter execution timeouts. 2021-07-26 15:14:43 -04:00
derekpierre b8f1a96367 Fix Porter Docker TLS volume mapping path. 2021-07-26 15:14:43 -04:00
derekpierre 5c21990fce Add mising command line prompts for docs. 2021-07-26 15:14:43 -04:00
derekpierre 1fe532c99c Add documentation about Basic Authentication provided by Porter. 2021-07-26 15:14:43 -04:00
derekpierre 73a186ba90 Updated information for `/publish_treasure_map` endpoint and what it returns - it should have some data representing confirmation. 2021-07-26 15:14:43 -04:00
derekpierre c58184f246 Add Docker and Docker Compose sections as separate. 2021-07-26 15:14:43 -04:00
derekpierre 5c80256456 Add documentation for Porter docker usage. 2021-07-26 15:14:43 -04:00
derekpierre 11a5eea51b Add documentation about CLI usage of Porter service. 2021-07-26 15:14:43 -04:00
derekpierre bcaa4c2bd6 Flesh out initial API documentation for Porter endpoints. 2021-07-26 15:14:43 -04:00
derekpierre 9c7051ce6a Very rough initial diagram and blurb for Porter documentation. 2021-07-26 15:14:43 -04:00
Kieran Prasch e4594739a1 Update documentation to use Keystore and deprecate Keyring. 2021-06-28 14:33:31 -07:00
Kieran R. Prasch f0080b3e2e Minimally restore attachment of keystore 2021-06-28 14:33:31 -07:00
Kieran Prasch a0926112ad
Bump version: 5.2.0 → 5.3.0 2021-06-17 13:13:48 -07:00
Kosta 8fec1ce799 Update suggested pytest command to target unit tests 2021-05-20 16:24:26 -04:00
KPrasch e5c04859f9
Merge pull request #2694 from nucypher/fix-typo
Fix typo
2021-05-18 23:11:43 -07:00
David Núñez 4d873c6442 Apply suggestions from code review
Co-authored-by: Derek Pierre <derek.pierre@gmail.com>
2021-05-17 10:20:51 +02:00
David Núñez e87738c0f0 Fix math subindices 2021-05-17 10:20:51 +02:00
David Núñez 459d4ce0d4 Fix bad RST format for caution note and external ref 2021-05-17 10:20:51 +02:00
David Núñez 030b65b97f First pass at rewards documentation 2021-05-17 10:20:51 +02:00
David Núñez 668b0a401c Add boosts to example tables in CLI docs 2021-05-17 10:20:50 +02:00
piotr-roslaniec 572242faf4
Fix typo 2021-05-13 09:25:47 +02:00
KPrasch ae07242db6
Merge pull request #2665 from KPrasch/docs
Detailed description of Ursula's web status page
2021-05-07 14:27:50 -07:00
KPrasch 11cd9e5d3f
Update docs/source/staking/running_a_worker.rst 2021-05-07 14:27:34 -07:00
KPrasch af8b56a7db
Apply suggestions from code review
Co-authored-by: Derek Pierre <derek.pierre@gmail.com>
2021-05-07 14:18:38 -07:00
derekpierre b412d17340 Update service pricing fees to reflect 7-day period duration. 2021-05-03 10:08:27 -04:00
David Núñez 4466ea068d
Merge pull request #2634 from piotr-roslaniec/rewards-cmd#2509
Improve Rewards command
2021-04-28 22:03:44 +02:00
Piotr Roslaniec 7e57119767 Apply PR suggestions 2021-04-27 16:10:38 +02:00
Kieran Prasch 07cab383d2 Detailed description of the ursula web status page 2021-04-26 12:12:06 -07:00
Kieran Prasch e2d60412c6 Adjustments to worker setup documentation and docker command reccomendation. 2021-04-26 12:11:59 -07:00
Kieran Prasch 8668a49dab
Bump version: 5.1.0 → 5.2.0 2021-04-26 10:19:19 -07:00
Piotr Roslaniec eee2264ca1 Rename flags 2021-04-23 15:53:51 +02:00
Piotr Roslaniec 45fb78f5f4 Update docs 2021-04-23 15:42:39 +02:00
Piotr Roslaniec bcc4dc0902 Fix malformed table 2021-04-22 17:04:40 +02:00
Piotr Roslaniec 558ba24413 Update docs 2021-04-22 16:34:58 +02:00
Kieran Prasch 6975c15b95
Bump version: 5.0.2 → 5.1.0 2021-04-15 11:03:33 -07:00
derekpierre 229888ae99 Respond to RFCs for #2617.
Co-authored-by: Bogdan Opanchuk <bogdan@opanchuk.net>
2021-04-15 08:24:41 -04:00
derekpierre 4b1a7fd07c Respond to RFCs in #2617.
Co-authored-by: K Prasch <kieranprasch@gmail.com>
2021-04-15 08:24:41 -04:00
derekpierre 946552f326 Clarify that `--max-gas-price` is optional when initializing a worker. 2021-04-15 08:24:41 -04:00
derekpierre a89e1deb4b Add hint about `--config-file` to output of new configuration init for non-default configuration filepath.
Add docs note about non-default worker configuration files and the use of `--config-file <FILEPATH>`.
2021-04-15 08:24:41 -04:00
Kieran Prasch 555f7c631c
Bump version: 5.0.1 → 5.0.2 2021-04-14 18:53:54 -07:00
Kieran Prasch dd87a7a55c
Bump version: 5.0.0 → 5.0.1 2021-04-14 14:34:57 -07:00
Kieran Prasch 00bb3c7e82
Bump version: 4.8.2 → 5.0.0 2021-04-14 10:04:50 -07:00
KPrasch 74c986e53b
Merge branch 'main' into dao-proposal-1 2021-04-14 08:16:40 -07:00
derekpierre 71d5351501 Add date of switch to 7-day period. 2021-04-14 10:49:00 -04:00
derekpierre 0ac9c0c79d Respond to RFCs for #2610.
Co-authored-by: K Prasch <kieranprasch@gmail.com>
2021-04-09 19:18:35 -04:00
derekpierre 785cc585a2 Add link to MixBytes audit. 2021-04-08 12:27:42 -04:00
derekpierre e4535781e1 Respond to RFCs in #2597. 2021-04-07 10:42:41 -04:00
derekpierre 07f8e7f5c5 Respond to RFCs for #2597.
Co-Authored-By: cygnusv <david@nucypher.com>
2021-04-07 10:42:41 -04:00
derekpierre 7ba20778c5 Clarification of contract lifecycle, disclaimer about risks. 2021-04-07 10:42:41 -04:00
derekpierre 837222c8b0 Add lifecycle section for pooling contract docs. 2021-04-07 10:42:41 -04:00
derekpierre fd099d8946 Initial docs for staking contract work. 2021-04-07 10:42:41 -04:00
vzotova 9194e9ee6e Docs for pool contract 2021-04-07 10:42:41 -04:00
derekpierre f892d0a9af Add updated information about period duration and the consequence of the period duration extension. 2021-04-01 10:21:16 -04:00
derekpierre df28d9c9eb Ensured the use of "daily" in the docs was not used as a reference to period length since the length has now changed. 2021-04-01 10:21:16 -04:00
derekpierre d34187c83b Add updated CLI output to docs for `nucypher stake` command. 2021-04-01 10:21:16 -04:00
derekpierre 36238712a8 Modify events output, the output from block 0 doesn't change, since event already emitted with old values. 2021-04-01 10:21:16 -04:00
derekpierre 039f457376 Very rough draft of period migration page in docs. 2021-04-01 10:21:16 -04:00
derekpierre 2da8be9d10 Respond to RFCs for #2610.
Co-authored-by: Arjun Hassard <arjunhassard@gmail.com>
2021-04-01 10:21:16 -04:00
derekpierre 011da5dcc2 Modifications to sample CLI output. 2021-04-01 10:21:16 -04:00
derekpierre 4782bcd860 Initial modification of docs to reflect updated 7 day period length. 2021-04-01 10:21:16 -04:00
Kieran Prasch 2d05bb5b7d
Bump version: 4.8.1 → 4.8.2 2021-03-25 15:11:39 -07:00
Kieran Prasch 2a896e9add
Bump version: 4.8.0 → 4.8.1 2021-03-24 15:48:18 -07:00
Kieran Prasch e64d4035c8
Bump version: 4.7.1 → 4.8.0 2021-03-23 20:24:23 -07:00
Derek Pierre 1896088f0d
Respond to RFCs for #2599
Co-authored-by: David Núñez <david@nucypher.com>
2021-03-18 09:03:48 -04:00
derekpierre 418fc1f6cd Add documentation about approval / validation requirements for dao voting proposal.. 2021-03-17 16:50:10 -04:00
Kieran Prasch e3dedebc56 Respond to RFCs in PR #2583 2021-03-17 12:21:34 -07:00
Kieran Prasch 84240b4f07 remove_unused -> remove_inactive 2021-03-05 09:56:23 -08:00
Kieran Prasch a5090f69a9
Bump version: 4.7.0 → 4.7.1 2021-03-02 13:19:15 -08:00
Kieran Prasch a580a46280
Bump version: 4.6.0 → 4.7.0 2021-03-02 11:07:35 -08:00
Kieran Prasch 06d89fef07 ContractAdministrator is a BaseActor subclass. Respond to RFCs in PR #2572 2021-03-02 10:24:41 -08:00
derekpierre 3f49a08453 Respond to RFCs for #2573.
Co-authored-by: K Prasch <kieranprasch@gmail.com>
2021-02-26 13:07:26 -05:00
derekpierre 3ad3e2edc2 Add documentation about modifications to 'nucypher status events'.
Minor refactor.
2021-02-26 13:07:26 -05:00
Kieran Prasch c1eed47459 Lynx-based Finnegans's wake demo documentation mentions. 2021-02-13 18:35:31 -08:00
derekpierre f6bfaaee66 Document use of `nucypher stake events` including csv options; document StakingEcrow events. 2021-02-09 11:01:08 -05:00
Kieran Prasch 993fe301cc Use the same ethereum address in alice code snippets. 2021-02-07 14:10:27 -08:00
Kieran Prasch d43ea6ee47 Provide default seed urls in code samples. 2021-02-07 13:29:02 -08:00
Kieran Prasch 1232e9856f More comprehensive granting example script for the docs; Include policy rate. 2021-02-07 12:45:45 -08:00
Kieran Prasch a07b9fa1e8 Documentation: Signer.from_uri -> Signer.from_signer_uri 2021-02-06 11:35:06 -08:00
Kieran Prasch d7b5a6114f Update getting started with characters documentation: bugfixes and inclusion of signers API. 2021-02-06 00:30:27 -08:00
Kieran Prasch 8df75210a9 Move worker best practices to a standalone doc 2021-02-05 14:13:53 -08:00
derekpierre d4c218547f Random edits. Also fixed broken links. 2021-02-05 14:47:03 -05:00
derekpierre a19da053d1 Add some context information about NU and its uses. 2021-02-05 12:35:13 -05:00
derekpierre 72899513b3 Clarify FAQ to explain that participation in WorkLock is closed. Also remove CoinList FAQ entry. 2021-02-05 12:26:39 -05:00
derekpierre 0285153c44 Collapse Python API and Contracts API into one APIS section in sidebar. 2021-02-05 12:26:23 -05:00
derekpierre 3b6d47dfe3 Mostly reordering of specific page content; addition of helpful/contextual links. 2021-02-05 12:25:39 -05:00
Kieran Prasch 9965ea33d6 Include all NuCo seednode endpoints in getting started docs 2021-02-04 22:55:20 -08:00
Kieran Prasch 792f2095da Remove beta development stage warning; Thin out staker and worker overviews. 2021-02-04 20:34:03 -08:00
Kieran Prasch 263960502e Detailing the worker doc to include mentions of max gas price and cautions about autopilot. 2021-02-04 20:18:34 -08:00
Kieran Prasch 5ca18af778 Remove admonition regarding lost or compormised worker keys until a stronger reccomendation can be made. 2021-02-04 19:48:38 -08:00
Kieran Prasch 77f66513a6 Respond to RFCs for PR #2463 2021-02-04 19:43:19 -08:00
K Prasch e49e1f2045
Apply suggestions from code review
Thanks for the reviews @mswilkison ! :-)

Co-authored-by: MacLane S Wilkison <maclane@nucypher.com>
2021-02-04 16:00:14 -08:00
Kieran Prasch af0ffea572 Expands best practices section of worker doc 2021-02-04 14:36:47 -08:00
Kieran Prasch 4ba7a9179d Details and emphasis 2021-02-04 10:39:51 -08:00
Kieran Prasch bda81f893d Dissolves CLI Subsection 2021-02-04 10:39:51 -08:00
Kieran Prasch 8f23bb2450 Expand testnet docs in thier individual domains 2021-02-04 10:39:51 -08:00
Kieran Prasch da51afd987 Port ethereum network deployments references to docs 2021-02-04 10:39:51 -08:00
Kieran Prasch 346108f19e Basic command reference tables for every CLI entry point. 2021-02-04 10:39:51 -08:00
Kieran Prasch 0b3e579c60 Iterating on documentation improvements: structure, running a worker, Expand mentions of signers. 2021-02-04 10:39:51 -08:00
Kieran Prasch 12ed69d15c Expand worker guide favoring docker commands, and demonstrating worker qualification. 2021-02-04 10:39:51 -08:00
Kieran Prasch dade42af6a Include NuCypherKeyring kwarg for restoration snippet in getting started 2021-02-04 10:39:51 -08:00
Kieran Prasch 3921dca868 Removes Interactive ursula mode from docs; Reccomend Docker. 2021-02-04 10:39:51 -08:00
derekpierre eaf3b73c23 Update docs dependencies instruction based on modifications to setup.py; Minor text changes. 2021-02-04 10:39:51 -08:00
Kieran Prasch 3ebcb9cd29 Complete deprecation of guides 2021-02-04 10:39:51 -08:00
Kieran R. Prasch 82b7db2186 Another take on the documentation's introductory statements. 2021-02-04 10:39:51 -08:00
Kieran R. Prasch db3165baa3 Reorganizes documentation categories; Thinning and focus on what's important. 2021-02-04 10:39:51 -08:00