What are the key milestones you need to achieve in order to complete your project successfully?
Milestone 1: Milestone 1: Proposal Onboarding and Planning (1 Month)
Objective: Establish a solid foundation for the project by setting up the necessary infrastructure, assembling the team, and defining project management practices.
Activities:
- Proposal onboarding and project management tools setup
- Have a detailed breakdown of tasks for all the activities covered:
- Initial Documentation
- List out all the APIs needed
Acceptance Criteria & Evidence:
- Project management tools and systems set up.
- Github link with tasks breakdown publicly accessible
Milestone 2: Milestone 2: Rust & WASM Packaging (1 Month)
Objective: Prepare the code base for both the wasm package and package for rust use
Activities:
- Splitting code base into 2 separate rust projects
- Compile all core logics and type into wasm
- Publish initial version for both Rust SDK & WASM package
Acceptance Criteria & Evidence:
- 2 links pointing to root location of the 2 separate rust projects
- A published rust crate visitable in crates.io, indicating the package for rust use
- 2 published node modules containing the core logics, one for nodejs and one for browser in npm registry
Milestone 3: Milestone 3: MeshJS Migration (1.5 Month)
Objective: Migrate all existing CSL logic to mesh-csl, which builds on top of the wasm package
Activities:
- Migrate all existing CSL logic from MeshJS library to mesh-csl, leaving spacing for future MeshJS integration pattern upgrades.
- Integrate the migrated functions back to MeshJS library
Acceptance Criteria & Evidence:
- A complete mesh-csl package with open source Github repository link
- A published node module public visitable in on npm registry
- A upgraded <member communityid="163" id="189733">meshsdk</member>/core package with the migrated functions integrated
Milestone 4: Milestone 4: Feature development (1 Month)
Objective: Develop off-node transaction evaluation feature and integrating with mesh. Develop provider integration feature with the rust package
Activities:
- Develop the off-node transaction evaluation
- Develop blockchain provider implementation and integration with Maestro & Blockfrost
Acceptance Criteria & Evidence:
- New features available with documentation available in published rust package in crates.io
- New features available with documentation available in mesh core package
Milestone 5: Milestone 5: Feature development (1 Month)
Objective: Develop new feature of systematically parsing transaction information from hex, enable offchain code unit testing
Activities:
- Develop the backward transaction parser - getting the transaction hex and parsing back to rust object
- Develop the offchain code unit testing framework on top of the transaction parser, introducing a brand new developer experience on unit testing offchain code on Cardano
Acceptance Criteria & Evidence:
- New features available with documentation available in published rust package in crates.io
- New features available with documentation available in mesh core package
Final Milestone: Final Milestone: Complete Documentation (1 Month)
Objective: Provide full set of documentation, bringing the proposal result to the community
Activities:
- Complete all inline documentation on user-facing APIs, with public hosting for easy referencing.
- Hosting a community in both MeshJS & SIDAN Lab discord for feedback, question and communication
- Prepare the project close-out report and video
Acceptance Criteria & Evidence:
- A full set of public documentation on all new features and changes brought by this project
- Dedicated channel in SIDAN Lab discord server in regards to the project deliverables
- Announcement in MeshJS discord server about all new features provided by this project
- Publicly available project close-out report and video