Skip to content

Commit 5ec1616

Browse files
authored
docs: fix getCreator and ProposalCreator type documentation (#498)
Signed-off-by: Sourav <souravkjha2007@gmail.com>
1 parent 1ad13ca commit 5ec1616

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

libraries/fabric-shim/lib/stub.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -291,17 +291,17 @@ class ChaincodeStub {
291291

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

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

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

0 commit comments

Comments
 (0)