Skip to content

docs: document KeyEndorsementPolicy class for State-Based Endorsement (#307) #500

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.

Sign up for GitHub

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

Merged
bestbeforetoday merged 4 commits into from
Jun 2, 2026
+6 −2
Merged

docs: document KeyEndorsementPolicy class for State-Based Endorsement (#307) #500

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4f9318f
Document KeyEndorsementPolicy class for SBE #307
JhaSourav07 Mar 11, 2026
d13fe48
Merge branch 'hyperledger:main' into issue-307-fix
JhaSourav07 Jun 1, 2026
ed0f5b8
docs: remove class name and mark internal methods as private in KeyEn…
JhaSourav07 Jun 2, 2026
1cb8d47
refactor: simplify export logic in index.js to directly export the ch…
JhaSourav07 Jun 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/_jsdoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"../libraries/fabric-shim/lib/chaincode.js",
"../libraries/fabric-shim/lib/stub.js",
"../libraries/fabric-shim/lib/iterators.js",
"../libraries/fabric-shim/lib/utils/statebased.js",
"../apis/fabric-contract-api/lib"
]
},
Expand Down
4 changes: 3 additions & 1 deletion libraries/fabric-shim/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@
# SPDX-License-Identifier: Apache-2.0
*/

module.exports = require('./lib/chaincode.js');
const shim = require('./lib/chaincode.js');
module.exports = shim;
module.exports.KeyEndorsementPolicy = shim.KeyEndorsementPolicy;
Comment thread
JhaSourav07 marked this conversation as resolved.
Outdated
7 changes: 5 additions & 2 deletions libraries/fabric-shim/lib/utils/statebased.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ const ROLE_TYPE_PEER = 'PEER';
* For more informations, please read the [documents]{@link https://hyperledger-fabric.readthedocs.io/en/latest/endorsement-policies.html#setting-key-level-endorsement-policies}
*
* @class
* @memberof fabric-shim
*/
class KeyEndorsementPolicy {
/**
Expand All @@ -35,7 +36,7 @@ class KeyEndorsementPolicy {

/**
* returns the endorsement policy as bytes
* @returns {Buffer} the endorsement policy
* @returns {Uint8Array} the serialized signature policy envelope
*/
getPolicy() {
const spe = this._getPolicyFromMspId();
Expand All @@ -45,7 +46,7 @@ class KeyEndorsementPolicy {
/**
* adds the specified orgs to the list of orgs that are required
* to endorse
* @param {string} role the role of the new org(s). i.e., MEMBER or PEER
* @param {string} role the role of the new org(s). i.e., 'MEMBER' or 'PEER'
* @param {...string} neworgs the new org(s) to be added to the endorsement policy
*/
addOrgs(role, ...neworgs) {
Expand Down Expand Up @@ -89,6 +90,7 @@ class KeyEndorsementPolicy {
* Internal used only, set the orgs map from a signature policy envelope
* @param {_policiesProto.SignaturePolicyEnvelope} signaturePolicyEnvelope the signaturePolicyEnvelope
* decoded from the endorsement policy.
* @private
*/
_setMspIdsFromSPE(signaturePolicyEnvelope) {
Comment thread
JhaSourav07 marked this conversation as resolved.
// iterate over the identities in this envelope
Expand All @@ -106,6 +108,7 @@ class KeyEndorsementPolicy {
* Internal used only. construct the policy from all orgs' mspIds.
* the policy requires exactly 1 signature from all of the principals.
* @returns {_policiesProto.SignaturePolicyEnvelope} return the SignaturePolicyEnvelope instance
* @private
*/
_getPolicyFromMspId() {
Comment thread
JhaSourav07 marked this conversation as resolved.

Expand Down
Loading