florianhubl/lnbitskit

Requirements

• iOS 13 or higher
• macOS 12 or higher

Documentation

Connecting to LNBits

let lnbits = LNBits(server: "https://legend.lnbits.com", adminKey: "145a510c4ce1496e827e1fc34934b980", invoiceKey: "a04c53fec8524ba3aa63d8385e41c288")

These keys are in the Api docs in your LNBits Wallet.

Testing connection

if await lnbits.testConnection() {
    // connected
}else {
    // not connected
}

Generating an Invoice

let invoice = try! await lnbits.createInvoice(sats: 21, memo: "Hello :)")
let paymentRequest = invoice.paymentRequest

Decoding an Invoice

let decodeInvoice = try! await lnbits.decodeInvoice(invoice: "lnbc210n1pjd62g3sp5pwlfye29mk6mmsxzhj8w3cvq4va3tu2uwj2klwjqpguzhw67x38qpp5upej4ls9ytz7ard5ttq93m4ngrz6uw20tgv0jskmmvgv9y0e40wqdq2f38xy6t5wvxqzjccqpjrzjqw6lfdpjecp4d5t0gxk5khkrzfejjxyxtxg5exqsd95py6rhwwh72rpgrgqq3hcqqgqqqqlgqqqqqqgq9q9qxpqysgq9szuwpy2kd7ksk9vsgdnef9z0pdzdermcya50dd7ncgemzzlqptyukew6zd
let amount = decodeInvoice.amount
let memo = decodeInvoice.description

Paying an Invoice

try! await lnbits.payInvoice(invoice: "lnbc210n1pjd62g3sp5pwlfye29mk6mmsxzhj8w3cvq4va3tu2uwj2klwjqpguzhw67x38qpp5upej4ls9ytz7ard5ttq93m4ngrz6uw20tgv0jskmmvgv9y0e40wqdq2f38xy6t5wvxqzjccqpjrzjqw6lfdpjecp4d5t0gxk5khkrzfejjxyxtxg5exqsd95py6rhwwh72rpgrgqq3hcqqgqqqqlgqqqqqqgq9q9qxpqysgq9szuwpy2kd7ksk9vsgdnef9z0pdzdermcya50dd7ncgemzzlqptyukew6zd2m0ynan6shxv0s02qxvgzkapdfvps59vzx550hul6g0gp0937wp")

Get Wallet Balance

let balance = try await lnbits.getBalance()

The balance is in sats.

Get Wallet Name

let name = try await lnbits.getName()

List all Transactions

let txs = try await lnbits.getTXs()

Change Wallet Name

try await lnbits.changeName(name: "Wallet")

Create a LNURLPay Link

let lnurl = try await lnbits.createLNURLPayLink()
let link = lnurl.lnurl

List all created LNURLPay Links

let lnurls = try await lnbits.getPayLinks()
let links = lnurls.map { lnurl in
    lnurl.lnurl
}

Decode LNURL

let lnurl = try await lnbits.decodeLNURL(lnurl: "LNURLBITCOINISAWESOME")
switch lnurl.kind {
    case .pay:
    // LNURL Pay
    case .withdraw:
    // LNURL Withdraw
    case .auth:
    // LNURL Auth
}

Pay LNURL Pay Link

try await lnbits.payLNURL(lnurl: "LNURLBITCOINISAWESOME", amount: 21)

Create LNURL Withdraw

let lnurl = try await lnbits.createLNURLWithdraw()
let link = lnurl.lnurl

List LNURL Withdraw

let lnurl = try await lnbits.getLNURLWithdraws()
let a = lnurl.map { i in
    i.lnurl
}

Withdraw from LNURL Withdraw Link

try! await lnbits.withdrawFromLNURLWithdraw(lnurl: "LNURLBITCOINISAWESOME")

This function automaticlly withdraws the highest amount possible. But you can also set an amount.

try! await lnbits.withdrawFromLNURLWithdraw(lnurl: "LNURLBITCOINISAWESOME", amount: 21)

Delete LNURL Pay Link

try await lnbits.deleteLNURLPay(id: "BTC21M")

The ID is in the LNURLPay Object.

let lnurl = try await lnbits.createLNURLPayLink()
try await lnbits.deleteLNURLPay(id: lnurl.id)

Delete LNURL Withdraw Link

try await lnbits.deleteLNURLWithdraw(id: "BTC21M")

LNURL Auth

try await lnbits.lnurlAuth(lnurl: "LNURLLOGINWITHLIGHTNING")

Error Handling

do {
// Code
}catch LNBitsError.error(let error) {
    print(error)
}

Boltz Sub Marine Swap

let swap = try await lnbits.createSubMarineSwap(amount: 100000, refundAddress: "bc1qbitcoinfixesthis")

Min 50000 sats per Swap.

List Boltz Sub Marine Swaps

let swaps = try await lnbits.getSubMarineSwaps()

Refund Boltz Sub Marine Swap

try await lnbits.refundSubMarineSwap(swapID: "mySwapID")

Boltz Reverse Sub Marine Swap

let swap = try await lnbitscreateReversedSubMarineSwap(amount: 100000, onChainAddress: "bc1qbitcoinfixesthis")

List Boltz Reverse Sub Marine Swaps

let swap = try await lnbits.getReversedSubMarineSwaps()

Package Metadata

Repository: florianhubl/lnbitskit

Default branch: main

README: README.md