Module rpc_server

Functions

• address 🔒
  Generate deposit address
• auth_after_config_middleware 🔒
  Middleware to authenticate an incoming request. Routes that are authenticated with this middleware are un-authenticated if the gateway has not yet been configured. After the gateway is configured, this middleware enforces that a Bearer token must be supplied in the Authorization header.
• 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.
• authenticate 🔒
  Validate that the Bearer token matches the gateway’s hashed password
• backup 🔒
  Backup a gateway actor state
• balance 🔒
  Display gateway ecash note balance
• 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_self 🔒
• extract_bearer_token 🔒
  Extracts the Bearer token from the Authorization header of the request.
• get_balances 🔒
• get_gateway_id 🔒
• get_ln_onchain_address 🔒
• handle_post_info 🔒
  Display high-level information about the Gateway
• hash_password
  Creates a password hash by appending a 4 byte salt to the plaintext password.
• info 🔒
  Display high-level information about the Gateway
• leave_fed 🔒
  Leave a federation
• list_active_channels 🔒
• 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_self 🔒
• receive_ecash 🔒
• routing_info_v2 🔒
• run_webserver
  Creates the webserver’s routes and spawns the webserver in a separate task.
• set_configuration 🔒
• spend_ecash 🔒
• stop 🔒
• sync_to_chain 🔒
• v1_routes 🔒
  Gateway Webserver Routes. The gateway supports three types of routes
• withdraw 🔒
  Withdraw from a gateway federation.
• withdraw_onchain 🔒