xmr-btc-swap/docs/sequence.puml

@startuml
database Bitcoin
actor Bob as "Bob (User)"
Actor Alice as "Alice (Service Provider)"
database Monero

group Negotiation

    Bob --> Alice: Establish connection

    group Request Response Channel
        Bob -> Alice: Quote request
        note left: Btc Amount\naddress hints
        note right: Alice stores peer id & address hints\nto contact Bob

        Alice --> Bob: Quote response
        note right: Exact XMR amount
    end
end

group Execution Setup
    group Phase A [Messages can be exchanged in any order]
        Bob -> Alice: Message0
        note left: Pubkeys\ndleq proof s_b\nxmr viewkey v_b\nbtc refund addr

        Alice -> Bob: Message1
        note right: Pubkeys\ndleq proof s_a\nxmr view key v_a\nbtc redeem addr\nbtc punish addr
    end

    group Phase B [Messages must be exchanged in the given order]

        Bob -> Alice: Message2
        note left: unsigned btc lock tx

        Alice -> Bob: Message3
        note right: btc cancel tx sig\nbtc refund tx enc sig S_b

        Bob -> Alice: Message4
        note left: btc punish tx sig\nbtc cancel tx sig

    end
end

group Execution
    Bob ->> Bitcoin: Lock

    Alice ->> Monero: Lock

    Alice -> Bob: TransferProof
    note right: xmr lock tx transfer proof\nThis can be removed if Bob watches the blockchain.

    Bob -> Alice: EncryptedSignature
    note left: redeem tx enc sig S_a

    Alice ->> Bitcoin: Redeem

    Bitcoin ->> Bob: Signature

    Bob -> Bob: Extract s_a

    Bob ->> Monero: Redeem
end

@enduml
Add sequence diagram 2021-01-13 00:12:57 +00:00			`@startuml`
			`database Bitcoin`
Clarify who is user/SP 2021-01-14 00:48:49 +00:00			`actor Bob as "Bob (User)"`
			`Actor Alice as "Alice (Service Provider)"`
Add sequence diagram 2021-01-13 00:12:57 +00:00			`database Monero`

Remove Req-Res and update for single market maker use case - Bob initiate swap with BTC Amount - Alice acks with approx. xmr amount - Rework terminology, make a difference between negotiations and execution setup - Remove request response channels in favor of one shots - Give exact amount to Bob once assets are locked 2021-01-13 00:47:02 +00:00			`group Negotiation`
Add sequence diagram 2021-01-13 00:12:57 +00:00
Remove Req-Res and update for single market maker use case - Bob initiate swap with BTC Amount - Alice acks with approx. xmr amount - Rework terminology, make a difference between negotiations and execution setup - Remove request response channels in favor of one shots - Give exact amount to Bob once assets are locked 2021-01-13 00:47:02 +00:00			`Bob --> Alice: Establish connection`
Add sequence diagram 2021-01-13 00:12:57 +00:00
Remove Req-Res and update for single market maker use case - Bob initiate swap with BTC Amount - Alice acks with approx. xmr amount - Rework terminology, make a difference between negotiations and execution setup - Remove request response channels in favor of one shots - Give exact amount to Bob once assets are locked 2021-01-13 00:47:02 +00:00			`group Request Response Channel`
The first message is actually a quote or rate request 2021-02-12 06:05:06 +00:00			`Bob -> Alice: Quote request`
Remove Req-Res and update for single market maker use case - Bob initiate swap with BTC Amount - Alice acks with approx. xmr amount - Rework terminology, make a difference between negotiations and execution setup - Remove request response channels in favor of one shots - Give exact amount to Bob once assets are locked 2021-01-13 00:47:02 +00:00			`note left: Btc Amount\naddress hints`
			`note right: Alice stores peer id & address hints\nto contact Bob`

The first message is actually a quote or rate request 2021-02-12 06:05:06 +00:00			`Alice --> Bob: Quote response`
Use exact xmr amount, Remove ACK - Use exact XMR amount - Remove ACK, this can be added as a feature once needed. 2021-01-13 23:46:50 +00:00			`note right: Exact XMR amount`
Remove Req-Res and update for single market maker use case - Bob initiate swap with BTC Amount - Alice acks with approx. xmr amount - Rework terminology, make a difference between negotiations and execution setup - Remove request response channels in favor of one shots - Give exact amount to Bob once assets are locked 2021-01-13 00:47:02 +00:00			`end`
Add sequence diagram 2021-01-13 00:12:57 +00:00			`end`

