Skip to content

Commit

Permalink
Remove explicit FPC version from docu
Browse files Browse the repository at this point in the history
Signed-off-by: Marcus Brandenburger <[email protected]>
  • Loading branch information
mbrandenburger committed Sep 9, 2021
1 parent a007320 commit 699dc7b
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 17 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,15 +144,11 @@ Additional Google documents provide details on FPC 1.0:

## Releases

- [v1.0-rc1 - Feburary 5, 2021](https://github.com/hyperledger/fabric-private-chaincode/tree/v1.0-rc1)

- [Tech Preview - July 2, 2020](https://github.com/hyperledger/fabric-private-chaincode/tree/concept-release-2.0)

- [Concept Release - March 2, 2020](https://github.com/hyperledger/fabric-private-chaincode/tree/concept-release-1.0)
For all releases go to the [Github Release Page](https://github.com/hyperledger/fabric-private-chaincode/releases).

*WARNING: This project is in continous development and the `main`
branch will not always be stable. Unless you want to actively
contribute to the project itself, we advice you to use one of above releases*
contribute to the project itself, we advise you to use the latest release.*



Expand Down
4 changes: 2 additions & 2 deletions client_sdk/go/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ SPDX-License-Identifier: Apache-2.0
//
// Usage samples
//
// samples/main.go: Illustrates the use of the FPC Client SDK. The application can be used with our test-network.
// Reference: https://github.com/hyperledger/fabric-private-chaincode/tree/main/integration/test-network
// $FPC_PATH/samples/application: Illustrates the use of the FPC Client SDK.
// The sample applications can be used with our test-network `$FPC_PATH/samples/deployment/test-network`.
//
package fpcclientsdk
4 changes: 2 additions & 2 deletions client_sdk/go/pkg/client/resmgmt/lifecycleclient.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ SPDX-License-Identifier: Apache-2.0
// Package resmgmt provides FPC specific chaincode management functionality.
//
// For more information on the FPC management commands and related constraints on chaincode versions and endorsement policies,
// see https://github.com/hyperledger/fabric-private-chaincode/blob/main/docs/design/fabric-v2+/fpc-management.md
// see `$FPC_PATH/docs/design/fabric-v2+/fpc-management.md`
//
// Example:
//
Expand All @@ -34,7 +34,7 @@ SPDX-License-Identifier: Apache-2.0
// log.Fatal(err)
// }
//
// See also https://github.com/hyperledger/fabric-private-chaincode/blob/main/integration/client_sdk/go/utils.go
// See also `lifecycle_test.go` and `$FPC_PATH/integration/client_sdk/go/utils/utils.go`
// for a running example.
//
package resmgmt
Expand Down
2 changes: 1 addition & 1 deletion client_sdk/go/pkg/gateway/contract.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import (
// but in addition to the normal FPC operations, it performs FPC specific steps such as encryption/decryption of chaincode requests/responses.
//
// A Contract object is created using the GetContract() factory method.
// For an example of its use, see https://github.com/hyperledger/fabric-private-chaincode/blob/main/client_sdk/go/test/main.go
// For an example of its use, see `contract_test.go`
type Contract interface {
// Name returns the name of the smart contract
Name() string
Expand Down
2 changes: 1 addition & 1 deletion docs/design/fabric-v2+/interfaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -438,4 +438,4 @@ void log_notice(const char* format, ...);
void log_info(const char* format, ...);
void log_debug(const char* format, ...);
```
See https://github.com/hyperledger/fabric-private-chaincode/blob/main/ecc_enclave/enclave/shim.h
See [shim.h](../../../ecc_enclave/enclave/shim.h)
3 changes: 2 additions & 1 deletion ercc/registry/registry.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ Copyright 2020 Intel Corporation
SPDX-License-Identifier: Apache-2.0
*/

// Package registry defines the client-facing interface of ERCC as defined in the ERCC Interface section in [specifications](https://github.com/hyperledger/fabric-private-chaincode/blob/main/docs/design/fabric-v2%2B/interfaces.md)
// Package registry implements the client-facing interface of ERCC.
// The corresponding specification can be found in the ERCC Interface section in `$FPC_PATH/docs/design/fabric-v2+/interfaces.md`
package registry

import (
Expand Down
6 changes: 3 additions & 3 deletions samples/chaincode/helloworld/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ This tutorial illustrates a simple usecase where a FPC chaincode is used to stor
* Shut down the network

Please refer to [Architecture and
Components](https://github.com/hyperledger/fabric-private-chaincode#architecture-and-components)
Components](../../../README.md#architecture-and-components)
for more details of involved components.

## Prerequisites
This tutorial presumes that you have installed FPC on your `$GOPATH` as described in the FPC [README.md](https://github.com/hyperledger/fabric-private-chaincode/blob/main/README.md#requirements) and `$FPC_PATH` is set accordingly.
This tutorial presumes that you have installed FPC on your `$GOPATH` as described in the FPC [README.md](../../../README.md#requirements) and `$FPC_PATH` is set accordingly.

## Develop chaincode
Go to `$FPC_PATH/samples/chaincode/helloworld` and create a file named `helloworld_cc.cpp` where we will place our chaincode.
Expand Down Expand Up @@ -247,7 +247,7 @@ int invoke(
## Build
Make sure you have the [environment variables](https://github.com/hyperledger/fabric-private-chaincode#environment-settings) set. In addition, set `SGX_BUILD=DEBUG` to enable log messages.
Make sure you have the [environment variables](../../../README.md#environment-settings) set. In addition, set `SGX_BUILD=DEBUG` to enable log messages.
To build the helloworld chaincode, we are using CMake. This simplifies the build process and compiles our chaincode using the SGX SDK. Create `CMakeLists.txt` with the following content.
Expand Down
2 changes: 1 addition & 1 deletion samples/deployment/test-network/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ make build
Note: If you want to build with [mock-enclave](../../../ecc/chaincode/enclave/mock_enclave.go) rather than the real enclave-based one, build with
`make build GOTAGS="-tags mock_ecc"` instead.

Next, setup fabric sample network, binaries and docker images. Here we follow the official Fabric [instructions](https://hyperledger-fabric.readthedocs.io/en/latest/install.html).
Next, setup fabric sample network, binaries and docker images. Here we follow the official Fabric [instructions](https://hyperledger-fabric.readthedocs.io/en/release-2.3/install.html).

```bash
cd $FPC_PATH/samples/deployment/test-network
Expand Down

0 comments on commit 699dc7b

Please sign in to comment.