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

Wallet docs #114

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Wallet docs #114

wants to merge 12 commits into from

Conversation

fkrause98
Copy link
Contributor

@fkrause98 fkrause98 commented Sep 12, 2023

Related Issue: #115

Changes:

  • Add doctests for the wallet module, with some examples that should compile, taking inspiration from the tests.
    These doctests are only documentative, they compile just fine but most require a working Provider to work.

How to test:

  • Checkout to this branch.
  • Run cargo test --doc, it should compile the wallet module doc tests.
  • Check the docs render properly with cargo doc && open target/doc/zksync_web3_rs/index.html

@codecov-commenter
Copy link

codecov-commenter commented Sep 12, 2023

Codecov Report

Merging #114 (fc3c611) into main (fd7adf6) will not change coverage.
Report is 1 commits behind head on main.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #114   +/-   ##
=======================================
  Coverage   68.15%   68.15%           
=======================================
  Files          18       18           
  Lines        2179     2179           
=======================================
  Hits         1485     1485           
  Misses        694      694           
Files Changed Coverage Δ
src/zks_wallet/requests/call_request.rs 78.57% <ø> (ø)
src/zks_wallet/requests/deploy_request.rs 81.81% <ø> (ø)
src/zks_wallet/requests/transfer_request.rs 84.61% <ø> (ø)
src/zks_wallet/requests/withdraw_request.rs 75.00% <ø> (ø)
src/zks_wallet/wallet.rs 54.87% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@fkrause98 fkrause98 mentioned this pull request Sep 13, 2023
1 task
@fkrause98 fkrause98 marked this pull request as ready for review September 13, 2023 22:06
@fkrause98 fkrause98 requested a review from jpcenteno September 14, 2023 15:08
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