Skip to content

Commit

Permalink
mupdates readme with rendered mermaid
Browse files Browse the repository at this point in the history
  • Loading branch information
m00sey committed Aug 9, 2023
1 parent 96b61c3 commit 01597d1
Show file tree
Hide file tree
Showing 7 changed files with 502 additions and 43 deletions.
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

0 comments on commit 01597d1

Please sign in to comment.