refactor: modular architecture #141
Conversation
There was a problem hiding this comment.
Soft approve
I don't see the functional difference between domain and services.
Also, no need to address, but my 2c. If we are structuring in layers, i think i miss a bit the layer for DAO or Repository layer.
So I would leave these 4 => commands, services, repository, model
Each layer interacts with the one below.
| /** | ||
| * Process an order to determine if it is valid | ||
| * @param order The GPv2.Order data struct to validate | ||
| * @throws Error if the order is invalid | ||
| */ | ||
| export function validateOrder(order: Order) { | ||
| export function check(order: Order) { |
There was a problem hiding this comment.
I would think, check should return a boolean not throw.
If you want it to throw, a better name is assertValidOrder(order)
nit: If you want to make this more modular, you can have all the assertions as independent checks. This way, is easier to test them in isolation, reuse them for different checks, or define different messages.
type OrderCheck = (order: Order) => boolean
export ZeroAmountOrderCheck: OrderCheck = ...
This way, you can use it for filtering or for asserting and is easier to maintain as you can have smaller atomic checks.
Also, allows you to define your error messages easier:
const BAD_ORDER_ERRORS: Record<OrderCheck, string> = ...
mfw78
force-pushed
the
module-refactor
branch
from
3ac0791 to
231d6b9
Compare
Description
This PR refactors legacy locations of code to more accurately reflect the area of responsibility for the respective code.
Changes
How to test
yarn testpassesmainnetand verify the block watcher comes online (passeswarmUp).