Files
specs/README.md
2023-01-10 00:05:12 +03:00

81 lines
4.3 KiB
Markdown

# Specs
BitsApp specifications (BDS in short) stand for **BitsApp Design Specifications**. Specs are written to provide open and accessible documentation for [BitsApp](https://bits.app) implementation details.
- [BDS-01: One-directional channels](01.md)
- [BDS-02: Expiring channel addresses](02.md)
- [BDS-03: Expiring channel formation protocol](03.md)
- [BDS-04: Silent swaps](04.md)
- [BDS-05: HTLC-nested channels](05.md)
- [BDS-06: Swap factories](06.md)
- [BDS-07: Swap formation protocol](07.md)
- [BDS-08: Swap credit protocol](08.md)
- [BDS-09: Swap settlement protocol](09.md)
- [BDS-10: Swap statusses](10.md)
- [BDS-11: Payment statusses](11.md)
- [BDS-12: Interactive swap invoices](12.md)
- [BDS-13: Non-interactive swap invoices](13.md)
- [BDS-14: Channel backups](14.md)
- [BDS-15: Channel recovery](15.md)
- [BDS-16: Swap service](16.md)
- [BDS-17: Routing service](17.md)
- [BDS-18: Service provider federation](18.md)
- [BDS-19: Permenant channel addresses](19.md)
- [BDS-20: Encumbered swap factories](20.md)
- [BDS-21: Inbound swap settlement protocol](21.md)
- [BDS-22: Swap factory trees](22.md)
- [BDS-23: Swap settlement credits](23.md)
## BDS Categorization
BitsApp implementation specifications are categorized under six sub-categories; onboarding, receiving, user experience, future extensions, backups & recovery, and service.
### Onboarding
| Index | Specification | Status |
|------- |----------------------------------------------------|------------|
| [BDS-01](01.md) | One-directional channels | Draft |
| [BDS-02](02.md) | Expiring channel addresses | Draft |
| [BDS-03](03.md) | Expiring channel formation prototocol | Draft |
### Receiving
| Index | Specification | Status |
|------- |----------------------------------------------------|------------|
| [BDS-04](04.md) | Silent swaps | Draft |
| [BDS-05](05.md) | HTLC-nested channels | Draft |
| [BDS-06](06.md) | Swap factories | Draft |
| [BDS-07](07.md) | Swap formation protocol | Draft |
| [BDS-08](08.md) | Swap credit protocol | Draft |
| [BDS-09](09.md) | Swap settlement protocol | Draft |
### User Experience
| Index | Specification | Status |
|------- |----------------------------------------------------|------------|
| [BDS-10](10.md) | Swap statusses | Draft |
| [BDS-11](11.md) | Payment statusses | Draft |
| [BDS-12](12.md) | Interactive swap invocies | Draft |
| [BDS-13](13.md) | Non-interactive swap invoices | Draft |
### Backups & Recovery
| Index | Specification | Status |
|------- |----------------------------------------------------|------------|
| [BDS-14](14.md) | Channel backups | Draft |
| [BDS-15](15.md) | Channel recovery | Draft |
### Service
| Index | Specification | Status |
|------- |----------------------------------------------------|------------|
| [BDS-16](16.md) | Swap service | Draft |
| [BDS-17](17.md) | Routing service | Draft |
| [BDS-18](18.md) | Service provider federation | Draft |
### Future Extensions
| Index | Specification | Status | Changes to Bitcoin required |
|------- |----------------------------------------------------|------------| -----------------------------|
| [BDS-19](19.md) | Permenant channel addresses | Draft | CSFS, TXHASH |
| [BDS-20](20.md) | Encumbered swaps factories | Draft | APO |
| [BDS-21](21.md) | Inbound swap settlement protocol | Draft | XOR |
| [BDS-22](22.md) | Swap factory trees | Draft | CTLUV, CSFS, TXHASH |
| [BDS-23](23.md) | Swap settlement credits | Draft | CTLUV, CSFS, TXHASH |
## License