Tonic LND

https://docs.rs/tonic_lnd/latest/
Admin
A Rust implementation of an LND RPC client that uses the async GRPC library `tonic` and `prost` for...
Tokens:1,660,028
Snippets:9,989
Trust Score:9.7
Update:8 months ago
Show doc for...
Tokens:
Raw
### Connect to LND and Get Info (Rust)

Source: https://docs.rs/tonic_lnd/latest/index

Demonstrates how to connect to an LND instance using provided address, certificate file, and macaroon file, and then retrieve basic node information using the `get_info` call. This example requires the `tokio` runtime.

```rust
use std::env;

#[tokio::main]
async fn main() {
    let mut args = env::args_os();
    args.next().expect("not even zeroth arg given");
    let address = args.next().expect("missing arguments: address, cert file, macaroon file");
    let cert_file = args.next().expect("missing arguments: cert file, macaroon file");
    let macaroon_file = args.next().expect("missing argument: macaroon file");
    let address = address.into_string().expect("address is not UTF-8");

    // Connecting to LND requires only address, cert file, and macaroon file
    let mut client = tonic_lnd::connect(address, cert_file, macaroon_file)
        .await
        .expect("failed to connect");

    let info = client
        .lightning()
        // All calls require at least empty parameter
        .get_info(tonic_lnd::lnrpc::GetInfoRequest {{}})
        .await
        .expect("failed to get info");

    // We only print it here, note that in real-life code you may want to call `.into_inner()` on
    // the response to get the message.
    println!("{{:#?}}", info);
}
```

--------------------------------

### Rust Example Searches

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/walletrpc/fund_psbt_request/enum.Template_search=

These are example search queries demonstrating common Rust patterns and type signatures. They are useful for understanding how to search for specific functionalities or types within Rust codebases.

```rust
std::vec
```

```rust
u32 -> bool
```

```rust
Option<T>, (T -> U) -> Option<U>
```

--------------------------------

### Connect to LND RPC and Get Info (Rust)

Source: https://docs.rs/tonic_lnd/latest/src/tonic_lnd/lib.rs_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Demonstrates how to establish a connection to an LND node using its address, certificate file, and macaroon file. It then shows how to retrieve general information about the LND node using the `get_info` call. This example requires the `tokio` runtime and the `tonic_lnd` crate.

```rust
#![doc = r###"
Rust implementation of LND RPC client using async GRPC library `tonic`.

## About

**Warning: this crate is in early development and may have unknown problems!
Review it before using with mainnet funds!**

This crate implements LND GRPC using [`tonic`](https://docs.rs/tonic/) and [`prost`](https://docs.rs/prost/).
Apart from being up-to-date at the time of writing (:D) it also allows `aync` usage.
It contains vendored `rpc.proto` file so LND source code is not *required*
but accepts an environment variable `LND_REPO_DIR` which overrides the vendored `rpc.proto` file.
This can be used to test new features in non-released `lnd`.
(Actually, the motivating project using this library is that case. :))

## Usage

There's no setup needed beyond adding the crate to your `Cargo.toml`.
If you need to change the `rpc.proto` input set the environment variable `LND_REPO_DIR` to the directory with cloned `lnd` during build.

Here's an example of retrieving information from LND (`getinfo` call).
You can find the same example in crate root for your convenience.

```no_run
// This program accepts three arguments: address, cert file, macaroon file
// The address must start with `https://`!

