Skip to content

Commit

Permalink
[FABN-872] Remove references to v1.0 from node.js docs
Browse files Browse the repository at this point in the history
Clean up v1.0 references.

Change-Id: I85e21364e346ca281e871417cb6882e5f8c9a191
Signed-off-by: David Enyeart <enyeart@us.ibm.com>
  • Loading branch information
denyeart committed Aug 9, 2018
1 parent 744a7f6 commit 491b6b0
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The following check-list is for code contributors to make sure their changesets
Check the coding styles, run the following command and make sure no ESLint violations are present:
* `gulp`

Run the full unit test bucket and make sure 100% are passing. Because v1.0 is still in active development, all tests may not pass. You can run each individually to isolate the failure(s):
Run the full unit test bucket and make sure 100% are passing. You can also run each test individually to isolate any failures:
* `gulp test`

The gulp test command above also generates code coverage reports. Your new code should be accompanied with unit tests and provide 80% line coverage or higher.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ In the project root folder:
* optionally, `gulp doc` to generate API docs if you want to review the doc content
* `npm test` or `gulp test-headless` to run the headless tests that do not require any additional set up

The following tests require setting up a local blockchain network as the target. Because v1.0 is still in active development, you still need to build the necessary Docker images needed to run the network. Follow the steps below to set it up.
The following tests require setting up a local blockchain network as the target. You need to build the necessary Docker images required to run the network. Follow the steps below to set it up.
* You will need the peers, orderers and fabric-ca server (new implementation of the member service) to run the tests. The first two components are from the *fabric* repository. The fabric-ca server is from the *fabric-ca* repository.
* git clone both the *fabric* and *fabric-ca* repositories into the $GOPATH/src/github.com/hyperledger folder in your native host (MacOS, Windows or Ubuntu, etc).

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

The Hyperledger Fabric SDK for Node.js provides a powerful API to interact with a Hyperledger Fabric v1.0 blockchain. The SDK is designed to be used in the Node.js JavaScript runtime.
The Hyperledger Fabric SDK for Node.js provides a powerful API to interact with a Hyperledger Fabric blockchain. The SDK is designed to be used in the Node.js JavaScript runtime.

### Overview
Hyperledger Fabric is the operating system of an enterprise-strength permissioned blockchain network. For a high-level overview of the fabric, visit [http://hyperledger-fabric.readthedocs.io/en/latest/](http://hyperledger-fabric.readthedocs.io/en/latest/).
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/app-dev-env-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ within the organization can register themselves to listen on that port
to get notified.

The final piece of the puzzle is identities. Every operation in a Hyperledger
Fabric network must be digitially signed for the purposes of access control,
or provenance/auditing (who did what), or both. As of v1.0, identities are
Fabric network must be digitally signed for the purposes of access control,
or provenance/auditing (who did what), or both. Identities are
based on the Public Key Infrastructure (PKI)) standards. Every orderer node,
every peer node and every user/transactor must have a key pair with the
public key wrapped in a x.509 certificate signed by a
Expand Down
6 changes: 3 additions & 3 deletions fabric-client/lib/Channel.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ const PEER_NOT_ASSIGNED_MSG = 'Peer with name "%s" not assigned to this channel'
const ORDERER_NOT_ASSIGNED_MSG = 'Orderer with name "%s" not assigned to this channel';

/**
* In fabric v1.0, channels are the recommended way to isolate data and maintain privacy.
* Channels provide data isolation for a set of participating organizations.
* <br><br>
* A Channel object captures the settings needed to interact with a fabric backend in the
* context of a channel. These settings including the list of participating organizations,
Expand Down Expand Up @@ -1999,7 +1999,7 @@ const Channel = class {
* to this channel instance that are in the endorsing role.
* @property {string} chaincodeType - Optional. Type of chaincode. One of
* 'golang', 'car', 'java' or 'node'. Default is 'golang'. Note that 'java'
* is not supported as of v1.0.
* is not yet supported.
* @property {string} chaincodeId - Required. The name of the chaincode
* @property {string} chaincodeVersion - Required. Version string of the chaincode,
* such as 'v1'
Expand Down Expand Up @@ -2516,7 +2516,7 @@ const Channel = class {

/**
* Sends a proposal to one or more endorsing peers that will be handled by the chaincode.
* In fabric v1.0, there is no difference in how the endorsing peers process a request
* There is no difference in how the endorsing peers process a request
* to invoke a chaincode for transaction vs. to invoke a chaincode for query. All requests
* will be presented to the target chaincode's 'Invoke' method which must be implemented to
* understand from the arguments that this is a query request. The chaincode must also return
Expand Down
6 changes: 3 additions & 3 deletions fabric-client/lib/Client.js
Original file line number Diff line number Diff line change
Expand Up @@ -919,7 +919,7 @@ const Client = class extends BaseClient {
* where the chaincode source code resides.
* @property {string} chaincodeType - Optional. Type of chaincode. One of
* 'golang', 'car', 'node' or 'java'.
* Default is 'golang'. Note that 'java' is not supported as of v1.0.
* Default is 'golang'. Note that 'java' is not yet supported.
* @property {string[] | string} channelNames - Optional. When no targets are
* provided. The loaded network configuration will be searched for
* suitable target peers. Peers that are defined in the channels named
Expand All @@ -940,8 +940,8 @@ const Client = class extends BaseClient {
*/

/**
* In fabric v1.0, a chaincode must be installed and instantiated before it
* can be called to process transactions.
* A chaincode must be installed to peers and instantiated on a channel
* before it can be called to process transactions.
* <br><br>
* Chaincode installation is simply uploading the chaincode source and
* dependencies to the peers. This operation is "channel-agnostic" and is
Expand Down

0 comments on commit 491b6b0

Please sign in to comment.