LnUrl.Auth

See https://github.com/fiatjaf/lnurl-rfc/blob/master/lnurl-auth.md.

Workflow

1. LN SERVICE Use mkAuthUrl to generate.
2. LN WALLET Decode LNURL and parse with parseAuthUrl.
3. LN WALLET Display AuthUrl details and get consent from user to authorize.
4. LN WALLET Use getSignedCallback to prepare follow-up GET request
5. LN SERVICE Responds with AckResponse.

Server

mkAuthUrl :: URI -> Msg -> Maybe Action -> URI

Add the challenge and action parameters to a URI

Client

parseAuthUrl :: String -> Maybe AuthUrl

Attempt to interpret a URL as an LNURL-auth URL

authDomain :: AuthUrl -> String

getSignedCallback

Arguments

:: XPrvKey

Root key

-> AuthUrl

-> URI

Callback url with client-provided LNURL-auth paramaters

Use the linking key to sign a challenge

Types

data AuthUrl

Constructors

AuthUrl

Fields

• uri :: URI
• k1 :: Msg
• action :: Maybe Action

Instances

Eq AuthUrl

Defined in LnUrl.Auth

Methods

(==) :: AuthUrl -> AuthUrl -> Bool

(/=) :: AuthUrl -> AuthUrl -> Bool

Show AuthUrl

Defined in LnUrl.Auth

Methods

showsPrec :: Int -> AuthUrl -> ShowS

show :: AuthUrl -> String

showList :: [AuthUrl] -> ShowS

data Action

Constructors

Register

Login

Link

Auth

Instances

Eq Action

Defined in LnUrl.Auth

Methods

(==) :: Action -> Action -> Bool

(/=) :: Action -> Action -> Bool

Show Action

Defined in LnUrl.Auth

Methods

showsPrec :: Int -> Action -> ShowS

show :: Action -> String

showList :: [Action] -> ShowS

actionText :: Action -> Text

parseAction :: Text -> Maybe Action

data AckResponse

Constructors

AckSuccess

AckError Text

Instances

Eq AckResponse

Defined in LnUrl

Methods

(==) :: AckResponse -> AckResponse -> Bool

(/=) :: AckResponse -> AckResponse -> Bool

Show AckResponse

Defined in LnUrl

Methods

showsPrec :: Int -> AckResponse -> ShowS

show :: AckResponse -> String

showList :: [AckResponse] -> ShowS

ToJSON AckResponse

Defined in LnUrl

Methods

toJSON :: AckResponse -> Value

toEncoding :: AckResponse -> Encoding

toJSONList :: [AckResponse] -> Value

toEncodingList :: [AckResponse] -> Encoding

FromJSON AckResponse

Defined in LnUrl

Methods

parseJSON :: Value -> Parser AckResponse

parseJSONList :: Value -> Parser [AckResponse]

Utilities

deriveLinkingKey

Arguments

:: XPrvKey

-> ByteString

domain

-> SecKey

Derive the linking key from the domain

deriveLinkingPubKey

Arguments

:: XPrvKey

-> ByteString

domain

-> PubKey

Derive a public signing key