#[tokio::main]
async fn main() {
    let mut args = std::env::args_os();
    args.next().expect("not even zeroth arg given");
    let address = args.next().expect("missing arguments: address, cert file, macaroon file");
    let cert_file = args.next().expect("missing arguments: cert file, macaroon file");
    let macaroon_file = args.next().expect("missing argument: macaroon file");
    let address = address.into_string().expect("address is not UTF-8");

    // Connecting to LND requires only address, cert file, and macaroon file
    let mut client = tonic_lnd::connect(address, cert_file, macaroon_file)
        .await
        .expect("failed to connect");

    let info = client
        .lightning()
        // All calls require at least empty parameter
        .get_info(tonic_lnd::lnrpc::GetInfoRequest {{}})
        .await
        .expect("failed to get info");

    // We only print it here, note that in real-life code you may want to call `.into_inner()` on
    // the response to get the message.
    println!("{:#?}", info);
}
```

## MSRV

1.48.0

However some dependencies may need to be downgraded using `cargo update -p <package> --precise <version>`.
`Cargo-msrv.lock` is included for reference - it is the lock file used to test the crate and contains known working versions of dependencies.

The MSRV won't be bumped sooner than Debian Bookworm release.

## License

MITNFA
"###]

/// This is part of public interface so it's re-exported.
pub extern crate tonic;

use std::path::{Path, PathBuf};
use std::convert::TryInto;
pub use error::ConnectError;
use error::InternalConnectError;
use tonic::codegen::InterceptedService;
use tonic::transport::Channel;

#[cfg(feature = "tracing")]
use tracing;

/// Convenience type alias for lightning client.
pub type LightningClient = lnrpc::lightning_client::LightningClient<InterceptedService<Channel, MacaroonInterceptor>>;

/// Convenience type alias for wallet client.
pub type WalletKitClient =
    walletrpc::wallet_kit_client::WalletKitClient<InterceptedService<Channel, MacaroonInterceptor>>;

/// Convenience type alias for peers service client.
pub type PeersClient =
    peersrpc::peers_client::PeersClient<InterceptedService<Channel, MacaroonInterceptor>>;

// Convenience type alias for signer client.
pub type SignerClient = signrpc::signer_client::SignerClient<InterceptedService<Channel, MacaroonInterceptor>>;

/// The client returned by `connect` function
///
/// This is a convenience type which you most likely want to use instead of raw client.
pub struct Client {
    lightning: LightningClient,
    wallet: WalletKitClient,
    signer: SignerClient,
    peers: PeersClient,
}

impl Client {
    /// Returns the lightning client.
    pub fn lightning(&mut self) -> &mut LightningClient {
        &mut self.lightning
    }

    /// Returns the wallet client.
    pub fn wallet(&mut self) -> &mut WalletKitClient {
        &mut self.wallet
    }

    /// Returns the signer client.
    pub fn signer(&mut self) -> &mut SignerClient {
        &mut self.signer
    }

    /// Returns the peers client.
    pub fn peers(&mut self) -> &mut PeersClient {
        &mut self.peers
    }
}

/// [`tonic::Status`] is re-exported as `Error` for convenience.
pub type Error = tonic::Status;

mod error;

macro_rules! try_map_err {
    ($result:expr, $mapfn:expr) => {
        match $result {
            Ok(value) => value,

```

--------------------------------

### Example Searches for Rust Documentation

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/lnrpc/channel_point/enum.FundingTxid_search=

Common example search queries used within the Rust ecosystem, demonstrating type signatures and generic patterns.

```text
* std::vec
* u32 -> bool
* Option<T>, (T -> U) -> Option<U>
```

--------------------------------

### WalletKitClient Initialization and Configuration (Rust)

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.WalletKitClient_search=

Demonstrates how to create a new WalletKitClient instance and configure it with interceptors or compression options. The `new` function takes a gRPC service, while `with_interceptor` adds custom interceptor logic. `send_gzip` and `accept_gzip` control compression.

```rust
pub fn new(inner: T) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> WalletKitClient<InterceptedService<T, F>>
where F: Interceptor,

pub fn send_gzip(self) -> Self

pub fn accept_gzip(self) -> Self
```

--------------------------------

### WalletKitClient Instantiation

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.WalletKitClient_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for creating and configuring a WalletKitClient instance.

```APIDOC
## WalletKitClient Instantiation

### Description
Methods for creating and configuring a WalletKitClient instance.

### `new` Method

#### Description
Creates a new WalletKitClient with the given inner gRPC service.

#### Method
`new`

#### Parameters
- **inner** (T) - The inner gRPC service.

### `with_interceptor` Method

#### Description
Creates a new WalletKitClient with an added interceptor.

#### Method
`with_interceptor`

#### Parameters
- **inner** (T) - The inner gRPC service.
- **interceptor** (F) - The interceptor to apply.

### `send_gzip` Method

#### Description
Configures the client to compress requests with `gzip`. This requires the server to support gzip compression.

#### Method
`send_gzip`

### `accept_gzip` Method

#### Description
Enables the client to decompress responses using `gzip`.

#### Method
`accept_gzip`
```

--------------------------------

### Get Error Cause (Deprecated)

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.Error

A deprecated method for getting the cause of the error. It has been replaced by `Error::source` which supports downcasting.

```rust
fn cause(&self) -> Option<&dyn Error>
```

--------------------------------

### WalletKitClient Initialization

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/walletrpc/wallet_kit_client/struct.WalletKitClient_search=

Methods for creating and configuring a WalletKitClient instance.

```APIDOC
## WalletKitClient Initialization

### Description
Methods for creating and configuring a WalletKitClient instance.

### Methods

#### `connect<D>(dst: D) -> Result<Self, Error>`
Attempt to create a new client by connecting to a given endpoint.

**Parameters**

*   `dst` (Endpoint) - The endpoint to connect to.

#### `new(inner: T) -> Self`
Creates a new WalletKitClient with the given inner service.

**Parameters**

*   `inner` (T) - The inner gRPC service.

#### `with_interceptor<F>(inner: T, interceptor: F) -> WalletKitClient<InterceptedService<T, F>>`
Creates a new WalletKitClient with an interceptor.

**Parameters**

*   `inner` (T) - The inner gRPC service.
*   `interceptor` (F) - The interceptor function.

#### `send_gzip(self) -> Self`
Compress requests with `gzip`. This requires the server to support it otherwise it might respond with an error.

#### `accept_gzip(self) -> Self`
Enable decompressing responses with `gzip`.
```

--------------------------------

### LightningClient - Initialization and Configuration

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.LightningClient_search=std%3A%3Avec

Methods for initializing and configuring the Lightning client.

