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

Hydra SDK V1 Roadmap #6

Closed
errfrom opened this issue Dec 5, 2024 · 0 comments
Closed

Hydra SDK V1 Roadmap #6

errfrom opened this issue Dec 5, 2024 · 0 comments

Comments

@errfrom
Copy link
Member

errfrom commented Dec 5, 2024

  1. ☑️ Parse all incoming messages from Hydra Node API WebSocket server into HydraNodeApi_InMessage.
    NOTE: Support for incremental commits and decommits will be introduced in a future version.
    Remaining variants:

    • ☑️ PostTxOnChainFailed
    • ☑️ CommandFailed
    • ☑️ IgnoredHeadInitializing
  2. ☑️ Remove CTL dependency. We currently depend on the CTL's internal WebSocket interface that can be reimplemented using Node.js ws, a JS library, due to the lack of a community-standard WebSocket solution for PureScript. There are also a few minor dependencies on CTL throughout the codebase that can be easily resolved.

  3. ☑️ Switch to the latest version of purescript-codec-argonaut, which provides convenient codec builders for sum types. This update will enable us to deprecate our custom sumGenericCodec and fixTaggedSumCodec helpers.

  4. ☑️ Handle Hydra Head states implicitly. Currently, a user is responsible for reacting to incoming messages from the Hydra Node API and keeping track of the current Head state. This workflow can be simplified by updating the state within mkHydraNodeApiWebSocket using an optional user-provided setter function.

  5. ☑️ Add JSON serialization roundtrip tests for various relevant fixtures present in the hydra repository.

  6. ☑️ Fix JSON codecs for PlutusData required to encode / decode Hydra UTXOs with inline datums. Consider switching to purescript-aeson to avoid precision issues when handling large Numbers.

  7. Publish reference documentation on Pursuit.

@errfrom errfrom pinned this issue Dec 5, 2024
@errfrom errfrom mentioned this issue Dec 6, 2024
@errfrom errfrom closed this as completed Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant