search

XLabs / wormscan-ui

5 stars 3 forks source link

[Increase % of Coverage] Tidy up and make VAA parser repo public #699

Open SamantaCasal opened 4 months ago

SamantaCasal commented 4 months ago

Objective:

Make the VAA-Payload-Parser component public so that people, applications, and protocols using Wormhole can submit their own pull requests to the repository.

Task Requirements:

  1. Rewrite to Use Wormhole SDK v2:

    • Update the VAA-Payload-Parser component code to use version 2 of the Wormhole SDK.
    • Ensure all dependencies and configurations are compatible with the new SDK version.

  2. Implement Exhaustive Tests:

    • Develop a test suite to ensure the component functions correctly.
    • The tests should be exhaustive and cover all possible use cases.
    • Ensure that pull requests from integrators are only approved if they pass 100% of the implemented tests.

  3. Add Documentation, Integration Examples, and README:

    • Create comprehensive documentation that includes a quick start guide, detailed function descriptions, and practical integration examples.
    • The examples should demonstrate how to integrate the VAA-Payload-Parser with applications and protocols using Wormhole.
    • Include a detailed README file explaining the project's purpose, how to set it up and integrate it, and how to contribute.

Resources:

Deliverables:

  1. VAA-Payload-Parser component code updated to Wormhole SDK v2.
  2. Complete documentation, integration examples, and README file.
  3. Fully implemented and functioning test suite.
  4. Public repository with contribution guidelines.