Skip to content

Commit

Permalink
docs(mm-bot): add UML class diagramss
Browse files Browse the repository at this point in the history
  • Loading branch information
JuArce committed Feb 6, 2024
1 parent ece4888 commit fad9286
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 10 deletions.
21 changes: 20 additions & 1 deletion mm-bot/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,26 @@ Payment Registry contract.
- The bot must be able to retry failed orders.
- The bot must be able to perform adequate logs for the orders tracking.

[Version simplificada de la arquitectura]
### Simplified Class Diagram
```plantuml
@startuml
class Bot {
-order: Order
-paymentRegistry: PaymentRegistry
-database: Database
+run()
+readOrder()
+transfer()
+withdraw()
+storeOrder()
+updateOrder()
+storeError()
+retryOrder()
}
@enduml
```
![MM_Diagram_Class.svg](images%2FMM_Diagram_Class.svg)
![MM_Diagram_Class_Full.svg](images%2FMM_Diagram_Class_Full.svg)

## Development View (TODO)

Expand Down
25 changes: 16 additions & 9 deletions mm-bot/docs/diagrams/class_diagrams.puml
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,22 @@ hide members

class MM {
run()
process_order_events()
create_order_tasks()
process_order()
failed_orders_job()
process_failed_orders()
set_order_events_from_accepted_blocks_job()
process_orders_from_accepted_blocks()
transfer()
wait_transfer()
process_order_events(order_events: list, order_service: OrderService,
eth_lock: asyncio.Lock, herodotus_semaphore: asyncio.Semaphore)
create_order_tasks(order: Order, order_service: OrderService, eth_lock: asyncio.Lock,
herodotus_semaphore: asyncio.Semaphore)
process_order(order: Order, order_service: OrderService,
eth_lock: asyncio.Lock, herodotus_semaphore: asyncio.Semaphore)
failed_orders_job(order_service: OrderService,
eth_lock: asyncio.Lock, herodotus_semaphore: asyncio.Semaphore)
process_failed_orders(order_service: OrderService,
eth_lock: asyncio.Lock, herodotus_semaphore: asyncio.Semaphore)
set_order_events_from_accepted_blocks_job(order_service: OrderService, block_dao: BlockDao,
eth_lock: asyncio.Lock, herodotus_semaphore: asyncio.Semaphore)
process_orders_from_accepted_blocks(order_service: OrderService, block_dao: BlockDao,
eth_lock: asyncio.Lock, herodotus_semaphore: asyncio.Semaphore)
transfer(order: Order, order_service: OrderService)
wait_transfer(order: Order, order_service: OrderService)
}

package services {
Expand Down
1 change: 1 addition & 0 deletions mm-bot/docs/images/MM_Diagram_Class.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions mm-bot/docs/images/MM_Diagram_Class_Full.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fad9286

Please sign in to comment.