hyperledger / hyperledger/fabric-protos

Clarify discrepancies between code and package documentation regarding Epoch system

Open
#169 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Protocol Buffer
Stars
43
Forks
75
Avg merge
16h 55m
Merged PRs (30d)
5

Description

Comment regarding ChannelHeader structure inside common/common.proto implies that the Epoch system is already implemented
This comment is later used as part of the package's documentation:
https://hyperledger.github.io/fabric-protos/protos.html#common-ChannelHeader and https://pkg.go.dev/github.com/hyperledger/fabric-protos-go/common#ChannelHeader.
However, go SDK sets the Epoch to a hard coded value of 0 and contains TODO markers, e.g. in this file: https://github.com/hyperledger/fabric-sdk-go/blob/main/internal/github.com/hyperledger/fabric/protoutil/proputils.go.
This can be quite misleading and at least a warning in the documentation would be appreciated.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.