Skip to content

Commit

Permalink
update python docs for 0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
oceans404 committed Jul 3, 2024
1 parent 9dc6d8f commit 1151086
Show file tree
Hide file tree
Showing 6 changed files with 1,472 additions and 1,284 deletions.
14 changes: 7 additions & 7 deletions docs/compute.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The addition_simple example is a single party compute example that adds two secr
<TabItem value="client" label="Client code" default>

```python reference showGithubLink
https://github.com/NillionNetwork/nillion-python-starter/blob/main/examples_and_tutorials/core_concept_single_party_compute/addition_simple.py#L14-L100
https://github.com/NillionNetwork/python-examples/tree/main/examples_and_tutorials/core_concept_single_party_compute/addition_simple.py#L14-L100
```

</TabItem>
Expand All @@ -38,45 +38,45 @@ https://github.com/NillionNetwork/nillion-python-starter/blob/main/programs/addi

Multi party compute involves more than one Party. These Parties collaborate to provide secret inputs and one Party receives outputs of the program.

The [core_concept_multi_party_compute](https://github.com/NillionNetwork/nillion-python-starter/blob/main/examples_and_tutorials/core_concept_multi_party_compute) folder has a 3-step multi party compute example involving multiple parties providing secret inputs for computation of a program. The first party stores a secret, then N other parties store permissioned secrets giving the first party compute access. The first party computes with all secrets.
The [core_concept_multi_party_compute](https://github.com/NillionNetwork/python-examples/tree/main/examples_and_tutorials/core_concept_multi_party_compute) folder has a 3-step multi party compute example involving multiple parties providing secret inputs for computation of a program. The first party stores a secret, then N other parties store permissioned secrets giving the first party compute access. The first party computes with all secrets.

<Tabs>
<TabItem value="readme" label="README" default>

```python reference showGithubLink
https://github.com/NillionNetwork/nillion-python-starter/blob/main/examples_and_tutorials/core_concept_multi_party_compute/README.md
https://github.com/NillionNetwork/python-examples/tree/main/examples_and_tutorials/core_concept_multi_party_compute/README.md

```

</TabItem>
<TabItem value="config" label="Config file" default>

```python reference showGithubLink
https://github.com/NillionNetwork/nillion-python-starter/blob/main/examples_and_tutorials/core_concept_multi_party_compute/config.py
https://github.com/NillionNetwork/python-examples/tree/main/examples_and_tutorials/core_concept_multi_party_compute/config.py
```

</TabItem>
<TabItem value="apple" label="Step 1" default>
### Step 1: 1st Party Stores a Secret

```python reference showGithubLink
https://github.com/NillionNetwork/nillion-python-starter/blob/main/examples_and_tutorials/core_concept_multi_party_compute/01_store_secret_party1.py#L19-L100
https://github.com/NillionNetwork/python-examples/tree/main/examples_and_tutorials/core_concept_multi_party_compute/01_store_secret_party1.py#L19-L100
```

</TabItem>
<TabItem value="orange" label="Step 2">
### Step 2: N other parties store a permissioned secret

```python reference showGithubLink
https://github.com/NillionNetwork/nillion-python-starter/blob/main/examples_and_tutorials/core_concept_multi_party_compute/02_store_secret_party_n.py#L36-L108
https://github.com/NillionNetwork/python-examples/tree/main/examples_and_tutorials/core_concept_multi_party_compute/02_store_secret_party_n.py#L36-L108
```

</TabItem>
<TabItem value="banana" label="Step 3">
### Step 3: The 1st Party computes with all secrets

```python reference showGithubLink
https://github.com/NillionNetwork/nillion-python-starter/blob/main/examples_and_tutorials/core_concept_multi_party_compute/03_multi_party_compute.py#L43-L100
https://github.com/NillionNetwork/python-examples/tree/main/examples_and_tutorials/core_concept_multi_party_compute/03_multi_party_compute.py#L43-L100
```

</TabItem>
Expand Down
2 changes: 1 addition & 1 deletion docs/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Grant other Nillion users permission to retrieve, update, or delete your secrets

## Setting permissions

Permissions examples demonstrated modifying the permissions of secrets. Check out the [permissions](https://github.com/NillionNetwork/nillion-python-starter/blob/main/examples_and_tutorials/core_concept_permissions) folder on Github for examples of
Permissions examples demonstrated modifying the permissions of secrets. Check out the [permissions](https://github.com/NillionNetwork/python-examples/tree/main/examples_and_tutorials/core_concept_permissions) folder on Github for examples of

- storing a permissioned secret
- retrieving a secret
Expand Down
Loading

0 comments on commit 1151086

Please sign in to comment.