feat(copm): add fabric COPM implementation #3546

jenniferlianne · 2024-09-18T12:29:11Z

Primary Change:

add connectRPC cactus plugin for copm primitives

Secondary Changes:

add common COPM prototypes
add common weaver protos-js directory to enable building under ci.yaml, which requires all local
dependencies to be present at build time
remove incorrect 'main' declaration in protos-js package file
add separate tsconfig file to /weaver/sdks/fabric/interoperation-node-sdk to
allow it to be built by ci.yaml
update weaver fabric network makefile 'clean' target to continue if some target files
were not generated by the make process

Signed-off-by: Jennifer Bell [email protected]

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.

weaver/sdks/fabric/interoperation-node-sdk/.gitignore

sandeepnRES · 2024-09-19T06:49:35Z

packages/cacti-copm-core/src/main/proto/generated/openapi/models/asset_account_v1_pb.proto

+
+message AssetAccountV1PB {
+
+  string network = 232872497;


Sorry I don't have context about this structure, but why are these numbers so high?
Usually proto structures start with 1, 2 and so on...

Same comment for all the below proto files.

The pb files are generated from openapi, following cactus convention. The openapi desc is here: https://jenniferlianne.github.io/cacti/references/openapi/cacti-copm-core_openapi/,

sandeepnRES · 2024-09-19T06:59:02Z

packages/cacti-copm-core/src/main/proto/generated/openapi/models/view_address_v1_pb.proto

+
+message ViewAddressV1PB {
+
+  string contract_id = 512823451;


We may need more fields to this, but I'm assuming, we will keep updating this in future with implementations of these services?

Yes. For now I want to see what we can get away with. In Corda, flowpath (for instance) is very similar to a contract specification.

sandeepnRES · 2024-09-19T06:59:48Z

packages/cacti-copm-core/src/main/proto/generated/openapi/models/view_v1_pb.proto

+
+import "models/view_address_v1_pb.proto";
+
+message ViewV1PB {


View contains response to the remote query right?

No, this is part of the inbound message for the verifyState command. You can see the messages here for more context: https://jenniferlianne.github.io/cacti/references/openapi/cacti-copm-core_openapi/

petermetz

@jenniferlianne Very high quality PR overall, thank you very much for the contribution! I left a few comments with my usual nit picks but it's definitely looking great already! Congratulations!

packages/cacti-copm-core/package.json

packages/cacti-copm-core/openapitools.json

...ages/cacti-plugin-copm-fabric/src/test/typescript/integration/test-copm-pledge-claim.test.ts

sandeepnRES · 2024-09-25T06:59:04Z

packages/cacti-copm-core/src/main/json/openapi.json

+      "post": {
+        "x-hyperledger-cacti": {
+          "http": {
+            "path": "/api/v1/plugins/@hyperledger/cacti-plugin-copm/prove-state",


This path is different from "/api/v1/plugins/@hyperledger/cacti-plugin-copm/verify-state"

Endpoint has been updated to reflect naming recently discussed.

sandeepnRES · 2024-09-25T07:06:24Z

packages/cacti-copm-core/src/main/json/openapi.json

+            "verbLowerCase": "post"
+          }
+        },
+        "operationId": "provestateV1",


Lets use similar name as API names and IDs, so to be consistent with other API names and IDs

sandeepnRES · 2024-09-25T07:09:17Z

packages/cacti-copm-core/src/main/proto/generated/openapi/services/default_service.proto

+
+  rpc PledgeAssetV1 (PledgeAssetV1Request) returns (PledgeAssetV1200ResponsePB);
+
+  rpc ProvestateV1 (ProvestateV1Request) returns (google.protobuf.Empty);


API Name isn't updated here

sandeepnRES · 2024-09-25T07:09:25Z

packages/cacti-copm-core/src/main/proto/generated/openapi/services/default_service.proto

+
+}
+
+message ProvestateV1Request {


API Name isn't updated here

sandeepnRES · 2024-09-25T07:10:31Z

packages/cacti-plugin-copm-fabric/src/main/typescript/endpoints/prove-state-impl-v1.ts

+} from "@hyperledger/cacti-copm-core";
+import { Logger } from "@hyperledger/cactus-common";
+
+export async function proveStateV1Impl(


Here also function name I think should match with API name?

sandeepnRES · 2024-09-25T07:10:59Z

packages/cacti-plugin-copm-fabric/src/main/typescript/service-implementation.ts

+    }
+  }
+
+  public async provestateV1(req: ProvestateV1Request): Promise<void> {


Same comment here too

petermetz

@jenniferlianne LGTM, thank you very much!

VRamakrishna · 2024-10-09T07:43:38Z

@jenniferlianne Can you also check the documentation (with names updated as per your discussion with @sandeepnRES) from https://jenniferlianne.github.io/cacti/references/openapi/cacti-copm-core_openapi/ into this PR? That way, when we add code to the main repo, there is (at least some) documentation explaining what it does.

(BTW....sorry for my late comments. I've still not recovered from my illness, and am taking it slow.)

jenniferlianne · 2024-10-09T15:17:11Z

@jenniferlianne Can you also check the documentation (with names updated as per your discussion with @sandeepnRES) from https://jenniferlianne.github.io/cacti/references/openapi/cacti-copm-core_openapi/ into this PR? That way, when we add code to the main repo, there is (at least some) documentation explaining what it does.

(BTW....sorry for my late comments. I've still not recovered from my illness, and am taking it slow.)

The openapi documentation should be generated under this link https://hyperledger-cacti.github.io/cacti/references/openapi/ when the code is merged. An updated preview (with the changes discussed) is here: https://jenniferlianne.github.io/cacti/references/openapi/cacti-copm-core_openapi/

Primary Change: - add connectRPC cactus plugin for copm primitives Secondary Changes: - add common COPM prototypes - add common weaver protos-js directory to enable building under ci.yaml, which requires all local dependencies to be present at build time - remove incorrect 'main' declaration in protos-js package file - add separate tsconfig file to /weaver/sdks/fabric/interoperation-node-sdk to allow it to be built by ci.yaml - update weaver fabric network makefile 'clean' target to continue if some target files were not generated by the make process Signed-off-by: Jennifer Bell <[email protected]>

jenniferlianne requested review from petermetz, takeutak, izuru0, jagpreetsinghsasan, VRamakrishna, sandeepnRES and outSH as code owners September 18, 2024 12:29

jenniferlianne force-pushed the copm_draft branch from 2342278 to a8ae134 Compare September 18, 2024 12:34

sandeepnRES reviewed Sep 19, 2024

View reviewed changes

weaver/sdks/fabric/interoperation-node-sdk/.gitignore Outdated Show resolved Hide resolved

sandeepnRES reviewed Sep 19, 2024

View reviewed changes

petermetz requested changes Sep 19, 2024

View reviewed changes

jenniferlianne force-pushed the copm_draft branch 2 times, most recently from c50865d to 48b4e82 Compare September 19, 2024 21:25

jenniferlianne requested review from petermetz and sandeepnRES September 23, 2024 12:05

sandeepnRES reviewed Sep 25, 2024

View reviewed changes

jenniferlianne force-pushed the copm_draft branch from 48b4e82 to ab02c7f Compare September 27, 2024 14:42

jenniferlianne requested a review from sandeepnRES September 27, 2024 15:57

petermetz mentioned this pull request Sep 28, 2024

test(plugin-copm-fabric): automate infrastructure setup: copm-pledge-claim #3556

Open

petermetz approved these changes Sep 28, 2024

View reviewed changes

jenniferlianne force-pushed the copm_draft branch from ab02c7f to c3daece Compare October 10, 2024 17:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(copm): add fabric COPM implementation #3546

feat(copm): add fabric COPM implementation #3546

jenniferlianne commented Sep 18, 2024

sandeepnRES Sep 19, 2024 •

edited

Loading

jenniferlianne Sep 19, 2024

sandeepnRES Sep 19, 2024

jenniferlianne Sep 19, 2024

sandeepnRES Sep 19, 2024

jenniferlianne Sep 19, 2024 •

edited

Loading

petermetz left a comment

sandeepnRES Sep 25, 2024

jenniferlianne Sep 27, 2024

sandeepnRES Sep 25, 2024

jenniferlianne Sep 27, 2024

sandeepnRES Sep 25, 2024 •

edited

Loading

sandeepnRES Sep 25, 2024 •

edited

Loading

sandeepnRES Sep 25, 2024

sandeepnRES Sep 25, 2024

petermetz left a comment

VRamakrishna commented Oct 9, 2024 •

edited

Loading

jenniferlianne commented Oct 9, 2024


		rpc PledgeAssetV1 (PledgeAssetV1Request) returns (PledgeAssetV1200ResponsePB);

		rpc ProvestateV1 (ProvestateV1Request) returns (google.protobuf.Empty);

feat(copm): add fabric COPM implementation #3546

Are you sure you want to change the base?

feat(copm): add fabric COPM implementation #3546

Conversation

jenniferlianne commented Sep 18, 2024

sandeepnRES Sep 19, 2024 • edited Loading

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

jenniferlianne Sep 19, 2024 • edited Loading

Choose a reason for hiding this comment

petermetz 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

sandeepnRES Sep 25, 2024 • edited Loading

Choose a reason for hiding this comment

sandeepnRES Sep 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

petermetz left a comment

Choose a reason for hiding this comment

VRamakrishna commented Oct 9, 2024 • edited Loading

jenniferlianne commented Oct 9, 2024

sandeepnRES Sep 19, 2024 •

edited

Loading

jenniferlianne Sep 19, 2024 •

edited

Loading

sandeepnRES Sep 25, 2024 •

edited

Loading

sandeepnRES Sep 25, 2024 •

edited

Loading

VRamakrishna commented Oct 9, 2024 •

edited

Loading