Structs§
- Config
- Credentials
Credentialsis a container fornode_id, the mTLS client certificate used to authenticate a client against a node, as well as the seed secret if present. If no seed is present in the credentials, then theClientwill not start a signer in the background.- Developer
Cert - A developer certificate obtained from the Greenlight Developer
Console (GDC). When provided to a
Schedulerviawith_developer_cert(), nodes registered through that scheduler will be associated with the developer’s account. - Fund
Channel - Fund
Output - GetInfo
Response - Handle
- A handle to interact with a signer loop running and processing requests in the background. Used primarily to stop the loop and exiting the signer.
- Invoice
- Invoice
Paid Event - Details of a paid invoice.
- List
Funds Response - List
Invoices Response - List
Payments Request - List
Pays Response - List
Peer Channels Response - List
Peers Response - Node
- The
Nodeis an RPC stub representing the node running in the cloud. It is the main entrypoint to interact with the node. - Node
Event Stream - A stream of node events. Call
next()to receive the next event. - Onchain
Receive Response - A pair of on-chain addresses for receiving funds.
- Onchain
Send Response - Result of an on-chain send. The transaction has already been broadcast.
- Parsed
Invoice - Parsed BOLT11 invoice with extracted fields.
- Pay
- Payment
- Peer
- Peer
Channel - Receive
Response - Scheduler
- Send
Response - Signer
Enums§
- Channel
State - Error
- Input
Type - The result of parsing user input.
- Invoice
Status - List
Index - Index field used by CLN’s paginated list RPCs.
- Network
- Node
Event - A real-time event from the node.
- Output
Status - PayStatus
- Payment
Status - Payment
Type - Payment
Type Filter
Functions§
- connect
- Connect to an existing Greenlight node using previously saved credentials.
- parse_
input - Parse a string and identify whether it’s a BOLT11 invoice or a node ID.
- recover
- Recover credentials for an existing Greenlight node and return a connected Node.
- register
- Register a new Greenlight node and return a connected Node with signer running.
- register_
or_ recover - Try to recover an existing node; if none exists, register a new one.