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.

Sign up for GitHub

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

Jump to bottom

feat(mojaloop/#3488): enable batch processing #415

Draft
wants to merge 22 commits into
base: master
Choose a base branch
from
Draft

feat(mojaloop/#3488): enable batch processing #415

Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
8cf54d3
feat: added seq diagrams for binning fulfil and prepare
vijayg10 Sep 1, 2023
b5a0d2e
feat: added seq diagram for abort with partial changes
vijayg10 Sep 1, 2023
c9ca8a5
chore: render diagrams for ease of view
kleyow Sep 1, 2023
3abb86f
fix: refactored abort action messages
vijayg10 Sep 4, 2023
315f68f
feat: updated binning sequence diagram
vijayg10 Sep 4, 2023
6f05888
feat: added rev2 of binning diagram
vijayg10 Sep 4, 2023
dd6d24f
feat: changes in binning seq
vijayg10 Sep 5, 2023
acd4ec7
feat: update seq diagrams
vijayg10 Sep 5, 2023
4c4ada0
feat: restructured the files
vijayg10 Sep 5, 2023
d962592
chore: some file name changes
vijayg10 Sep 6, 2023
4a8bfc1
feat: added overview
vijayg10 Sep 6, 2023
c1e1ea9
feat: updated seq diagrams
vijayg10 Sep 6, 2023
cc84ec8
chore: re-organised filenames and diagram numbers
vijayg10 Sep 7, 2023
971e84d
feat: refined seq diagrams
vijayg10 Sep 7, 2023
1b38ec0
Update docs/technical/central-ledger/assets/diagrams/sequence/seq-pos…
vijayg10 Sep 11, 2023
9af8f4f
Update docs/technical/central-ledger/assets/diagrams/sequence/seq-pos…
vijayg10 Sep 11, 2023
4318852
fix: addressed PR comments
vijayg10 Sep 11, 2023
1bf4195
fix: build issues
vijayg10 Sep 11, 2023
cd2d40a
fixes for legacy-build issues
mdebarros Sep 12, 2023
b63f436
fix: fixed design diagram for batching
vijayg10 Sep 27, 2023
cb7ab69
Merge branch 'feat/3488-enable-batch-processing' of https://github.co…
vijayg10 Sep 27, 2023
a44c197
fix: updated design diagram for batching
vijayg10 Oct 4, 2023
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
1 change: 1 addition & 0 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ defaults_Dependencies: &defaults_Dependencies |
make gcc g++ python3 libtool autoconf automake \
python3 \
py3-pip
pip3 install --upgrade pip
pip3 install awscli


Expand Down
4 changes: 4 additions & 0 deletions docs/.vuepress/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -684,6 +684,10 @@ module.exports = {
}
]
},
{
title: "Position Handler Batch Support",
path: "central-ledger/transfers/1.3.4-position-handler-consume-binning"
},
]
},
{
Expand Down
6 changes: 3 additions & 3 deletions docs/api/thirdparty/assets/diagrams/transfer/1-1-discovery.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ end box


== Discovery (Lookup) ==
rnote right of D1 #Light
rnote right of D1 #LightYellow
**""GET /parties/MSISDN/+4412345678""**
""FSPIOP-Source: pispa""
end note
Expand All @@ -37,15 +37,15 @@ S --> D1: ""202 Accepted""

... ALS lookup flow not shown here ...

rnote over S #Light
rnote over S #LightYellow
**""GET /parties/MSISDN/+4412345678""**
""FSPIOP-Source: pispa""
""FSPIOP-Destination: dfspb""
end note
S -> D3: ""GET /parties/MSISDN/+4412345678""
D3 --> S: ""202 Accepted""

rnote left of D3 #Light
rnote left of D3 #LightYellow
**""PUT /parties/MSISDN/+4412345678""**
""FSPIOP-Source: dfspb""
""FSPIOP-Destination: pispa""
Expand Down
4 changes: 2 additions & 2 deletions docs/api/thirdparty/assets/diagrams/transfer/1-2-1-agreement.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ end box


== Agreement Phase ==
rnote right of D1 #Light
rnote right of D1 #LightYellow
**""POST /thirdpartyRequests/transactions""**
""FSPIOP-Source: pispa""
""FSPIOP-Destination: dfspa""
Expand Down Expand Up @@ -68,7 +68,7 @@ D2 -> D2: Store a referece to the ""consentId"" with the ""transactionRequestId"
D2 -> D2: Generate a unique transactionId for this transaction request:\n**""11111111-0000-0000-0000-000000000000""**


rnote left of D2 #Light
rnote left of D2 #LightYellow
**""PUT /thirdpartyRequests/transactions""**
**"" /00000000-0000-0000-0000-000000000000""**
""FSPIOP-Source: dfspa""
Expand Down
6 changes: 3 additions & 3 deletions docs/api/thirdparty/assets/diagrams/transfer/1-2-2-authorization.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ box "DFSP B"
participant "DFSP B\n(Payee)" as D3
end box

rnote left of D2 #Light
rnote left of D2 #LightYellow
**""POST /quotes""**
""FSPIOP-Source: dfspa""
""FSPIOP-Destination: dfspb""
Expand Down Expand Up @@ -76,7 +76,7 @@ S --> D2: ""202 Accepted""
S -> D3: ""POST /quotes""
D3 --> S: ""202 Accepted""

rnote left of D2 #Light
rnote left of D2 #LightYellow
**""PUT /quotes/22222222-0000-0000-0000-000000000000""**
""FSPIOP-Source: dfspb""
""FSPIOP-Destination: dfspa""
Expand Down Expand Up @@ -111,7 +111,7 @@ end note
D2 -> D2: Generate a UUID for the authorization Request:\n""33333333-0000-0000-0000-000000000000""
D2 -> D2: Derive the challenge based \non ""PUT /quotes/{ID}""

rnote left of D2 #Light
rnote left of D2 #LightYellow
**""POST /thirdpartyRequests/authorizations""**
""FSPIOP-Source: dfspa""
""FSPIOP-Destination: pispa""
Expand Down
4 changes: 2 additions & 2 deletions docs/api/thirdparty/assets/diagrams/transfer/1-2-3-rejected-authorization.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ note right of D1
User rejects the terms of the transcationRequest
end note

rnote right of D1 #Light
rnote right of D1 #LightYellow
**""PUT /thirdpartyRequests/authorizations/33333333-0000-0000-0000-000000000000""**
""FSPIOP-Source: pispa""
""FSPIOP-Destination: dfspa""
Expand All @@ -53,7 +53,7 @@ note over D2
User has rejected the transaction request.
end note

rnote over D2 #Light
rnote over D2 #LightYellow
**""PATCH /thirdpartyRequests/transactions/00000000-0000-0000-0000-000000000000""**
""FSPIOP-Source: dfspa""
""FSPIOP-Destination: pispa""
Expand Down
4 changes: 2 additions & 2 deletions docs/api/thirdparty/assets/diagrams/transfer/1-2-3-signed-authorization-fido.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ skinparam SequenceLifeLineBorderColor Black
skinparam ParticipantFontStyle Bold
skinparam ParticipantFontSize 20
skinparam ParticipantBackgroundColor WhiteSmoke
skinparam ArrowColor Black
skinparam ArrowColor Black

hide footbox

Expand All @@ -35,7 +35,7 @@ note right of D1
the **""challenge""** string
end note

rnote right of D1 #Light
rnote right of D1 #LightYellow
**""PUT /thirdpartyRequests/authorizations/33333333-0000-0000-0000-000000000000""**
""FSPIOP-Source: pispa""
""FSPIOP-Destination: dfspa""
Expand Down
2 changes: 1 addition & 1 deletion docs/api/thirdparty/assets/diagrams/transfer/1-2-3-signed-authorization-generic.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ note right of D1
the Credential's privateKey to sign the challenge
end note

rnote right of D1 #Light
rnote right of D1 #LightYellow
**""PUT /thirdpartyRequests/authorizations/33333333-0000-0000-0000-000000000000""**
""FSPIOP-Source: pispa""
""FSPIOP-Destination: dfspa""
Expand Down
4 changes: 2 additions & 2 deletions docs/api/thirdparty/assets/diagrams/transfer/1-2-4-verify-authorization.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ end box

D2 -> D2: Generate a new ""verificationRequestId"", and associate \n it with the ""thirdpartyTransactionRequestId""

rnote left of D2 #Light
rnote left of D2 #LightYellow
**""POST /thirdpartyRequests/verifications""**
""FSPIOP-Source: dfspa""
""FSPIOP-Destination: central-auth""
Expand Down Expand Up @@ -59,7 +59,7 @@ AUTHS -> AUTHS: Lookup this consent based on consentId
AUTHS -> AUTHS: Ensure the accountAddress matches what is in Consent
AUTHS -> AUTHS: Check that the signed bytes match the \npublickey we have stored for the consent

rnote right of AUTHS #Light
rnote right of AUTHS #LightYellow
**""PUT /thirdpartyRequests/verifications/44444444-0000-0000-0000-000000000000""**
""FSPIOP-Source: central-auth""
""FSPIOP-Destination: dfspa""
Expand Down
8 changes: 4 additions & 4 deletions docs/api/thirdparty/assets/diagrams/transfer/1-3-transfer.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ actor "<$actor>\nPayee" as CB

D2 -> D2: Generate a new ""transferId"", and associate \n it with the ""transactionRequestId""

rnote over D2 #Light
rnote over D2 #LightYellow
**""POST /transfers""**
""FSPIOP-Source: dfspa""
""FSPIOP-Destination: dfspb""
Expand All @@ -116,7 +116,7 @@ end note
D2 -> S: ""POST /transfers""
S --> D2: ""202 Accepted""

rnote over S #Light
rnote over S #LightYellow
**""POST /transfers""**
""FSPIOP-Source: dfspa""
""FSPIOP-Destination: dfspb""
Expand All @@ -136,7 +136,7 @@ end note
S -> D3: ""POST /transfers""
D3 --> S: ""202 Accepted""

rnote left of D3 #Light
rnote left of D3 #LightYellow
**""PUT /transfers/55555555-0000-0000-0000-000000000000""**
""FSPIOP-Source: dfspb""
""FSPIOP-Destination: dfspa""
Expand All @@ -155,7 +155,7 @@ D2 --> S: ""200 OK""

D2 -> D2: Look up ""transactionRequestId"" from the ""transferId""

rnote over D2 #Light
rnote over D2 #LightYellow
**""PATCH /thirdpartyRequests/transactions/00000000-0000-0000-0000-000000000000""**
""FSPIOP-Source: dfspa""
""FSPIOP-Destination: pispa""
Expand Down
4 changes: 2 additions & 2 deletions docs/api/thirdparty/assets/diagrams/transfer/3-2-1-bad-tx-request.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ end box


== Agreement Phase ==
rnote right of D1 #Light
rnote right of D1 #LightYellow
**""POST /thirdpartyRequests/transactions""**
""FSPIOP-Source: pispa""
""FSPIOP-Destination: dfspa""
Expand Down Expand Up @@ -68,7 +68,7 @@ D2 --> S: ""202 Accepted""
D2 -> D2: DFSP finds something wrong with this transaction request.


rnote left of D2 #Light
rnote left of D2 #LightYellow
**""PUT /thirdpartyRequests/transactions""**
**"" /00000000-0000-0000-0000-000000000000/error""**
""FSPIOP-Source: dfspa""
Expand Down
8 changes: 4 additions & 4 deletions docs/api/thirdparty/assets/diagrams/transfer/3-3-1-bad-quote-request.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ end box
D2 -> D2: Generate a unique transactionId for this transaction request:\n**""11111111-0000-0000-0000-000000000000""**


rnote left of D2 #Light
rnote left of D2 #LightYellow
**""PUT /thirdpartyRequests/transactions""**
**"" /00000000-0000-0000-0000-000000000000""**
""FSPIOP-Source: dfspa""
Expand All @@ -50,7 +50,7 @@ S --> D2: ""200 OK""
S -> D1: ""PUT /thirdpartyRequests/transactions""\n"" /00000000-0000-0000-0000-000000000000""
D1 --> S: ""200 OK""

rnote left of D2 #Light
rnote left of D2 #LightYellow
**""POST /quotes""**
""FSPIOP-Source: dfspa""
""FSPIOP-Destination: dfspb""
Expand Down Expand Up @@ -99,7 +99,7 @@ D3 --> S: ""202 Accepted""

D3 -> D3: Quote fails for some reason.

rnote left of D3 #Light
rnote left of D3 #LightYellow
**""PUT /quotes/22222222-0000-0000-0000-000000000000/error""**
""FSPIOP-Source: dfspb""
""FSPIOP-Destination: dfspa""
Expand All @@ -120,7 +120,7 @@ note left of D2
Quote failed, DFSP needs to inform PISP
end note

rnote left of D2 #Light
rnote left of D2 #LightYellow
**""PUT /thirdpartyRequests/transactions""**
**"" /00000000-0000-0000-0000-000000000000/error""**
""FSPIOP-Source: dfspa""
Expand Down
8 changes: 4 additions & 4 deletions docs/api/thirdparty/assets/diagrams/transfer/3-3-2-bad-transfer-request.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ end box

D2 -> D2: Generate a new ""transferId"", and associate \n it with the ""transactionRequestId""

rnote over D2 #Light
rnote over D2 #LightYellow
**""POST /transfers""**
""FSPIOP-Source: dfspa""
""FSPIOP-Destination: dfspb""
Expand All @@ -60,7 +60,7 @@ end note
D2 -> S: ""POST /transfers""
S --> D2: ""202 Accepted""

rnote over S #Light
rnote over S #LightYellow
**""POST /transfers""**
""FSPIOP-Source: dfspa""
""FSPIOP-Destination: dfspb""
Expand All @@ -80,7 +80,7 @@ end note
S -> D3: ""POST /transfers""
D3 --> S: ""202 Accepted""

rnote left of D3 #Light
rnote left of D3 #LightYellow
**""PUT /transfers/55555555-0000-0000-0000-000000000000/error""**
""FSPIOP-Source: dfspb""
""FSPIOP-Destination: dfspa""
Expand All @@ -101,7 +101,7 @@ note left of D2
Transfer failed, DFSP needs to inform PISP
end note

rnote left of D2 #Light
rnote left of D2 #LightYellow
**""PUT /thirdpartyRequests/transactions""**
**"" /00000000-0000-0000-0000-000000000000/error""**
""FSPIOP-Source: dfspa""
Expand Down
4 changes: 2 additions & 2 deletions docs/api/thirdparty/assets/diagrams/transfer/3-4-1-bad-signed-challenge-self-hosted.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ note right of D1
the **""challenge""** string
end note

rnote right of D1 #Light
rnote right of D1 #LightYellow
**""PUT /thirdpartyRequests/authorizations/33333333-0000-0000-0000-000000000000""**
""FSPIOP-Source: pispa""
""FSPIOP-Destination: dfspa""
Expand Down Expand Up @@ -74,7 +74,7 @@ note over D2
end note


rnote left of D2 #Light
rnote left of D2 #LightYellow
**""PUT /thirdpartyRequests/transactions""**
**"" /00000000-0000-0000-0000-000000000000/error""**
""FSPIOP-Source: dfspa""
Expand Down
8 changes: 4 additions & 4 deletions docs/api/thirdparty/assets/diagrams/transfer/3-4-2-bad-signed-challenge-auth-service.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ note right of D1
the **""challenge""** string
end note

rnote right of D1 #Light
rnote right of D1 #LightYellow
**""PUT /thirdpartyRequests/authorizations""**
**"" /33333333-0000-0000-0000-000000000000""**
""FSPIOP-Source: pispa""
Expand Down Expand Up @@ -74,7 +74,7 @@ D2 -> D2: Lookup ""consentId"" for this ""transactionRequestId""

D2 -> D2: Generate a new ""verificationRequestId"", and associate \n it with the ""thirdpartyTransactionRequestId""

rnote left of D2 #Light
rnote left of D2 #LightYellow
**""POST /thirdpartyRequests/verifications""**
""FSPIOP-Source: dfspa""
""FSPIOP-Destination: central-auth""
Expand Down Expand Up @@ -105,7 +105,7 @@ AUTHS -> AUTHS: Lookup this consent based on consentId
AUTHS -> AUTHS: Ensure the accountAddress matches what is in Consent
AUTHS -> AUTHS: Check that the signed bytes match the \npublickey we have stored for the consent

rnote right of AUTHS #Light
rnote right of AUTHS #LightYellow
**""PUT /thirdpartyRequests/verifications""**
**"" /44444444-0000-0000-0000-000000000000/error""**
""FSPIOP-Source: central-auth""
Expand All @@ -128,7 +128,7 @@ note over D2
end note


rnote left of D2 #Light
rnote left of D2 #LightYellow
**""PUT /thirdpartyRequests/transactions""**
**"" /00000000-0000-0000-0000-000000000000/error""**
""FSPIOP-Source: dfspa""
Expand Down
2 changes: 1 addition & 1 deletion docs/api/thirdparty/assets/diagrams/transfer/3-6-tpr-timeout.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ box "DFSP A"
end box


rnote right of D1 #Light
rnote right of D1 #LightYellow
**""POST /thirdpartyRequests/transactions""**
""FSPIOP-Source: pispa""
""FSPIOP-Destination: dfspa""
Expand Down
4 changes: 2 additions & 2 deletions docs/api/thirdparty/assets/diagrams/transfer/get_transaction_request.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ end note



rnote right of D1 #Light
rnote right of D1 #LightYellow
**""GET /thirdpartyRequests/transactions/00000000-0000-0000-0000-000000000000""**
""FSPIOP-Source: pispa""
""FSPIOP-Destination: dfspa""
Expand All @@ -50,7 +50,7 @@ D2 --> S: ""202 Accepted""
D2 -> D2: DFSP looks up already created \nthirdparty transaction request
D2 -> D2: DFSP ensures that the FSPIOP-Source (pisp)\nis the same as the original sender of \n""POST /thirdpartyRequests/transactions/00000000-0000-0000-0000-000000000000""

rnote left of D2 #Light
rnote left of D2 #LightYellow
**""PUT /thirdpartyRequests/transactions/00000000-0000-0000-0000-000000000000""**
""FSPIOP-Source: dfspa""
""FSPIOP-Destination: pispa""
Expand Down
4 changes: 4 additions & 0 deletions ...ntral-ledger/assets/diagrams/architecture/Transfers-Position-Binning.drawio.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading