Safe Haskell	None
Language	Haskell2010

LnUrl.Pay

Contents

Client
Server
Types

Description

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

Workflow

LN WALLET decodes URL using getPayURL and makes a GET request.
LN SERVICE responds with Response SuccessResponse.
LN WALLET get parameters from the user.
LN WALLET prepare a callback URL using getCallbackUrl.
LN SERVICE responds with Response CallbackSuccessResponse.
LN WALLET verifies: (a) h tag in paymentRequest is SHA256(metadata), (b) the amount in paymentRequest matches the requested amount, and (c) signatures on ChannelUpdate messages.
LN WALLET pays invoice.
LN WALLET after paying the invoice, execute the successAction if defined.

Synopsis

getPayURL :: URI -> URI
getCallbackUrl :: SuccessResponse -> Word64 -> Maybe ByteString -> [NodeId] -> Maybe Text -> Maybe PubKey -> Maybe URI
decrypt :: ByteString -> AesAction -> Either AesError ByteString
encrypt :: ByteString -> Text -> ByteString -> IO (Either AesError AesAction)
data Response a
- = Success a
- | ErrorResponse Text
data SuccessResponse = SuccessResponse {
- callback :: URI
- maxSendable :: Word64
- minSendable :: Word64
- metadata :: [Metadata]
- commentAllowed :: Maybe Int
}
data Metadata
- = PlainText Text
- | ImagePNG ByteString
- | ImageJPEG ByteString
- | Email Text
- | Ident Text
data CallbackSuccessResponse = CallbackSuccessResponse {
- paymentRequest :: Text
- successAction :: Maybe SuccessAction
- disposable :: Bool
- routes :: [[Hop]]
}
data Hop = Hop {
- nodeId :: Text
- channelUpdate :: ByteString
}
data SuccessAction
- = Url UrlAction
- | Message Text
- | Aes AesAction
data UrlAction = UrlAction {
- urlDescription :: Text
- url :: URI
}
data AesAction = AesAction {
- aesDescription :: Text
- ciphertext :: ByteString
- iv :: ByteString
}
data AesError
- = KeyError
- | IvError
- | PaddingError

Client

getPayURL :: URI -> URI Source #

Apply the LNURL-pay uri transform logic. LN SERVICE should respond to the resulting URL with Response.

getCallbackUrl Source #

Arguments

:: SuccessResponse
-> Word64	amount (millisatoshis)
-> Maybe ByteString	cache prevention
-> [NodeId]	starting points (node ids)
-> Maybe Text	comment
-> Maybe PubKey	proof of payer
-> Maybe URI

Prepare a callback url to use to retrieve the payment request

decrypt Source #

Arguments

:: ByteString	Payment preimage
-> AesAction
-> Either AesError ByteString

Use the payment preimage to get the encrypted payload

Server

encrypt Source #

Arguments

:: ByteString	Payment preimage
-> Text	Description
-> ByteString	Message to encrypt
-> IO (Either AesError AesAction)

Use the payment preimage to build an encrypted payload

Types

data Response a Source #

Constructors

Success a
ErrorResponse Text

Instances

Instances details

Eq a => Eq (Response a) Source #
Instance details Defined in LnUrl Methods (==) :: Response a -> Response a -> Bool # (/=) :: Response a -> Response a -> Bool #
Show a => Show (Response a) Source #
Instance details Defined in LnUrl Methods showsPrec :: Int -> Response a -> ShowS # show :: Response a -> String # showList :: [Response a] -> ShowS #
ToJSON a => ToJSON (Response a) Source #
Instance details Defined in LnUrl Methods toJSON :: Response a -> Value # toEncoding :: Response a -> Encoding # toJSONList :: [Response a] -> Value # toEncodingList :: [Response a] -> Encoding #
FromJSON a => FromJSON (Response a) Source #
Instance details Defined in LnUrl Methods parseJSON :: Value -> Parser (Response a) # parseJSONList :: Value -> Parser [Response a] #

data SuccessResponse Source #

Constructors

SuccessResponse
Fields callback :: URI maxSendable :: Word64 millisatoshi minSendable :: Word64 millisatoshi metadata :: [Metadata] commentAllowed :: Maybe Int

Instances

Instances details

Eq SuccessResponse Source #
Instance details Defined in LnUrl.Pay Methods (==) :: SuccessResponse -> SuccessResponse -> Bool # (/=) :: SuccessResponse -> SuccessResponse -> Bool #
Show SuccessResponse Source #
Instance details Defined in LnUrl.Pay Methods showsPrec :: Int -> SuccessResponse -> ShowS # show :: SuccessResponse -> String # showList :: [SuccessResponse] -> ShowS #
ToJSON SuccessResponse Source #
Instance details Defined in LnUrl.Pay Methods toJSON :: SuccessResponse -> Value # toEncoding :: SuccessResponse -> Encoding # toJSONList :: [SuccessResponse] -> Value # toEncodingList :: [SuccessResponse] -> Encoding #
FromJSON SuccessResponse Source #
Instance details Defined in LnUrl.Pay Methods parseJSON :: Value -> Parser SuccessResponse # parseJSONList :: Value -> Parser [SuccessResponse] #

data Metadata Source #

The metadata array

Must contain a PlainText value
May contain at most one of ImagePNG or ImageJPEG
May contain at most one of Email or Ident

Constructors

PlainText Text
ImagePNG ByteString
ImageJPEG ByteString
Email Text
Ident Text

Instances

Instances details

