Skip to content

Commit 8621522

Browse files
authored
Merge pull request #77 from osamamagdy/feature/integrate-with-fpc
feat: add documentation about how to integrate with FPC
2 parents 9de20ef + 970ff0e commit 8621522

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
- `/fabric`: Fabric network v2.5 used as a test environment
66
- `/chaincode`: chaincode-related files
77
- `/ccapi`: chaincode REST API in Golang project
8+
- `/fabric-private-chaincode`: Explaining the integration project between CC-tools and FPC
89

910
## Development
1011

@@ -66,6 +67,10 @@ By using the `--org/-o` option along the script, it's possible to specify the or
6667

6768
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`
6869

70+
## Integration with Fabric Private Chaincode
71+
72+
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.
73+
6974
## More
7075

7176
You can reach GoLedger developers and `cc-tools` maintainers at our Discord - [Join us!](https://discord.gg/GndkYHxNyQ)

fabric-private-chaincode/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Integration with Fabric Private Chaincode
2+
3+
## Motivation
4+
5+
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 susceptible information, such as financial transactions or medical records, while still benefiting from the transparency and immutability of blockchain.
6+
7+
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.
8+
9+
## Prerequisites
10+
11+
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 until you can set up the development environment.
12+
13+
## Integrating your chaincode with FPC
14+
15+
As part of the integration project, there is now a tutorial explaining step-by-step how to run your chaincode using cc-tools framework within a trusted execution environment with FPC. Follow the [tutorial](https://github.com/hyperledger/fabric-private-chaincode/tree/main/samples/chaincode/cc-tools-demo) for more.

0 commit comments

Comments
 (0)