```APIDOC
## LightningClient Initialization and Configuration

### `new(inner: T)`

#### Description
Creates a new `LightningClient` instance.

#### Method
`new`

#### Parameters
- `inner` (T) - The underlying gRPC service.

### `with_interceptor<F>(inner: T, interceptor: F)`

#### Description
Creates a new `LightningClient` instance with a custom interceptor.

#### Method
`with_interceptor`

#### Parameters
- `inner` (T) - The underlying gRPC service.
- `interceptor` (F) - The interceptor to apply.

### `send_gzip(self)`

#### Description
Configures the client to compress requests with `gzip`. This requires the server to support gzip compression.

#### Method
`send_gzip`

### `accept_gzip(self)`

#### Description
Enables the client to decompress responses using `gzip`.

#### Method
`accept_gzip`
```

--------------------------------

### Get Error Description (Deprecated)

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.Error

A deprecated method for getting a description of the error. It is recommended to use the Display implementation or `to_string()` instead.

```rust
fn description(&self) -> &str
```

--------------------------------

### Create WalletKitClient Instance

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/walletrpc/wallet_kit_client/struct.WalletKitClient_search=

Provides methods for creating and configuring a WalletKitClient. This includes connecting to a gRPC endpoint, creating a client from an existing channel, and adding interceptors or enabling gzip compression.

```rust
pub async fn connect<D>(dst: D) -> Result<Self, Error>
where D: TryInto<Endpoint>, D::Error: Into<StdError>
```

```rust
pub fn new(inner: T) -> Self
where T: GrpcService<BoxBody>
```

```rust
pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> WalletKitClient<InterceptedService<T, F>>
where F: Interceptor, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync
```

```rust
pub fn send_gzip(self) -> Self
```

```rust
pub fn accept_gzip(self) -> Self
```

--------------------------------

### Get and Set close_type for ChannelCloseSummary in Rust

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/lnrpc/struct.ChannelCloseSummary

Provides methods to get and set the `close_type` field of the ChannelCloseSummary struct. These methods handle potential invalid enum values by returning the default.

```rust
pub fn close_type(&self) -> ClosureType
Returns the enum value of `close_type`, or the default if the field is set to an invalid enum value.
Source
#### pub fn set_close_type(&mut self, value: ClosureType)
Sets `close_type` to the provided enum value.
Source
```

--------------------------------

### WalletKitClient - Constructor and Configuration

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.WalletKitClient_search=u32+-%3E+bool

Provides details on how to create and configure a WalletKitClient instance.

```APIDOC
## WalletKitClient Implementations

### `new`

#### Description
Creates a new WalletKitClient instance.

#### Method
`new`

#### Parameters
* `inner` (T) - The underlying gRPC service.

### `with_interceptor`

#### Description
Creates a new WalletKitClient instance with a custom interceptor.

#### Method
`with_interceptor`

#### Parameters
* `inner` (T) - The underlying gRPC service.
* `interceptor` (F) - The interceptor function.

### `send_gzip`

#### Description
Configures the client to compress requests with `gzip`. This requires the server to support gzip compression.

#### Method
`send_gzip`

### `accept_gzip`

#### Description
Configures the client to decompress responses with `gzip`.

#### Method
`accept_gzip`
```

--------------------------------

### Get Dest Features from SendRequest in Rust

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/lnrpc/struct.SendRequest

Provides a method to get an iterator over the valid enum values contained in the `dest_features` field of a SendRequest. This allows for easy inspection of the destination's supported features.

```rust
pub fn dest_features(&self) -> FilterMap<Cloned<Iter<'_, i32>>, fn(i32) -> Option<FeatureBit>> {
    // ... implementation details ...
}
```

--------------------------------

### Initialize WalletKitClient (Rust)

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.WalletKitClient_search=std%3A%3Avec

Provides methods to create a new WalletKitClient instance. It can be initialized directly or with an interceptor for custom request handling.

```rust
pub fn new(inner: T) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> WalletKitClient<InterceptedService<T, F>>
where F: Interceptor,
```

--------------------------------

### Get Node and Recovery Information in LND

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/lnrpc/lightning_client/struct.LightningClient_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Retrieve general information about the lightning node, including its identity, alias, connected chains, and channel statistics. Also, get information about the node's recovery mode status and progress.

```rust
pub async fn get_info( &mut self, request: impl IntoRequest<GetInfoRequest>, ) -> Result<Response<GetInfoResponse>, Status>
lncli: `getinfo`
```

```rust
pub async fn get_recovery_info( &mut self, request: impl IntoRequest<GetRecoveryInfoRequest>, ) -> Result<Response<GetRecoveryInfoResponse>, Status>
  * lncli: `getrecoveryinfo`
```

--------------------------------

### GET /channels/closed

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.LightningClient_search=

Returns a description of all closed channels the node was a participant in.

