breez-sdk-docs/src/guide/lnurl_auth.md

LNURL-Auth

Usage

Rust

// Endpoint can also be of the form:
// keyauth://domain.com/auth?key=val
let lnurl_auth_url = "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttvdankjm3lw3skw0tvdankjm3xdvcn6vtp8q6n2dfsx5mrjwtrxdjnqvtzv56rzcnyv3jrxv3sxqmkyenrvv6kve3exv6nqdtyv43nqcmzvdsnvdrzx33rsenxx5unqc3cxgeqgntfgu";

if let Ok(LnUrlAuth{data: ad}) = parse(lnurl_auth_url).await {
    match sdk.lnurl_auth(ad).await {
        Ok(LnUrlCallbackStatus::Ok) => {
            info!("Successfully authenticated")
        }
        Ok(LnUrlCallbackStatus::ErrorStatus { data }) => {
            error!("Failed to authenticate: {}", data.reason)
        }
        Err(e) => {
            error!("Failed to connect: {e}")
        }
    }
}

Swift

// Endpoint can also be of the form:
// keyauth://domain.com/auth?key=val
let lnurlAuthUrl = "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttvdankjm3lw3skw0tvdankjm3xdvcn6vtp8q6n2dfsx5mrjwtrxdjnqvtzv56rzcnyv3jrxv3sxqmkyenrvv6kve3exv6nqdtyv43nqcmzvdsnvdrzx33rsenxx5unqc3cxgeqgntfgu";

do {
  let inputType = try parseInput(s: lnurlAuthUrl)
  if case .lnUrlAuth(data) = inputType {
    let result = try sdk.lnurlAuth(data)
    switch result {
    case .ok:
        print("Successfully authenticated")
    case .errorStatus(data):
        print("Failed to authenticate")
    }    
  }
} catch SdkError.Error(let message) {
  print(message)
}

React Native

// Endpoint can also be of the form:
// keyauth://domain.com/auth?key=val
let lnurlAuthUrl = "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttvdankjm3lw3skw0tvdankjm3xdvcn6vtp8q6n2dfsx5mrjwtrxdjnqvtzv56rzcnyv3jrxv3sxqmkyenrvv6kve3exv6nqdtyv43nqcmzvdsnvdrzx33rsenxx5unqc3cxgeqgntfgu";

try {
    const input = await parseInput(lnurlAuthUrl)
    if (input.type === InputType.LNURL_AUTH) {
        const result = await lnurlAuth(input.data)
        if (result.status === "ok") {
            print("Successfully authenticated")
        } else {
            print("Failed to authenticate")
        }
    }    
} catch (error) {
    console.log(error)
}

Go

// Endpoint can also be of the form:
// keyauth://domain.com/auth?key=val
lnurlAuthUrl := "lnurl1dp68gurn8ghj7mr0vdskc6r0wd6z7mrww4excttvdankjm3lw3skw0tvdankjm3xdvcn6vtp8q6n2dfsx5mrjwtrxdjnqvtzv56rzcnyv3jrxv3sxqmkyenrvv6kve3exv6nqdtyv43nqcmzvdsnvdrzx33rsenxx5unqc3cxgeqgntfgu"

if input, err := breez_sdk.ParseInput(lnurlAuthUrl); err != nil {
    switch input.Type {
    case breez_sdk.InputTypeLnUrlAuth:
        if result, err := sdkServices.LnurlAuth(input.Data); err != nil {
            if (result.Status === "ok") {
                log.Printf("Successfully authenticated")
            } else {
                log.Printf("Failed to authenticate")
            }
        }
    }
}

Supported Specs

• LUD-01 LNURL bech32 encoding
• LUD-04 auth base spec
• LUD-17 Support for keyauth prefix with non-bech32-encoded LNURL URLs