2025-06-27 15:54:31 +00:00

1.6 KiB

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 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.

Federation

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. When the Nostr connection is active, book is filled with orders from relays instead.

Coordinator

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.

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.