Skip to content

Commit

Permalink
docs: add tutorial for ccapi
Browse files Browse the repository at this point in the history
  • Loading branch information
osamamagdy committed Oct 18, 2024
1 parent 57a9ff3 commit a16a291
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 1,245 deletions.
Binary file added samples/application/ccapi/CCAPIFlow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 27 additions & 0 deletions samples/application/ccapi/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# CCAPI - A web server developed to interface with CC-tools chaincode

## Motivation

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 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.

## Architecture

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.

The transaction client invocation process, as illustrated in the diagram, consists of several key steps that require careful integration between FPC and cc-tools.

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.
2. Step 3: The handler starts by determining the appropriate transaction invocation based on the requested endpoint and calling the corresponding chaincode API.
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.
4. Step 5: FPCUtils is the step where the actual transaction invocation happens and it follows the steps explained in the previous diagram as it builds on top of the FPC Client SDK.

![CCAPIFlow](./CCAPIFlow.png)


## User Experience

CCAPI is using docker and docker-compose for spinning up all the required components needed to work.

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.

Start by running `docker-compose -f fpc-docker-compose.yaml up`
33 changes: 0 additions & 33 deletions samples/application/ccapi/docker-compose-1org.yaml

This file was deleted.

85 changes: 0 additions & 85 deletions samples/application/ccapi/docker-compose.yaml

This file was deleted.

97 changes: 0 additions & 97 deletions samples/application/ccapi/go.mod

This file was deleted.

Loading

0 comments on commit a16a291

Please sign in to comment.