Implement Integration API for Gateways

[AndreAugusto11]

Tasks: 1 - Define and Implement the specific endpoints that users will have access to. 2 - define openapi for application layer 3 - create SDK, including the event listners 4 - change satp helpers to get input from event listeners

[AndreAugusto11]

https://finp2p.atlassian.net/wiki/spaces/FINP2P/

[AndreAugusto11]

Client Facing Endpoints

The gateway will store logs with the information of each request, signed by the client app, for accountability. We also need some kind of mechanism to protect the gateway from replay attacks (like a nonce).

/route

Request the gateway a route available to transfer an asset from network from to network to

Input:

• clientApp pubKey
• from network
• to network
• app id
• session id
• signature

Output:

• a set of gateways composing a path from from to to
• signature

/transact

Request the gateway to transfer an asset asset ID owned on network from to network to.

Input:

• from
• to
• set of events to listen for
• other fields necessary for the clientRequest to initiate SATP
• from smart contract (temos de pensar quem tem permissões no SC. Se a gateway tem de ter permissões no contrato)
• to smart contract
• signature

Relevant Discussion:

• If the client app specifies the smart contracts of origin and destination, the gateway needs permission to access those smart contracts. Existing contracts must set the gateway as trusted, which may not be an adopted solution.
• The second solution is the client app sending signed transactions to the gateway, which executes these based on the protocol. The gateway would need transactions for the normal execution of the protocol and rollbacks if possible.
• The client needs to be kept listening for events. We need to make sure there is an open channel between the gateway and the client app when running SATP, such that it is notified once any event of interest is emitted in the smart contract.

Output:

• session ID

/status

Request the gateway for the status of an open SATP session.

Input:

• session ID
• signature

Output:

• SATP session ID status (i.e., the step of the protocol)

/cancel

Input:

• session ID
• signature

Output:

• SATP session ID status

TBD

Define request(s) for the interaction with the adapter layer...