Skip to content

Commit 816fe49

Browse files
osamamagdymunapower
osamamagdy
authored and
munapower
committed
feat: add ccapi to application samples (#780)
* feat: add ccapi Signed-off-by: osamamagdy <osamamagdy174@gmail.com> * fix: fix linting errors Signed-off-by: osamamagdy <osamamagdy174@gmail.com> * fix: add go mod for ccapi Signed-off-by: osamamagdy <osamamagdy174@gmail.com> * fix: edit go mod to use fpc from main commit Signed-off-by: osamamagdy <osamamagdy174@gmail.com> * fix: edit path Signed-off-by: osamamagdy <osamamagdy174@gmail.com> * fix: remove go mod vendor from dockerfile Signed-off-by: osamamagdy <osamamagdy174@gmail.com> * doc: cd into ccapi before running Signed-off-by: osamamagdy <osamamagdy174@gmail.com> * feat: remove hardcoded org name Signed-off-by: osamamagdy <osamamagdy174@gmail.com> * feat: edit ccapi to be just an extension Signed-off-by: osamamagdy <osamamagdy174@gmail.com> * fix: add the org name for scripts Signed-off-by: osamamagdy <osamamagdy174@gmail.com> * fix: export CORE_PEER_ORG_NAME Signed-off-by: osamamagdy <osamamagdy174@gmail.com> * docs: edit readme Signed-off-by: osamamagdy <osamamagdy174@gmail.com> * docs: add notes for ccapi Signed-off-by: Osama Magdy <59124937+osamamagdy@users.noreply.github.com> --------- Signed-off-by: osamamagdy <osamamagdy174@gmail.com> Signed-off-by: Osama Magdy <59124937+osamamagdy@users.noreply.github.com>
1 parent d14ffd7 commit 816fe49

File tree

35 files changed

+3900
-1
lines changed

35 files changed

+3900
-1
lines changed

‎samples/application/ccapi/CCAPIFlow.png‎

18.3 KB
Loading

‎samples/application/ccapi/Dockerfile‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Use an official Golang runtime as a parent image
2+
FROM golang:1.21-alpine AS build
3+
4+
ENV PATH="${PATH}:/usr/bin/"
5+
6+
RUN apk update
7+
8+
RUN apk add \
9+
docker \
10+
openrc \
11+
git \
12+
gcc \
13+
gcompat \
14+
libc-dev \
15+
libc6-compat \
16+
libstdc++ && \
17+
ln -s /lib/libc.so.6 /usr/lib/libresolv.so.2
18+
19+
# Set the working directory to /rest-server
20+
WORKDIR /rest-server
21+
22+
# Copy the go.mod and go.sum files for dependency management
23+
COPY go.mod go.sum ./
24+
25+
# Install go dependencies
26+
RUN go mod download
27+
28+
# Copy the current directory contents into the container at /rest-server
29+
COPY . .
30+
31+
# Build the Go ccapi
32+
RUN go build -o ccapi
33+
34+
# # Use an official Alpine runtime as a parent image
35+
# FROM alpine:latest
36+
37+
# ENV PATH="${PATH}:/usr/bin/"
38+
39+
# RUN apk update
40+
41+
# RUN apk add \
42+
# docker \
43+
# openrc \
44+
# git \
45+
# gcc \
46+
# gcompat \
47+
# libc-dev \
48+
# libc6-compat \
49+
# libstdc++ && \
50+
# ln -s /lib/libc.so.6 /usr/lib/libresolv.so.2
51+
52+
# # Set the working directory to /rest-server
53+
# WORKDIR /rest-server
54+
55+
# Copy the ccapi binary from the build container to the current directory in the Alpine container
56+
RUN ls -l
57+
RUN pwd
58+
59+
RUN cp ./ccapi /usr/bin/ccapi
60+
61+
# Run the ccapi binary
62+
CMD ["ccapi"]

‎samples/application/ccapi/README.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# CCAPI - A web server developed to interface with CC-tools chaincode
2+
3+
## Motivation
4+
5+
As continuation to the [cc-tools-demo]() tutorial on how to integrate the cc-tools project with FPC chaincodes, we start by utilizing another powerful solution offered by cc-tools which is the CCAPI. It's a complete web server that simplifies the communication with the peers and Fabric components to replace the need to deal with CLI applications.
6+
7+
## Architecture
8+
9+
The following diagram explains the process where we modified the API server developed for a demo on cc-tools ([CCAPI](https://github.com/hyperledger-labs/cc-tools-demo/tree/main/ccapi)) and modified it to communicate with FPC code.
10+
11+
The transaction client invocation process, as illustrated in the diagram, consists of several key steps that require careful integration between FPC and cc-tools.
12+
13+
1. Step 1-2: The API server is listening for requests on a specified port over an HTTP channel and sends it to the handler.
14+
2. Step 3: The handler starts by determining the appropriate transaction invocation based on the requested endpoint and calling the corresponding chaincode API.
15+
3. Step 4: The chaincode API is responsible for parsing and ensuring the payload is correctly parsed into a format that is FPC-friendly. This parsing step is crucial, as it prepares the data to meet FPC’s privacy and security requirements before it reaches the peer.
16+
4. Step 5: FPCUtils is the step where the actual transaction invocation happens. It follows the steps explained in [here](https://github.com/hyperledger/fabric-rfcs/blob/main/text/0000-fabric-private-chaincode-1.0.md#fpc-transaction-flow) as it builds on top of the FPC Client SDK.
17+
18+
![CCAPIFlow](./CCAPIFlow.png)
19+
20+
## User Experience
21+
22+
CCAPI uses docker and docker-compose to spin up all the required components to work.
23+
24+
Have a look at the [fpc-docker-compose.yaml](./fpc-docker-compose.yaml) to see how we use different env vars. Most of these environment variables are required by any client application to work and communicate with FPC. If you followed the [cc-tools-demo](../../chaincode/cc-tools-demo/README.md) tutorial, the values should be the same.
25+
26+
Note: The following steps should run outside the FPC dev container
27+
28+
Start by running:
29+
30+
```bash
31+
cd $FPC_PATH/samples/application/ccapi
32+
docker-compose -f fpc-docker-compose.yaml up
33+
```
34+
35+
then go to the browser and type `localhost:80` to open the swagger api and start executing functions.
36+
37+
## Future work
38+
39+
CCAPI has another component for the dashboard frontend application but it's not yet utilized with

‎samples/application/ccapi/chaincode/invokeFPC.go‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/*
2+
Copyright IBM Corp. All Rights Reserved.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/
6+
7+
package chaincode
8+
9+
import (
10+
"net/http"
11+
12+
"github.com/hyperledger/fabric-private-chaincode/samples/application/ccapi/common"
13+
)
14+
15+
func InvokeFpc(channelName string, chaincodeName string, txname string, args [][]byte) ([]byte, int, error) {
16+
stringArgs := make([]string, len(args))
17+
for i, b := range args {
18+
stringArgs[i] = string(b)
19+
}
20+
21+
client := common.NewFpcClient(channelName, chaincodeName)
22+
res := client.Invoke(txname, stringArgs[0:]...)
23+
return []byte(res), http.StatusOK, nil
24+
}

‎samples/application/ccapi/chaincode/invokeFPCDefault.go‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/*
2+
Copyright IBM Corp. All Rights Reserved.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/
6+
7+
package chaincode
8+
9+
import (
10+
"net/http"
11+
12+
"github.com/hyperledger/fabric-private-chaincode/samples/application/ccapi/common"
13+
)
14+
15+
func InvokeFpcDefault(txname string, args [][]byte) ([]byte, int, error) {
16+
stringArgs := make([]string, len(args))
17+
for i, b := range args {
18+
stringArgs[i] = string(b)
19+
}
20+
21+
client := common.NewDefaultFpcClient()
22+
res := client.Invoke(txname, stringArgs[0:]...)
23+
return []byte(res), http.StatusOK, nil
24+
}

‎samples/application/ccapi/chaincode/queryFPC.go‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/*
2+
Copyright IBM Corp. All Rights Reserved.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/
6+
7+
package chaincode
8+
9+
import (
10+
"net/http"
11+
12+
"github.com/hyperledger/fabric-private-chaincode/samples/application/ccapi/common"
13+
)
14+
15+
func QueryFpc(chaincodeName string, channelName string, txName string, args [][]byte) ([]byte, int, error) {
16+
stringArgs := make([]string, len(args))
17+
for i, b := range args {
18+
stringArgs[i] = string(b)
19+
}
20+
21+
client := common.NewFpcClient(chaincodeName, channelName)
22+
res := client.Query(txName, stringArgs[0:]...)
23+
return []byte(res), http.StatusOK, nil
24+
}

‎samples/application/ccapi/chaincode/queryFPCDefault.go‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/*
2+
Copyright IBM Corp. All Rights Reserved.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/
6+
7+
package chaincode
8+
9+
import (
10+
"net/http"
11+
12+
"github.com/hyperledger/fabric-private-chaincode/samples/application/ccapi/common"
13+
)
14+
15+
func QueryFpcDefault(txName string, args [][]byte) ([]byte, int, error) {
16+
stringArgs := make([]string, len(args))
17+
for i, b := range args {
18+
stringArgs[i] = string(b)
19+
}
20+
21+
client := common.NewDefaultFpcClient()
22+
res := client.Query(txName, stringArgs[0:]...)
23+
return []byte(res), http.StatusOK, nil
24+
}

‎samples/application/ccapi/common/fpc.go‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
/*
2+
Copyright IBM Corp. All Rights Reserved.
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/
6+
7+
package common
8+
9+
import (
10+
"fmt"
11+
"os"
12+
"strconv"
13+
14+
pkgFpc "github.com/hyperledger/fabric-private-chaincode/samples/application/ccapi/fpcUtils"
15+
)
16+
17+
var (
18+
defaultFpcConfig *pkgFpc.Config
19+
)
20+
21+
func InitFpcConfig() {
22+
23+
getStrEnv := func(key string) string {
24+
val := os.Getenv(key)
25+
if val == "" {
26+
panic(fmt.Sprintf("%s not set", key))
27+
}
28+
return val
29+
}
30+
31+
getBoolEnv := func(key string) bool {
32+
val := getStrEnv(key)
33+
ret, err := strconv.ParseBool(val)
34+
if err != nil {
35+
if val == "" {
36+
panic(fmt.Sprintf("invalid bool value for %s", key))
37+
}
38+
}
39+
return ret
40+
}
41+
42+
defaultFpcConfig = &pkgFpc.Config{
43+
CorePeerAddress: getStrEnv("CORE_PEER_ADDRESS"),
44+
CorePeerId: getStrEnv("CORE_PEER_ID"),
45+
CorePeerOrgName: getStrEnv("CORE_PEER_ORG_NAME"),
46+
CorePeerLocalMSPID: getStrEnv("CORE_PEER_LOCALMSPID"),
47+
CorePeerMSPConfigPath: getStrEnv("CORE_PEER_MSPCONFIGPATH"),
48+
CorePeerTLSCertFile: getStrEnv("CORE_PEER_TLS_CERT_FILE"),
49+
CorePeerTLSEnabled: getBoolEnv("CORE_PEER_TLS_ENABLED"),
50+
CorePeerTLSKeyFile: getStrEnv("CORE_PEER_TLS_KEY_FILE"),
51+
CorePeerTLSRootCertFile: getStrEnv("CORE_PEER_TLS_ROOTCERT_FILE"),
52+
OrdererCA: getStrEnv("ORDERER_CA"),
53+
ChaincodeId: getStrEnv("CCNAME"),
54+
ChannelId: getStrEnv("CHANNEL"),
55+
GatewayConfigPath: getStrEnv("GATEWAY_CONFIG"),
56+
}
57+
58+
}
59+
60+
func NewDefaultFpcClient() *pkgFpc.Client {
61+
return pkgFpc.NewClient(defaultFpcConfig)
62+
}
63+
64+
func NewFpcClient(channelName string, chaincodeName string) *pkgFpc.Client {
65+
fpcConfig := defaultFpcConfig
66+
fpcConfig.ChannelId = channelName
67+
fpcConfig.ChaincodeId = chaincodeName
68+
return pkgFpc.NewClient(fpcConfig)
69+
}

0 commit comments

Comments
 (0)