RFC: Kakarot File Architecture

[matthieuauger]

Currently our code structure is the following (scrolling necessary) and has a few limitations:

kakarot
│   coverage/  <-- artifacts are placed at the same root level than written content (ie: docs, scripts)
│   docs/
│   resources/ <-- artifacts are placed at the same root level than written content (ie: docs, scripts)
│   scripts/
│   src/
│       kakarot/
│           accounts/
│               contract/
│                   contract_account.cairo
│           instructions/
│               block_information.cairo/
│       utils/
│   tests/
│       cairo_files/  <-- folder naming doesn't follow file architecture in src/
│           instructions/
│               test_block_information.cairo/
│           test_contract_account.cairo/ <-- test doesn't follow file architecture in src/ (accounts/contracts)
│       integrations/
│           test_erc20.py
│       solidity_files/ <-- solidity_files are used for integration tests but not in integrations/ folder
│           output/
│           ERC20.sol
│           ERC721.sol
│       units/
│           instructions/
│           test_contract_account.py/ <-- test doesn't follow file architecture in src/ (accounts/contracts)

This is usually good practice to mimic source code architecture in tests.

This RFC proposes following modifications (see example below):

• move coverage/ and resources/ in a dedicated artifacts/ folder
• use same file architecture in tests/ than in src/
• remove cairo_files directory and move cairo tests directly in the tests/ folder
• move python test files in a separate py_runners/ directory that also follow same file architecture than src/
• move integration tests by contract, ie create an ERC20/ directory with the solidity file + the python tests, same for ERC721 instead of grouping contracts in a solidity_files/ folder

kakarot
│   artifacts/  <-- artifacts are separated, naming to discuss
│       coverage/
│       resources/
│   docs/
│   scripts/
│   src/
│       kakarot/
│           accounts/
│               contract/
│                   contract_account.cairo
│           instructions/
│               block_information.cairo/
│       utils/
│   tests/
│       units/
│           src/ <-- same folder architecture than src/
│               kakarot/
│                   accounts/
│                       contract/
│                           test_contract_account.cairo <-- tests location follows same file architecture than src/
│           py_runners/ <-- pythons runners are in a separate folder that can be removed when we don't need it anymore (ie with testing tool full cairo like protostar, cairo-foundry
│               kakarot/
│                   accounts/
│                       contract/
│                           test_contract_account.py 
│       integrations/
│           ERC20/ <-- integration test are gathered in a folder containing solidity + test
│               solidity/
│                   ERC20.sol
│                   output/
│               test_erc20.py
│           ERC721/
│               solidity/
│                   ERC721.sol
│                   output/
│               test_erc721.py

[Eikix]

Really cool changes:)!!