Robosats/robosats
1
0
Fork 0
mirror of https://github.com/RoboSats/robosats.git synced 2025-09-13 00:56:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Dev docs +

Browse Source
This commit is contained in:
koalasat
2025-06-27 17:32:51 +02:00
parent 6851f3bdba
commit 89c0fcade5
3 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
development/assets/coordinator.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 288 KiB

BIN
development/assets/order.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 131 KiB

20
development/docs.md
View File

@ -4,7 +4,7 @@
### Garage
The `Garage` contains user's tokens separated by `Slots` . Every `Slot` stores the core data generated with the token and a set of `Robots`. Each `Robot` fetches the information a `Coordinator` has about that specific token. Tokens should be always sent to all coordinators on creation/recovery to ensure consistency and good UX.
The `Garage` contains user's tokens separated by `Slots` . Every `Slot` stores the core data generated with the token and a set of `Robots`. Each `Robot` fetches the information a `Coordinator` has about that specific token. Tokens should be always sent to all coordinators on creation/recovery to ensure consistency and good UX.
<div align="center">
<img src="/development/assets/garage.png" width="500px">
@ -12,8 +12,24 @@ The `Garage` contains user's tokens separated by `Slots` . Every `Slot` stores t
### Federation
The `Federation` stores information from all available coordinators. A `Coordinator` contains the main data obtained from its main API endpoints: `/api/book`, `/api/limits` and `/api/info`. This information is aggregated in the `Federation`: `book` for all orders and `exchange` for coordinator's meta data.
The `Federation` stores information from all available coordinators. A `Coordinator` contains the main data obtained from its main API endpoints: `/api/book`, `/api/limits` and `/api/info`. This information is aggregated in the `Federation`: `book` for all orders and `exchange` for coordinator's meta data.
<div align="center">
<img src="/development/assets/federation.png" width="500px">
</div>
### Coordinator
A `Coordinator` contains the main data obtained from its main API endpoints: `/api/book`, `/api/limits` and `/api/info` and provides functions for any necesary API call on this matter.
<div align="center">
<img src="/development/assets/coordinator.png" width="300px">
</div>
### Order
An `Order` contains the details obtained from the coordinator hosting it and all necessary functions to interact with it. The client also has the concept of `MakerForm`, which is none other than the necessary data for order creation before it is sent to the selected coordinator.
<div align="center">
<img src="/development/assets/order.png" width="300px">
</div>