Skip to content
This repository has been archived by the owner on Dec 18, 2019. It is now read-only.

Added screenshots for python3 getting_started.py test step #16

Open
wants to merge 60 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
7064112
Added screenshots for python3 getting_started.py test step
Jan 21, 2019
0bb44e5
Removed unused images
Jan 21, 2019
9774ef0
Added numbering to logger.info() msgs
Jan 26, 2019
3c2de0b
Small clean-up
Jan 26, 2019
d730bb3
working-in-progress checkin
Jan 27, 2019
77903b5
Moved sample log file to doc folder
Jan 27, 2019
113c5fc
Added verbose output script
Jan 29, 2019
9d0eb79
Interim check-in
Jan 29, 2019
6f6e088
Interim check-in
Jan 29, 2019
00f336e
Interim check-in with idstring 2 did wrappers
Jan 31, 2019
0894315
Interim (second last :-)) checkin
Feb 3, 2019
c6c7940
Added 1.1 Message Flow Diagram
Feb 3, 2019
da28f23
Updated 1.1 Message Flow diagram
Feb 3, 2019
f2226c9
Added DID-7-Layer-Model image
Feb 5, 2019
6647fcc
Renamed id-string <> valid_did methods
Feb 5, 2019
5b9c7fb
7-Layer Model changed to new 6-Layer Model
Feb 6, 2019
b27a93f
Updated/new images
Feb 7, 2019
4ea3737
Renamed images
Feb 7, 2019
0aaaeee
Initial Interaction Diagrams
mwherman2000 Feb 20, 2019
4d93dd6
Updates
mwherman2000 Feb 21, 2019
ba64c71
First complete set of interaction diagrams
mwherman2000 Feb 23, 2019
71724fa
Added 5.0 Raw Message Flows.md
Feb 26, 2019
0070080
5.0 Message Flow tweaks
Feb 26, 2019
17726dc
Path typo
Feb 26, 2019
508f804
Edits
Feb 26, 2019
88d536c
Added subheadings
Feb 26, 2019
e257645
Add missing samople msg file
Feb 26, 2019
097cb94
Updated sample msg file list
Feb 26, 2019
83587f7
Tweaks to Figure captions
Feb 26, 2019
d5dac92
Added Overview heading
Feb 26, 2019
6e7ebb7
Added scenario intro graphics
Mar 1, 2019
6534098
U[dated Scenario Intro 3 graphic
Mar 1, 2019
c1a689e
Added GSG-EA
Mar 3, 2019
bbb95b8
Updated Trust Anchor viewpoint
Mar 3, 2019
897b811
Updated Trust Anchors viewpoint
Mar 3, 2019
f357786
Updated Trust Anchors diagram
Mar 3, 2019
80be04b
Added Business Process diagrams / updated Interaction diagrams
Mar 4, 2019
b5f43b3
Start of GSG-EA readme.md
Mar 4, 2019
761927d
Updated TOC
Mar 4, 2019
0637a68
Updated GSG-EA
Mar 5, 2019
a02268a
Added abstract; updated actor/anchors diagrams
Mar 5, 2019
e3621f5
Fixed typos
Mar 5, 2019
756fdaa
Fixed typo
Mar 5, 2019
dceaecf
Edit
Mar 5, 2019
34bd20d
Updated business process diagrams
Mar 6, 2019
7d1e820
Updates
Mar 6, 2019
cb156ff
Wrote Design section
Mar 8, 2019
fd3d74b
Updated role model viewpoints
Mar 9, 2019
113bd2f
Added ArchiMate relationships legend
Mar 9, 2019
27b291a
Editorial changes
mwherman2000 Sep 23, 2019
f68e6ce
Typos
mwherman2000 Sep 23, 2019
0ed96f0
--allow-unauthenticated
mwherman2000 Sep 23, 2019
318afda
rm indy-dev -r -f
mwherman2000 Sep 23, 2019
f90dba9
rename restartenv.bat
mwherman2000 Sep 24, 2019
e2e478e
Updates
mwherman2000 Sep 25, 2019
b3b7a0c
Guide updates
mwherman2000 Sep 25, 2019
ae07100
Guide updates
mwherman2000 Sep 25, 2019
d19e3f4
Added PPTX from Turkey
mwherman2000 Sep 26, 2019
9f60432
Added Turkey 2019 PPTs
mwherman2000 Dec 9, 2019
c04bce2
Moved the presentatios folder to python/doc
mwherman2000 Dec 9, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 26 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ to cleanup the docker images built run: `sudo make cleanup`

to refresh the container and cleanup the data in the wallets and the pool.txn file use `sudo make refresh`

## Windows
## Windows Setup Guide
The steps below have been tested with Windows 10 Professional but the following previous caveat still applies: Your mileage may vary on Windows and will be tougher to work with, continue at your own risk.

Alternatively, if you've not been able to get docker setup on windows, **Use the in-browser setup instead.**
Expand All @@ -53,38 +53,55 @@ Alternatively, if you've not been able to get docker setup on windows, **Use the
4. The following steps do not assume or require that you have installed the Windows 10 Linux subsystem feature installed on your Windows 10 computer.
5. The following steps assume you have used the Docker Desktop app to share your C: (or alternate drive partitiion) with a Linux container.
- Start the Docker Desktop app by clicking the Docker icon in the Task Bar System Tray.
- Click Settings
- Select Share Drives
- Select C: (or an alternate drive)
- Click Apply
- Click `Settings`
- Select `Shared Drives`
- Select `C:` (or an alternate drive)
- Click `Apply`
- When prompted, enter your local Windows 10 login credentials to enable Docker to create a shared drive.
![Docker Desktop: Share C: Drive](images/Win10-DockerDesktop-ShareCDrive.png)
6. Enter the following commands using either the `Powershell` or `Windowws Command Line` console:
6. Enter the following commands using either the `Windows PowerShell` or `Windows Command Line` console:
```
mkdir c:\INDY
c:
cd c:\INDY
git clone https://github.com/kdenhartog/indy-dev.git
rem git clone https://github.com/kdenhartog/indy-dev.git
git clone https://github.com/mwherman2000/indy-dev.git

cd indy-dev
docker build -f indy-pool.dockerfile -t indy_pool .
docker build -f indy-dev.dockerfile -t indy_dev .

docker run -itd --net=host -p 127.0.0.1:9701-9708:9701-9708 indy_pool
docker run -it --net=host -p 127.0.0.1:8080:8080 -v C:/INDY/indy-dev:/indy-dev indy_dev
```
NOTE: The construction `C:/INDY/indy-dev:/indy-dev` is necessary under Windows 10 because if the `:/indy-dev` alias is missing, you end up with an unusable shared folder called `C:/INDY/indy-dev` in your Linux session.

REFERENCE: https://forums.docker.com/t/volume-mounts-in-windows-does-not-work/10693/7

To reset the environment, simply re-run these two commands:
```
docker run -itd --net=host -p 127.0.0.1:9701-9708:9701-9708 indy_pool
docker run -it --net=host -p 127.0.0.1:8080:8080 -v C:/INDY/indy-dev:/indy-dev indy_dev
```

## Test Python environment
Once inside the docker shell (started in step 2 of "how to start"):
Once the above two `docker` commands have been executed, the Docker shell will start with a '$' prompt. Inside the docker shell, enter the following commands:

```
cd /
cd indy-dev
cd python
python3 getting_started.py
```
If the Getting Started Guide script completes through the end of cleanup, everything is working correctly.

The initial console output will look something like the following:

![python3 getting_started.py console output - start](images/python3-getting_started_py-start.png)

...and when finished, the last part of the console output will look something like:

If the getting started guide completes through the end of cleanup everything is working correctly.
![python3 getting_started.py console output -end](images/python3-getting_started_py-end.png)

## Going through the IndySDK How-to guides

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/DID-6-Layer-Model-Tasks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/DID-6-Layer-Model.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/python3-getting_started_py-end.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/python3-getting_started_py-start.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion indy-pool.dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ ARG indy_node_ver=1.6.576
ARG python3_indy_crypto_ver=0.4.3
ARG indy_crypto_ver=0.4.3

RUN apt-get update -y && apt-get install -y \
RUN apt-get update -y && apt-get install -y --allow-unauthenticated \
indy-plenum=${indy_plenum_ver} \
indy-anoncreds=${indy_anoncreds_ver} \
indy-node=${indy_node_ver} \
Expand Down
104 changes: 104 additions & 0 deletions python/doc/getting_started-5.0 Raw Message Flows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# INDY-DEV - 5.0 Raw Message Flows

This is a temporary page whose goal is to quickly illustrate the number and size of the JSON messages exchanged in a typical Indy SDK scenario.

## Overview

The following documents, at a high-level, Activity 5, a subset of the tasks in the _Sally buys a car" Getting Started Scenario.

The message flows include all JSON messages exchanged between:
- Any pair of the 6 agents:
- Sovrin Steward (SS)
- Government (G)
- Faber College (FC)
- Acme Corp (AC)
- Thrift Bank (TB)
- Alice (A)
- Any one of the agents in their interactions with their local wallet
- Any one of the agents in their interactions with their local, shared replica of the Ledger

## High-level Task Flow

![High-level Task Flow](images/Indy-SDK-Getting-Started-5.0.png)

Figure 1. High-Level Task Flow

## Message Flow

![Message Flow](images/Indy-SDK-Getting-Started-5.0-Interaction.png)

Figure 2a. Interaction Diagram with Message Flows: All-in (5.1, 5.2, 5.3)

### 5.1 Message Flows

![Message Flow](images/Indy-SDK-Getting-Started-5.1-Interaction.png)

Figure 2b. Interaction Diagram with Message Flows: 5.1

### 5.2 Message Flows

![Message Flow](images/Indy-SDK-Getting-Started-5.2-Interaction.png)

Figure 2c. Interaction Diagram with Message Flows: 5.2

### 5.3 Message Flows

![Message Flow](images/Indy-SDK-Getting-Started-5.3-Interaction.png)

Figure 2d. Interaction Diagram with Message Flows: 5.3

## Sample Message Sizes

![Sample Message Sizes](msg_traces/msg_sizes.png)

Figure 3. Sample Message Sizes sorted by Size (Approximate)

## Sample Message Files and Sizes (Bytes)

| Message File | Size (Bytes) |
| ------------ | ------------:|
| [5.1.2&#32;SEND_NYM.txt](msg_traces/5.1.2&#32;SEND_NYM.txt) | 216|
| [5.1.3&#32;Connection&#32;Request.txt](msg_traces/5.1.3&#32;Connection&#32;Request.txt) | 92|
| [5.1.7&#32;Connection&#32;Response.txt](msg_traces/5.1.7&#32;Connection&#32;Response.txt) | 151|
| [5.1.9&#32;Decrypted&#32;Connection&#32;Response.txt](msg_traces/5.1.9&#32;Decrypted&#32;Connection&#32;Response.txt) | 161|
| [5.1.11&#32;SEND_NYM.txt](msg_traces/5.1.11&#32;SEND_NYM.txt) | 217|
| [5.2.1&#32;Loan&#32;Application-Basic&#32;Proof&#32;Request.txt](msg_traces/5.2.1&#32;Loan&#32;Application-Basic&#32;Proof&#32;Request.txt) | 595|
| [5.2.6&#32;GET_CRED_REFERENT.txt](msg_traces/5.2.6&#32;GET_CRED_REFERENT.txt) | 1181|
| [5.2.7&#32;GET_SCHEMA_REQ-Job-Certificate.txt](msg_traces/5.2.7&#32;GET_SCHEMA_REQ-Job-Certificate.txt) | 219|
| [5.2.7&#32;GET_SCHEMA_RESP-Job-Certificate.txt](msg_traces/5.2.7&#32;GET_SCHEMA_RESP-Job-Certificate.txt) | 2213|
| [5.2.8&#32;GET_CRED_DEF_REQ-Job-Certificate.txt](msg_traces/5.2.8&#32;GET_CRED_DEF_REQ-Job-Certificate.txt) | 217|
| [5.2.8&#32;GET_CRED_DEF_RESP-Job-Certificate.txt](msg_traces/5.2.8&#32;GET_CRED_DEF_RESP-Job-Certificate.txt) | 16607|
| [5.2.9&#32;Loan&#32;Application-Basic&#32;Proof.txt](msg_traces/5.2.9&#32;Loan&#32;Application-Basic&#32;Proof.txt) | 2120|
| [5.2.9&#32;Loan&#32;Application-Basic&#32;Requested&#32;Credentials.txt](msg_traces/5.2.9&#32;Loan&#32;Application-Basic&#32;Requested&#32;Credentials.txt) | 378|
| [5.2.14&#32;GET_SCHEMA_REQ-Job-Certificate.txt](msg_traces/5.2.14&#32;GET_SCHEMA_REQ-Job-Certificate.txt) | 220|
| [5.2.14&#32;GET_SCHEMA_RESP-Job-Certificate.txt](msg_traces/5.2.14&#32;GET_SCHEMA_RESP-Job-Certificate.txt) | 2214|
| [5.2.15&#32;GET_CRED_DEF_REQ-Job-Certificate.txt](msg_traces/5.2.15&#32;GET_CRED_DEF_REQ-Job-Certificate.txt) | 218|
| [5.2.15&#32;GET_CRED_DEF_RESP-Job-Certificate.txt](msg_traces/5.2.15&#32;GET_CRED_DEF_RESP-Job-Certificate.txt) | 16610|
| [5.3.1&#32;Loan&#32;Application-KYC&#32;Proof&#32;Request.txt](msg_traces/5.3.1&#32;Loan&#32;Application-KYC&#32;Proof&#32;Request.txt) | 289|
| [5.3.6&#32;GET_CRED_REFERENT.txt](msg_traces/5.3.6&#32;GET_CRED_REFERENT.txt) | 1227|
| [5.3.7&#32;GET_SCHEMA_REQ-Job-Certificate.txt](msg_traces/5.3.7&#32;GET_SCHEMA_REQ-Job-Certificate.txt) | 235|
| [5.3.7&#32;GET_SCHEMA_RESP-Job-Certificate.txt](msg_traces/5.3.7&#32;GET_SCHEMA_RESP-Job-Certificate.txt) | 2229|
| [5.3.7&#32;GET_SCHEMA_REQ-Transcript.txt](msg_traces/5.3.7&#32;GET_SCHEMA_REQ-Transcript.txt) | 225|
| [5.3.7&#32;GET_SCHEMA_RESP-Transcript.txt](msg_traces/5.3.7&#32;GET_SCHEMA_RESP-Transcript.txt) | 2217|
| [5.3.8&#32;GET_CRED_DEF_REQ-Job-Certificate.txt](msg_traces/5.3.8&#32;GET_CRED_DEF_REQ-Job-Certificate.txt) | 233|
| [5.3.8&#32;GET_CRED_DEF_RESP-Job-Certificate.txt](msg_traces/5.3.8&#32;GET_CRED_DEF_RESP-Job-Certificate.txt) | 16625|
| [5.3.8&#32;GET_CRED_DEF_REQ-Transcript.txt](msg_traces/5.3.8&#32;GET_CRED_DEF_REQ-Transcript.txt) | 228|
| [5.3.8&#32;GET_CRED_DEF_RESP-Transcript.txt](msg_traces/5.3.8&#32;GET_CRED_DEF_RESP-Transcript.txt) | 19587|
| [5.3.9&#32;Loan&#32;Application-KYC&#32;Proof.txt](msg_traces/5.3.9&#32;Loan&#32;Application-KYC&#32;Proof.txt) | 8934|
| [5.3.9&#32;Loan&#32;Application-KYC&#32;Requested&#32;Credentials.txt](msg_traces/5.3.9&#32;Loan&#32;Application-KYC&#32;Requested&#32;Credentials.txt) | 403|
| [5.3.14&#32;GET_SCHEMA_REQ-Transcript.txt](msg_traces/5.3.14&#32;GET_SCHEMA_REQ-Transcript.txt) | 226|
| [5.3.14&#32;GET_SCHEMA_RESP-Transcript.txt](msg_traces/5.3.14&#32;GET_SCHEMA_RESP-Transcript.txt) | 2217|
| [5.3.14&#32;GET_SCHEMA_REQ-Job-Certificate.txt](msg_traces/5.3.14&#32;GET_SCHEMA_REQ-Job-Certificate.txt) | 236|
| [5.3.14&#32;GET_SCHEMA_RESP-Job-Certificate.txt](msg_traces/5.3.14&#32;GET_SCHEMA_RESP-Job-Certificate.txt) | 2229|
| [5.3.15&#32;GET_CRED_DEF_REQ-Job-Certificate.txt](msg_traces/5.3.15&#32;GET_CRED_DEF_REQ-Job-Certificate.txt) | 234|
| [5.3.15&#32;GET_CRED_DEF_RESP-Job-Certificate.txt](msg_traces/5.3.15&#32;GET_CRED_DEF_RESP-Job-Certificate.txt) | 16626|
| [5.3.15&#32;GET_CRED_DEF_REQ-Transcript.txt](msg_traces/5.3.15&#32;GET_CRED_DEF_REQ-Transcript.txt) | 229|
| [5.3.15&#32;GET_CRED_DEF_RESP-Transcript.txt](msg_traces/5.3.15&#32;GET_CRED_DEF_RESP-Transcript.txt) | 19588|

Table 1. Sample Message Files and File Sizes (Bytes)

## Appendix A - DID Legend

![DID Legend](images/Indy-SDK-Getting-Started-DID-Legend.png)

Figure 4. DID Legend
Loading