aljaz/bitcoin-waila
1
0
Fork 0
mirror of https://github.com/aljazceru/bitcoin-waila.git synced 2025-12-17 04:54:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
benthecarman
2023-11-08 13:09:05 -06:00
parent db1b121e7b
commit 39cdf490b7
3 changed files with 35 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -28,9 +28,11 @@ Currently supported:
- BIP-21 URI - BIP-21 URI
- Lightning invoice - Lightning invoice
- Lightning Offer - Lightning Offer
- Bolt 12 Refund
- Node Pubkey - Node Pubkey
- LNURL - LNURL
- Lightning Address - Lightning Address
- Nostr Pubkey
- RGB invoice - RGB invoice
## Examples ## Examples
@@ -68,6 +70,21 @@ let parsed = bitcoin_waila::PaymentParams::from_str("ben@opreturnbot.com").unwra
assert_eq!(parsed.lnurl(), Some(LnUrl::from_str("lnurl1dp68gurn8ghj7mmswfjhgatjde3x7apwvdhk6tewwajkcmpdddhx7amw9akxuatjd3cz7cn9dc94s6d4").unwrap())); assert_eq!(parsed.lnurl(), Some(LnUrl::from_str("lnurl1dp68gurn8ghj7mmswfjhgatjde3x7apwvdhk6tewwajkcmpdddhx7amw9akxuatjd3cz7cn9dc94s6d4").unwrap()));
``` ```
Bolt 12:
```rust
let parsed = bitcoin_waila::PaymentParams::from_str("lno1qgs0v8hw8d368q9yw7sx8tejk2aujlyll8cp7tzzyh5h8xyppqqqqqqgqvqcdgq2qenxzatrv46pvggrv64u366d5c0rr2xjc3fq6vw2hh6ce3f9p7z4v4ee0u7avfynjw9q").unwrap();
assert_eq!(parsed.amount_msats(), Some(100_000));
assert_eq!(parsed.offer(), Some(Offer::from_str("lno1qgs0v8hw8d368q9yw7sx8tejk2aujlyll8cp7tzzyh5h8xyppqqqqqqgqvqcdgq2qenxzatrv46pvggrv64u366d5c0rr2xjc3fq6vw2hh6ce3f9p7z4v4ee0u7avfynjw9q").unwrap()));
```
RGB Invoice:
```rust
let parsed = bitcoin_waila::PaymentParams::from_str("rgb:Cbw1h3zbHgRhA6sxb4FS3Z7GTpdj9MLb7Do88qh5TUH1/RGB20/1+utxob0KPoUVTWL3WqyY6zsJY5giaugWHt5n4hEeWMQymQJmPRFPXL2n").unwrap();
assert!(matches!(parsed, PaymentParams::Rgb(_)));
```
JavaScript: JavaScript:
```js ```js

17
waila/README.md
View File

@@ -16,9 +16,11 @@ Currently supported:
- BIP-21 URI - BIP-21 URI
- Lightning invoice - Lightning invoice
- Lightning Offer - Lightning Offer
- Bolt 12 Refund
- Node Pubkey - Node Pubkey
- LNURL - LNURL
- Lightning Address - Lightning Address
- Nostr Pubkey
- RGB invoice - RGB invoice
## Examples ## Examples
@@ -55,3 +57,18 @@ Lightning Address:
let parsed = bitcoin_waila::PaymentParams::from_str("ben@opreturnbot.com").unwrap(); let parsed = bitcoin_waila::PaymentParams::from_str("ben@opreturnbot.com").unwrap();
assert_eq!(parsed.lnurl(), Some(LnUrl::from_str("lnurl1dp68gurn8ghj7mmswfjhgatjde3x7apwvdhk6tewwajkcmpdddhx7amw9akxuatjd3cz7cn9dc94s6d4").unwrap())); assert_eq!(parsed.lnurl(), Some(LnUrl::from_str("lnurl1dp68gurn8ghj7mmswfjhgatjde3x7apwvdhk6tewwajkcmpdddhx7amw9akxuatjd3cz7cn9dc94s6d4").unwrap()));
``` ```
Bolt 12:
```rust
let parsed = bitcoin_waila::PaymentParams::from_str("lno1qgs0v8hw8d368q9yw7sx8tejk2aujlyll8cp7tzzyh5h8xyppqqqqqqgqvqcdgq2qenxzatrv46pvggrv64u366d5c0rr2xjc3fq6vw2hh6ce3f9p7z4v4ee0u7avfynjw9q").unwrap();
assert_eq!(parsed.amount_msats(), Some(100_000));
assert_eq!(parsed.offer(), Some(Offer::from_str("lno1qgs0v8hw8d368q9yw7sx8tejk2aujlyll8cp7tzzyh5h8xyppqqqqqqgqvqcdgq2qenxzatrv46pvggrv64u366d5c0rr2xjc3fq6vw2hh6ce3f9p7z4v4ee0u7avfynjw9q").unwrap()));
```
RGB Invoice:
```rust
let parsed = bitcoin_waila::PaymentParams::from_str("rgb:Cbw1h3zbHgRhA6sxb4FS3Z7GTpdj9MLb7Do88qh5TUH1/RGB20/1+utxob0KPoUVTWL3WqyY6zsJY5giaugWHt5n4hEeWMQymQJmPRFPXL2n").unwrap();
assert!(matches!(parsed, PaymentParams::Rgb(_)));
```

1
waila/src/lib.rs
View File

@@ -662,5 +662,6 @@ mod tests {
assert_eq!(parsed.invoice(), None); assert_eq!(parsed.invoice(), None);
assert_eq!(parsed.node_pubkey(), None); assert_eq!(parsed.node_pubkey(), None);
assert_eq!(parsed.nostr_pubkey(), None); assert_eq!(parsed.nostr_pubkey(), None);
assert!(matches!(parsed, PaymentParams::Rgb(_)));
} }
} }