fix(evm-core): Reconcile the crate root re-exports with the items defined in the derive module

Open Beginner friendly
#659 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
rust
Domain
api, backend

Research direction

Read the public items in crates/evm-core/src/derive.rs and compare them with the re-exports and rustdoc in crates/evm-core/src/lib.rs. Update the export list to match the available items and keep the names consumers need. Run cargo build -p octo-evm-core and cargo test -p octo-evm-core; done means both pass with the crate root exports aligned.

Written by the indexing model from the issue text.

Description

area/contract bug good first issue help wanted

Description

crates/evm-core/src/lib.rs re-exports derive_key, derive_key_at_path, EvmDerivationPath and EvmSecretKey, but derive.rs defines derive_signing_key and evm_derivation_path, so the re-export list refers to items that do not exist.

Requirements and context

  • Where: crates/evm-core/src/lib.rs, crates/evm-core/src/derive.rs
  • Security: Follow docs/threat-model.md; no secrets, tokens or personal data in code, logs, tests or commit messages.
  • Testing: just fmt-check, just lint and just test must pass; add or update tests for the change.
  • Documentation: Update the nearest doc if behaviour changes; otherwise no doc change is needed.

Suggested execution

  • Comment on this issue to claim it, then fork the repository and branch from main.
  • Branch name: git checkout -b fix/evm-core-public-reexports

Implement changes

  • List the actual pub items in derive.rs.
  • Update the pub use line to match, keeping names consumers need.
  • Update the rustdoc in lib.rs if it names the old functions.

Test and commit

  • cargo build -p octo-evm-core and cargo test -p octo-evm-core succeed.
  • Run just fmt, just lint and just test locally before pushing (see CONTRIBUTING.md).
  • Commit with a conventional message and keep the change small and focused.

Example commit message

fix(evm-core): align re-exports with derive module

Guidelines

  • Open the PR against main and link it with Closes #<this issue>.
  • Keep the diff focused on this issue; no unrelated refactors or formatting churn.
  • One line per comment, no bloated code; follow patterns already used in the crate.
  • Never commit secrets, .env files or real keys; use public test vectors only.
  • CI (fmt, clippy -D warnings, tests) must be green before requesting review.
  • Ask in the issue thread if anything is unclear before starting.
Dominant language
Rust
Stars
0
Forks
91
Avg merge
5h 23m
Merged PRs (30d)
4

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Octo-Protocol-org/Octo-Protocol

All issues in Octo-Protocol-org/Octo-Protocol

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.