Robosats/robosats
1
0
Fork 0
mirror of https://github.com/RoboSats/robosats.git synced 2025-07-19 09:13:28 +00:00
Code Issues Packages Projects Releases Wiki Activity
robosats/development/docs.md
koalasat 89c0fcade5 Dev docs +
2025-06-27 17:32:51 +02:00

1.5 KiB
Raw Blame History

Documentation

Client

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.

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.

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.

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.