diff --git a/development/assets/robot.png b/development/assets/robot.png new file mode 100644 index 00000000..4cbd8f75 Binary files /dev/null and b/development/assets/robot.png differ diff --git a/development/docs.md b/development/docs.md index 99dce46d..05054c8a 100644 --- a/development/docs.md +++ b/development/docs.md @@ -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 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.
@@ -12,7 +12,7 @@ The `Garage` contains user's tokens separated by `Slots`. Every `Slot` stores th ### 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. +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.
@@ -26,10 +26,18 @@ A `Coordinator` contains the main data obtained from its primary API endpoints:
+### Robot + +A `Robot` fetches the information that a specific `Coordinator` has about a token and all necessary functions to interact with it. + +
+ +
+ ### 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.
-
+
\ No newline at end of file