-
Notifications
You must be signed in to change notification settings - Fork 98
feature(samples): confidential escrow example - LFX25 #836
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
PsychoPunkSage
wants to merge
3
commits into
hyperledger:main
Choose a base branch
from
PsychoPunkSage:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+9,369
−1
Open
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| export CC_ID=confidential-escrow | ||
| export CHANNEL_NAME=mychannel | ||
| export CORE_PEER_ADDRESS=localhost:7051 | ||
| export CORE_PEER_ID=peer0.org1.example.com | ||
| export CORE_PEER_ORG_NAME=org1 | ||
| export CORE_PEER_LOCALMSPID=Org1MSP | ||
| export CORE_PEER_MSPCONFIGPATH=$FPC_PATH/samples/deployment/test-network/fabric-samples/test-network/organizations/peerOrganizations/org1.example.com/users/Admin@org1.example.com/msp | ||
| export CORE_PEER_TLS_CERT_FILE=$FPC_PATH/samples/deployment/test-network/fabric-samples/test-network/organizations/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/server.crt | ||
| export CORE_PEER_TLS_ENABLED="true" | ||
| export CORE_PEER_TLS_KEY_FILE=$FPC_PATH/samples/deployment/test-network/fabric-samples/test-network/organizations/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/server.key | ||
| export CORE_PEER_TLS_ROOTCERT_FILE=$FPC_PATH/samples/deployment/test-network/fabric-samples/test-network/organizations/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/ca.crt | ||
| export ORDERER_CA=$FPC_PATH/samples/deployment/test-network/fabric-samples/test-network/organizations/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem | ||
| export GATEWAY_CONFIG=$FPC_PATH/samples/deployment/test-network/fabric-samples/test-network/organizations/peerOrganizations/org1.example.com/connection-org1.yaml | ||
| export FPC_ENABLED=true | ||
| export RUN_CCAAS=true |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| export CC_ID=confidential-escrow | ||
| export CHANNEL_NAME=mychannel | ||
| export CORE_PEER_ADDRESS=localhost:9051 | ||
| export CORE_PEER_ID=peer0.org2.example.com | ||
| export CORE_PEER_ORG_NAME=org2 | ||
| export CORE_PEER_LOCALMSPID=Org2MSP | ||
| export CORE_PEER_MSPCONFIGPATH=$FPC_PATH/samples/deployment/test-network/fabric-samples/test-network/organizations/peerOrganizations/org2.example.com/users/Admin@org2.example.com/msp | ||
| export CORE_PEER_TLS_CERT_FILE=$FPC_PATH/samples/deployment/test-network/fabric-samples/test-network/organizations/peerOrganizations/org2.example.com/peers/peer0.org2.example.com/tls/server.crt | ||
| export CORE_PEER_TLS_ENABLED="true" | ||
| export CORE_PEER_TLS_KEY_FILE=$FPC_PATH/samples/deployment/test-network/fabric-samples/test-network/organizations/peerOrganizations/org2.example.com/peers/peer0.org2.example.com/tls/server.key | ||
| export CORE_PEER_TLS_ROOTCERT_FILE=$FPC_PATH/samples/deployment/test-network/fabric-samples/test-network/organizations/peerOrganizations/org2.example.com/peers/peer0.org2.example.com/tls/ca.crt | ||
| export ORDERER_CA=$FPC_PATH/samples/deployment/test-network/fabric-samples/test-network/organizations/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem | ||
| export GATEWAY_CONFIG=$FPC_PATH/samples/deployment/test-network/fabric-samples/test-network/organizations/peerOrganizations/org2.example.com/connection-org2.yaml | ||
| export FPC_ENABLED=true | ||
| export RUN_CCAAS=true | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| export CC_ID=confidential-escrow | ||
| export CHANNEL_NAME=mychannel | ||
| export CORE_PEER_ADDRESS=localhost:7051 | ||
| export CORE_PEER_ID=peer0.org1.example.com | ||
| export CORE_PEER_ORG_NAME=org1 | ||
| export CORE_PEER_LOCALMSPID=Org1MSP | ||
| export CORE_PEER_MSPCONFIGPATH=$FPC_PATH/samples/deployment/test-network/fabric-samples/test-network/organizations/peerOrganizations/org1.example.com/users/Admin@org1.example.com/msp | ||
| export CORE_PEER_TLS_CERT_FILE=$FPC_PATH/samples/deployment/test-network/fabric-samples/test-network/organizations/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/server.crt | ||
| export CORE_PEER_TLS_ENABLED="true" | ||
| export CORE_PEER_TLS_KEY_FILE=$FPC_PATH/samples/deployment/test-network/fabric-samples/test-network/organizations/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/server.key | ||
| export CORE_PEER_TLS_ROOTCERT_FILE=$FPC_PATH/samples/deployment/test-network/fabric-samples/test-network/organizations/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/ca.crt | ||
| export ORDERER_CA=$FPC_PATH/samples/deployment/test-network/fabric-samples/test-network/organizations/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem | ||
| export GATEWAY_CONFIG=$FPC_PATH/samples/deployment/test-network/fabric-samples/test-network/organizations/peerOrganizations/org1.example.com/connection-org1.yaml | ||
| export FPC_ENABLED=true | ||
| export RUN_CCAAS=true |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| ecc | ||
| ecc-bundle | ||
| enclave.json | ||
| private.pem | ||
| public.pem | ||
| mrenclave | ||
| details.env | ||
|
|
||
| .env | ||
| *.bak |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| TOP = ../../.. | ||
PsychoPunkSage marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| include $(TOP)/ecc_go/build.mk | ||
|
|
||
| CC_NAME ?= confidential-escrow | ||
|
|
||
| EGO_CONFIG_FILE = $(FPC_PATH)/samples/chaincode/confidential-escrow/confidentialEscrowEnclave.json | ||
| ECC_MAIN_FILES=$(FPC_PATH)/samples/chaincode/confidential-escrow | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| # Confidential Escrow Chaincode | ||
|
|
||
| A privacy-preserving escrow system built on Hyperledger Fabric Private Chaincode (FPC) that enables secure digital asset management with programmable conditional payments. | ||
|
|
||
| ## Overview | ||
|
|
||
| This chaincode implements a confidential escrow mechanism for digital assets, combining: | ||
|
|
||
| - **Privacy-Preserving Transactions**: All transaction data is encrypted within Intel SGX enclaves | ||
| - **Programmable Escrow Contracts**: Automated conditional fund releases based on cryptographic verification | ||
| - **Multi-Asset Support**: Manage multiple token types within individual wallets | ||
| - **Certificate-Based Authorization**: Fine-grained access control using X.509 certificate hashes | ||
|
|
||
| ## Architecture | ||
|
|
||
| ### Core Components | ||
|
|
||
| **Assets** | ||
|
|
||
| - `DigitalAsset`: Fungible tokens with controlled supply (CBDC, stablecoins, etc.) | ||
| - `Wallet`: User accounts supporting multiple asset types with separate available and escrowed balances | ||
| - `Escrow`: Smart contracts holding funds pending condition fulfillment | ||
| - `UserDirectory`: Privacy-preserving public key to wallet UUID mapping | ||
|
|
||
| **Transaction Operations** | ||
|
|
||
| - Asset lifecycle: Create, mint, transfer, burn | ||
| - Wallet management: Create wallets, query balances | ||
| - Escrow workflow: Lock funds, verify conditions, release or refund | ||
|
|
||
| ## Project Structure | ||
|
|
||
| ``` | ||
| confidential-escrow/ | ||
| ├── chaincode/ | ||
| │ ├── assets/ # Asset type definitions | ||
| │ ├── transactions/ # Transaction handlers | ||
| │ ├── header/ # Chaincode metadata | ||
| │ ├── escrow.go # Main chaincode implementation | ||
| │ ├── server.go # CCaaS server setup | ||
| │ └── setup.go # Component registration | ||
| ├── main.go # Entry point | ||
| ├── main.sh # Deployment and test automation | ||
| └── README.md # This file | ||
| ``` | ||
|
|
||
| ### Security Model | ||
|
|
||
| 1. **Access Control**: All operations require valid certificate hash verification | ||
| 2. **Atomic Escrow**: Funds move from available to escrowed balance during lock, preventing double-spending | ||
| 3. **Condition Verification**: SHA-256 hash of `(secret + parcelId)` ensures only authorized parties can release funds | ||
| 4. **Confidential Execution**: FPC ensures transaction details remain private within SGX enclaves | ||
|
|
||
| ## Running Procedure | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - FPC is properly set up and built | ||
| - `multi_user_dashboard.sh ` script is placed in the chaincode directory | ||
| - `.env.alice` and `.env.bob` file is present | ||
|
|
||
| ### Setup Files | ||
|
|
||
| **1. Set FPC_PATH:** | ||
|
|
||
| ```bash | ||
| export FPC_PATH=/project/src/github.com/hyperledger/fabric-private-chaincode | ||
| ``` | ||
|
|
||
| ### Running Procedure | ||
|
|
||
| #### 1. In 1st terminal window - Setup and Deploy | ||
|
|
||
| ```bash | ||
| # Get inside dev env | ||
| make -C $FPC_PATH/utils/docker run-dev | ||
| cd samples/chaincode/confidential-escrow | ||
|
|
||
| # Interactive menu | ||
| ./multi_user_dashboard.sh | ||
|
|
||
| # Choose Option 1. or 2. as per your setup condn | ||
| ``` | ||
|
|
||
| #### 2. In 2nd terminal window - Docker Environment (`Alice`) | ||
|
|
||
| ```bash | ||
| # Enter docker container | ||
| docker exec -it fpc-development-main /bin/bash | ||
| cd samples/chaincode/confidential-escrow | ||
|
|
||
| # Interactive menu | ||
| ./multi_user_dashboard.sh | ||
|
|
||
| # Setup Alice using Option 3. | ||
| ``` | ||
|
|
||
| #### 3. In 3rd terminal window - Docker Environment (`Bob`) | ||
|
|
||
| ```bash | ||
| # Enter docker container | ||
| docker exec -it fpc-development-main /bin/bash | ||
| cd samples/chaincode/confidential-escrow | ||
|
|
||
| # Interactive menu | ||
| ./multi_user_dashboard.sh | ||
|
|
||
| # Setup Bob using Option 4. | ||
| ``` | ||
|
|
||
| #### 4. In 3rd terminal window - Docker Environment (`Monitor`) | ||
PsychoPunkSage marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ```bash | ||
| # Enter docker container | ||
| docker exec -it fpc-development-main /bin/bash | ||
| cd samples/chaincode/confidential-escrow | ||
|
|
||
| # Interactive menu | ||
| ./multi_user_dashboard.sh | ||
|
|
||
| # Setup Bob using Option 5. | ||
PsychoPunkSage marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
| #### 5. Run Tests | ||
PsychoPunkSage marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ```bash | ||
| # Run all basic tests | ||
| ./multi_user_dashboard.sh | ||
|
|
||
| # Chosing Option 7. | ||
| ``` | ||
|
|
||
PsychoPunkSage marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Contributing | ||
|
|
||
| When adding new features: | ||
|
|
||
| 1. Define asset types in `chaincode/assets/` | ||
| 2. Implement transaction logic in `chaincode/transactions/` | ||
| 3. Register new components in `chaincode/setup.go` | ||
| 4. Add test cases to `main.sh` | ||
| 5. Update this README with usage examples | ||
62 changes: 62 additions & 0 deletions
62
samples/chaincode/confidential-escrow/chaincode/assets/digital_asset.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| package assets | ||
|
|
||
| import ( | ||
| "github.com/hyperledger-labs/cc-tools/assets" | ||
| ) | ||
|
|
||
| // DigitalAssetToken defines the asset type for fungible digital tokens. | ||
| // This represents confidential digital currencies such as Central Bank Digital Currencies (CBDC) | ||
| // or tokenized assets. Each token type has a fixed supply controlled by the issuer. | ||
| // | ||
| // Security: The issuerHash ensures only authorized entities can mint/burn tokens. | ||
| var DigitalAssetToken = assets.AssetType{ | ||
| Tag: "digitalAsset", | ||
| Label: "Digital Asset Token", | ||
| Description: "Confidential digital currency token (e.g., CBDC)", | ||
|
|
||
| Props: []assets.AssetProp{ | ||
| { | ||
| Tag: "name", | ||
| Label: "Token Name", | ||
| DataType: "string", | ||
| Required: true, | ||
| }, | ||
| { | ||
| Tag: "symbol", | ||
| Label: "Token Symbol", | ||
| DataType: "string", | ||
| Required: true, | ||
| IsKey: true, | ||
| }, | ||
| { | ||
| Tag: "decimals", | ||
| Label: "Decimal Places", | ||
| DataType: "number", | ||
| Required: true, | ||
| }, | ||
| { | ||
| Tag: "totalSupply", | ||
| Label: "Total Supply", | ||
| DataType: "number", | ||
| Required: true, | ||
| }, | ||
| { | ||
| Tag: "issuerHash", | ||
| Label: "Issuer Certificate Hash", | ||
| DataType: "string", | ||
| Required: true, | ||
| }, | ||
| { | ||
| Tag: "owner", | ||
| Label: "Owner Identity", | ||
| DataType: "string", | ||
| Required: true, | ||
| }, | ||
| { | ||
| Tag: "issuedAt", | ||
| Label: "Issued At", | ||
| DataType: "datetime", | ||
| Required: false, | ||
| }, | ||
| }, | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.