https://github.com/niteshbalusu11/lightning-probing

https://github.com/niteshbalusu11/lightning-probing

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/niteshbalusu11/lightning-probing
• Owner: niteshbalusu11
• License: mit
• Created: 2023-10-01T04:11:34.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-10-16T22:10:08.000Z (about 1 year ago)
• Last Synced: 2024-10-12T20:35:47.537Z (2 months ago)
• Language: Rust
• Size: 85.9 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# lightning-probing

A package to probe the lightning network.

# Add a dependency

```

cargo add lightning-probing

```

## Installation locally for testing

- Install Rust https://www.rust-lang.org/

- Set env variables for running tests

```

# Update as necessary

cp .env.example .env

```

- Build

```

cargo build

```

- Test

```

# To test with log printing

cargo test -- --nocapture

```

- For using the repo, here's what it takes as inputs and outputs.

```rust

// For examples check the tests folder

// @Input

// For LndClient use https://github.com/yzernik/tonic_openssl_lnd 

// OR my fork https://github.com/niteshbalusu11/lnd-grpc-rust 

pub struct ProbeDestination {

    pub client: LndClient,

    pub probe_amount_sat: Option,

    pub destination_pubkey: Option,

    pub timeout_seconds: Option,

    pub fee_limit_sat: i64,

    pub payment_request: Option,

    pub outgoing_pubkeys: Option>,

    pub last_hop_pubkey: Option,

    pub max_paths: Option,

}

// @Returns

#[derive(Debug)]

pub struct ReturnValue {

    pub payment: lnrpc::Payment,

    pub is_probe_success: bool,

    pub failure_reason: FailureReason,

}

```

# License

MIT