[plan] Milestone 2

[Hyung-bharvest]

Milestone 2 : Production-level implementation of Milestone 1 on Cosmos-SDK stargate version

1) Backend

• Rebase and Refactoring
  • Rebase codebase to Cosmos-SDK version equal or later than 0.40.0-RC4
  • Refactoring codebase for rule-based decimal management and better error handling
• Functional Improvement
  • Half-half fee payment for consistent pool price during fee payment process
  • Implement spam prevention methodologies
    • flat ATOM fees for each Liquidity Module message
    • proportional fees for each liquidity pool withdrawal
• Utilities
  • RPC/CLI implementation
  • Genesis export
• Maintenance
  • Deal with issues on the repository from AiB or other community members
  • Global test coverage +80% with below range of files
    • all *.go files in x/liquidity/keeper and x/liquidity/types
    • excluding _test.go, .pb.go and *.pb.gw.go

2) Test and Simulation

• Implement various invariant check functions for verifying wide range of error possibilities
• Implement scenario-based random simulation test program for
  • extensive edge case finding
  • testing the validity of the Liquidity Module model with various economic assumptions
  • provide testing report with simulation results

3) Documentations

• Update spec documentation for new functionalities
• Write white paper for Liquidity Module
  • mathematical explanation documentation for Liquidity Module calculations
  • comparison with Uniswap, Reasoning for Liquidity Module mechanisms
  • comprehensive economic simulation result for validation of Liquidity Module model

4) Frontend

• Finalize wire frame for web interface of Liquidity Module
• Provide sample frontend source code for reference (React)
• Provide sample API communication codebase for frontend UI (RPC or gRPC)
• Provide sample Keplr integration (Javascript)
• Provide simple web interface connected to testnet for entire user-flow testing of Liquidity Module

[Hyung-bharvest]

Milestone 2 : Bi-Weekly Schedule

• 1~2 week
  • Backend
  • Feature : Half-half fee payment for consistent pool price during fee payment process
  • Test and Simulation
  • Doc : Invariant check spec and objectives
  • Improve test coverage (ongoing)
  • Documentation
  • White Paper Draft Completion
  • Update spec documentation for two improved functionalities (fee handling and spam prevention)
  • Frontend
  • Implement sample frontend
    • Web interface (React)

• 3~4 week
  • Backend
  • Feature : Implement spam prevention methodology (flat Atom fees for each Liquidity Module message)
  • Doc : Strategy for rule-based decimal management and better error handling
  • Doc : CLI spec documentation
  • Test and Simulation
  • Implement various invariant check functions for verifying wide range of error possibilities
  • Doc : Simulation spec and objectives
  • Improve test coverage (ongoing)
  • Documentation
  • White paper for Liquidity Module
    • Mathematical explanation documentation for Liquidity Module calculations
  • Frontend
  • Implement sample frontend
    • API communication (RPC or gRPC)

• 5~6 week
  • Backend
  • Refactoring codebase for rule-based decimal management and better error handling
  • Rebase codebase to most updated Cosmos-SDK stargate version
  • RPC/CLI implementation
  • Test and Simulation
  • Simulation program implementation
  • Improve test coverage (ongoing)
  • Documentation
  • White paper for Liquidity Module
    • Comparison with Uniswap, Reasoning for Liquidity Module mechanisms
  • Frontend
    • Keplr integration (Javascript)

• 7~8 week
  • Backend
  • Rebase codebase to most updated Cosmos-SDK stargate version
  • Genesis export
  • Test and Simulation
  • Doc : Testing report with simulation results
  • Improve test coverage : Global test coverage +80% with given range of files
  • Documentation
  • White paper for Liquidity Module
  • Doc : Update API spec documentation
  • Frontend
  • Demo : Web interface connected to testnet for entire user-flow testing of Liquidity Module

[Hyung-bharvest]

Milestone2 SoW Items

• Turn initial proof of concept into a production level module based on Stargate version 0.40.0.

  • Code coverage of minimum 80% with all tests passing with success;
    • continuous
  • Unit testing on CLI functions that pass with success;
    • continuous
  • Qualitative review and enhancement of current unit tests; (qualitative review?)
    • continuous
  • Use of appropriate production-level error trapping, handling and logging;
    • continuous

• Add the following additional features:

  • Pool Identification;
    • spec update and implementation by 2021-01-29
  • Half/Half Fee Payments;
    • done
  • Fee structure for Spam;
    • spec update and implementation by 2021-01-29
  • Remaining features from milestone one in the specification e.g. Event emission;
    • spec document by 2021-02-05
    • codebase update by 2021-02-12
  • Strategy for rule-based decimal management.
    • spec document by 2021-02-05
    • codebase update by 2021-02-19

• "Light" paper outlining

  • Rationale for module design;
  • Explanation of how the model works, through the use of order book and AMM technologies;
  • Explanation of the Swap matching algorithm;
  • Outline assumptions and constraints of the model;
  • Comparison analysis versus other liquidity engines.
  • Version 0.1 by 2021-01-29
  • Version 0.2 by 2021-02-26

• Production-level developers reference documentation that

  • Covers code’s public API and deployment;
  • Is based on Golang’s Godoc convention: https://blog.golang.org/godoc;
  • by 2021-02-19

• HTTP API specification implementation based on the specification of Milestone One. This will include gRPC as well as HTTP API.

  • by 2021-02-19

• Rosetta API integration

  • by 2021-02-26

• Testing, that will include the following:

  • Simulation testing using Cosmos SDK's functionality provided by the x/simulation module;
    • simapp simulation implementation by 2021-02-12
    • economic simulation test result by 2021-02-19
    • economic simulation report by 2021-02-26
  • Invariant checks;
    • spec document by 2021-01-29
    • implementation by 2021-02-12
  • Performance testing, particularly around End-Block.
    • performance testing by 2021-01-29
    • full report by 2021-02-05

Milestone2 SoW Weekly Schedule

• by 2021-01-29
  • Pool Identification : spec update and implementation
  • Fee structure for Spam : spec update and implementation
  • Light Paper : V0.1 Finalize
  • Invariant checks : spec document
  • Performance testing : testing execution
• by 2021-02-05
  • Remaining features from milestone one in the specification e.g. Event emission : spec update
  • Strategy for rule-based decimal management : spec document
  • Performance testing : report
• by 2021-02-12
  • Remaining features from milestone one in the specification e.g. Event emission : implementation
  • Simulation testing using Cosmos SDK's functionality : simapp simulation implementation
  • Invariant checks : implementation
• by 2021-02-19
  • Strategy for rule-based decimal management : implementation
  • Production-level developers reference documentation : finalize
  • HTTP API specification implementation including gRPC as well as HTTP API : implementation
  • Economic simulation result
• by 2021-02-26
  • Light Paper : V0.2 finalize
  • Rosetta API integration
  • Economic simulation report

[Hyung-bharvest]

outdated