Skip to content

Commit d539b82

Browse files
authored
Merge pull request #78 from didx-xyz/issue_76
Adjust Readme and explanation in the getting started notebook.
2 parents 664bdb5 + c16c123 commit d539b82

File tree

4 files changed

+23
-10
lines changed

4 files changed

+23
-10
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ You should now be able to run any of the tutorials or projects within this repo.
3535

3636
E.g for the main tutorial on the aries-basic-controller
3737
1. Navigate to the root directory of the tutorial
38-
`cd tutorials/aries-basic-controller`
38+
`cd tutorials/1. Learning Aries, ACA-Py and the Basic Controller`
3939
2. Spin up the docker-compose configuration
4040
`./manage start`
4141
3. Get the urls and tokens for the juypter notebook instances within the project
@@ -47,15 +47,26 @@ E.g for the main tutorial on the aries-basic-controller
4747

4848
In the tutorials folder you will find a set of series of juypter notebook tutorials walking through how to use the libraries contained within this repository. Each tutorial series can be run from it's folder using `./manage start`
4949

50-
### [SSI Basics with Hyperledger](./tutorials/aries-basic-controller)
50+
### [Learning Aries, ACA-Py and the Basic Controller](./tutorials/1.%20Learning%20Aries,%20ACA-Py%20and%20the%20Basic%20Controller)
5151

5252
This series introduces Self-Sovereign Identity and provides all the information needed to get started developing with the Hyperledger SSI stack using the aries-basic-controller library we developed to provide code examples within the notebooks.
5353

5454
**This is a great place to start!**
5555

56-
### [Making SSI "Real"](./tutorials/aries-stagingnet)
56+
### [Public Ledgers and Mobile Wallets](./tutorials/2.%20Public%20Ledgers%20and%20Mobile%20Wallets)
57+
58+
In this series you will learn how to move your solutions from a local test network onto the publicly accessible internet by connecting to the Sovrin StagingNet. You will interact with the agents through the notebooks using a publically available mobile agent that you can download from the app store.
59+
60+
### [Sending files](./tutorials/3.%20Attachments)
61+
62+
In this series you will learn how to attach files and send them from Alice to Bob.
63+
64+
### [Multi-tenancy and Mediation](./tutorials/4.%20Multitenancy)
65+
66+
In this series you will learn mainly three things. Firstly, we show how to create wallets for Alice and Bob on the same agent. These wallets are called subwallets and are managed by a base wallet. We continue by exploring mediation of communication ([see here for more details](https://github.com/hyperledger/aries-cloudagent-python/blob/main/Mediation.md)). Lastly, the tutorial expands on these concept by introducing an external agent - external as in from an outside network. Here, we use familiar concepts from the second tutorial series.
67+
68+
**This configuration also gives an example of how to configure an agent to use postgres for it's wallet storage**
5769

58-
In this series you will learn how to move your solutions from a local test network onto the publicly accessible internet by connecting to the Sovrin StagingNet.
5970

6071
## Libraries
6172

libs/aries-basic-controller/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ Current version 0.2
1111

1212
## Tutorial
1313

14-
Find out how to use this package by taking our [jupyter notebook tutorial series](../../tutorials/aries-basic-controller).
14+
Find out how to use this package by taking our [jupyter notebook tutorial series](../../tutorials/).
1515

1616

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# Aries StagingNet Example
1+
# Public ledgers and mobile wallets example
22

33
This example takes you through the process of moving from a local development environment into a more realistic implementation of SSI with credential schema and definitions written to the public Sovrin StagingNet.
44

55
In this example, **you** will play the role of holder using a mobile agent of your choice. The notebooks represent an issuer and a verifier, the example takes you through issuing a credential to your wallet using the issuer notebook and then presenting attributes from this credential to the verifier on a different notebook. This begins to show the power of this architecture, the individual becomes the point of interoperability between systems for data about them.
66

77
## Notebooks:
88

9-
* [Issuer](http://localhost:8888) - run `docker logs aries-stagingnet_issuer-notebook_1` for the token.
10-
* [Verifier](http://localhost:8889) - run `docker logs aries-stagingnet_verifier-notebook_1` for the token.
9+
* [Issuer](http://localhost:8888/lab)
10+
* [Verifier](http://localhost:8889/lab)
11+
12+
In order to obtain the tokens required to access the notebooks, please run `./scripts/get_URLS.sh` in the root folder of the project (`/PyDentity`). If you run this you can also just click the links genrated by the script instead of copy-pasting the token.

tutorials/2. Public Ledgers and Mobile Wallets/notebooks/issuer/Part 1 - Getting Started.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
" * For a complete list of Aca-Py startup parameters please refer to [this](https://github.com/hyperledger/aries-cloudagent-python/blob/25b7a9c08921e67b0962c434102489884ac403b2/aries_cloudagent/config/argparse.py) link.\n",
6868
"* Ensure that agent is exposed to the internet with `ngrok`\n",
6969
"\n",
70-
"Both of these are already taken care off by the `example/aries-stagingnet` docker environment.\n"
70+
"Both of these are already taken care off by the aries-args YAML files in the configuration folder in PyDentity root that provide paramaeters for the docker environments. You can go and have a look in the docker-compose.yml in this tutorial folder to see what images are used. Then check the respective docker and arg files to get an idea of how this can be configured.\n"
7171
]
7272
},
7373
{
@@ -111,4 +111,4 @@
111111
},
112112
"nbformat": 4,
113113
"nbformat_minor": 4
114-
}
114+
}

0 commit comments

Comments
 (0)