Add simple REST API

.github/scripts/install-local-cli.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+#
+# Copyright (c) Gala Games Inc. All rights reserved.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+set -eu
+
+cd "$GITHUB_WORKSPACE"
+
+npm i
+(cd chain-cli && ../npm-pack-and-replace.sh --skipConfirmation && npm i -g gala-chain-cli-*)
+
+galachain --help

.github/workflows/ci.yml

@@ -12,29 +12,51 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Install jq
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y jq
-      - name: Check Copyright
+      - name: Verify copyright
         run: ./verify_copyright.sh
       - name: Install Node 18
         uses: actions/setup-node@v4
         with:
           node-version: 18
+      - name: Install dependencies
+        run: npm i
       - name: Lint
-        run: |
-          npm i
-          npm run lint
+        run: npm run lint
       - name: Build
         run: npm run build
       - name: Test
         run: npm run test
 
+  template-ci:
+    name: Chaincode template CI
+    runs-on: ubuntu-22.04
+    needs: [ ci ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+      - name: Install local CLI
+        run: .github/scripts/install-local-cli.sh
+      - name: Create test project
+        run: galachain init ./project-test
+      - name: Install dependencies
+        run: |
+          npm i --prefix ./project-test
+          (cd ./project-test && ../npm-pack-and-replace.sh --skipConfirmation)
+      - name: Lint
+        run: npm run lint --prefix ./project-test
+      - name: Build
+        run: npm run build --prefix ./project-test
+      - name: Test
+        run: npm run test --prefix ./project-test
+
   template-e2e:
-    needs: [ci]
-    name: Test Project Template
+    name: Chaincode template E2E (watch mode)
     runs-on: ubuntu-22.04
+    needs: [ ci ]
     env:
       GALA_CLIENT_DEV_MODE: "true"
     steps:
@@ -55,40 +77,38 @@ jobs:
           docker version
           docker-compose version          
           npm i -g nx
-
-      - name: Build template
-        run: |
-          npm i
-          cd chain-cli
-          ../npm-pack-and-replace.sh --skipConfirmation
-          npm i -g gala-chain-cli-*
-          galachain --help
-          cd ..
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+      - name: Install local CLI
+        run: .github/scripts/install-local-cli.sh
       - name: Create test project
+        run: galachain init ./project-test
+      - name: Install dependencies
         run: |
-          galachain init ./project-test
-          cd ./project-test
-
-          ../npm-pack-and-replace.sh --skipConfirmation
-          cat package.json
-          npm run network:start & # Run network in background and wait for it to start
-          npm run test
-
+          npm i --prefix ./project-test
+          (cd ./project-test && ../npm-pack-and-replace.sh --skipConfirmation)
+      - name: Run network in watch mode and wait for it to start
+        run: |
+          npm run network:start --prefix ./project-test &
           sleep 120
-          npm run test:e2e
-
+      - name: Run E2E tests
+        run: npm run test:e2e --prefix ./project-test
+      - name: Verify chain browser blocks
+        run: |
           MAX_BLOCK_INDEX=$(curl --location 'http://localhost:3010/product-channel/blocks' --header 'Content-Type: application/json' | jq '.info.fromBlock')
           if [ $MAX_BLOCK_INDEX -lt 56]; then
             echo "The number of blocks is less than 56"
             exit 1
           else
             echo "There are at least 56 blocks after the tests ($$MAX_BLOCK_INDEX)"
           fi
-          npm run network:prune
+          npm run network:prune --prefix ./project-test
 
   template-image-check:
-    name: Template Image Check
-    needs: [ci]
+    name: Chaincode template image check
+    needs: [ ci ]
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout
@@ -97,17 +117,17 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: 18
-      - name: Install tools
+      - name: Install local CLI
+        run: .github/scripts/install-local-cli.sh
+      - name: Create test project
+        run: galachain init ./project-test
+      - name: Install dependencies
+        run: |
+          npm i --prefix ./project-test
+          (cd ./project-test && ../npm-pack-and-replace.sh --skipConfirmation)
+      - name: Verify image
         run: |
-          npm i
-          cd chain-cli
-          npm run build
-          npm link ./
-          cd ..
-          galachain init ./project-test
           cd ./project-test
-          ../npm-pack-and-replace.sh --skipConfirmation
-          npm i
           docker build . -t chaincode-test
           run_output=$(docker run --rm chaincode-test 2>&1 || true)
           echo "$run_output"
@@ -121,37 +141,9 @@ jobs:
             exit 1
           fi
 
-  chaincode-template-lint:
-    name: Chaincode Template Lint
-    runs-on: ubuntu-22.04
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 18
-      - name: Install dependencies
-        run: npm install
-      - name: Build CLI and link it
-        run: |
-          cd chain-cli/chaincode-template
-          ../../npm-pack-and-replace.sh --skipConfirmation
-          cd ..
-          npm install
-          npm run build
-          npm link --force
-      - name: Chaincode lint
-        run: |
-          galachain init test-project
-          cd test-project
-          npm install
-          npm run build
-          npm run lint
-
   publish:
     name: Publish Release
-    needs: [template-e2e, template-image-check]
+    needs: [ ci, template-ci, template-e2e, template-image-check ]
     if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v'))
     runs-on: ubuntu-22.04
     steps:

chain-cli/chaincode-template/e2e/gcclient.spec.ts

@@ -46,7 +46,7 @@ describe("Chaincode client (PartnerOrg1)", () => {
     const params = {
       orgMsp: "PartnerOrg1",
       userId: "admin",
-      userPass: "adminpw",
+      userSecret: "adminpw",
       connectionProfilePath: path.resolve(networkRoot(), "connection-profiles/cpp-partner.json")
     };
 
@@ -83,7 +83,7 @@ describe("Chaincode client (CuratorOrg)", () => {
     const params: HFClientConfig = {
       orgMsp: "CuratorOrg",
       userId: "admin",
-      userPass: "adminpw",
+      userSecret: "adminpw",
       connectionProfilePath: path.resolve(networkRoot(), "connection-profiles/cpp-curator.json")
     };
 
@@ -132,7 +132,7 @@ describe.skip("REST API client", () => {
   beforeAll(() => {
     const params: RestApiClientConfig = {
       orgMsp: "CuratorOrg",
-      userKey: "GC_ADMIN_CURATOR",
+      userId: "GC_ADMIN_CURATOR",
       userSecret: "abc",
       apiUrl: "http://localhost:3000/api",
       configPath: path.resolve(__dirname, "api-config.json")

chain-cli/chaincode-template/package.json

@@ -14,10 +14,11 @@
     "format": "prettier --config .prettierrc 'src/**/*.ts' 'e2e/**/*.ts' --write",
     "prepublishOnly": "npm run format && npm run build && npm run lint && npm run test",
     "network:start": "galachain network:up -C=product-channel -t=curator -n=basic-product -d=./ --envConfig=./.dev-env --watch",
+    "network:up": "galachain network:up -C=product-channel -t=curator -n=basic-product -d=./ --envConfig=./.dev-env",
     "network:prune": "galachain network:prune",
     "network:recreate": "npm run network:prune && rm -rf ./test-network && npm run network:start",
     "test": "jest",
-    "test:e2e": "jest --config=e2e/jest.config.js",
+    "test:e2e": "jest --config=e2e/jest.config.js --runInBand",
     "update-snapshot": "jest --updateSnapshot"
   },
   "dependencies": {

chain-cli/chaincode-template/rest-api-samples.sh

@@ -0,0 +1,56 @@
+#!/usr/bin/env bash
+
+#
+# Copyright (c) Gala Games Inc. All rights reserved.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+set -eu
+
+# Enroll a user (default admin credentials for local env)
+enroll_response="$(
+  curl --request POST \
+    --url http://localhost:8801/user/enroll \
+    --data '{"id": "admin", "secret": "adminpw"}'
+)"
+echo "Enroll response: $enroll_response"
+
+token="$(echo "$enroll_response" | jq -r '.token')"
+
+# Call chaincode (GetChaincodeVersion - the simplest call)
+version_response="$(
+  curl --request POST \
+    --url http://localhost:8801/invoke/product-channel/basic-product \
+    --header "Authorization: Bearer $token" \
+    --data '{"method": "PublicKeyContract:GetChaincodeVersion", "args": []}'
+)"
+echo "Version response: $version_response"
+
+
+# Call chaincode (GetMyProfile - requires signing of DTO with user's private key
+get_my_profile_dto="$(galachain dto-sign test-network/dev-admin-key/dev-admin.priv.hex.txt '{}')"
+echo "get_my_profile_dto: $get_my_profile_dto"
+get_my_profile_payload="$(
+  echo '{}' |
+   jq '.method="PublicKeyContract:GetMyProfile"' |
+   jq ".args=[\"${get_my_profile_dto//\"/\\\"}\"]"
+)"
+
+profile_response="$(
+  curl --request POST \
+    --url http://localhost:8801/invoke/product-channel/basic-product \
+    --header "Authorization: Bearer $token" \
+    --header 'Content-Type: application/json' \
+    --data "$get_my_profile_payload"
+)"
+echo "Profile response: $profile_response"

chain-cli/network/api-config.json

@@ -0,0 +1,26 @@
+{
+  "channels": [
+    {
+      "pathFragment": "product",
+      "channelName": "product-channel",
+      "asLocalHost": true,
+      "contracts": [
+        {
+          "pathFragment": "apple",
+          "chaincodeName": "basic-product",
+          "contractName": "AppleContract"
+        },
+        {
+          "pathFragment": "public-key-contract",
+          "chaincodeName": "basic-product",
+          "contractName": "PublicKeyContract"
+        },
+        {
+          "pathFragment": "token-contract",
+          "chaincodeName": "basic-product",
+          "contractName": "GalaChainToken"
+        }
+      ]
+    }
+  ]
+}

chain-cli/network/fablo-config-default.json

@@ -30,6 +30,9 @@
       },
       "peer": {
         "instances": 1
+      },
+      "tools": {
+        "fabloRest": true
       }
     },
     {
@@ -40,13 +43,19 @@
       },
       "peer": {
         "instances": 1
+      },
+      "tools": {
+        "fabloRest": true
       }
     },
     {
       "organization": {
         "name": "UsersOrg1",
         "mspName": "UsersOrg1",
         "domain": "users1.local"
+      },
+      "tools": {
+        "fabloRest": true
       }
     }
   ],

chain-client/src/gcclient.spec.ts

@@ -35,7 +35,7 @@ describe("forConnectionProfile", () => {
     const org = {
       orgMsp: "CuratorOrg",
       userId: "admin",
-      userPass: "adminpw",
+      userSecret: "adminpw",
       connectionProfilePath: "some/path"
     };
 
@@ -51,7 +51,7 @@ describe("forConnectionProfile", () => {
     const org = {
       orgMsp: "MissingOrg",
       userId: "admin",
-      userPass: "adminpw",
+      userSecret: "adminpw",
       connectionProfilePath: "some/path"
     };
 
@@ -79,7 +79,7 @@ describe("forApiConfig", () => {
     const api = {
       orgMsp: "CuratorOrg",
       apiUrl: "http://localhost:3000",
-      userKey: "GC_ADMIN_KEY",
+      userId: "GC_ADMIN_ID",
       userSecret: "GC_ADMIN_SECRET",
       configPath: "some/path"
     };