feat(connector-iroha2): add support for Iroha V2 #2153

outSH · 2022-08-31T14:59:49Z

Add new Iroha V2 cactus connector.
Two OpenAPI endpoints are implemented: transact and query. Both endpoints support
critical subset of instructions and queries supported by the upstream javascript iroha sdk.
One SocketIO endpoint can be used to monitor new blocks from the ledger.
New connector can be used through a verifier-client interface.
All added functions are tested in functional test suites and documented.
Added execution of Iroha2 tests to the CI.

Additional notes:

Connector doesn't work well with cactus module system, the issue has been reported and described
in README. PR is not merge-ready until this is fixed (the CI should fail now).
Iroha V2 javascript packages are not available on official npm yet, had to include .npmrc with
private npm address. I'm not sure if there's ETA of delivering these through NPM, so it might be
necessary to commit it after all.

Closes #2138
Depends on #2140

Signed-off-by: Michal Bajer [email protected]

outSH · 2022-08-31T15:02:32Z

@petermetz @izuru0 This is almost ready, I'm only waiting for fixes in upstream javascript SDK. Please start the review in the meantime

...dger-connector-iroha2/src/test/typescript/integration/iroha-instructions-and-queries.test.ts

outSH · 2022-09-27T18:25:20Z

@petermetz @izuru0 After fixes from Iroha team this is ready for merge. Please review, I'll introduce future upgrades in separate PRs

izuru0

LGTM

@petermetz can you review thanks

- Add new endpoint `generate-transaction`, to create unsigned transactions that can be signed on the client side. - Add a function to iroha2-connector package to help signing iroha transactions on the client (BLP) side. - Extend transact endpoint to accept signed transaction as an argument as well. - Add new test suite to check features implemented in this PR (i.e. signing on the client side). Relates to hyperledger-cacti#2077 Depends on hyperledger-cacti#2153 Signed-off-by: Michal Bajer <[email protected]>

.../cactus-plugin-ledger-connector-iroha2/src/main/typescript/plugin-ledger-connector-iroha2.ts

...ges/cactus-plugin-ledger-connector-iroha2/src/main/typescript/web-services/query-endpoint.ts

.../cactus-plugin-ledger-connector-iroha2/src/main/typescript/web-services/transact-endpoint.ts

...dger-connector-iroha2/src/test/typescript/integration/iroha-instructions-and-queries.test.ts

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

petermetz · 2022-11-01T23:01:33Z

Suggested edit:

diff --git a/packages/cactus-plugin-ledger-connector-iroha2/openapitools.json b/packages/cactus-plugin-ledger-connector-iroha2/openapitools.json
index 29f5d069..601ac1d6 100644
--- a/packages/cactus-plugin-ledger-connector-iroha2/openapitools.json
+++ b/packages/cactus-plugin-ledger-connector-iroha2/openapitools.json
@@ -2,6 +2,6 @@
   "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
   "spaces": 2,
   "generator-cli": {
-    "version": "5.2.0"
+    "version": "5.2.1"
   }
 }

petermetz · 2022-11-01T23:01:56Z

Suggested edit:

diff --git a/packages/cactus-plugin-ledger-connector-iroha2/package.json b/packages/cactus-plugin-ledger-connector-iroha2/package.json
index aab130a5..83e9a8d8 100644
--- a/packages/cactus-plugin-ledger-connector-iroha2/package.json
+++ b/packages/cactus-plugin-ledger-connector-iroha2/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@hyperledger/cactus-plugin-ledger-connector-iroha2",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Allows Cactus nodes to connect to an Iroha V2 ledger.",
   "keywords": [
     "Hyperledger",

petermetz · 2022-11-01T23:12:37Z

Suggested edit:

diff --git a/packages/cactus-plugin-ledger-connector-iroha2/src/test/typescript/integration/iroha-instructions-and-queries.test.ts b/packages/cactus-plugin-ledger-connector-iroha2/src/test/typescript/integration/iroha2-instructions-and-queries.test.ts
similarity index 99%
rename from packages/cactus-plugin-ledger-connector-iroha2/src/test/typescript/integration/iroha-instructions-and-queries.test.ts
rename to packages/cactus-plugin-ledger-connector-iroha2/src/test/typescript/integration/iroha2-instructions-and-queries.test.ts
index befa9a8e..cbe51a48 100644
--- a/packages/cactus-plugin-ledger-connector-iroha2/src/test/typescript/integration/iroha-instructions-and-queries.test.ts
+++ b/packages/cactus-plugin-ledger-connector-iroha2/src/test/typescript/integration/iroha2-instructions-and-queries.test.ts
@@ -1,5 +1,5 @@
 /**
- * Tests for executing Iroha instructions and queries through the cactus connector.
+ * Tests for executing Iroha 2 instructions and queries through the cactus connector.
  */
 
 //////////////////////////////////

petermetz · 2022-11-01T23:18:49Z

@outSH Update about the 1.1.0 release packages being issued: we no longer have permission to directly publish to npm ourselves so it has to go through the github actions which I have a PR open for, but we'll have to test it to see if it even works and because we don't have the npm token of our own, this can only be tested "in production" as in the PR of mine that is adding the auto-publish action has to be merged and then we need to re-tag the release and see if it triggers and if the publishing process succeed or not (and if it does not then the whole PR+review+merge all over again until it gets fixed).

Kinda off-topic but I wanted to keep you in the loop about what's taking so long.

petermetz

@outSH Please rebase onto upstream/main to disappear the parent PR (the one that this one used to depend on) from the commit log of this PR

github-actions · 2022-11-14T08:40:51Z

This PR/issue depends on:

~~feat(iroha2-ledger): add Iroha V2 test ledger image and setup class #2140~~
By Dependent Issues (🤖). Happy coding!

petermetz · 2022-11-22T23:41:07Z

@outSH FYI the v1.1.2 package artifacts are now published onto npm and can be used.

outSH · 2022-11-25T13:05:59Z

@petermetz

I've rebased with current main
Changed package version
Done changes you've recommended in review (mostly to make it more distinct that this is for Iroha V2)

I've also merged all the follow-up PR for this connector to avoid juggling back and forth fixes and make it more manageable in single PR. All PR I've merged were already approved so I hope it won't be a problem. The PR list:

I'll close them if you agree to merge it as one.
Please do a final review and let me know if there's anything more you'd like to improve.

petermetz

@outSH

I'll close them if you agree to merge it as one.

Works for me. Ideally each PR would be as small as possible as a self contained change by itself, but in this case I think it's fine to combine them in the interest of moving things along a bit faster (I know it doesn't look like it but I try to be cognizant of productivity and velocity with my change requests haha)

Please do a final review and let me know if there's anything more you'd like to improve.

I left a little essay about the .npmrc thing in the comments above, please take a look at that, but other than that it's LGTM

.gitignore

petermetz

@outSH LGTM, thank you!

petermetz

@outSH Sorry, last one: the tests need to pass too. (I retried them just now and they failed twice in a row so I'm thinking it's probably not a flake either).

I can't configure GitHub (yet) to require the passing of the tests for the iroha2 connector (because I can only pick checks to be mandatory that are already on the main branch) so I'll set that up once this is merged and in the meantime I'll just prevent accidental merging with the change request thingy. TLDR: Please fix the tests and then pass it back.

outSH · 2022-12-20T16:02:10Z

Sorry, last one: the tests need to pass too. (I retried them just now and they failed twice in a row so I'm thinking it's probably not a flake either).

@petermetz Yeah, there was a bug in Iroha2 test ledger healthcheck, sorry for that. Should be all good now. Please upload tools/docker/iroha2-all-in-one image from this PR to hyperledger ghcr, I'll replace the links in the test and we should be good to go.

petermetz

@outSH Got it, thanks for the fix! I built and pushed the new image just now as: ghcr.io/hyperledger/cactus-iroha2-all-in-one:2022-12-22-6c715bdb please re-test with the new image and then pass it back for review!

- Add new Iroha V2 cactus connector. - Add endpoints `transact` and `query`. Both endpoints support critical subset of instructions and queries supported by the upstream javascript iroha sdk. Transaction can be awaited or can return immediately. - Add new endpoint `generate-transaction`, to create unsigned transactions that can be signed on the client side. - Add a function to iroha2-connector package to help signing iroha transactions on the client (BLP) side. - One SocketIO endpoint can be used to monitor new blocks from the ledger. - Add new helper method for signing query payload on the client side. - New connector can be used through a verifier-client interface. - All added functions are tested in functional test suites and documented. - Add test for complex scenario that involves creating new account and asset, and then transfering assets between two accounts. - Add test for parsing retrieved block data to find specific transaction hashes. - Added execution of Iroha2 tests to the CI. Additional notes: - Iroha V2 javascript packages are not available on official npm yet, had to include `.npmrc` with private npm address. I'm not sure if there's ETA of delivering these through NPM, so it might be necessary to commit it after all. Closes hyperledger-cacti#2138 Depends on hyperledger-cacti#2140 Signed-off-by: Michal Bajer <[email protected]>

