From 4f9318f4d01770f3a63b054e2e160409771c9e1d Mon Sep 17 00:00:00 2001 From: Sourav Date: Wed, 11 Mar 2026 23:33:24 +0530 Subject: [PATCH] Document KeyEndorsementPolicy class for SBE #307 Signed-off-by: Sourav --- docs/_jsdoc.json | 1 + libraries/fabric-shim/index.js | 4 +++- libraries/fabric-shim/lib/utils/statebased.js | 7 ++++--- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/_jsdoc.json b/docs/_jsdoc.json index 5b2fccd8b..1b79c6a7a 100644 --- a/docs/_jsdoc.json +++ b/docs/_jsdoc.json @@ -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" ] }, diff --git a/libraries/fabric-shim/index.js b/libraries/fabric-shim/index.js index eba64698d..73473c776 100644 --- a/libraries/fabric-shim/index.js +++ b/libraries/fabric-shim/index.js @@ -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; diff --git a/libraries/fabric-shim/lib/utils/statebased.js b/libraries/fabric-shim/lib/utils/statebased.js index c294ad5b1..598282a10 100644 --- a/libraries/fabric-shim/lib/utils/statebased.js +++ b/libraries/fabric-shim/lib/utils/statebased.js @@ -17,7 +17,8 @@ const ROLE_TYPE_PEER = 'PEER'; * of the MSP identifiers of organizations. * For more informations, please read the [documents]{@link https://hyperledger-fabric.readthedocs.io/en/latest/endorsement-policies.html#setting-key-level-endorsement-policies} * - * @class + * @class KeyEndorsementPolicy + * @memberof fabric-shim */ class KeyEndorsementPolicy { /** @@ -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(); @@ -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) {