```APIDOC
## GET /channels/closed

### Description
ClosedChannels returns a description of all the closed channels that this node was a participant in.

### Method
GET

### Endpoint
/channels/closed

### Parameters
#### Query Parameters
- **channel_point** (string) - Optional - Filter closed channels by channel point.
- **remote_pubkey** (string) - Optional - Filter closed channels by remote peer's public key.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **closed_channels** (array) - A list of closed channels.
  - **channel_point** (string) - The channel funding transaction ID and output index.
  - **remote_pubkey** (string) - The public key of the remote peer.
  - **capacity** (integer) - The total capacity of the channel.
  - **close_height** (integer) - The block height at which the channel was closed.
  - **settled_balance** (integer) - The settled balance of the channel.
  - **total_tx_fee** (integer) - The total transaction fee for the channel closure.
  - **amount_per_sat_per_byte** (integer) - The amount per satoshi per byte.
  - **peer_direction** (string) - The direction of the peer connection.

#### Response Example
```json
{
  "closed_channels": [
    {
      "channel_point": "txid:0",
      "remote_pubkey": "03...",
      "capacity": 1000000,
      "close_height": 1000,
      "settled_balance": 500000,
      "total_tx_fee": 10000,
      "amount_per_sat_per_byte": 10,
      "peer_direction": "outbound"
    }
  ]
}
```
```

--------------------------------

### LightningClient Initialization

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/lnrpc/lightning_client/struct.LightningClient_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for creating and configuring a LightningClient instance.

```APIDOC
## LightningClient Initialization

### Description
Methods for creating and configuring a LightningClient instance.

### `new`

#### Description
Creates a new LightningClient with the provided inner service.

#### Method
`new`

#### Parameters
* `inner` (T) - The inner gRPC service.

### `with_interceptor`

#### Description
Creates a new LightningClient with an added interceptor.

#### Method
`with_interceptor`

#### Parameters
* `inner` (T) - The inner gRPC service.
* `interceptor` (F) - The interceptor function.

### `connect`

#### Description
Attempts to create a new LightningClient by connecting to a given endpoint.

#### Method
`connect<D>(dst: D)`

#### Parameters
* `dst` (D) - The destination endpoint to connect to. Must be convertible into an `Endpoint`.

#### Returns
* `Result<Self, Error>` - A `Result` containing the `LightningClient` on success or an `Error` on failure.
```

--------------------------------

### SignerClient Initialization and Configuration

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/signrpc/signer_client/struct.SignerClient_search=std%3A%3Avec

Provides methods for creating a SignerClient instance, either directly or with an interceptor. It also includes methods to enable gzip compression for requests and responses.

```rust
impl<T> SignerClient<T>
where
    T: GrpcService<BoxBody>,
    T::ResponseBody: Body + Send + Sync + 'static,
    T::Error: Into<StdError>,
    <T::ResponseBody as Body>::Error: Into<StdError> + Send,
{
    pub fn new(inner: T) -> Self>

    pub fn with_interceptor<F>(
        inner: T,
        interceptor: F,
    ) -> SignerClient<InterceptedService<T, F>>
    where
        F: Interceptor,
        T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>,
        <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

    pub fn send_gzip(self) -> Self

    pub fn accept_gzip(self) -> Self
}
```

--------------------------------

### GET /channels

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.LightningClient_search=

Returns a description of all open channels the node is participating in.

```APIDOC
## GET /channels

### Description
ListChannels returns a description of all the open channels that this node is a participant in.

### Method
GET

### Endpoint
/channels

### Parameters
#### Query Parameters
- **active_only** (boolean) - Optional - Filter to show only active channels.
- **remote_pubkey** (string) - Optional - Filter channels by remote peer's public key.
- **pending_open_only** (boolean) - Optional - Filter to show only channels that are pending open.

### Request Example
```json
{
  "active_only": true
}
```

### Response
#### Success Response (200)
- **channels** (array) - A list of channels.
  - **active** (boolean) - Whether the channel is active.
  - **remote_pubkey** (string) - The public key of the remote peer.
  - **channel_point** (string) - The channel funding transaction ID and output index.
  - **capacity** (integer) - The total capacity of the channel.
  - **local_balance** (integer) - The balance on the local side of the channel.
  - **remote_balance** (integer) - The balance on the remote side of the channel.
  - **unsettled_balance** (integer) - The unsettled balance in the channel.
  - **commit_fee** (integer) - The commitment fee for the channel.
  - **commit_weight** (integer) - The commitment weight for the channel.
  - **fee_per_kw** (integer) - The fee rate per kiloweight.
  - **terminus_conf** (integer) - The number of confirmations required for the funding transaction.
  - **num_updates** (integer) - The number of channel updates.
  - **info** (object) - Additional channel information.

#### Response Example
```json
{
  "channels": [
    {
      "active": true,
      "remote_pubkey": "03...",
      "channel_point": "txid:0",
      "capacity": 1000000,
      "local_balance": 500000,
      "remote_balance": 490000,
      "unsettled_balance": 10000,
      "commit_fee": 5000,
      "commit_weight": 1000,
      "fee_per_kw": 1000,
      "terminus_conf": 6,
      "num_updates": 10,
      "info": {
        "funding_txid": "...",
        "output": 0,
        "peer_direction": "outbound"
      }
    }
  ]
}
```
```

