Robosats/robosats
1
0
Fork 0
mirror of https://github.com/RoboSats/robosats.git synced 2025-07-19 17:23:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs.md

Browse Source
This commit is contained in:
KoalaSat
2025-06-27 15:38:24 +00:00
committed by GitHub
parent 89c0fcade5
commit e4deef613c
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
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 users' tokens separated by `Slots`. Every `Slot` stores the core data generated with the token and a set of `Robots`. Each `Robot` fetches the information that a `Coordinator` has about that specific token. Tokens should always be sent to all coordinators upon creation or recovery to ensure consistency and a good user experience.
<div align="center">
<img src="/development/assets/garage.png" width="500px">
@ -12,7 +12,7 @@ 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. All coordinators information is aggregated here: `book` for all orders and `exchange` for `Coordinator`'s meta data.
<div align="center">
<img src="/development/assets/federation.png" width="500px">
@ -20,7 +20,7 @@ The `Federation` stores information from all available coordinators. A `Coordina
### 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.
A `Coordinator` contains the main data obtained from its primary API endpoints: `/api/book`, `/api/limits` and `/api/info`, and provides functions for any necessary API calls related to this matter. It also stores some static data loaded from [federation.json](/frontend/static/federation.json).
<div align="center">
<img src="/development/assets/coordinator.png" width="300px">