outSH · 2022-12-23T09:54:47Z

Done

petermetz

@outSH Cheers, LGTM!

github-actions bot added the dependent label Aug 31, 2022

github-advanced-security bot found potential problems Aug 31, 2022

View reviewed changes

outSH force-pushed the iroha2_connector_pr branch 2 times, most recently from 26938d1 to 9330dca Compare September 27, 2022 15:23

outSH marked this pull request as ready for review September 27, 2022 18:24

outSH requested review from petermetz, takeutak, izuru0, jagpreetsinghsasan and sandeepnRES as code owners September 27, 2022 18:24

izuru0 approved these changes Sep 30, 2022

View reviewed changes

outSH force-pushed the iroha2_connector_pr branch from 9330dca to 19f28b6 Compare October 3, 2022 14:51

outSH mentioned this pull request Oct 4, 2022

feat(connector-iroha2): sending transactions signed on the client-side #2168

Closed

petermetz requested changes Oct 18, 2022

View reviewed changes

outSH force-pushed the iroha2_connector_pr branch from 19f28b6 to 1247411 Compare October 19, 2022 09:52

petermetz requested changes Nov 1, 2022

View reviewed changes

github-actions bot removed the dependent label Nov 14, 2022

outSH force-pushed the iroha2_connector_pr branch from 1247411 to d8d6600 Compare November 25, 2022 13:00

outSH removed the request for review from sandeepnRES November 25, 2022 13:06

outSH requested review from petermetz and removed request for jagpreetsinghsasan and takeutak November 25, 2022 13:06

petermetz requested changes Nov 28, 2022

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

outSH force-pushed the iroha2_connector_pr branch 2 times, most recently from e38acaa to 6bedf9f Compare November 29, 2022 15:56

outSH requested a review from petermetz November 29, 2022 15:57

petermetz approved these changes Nov 29, 2022

View reviewed changes

petermetz requested changes Nov 29, 2022

View reviewed changes

outSH force-pushed the iroha2_connector_pr branch 2 times, most recently from 9bc9a86 to 6c715bd Compare December 20, 2022 15:35

outSH requested a review from petermetz December 20, 2022 19:26

petermetz requested changes Dec 22, 2022

View reviewed changes

outSH force-pushed the iroha2_connector_pr branch from 6c715bd to 9dd6c71 Compare December 23, 2022 09:46

outSH force-pushed the iroha2_connector_pr branch from 9dd6c71 to db78969 Compare December 23, 2022 09:54

outSH requested a review from petermetz December 23, 2022 16:03

petermetz approved these changes Dec 24, 2022

View reviewed changes

petermetz merged commit db78969 into hyperledger-cacti:main Dec 24, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(connector-iroha2): add support for Iroha V2 #2153

feat(connector-iroha2): add support for Iroha V2 #2153

outSH commented Aug 31, 2022

outSH commented Aug 31, 2022

outSH commented Sep 27, 2022

izuru0 left a comment

petermetz commented Nov 1, 2022

petermetz commented Nov 1, 2022

petermetz commented Nov 1, 2022

petermetz commented Nov 1, 2022

petermetz left a comment

github-actions bot commented Nov 14, 2022

petermetz commented Nov 22, 2022

outSH commented Nov 25, 2022

petermetz left a comment

petermetz left a comment

petermetz left a comment •

edited

Loading

outSH commented Dec 20, 2022

petermetz left a comment

outSH commented Dec 23, 2022

petermetz left a comment

feat(connector-iroha2): add support for Iroha V2 #2153

feat(connector-iroha2): add support for Iroha V2 #2153

Conversation

outSH commented Aug 31, 2022

outSH commented Aug 31, 2022

outSH commented Sep 27, 2022

izuru0 left a comment

Choose a reason for hiding this comment

petermetz commented Nov 1, 2022

petermetz commented Nov 1, 2022

petermetz commented Nov 1, 2022

petermetz commented Nov 1, 2022

petermetz left a comment

Choose a reason for hiding this comment

github-actions bot commented Nov 14, 2022

petermetz commented Nov 22, 2022

outSH commented Nov 25, 2022

petermetz left a comment

Choose a reason for hiding this comment

petermetz left a comment

Choose a reason for hiding this comment

petermetz left a comment • edited Loading

Choose a reason for hiding this comment

outSH commented Dec 20, 2022

petermetz left a comment

Choose a reason for hiding this comment

outSH commented Dec 23, 2022

petermetz left a comment

Choose a reason for hiding this comment

petermetz left a comment •

edited

Loading