Skip to content

Commit d9e443f

Browse files
authored
docs: add notes for ccapi
Signed-off-by: Osama Magdy <59124937+osamamagdy@users.noreply.github.com>
1 parent ed6cea3 commit d9e443f

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

samples/application/ccapi/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,18 @@ The transaction client invocation process, as illustrated in the diagram, consis
1313
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.
1414
2. Step 3: The handler starts by determining the appropriate transaction invocation based on the requested endpoint and calling the corresponding chaincode API.
1515
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 and 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.
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.
1717

1818
![CCAPIFlow](./CCAPIFlow.png)
1919

2020
## User Experience
2121

22-
CCAPI is using docker and docker-compose for spinning up all the required components needed to work.
22+
CCAPI uses docker and docker-compose to spin up all the required components to work.
2323

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

26+
Note: The following steps should run outside the FPC dev container
27+
2628
Start by running:
2729

2830
```bash
@@ -34,4 +36,4 @@ then go to the browser and type `localhost:80` to open the swagger api and start
3436

3537
## Future work
3638

37-
CCAPI have another component for the dashboard frontend application but it's not yet utilized with
39+
CCAPI has another component for the dashboard frontend application but it's not yet utilized with

0 commit comments

Comments
 (0)