Skip to content

Commit

Permalink
[FAB-5255] Update jsdoc links
Browse files Browse the repository at this point in the history
There are links to fabric code such as transaction
status codes that uses the 1.0.0-beta URLs. They are
legit since no changes have been made but should
eventually update them to 1.0.0 URLs.

Change-Id: If0e8873eef51a8f8038f9de21713d059bbe3bf95
Signed-off-by: Jim Zhang <[email protected]>
  • Loading branch information
jimthematrix committed Jul 12, 2017
1 parent 974bafc commit 9522ad6
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion fabric-client/lib/BlockDecoder.js
Original file line number Diff line number Diff line change
Expand Up @@ -512,7 +512,7 @@ policy

/**
* @typedef {Object} ProcessedTransaction
* @property {number} validationCode - See [this list]{@link https://github.com/hyperledger/fabric/blob/v1.0.0-beta/protos/peer/transaction.proto#L125}
* @property {number} validationCode - See [this list]{@link https://github.com/hyperledger/fabric/blob/v1.0.0/protos/peer/transaction.proto#L125}
* for all the defined validation codes
* @property {Object} transactionEnvelope - Encapsulates the transaction and the signature over it.
* It has the following structure:
Expand Down
4 changes: 2 additions & 2 deletions fabric-client/lib/Channel.js
Original file line number Diff line number Diff line change
Expand Up @@ -1375,7 +1375,7 @@ var Channel = class {
* validation against the chaincode's endorsement policy. When the committering peers
* successfully validate the transactions, it will mark the transaction as valid inside
* the block. After all transactions in a block have been validated, and marked either as
* valid or invalid (with a [reason code]{@link https://github.com/hyperledger/fabric/blob/v1.0.0-beta/protos/peer/transaction.proto#L125}),
* valid or invalid (with a [reason code]{@link https://github.com/hyperledger/fabric/blob/v1.0.0/protos/peer/transaction.proto#L125}),
* the block will be appended (committed) to the channel's ledger on the peer.
* <br><br>
* The caller of this method must use the proposal responses returned from the endorser along
Expand All @@ -1388,7 +1388,7 @@ var Channel = class {
*
* @param {TransactionRequest} request
* @returns {Promise} A Promise for a "BroadcastResponse" message returned by the orderer that contains a
* single "status" field for a standard [HTTP response code]{@link https://github.com/hyperledger/fabric/blob/v1.0.0-beta/protos/common/common.proto#L27}.
* single "status" field for a standard [HTTP response code]{@link https://github.com/hyperledger/fabric/blob/v1.0.0/protos/common/common.proto#L27}.
* This will be an acknowledgement from the orderer of successfully submitted transaction.
*/
sendTransaction(request) {
Expand Down
10 changes: 5 additions & 5 deletions fabric-client/lib/EventHub.js
Original file line number Diff line number Diff line change
Expand Up @@ -88,10 +88,10 @@ var ChainCodeCBE = class {
* will be passed a fully decoded {@link Block} object. See [registerBlockEvent]{@link EventHub#registerBlockEvent}
* <li>register a "transaction listener" to get called when the specific transaction
* by id is committed (discovered inside a block event). The listener will be
* passed the transaction id and the [validation code]{@link https://github.com/hyperledger/fabric/blob/v1.0.0-beta/protos/peer/transaction.proto#L125}.
* passed the transaction id and the [validation code]{@link https://github.com/hyperledger/fabric/blob/v1.0.0/protos/peer/transaction.proto#L125}.
* See [registerTxEvent]{@link EventHub#registerTxEvent}
* <li>register a "chaincode event listener" to get called when a specific
* [chaincode event]{@link https://github.com/hyperledger/fabric/blob/v1.0.0-beta/examples/chaincode/go/eventsender/eventsender.go}
* [chaincode event]{@link https://github.com/hyperledger/fabric/blob/v1.0.0/examples/chaincode/go/eventsender/eventsender.go#L65}
* has arrived. The listener will be passed the {@link ChaincodeEvent}. See
* [registerChaincodeEvent]{@link EventHub#registerChaincodeEvent}
* <br><br>
Expand All @@ -108,9 +108,9 @@ var ChainCodeCBE = class {
* implementations can be used as reference to write the necessary glue code between
* the fabric event stream and a message queue:
* <ul>
* <li>Node.js: this class. Source code can be found [here]{@link https://github.com/hyperledger/fabric-sdk-node/blob/v1.0.0-beta/fabric-client/lib/EventHub.js}
* <li>Java: part of the Java SDK for Hyperledger Fabric. Source code can be found [here]{@link https://github.com/hyperledger/fabric-sdk-java/blob/v1.0.0-beta/src/main/java/org/hyperledger/fabric/sdk/EventHub.java}
* <li>Golang: an example event listener client can be found [here]{@link https://github.com/hyperledger/fabric/blob/v1.0.0-beta/examples/events/block-listener/block-listener.go}
* <li>Node.js: this class. Source code can be found [here]{@link https://github.com/hyperledger/fabric-sdk-node/blob/v1.0.0/fabric-client/lib/EventHub.js}
* <li>Java: part of the Java SDK for Hyperledger Fabric. Source code can be found [here]{@link https://github.com/hyperledger/fabric-sdk-java/blob/v1.0.0/src/main/java/org/hyperledger/fabric/sdk/EventHub.java}
* <li>Golang: an example event listener client can be found [here]{@link https://github.com/hyperledger/fabric/blob/v1.0.0/examples/events/block-listener/block-listener.go}
* </ul>
*
* @example
Expand Down
12 changes: 6 additions & 6 deletions fabric-client/lib/Orderer.js
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ var Orderer = class extends Remote {
*
* @param {byte[]} envelope - Byte data to be included in the broadcast. This must
* be a protobuf encoded byte array of the
* [common.Envelope]{@link https://github.com/hyperledger/fabric/blob/v1.0.0-beta/protos/common/common.proto#L132}
* that contains either a [ConfigUpdateEnvelope]{@link https://github.com/hyperledger/fabric/blob/v1.0.0-beta/protos/common/configtx.proto#L70}
* or a [Transaction]{@link https://github.com/hyperledger/fabric/blob/v1.0.0-beta/protos/peer/transaction.proto#L70}
* [common.Envelope]{@link https://github.com/hyperledger/fabric/blob/v1.0.0/protos/common/common.proto#L132}
* that contains either a [ConfigUpdateEnvelope]{@link https://github.com/hyperledger/fabric/blob/v1.0.0/protos/common/configtx.proto#L70}
* or a [Transaction]{@link https://github.com/hyperledger/fabric/blob/v1.0.0/protos/peer/transaction.proto#L70}
* in the <code>payload.data</code> property of the envelope.
* @returns {Promise} A Promise for a {@link BroadcastResponse} object
*/
Expand Down Expand Up @@ -148,11 +148,11 @@ var Orderer = class extends Remote {
*
* @param {byte[]} envelope - Byte data to be included in the broadcast. This must
* be a protobuf encoded byte array of the
* [common.Envelope]{@link https://github.com/hyperledger/fabric/blob/v1.0.0-beta/protos/common/common.proto#L132}
* that contains a [SeekInfo]{@link https://github.com/hyperledger/fabric/blob/v1.0.0-beta/protos/orderer/ab.proto#L54}
* [common.Envelope]{@link https://github.com/hyperledger/fabric/blob/v1.0.0/protos/common/common.proto#L132}
* that contains a [SeekInfo]{@link https://github.com/hyperledger/fabric/blob/v1.0.0/protos/orderer/ab.proto#L54}
* in the <code>payload.data</code> property of the envelope.
* The <code>header.channelHeader.type</code> must be set to
* [common.HeaderType.DELIVER_SEEK_INFO]{@link https://github.com/hyperledger/fabric/blob/v1.0.0-beta/protos/common/common.proto#L44}
* [common.HeaderType.DELIVER_SEEK_INFO]{@link https://github.com/hyperledger/fabric/blob/v1.0.0/protos/common/common.proto#L44}
* @returns {Promise} A Promise for a protobuf object of type common.Block. Note that this
* is <b>NOT</b> the same type of object as the {@link Block} returned by the
* [BlockDecoder.decode()]{@link BlockDecode.decode} method and various
Expand Down
2 changes: 1 addition & 1 deletion fabric-client/lib/Peer.js
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ var Peer = class extends Remote {
* or runs queries.
*
* @param {Proposal} proposal - A protobuf encoded byte array of type
* [Proposal]{@link https://github.com/hyperledger/fabric/blob/v1.0.0-beta/protos/peer/proposal.proto#L134}
* [Proposal]{@link https://github.com/hyperledger/fabric/blob/v1.0.0/protos/peer/proposal.proto#L134}
* @returns {Promise} A Promise for a {@link ProposalResponse}
*/
sendProposal(proposal) {
Expand Down

0 comments on commit 9522ad6

Please sign in to comment.