search

magic-wormhole / magic-wormhole.rs

Rust implementation of Magic Wormhole, with new features and enhancements
European Union Public License 1.2
648 stars 72 forks source link

Examples #155

Open mberry opened 2 years ago

mberry commented 2 years ago

Added examples for building wormhole structs and the transfer functions.

Wouldn't compile without updating the lockfile for cli-clipboard

codecov[bot] commented 2 years ago

Codecov Report

Merging #155 (f50c56f) into master (4823a3b) will decrease coverage by 0.34%. The diff coverage is 53.33%.

@@            Coverage Diff             @@
##           master     #155      +/-   ##
==========================================
- Coverage   52.59%   52.25%   -0.35%     
==========================================
  Files          15       15              
  Lines        2694     2687       -7     
==========================================
- Hits         1417     1404      -13     
- Misses       1277     1283       +6
Impacted Files Coverage Δ
cli/src/main.rs 0.00% <0.00%> (ø)
src/core.rs 81.15% <ø> (ø)
src/forwarding.rs 0.00% <0.00%> (ø)
src/transfer/messages.rs 78.94% <ø> (-0.37%) :arrow_down:
src/transfer.rs 37.57% <50.00%> (-0.89%) :arrow_down:
src/transfer/v1.rs 31.68% <50.00%> (+0.15%) :arrow_up:
src/transit.rs 80.20% <76.92%> (+1.00%) :arrow_up:
src/core/test.rs 93.27% <80.00%> (+0.12%) :arrow_up:
src/core/rendezvous.rs 71.64% <0.00%> (-0.59%) :arrow_down:
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 4823a3b...f50c56f. Read the comment docs.

piegamesde commented 2 years ago

I pushed a few fixes on master, including the dependencies stuff. Please rebase. Edit: Apparenently CI fails for some reason, I'll investigate that tomorrow. Sorry about that

piegamesde commented 2 years ago

Master should be good to go now

piegamesde commented 2 years ago

Looks good so far, I'll do a more in-depth read later. Please add some small example doing a transfer to the top-level documentation (lib.rs and transfer.rs), to get people started more easily.

Note that the commit history in this PR is really weird, it looks something went wrong during the merge. You may try to fix it, otherwise I'll simply squash all commits in the end.