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

Development docs

Browse Source
This commit is contained in:
koalasat
2025-06-27 18:02:09 +02:00
parent d844b621aa
commit c0bf9b9477
2 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 157 KiB

10
development/docs.md
View File

@ -4,7 +4,7 @@
### Garage ### 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 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. The `Garage` contains user's tokens separated by `Slots`. Every `Slot` stores the core data generated with the token and a set of `Robots`. Tokens should always be sent to all coordinators upon creation or recovery to ensure consistency and a good user experience.
<div align="center"> <div align="center">
<img src="/development/assets/garage.png" width="500px"> <img src="/development/assets/garage.png" width="500px">
@ -26,6 +26,14 @@ A `Coordinator` contains the main data obtained from its primary API endpoints:
<img src="/development/assets/coordinator.png" width="300px"> <img src="/development/assets/coordinator.png" width="300px">
</div> </div>
### Robot
A `Robot` fetches the information that a specific `Coordinator` has about a token and all necessary functions to interact with it.
<div align="center">
<img src="/development/assets/robot.png" width="300px">
</div>
### Order ### 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. 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.