feat(daml): creation of connector class #3615

raynatopedrajeta · 2024-11-04T08:37:12Z

Commit to be reviewed

feat(daml): creation of connector class

Primary Changes
---------------
1. Create a DAML connector class
2. Created OpenAPI endpoints of DAML
3. Created DAML web services for create, exercise and query contracts
4. Create simple IOU Transaction using DAML

Fixes #3489

Pull Request Requirements

Rebased onto upstream/main branch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.
Have git sign off at the end of commit message to avoid being marked red. You can add -s flag when using git commit command. You may refer to this link for more information.
Follow the Commit Linting specification. You may refer to this link for more information.

Character Limit

Pull Request Title and Commit Subject must not exceed 72 characters (including spaces and special characters).
Commit Message per line must not exceed 80 characters (including spaces and special characters).

A Must Read for Beginners
For rebasing and squashing, here's a must read guide for beginners.

jagpreetsinghsasan

Please incorporate these changes and then re-request for review (Make sure to squash the commits into a single commit)

jagpreetsinghsasan · 2024-11-04T08:48:51Z

packages/cactus-plugin-ledger-connector-daml/package.json

+    "generate-sdk:go": "openapi-generator-cli generate -i ./src/main/json/openapi.json -g go -o ./src/main/go/generated/openapi/go-client/ --git-user-id hyperledger --git-repo-id $(echo $npm_package_name | replace @hyperledger/ \"\" -z)/src/main/go/generated/openapi/go-client --package-name $(echo $npm_package_name | replace @hyperledger/ \"\" -z)  --reserved-words-mappings protected=protected --ignore-file-override ../../openapi-generator-ignore",
+    "generate-sdk:kotlin": "openapi-generator-cli generate -i ./src/main/json/openapi.json -g kotlin -o ./src/main/kotlin/generated/openapi/kotlin-client/ --reserved-words-mappings protected=protected --ignore-file-override ../../openapi-generator-ignore",
+    "generate-sdk:typescript-axios": "openapi-generator-cli generate -i ./src/main/json/openapi.json -g typescript-axios -o ./src/main/typescript/generated/openapi/typescript-axios/ --ignore-file-override ../../openapi-generator-ignore",
+    "generate-server": "yarn run --top-level openapi-generator-cli generate -i ./src/main/json/openapi.json -g kotlin-spring -o ./src/main-server/kotlin/gen/kotlin-spring/ -c ./src/main-server/openapi-generator-config.yaml --ignore-file-override ../../openapi-generator-ignore",


We do not need this. Please remove this (might got have remained when you copied this from corda connector)

jagpreetsinghsasan · 2024-11-04T08:50:47Z

packages/cactus-plugin-ledger-connector-daml/src/main/json/openapi.tpl.json

+          }
+        },
+        "operationId": "exerciseChoice",
+        "summary": "This method creates a simple iou countract",


Please update the summary and the following description of this path

jagpreetsinghsasan · 2024-11-04T08:51:44Z

packages/cactus-plugin-ledger-connector-daml/src/main/json/openapi.tpl.json

+          }
+        },
+        "operationId": "queryRawContract",
+        "summary": "This method queries DAML contracts",


Please update this, along with the description and mention why is it different from the above query-iou-endpoint method

jagpreetsinghsasan · 2024-11-04T08:52:39Z

packages/cactus-plugin-ledger-connector-daml/src/main/json/openapi.tpl.json

+          }
+        },
+        "operationId": "getPartiesInvolved",
+        "summary": "This method queries DAML contracts",


Please update this to match the referenced path

jagpreetsinghsasan · 2024-11-04T08:53:18Z

...ages/cactus-plugin-ledger-connector-daml/src/main/typescript/plugin-ledger-connector-daml.ts

+import type { Server as SecureServer } from "https";
+import type { Config as SshConfig } from "node-ssh";
+import type { Express } from "express";
+// import urlcat from "urlcat";


Please remove all instances of uncommented (unused) code.

jagpreetsinghsasan · 2024-11-04T09:08:43Z

.../cactus-plugin-ledger-connector-daml/src/main/typescript/web-services/create-iou-endpoint.ts

