Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update smart contracts folder structure #399

Open
10 tasks
VGau opened this issue Dec 5, 2024 · 0 comments
Open
10 tasks

Update smart contracts folder structure #399

VGau opened this issue Dec 5, 2024 · 0 comments
Assignees
Labels
Contracts Smart Contract related documentation Improvements or additions to documentation P2: Medium Issue priority: medium TechDebt Technical Debt

Comments

@VGau
Copy link
Collaborator

VGau commented Dec 5, 2024

Description

Reorganize the folder structure of the smart contracts to improve clarity, maintainability, and scalability. This includes categorizing contracts into subfolders based on functionality (e.g., tokens, utils, governance) and updating references in all related files and scripts.

Motivation

A more intuitive folder structure enhances developer productivity, reduces onboarding time for new team members.

Tasks

  • Create subfolders for smart contracts based on functionality (tokens, governance, utils, etc.).
  • Update all imports and references in contracts, related scripts and configuration files.
  • Verify deployment scripts and test cases work with the new structure.
  • Document the new folder structure in the development guide.

Acceptance criteria

  • All smart contracts are organized into appropriate subfolders.
  • All references, imports, and scripts are updated to reflect the new structure.
  • Deployment scripts execute without errors.
  • All tests pass successfully with the new structure.
  • Documentation is updated to reflect the new folder structure.

Risks

  • Risk of broken imports or references in contracts, scripts and tests.
@VGau VGau added Contracts Smart Contract related documentation Improvements or additions to documentation P2: Medium Issue priority: medium TechDebt Technical Debt labels Dec 5, 2024
@VGau VGau self-assigned this Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Contracts Smart Contract related documentation Improvements or additions to documentation P2: Medium Issue priority: medium TechDebt Technical Debt
Projects
None yet
Development

No branches or pull requests

1 participant