This repository contains the complete documentation for the OpenSwap Protocol, an atomic swap protocol that enables trustless atomic swaps through a decentralized, Sybil-resistant marketplace using Bitcoin-based fidelity bonds. This documentation provides an in-depth overview of the protocol's architecture, functionality, and other important details.
All documentation for the first version of the protocol is located in the v1 directory.Reading v1 is recommended to understand the historical context and design motivations that influenced later revisions.
The v1 docs are organized as follows:
- Architecture: An explanation of the protocol’s architecture, participants, and transaction types.
- Messages: A detailed description all messages exchanged during a swap.
- Protocol Flow: A Step-by-Step description of a OpenSwap.
All documentation for the second version of the protocol is located in the v2 directory.The refinement of protocol and adoption of Taproot and MuSig2 for improved privacy and efficiency.
The v2 docs are organized as follows:
- Architecture: Updated architecture, participants, and transaction types for the Taproot–MuSig2-based design.
- Messages: A detailed specification of all messages exchanged during a swap, including fields and semantics.
- Protocol Flow: Step-By-Step description of a Taproot–MuSig2 OpenSwap.
All other general documents that applies to both the protocols are as follows:
- Introduction: An overview of the OpenSwap Protocol, its history, and core features.
- Architecture: An overview of the OpenSwap server, client and the marketplace.
- Fidelity: Explanation of fidelity bonds and their role in the protocol.
- Fees: Overview of how fees are structured and accounted for within OpenSwap transactions.
- Security: A discussion of the security considerations in the OpenSwap Protocol.
- Privacy: A discussion on how openswap provides privacy.
- Tor Address Derivation: How a maker's Tor onion address is deterministically derived from the wallet master key.