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

[BP: release/v6 <- #158] Upgrade sequence diagrams from ASCII to Mermaid. #161

Closed
wants to merge 1 commit into from
Closed

[BP: release/v6 <- #158] Upgrade sequence diagrams from ASCII to Mermaid. #161

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
87 changes: 53 additions & 34 deletions middleware/packet-forward-middleware/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,44 +14,63 @@ initial IBC release.

## Sequence diagrams

### Multi-hop A->B->C->D success
```ascii
channel-0 channel-1 channel-2 channel-3 channel-4 channel-5
┌───────┐ ibc ┌───────┐ ibc ┌───────┐ ibc ┌───────┐
│Chain A│◄────────────────►│Chain B│◄────────────────►│Chain C│◄────────────────►│Chain D│
└───────┘ └───────┘ └───────┘ └───────┘
1. transfer 2. recv_packet 3. forward 4. recv_packet 5. forward 6. recv_packet
─────────────────► packet ─────────────────► packet ─────────────────►
9. ack forward 8. ack forward 7. ack
◄───────────────── middleware◄─────────────── middleware◄───────────────
### Let's stipulate the following connections between chains A, B, C, and D
```mermaid
flowchart LR
A((Chain A))
B((Chain B))
C((Chain C))
D((Chain D))

A <--"ch-0 ch-1 (IBC)"--> B
B <--"ch-2 ch-3 (IBC)"--> C
C <--"ch-4 ch-5 (IBC)"--> D
```

### Multi-hop A->B->C->D, C->D `recv_packet` error, refund back to A
```ascii
channel-0 channel-1 channel-2 channel-3 channel-4 channel-5
┌───────┐ ibc ┌───────┐ ibc ┌───────┐ ibc ┌───────┐
│Chain A│◄────────────────►│Chain B│◄────────────────►│Chain C│◄────────────────►│Chain D│
└───────┘ └───────┘ └───────┘ └───────┘
1. transfer 2. recv_packet 3. forward 4. recv_packet 5. forward 6. recv_packet ERR
─────────────────► packet ─────────────────► packet ─────────────────►
9. ack ERR forward 8. ack ERR forward 7. ack ERR
◄───────────────── middleware◄─────────────── middleware◄───────────────

### SCENARIO: Via PFM, Chain A wants to pass a message to Chain D (to which it's not directly connected).
```mermaid
sequenceDiagram
autonumber
Chain A ->> Chain B: PFM transfer
Chain B --> Chain B: recv_packet
Chain B ->> Chain C: forward
Chain C --> Chain C: recv_packet
Chain C ->> Chain D: forward
Chain D --> Chain D: recv_packet
Chain D ->> Chain C: ack
Chain C ->> Chain B: ack
Chain B ->> Chain A: ack
```

### SCENARIO: Multi-hop A->B->C->D, C->D `recv_packet` error, refund back to A

```mermaid
sequenceDiagram
autonumber
Chain A ->> Chain B: PFM transfer
Chain B --> Chain B: recv_packet
Chain B ->> Chain C: forward
Chain C --> Chain C: recv_packet
Chain C ->> Chain D: forward
Chain D --> Chain D: ☠️ recv_packet ERR ☠️
Chain D ->> Chain C: ☠️ ack ERR ☠️
Chain C ->> Chain B: ☠️ ack ERR ☠️
Chain B ->> Chain A: ☠️ ack ERR ☠️
```

### Forward A->B->C with 1 retry, max timeouts occurs, refund back to A
```ascii
channel-0 channel-1 channel-2 channel-3
┌───────┐ ibc ┌───────┐ ibc ┌───────┐
│Chain A│◄────────────────►│Chain B│◄────────────────►│Chain C│
└───────┘ └───────┘ └───────┘
1. transfer 2. recv_packet 3. forward
─────────────────► packet ─────────────────►
forward 4. timeout
middleware◄───────────────
5. forward retry
─────────────────►
7. ack ERR 6. timeout
◄───────────────── ◄─────────────────
### SCENARIO: Forward A->B->C with 1 retry, max timeouts occurs, refund back to A

```mermaid
sequenceDiagram
autonumber
Chain A ->> Chain B: PFM transfer
Chain B --> Chain B: recv_packet
Chain B ->> Chain C: forward
Chain C --x Chain B: timeout
Chain B ->> Chain C: forward retry
Chain C --x Chain B: timeout
Chain B ->> Chain A: ☠️ ack ERR ☠️
```

## Examples
Expand Down
Loading