--------------------------------

### PeersClient Initialization

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.PeersClient_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for creating and configuring a new PeersClient instance.

```APIDOC
## PeersClient Initialization

### `new` Method

#### Description
Creates a new PeersClient instance.

#### Method
`pub fn new(inner: T) -> Self`

### `with_interceptor` Method

#### Description
Creates a new PeersClient instance with a custom interceptor.

#### Method
`pub fn with_interceptor<F>(inner: T, interceptor: F) -> PeersClient<InterceptedService<T, F>>`
where F: Interceptor,
T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>,
<T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync
```

--------------------------------

### LightningClient - Get Transactions

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.LightningClient_search=u32+-%3E+bool

Retrieves a list of all known transactions relevant to the wallet.

```APIDOC
## `get_transactions`

### Description
`GetTransactions` returns a list describing all the known transactions relevant to the wallet.

### Method
`POST`

### Endpoint
`/lnrpc.Lightning/GetTransactions`

### Request Body
- **request** (impl IntoRequest<GetTransactionsRequest>) - The request object for `GetTransactions`.

### Response
#### Success Response (200)
- **response** (Response<TransactionDetails>) - The response object containing transaction details.

### Request Example
```json
{
  "example": "GetTransactionsRequest object"
}
```

### Response Example
```json
{
  "example": "TransactionDetails object"
}
```
```

--------------------------------

### Network Information API

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/lnrpc/lightning_client/struct.LightningClient_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Get statistics about the known channel graph.

```APIDOC
## GET /v1/network/info

### Description
Returns basic statistics about the known channel graph from the point of view of the node.

### Method
GET

### Endpoint
/v1/network/info

### Response
#### Success Response (200)
- **NetworkInfo** (object) - Contains network statistics.
  - **graph_diameter** (integer)
  - **avg_channel_size** (string)
  - **num_nodes** (integer)
  - **num_channels** (integer)
  - **total_network_capacity** (string)
  - **avg_payment_routing_fail_rate** (object)
  - **avg_routing_capacity** (string)

#### Response Example
```json
{
  "graph_diameter": 5,
  "avg_channel_size": "1000000",
  "num_nodes": 1000,
  "num_channels": 5000,
  "total_network_capacity": "5000000000",
  "avg_payment_routing_fail_rate": {
    "num_payments": 1000,
    "num_failures": 10
  },
  "avg_routing_capacity": "1000000"
}
```
```

--------------------------------

### GET /list_macaroon_i_ds

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.LightningClient_search=std%3A%3Avec

Lists all root key IDs currently in use.

```APIDOC
## GET /list_macaroon_i_ds

### Description
Returns all root key IDs that are in use.

### Method
GET

### Endpoint
/list_macaroon_i_ds

### Parameters

### Request Example


### Response
#### Success Response (200)
- **root_key_ids** (array) - An array of root key IDs.

#### Response Example
{
  "root_key_ids": ["<key_id1>", "<key_id2>"]
}
```

--------------------------------

### Create PeersClient Instance (Rust)

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.PeersClient

Demonstrates how to create a new instance of the PeersClient. The `new` function takes an inner gRPC service implementation as an argument, allowing for flexible integration with different transport layers.

```rust
pub fn new(inner: T) -> Self
```

--------------------------------

### clone_to_uninit

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/lnrpc/struct.MiddlewareRegistration_search=

This is a nightly-only experimental API that performs copy-assignment from self to dest.

```APIDOC
## unsafe fn clone_to_uninit(&self, dest: *mut u8)

### Description
This is a nightly-only experimental API. Performs copy-assignment from `self` to `dest`.

### Method
`unsafe fn`

### Endpoint
N/A (Method implementation)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None (in-place operation)

#### Response Example
None
```

--------------------------------

### GET /channels/pending

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.LightningClient_search=

Returns a list of all channels currently considered "pending".

