Update Dart docs

This commit is contained in:
Erdem Yerebasmaz
2023-11-28 20:01:16 +03:00
committed by Erdem Yerebasmaz
parent 41213db8de
commit 197b8d965c
6 changed files with 30 additions and 25 deletions

View File

@@ -1,4 +1,7 @@
# https://dart.dev/guides/libraries/private-files # https://dart.dev/guides/libraries/private-files
# Created by `dart pub` # Created by `dart pub`
.dart_tool/ .dart_tool/
packages/ packages/
.flutter-version
.flutter-plugins
.flutter-plugins-dependencies

View File

@@ -3,4 +3,4 @@
- By running the publish-all-platforms CI in the breez-sdk repository (use dummy binaries) - By running the publish-all-platforms CI in the breez-sdk repository (use dummy binaries)
- or by cloning https://github.com/breez/breez-sdk-flutter - or by cloning https://github.com/breez/breez-sdk-flutter
2. Place the files in the folder `snippets/dart-snippets/packages/breez-sdk-flutter` 2. Place the files in the folder `snippets/dart-snippets/packages/breez-sdk-flutter`
3. happy coding 3. Happy coding

View File

@@ -7,7 +7,7 @@ Future<SwapInfo> generateReceiveOnchainAddress() async {
SwapInfo swapInfo = await BreezSDK().receiveOnchain(req: req); SwapInfo swapInfo = await BreezSDK().receiveOnchain(req: req);
// Send your funds to the below bitcoin address // Send your funds to the below bitcoin address
final address = swapInfo.bitcoinAddress; String address = swapInfo.bitcoinAddress;
print(address); print(address);
return swapInfo; return swapInfo;
// ANCHOR_END: generate-receive-onchain-address // ANCHOR_END: generate-receive-onchain-address

View File

@@ -8,11 +8,13 @@ Future<void> healthCheckStatus() async {
// ANCHOR_END: health-check-status // ANCHOR_END: health-check-status
} }
Future<void> reportPaymentFailure() async { Future<void> reportPaymentFailure({required String paymentHash}) async {
// ANCHOR: report-payment-failure // ANCHOR: report-payment-failure
String paymentHash = "..."; ReportIssueRequest req = ReportIssueRequest.paymentFailure(
await BreezSDK().reportIssue( data: ReportPaymentFailureDetails(
req: ReportIssueRequest.paymentFailure( paymentHash: paymentHash,
data: ReportPaymentFailureDetails(paymentHash: paymentHash))); ),
);
await BreezSDK().reportIssue(req: req);
// ANCHOR_END: report-payment-failure // ANCHOR_END: report-payment-failure
} }

View File

@@ -21,10 +21,10 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: archive name: archive
sha256: "7e0d52067d05f2e0324268097ba723b71cb41ac8a6a2b24d1edf9c536b987b03" sha256: "7b875fd4a20b165a3084bd2d210439b22ebc653f21cea4842729c0c30c82596b"
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "3.4.6" version: "3.4.9"
args: args:
dependency: transitive dependency: transitive
description: description:
@@ -100,10 +100,10 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: collection name: collection
sha256: f092b211a4319e98e5ff58223576de6c2803db36221657b46c82574721240687 sha256: ee67cb0715911d28db6bf4af1026078bd6f0128b07a5f66fb2ed94ec6783c09a
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "1.17.2" version: "1.18.0"
convert: convert:
dependency: transitive dependency: transitive
description: description:
@@ -132,10 +132,10 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: dart_style name: dart_style
sha256: abd7625e16f51f554ea244d090292945ec4d4be7bfbaf2ec8cccea568919d334 sha256: "40ae61a5d43feea6d24bd22c0537a6629db858963b99b4bc1c3db80676f32368"
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "2.3.3" version: "2.3.4"
ffi: ffi:
dependency: transitive dependency: transitive
description: description:
@@ -201,10 +201,10 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: http name: http
sha256: "5895291c13fa8a3bd82e76d5627f69e0d85ca6a30dcac95c4ea19a5d555879c2" sha256: d4872660c46d929f6b8a9ef4e7a7eff7e49bbf0c4ec3f385ee32df5119175139
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "0.13.6" version: "1.1.2"
http_multi_server: http_multi_server:
dependency: transitive dependency: transitive
description: description:
@@ -249,10 +249,10 @@ packages:
dependency: "direct dev" dependency: "direct dev"
description: description:
name: lints name: lints
sha256: "0a217c6c989d21039f1498c3ed9f3ed71b354e69873f13a8dfc3c9fe76f1b452" sha256: cbf8d4b858bb0134ef3ef87841abdf8d63bfc255c266b7bf6b39daa1085c4290
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "2.1.1" version: "3.0.0"
logging: logging:
dependency: transitive dependency: transitive
description: description:
@@ -281,10 +281,10 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: meta name: meta
sha256: "3c74dbf8763d36539f114c799d8a2d87343b5067e9d796ca22b5eb8437090ee3" sha256: a6e590c838b18133bb482a2745ad77c5bb7715fb0451209e1a7567d416678b8e
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "1.9.1" version: "1.10.0"
mime: mime:
dependency: transitive dependency: transitive
description: description:
@@ -550,10 +550,10 @@ packages:
dependency: transitive dependency: transitive
description: description:
name: web name: web
sha256: dc8ccd225a2005c1be616fe02951e2e342092edf968cf0844220383757ef8f10 sha256: afe077240a270dcfd2aafe77602b4113645af95d0ad31128cc02bce5ac5d5152
url: "https://pub.dev" url: "https://pub.dev"
source: hosted source: hosted
version: "0.1.4-beta" version: "0.3.0"
web_socket_channel: web_socket_channel:
dependency: transitive dependency: transitive
description: description:
@@ -579,5 +579,5 @@ packages:
source: hosted source: hosted
version: "3.1.2" version: "3.1.2"
sdks: sdks:
dart: ">=3.1.0 <4.0.0" dart: ">=3.2.0 <4.0.0"
flutter: ">=3.10.0" flutter: ">=3.10.0"

View File

@@ -11,5 +11,5 @@ dependencies:
path: ./packages/breez-sdk-flutter path: ./packages/breez-sdk-flutter
dev_dependencies: dev_dependencies:
lints: ^2.0.0 lints: ^3.0.0
test: ^1.21.0 test: ^1.24.9