LnUrl.Channel

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

Workflow

1. LN SERVICE provides a URL for LNURL-channel.
2. LN WALLET makes a GET request to this URL.
3. LN SERVICE responds with Response SuccessResponse.
4. LN WALLET connects to the node at remoteNode.
5. LN WALLET prepare and make a GET request using proceed (followed possibly by cancel).
6. LN SERVICE responds with AckResponse.
7. LN WALLET awaits an OpenChannel message.

Client

proceed :: SuccessResponse -> NodeId -> Bool -> URI

Create the URL for the follow up LNURL-channel request. LN SERVICE responds with AckResponse.

cancel :: SuccessResponse -> NodeId -> URI

Create the URL to cancel a LNURL-channel request. LN SERVICE responds with AckResponse.

Types

type NodeId = ByteString

data SuccessResponse

LN SERVICE responds with Response SuccessResponse

Constructors

SuccessResponse

Fields

• remoteNode :: ByteString

  Remote node URI

• callback :: URI

  Service URL

• k1 :: ByteString

  Wallet identifier

Instances

Eq SuccessResponse

Defined in LnUrl.Channel

Methods

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

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

Show SuccessResponse

Defined in LnUrl.Channel

Methods

showsPrec :: Int -> SuccessResponse -> ShowS

show :: SuccessResponse -> String

showList :: [SuccessResponse] -> ShowS

ToJSON SuccessResponse

Defined in LnUrl.Channel

Methods

toJSON :: SuccessResponse -> Value

toEncoding :: SuccessResponse -> Encoding

toJSONList :: [SuccessResponse] -> Value

toEncodingList :: [SuccessResponse] -> Encoding

FromJSON SuccessResponse

Defined in LnUrl.Channel

Methods

parseJSON :: Value -> Parser SuccessResponse

parseJSONList :: Value -> Parser [SuccessResponse]

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 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]