```APIDOC
## GET /channels/pending

### Description
PendingChannels returns a list of all the channels that are currently considered “pending”. A channel is pending if it has finished the funding workflow and is waiting for confirmations for the funding txn, or is in the process of closure, either initiated cooperatively or non-cooperatively.

### Method
GET

### Endpoint
/channels/pending

### Parameters
#### Query Parameters
- **peer_pubkey** (string) - Optional - Filter pending channels by peer public key.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **total_limbo_balance** (integer) - The total limbo balance across all pending channels.
- **pending_open_channels** (array) - Channels that are pending open.
  - **channel** (object) - Details of the pending open channel.
    - **remote_pubkey** (string) - The public key of the remote peer.
    - **channel_point** (string) - The channel funding transaction ID and output index.
    - **capacity** (integer) - The total capacity of the channel.
    - **local_balance** (integer) - The balance on the local side of the channel.
    - **remote_balance** (integer) - The balance on the remote side of the channel.
    - **limbo_balance** (integer) - The limbo balance in the channel.
    - **commit_fee** (integer) - The commitment fee for the channel.
    - **commit_weight** (integer) - The commitment weight for the channel.
    - **maturity_height** (integer) - The maturity height of the channel.
    - ** Settled_height** (integer) - The settled height of the channel.
    - **best_height** (integer) - The best height of the channel.
    - **info** (object) - Additional channel information.
- **waiting_close_channels** (array) - Channels that are waiting to close.
  - **channel** (object) - Details of the waiting close channel.
    - **remote_pubkey** (string) - The public key of the remote peer.
    - **channel_point** (string) - The channel funding transaction ID and output index.
    - **capacity** (integer) - The total capacity of the channel.
    - **local_balance** (integer) - The balance on the local side of the channel.
    - **remote_balance** (integer) - The balance on the remote side of the channel.
    - **limbo_balance** (integer) - The limbo balance in the channel.
    - **commit_fee** (integer) - The commitment fee for the channel.
    - **commit_weight** (integer) - The commitment weight for the channel.
    - **fee_per_kw** (integer) - The fee rate per kiloweight.
    - **close_txid** (string) - The transaction ID of the close transaction.
    - **info** (object) - Additional channel information.

#### Response Example
```json
{
  "total_limbo_balance": 10000,
  "pending_open_channels": [
    {
      "channel": {
        "remote_pubkey": "03...",
        "channel_point": "txid:0",
        "capacity": 1000000,
        "local_balance": 500000,
        "remote_balance": 490000,
        "limbo_balance": 10000,
        "commit_fee": 5000,
        "commit_weight": 1000,
        "maturity_height": 100,
        "settled_height": 0,
        "best_height": 100,
        "info": {}
      }
    }
  ],
  "waiting_close_channels": []
}
```
```

--------------------------------

### GET /peers

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.LightningClient_search=

Returns a verbose listing of all currently active peers connected to the node.

```APIDOC
## GET /peers

### Description
ListPeers returns a verbose listing of all currently active peers.

### Method
GET

### Endpoint
/peers

### Parameters
#### Query Parameters
- **latest_error** (boolean) - Optional - Include information about the latest error for each peer.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **peers** (array) - A list of connected peers.
  - **pub_key** (string) - The public key of the peer.
  - **address** (string) - The network address of the peer.
  - **last_ping_time** (integer) - The timestamp of the last ping.
  - **in_bound** (boolean) - Whether the connection is inbound.
  - **ping_time** (integer) - The current ping time.
  - **bytes_sent** (integer) - Total bytes sent to the peer.
  - **bytes_recv** (integer) - Total bytes received from the peer.
  - **features** (object) - Supported features of the peer.

#### Response Example
```json
{
  "peers": [
    {
      "pub_key": "03...",
      "address": "1.2.3.4:8333",
      "last_ping_time": 1678886400,
      "in_bound": true,
      "ping_time": 100,
      "bytes_sent": 10000,
      "bytes_recv": 12000,
      "features": {
        "" : ""
      }
    }
  ]
}
```
```

--------------------------------

### WalletKitClient Initialization

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.WalletKitClient

Provides methods to create new instances of WalletKitClient. `new` takes a gRPC service, while `with_interceptor` allows for custom interceptors to be added.

```rust
pub fn new(inner: T) -> Self
```

```rust
pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> WalletKitClient<InterceptedService<T, F>>
where F: Interceptor,
      T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>,
      <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,
```

--------------------------------

### Instantiate LightningClient in Rust

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/lnrpc/lightning_client/struct.LightningClient

Demonstrates how to create a new LightningClient instance. It can connect to a specified endpoint or be created with an existing gRPC service. The client can also be configured with interceptors and GZIP compression.

```rust
use tonic_lnd::lnrpc::lightning_client::LightningClient;
use tonic_lnd::Endpoint;

// Example of connecting to an endpoint
async fn connect_client() -> Result<LightningClient<tonic::transport::Channel>, Box<dyn std::error::Error>> {
    let dst = Endpoint::new("https://[::1]:10009");
    let client = LightningClient::connect(dst).await?;
    Ok(client)
}

// Example of creating a client with an inner service
fn new_client<T>(inner: T) -> LightningClient<T> {
    LightningClient::new(inner)
}

// Example of creating a client with an interceptor
fn client_with_interceptor<T, F>(inner: T, interceptor: F) -> LightningClient<tonic_middleware::interceptor::InterceptedService<T, F>> 
where
    F: tonic_middleware::interceptor::Interceptor,
{
    LightningClient::with_interceptor(inner, interceptor)
}

// Example of enabling GZIP compression
fn client_with_gzip<T>(client: LightningClient<T>) -> LightningClient<T> {
    client.send_gzip().accept_gzip()
}
```

--------------------------------

### Peers RPC Client

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/peersrpc/peers_client/index_search=

The Peers client provides a service to get information and interact with other nodes in the network.

