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

Add documentation about retrieval kit parameter expected format.

pull/2768/head
derekpierre 2021-09-16 15:09:21 -04:00
parent 9cd8bfc33d
commit 8ff0932b1d
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/source/application_development/porter.rst
View File

@ -491,12 +491,20 @@ Parameters
| | | | encoded as hex. |
+-------------------------------------------+---------------+----------------------------------------+
* A *retrieval kit* is an encapsulation of the information necessary obtain cfrags from Ursulas.
It contains the capsule and the checksum addresses of the Ursulas from which the requester has
already received cfrags i.e. Ursulas in the treasure map to skip. The format of the *retrieval kit* parameter
is ``base64(<capsule bytes>)``, if no cfrags were previously obtained, or
``base64(<capsule bytes><bytes of ursula_1 checksum address><bytes of ursula_2 checksum address>...)``
if some cfrags were already obtained (for example, retrying after a not receiving a threshold of cfrags because
some Ursulas may have experienced a blip in connectivity).
Returns
+++++++
The result of the re-encryption operations performed:
* ``retrieval_results`` - The list of retrieval results of the re-encryption operations containing cfrags produced by different ursulas.
* ``retrieval_results`` - The list of results from the re-encryption operations performed; contains a mapping of
Ursula checksum address/cfrag pairs. The cfrags are base64 encoded.
Example Request
+++++++++++++++