mirror of
https://github.com/bits-wallet/specs.git
synced 2025-12-17 05:34:21 +01:00
c24dba5468b01978692b767dc56576ec23be5cf6
Specs
BitsApp specifications (BAS in short) stand for BitsApp Implementation Specifications. Specs are written to provide open and accessible documentation for BitsApp implementation details.
- BAS-01: One-directional channels
- BAS-02: Expiring channel addresses
- BAS-11: Silent swaps
- BAS-12: Swap factories
- BAS-13: Swap formation protocol
- BAS-14: Swap credit protocol
- BAS-15: Swap settlement protocol
- BAS-31: Swap statuses
- BAS-32: Payment statuses
- BAS-33: Interactive swap invoices
- BAS-34: Non-interactive swap invoices
- BAS-41: Permenant channel addresses
- BAS-42: Encumbered swap factories
- BAS-43: Inbound swap settlement protocol
- BAS-44: Swap factory trees
- BAS-45: Swap settlement credits
- BAS-51: Channel backups
- BAS-52: Channel recovery
- BAS-53: Swap service
- BAS-54: Routing service
- BAS-55: Service provider federation
Spec Categorization
Onboarding
| Index | Specification | Status |
|---|---|---|
| BAS-01 | One-directional channels | Draft |
| BAS-02 | Expiring channel addresses | Draft |
Receiving
| Index | Specification | Status |
|---|---|---|
| BAS-03 | Silent swaps | Draft |
| BAS-04 | Swap factoriees | Draft |
| BAS-05 | Swap formation protocol | Draft |
| BAS-06 | Swap credit protocol | Draft |
| BAS-07 | Swap settlement protocol | Draft |
User Experience
| Index | Specification | Status |
|---|---|---|
| BAS-08 | Swap statusses | Draft |
| BAS-09 | Payment statusses | Draft |
| BAS-10 | Interactive swap invocies | Draft |
| BAS-11 | Non-interactive swap invoices | Draft |
Future Extensions
| Index | Specification | Status |
|---|---|---|
| BAS-12 | Permenant channel addresses | Draft |
| BAS-13 | Encumbered swaps factories | Draft |
| BAS-14 | Inbound swap settlement protocol | Draft |
| BAS-15 | Swap factory trees | Draft |
| BAS-16 | Swap settlement credits | Draft |
Future Extensions
| Index | Specification | Status |
|---|---|---|
| BAS-12 | Permenant channel addresses | Draft |
| BAS-13 | Encumbered swaps factories | Draft |
| BAS-14 | Inbound swap settlement protocol | Draft |
| BAS-15 | Swap factory trees | Draft |
| BAS-16 | Swap settlement credits | Draft |
Relay to Client
| type | description | NIP |
|---|---|---|
| EVENT | used to send events requested to clients | 1 |
| NOTICE | used to send human-readable messages to clients | 1 |
| EOSE | used to notify clients all stored events have been sent | 15 |
| OK | used to notify clients if an EVENT was successuful | 20 |
Please update these lists when proposing NIPs introducing new event kinds.
When experimenting with kinds, keep in mind the classification introduced by NIP-16.
Criteria for acceptance of NIPs
- They should be implemented in at least two clients and one relay -- when applicable.
- They should make sense.
- They should be optional and backwards-compatible: care must be taken such that clients and relays that choose to not implement them do not stop working when interacting with the ones that choose to.
- There should be no more than one way of doing the same thing.
- Other rules will be made up when necessary.
License
Description
Languages
Markdown
100%