Skip to content

Bucky/abci docs#2524

Merged
ebuchman merged 2 commits intodevelopfrom
bucky/abci-docs
Sep 30, 2018
Merged

Bucky/abci docs#2524
ebuchman merged 2 commits intodevelopfrom
bucky/abci-docs

Conversation

@ebuchman
Copy link
Contributor

Document the General Merkle Proofs in ABCI spec as follow up from #2509

Also add some missing/extra ConsensusParams docs

@ebuchman ebuchman requested a review from zramsay as a code owner September 30, 2018 17:06
@ebuchman
Copy link
Contributor Author

@jaekwon @mossid not 100% sure where the KeyPath stuff interfaces with the user. Are we expecting that the KeyPath passed into RequestQuery.Path corresponds to the keys in the ResponseQuery.Proofs? In which case this KeyPath becomes the sort of standard for RequestQuery.Path and should also be documented here?

Noting that it's a bit weird for the general Merkle proof types to live in crypto/merkle. They're effectively part of ABCI and should live in abci/types, just like the ABCI PubKey type...

We would also benefit from separation in crypto/merkle between the SimpleTree code and the GeneralMerkle code. Since we want most of the crypto/merkle to be used by external consumers, it really helps to have separation to simplify looking at the godoc.org.

@codecov-io
Copy link

Codecov Report

Merging #2524 into develop will decrease coverage by 0.02%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop    #2524      +/-   ##
===========================================
- Coverage    61.35%   61.32%   -0.03%     
===========================================
  Files          202      202              
  Lines        16668    16710      +42     
===========================================
+ Hits         10226    10247      +21     
- Misses        5580     5598      +18     
- Partials       862      865       +3
Impacted Files Coverage Δ
blockchain/pool.go 65.73% <0%> (-0.7%) ⬇️
consensus/state.go 77.54% <0%> (+0.23%) ⬆️
libs/db/remotedb/remotedb.go 41.52% <0%> (+4.68%) ⬆️

@ebuchman
Copy link
Contributor Author

Please review, but merging for staging deployment. Opened my comment in #2527

@ebuchman ebuchman merged commit ccd0458 into develop Sep 30, 2018
@ebuchman ebuchman deleted the bucky/abci-docs branch September 30, 2018 19: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