feat(connector-polkadot): polkadot connector #1997

RafaelAPB · 2022-05-02T00:31:12Z

This PR adds a long-term effort to adding preliminary support to Substrate-based chains. Most work wonderfully done by @CatarinaPedreira

"The Polkadot Connector provides functionality that enables any permissioned blockchain (as long as it is supported by Hyperledger Cactus) to connect to the Polkadot network and perform monetary transactions to the latter. Besides this, the connector provides methods for these blockchains to deploy and interact with smart contracts in the network.

Our connector in Hyperledger Cactus uses three different API’s to communicate with the Polkadot network: ”@polkadot/api” (which has the base API functionality), ”@polkadot/api-contracts” (which contains the API specific for smart contract interaction) and ”@polkadot/types” (which encompasses specific
Polkadot types)."

Features:
-transact on the network
-read smart contracts
-deploy smart contracts
-read from smart contracts
-endpoints for the features

Future work/limitations

The integration tests are commented/skipped because we need to add the source code of the smart contracts (metadata, etc) to the repository, such that they can be executed.
Some of the features could be more extensible/flexible, but again, this is the first version of the connector
Some endpoints are not fully implemented

Thanks to @petermetz for helping develop the test ledger.

Co-authored-by: CatarinaPedreira [email protected]
Signed-off-by: Rafael Belchior [email protected]

jagpreetsinghsasan · 2022-05-02T07:47:28Z

...tus-plugin-ledger-connector-polkadot/src/main/typescript/plugin-ledger-connector-polkadot.ts

+
+  public setProvider(wsProviderUrl: string): void {
+    try {
+      this.wsProvider = new WsProvider(wsProviderUrl);


Does this even try to connect to the wsProviderUrl?
If yes, is there a way to avoid autoconnect by passing some other argument(s) to the WsProvider constructor or some other way? (If this is enabled, this will be helpful in the DAST scan, so that we can pass a dummy wsProviderUrl and don't require to spin up an actual all-in-one image for Polkadot)
@petermetz will we be adding this platform as well to the DAST scans?

Yes it automatically connects (behind the scenes): https://polkadot.js.org/docs/api/start/create/
and yes.

...n-ledger-connector-polkadot/src/main/typescript/web-services/deploy-contract-ink-endpoint.ts

petermetz · 2022-05-02T17:53:46Z

packages/cactus-core-api/src/main/json/openapi.json

+                    "Authority",
+                    "Stake",
+                    "Work",
+                    "Substrate"


@RafaelAPB By the consesus algorithm family "Substrate" are you referring to all the consensus algorithms listed here on their documentation? https://docs.substrate.io/v3/advanced/consensus/#consensus-in-substrate

Updated to Substrate-GRANPA (for clarity)

petermetz

@RafaelAPB Please delete the package-lock.json file, it's not being used since we migrated to yarn.

...cactus-plugin-ledger-connector-polkadot/src/test/rust/fixtures/ink!/publicBulletin/README.md

petermetz · 2022-05-02T17:59:06Z

.../cactus-plugin-ledger-connector-polkadot/src/test/typescript/integration/api-surface.test.ts

@@ -0,0 +1,8 @@
+import test, { Test } from "tape-promise/tape";


@RafaelAPB Any chance that you could write the tests with Jest? See my earlier email on the mailing list for rationale (we've migrated over last summer)

Please see comment bellow

petermetz · 2022-05-02T17:59:34Z

...plugin-ledger-connector-polkadot/src/test/typescript/integration/deploy-ink-contract.test.ts

@@ -0,0 +1,89 @@
+/*


@RafaelAPB Are these commented out because they are not needed at all to achieve sufficient coverage or some other reason?

Tests are not currently passing because the smart contracts are not being generated automatically from the source, and thus we cannot run them. Is this an impeditive issue?

tools/docker/substrate-all-in-one/hooks/post_push

Co-authored-by: CatarinaPedreira <[email protected]> Signed-off-by: Rafael Belchior <[email protected]> feat(tools): substrate test ledger Co-authored-by: CatarinaPedreira <[email protected]> Co-authored-by: Peter Somogyvari <[email protected]> Signed-off-by: Rafael Belchior <[email protected]> feat(polkadot-connector): add transaction endpoint Signed-off-by: Rafael Belchior <[email protected]> feat(polkadot-connector): add documentation Signed-off-by: Rafael Belchior <[email protected]> chore(polkadot-connector): update dependencies Signed-off-by: Rafael Belchior <[email protected]> refactor(polkadot-connector): refactor endpoints Signed-off-by: Rafael Belchior <[email protected]> refactor(polkadot-connector): refactor connector Signed-off-by: Rafael Belchior <[email protected]> feat(polkadot-connector): get tx info endpoint Signed-off-by: Rafael Belchior <[email protected]> test(polkadot-connector): skip tests Signed-off-by: Rafael Belchior <[email protected]> feat(connector-polkadot): polkadot connector Co-authored-by: CatarinaPedreira <[email protected]> Signed-off-by: Rafael Belchior <[email protected]> feat(tools): substrate test ledger Co-authored-by: CatarinaPedreira <[email protected]> Co-authored-by: Peter Somogyvari <[email protected]> Signed-off-by: Rafael Belchior <[email protected]> feat(polkadot-connector): add transaction endpoint Signed-off-by: Rafael Belchior <[email protected]> feat(polkadot-connector): add documentation Signed-off-by: Rafael Belchior <[email protected]> chore(polkadot-connector): update dependencies Signed-off-by: Rafael Belchior <[email protected]> refactor(polkadot-connector): refactor endpoints Signed-off-by: Rafael Belchior <[email protected]> refactor(polkadot-connector): refactor connector Signed-off-by: Rafael Belchior <[email protected]> feat(polkadot-connector): get tx info endpoint Signed-off-by: Rafael Belchior <[email protected]> test(polkadot-connector): skip tests Signed-off-by: Rafael Belchior <[email protected]> feat(connector-polkadot): add connector draft Signed-off-by: Rafael Belchior <[email protected]>

petermetz · 2023-09-08T23:02:01Z

@jagpreetsinghsasan @AnmolBansalDEV I'm closing this for now just to keep our backlog of PRs tidy(er) but please re-open as soon as it is ready for review with the new changes incorporated from the LF mentorship program!

cc: @RafaelAPB

RafaelAPB requested review from jonathan-m-hamilton and petermetz as code owners May 2, 2022 00:31

RafaelAPB force-pushed the polkadot-connector-squashed branch from 0903bed to 91f68a1 Compare May 2, 2022 00:44

jagpreetsinghsasan reviewed May 2, 2022

View reviewed changes

RafaelAPB force-pushed the polkadot-connector-squashed branch 3 times, most recently from 782ad1e to 133f245 Compare May 2, 2022 12:01

petermetz reviewed May 2, 2022

View reviewed changes

petermetz requested changes May 2, 2022

View reviewed changes

petermetz requested review from izuru0 and takeutak and removed request for jonathan-m-hamilton May 2, 2022 18:03

petermetz added the Polkadot Tasks related or relevant to the Polkadot connector label May 2, 2022

petermetz requested changes May 2, 2022

View reviewed changes

tools/docker/substrate-all-in-one/hooks/post_push Outdated Show resolved Hide resolved

RafaelAPB force-pushed the polkadot-connector-squashed branch 2 times, most recently from c6f30d4 to a296a35 Compare May 9, 2022 11:52

RafaelAPB force-pushed the polkadot-connector-squashed branch from a296a35 to f3aa175 Compare November 25, 2022 00:40

RafaelAPB requested a review from sandeepnRES as a code owner November 25, 2022 00:40

RafaelAPB force-pushed the polkadot-connector-squashed branch from f3aa175 to a296a35 Compare November 25, 2022 01:05

RafaelAPB force-pushed the polkadot-connector-squashed branch from a296a35 to 707eaed Compare November 25, 2022 01:13

RafaelAPB mentioned this pull request Nov 25, 2022

fix(test-tooling): substrate test ledger fails if WS_PORT not specified #2213

Closed

RafaelAPB requested review from jagpreetsinghsasan and petermetz and removed request for izuru0, takeutak, sandeepnRES, jagpreetsinghsasan and petermetz November 25, 2022 01:38

RafaelAPB requested review from jagpreetsinghsasan and petermetz and removed request for jagpreetsinghsasan and petermetz November 25, 2022 01:38

RafaelAPB mentioned this pull request Jun 15, 2023

feat(connector-polkadot): Connector and Validator #627

Closed

petermetz closed this Sep 8, 2023

RafaelAPB deleted the polkadot-connector-squashed branch January 30, 2024 15:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(connector-polkadot): polkadot connector #1997

feat(connector-polkadot): polkadot connector #1997

RafaelAPB commented May 2, 2022

jagpreetsinghsasan May 2, 2022

RafaelAPB May 2, 2022

petermetz May 2, 2022

RafaelAPB May 9, 2022

petermetz left a comment

petermetz May 2, 2022

RafaelAPB May 9, 2022

petermetz May 2, 2022

RafaelAPB May 9, 2022

petermetz commented Sep 8, 2023

		@@ -0,0 +1,8 @@
		import test, { Test } from "tape-promise/tape";

feat(connector-polkadot): polkadot connector #1997

feat(connector-polkadot): polkadot connector #1997

Conversation

RafaelAPB commented May 2, 2022

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

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

petermetz commented Sep 8, 2023