A class representing a client to interact with lnd.
Creates an lnd client.
The identifier for the chain this lnd instance is using in the format [chain]-[network] like "bitcoin-testnet"
The identity pub key for this lnd instance.
The path to the lnd admin macaroon, will be undefined if
nomacaroons is enabled
The maximum time to wait for a client to be ready for making grpc calls, can be used for exponential backoff.
List of client's public listening uris that are advertised to the network
Time in milliseconds between attempts to recheck connectivity to the client.
Waits for the lnd wallet to be initialized and for its macaroons to be created then attempts to verify the connection to lnd.
Builds a lndrpc.SendRequest
Ends all connections, subscriptions, and timers for for this client.
Closes any payment channels with a specified node.
A synchronous helper method for the closeChannel call
Connects to another lnd node.
Tries to connect to a given list of a peer's uris in sequential order.
true when successful, otherwise
Lnd specific procedure to disconnect from the server.
Returns closed channels that this node was a participant in.
Returns general information concerning the lightning node including it’s identity pubkey, alias, the chains it is connected to, and information concerning the number of open+pending channels.
Initializes the client for calls to lnd and verifies that we can connect to it.
true if the client is enabled and configured properly.
Lists all open channels for this node.
Lnd specific procedure to mark the client as locked.
Gets a new address for the internal lnd wallet.
Opens a channel given peerPubKey and amount.
Opens a channel with a connected lnd node.
Lists all pending channels for this node.
Lists all routes to destination.
Sends a payment through the Lightning Network.
the preimage in hex format
Lnd specific procedure to mark the client as unlocked.
Subscribes to channel backups
Updates all balances related to channels including active, inactive, and pending balances. Sets trading limits for this client accordingly.
Returns the total of unspent outputs for the internal lnd wallet.
Watches for a change in the admin.macaroon file at the configured path, then loads the macaroon.
Generated using TypeDoc