What Is This Repository About?

[thunderbiscuit]

At first glance and from the point of view of a React Native developer or maintainer, this repository does not look like a standard RN repo. This issue outlines what this repository is, the core aspects of maintaining it, and the goals we have for it in the long run.

The overarching goal of the repo is to provide a separate space for building and maintaining the React Native bindings for BDK, separate from the bdk-ffi repository while still leveraging the Rust-based "wrapper codebase" that has been built over the years, is reviewed well, and used in production by many teams and projects in bitcoin.

In practice, this means the chief objectives of this repository are as follows:

1. Maintain the infrastructure necessary to transform the Rust uniff-based API residing in bdk-ffi into a full-fledged Kotlin library.
2. Maintain and publish the API documentation website for the library.
3. Own the CI workflows that (a) test the library, (b) build the API docs, and (c) run the test suite against the latest commits merged on the bdk-ffi repository.
4. Own the release to npm workflows.