grid api refactoring plan

[Omarabdul3ziz]

• unified mapping from chain types to db types
  • define a proper db schema (consider pk/fk/idx)
  • reduce the use of jsonb objects
  • db should return its own types (models)
  • proposal: merge gridproxy and graphql into a new Grid-API #843
  • consider bun/sqlc
• api v2
  • define a proper api schema
  • api client/ routing pkgs
  • inconsistent/non-standard REST API design #57
  • Review numeric fields in models, make sure to choose a proper size and to be consistent #49
  • json tags should follow naming convention #340
  • we should establish API versioning policy #50
• testing
  • research: Load and Stress Testing for Grid-Proxy #610
  • use fixtures to properly test the db #338
  • schema tests #695
  • revisit the integration tests
  • add tests for the indexers #643
• API server
  • a validation layer for all (filtering/paginating/sorting) key/value
• app structure
  • separate bins for (api-server/node-indexer/chain-processor)
  • separate db client to (query-client/mutate-client)
    query client used with the server, mutate-client used with processor/indexer
  • support running from config/flags
• docs
  • Using OpenAPI 3.0 #217
  • write a developer guide explain each part of the project
  • explain the tricky filters (dedicated/rentable/...)

[Nabil-Salah]

5/11/2024

Worked on listing all mapping happens in

• graphql processor
• gridproxy triggers
  (Farms, addEvent, Service Contracts, Extra Fee For nodes, Price Stored, Average Price Stored)

[SalmaElsoly]

5/11

Listed events happen and how are they handled with associated triggers:

• Policies
• Nodes
• Twins