Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[EPIC] connection chain code consolidation #1497

Closed
petermetz opened this issue Nov 3, 2021 · 4 comments
Closed

[EPIC] connection chain code consolidation #1497

petermetz opened this issue Nov 3, 2021 · 4 comments
Labels
API_Server bug Something isn't working dependencies Pull requests that update a dependency file Developer_Experience documentation Improvements or additions to documentation Epic P5 Priority 5: Lowest Significant_Change Applying this label triggers the more stringent review of the maintainers and the 2+1 PR rule. SPIKE Exploratory work to better scope additional effort Triage_Needed Triage if the issue is/still relevant, bug report is valid, arch/design details etc.

Comments

@petermetz
Copy link
Contributor

petermetz commented Nov 3, 2021

Description

As a maintainer I want to have packages that do not duplicate existing functionality so that it's easier to maintain the code, needs less documentation and newcomers can better understand what's going on in terms of individual package responsibilities.

This is a reboot of #719 which was opened in the Spring of 2021 and then went nowhere for 5 months with finally all the original work getting deleted from it completely.

Most of the issues within this epic will apply equally to all of these packages:

- packages:
  - cactus-cmd-socketio-server
  - cactus-plugin-ledger-connector-go-ethereum-socketio
  - cactus-plugin-ledger-connector-fabric-socketio
  - cactus-plugin-ledger-connector-sawtooth-socketio
@izuru0
Copy link
Contributor

izuru0 commented Nov 5, 2021

@petermetz

Refactoring to reduce redundancy is acceptable if functionalities provided by existing modules (e.g. monitoring functionality provided by startMonitor/stopMonitor API in cactus-cmd-socketio-server) are not removed.

In particular, the following functionalities described in the API table are needed.

  • Verifier API (= Cactus API)
    • sendAsyncRequest: transfer signed transactions into validator
    • sendSyncRequest: transfer synchronized request into validator
    • startMonitor: transfer request to start continuous monitoring of blocks into validator
    • stopMonior: transfer request to stop continuous monitoring of blocks into validator
  • Validator API (= Ledger Connector API)
    • sendAsyncRequest: issue signed transaction to ledger
    • sendSyncRequest: send synchronized request to ledger and receive the return
    • startMonitor: start continuous monitoring of blocks
    • stopMonitor: stop continuous monitoring of blocks

@takeutak
Copy link
Contributor

takeutak commented Nov 5, 2021

@petermetz Thanks for @izuru0's comment about the above API. Please let me add more information.

We also need to the functionality of posting transactions and getting transaction information and status described as the following whitepaper

The current codes are here

For example, these are called by the examples as the following:

The above are only part of those functionalities and I will add the other functionalities we already developed on this comment later. After finishing our preparations, I'm happy that we will discuss about the API design.

@petermetz
Copy link
Contributor Author

@takeutak @izuru0 I responded to your emails.

@outSH
Copy link
Contributor

outSH commented Sep 30, 2024

All of these modules have been refactored and/or deprecated - closing

@outSH outSH closed this as completed Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API_Server bug Something isn't working dependencies Pull requests that update a dependency file Developer_Experience documentation Improvements or additions to documentation Epic P5 Priority 5: Lowest Significant_Change Applying this label triggers the more stringent review of the maintainers and the 2+1 PR rule. SPIKE Exploratory work to better scope additional effort Triage_Needed Triage if the issue is/still relevant, bug report is valid, arch/design details etc.
Projects
None yet
Development

No branches or pull requests

4 participants