bdk icon indicating copy to clipboard operation
bdk copied to clipboard

Refactor BDK Integration tests

Open rajarshimaitra opened this issue 3 years ago • 0 comments

Description

BDK uses automated integration testing to use in both local and github CI tests. This ensures the library is working as expected and there are no unexpected changed behaviour. Currently the testing framework is written using rust macros, which makes it a little difficult to parse through. The goal of this project is to use more intuitive rust structures and methods for the test framework. Similar to Boitcoin Core's test framework. This will help in easier understanding of the tests for new devs and also allow casual contributors to extend the tests.

Expected Outcomes

  • Through understanding of integration tests in BDK.
  • Good understanding of rust macros.
  • A flexible yet comprehensive struct based test framework for BDK, replacing the existing macros.
  • Bonus: Add more integration tests into BDK.

Resources

Skills Required

  • Experience with git. Guide
  • Basic familiarity with rust. First seven chapters of the book
  • Familiarity with BDK’s integration tests.
  • Familiarity with rust macro, structure and traits.

Mentor(s)
@rajarshimaitra

Difficulty : Medium

Competency Test (optional)

  • Install rust, compile and run all bdk examples and tests.
  • Read through the BDK docs.
  • Make a dummy wallet with BDK with different blockchain backends.
  • Familiarity with basic rust, should be able to write basic custom trait implementations on foreign structures.

rajarshimaitra avatar Nov 30 '21 05:11 rajarshimaitra