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

chore: rename merkle-tree -> program-libs, create prover & sdk-libs #1430

Merged
merged 1 commit into from
Jan 2, 2025

Conversation

ananas-block
Copy link
Contributor

@ananas-block ananas-block commented Dec 26, 2024

Repo folder reorg:

  1. renamed merkle-tree -> program-libs
    • contains anything that is a separate crate and used in programs
    1. batched -> batched-merkle-tree
    2. concurrent -> concurrent-merkle-tree
    3. moved heap -> program-libs/heap
    4. indexed -> indexed-merkle-tree
    5. moved macros/light -> program-libs/macros
    6. moved macros/aligned-sized -> program-libs/aligned-sized
    7. metadata -> merkle-tree-metadata
    8. moved utils -> program-libs/utils
    9. moved verifier -> program-libs/verifier
  2. created sdk-libs folder
    • contains anything that is a rust sdk and intended to be used by devs working with light protocol
    1. moved sdk -> sdk-libs/sdk
    2. light-program-test -> sdk-libs/program-test
    3. client -> sdk-libs/client
    4. macros/light-sdk-macros -> sdk-libs/macros
    5. photon-api -> sdk-libs/photon-api
  3. created prover folder
    • contains prover server, circuits, rust client for go prover server
    1. moved light-prover-client -> prover/client
    2. moved light-prover -> prover/server
  4. renamed test-programs-> program-tests
    • contains anything that is a test for programs or a crate only used in program tests
    1. moved test-utils -> program-tests/utils
    2. moved merkle-tree/reference -> ./program-tests/merkle-tree

Other Changes:

  1. converted all path dependencies to workspace dependencies
  2. removed Michal from CODEOWNERS

TODOs for future prs

  • remove forester-utils by extracting functionality to forester and sdk-libs/client

Notes

  1. consider renaming prover to forester or backend or similar and move forester into this folder as well
  2. I tried to remove the crates light-concurrent-merkle-tree, light-indexed-merkle-tree, and light-hash-set, this created version mismatches of bounded-vec and light-hasher in the account compression program and prover/client. We can either fork these crates and move the current versions to program-libs repo or wait to remove these crates until we can remove them from the account-compression program in Q1 or Q2 25.

@ananas-block ananas-block force-pushed the jorrit/chore-folder-reorg branch 3 times, most recently from 3de3b88 to 03c47ad Compare December 26, 2024 10:05
@ananas-block ananas-block force-pushed the jorrit/chore-folder-reorg branch from 03c47ad to 5574c7d Compare January 2, 2025 19:12
@ananas-block ananas-block merged commit 864a1a1 into main Jan 2, 2025
19 checks passed
@ananas-block ananas-block deleted the jorrit/chore-folder-reorg branch January 2, 2025 22:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants