Functions§
- address 🔒
- Generate deposit address
- auth_
middleware 🔒 - Middleware to authenticate an incoming request. Routes that are authenticated with this middleware always require a Bearer token to be supplied in the Authorization header.
- backup 🔒
- Backup a gateway actor state
- close_
channels_ 🔒with_ peer - configuration 🔒
- Display high-level information about the Gateway config
- connect_
fed 🔒 - Connect a new federation
- create_
bolt11_ 🔒invoice_ v2 - create_
invoice_ 🔒for_ operator - create_
offer_ 🔒for_ operator - extract_
bearer_ 🔒token - Extracts the Bearer token from the Authorization header of the request.
- get_
balances 🔒 - get_
gateway_ 🔒id - get_
invoice 🔒 - get_
ln_ 🔒onchain_ address - info 🔒
- Display high-level information about the Gateway
- leave_
fed 🔒 - Leave a federation
- list_
channels 🔒 - list_
transactions 🔒 - lnv1_
routes 🔒 - Public routes that are used in the LNv1 protocol
- lnv2_
routes 🔒 - Public routes that are used in the LNv2 protocol
- mnemonic 🔒
- open_
channel 🔒 - pay_
bolt11_ 🔒invoice_ v2 - pay_
invoice 🔒 - pay_
invoice_ 🔒operator - pay_
offer_ 🔒operator - payment_
log 🔒 - payment_
summary 🔒 - receive_
ecash 🔒 - recheck_
address 🔒 - register_
get_ 🔒handler - Registers a GET API handler for both the HTTP server and the Iroh
Endpoint. - register_
post_ 🔒handler - Registers a POST API handler for both the HTTP server and the Iroh
Endpoint. - routes 🔒
- Gateway Webserver Routes. The gateway supports two types of routes
- routing_
info_ 🔒v2 - run_
webserver - Creates the webserver’s routes and spawns the webserver in a separate task.
- send_
onchain 🔒 - set_
fees 🔒 - spend_
ecash 🔒 - stop 🔒
- verify_
bolt11_ 🔒preimage_ v2_ get - withdraw 🔒
- Withdraw from a gateway federation.