trustbloc / sidetree-fabric

Implementation of Sidetree with a backing Hyperledger Fabric ledger
Apache License 2.0
26 stars 13 forks source link

feat: Modified Sidetree version endpoint to return protocol version and parameters #434

Closed bstasyszyn closed 3 years ago

bstasyszyn commented 3 years ago

The existing Sidetree version endpoint was modified to return the protocol version instead of the component version. The protocol parameters are also returned in the response.

The version endpoint accepts a 'time' parameter which, when specified, returns the protocol version applicable to that transaction time (block number). If not specified then the protocol for the latest block number is returned.

closes #432

Signed-off-by: Bob Stasyszyn Bob.Stasyszyn@securekey.com

bstasyszyn commented 3 years ago

Example:

https://localhost:48326/sidetree/0.0.1/version?time=50

Returns: { "version": "0.1.0", "genesis_time": 1, "multi_hash_algorithm": 18, "hash_algorithm": 5, "max_operation_count": 10, "max_operation_size": 200000, "compression_algorithm": "GZIP", "max_anchor_file_size": 1000000, "max_map_file_size": 1000000, "max_chunk_file_size": 10000000, "enable_replace_patch": false, "signature_algorithms": [ "EdDSA", "ES256", "ES256K" ], "key_algorithms": [ "Ed25519", "P-256", "secp256k1" ] }

codecov[bot] commented 3 years ago

Codecov Report

Merging #434 into master will increase coverage by 0.13%. The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #434      +/-   ##
==========================================
+ Coverage   91.64%   91.78%   +0.13%     
==========================================
  Files          80       80              
  Lines        3077     3128      +51     
==========================================
+ Hits         2820     2871      +51     
  Misses        174      174              
  Partials       83       83              
Impacted Files Coverage Δ
pkg/context/protocol/client.go 100.00% <ø> (ø)
pkg/peer/sidetreesvc/context.go 75.00% <100.00%> (ø)
pkg/peer/sidetreesvc/restsvc.go 94.87% <100.00%> (-0.07%) :arrow_down:
...protocolversion/factoryregistry/factoryregistry.go 100.00% <100.00%> (ø)
pkg/protocolversion/versions/common/protocol.go 100.00% <100.00%> (ø)
...g/protocolversion/versions/v0_1/factory/factory.go 100.00% <100.00%> (ø)
pkg/rest/sidetreehandler/versionhandler.go 100.00% <100.00%> (ø)

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 afce199...4a37426. Read the comment docs.