-
Notifications
You must be signed in to change notification settings - Fork 294
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(connector-fabric): containerize-fabric
Signed-off-by: jordigiam <[email protected]>
- Loading branch information
Showing
2 changed files
with
170 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,5 @@ | ||
| FROM cactus-api-server:latest | ||
|
|
||
| ARG NPM_PKG_VERSION=latest | ||
|
|
||
| RUN npm i @hyperledger/cactus-plugin-ledger-connector-fabric@${NPM_PKG_VERSION} --production |
This file contains 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 |
|---|---|---|
|
|
@@ -74,6 +74,171 @@ To check that all has been installed correctly and that the pugin has no errors, | |
| ```sh | ||
| npm run test:plugin-ledger-connector-fabric | ||
| ``` | ||
| ### Building/running the container image locally | ||
|
|
||
| In the Cactus project root say: | ||
|
|
||
| ```sh | ||
| DOCKER_BUILDKIT=1 docker build -f ./packages/cactus-plugin-ledger-connector-fabric/Dockerfile . -t cplcb | ||
| ``` | ||
|
|
||
| Build with a specific version of the npm package: | ||
| ```sh | ||
| DOCKER_BUILDKIT=1 docker build --build-arg NPM_PKG_VERSION=0.4.1 -f ./packages/cactus-plugin-ledger-connector-fabric/Dockerfile . -t cplcb | ||
| ``` | ||
|
|
||
| #### Running the container | ||
|
|
||
| Launch container with plugin configuration as an **environment variable**: | ||
| ```sh | ||
| docker run \ | ||
| --rm \ | ||
| --publish 3000:3000 \ | ||
| --publish 4000:4000 \ | ||
| --env PLUGINS='[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-fabric", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "options": {"instanceId": "some-unique-fabric-connector-instance-id", "dockerBinary": "usr/local/bin/docker","cliContainerEnv": { | ||
| "CORE_PEER_LOCALMSPID": "Org1MSP", | ||
| "CORE_PEER_ADDRESS": "peer0.org1.example.com:7051", | ||
| "CORE_PEER_MSPCONFIGPATH": | ||
| "/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/users/[email protected]/msp", | ||
| "CORE_PEER_TLS_ROOTCERT_FILE": | ||
| "/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/ca.crt", | ||
| "ORDERER_TLS_ROOTCERT_FILE": | ||
| "/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem" | ||
| }, | ||
| "discoveryOptions": { | ||
| "enabled": true, | ||
| "asLocalhost: true" | ||
| } | ||
| }}}]' \ | ||
| cplcb | ||
| ``` | ||
|
|
||
| Launch container with plugin configuration as a **CLI argument**: | ||
| ```sh | ||
| docker run \ | ||
| --rm \ | ||
| --publish 3000:3000 \ | ||
| --publish 4000:4000 \ | ||
| cplcb \ | ||
| ./node_modules/.bin/cactusapi \ | ||
| --plugins='[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-fabric", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "options": {"instanceId": "some-unique-fabric-connector-instance-id", "dockerBinary": "usr/local/bin/docker","cliContainerEnv": { | ||
| "CORE_PEER_LOCALMSPID": "Org1MSP", | ||
| "CORE_PEER_ADDRESS": "peer0.org1.example.com:7051", | ||
| "CORE_PEER_MSPCONFIGPATH": | ||
| "/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/users/[email protected]/msp", | ||
| "CORE_PEER_TLS_ROOTCERT_FILE": | ||
| "/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/ca.crt", | ||
| "ORDERER_TLS_ROOTCERT_FILE": | ||
| "/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem" | ||
| }, | ||
| "discoveryOptions": { | ||
| "enabled": true, | ||
| "asLocalhost: true" | ||
| } | ||
| }}}]' | ||
| ``` | ||
|
|
||
| Launch container with **configuration file** mounted from host machine: | ||
| ```sh | ||
|
|
||
| echo '[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-fabric", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "options": {"instanceId": "some-unique-fabric-connector-instance-id", "dockerBinary": "usr/local/bin/docker","cliContainerEnv": { | ||
| "CORE_PEER_LOCALMSPID": "Org1MSP", | ||
| "CORE_PEER_ADDRESS": "peer0.org1.example.com:7051", | ||
| "CORE_PEER_MSPCONFIGPATH": | ||
| "/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/users/[email protected]/msp", | ||
| "CORE_PEER_TLS_ROOTCERT_FILE": | ||
| "/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/ca.crt", | ||
| "ORDERER_TLS_ROOTCERT_FILE": | ||
| "/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem" | ||
| }, | ||
| "discoveryOptions": { | ||
| "enabled": true, | ||
| "asLocalhost: true" | ||
| } | ||
| }}}]' > cactus.json | ||
|
|
||
| docker run \ | ||
| --rm \ | ||
| --publish 3000:3000 \ | ||
| --publish 4000:4000 \ | ||
| --mount type=bind,source="$(pwd)"/cactus.json,target=/cactus.json \ | ||
| cplcb \ | ||
| ./node_modules/.bin/cactusapi \ | ||
| --config-file=/cactus.json | ||
| ``` | ||
|
|
||
| #### Testing API calls with the container | ||
|
|
||
| Don't have a fabric network on hand to test with? Test or develop against our fabric All-In-One container! | ||
|
|
||
| **Terminal Window 1 (Ledger)** | ||
| ```sh | ||
| docker run -p 0.0.0.0:8545:8545/tcp -p 0.0.0.0:8546:8546/tcp -p 0.0.0.0:8888:8888/tcp -p 0.0.0.0:9001:9001/tcp -p 0.0.0.0:9545:9545/tcp hyperledger/cactus-fabric-all-in-one:latest | ||
| ``` | ||
|
|
||
| **Terminal Window 2 (Cactus API Server)** | ||
| ```sh | ||
| docker run \ | ||
| --network host \ | ||
| --rm \ | ||
| --publish 3000:3000 \ | ||
| --publish 4000:4000 \ | ||
| --env PLUGINS='[{"packageName": "@hyperledger/cactus-plugin-ledger-connector-fabric", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "options": {"instanceId": "some-unique-fabric-connector-instance-id", "dockerBinary": "usr/local/bin/docker","cliContainerEnv": { | ||
| "CORE_PEER_LOCALMSPID": "Org1MSP", | ||
| "CORE_PEER_ADDRESS": "peer0.org1.example.com:7051", | ||
| "CORE_PEER_MSPCONFIGPATH": | ||
| "/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/users/[email protected]/msp", | ||
| "CORE_PEER_TLS_ROOTCERT_FILE": | ||
| "/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/peers/peer0.org1.example.com/tls/ca.crt", | ||
| "ORDERER_TLS_ROOTCERT_FILE": | ||
| "/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem" | ||
| }, | ||
| "discoveryOptions": { | ||
| "enabled": true, | ||
| "asLocalhost: true" | ||
| } | ||
| }}}]' \ | ||
| cplcb | ||
| ``` | ||
|
|
||
| **Terminal Window 3 (curl - replace eth accounts as needed)** | ||
| ```sh | ||
| curl --location --request POST 'http://127.0.0.1:4000/api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-fabric/run-transaction' \ | ||
| --header 'Content-Type: application/json' \ | ||
| --data-raw '{ | ||
| channelName: "mychannel", | ||
| contractName: "contract-example"; | ||
| invocationType: "FabricContractInvocationType.SEND"; | ||
| methodName: "example" | ||
| }' | ||
| ``` | ||
|
|
||
| The above should produce a response that looks similar to this: | ||
|
|
||
| ```json | ||
| { | ||
| "success": true, | ||
| "data": { | ||
| "transactionReceipt": { | ||
| "blockHash": "0x7c97c038a5d3bd84613fe23ed442695276d5d2df97f4e7c4f10ca06765033ffd", | ||
| "blockNumber": 1218, | ||
| "contractAddress": null, | ||
| "cumulativeGasUsed": 21000, | ||
| "from": "0x627306090abab3a6e1400e9345bc60c78a8bef57", | ||
| "gasUsed": 21000, | ||
| "logs": [], | ||
| "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", | ||
| "status": true, | ||
| "to": "0xf17f52151ebef6c7334fad080c5704d77216b732", | ||
| "transactionHash": "0xc7fcb46c735bdc696d500bfc70c72595a2b8c31813929e5c61d9a5aec3376d6f", | ||
| "transactionIndex": 0 | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ## Prometheus Exporter | ||
|
|
||
| This class creates a prometheus exporter, which scraps the transactions (total transaction count) for the use cases incorporating the use of Fabric connector plugin. | ||
|
|
||