You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-17Lines changed: 28 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,36 +8,47 @@ To use the `payjoin_flutter` package in your project, add it as a dependency in
8
8
9
9
```dart
10
10
dependencies:
11
-
payjoin_flutter: 0.20.0
11
+
payjoin_flutter: 0.22.0
12
12
```
13
13
### Requirements
14
14
15
15
- Flutter : 3.0 or higher
16
16
- Android minSdkVersion. : API 23 or higher.
17
17
- Deployment target : iOS 12.0 or greater.
18
18
19
-
### Build and run code
20
-
First we need to set up the `bitcoin core` and `esplora` locally in the regtest network. If you don't
21
-
have these, please refer to this [page](https://learn.saylor.org/mod/page/view.php?id=36347). Or you can
22
-
install `Nigiri Bitcoin`, which is a tool designed to simplify the process of running local instances of Bitcoin and
23
-
Liquid networks for development and testing purposes. You can refer to
24
-
this [link](https://github.com/vulpemventures/nigiri), to install it on your local machine.
25
19
26
-
Once the nigiri bitcoin starts running, you need to mine a few blocks. Please refer to the following [link](https://developer.bitcoin.org/reference/rpc/generatetoaddress.html?highlight=generate)
27
-
on how to mine blocks.
28
-
29
-
30
-
## Running the integration tests
31
-
Once we have set up the Bitcoin core properly in the `Regtest` network,
#Run integration tests with bitcoin_core and bdk_flutter
39
-
flutter test integration_test
26
+
27
+
flutter pub get
28
+
flutter run
29
+
```
30
+
31
+
For more advanced usage notes see below
32
+
33
+
## Flutter and Flutter Rust Bridge Usage Notes
34
+
Here are some useful commands when making changes that require rebuilding the generated code or running the example app to test:
35
+
36
+
```shell
37
+
# You often need to run the build_runner to generate freezed files
38
+
flutter pub get
39
+
flutter pub run build_runner build --delete-conflicting-outputs
40
+
flutter run
41
+
42
+
# Must be run after any updates to the rust code (can be set to watch)
43
+
flutter_rust_bridge_codegen generate
44
+
# or
45
+
flutter_rust_bridge_codegen generate --watch
46
+
# Note: generated files can be determined based off what the custom rust code is importing. If you're expecting something to be available from a generated file but your rust isn't compiling then regenerate (ex: frb_generated::RustOpaque type is determined by how it's used)
47
+
48
+
# Useful if your app build gets messed up (ios for example)
0 commit comments