docs(evm-core): Add a compiled rustdoc example that derives the first EVM address from a test seed

Open Beginner friendly
#690 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
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
rust
Domain
documentation

Research direction

Read crates/evm-core/src/derive.rs and follow the existing derivation path API and nearby documentation. Add a compiled # Example doctest using a clearly labeled public BIP-39 test vector; include the path and resulting checksummed address. Run cargo test -p octo-evm-core --doc; done means the example compiles and the requested formatting, lint, and test checks pass.

Written by the indexing model from the issue text.

Description

area/contract documentation good first issue help wanted

Description

The crate docs explain the derivation path in prose but show no usage example.

Requirements and context

  • Where: crates/evm-core/src/derive.rs
  • Security: Use only a published test vector; never commit a real mnemonic.
  • 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 docs/evm-core-path-example

Implement changes

  • Add a # Example doctest using a public BIP-39 test seed.
  • Show the path and the resulting checksummed address.
  • Mark the seed clearly as a public test vector, never a real wallet.

Test and commit

  • cargo test -p octo-evm-core --doc passes.
  • 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

docs(evm-core): add derivation example

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.