```APIDOC
## Module peers_client

tonic_lnd::peersrpc

# Module peers_client Copy item path

Source

## Description

Generated client implementations for the Peers service.

## Structs

### PeersClient

Peers is a service that can be used to get information and interact with the other nodes of the network.

### Method

(Not specified in the provided text, but typically would be GET, POST, etc. for specific operations)

### Endpoint

(Not specified in the provided text)

### Parameters

(Not specified in the provided text)

### Request Example

(Not specified in the provided text)

### Response

#### Success Response (200)

(Not specified in the provided text)

#### Response Example

(Not specified in the provided text)
```

--------------------------------

### GET /list_permissions

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.LightningClient_search=std%3A%3Avec

Lists all RPC method URIs and their required macaroon permissions.

```APIDOC
## GET /list_permissions

### Description
Lists all RPC method URIs and their required macaroon permissions to access them.

### Method
GET

### Endpoint
/list_permissions

### Parameters

### Request Example


### Response
#### Success Response (200)
- **permissions** (array) - An array of permission objects.

#### Response Example
{
  "permissions": [{"uri": "/lnrpc.Lightning/GetInfo", "permissions": [{"entity": "info", "action": "read"}]}]
}
```

--------------------------------

### Ownership and Cloning

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/lnrpc/struct.SendCustomMessageRequest_search=u32+-%3E+bool

Explains how to obtain ownership of data and how to clone data using owned and borrowed references.

```APIDOC
## Owned Type

### Description
The resulting type after obtaining ownership.

### Type Alias
`Owned = T`

## `to_owned` Method

### Description
Creates owned data from borrowed data, usually by cloning.

### Method
`to_owned(&self) -> T`

## `clone_into` Method

### Description
Uses borrowed data to replace owned data, usually by cloning.

### Method
`clone_into(&self, target: &mut T)`
```

--------------------------------

### TryFrom and TryInto Traits

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/lnrpc/struct.ChannelBackup

Documentation for the TryFrom and TryInto traits for fallible type conversions.

```APIDOC
## TryFrom<U> for T

### Description
Provides a fallible conversion from type `U` into type `T`.

### Type
`Error = Infallible`

### Method
`try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`

Performs the conversion.

## TryInto<U> for T

### Description
Provides a fallible conversion from type `T` into type `U`.

### Type
`Error = <U as TryFrom<T>>::Error`

### Method
`try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`

Performs the conversion.
```

--------------------------------

### Get Transactions API

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.LightningClient_search=std%3A%3Avec

Retrieve a list of all known transactions relevant to the wallet.

```APIDOC
## Get Transactions

### `get_transactions(&mut self, request: impl IntoRequest<GetTransactionsRequest>) -> Result<Response<TransactionDetails>, Status>`

#### Description
`get_transactions` returns a list describing all the known transactions relevant to the wallet. Corresponds to `lncli: listchaintxns`.

#### Method
`POST` (or relevant gRPC method)

#### Endpoint
`/lnrpc.Lightning/GetTransactions` (example, actual endpoint may vary based on gRPC service definition)

#### Parameters
##### Request Body
- `request` (GetTransactionsRequest) - The request object for fetching transactions.

#### Response
##### Success Response (200)
- `transaction_details` (TransactionDetails) - A collection of transaction details.

#### Response Example
```json
{
  "transactions": [
    {
      "tx_hash": "some_tx_hash",
      "amount": "10000",
      "num_confirmations": 6,
      "block_height": 1000,
      "time_seen": 1678886400
    }
  ]
}
```
```

--------------------------------

### PeersClient

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/peersrpc/peers_client/struct.PeersClient_search=u32+-%3E+bool

The PeersClient service provides methods to get information about and interact with other nodes in the network.

```APIDOC
## Struct PeersClient

tonic_lnd::peersrpc::peers_client

### Description

Peers is a service that can be used to get information and interact with the other nodes of the network.

### Methods

#### `new(inner: T) -> Self`

Creates a new `PeersClient` instance.

#### `with_interceptor<F>(inner: T, interceptor: F) -> PeersClient<InterceptedService<T, F>>`

Creates a new `PeersClient` instance with a custom interceptor.

#### `send_gzip(self) -> Self`

Compress requests with `gzip`. This requires the server to support it otherwise it might respond with an error.

#### `accept_gzip(self) -> Self`

Enable decompressing responses with `gzip`.

#### `connect<D>(dst: D) -> Result<Self, Error>`

Attempt to create a new client by connecting to a given endpoint.

### Endpoint

`/peersrpc.Peers` (gRPC service)

### Request Body (for `update_node_announcement`)

```json
{
  "node_announcement_update": {
    "node": {
      "pub_key": "string",
      "next_required_version": 0,
      "color_snapshot": {
        "rgb_color": "string"
      },
      "alias": "string"
    },
    "initial_height": 0,
    "final_height": 0
  }
}
```

### Response (for `update_node_announcement`)

```json
{
  "node_announcement_update_response": {}
}
```
```

--------------------------------

### Create PeersClient Instance in Rust

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.PeersClient_search=

Demonstrates how to instantiate a PeersClient. The `new` function takes an inner gRPC service implementation, while `with_interceptor` allows adding custom interceptor logic for request modification or handling.