Remove Req-Res and update for single market maker use case - Bob initiate swap with BTC Amount - Alice acks with approx. xmr amount - Rework terminology, make a difference between negotiations and execution setup - Remove request response channels in favor of one shots - Give exact amount to Bob once assets are locked 2021-01-13 00:47:02 +00:00			`group Execution Setup`
Use global counter to name messages 2021-01-13 23:27:33 +00:00			`group Phase A [Messages can be exchanged in any order]`
Implement new behaviour for execution setup 2021-02-03 05:45:43 +00:00			`Bob -> Alice: Message0`
Remove Req-Res and update for single market maker use case - Bob initiate swap with BTC Amount - Alice acks with approx. xmr amount - Rework terminology, make a difference between negotiations and execution setup - Remove request response channels in favor of one shots - Give exact amount to Bob once assets are locked 2021-01-13 00:47:02 +00:00			`note left: Pubkeys\ndleq proof s_b\nxmr viewkey v_b\nbtc refund addr`
Add sequence diagram 2021-01-13 00:12:57 +00:00
Implement new behaviour for execution setup 2021-02-03 05:45:43 +00:00			`Alice -> Bob: Message1`
Remove Req-Res and update for single market maker use case - Bob initiate swap with BTC Amount - Alice acks with approx. xmr amount - Rework terminology, make a difference between negotiations and execution setup - Remove request response channels in favor of one shots - Give exact amount to Bob once assets are locked 2021-01-13 00:47:02 +00:00			`note right: Pubkeys\ndleq proof s_a\nxmr view key v_a\nbtc redeem addr\nbtc punish addr`
			`end`
Add sequence diagram 2021-01-13 00:12:57 +00:00
Use global counter to name messages 2021-01-13 23:27:33 +00:00			`group Phase B [Messages must be exchanged in the given order]`
Add sequence diagram 2021-01-13 00:12:57 +00:00
Implement new behaviour for execution setup 2021-02-03 05:45:43 +00:00			`Bob -> Alice: Message2`
Remove Req-Res and update for single market maker use case - Bob initiate swap with BTC Amount - Alice acks with approx. xmr amount - Rework terminology, make a difference between negotiations and execution setup - Remove request response channels in favor of one shots - Give exact amount to Bob once assets are locked 2021-01-13 00:47:02 +00:00			`note left: unsigned btc lock tx`

Implement new behaviour for execution setup 2021-02-03 05:45:43 +00:00			`Alice -> Bob: Message3`
Remove Req-Res and update for single market maker use case - Bob initiate swap with BTC Amount - Alice acks with approx. xmr amount - Rework terminology, make a difference between negotiations and execution setup - Remove request response channels in favor of one shots - Give exact amount to Bob once assets are locked 2021-01-13 00:47:02 +00:00			`note right: btc cancel tx sig\nbtc refund tx enc sig S_b`
Add sequence diagram 2021-01-13 00:12:57 +00:00
Implement new behaviour for execution setup 2021-02-03 05:45:43 +00:00			`Bob -> Alice: Message4`
Remove Req-Res and update for single market maker use case - Bob initiate swap with BTC Amount - Alice acks with approx. xmr amount - Rework terminology, make a difference between negotiations and execution setup - Remove request response channels in favor of one shots - Give exact amount to Bob once assets are locked 2021-01-13 00:47:02 +00:00			`note left: btc punish tx sig\nbtc cancel tx sig`
Add sequence diagram 2021-01-13 00:12:57 +00:00
Remove Req-Res and update for single market maker use case - Bob initiate swap with BTC Amount - Alice acks with approx. xmr amount - Rework terminology, make a difference between negotiations and execution setup - Remove request response channels in favor of one shots - Give exact amount to Bob once assets are locked 2021-01-13 00:47:02 +00:00			`end`
			`end`
Add sequence diagram 2021-01-13 00:12:57 +00:00
Remove Req-Res and update for single market maker use case - Bob initiate swap with BTC Amount - Alice acks with approx. xmr amount - Rework terminology, make a difference between negotiations and execution setup - Remove request response channels in favor of one shots - Give exact amount to Bob once assets are locked 2021-01-13 00:47:02 +00:00			`group Execution`
Add sequence diagram 2021-01-13 00:12:57 +00:00			`Bob ->> Bitcoin: Lock`

			`Alice ->> Monero: Lock`

Improve names for messages 4 and 5 2021-01-27 03:14:20 +00:00			`Alice -> Bob: TransferProof`
Use exact xmr amount 2021-01-13 23:45:29 +00:00			`note right: xmr lock tx transfer proof\nThis can be removed if Bob watches the blockchain.`
Add sequence diagram 2021-01-13 00:12:57 +00:00
Improve names for messages 4 and 5 2021-01-27 03:14:20 +00:00			`Bob -> Alice: EncryptedSignature`
Clarify diagram 2021-01-13 00:36:02 +00:00			`note left: redeem tx enc sig S_a`
Add sequence diagram 2021-01-13 00:12:57 +00:00
			`Alice ->> Bitcoin: Redeem`

			`Bitcoin ->> Bob: Signature`

Clarify diagram 2021-01-13 00:36:02 +00:00			`Bob -> Bob: Extract s_a`
Add sequence diagram 2021-01-13 00:12:57 +00:00
			`Bob ->> Monero: Redeem`
Remove Req-Res and update for single market maker use case - Bob initiate swap with BTC Amount - Alice acks with approx. xmr amount - Rework terminology, make a difference between negotiations and execution setup - Remove request response channels in favor of one shots - Give exact amount to Bob once assets are locked 2021-01-13 00:47:02 +00:00			`end`
Add sequence diagram 2021-01-13 00:12:57 +00:00
			`@enduml`