+    try {
+      if (this.apiUrl === undefined)
+        throw new InternalServerError("apiUrl option is necessary");
+      const body = await this.options.connector.createContract(req.body, "testdata123");


Why are we passing testdata123 here? Should this variable be passed from the test case itself if required? (And thus be a part of req.body?)

jagpreetsinghsasan · 2024-11-04T09:09:23Z

...actus-plugin-ledger-connector-daml/src/main/typescript/web-services/exercise-iou-endpoint.ts

+    try {
+      if (this.apiUrl === undefined)
+        throw new InternalServerError("apiUrl option is necessary");
+      const body = await this.options.connector.exerciseContract(req.body, "testdata123");


Why are we passing testdata123 here? Should this variable be passed from the test case itself if required? (And thus be a part of req.body?)

jagpreetsinghsasan · 2024-11-04T09:12:11Z

...ctus-plugin-ledger-connector-daml/src/main/typescript/web-services/query-raw-iou-endpoint.ts

+  }
+
+  async handleRequest(req: Request, res: Response): Promise<void> {
+    const fnTag = "QueryIOURawEndpointRequest#handleRequest()";


Please update this to QueryRawIOUEndpoint... to match the api endpoint

jagpreetsinghsasan · 2024-11-04T09:16:19Z

...us-plugin-ledger-connector-daml/src/test/typescript/integration/daml-get-transaction.test.ts

+    }
+    const createIou = await apiClient.createIou(iouBody)
+    console.log("STEP 1. Create IOU as Alice result:")
+    console.log(createIou)


Use LoggerProvider class from cactus-common instead

jagpreetsinghsasan · 2024-11-04T09:18:03Z

...us-plugin-ledger-connector-daml/src/test/typescript/integration/daml-get-transaction.test.ts

+    responseForIOUResult = JSON.parse(stringifyIOUPayload)
+
+
+    console.log("STEP 4. Check if transfer is successful by querying as BOB")


Please rephrase all these statements (along with using LoggerProvider class). Right now it looks like this is the line from where step4 execution starts.

petermetz · 2024-11-05T22:20:43Z

...ages/cactus-plugin-ledger-connector-daml/src/main/typescript/plugin-ledger-connector-daml.ts

+  }
+
+  public async transact(): Promise<any> {
+    return null as any;


@jagpreetsinghsasan I agree, this looks closer to something application specific instead of belong in the generic framework code. I'm not an expert on DAML/Canton, but maybe we are looking for something like this instead?
https://docs.daml.com/app-dev/grpc/proto-docs.html#submitandwait-method-version-com-daml-ledger-api-v1

raynatopedrajeta · 2024-11-14T08:02:49Z

Hello @petermetz ,

May I request for you to update the docker image of this task?:
imageVersion: "2024-09-08T07-40-07-dev-2cc217b7a",
imageName: "ghcr.io/hyperledger/cacti-daml-all-in-one",

Cheers!

Rayn

petermetz

@raynatopedrajeta Please don't forget to fix the custom-checks that are failing:

[tools/check-missing-node-deps.ts] ERROR - MISSING production dependency node-fetch from /********/packages/cactus-plugin-ledger-connector-daml/package.json. Found usage in 
        /********/packages/cactus-plugin-ledger-connector-daml/src/main/typescript/plugin-ledger-connector-daml.ts
[tools/check-missing-node-deps.ts] ERROR - MISSING production dependency express from /********/packages/cactus-plugin-ledger-connector-daml/package.json. Found usage in 
        /********/packages/cactus-plugin-ledger-connector-daml/src/main/typescript/web-services/create-iou-endpoint.ts
        /********/packages/cactus-plugin-ledger-connector-daml/src/main/typescript/web-services/exercise-iou-endpoint.ts
        /********/packages/cactus-plugin-ledger-connector-daml/src/main/typescript/web-services/get-parties-involved-endpoint.ts
        /********/packages/cactus-plugin-ledger-connector-daml/src/main/typescript/web-services/query-iou-endpoint.ts
        /********/packages/cactus-plugin-ledger-connector-daml/src/main/typescript/web-services/query-raw-iou-endpoint.ts
"node-fetch" is a missing dependency from /********/packages/cactus-plugin-ledger-connector-daml/package.json with the following files using them:
        /********/packages/cactus-plugin-ledger-connector-daml/src/main/typescript/plugin-ledger-connector-daml.ts

Primary Changes --------------- 1. Create a DAML connector class 2. Created OpenAPI endpoints of DAML 3. Created DAML web services for create, exercise and query contracts 4. Create simple IOU Transaction using DAML Fixes hyperledger-cacti#3489 Co-authored-by: Peter Somogyvari <peter.somogyvari@accenture.com> Signed-off-by: raynato.c.pedrajeta <raynato.c.pedrajeta@accenture.com> Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>

petermetz · 2024-11-14T17:48:58Z

Hello @petermetz ,

May I request for you to update the docker image of this task?: imageVersion: "2024-09-08T07-40-07-dev-2cc217b7a", imageName: "ghcr.io/hyperledger/cacti-daml-all-in-one",

Cheers!

Rayn

@raynatopedrajeta I tried to publish the image but it fails to upload because one of the layers is 1.5GB and the upload keeps retrying to infinity.

Could you please reduce the layer size by splitting the commands in the dockerfile? I'm pretty sure it's this one:

# Download and install DAML SDK 2.9.3
RUN curl -L https://github.com/digital-asset/daml/releases/download/v2.9.3/daml-sdk-2.9.3-linux.tar.gz | tar -xz -C /opt && \
    cd /opt/sdk-2.9.3 && \
   ./install.sh && \
   rm -rf /opt/sdk-2.9.3/

petermetz · 2024-11-14T17:49:58Z

@raynatopedrajeta FYI: I pushed a small change to modify the readme of the DAML aio image so that it's easier to build the image in the future for publishing:

## Build an image locally

To build the daml-all-in-one image locally, use:
```sh
DOCKER_BUILDKIT=1 docker build \
  --file ./tools/docker/daml-all-in-one/Dockerfile \
  ./tools/docker/daml-all-in-one/ \
   --tag daio \
   --tag daml-all-in-one \
   --tag ghcr.io/hyperledger/daml-all-in-one:$(date +"%Y-%m-%dT%H-%M-%S" --utc)-dev-$(git rev-parse --short HEAD)


(Just saying this so you don't accidentally delete that change when you are resolving potential conflicts)

raynatopedrajeta requested review from petermetz, izuru0, jagpreetsinghsasan, VRamakrishna, sandeepnRES and outSH as code owners November 4, 2024 08:37

raynatopedrajeta force-pushed the raynatopedrajeta/issue3489 branch from 886560c to cd091b0 Compare November 4, 2024 08:39

jagpreetsinghsasan requested changes Nov 4, 2024

View reviewed changes

raynatopedrajeta force-pushed the raynatopedrajeta/issue3489 branch from cd091b0 to 20cc75d Compare November 5, 2024 07:04

petermetz requested changes Nov 5, 2024

View reviewed changes

raynatopedrajeta force-pushed the raynatopedrajeta/issue3489 branch 3 times, most recently from 1a99027 to 5b9e094 Compare November 14, 2024 07:45

raynatopedrajeta force-pushed the raynatopedrajeta/issue3489 branch from 5b9e094 to 0e0ae2e Compare November 14, 2024 08:11

raynatopedrajeta requested a review from jagpreetsinghsasan November 14, 2024 08:12

petermetz requested changes Nov 14, 2024

View reviewed changes

petermetz force-pushed the raynatopedrajeta/issue3489 branch from 0e0ae2e to 67919b6 Compare November 14, 2024 17:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(daml): creation of connector class #3615

feat(daml): creation of connector class #3615

raynatopedrajeta commented Nov 4, 2024

jagpreetsinghsasan left a comment

jagpreetsinghsasan Nov 4, 2024

jagpreetsinghsasan Nov 4, 2024

jagpreetsinghsasan Nov 4, 2024

jagpreetsinghsasan Nov 4, 2024

jagpreetsinghsasan Nov 4, 2024

jagpreetsinghsasan Nov 4, 2024

jagpreetsinghsasan Nov 4, 2024

jagpreetsinghsasan Nov 4, 2024

jagpreetsinghsasan Nov 4, 2024

jagpreetsinghsasan Nov 4, 2024

petermetz Nov 5, 2024

raynatopedrajeta commented Nov 14, 2024

petermetz left a comment

petermetz commented Nov 14, 2024

petermetz commented Nov 14, 2024

		responseForIOUResult = JSON.parse(stringifyIOUPayload)


		console.log("STEP 4. Check if transfer is successful by querying as BOB")

feat(daml): creation of connector class #3615

Are you sure you want to change the base?

feat(daml): creation of connector class #3615

Conversation

raynatopedrajeta commented Nov 4, 2024

Commit to be reviewed

jagpreetsinghsasan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raynatopedrajeta commented Nov 14, 2024

petermetz left a comment

Choose a reason for hiding this comment

petermetz commented Nov 14, 2024

petermetz commented Nov 14, 2024