Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 1.82 KB

README.md

File metadata and controls

50 lines (35 loc) · 1.82 KB
Raw

Payjoin Flutter

A Flutter library for the Payjoin Dev Kit.

How to Use

To use the payjoin_flutter package in your project, add it as a dependency in your project's pubspec.yaml:

dependencies:
payjoin_flutter: 0.20.0

Requirements

  • Flutter : 3.0 or higher
  • Android minSdkVersion. : API 23 or higher.
  • Deployment target : iOS 12.0 or greater.

Build and run code

First we need to set up the bitcoin core and esplora locally in the regtest network. If you don't have these, please refer to this page. Or you can install Nigiri Bitcoin, which is a tool designed to simplify the process of running local instances of Bitcoin and Liquid networks for development and testing purposes. You can refer to this link, to install it on your local machine.

Once the nigiri bitcoin starts running, you need to mine a few blocks. Please refer to the following link on how to mine blocks.

Running the integration tests

Once we have set up the Bitcoin core properly in the Regtest network,

git clone https://github.com/LtbLightning/payjoin-flutter.git
cd payjoin-flutter

cd example
#Run integration tests with bitcoin_core and bdk_flutter
flutter test integration_test

References

Payjoin Dev Kit

mozilla/uniffi-rs

Release Status and Disclaimer

This project is in active development and currently in its Alpha stage. Please proceed with caution, particularly when using real funds. We encourage thorough review, testing, and contributions to help improve its stability and security before considering production use.