Skip to content

Commit 3827ea5

Browse files
HenkKoddeSam
HenkKodde
and
Sam
authored
Feature/markdown documents (#44)
* - Updated version to 8.6.3 - Create Encryption document in Markdown format - Added new Encryption document to SUMMARY.md for publishing. * - Included package-lock.json * - Converted the following documents in Markdown. format; - JSON Binding Rules, - Generic Transaction Patterns. - Created the following sequence diagrams required in the documents; - figure63a.plantuml, - figure64a.plantuml, - figure65a.plantuml, - figure66a.plantuml. - Updated the following sequence diagrams; - figure63.plantuml, - figure64.plantuml, - figure65.plantuml, - figure66.plantuml. increase version to 8.8.1 * Format updates to accommodate auto numbering and Gitbooks display format. Version too 8.8.1. Co-authored-by: Sam <[email protected]>
1 parent d64b399 commit 3827ea5

13 files changed

+4101
-23
lines changed

‎SUMMARY.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
### Documents
44
* [Mojaloop Specifications Overview](README.md)
55
* [Glossary](documents/Glossary.md)
6+
* [Generic Transaction Patterns](documents/Generic Transaction Patterns.md)
67
* [API Definition v1.0](documents/API Definition v1.0.md)
8+
* [JSON Binding Rules](documents/JSON Binding Rules.md)
79
* [Encryption](documents/Encryption.md)
810
### Change Control Board
911
* [Change Control Board Overview](ccb-meetings/README.md)

‎assets/diagrams/sequence/figure63.plantuml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ activate Switch
129129
autonumber stop
130130
PayerFSP <<-- Switch: **HTTP 202** (Accepted)
131131
autonumber resume
132-
Switch ->> ALS: **GET /parties/MSISDN/123456789**
132+
Switch ->> ALS: **GET /participants/MSISDN/123456789**
133133
activate ALS
134134
autonumber stop
135135
Switch <<-- ALS: **HTTP 202** (Accepted)

‎assets/diagrams/sequence/figure63a.plantuml‎

Lines changed: 212 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,212 @@
1+
/'*****
2+
License
3+
--------------
4+
Copyright © 2017 Bill & Melinda Gates Foundation
5+
The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
6+
http://www.apache.org/licenses/LICENSE-2.0
7+
Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
8+
Contributors
9+
--------------
10+
This is the official list of the Mojaloop project contributors for this file.
11+
Names of the original copyright holders (individuals or organizations)
12+
should be listed with a '*' in the first column. People who have
13+
contributed from an organization can be listed under the organization
14+
that actually holds the copyright for their contributions (see the
15+
Gates Foundation organization for an example). Those individuals should have
16+
their names indented and be marked with a '-'. Email address can be added
17+
optionally within square brackets <email>.
18+
* Gates Foundation
19+
- Name Surname <[email protected]>
20+
21+
* Henk Kodde <[email protected]>
22+
--------------
23+
******'/
24+
25+
@startuml
26+
27+
' define actor image
28+
sprite $actor [25x48/16] {
29+
0000000000010000000000000
30+
0000000006CAC910000000000
31+
0000000095101292000000000
32+
0000000651000119000000000
33+
0000000B10000018400000000
34+
0000001A10000016600000000
35+
0000000B10000017510000000
36+
000000083100001A210000000
37+
0000000191000176110000000
38+
000000003A866A61100000000
39+
0000000000466211100000000
40+
0003333333334443333310000
41+
0088888888888888888892000
42+
0821111111111111111118200
43+
8311111111111111111111A00
44+
A111111111111111111111A20
45+
A111111111111111111111A20
46+
A111111111111111111111A20
47+
A111111111111111111111A20
48+
A111111111111111111111A20
49+
A111111111111111111111A20
50+
A111111111111111111111A20
51+
A111111111111111111111A20
52+
A111551111111111138111A20
53+
A111661111111111139111A20
54+
A211661111111111139111A20
55+
A211661111111111139111A20
56+
A211661111161111139111A20
57+
A2116611111A2111139111A20
58+
A2116611111A2111139111A20
59+
A2116611111A2111139111A20
60+
A7669611111A211113A666B20
61+
36669611111A211113A666610
62+
00016611111A2111139111110
63+
00006611111A2111139100000
64+
00006611111A2111139100000
65+
00006611111A2111139100000
66+
00006611111A2111139100000
67+
00006611111A2111139100000
68+
00006611111A2111139100000
69+
00006611111A2111139100000
70+
00006611111A2111139100000
71+
00006611111A2111139100000
72+
00006611111A2111139100000
73+
00006966666B7666679100000
74+
0000266666666666664100000
75+
0000000111111111111100000
76+
0000000000000000000000000
77+
}
78+
79+
' declaring skinparam
80+
skinparam sequenceMessageAlign center
81+
skinparam shadowing false
82+
skinparam defaultFontName Verdana
83+
skinparam monochrome true
84+
skinparam SequenceLifeLineBackgroundColor WhiteSmoke
85+
skinparam SequenceLifeLineBorderColor Black
86+
skinparam ActorFontStyle Bold
87+
skinparam ActorFontSize 20
88+
skinparam ParticipantFontStyle Bold
89+
skinparam ParticipantFontSize 20
90+
skinparam ParticipantBackgroundColor WhiteSmoke
91+
skinparam ArrowColor Black
92+
93+
skinparam actor {
94+
Bordercolor none
95+
Backgroundcolor none
96+
shadowing false
97+
}
98+
99+
skinparam participant {
100+
shadowing true
101+
}
102+
103+
hide footbox
104+
105+
' declare title
106+
' title Payer-Initiated Transaction
107+
108+
' Actor Keys:
109+
' participant - FSP(Payer/Payee), Switch and Account Lookup
110+
' actor - Payer/Payee(s)
111+
112+
' declare actors
113+
actor "<$actor>\nPayer" as Payer
114+
participant "Payer\nFSP" as PayerFSP
115+
participant "Optional\nSwitch" as Switch
116+
participant "Account\nLookup" as ALS
117+
participant "Payee\nFSP" as PayeeFSP
118+
actor "<$actor>\nPayee" as Payee
119+
120+
' start flow
121+
autonumber 1 1 "<b>[0]"
122+
Payer -> PayerFSP: I would like to\npay 100 USD\nto +123456789
123+
activate PayerFSP
124+
PayerFSP -> PayerFSP: Payee not within\nPayer FSP system
125+
autonumber stop
126+
PayerFSP ->> Switch: **Lookup Party Information**\n(MSISDN 123456789)
127+
activate Switch
128+
autonumber resume
129+
Switch ->> ALS: **Lookup Participant Information**\n(MSISDN 123456789)
130+
activate ALS
131+
ALS -> ALS: Lookup which\nFSP MSISDN\n+123456789\nbelongs to
132+
autonumber stop
133+
Switch <<- ALS: **Return Participant Information**\n(FSP ID)
134+
deactivate ALS
135+
autonumber resume
136+
Switch ->> PayeeFSP: **Lookup Party Information**\n(MSISDN 123456789)
137+
activate PayeeFSP
138+
PayeeFSP -> PayeeFSP: Lookup party\ninformation\nregarding\nMSISDN\n+123456789
139+
autonumber stop
140+
Switch <<- PayeeFSP: **Return Party Information**\n(Party Information)
141+
deactivate PayeeFSP
142+
autonumber resume
143+
PayerFSP <<- Switch: **Return Party Information**\n(Party Information)
144+
deactivate Switch
145+
deactivate PayerFSP
146+
PayerFSP -> PayerFSP: Rate Payer FSP quote\n(depending on fee model)
147+
activate PayerFSP
148+
PayerFSP ->> Switch: **Calculate Quote**\n(Transaction details)
149+
activate Switch
150+
Switch ->> PayeeFSP: **Calculate Quote**\n(Transaction details)
151+
activate PayeeFSP
152+
PayeeFSP -> PayeeFSP: Rate Payee FSP\nfee/commission,\ngenerate condition
153+
group #OldLace Optional
154+
hnote left of PayeeFSP #OldLace
155+
Confirm quote
156+
end hnote
157+
PayeeFSP -> Payee: Here is the\nquote and\nPayer name
158+
autonumber stop
159+
PayeeFSP <- Payee: I confirm
160+
end
161+
autonumber resume
162+
Switch <<- PayeeFSP: **Return Quote Information**\n(Payee FSP fee/commission,\ncondition)
163+
deactivate PayeeFSP
164+
PayerFSP <<- Switch: **Return Quote Information**\n(Payee FSP fee/commission,\ncondition)
165+
deactivate Switch
166+
PayerFSP -> PayerFSP: Rate Payer FSP quote\n(depending on fee model)
167+
autonumber stop
168+
Payer <- PayerFSP: Present fees and\noptionally payee name
169+
deactivate PayerFSP
170+
autonumber resume
171+
Payer -> PayerFSP: I approve the\ntransaction
172+
activate PayerFSP
173+
autonumber stop
174+
PayerFSP -> PayerFSP: Reserve transfer from Payer\naccount to Switch account
175+
autonumber resume
176+
PayerFSP -> Switch: **Preform Transfers**\n(Transfer ID, condition, ILP packet\nincluding transaction ID)
177+
activate Switch
178+
Switch -> Switch: Reserve transfer from\nPayer FSP to Payee FSP
179+
autonumber stop
180+
Switch ->> PayeeFSP: **Perform Transfer**\n(Transfer ID, condition, ILP packet\nincluding transaction ID)
181+
activate PayeeFSP
182+
autonumber resume
183+
PayeeFSP -> PayeeFSP: Perform transfer\nfrom Switch\naccount to Payee\naccount, generate\nfulfilment
184+
PayeeFSP -> Payee: Transaction notification
185+
autonumber stop
186+
Switch <<- PayeeFSP: **Return Transfer Information**\n(Fulfilment)
187+
deactivate PayeeFSP
188+
autonumber resume
189+
Switch -> Switch: Commit transfer from\nPayer FSP to Payee FSP
190+
autonumber stop
191+
PayerFSP <<- Switch: **Return Transfer Information**\n(Fulfilment)
192+
deactivate Switch
193+
autonumber resume
194+
PayerFSP -> PayerFSP: Commit transfer from Payer\naccount to Switch account
195+
group #OldLace Optional
196+
hnote left of PayerFSP #OldLace
197+
Get transaction data
198+
end hnote
199+
PayerFSP ->> Switch: **Retrieve Transaction Information**\n(Transaction ID)
200+
activate Switch
201+
Switch <<- PayeeFSP: **Retrieve Transaction Information**\n(Transaction ID)
202+
activate PayeeFSP
203+
PayeeFSP -> PayeeFSP: Lookup\ntransaction\ninformation
204+
Switch <<- PayeeFSP: **Return Transaction Information**\n(Transaction details)
205+
deactivate PayeeFSP
206+
PayerFSP <<- Switch: **Return Transaction Information**\n(Transaction details)
207+
deactivate Switch
208+
end
209+
Payer <- PayerFSP: Transaction notification\nincluding optional\ntransaction data\n(e.g. token ID)
210+
deactivate PayerFSP
211+
autonumber stop
212+
@enduml

‎assets/diagrams/sequence/figure64.plantuml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ ALS <<- PayeeFSP: **GET /participants/MSISDN/123456789**
127127
activate ALS
128128
ALS -->> PayeeFSP: **HTTP 202** (Accepted)
129129
autonumber resume
130-
ALS -> ALS: Lookup which FSP MSISDN\n+123456789 belongins to
130+
ALS -> ALS: Lookup which FSP MSISDN\n+123456789 belongs to
131131
ALS ->> PayeeFSP: **PUT /participants/MSISDN/123456789**\n(FSP ID)
132132
autonumber stop
133133
ALS <<-- PayeeFSP: **HTTP 200** (OK)

0 commit comments

Comments
 (0)