LnUrl.Withdraw

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

Workflow

1. LN WALLET makes GET request
2. LN SERVICE responds with Response SuccessResponse.
3. LN WALLET get withdrawal amount from user.
4. LN WALLET prepare and make GET request using getCallbackURL.
5. LN SERVICE responds with AckResponse.

Client

getCallbackURL

Arguments

:: SuccessResponse

-> Text

-> Maybe URI

URL where LN SERVICE can POST SuccessResponse values to notify the wallet

-> URI

Use the first response to build the callback url

Types

data Response a

Constructors

Success a

ErrorResponse Text

Instances

Eq a => Eq (Response a)

Defined in LnUrl

Methods

(==) :: Response a -> Response a -> Bool

(/=) :: Response a -> Response a -> Bool

Show a => Show (Response a)

Defined in LnUrl

Methods

showsPrec :: Int -> Response a -> ShowS

show :: Response a -> String

showList :: [Response a] -> ShowS

ToJSON a => ToJSON (Response a)

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)

Defined in LnUrl

Methods

parseJSON :: Value -> Parser (Response a)

parseJSONList :: Value -> Parser [Response a]

data SuccessResponse

The initial GET request responds with Response SuccessResponse

Constructors

SuccessResponse

Fields

• callback :: URI
• challenge :: Text
• defaultDescription :: Text
• minWithdrawable :: Word64

  millisatoshis

• maxWithdrawable :: Word64

  millisatoshis

• balanceCheck :: Maybe URI

  URL to use to make a subsequent LNURL-withdraw request, response with SuccessResponse

Instances

Eq SuccessResponse

Defined in LnUrl.Withdraw

Methods

(==) :: SuccessResponse -> SuccessResponse -> Bool

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

Show SuccessResponse

Defined in LnUrl.Withdraw

Methods

showsPrec :: Int -> SuccessResponse -> ShowS

show :: SuccessResponse -> String

showList :: [SuccessResponse] -> ShowS

ToJSON SuccessResponse

Defined in LnUrl.Withdraw

Methods

toJSON :: SuccessResponse -> Value

toEncoding :: SuccessResponse -> Encoding

toJSONList :: [SuccessResponse] -> Value

toEncodingList :: [SuccessResponse] -> Encoding

FromJSON SuccessResponse

Defined in LnUrl.Withdraw

Methods

parseJSON :: Value -> Parser SuccessResponse

parseJSONList :: Value -> Parser [SuccessResponse]

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]