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

docs: documention of SATP package #3619

Open
wants to merge 1 commit into
base: satp-dev
Choose a base branch
from
Open

docs: documention of SATP package #3619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 24 additions & 16 deletions packages/cactus-plugin-satp-hermes/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,27 +55,35 @@ Firstly let us identify the different entities involved in the protocol and what

The sequence diagram of SATP is pictured below.

![satp-sequence-diagram](https://i.imgur.com/SOdXFEt.png)
![satp-sequence-diagram](images/SATP-Protocol.jpg))

### Application-to-Gateway API (API Type 1)
We

### Gateway-to-Gateway API (API Type 2)
This plugin uses OpenAPI to generate the API paths.
There are Client and Server Endpoints for each type of message detailed in the SATP protocol:

- TransferInitializationV1Request
- TransferInitializationV1Response
- TransferCommenceV1Request
- TransferCommenceV1Response
- LockEvidenceV1Request
- LockEvidenceV1Response
- CommitPreparationV1Request
- CommitPreparationV1Response
- CommitFinalV1Request
- CommitFinalV1Response
- TransferCompleteV1Request
- ClientV1Request
This plugin in the Gateway-to-Gateway communication uses grpc.

There are Client and Server GRPC Endpoints for each type of message detailed in the SATP protocol:

- Stage 0:
- NewSessionRequest
- NewSessionResponse
- PreSATPTransferRequest
- PreSATPTransferResponse
- Stage 1:
- TransferProposalRequestMessage
- TransferProposalReceiptMessage
- TransferCommenceRequestMessage
- TransferCommenceResponseMessage
- Stage 2:
- LockAssertionRequestMessage
- LockAssertionReceiptMessage
- Stage 3:
- CommitPreparationRequestMessage
- CommitReadyResponseMessage
- CommitFinalAssertionRequestMessage
- CommitFinalAcknowledgementReceiptResponseMessage
- TransferCompleteRequestMessage

There are also defined the endpoints for the crash recovery procedure (there is still missing the endpoint to receive the Rollback mesage):
- RecoverV1Message
Expand Down
Binary file added packages/cactus-plugin-satp-hermes/images/SATP-Protocol.jpg
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.
6 changes: 6 additions & 0 deletions ...ypescript/fabric-contracts/satp-wrapper/chaincode-typescript/src/interaction-signature.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
* SPDX-License-Identifier: Apache-2.0
*/

/**
* InteractionSignatureType is an enum that represents the type of the interaction signature.
*/
export enum InteractionSignatureType {
MINT = 0,
BURN = 1,
Expand All @@ -11,6 +14,9 @@ export enum InteractionSignatureType {
UNLOCK = 5,
}

/**
* VarType is an enum that represents the type of the variables.
*/
export enum VarType {
CONTRACTNAME = 0,
CHANNELNAME = 1,
Expand Down
Loading
Loading