From 491b6b0888ef356bf11ca0b903b0714f76bbb085 Mon Sep 17 00:00:00 2001 From: David Enyeart Date: Thu, 9 Aug 2018 15:53:30 -0400 Subject: [PATCH] [FABN-872] Remove references to v1.0 from node.js docs Clean up v1.0 references. Change-Id: I85e21364e346ca281e871417cb6882e5f8c9a191 Signed-off-by: David Enyeart --- CONTRIBUTING.md | 2 +- README.md | 2 +- docs/index.md | 2 +- docs/tutorials/app-dev-env-setup.md | 4 ++-- fabric-client/lib/Channel.js | 6 +++--- fabric-client/lib/Client.js | 6 +++--- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 73b24bd5aa..6417b0622d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index 59422f63c1..bc8a044bf2 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/docs/index.md b/docs/index.md index ee4b98754c..74bd7d9709 100755 --- a/docs/index.md +++ b/docs/index.md @@ -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/). diff --git a/docs/tutorials/app-dev-env-setup.md b/docs/tutorials/app-dev-env-setup.md index 3588e9ea30..36f55a449a 100755 --- a/docs/tutorials/app-dev-env-setup.md +++ b/docs/tutorials/app-dev-env-setup.md @@ -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 diff --git a/fabric-client/lib/Channel.js b/fabric-client/lib/Channel.js index bd1d305d97..5a3d438ac8 100755 --- a/fabric-client/lib/Channel.js +++ b/fabric-client/lib/Channel.js @@ -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. *

* 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, @@ -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' @@ -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 diff --git a/fabric-client/lib/Client.js b/fabric-client/lib/Client.js index 2fcbe1c640..c7c37dc108 100644 --- a/fabric-client/lib/Client.js +++ b/fabric-client/lib/Client.js @@ -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 @@ -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. *

* Chaincode installation is simply uploading the chaincode source and * dependencies to the peers. This operation is "channel-agnostic" and is