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

V2 API Doctest generation #24

Merged
merged 22 commits into from Mar 22, 2019

Conversation

Projects
None yet
1 participant
@yeastplume
Copy link
Member

commented Mar 19, 2019

Aim is to create working self-testing documentation for wallet APIs, both internal and JSON RPC examples. All doctests should be executing against a local test environment (using the same framework that the wallet integration tests currently use).

Mostly straightforward, recording some small changes here:

  • I've needed to ensure that any returned u64 values are wrapped as strings (JS can't handle u64 values, so best to let callers decide how they want to handle these values). However, when called with u64 values the API will accept either strings or literals.

  • New struct OutputCommitMapping returned from retrieve_outputs (so commits don't serialize as byte arrays in json)

  • New struct TxEstimation returned from extimate_initiate_tx for same reason.

yeastplume added some commits Mar 19, 2019

@yeastplume yeastplume changed the title [WIP] V2 API Doctest generation V2 API Doctest generation Mar 22, 2019

@yeastplume yeastplume merged commit 94960b3 into mimblewimble:master Mar 22, 2019

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@lehnberg lehnberg referenced this pull request Apr 8, 2019

Open

Use Rustdoc to auto-generate API docs #1530

1 of 2 tasks complete

@yeastplume yeastplume deleted the yeastplume:v2_api_3 branch May 20, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.