From cae29afeda95e4390e8fb772f33527c43723836c Mon Sep 17 00:00:00 2001 From: osamamagdy Date: Wed, 20 Nov 2024 00:17:06 +0200 Subject: [PATCH] feat: add documentation about how to integrate with FPC Signed-off-by: osamamagdy --- README.md | 5 +++++ fabric-private-chaincode/README.md | 15 +++++++++++++++ 2 files changed, 20 insertions(+) create mode 100644 fabric-private-chaincode/README.md diff --git a/README.md b/README.md index 681f808..2131c17 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ - `/fabric`: Fabric network v2.5 used as a test environment - `/chaincode`: chaincode-related files - `/ccapi`: chaincode REST API in Golang project +- `/fabric-private-chaincode`: Explaining the integration project between CC-tools and FPC ## Development @@ -66,6 +67,10 @@ By using the `--org/-o` option along the script, it's possible to specify the or By standard the archive is created using the project name with *1.0* label, to change it the `--name/-n` and `--label/-l` flags may be used. Example: `$ ./generatePackage.sh -n my-project -l 2.0` +## Integration with Fabric Private Chaincode + +If you want to execute your chaincode in a Trusted Execution Environment (TEE) using Fabric Private Chaincode (FPC), we've set up an integration guide to help you. Check out the instructions in the `./fabric-private-chaincode` directory to seamlessly integrate FPC with CC Tools for enhanced privacy and security. + ## More You can reach GoLedger developers and `cc-tools` maintainers at our Discord - [Join us!](https://discord.gg/GndkYHxNyQ) diff --git a/fabric-private-chaincode/README.md b/fabric-private-chaincode/README.md new file mode 100644 index 0000000..d42c88c --- /dev/null +++ b/fabric-private-chaincode/README.md @@ -0,0 +1,15 @@ +# Integration with Fabric Private Chaincode + +## Motivation + +Fabric Private Chaincode (FPC) enhances the privacy and security of smart contracts on Hyperledger Fabric by leveraging Trusted Execution Environments (TEEs), such as Intel SGX. With FPC, chaincode execution is shielded, ensuring that sensitive data and business logic remain confidential—even from the hosting peers. This makes FPC an ideal choice for organizations handling highly sensitive information, such as financial transactions or medical records, while still benefiting from the transparency and immutability of blockchain. + +By integrating FPC with CC Tools, developers can now enjoy a streamlined workflow for deploying and managing private chaincode. This integration combines the usability of CC Tools with the robust privacy guarantees of FPC, enabling faster development cycles without compromising data security. To learn more about the design and technical details of this integration project, refer to the [design document](https://github.com/hyperledger/fabric-private-chaincode/tree/main/docs/design/integrate-with-cc-tools) for a comprehensive explanation. + +## Prerequisites + +To be able to use FPC, you are required to have some software components as dependencies to enable the trusted execution of chaincodes. Follow the [getting started guide](https://github.com/hyperledger/fabric-private-chaincode?tab=readme-ov-file#getting-started) on FPC till you're able to setup the development environment. + +## Integrating your chaincode with FPC + +As part of the integration project, there is now a tutorial explaining step-by-step how to run your chaincode that is using cc-tools framework within a trusted execution environment with FPC. Follow the [tutorial]() for more. \ No newline at end of file