Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updates readme with rendered mermaid #77

Merged
merged 1 commit into from
Aug 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
46 changes: 3 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,47 +41,7 @@ The code is built using Typescript and running code locally requires a Mac or Li

Account Creation Workflow

![Account Creation](/docs/diagrams/account-creation-workflow.png)

sequenceDiagram
actor u as User
participant s as Signify
participant c as Cloud Agent
u ->> s: Create Account
s ->> s: Generate Pub/Pri Keys
s ->>+ c: Request ICP Event Creation with Keys
note over s,c: This call can not be secured
note right of c: Creates ICP Event
c ->>- s: Return ICP event
s ->>+ c: Create Account with Signed ICP Event
note over s,c: Call Signed by new Keys
note right of c: Parses and Saves ICP
note right of c: Create Account with new AID
c ->>- s: Return New Account KeyState
s ->>+ c: Save Key Information
c ->>- s: Key Information Saved
s ->> u: Return New Account Information


sequenceDiagram
actor u as User
participant a as Web Page App
participant s as Signify
participant c as Cloud Agent
u ->> a: Create Account
a ->>+ s: Generate Pub/Pri Keys
s ->>- a: Return new Pub/Pri Keypair
a ->>+ c: Request ICP Event Creation with Keys
note over s,c: This call can not be secured
note right of c: Creates ICP Event
c ->>- a: Return ICP event
a ->>+ s: Sign ICP Event
s ->>- a: Return Signed Event
a ->>+ c: Create Account with Signed ICP Event
note over s,c: Call Signed by new Keys
note right of c: Parses and Saves ICP
note right of c: Create Account with new AID
c ->>- a: Return New Account KeyState
a ->>+ s: Save Key Information
s ->>+ c: Save Key Information
c ->>- s: Key Information Saved
a ->> u: Return New Account Information

![Account Creation Webpage](/docs/diagrams/account-creation-webpage-workflow.png)
23 changes: 23 additions & 0 deletions docs/diagrams/account-creation-webpage-workflow.mmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
sequenceDiagram
actor u as User
participant a as Web Page App
participant s as Signify
participant c as Cloud Agent
u ->> a: Create Account
a ->>+ s: Generate Pub/Pri Keys
s ->>- a: Return new Pub/Pri Keypair
a ->>+ c: Request ICP Event Creation with Keys
note over s,c: This call can not be secured
note right of c: Creates ICP Event
c ->>- a: Return ICP event
a ->>+ s: Sign ICP Event
s ->>- a: Return Signed Event
a ->>+ c: Create Account with Signed ICP Event
note over s,c: Call Signed by new Keys
note right of c: Parses and Saves ICP
note right of c: Create Account with new AID
c ->>- a: Return New Account KeyState
a ->>+ s: Save Key Information
s ->>+ c: Save Key Information
c ->>- s: Key Information Saved
a ->> u: Return New Account Information
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions docs/diagrams/account-creation-workflow.mmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
sequenceDiagram
actor u as User
participant s as Signify
participant c as Cloud Agent
u ->> s: Create Account
s ->> s: Generate Pub/Pri Keys
s ->>+ c: Request ICP Event Creation with Keys
note over s,c: This call can not be secured
note right of c: Creates ICP Event
c ->>- s: Return ICP event
s ->>+ c: Create Account with Signed ICP Event
note over s,c: Call Signed by new Keys
note right of c: Parses and Saves ICP
note right of c: Create Account with new AID
c ->>- s: Return New Account KeyState
s ->>+ c: Save Key Information
c ->>- s: Key Information Saved
s ->> u: Return New Account Information
Binary file added docs/diagrams/account-creation-workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading