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

[CHECKLIST] Tangle SDK Improvement #255

Closed
22 of 36 tasks
shekohex opened this issue Sep 6, 2024 · 1 comment
Closed
22 of 36 tasks

[CHECKLIST] Tangle SDK Improvement #255

shekohex opened this issue Sep 6, 2024 · 1 comment
Assignees
Labels
epic 🚀 These are considered CHECKLISTS that make up larger chunks of work

Comments

@shekohex
Copy link
Contributor

shekohex commented Sep 6, 2024

NOTE: This Checklist does not contain any tasks and overlaps with most of the tasks in #232. It is only being used to simultaneously track progress.

This checklist tracks the comprehensive improvements needed for the Tangle SDK, including Eigenlayer integration, networking enhancements, keystore updates, blueprint refinements, and documentation. These tasks are crucial for enhancing the functionality, interoperability, and user-friendliness of our SDK. Overall priority: p1

Eigenlayer Integration (Priority: p0)

Integrate Eigenlayer with Tangle, focusing on cross-chain operations, identity verification, and slashing mechanisms. This is critical for expanding our ecosystem and ensuring secure, interoperable validator operations.

  • Implement EigenLayer operator registration for AVS running Tangle Validator
  • Develop cross-chain registration mechanism
  • Create identity validation/verification system for cross-chain operators
  • Implement slashing propagation between EigenLayer and Tangle
  • Develop system to listen to Tangle and post messages to EL or use a bridge for relaying
  • Implement Job Macro for inbound jobs
  • Implement Report Macro for reporting slashing
  • Generalize current EL event handlers for any event system and callback
  • Plan and implement AVS Upgrades, particularly adding slashing function
  • Develop AVS Operator functionality to read slashing events on Tangle and send to EL Slash Manager Contract

Networking Enhancements (Priority: p1)

Improve the networking capabilities of the SDK to support advanced features like BLS Aggregation and efficient multiplexing.

  • Implement BLS Aggregation support
  • Develop BLS Aggregator Blueprint
  • Investigate and implement BLS Aggregation as a Gossip Module
  • Implement Libp2p Substreams/Yamux for multiplexing and enqueueing

Keystore Updates (Priority: p1)

Enhance the keystore functionality to support new cryptographic operations required for Eigenlayer integration.

  • Add BLS on BN254 to the Keystore to support Eigenlayer BLS

Blueprint Improvements (Priority: p1)

Refine and expand the blueprint system to enhance modularity, reusability, and ease of use for developers.

  • Add Derives like WithKeystore, WithTangleClient, etc.
  • Develop a Derive for all basic "Defaults"
  • Document additional options for developers
  • Separate Eigen Incredible Squaring Blueprint from Tangle Incredible Squaring Blueprint
  • Complete and test Eigen IS Blueprint
  • Complete and test Tangle IS Blueprint
  • Develop and test Tangle AVS Blueprint
  • Implement cross-chain registration, identity verification, and slashing in Tangle AVS Blueprint
  • Create BLS Aggregation Blueprint with pseudocode implementation
  • Ensure necessary networking functions for BLS Aggregation

Core, Common, and Cleanup (Priority: p2)

Address ongoing improvements and cleanup tasks to maintain code quality and implement new features.

Documentation (Priority: p1)

Improve and expand documentation to facilitate easier adoption and usage of the SDK for both operators and developers.

  • Document Context Derive options
  • Create instructions/example for creating a Blueprint
  • Write documentation for Gadget CLI
  • Create README for each Blueprint
  • Write Operator and End User Instructions in Tangle Docs
  • Document Node Specifications in Tangle Docs

Smart Contracts (Priority: p2)

Ensure the smart contracts are upgradeable and follow best practices for security and flexibility.

  • Implement upgradeable smart contracts using OpenZeppelin
  • Review and test upgradeable contracts
@shekohex
Copy link
Contributor Author

shekohex commented Sep 6, 2024

Please note that some of the work is overlapping with #232

@shekohex shekohex added the epic 🚀 These are considered CHECKLISTS that make up larger chunks of work label Sep 6, 2024
@github-project-automation github-project-automation bot moved this to Not Started 🕧 in Webb Universe Sep 6, 2024
@shekohex shekohex moved this from Not Started 🕧 to Planning 🗺️ in Webb Universe Sep 6, 2024
@shekohex shekohex moved this from Planning 🗺️ to EPICS 🚀 in Webb Universe Sep 6, 2024
@github-project-automation github-project-automation bot moved this from EPICS 🚀 to Completed ✅ in Webb Universe Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
epic 🚀 These are considered CHECKLISTS that make up larger chunks of work
Projects
Archived in project
Development

No branches or pull requests

4 participants