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

Smart Contract Repo Reorder/cleanup [NEEDS DESIGN] #1227

Open
Ferparishuertas opened this issue Jan 24, 2025 · 3 comments
Open

Smart Contract Repo Reorder/cleanup [NEEDS DESIGN] #1227

Ferparishuertas opened this issue Jan 24, 2025 · 3 comments
Assignees

Comments

@Ferparishuertas
Copy link

Ferparishuertas commented Jan 24, 2025

The idea is to agree on repo structure, cleanup before implementing a library, and deployment cycle.

Steps to achieve this:

  • Cleat out questions
  • Design repot structure
  • Implement the restructure

Open questions

  • why do we have a local.env published?
  • why do we have a scripts folder with network freeze example?
  • Why do we have an Openzeppelin folder instead using the node library?
  • Why do we have libs folder vs using node libraries?
  • Why tests include mixed scenarios vs
  • Do we have samples for everything
  • WHy Ihederatokenservice has all, but then we have HIP interfaces, Shall we inheritate?
    Enhancements Suggestions
  • Should we have a Readme file per folder that explains it concepts?
  • Should we have a main README more detailed to explain all the things included in the repo?
  • Should me have parent folder, distinguihung system contracts activities vs other examples tools?
  • Should me move samples that are smart contract functionalities more than json-rpc related stuff to the new strucuture?
@Nana-EC
Copy link
Collaborator

Nana-EC commented Jan 24, 2025

@Nana-EC
Copy link
Collaborator

Nana-EC commented Jan 24, 2025

Goal would be https://github.com/hashgraph/hedera-smart-contracts/tree/main/contracts/system-contracts would be the folder that is included in the npm package that developers can import and utilize.
Examples under here should also be moved out to make it easier on developer experience

@Nana-EC
Copy link
Collaborator

Nana-EC commented Jan 24, 2025

@acuarica suggested we consider a separate repo to highlight system contracts even more. There's potential to make usage with other tools easier.

Q: Would this also be satisfied by a sub package

@Ferparishuertas Ferparishuertas changed the title Smart Contract Repo Reorder/cleanup Smart Contract Repo Reorder/cleanup [NEEDS DESIGN] Feb 4, 2025
@Ferparishuertas Ferparishuertas transferred this issue from hashgraph/hedera-json-rpc-relay Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog
Development

No branches or pull requests

3 participants