cowprotocol / cowprotocol/ebbo
Restructure codebase
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
We decided to restructure the code to make it easier to maintain and extend.
The general structure would be as follows:
- Data collection via APIs which are encapsulated in classes, e.g.,
Web3API,OrderbookAPI - Data processing in tests; each test has its own class and depends on different APIs for fetching data
- unit tests and end-to-end tests using mock instances for the data fetching
It might be possible to make those changes one by one, without breaking the code.
TODO:
- implement prototype for iterating on the design
- move all data fetching to API classes
- convert all monitoring tests into new format
- add unit tests and e2e tests
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the existing Web3API and OrderbookAPI classes and the monitoring tests converted to the new format. Trace how those tests fetch data, then add unit and end-to-end coverage using mock data-fetching instances. Done means the remaining TODO item is implemented without breaking the current monitoring tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend, testing
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100