Eq Metadata Source #
Instance details Defined in LnUrl.Pay Methods (==) :: Metadata -> Metadata -> Bool # (/=) :: Metadata -> Metadata -> Bool #
Show Metadata Source #
Instance details Defined in LnUrl.Pay Methods showsPrec :: Int -> Metadata -> ShowS # show :: Metadata -> String # showList :: [Metadata] -> ShowS #
ToJSON Metadata Source #
Instance details Defined in LnUrl.Pay Methods toJSON :: Metadata -> Value # toEncoding :: Metadata -> Encoding # toJSONList :: [Metadata] -> Value # toEncodingList :: [Metadata] -> Encoding #
FromJSON Metadata Source #
Instance details Defined in LnUrl.Pay Methods parseJSON :: Value -> Parser Metadata # parseJSONList :: Value -> Parser [Metadata] #

data CallbackSuccessResponse Source #

Constructors

CallbackSuccessResponse
Fields paymentRequest :: Text successAction :: Maybe SuccessAction disposable :: Bool routes :: [[Hop]]

Instances

Instances details

Eq CallbackSuccessResponse Source #
Instance details Defined in LnUrl.Pay Methods (==) :: CallbackSuccessResponse -> CallbackSuccessResponse -> Bool # (/=) :: CallbackSuccessResponse -> CallbackSuccessResponse -> Bool #
Show CallbackSuccessResponse Source #
Instance details Defined in LnUrl.Pay Methods showsPrec :: Int -> CallbackSuccessResponse -> ShowS # show :: CallbackSuccessResponse -> String # showList :: [CallbackSuccessResponse] -> ShowS #
ToJSON CallbackSuccessResponse Source #
Instance details Defined in LnUrl.Pay Methods toJSON :: CallbackSuccessResponse -> Value # toEncoding :: CallbackSuccessResponse -> Encoding # toJSONList :: [CallbackSuccessResponse] -> Value # toEncodingList :: [CallbackSuccessResponse] -> Encoding #
FromJSON CallbackSuccessResponse Source #
Instance details Defined in LnUrl.Pay Methods parseJSON :: Value -> Parser CallbackSuccessResponse # parseJSONList :: Value -> Parser [CallbackSuccessResponse] #

data Hop Source #

Constructors

Hop
Fields nodeId :: Text channelUpdate :: ByteString

Instances

Instances details

Eq Hop Source #
Instance details Defined in LnUrl.Pay Methods (==) :: Hop -> Hop -> Bool # (/=) :: Hop -> Hop -> Bool #
Show Hop Source #
Instance details Defined in LnUrl.Pay Methods showsPrec :: Int -> Hop -> ShowS # show :: Hop -> String # showList :: [Hop] -> ShowS #
ToJSON Hop Source #
Instance details Defined in LnUrl.Pay Methods toJSON :: Hop -> Value # toEncoding :: Hop -> Encoding # toJSONList :: [Hop] -> Value # toEncodingList :: [Hop] -> Encoding #
FromJSON Hop Source #
Instance details Defined in LnUrl.Pay Methods parseJSON :: Value -> Parser Hop # parseJSONList :: Value -> Parser [Hop] #

data SuccessAction Source #

Constructors

Url UrlAction
Message Text
Aes AesAction

Instances

Instances details

Eq SuccessAction Source #
Instance details Defined in LnUrl.Pay Methods (==) :: SuccessAction -> SuccessAction -> Bool # (/=) :: SuccessAction -> SuccessAction -> Bool #
Show SuccessAction Source #
Instance details Defined in LnUrl.Pay Methods showsPrec :: Int -> SuccessAction -> ShowS # show :: SuccessAction -> String # showList :: [SuccessAction] -> ShowS #
ToJSON SuccessAction Source #
Instance details Defined in LnUrl.Pay Methods toJSON :: SuccessAction -> Value # toEncoding :: SuccessAction -> Encoding # toJSONList :: [SuccessAction] -> Value # toEncodingList :: [SuccessAction] -> Encoding #
FromJSON SuccessAction Source #
Instance details Defined in LnUrl.Pay Methods parseJSON :: Value -> Parser SuccessAction # parseJSONList :: Value -> Parser [SuccessAction] #

data UrlAction Source #

Constructors

UrlAction
Fields urlDescription :: Text url :: URI

Instances

Instances details

Eq UrlAction Source #
Instance details Defined in LnUrl.Pay Methods (==) :: UrlAction -> UrlAction -> Bool # (/=) :: UrlAction -> UrlAction -> Bool #
Show UrlAction Source #
Instance details Defined in LnUrl.Pay Methods showsPrec :: Int -> UrlAction -> ShowS # show :: UrlAction -> String # showList :: [UrlAction] -> ShowS #

data AesAction Source #

Constructors

AesAction
Fields aesDescription :: Text ciphertext :: ByteString iv :: ByteString

Instances

Instances details

Eq AesAction Source #
Instance details Defined in LnUrl.Pay Methods (==) :: AesAction -> AesAction -> Bool # (/=) :: AesAction -> AesAction -> Bool #
Show AesAction Source #
Instance details Defined in LnUrl.Pay Methods showsPrec :: Int -> AesAction -> ShowS # show :: AesAction -> String # showList :: [AesAction] -> ShowS #

data AesError Source #

Constructors

KeyError
IvError
PaddingError

Instances

Instances details

Eq AesError Source #
Instance details Defined in LnUrl.Pay Methods (==) :: AesError -> AesError -> Bool # (/=) :: AesError -> AesError -> Bool #
Show AesError Source #
Instance details Defined in LnUrl.Pay Methods showsPrec :: Int -> AesError -> ShowS # show :: AesError -> String # showList :: [AesError] -> ShowS #
Exception AesError Source #
Instance details Defined in LnUrl.Pay Methods toException :: AesError -> SomeException # fromException :: SomeException -> Maybe AesError # displayException :: AesError -> String #