```rust
pub fn new(inner: T) -> Self
```

```rust
pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> PeersClient<InterceptedService<T, F>>
where F: Interceptor,
      T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>,
      <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,
```

--------------------------------

### PeersClient

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/peersrpc/peers_client/struct.PeersClient_search=

The PeersClient service provides functionalities to get information about and interact with other nodes in the network.

```APIDOC
## Struct PeersClient

tonic_lnd::peersrpc::peers_client

### Description
Peers is a service that can be used to get information and interact with the other nodes of the network.

### Methods

#### `new(inner: T) -> Self`
Creates a new `PeersClient` instance.

#### `with_interceptor<F>(inner: T, interceptor: F) -> PeersClient<InterceptedService<T, F>>`
Creates a new `PeersClient` instance with a custom interceptor.

#### `send_gzip(self) -> Self`
Configures the client to compress requests with `gzip`. This requires server support.

#### `accept_gzip(self) -> Self`
Enables the client to decompress responses using `gzip`.

#### `connect<D>(dst: D) -> Result<Self, Error>`
Attempts to establish a connection to a given endpoint and returns a new `PeersClient`.

### Endpoint
`/peers` (conceptual, actual endpoint depends on gRPC service)

### Request Body (for `update_node_announcement`)
```json
{
  "node": "<node_id>",
  "addresses": ["<address1>", "<address2>"]
}
```

### Response (for `update_node_announcement`)
```json
{
  "node_announcement": {
    "node_id": "<node_id>",
    "signatures": ["<signature1>", "<signature2>"]
  }
}
```
```

--------------------------------

### SignerClient Constructor and Configuration (Rust)

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/type.SignerClient

Provides methods to create and configure a SignerClient. `new` creates a client with a given gRPC service, `with_interceptor` adds a custom interceptor, and `send_gzip`/`accept_gzip` control compression settings for requests and responses.

```rust
pub fn new(inner: T) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> SignerClient<InterceptedService<T, F>>
where F: Interceptor,

pub fn send_gzip(self) -> Self

pub fn accept_gzip(self) -> Self
```

--------------------------------

### tonic_lnd Client Blanket Implementations (Examples)

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/struct.Client

Illustrates some of the blanket implementations provided for the `Client` struct in Rust. These include traits like `Any`, `Borrow`, `From`, `Instrument`, `Into`, `TryFrom`, `TryInto`, `VZip`, and `WithSubscriber`, which enable various interoperability and utility features.

```rust
impl<T> Any for T
where T: 'static + ?Sized,
fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T
where T: ?Sized,
fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T
where T: ?Sized,
fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T
fn from(t: T) -> T

impl<T> Instrument for T
fn instrument(self, span: Span) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T
where U: From<T>,
fn into(self) -> U

impl<T> IntoRequest<T> for T
fn into_request(self) -> Request<T>

impl<T, U> TryFrom<U> for T
where U: Into<T>,
type Error = Infallible
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T>
VZip<V> for T
where V: MultiLane<T>,
fn vzip(self) -> V

impl<T> WithSubscriber for T
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,
fn with_current_subscriber(self) -> WithDispatch<Self>
```

--------------------------------

### Get Node Metrics

Source: https://docs.rs/tonic_lnd/latest/src/tonic_lnd/opt/rustwide/target/x86_64-unknown-linux-gnu/debug/build/tonic_lnd-45dc51beaddbe946/out/lnrpc.rs_search=u32+-%3E+bool

Returns node metrics calculated from the graph.

```APIDOC
## POST /lnrpc.Lightning/GetNodeMetrics

### Description
Returns node metrics calculated from the graph. Currently, the metrics include information about channel activity and liquidity.

### Method
POST

### Endpoint
/lnrpc.Lightning/GetNodeMetrics

### Parameters
#### Request Body
- **request** (NodeMetricsRequest) - Required - The request object for getting node metrics.

### Request Example
```json
{
  "mode": "" 
}
```

### Response
#### Success Response (200)
- **sample_ கொள்ளுங்கள்** (List<NodeMetricSample>) - A list of node metric samples.

#### Response Example
```json
{
  "sample_ கொள்ளுங்கள்": [
    {
      "timestamp": 1678800000,
      "active_channels": 10,
      "total_capacity": 1000000000,
      "avg_channel_size": 100000000,
      "num_nodes": 50
    }
  ]
}
```
```

--------------------------------

### Conversion Methods

Source: https://docs.rs/tonic_lnd/latest/tonic_lnd/lnrpc/struct.NodeInfoRequest_search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Documentation for `to_owned` and `clone_into` methods, which handle creating owned data from borrowed data and replacing owned data with borrowed data, respectively.

```APIDOC
## `to_owned` and `clone_into` Methods

### Description
- `to_owned`: Creates owned data from borrowed data, usually by cloning.
- `clone_into`: Uses borrowed data to replace owned data, usually by cloning.

### Methods
- `to_owned(&self) -> T`
- `clone_into(&self, target: &mut T)`
```
Tokens:
Raw