Skip to content

docs: fix getCreator and ProposalCreator type documentation #498

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 1 commit into from
Mar 11, 2026
Merged

docs: fix getCreator and ProposalCreator type documentation #498

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions libraries/fabric-shim/lib/stub.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,17 +291,17 @@ class ChaincodeStub {

/**
* This object contains the essential identity information of the chaincode invocation's submitter,
* including its organizational affiliation (mspid) and certificate (id_bytes)
* @typedef {Object} ProposalCreator
* including its organizational affiliation (mspid) and certificate (idBytes)
* @typedef {Object} SerializedIdentity
* @property {string} mspid The unique ID of the Membership Service Provider instance that is associated
* to the identity's organization and is able to perform digital signing and signature verification
* @class
* @property {byte[]} idBytes The raw identity bytes (certificate) as a Uint8Array. Often contains an X.509 certificate in PEM form.
* @memberof fabric-shim
*/

/**
* Returns the identity object of the chaincode invocation's submitter
* @returns {ProposalCreator}
* @returns {SerializedIdentity}
*/
getCreator() {
return this.creator;
Expand Down Expand Up @@ -333,7 +333,7 @@ class ChaincodeStub {
* to the chaincode.
* @typedef {Object} SignedProposal
* @property {Buffer} signature The signature over the proposal. This signature is to be verified against
* the {@link ProposalCreator} returned by <code>getCreator()</code>. The signature will have already been
* the {@link SerializedIdentity} returned by <code>getCreator()</code>. The signature will have already been
* verified by the peer before the invocation request reaches the chaincode.
* @property {Proposal} proposal The object containing the chaincode invocation request and metadata about the request
* @memberof fabric-shim
Expand Down Expand Up @@ -385,7 +385,7 @@ class ChaincodeStub {

/**
* @typedef {Object} SignatureHeader
* @property {ProposalCreator} creator The submitter of the chaincode invocation request
* @property {SerializedIdentity} creator The submitter of the chaincode invocation request
* @property {Buffer} nonce Arbitrary number that may only be used once. Can be used to detect replay attacks.
* @memberof fabric-shim
* @class
Expand Down
Loading