mirrors/bitcoin-s
1
0
Fork 0
mirror of https://github.com/bitcoin-s/bitcoin-s.git synced 2025-02-22 14:33:06 +01:00
Code Issues Projects Releases Packages Wiki Activity

Document LN Data types (#1504)

Browse source 
* Document LN Data types

* change to to-string
This commit is contained in:
Ben Carman 2020-06-08 15:20:40 -05:00 • committed by GitHub
parent 8197108c1f
commit 1d9c748abf
2 changed files with 31 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
docs/core/lightning-network.md Normal file
View file

@ -0,0 +1,29 @@
---
id: lightning-network
title: Lightning Network Data Types
---
Bitcoin-S offers support for many different Lightning Network data types.
Here are some examples:
```scala mdoc:invisible
import org.bitcoins.core.protocol.ln._
import org.bitcoins.core.protocol.ln.currency._
import org.bitcoins.core.protocol.ln.node._
import org.bitcoins.crypto._
import scala.util._
import scodec.bits._
```
```scala mdoc:to-string
val lnInvoiceT: Try[LnInvoice] = LnInvoice.fromString(bech32String = "lnbc1u1p0d0k6npp5qndcvujqf47244g6yhd3laqj8c3ckummaahrs375gsgau4upg32qdq623jhxapqv3jhxcmjd9c8g6t0dccqzpgxqrrssrzjqvgptfurj3528snx6e3dtwepafxw5fpzdymw9pj20jj09sunnqmwqz2uagqqjjgqqqqqqqlgqqqqqqgq9qsp5nyg950yy703ah6sazalytaksg0lvyxq3veze5lqswp6rh3jx9css9qy9qsq0d4vhtxkkvse0yx8cgcpemhzatw2wtyvy04ve7n0j3k78l40qpqpvg07vjldvn8zx6nana6glmnlwqvm4fz0pttw7k3rh7wzr48nccsqhnd8wv")
val paymentPreImage = PaymentPreimage(hex"a8c5260174cab81047ba14e8fd96b23074aec7407867343b2d270861e3f0ee66")
val paymentSecret = PaymentSecret(hex"f19d44f4d5fd6a25a7dba8cc84954f2156c2d48db4785b586fdea95561c295b8")
val nodeId = NodeId(ECPublicKey("034f355bdcb7cc0af728ef3cceb9615d90684bb5b2ca5f859ab0f0b704075871aa"))
val millsats100 = MilliSatoshis(BigInt(100))
```

3
website/sidebars.json
View file

@ -21,7 +21,8 @@
"core/adding-spks",
"core/spending-info",
"core/psbts",
"core/txbuilder"
"core/txbuilder",
"core/lightning-network"
],
"Crypto Module": [
"crypto/crypto-intro",