orb.cli.network module

orb.cli.network.get_route(destination: str = <typer.models.ArgumentInfo object>, fee_limit_msat: int = <typer.models.OptionInfo object>, source_pub_key: str = <typer.models.OptionInfo object>, outgoing_chan_id: str = <typer.models.OptionInfo object>, ignored_nodes: str = <typer.models.OptionInfo object>, ignored_pairs: str = <typer.models.OptionInfo object>, last_hop_pubkey: str = <typer.models.OptionInfo object>, satoshis: int = <typer.models.OptionInfo object>, time_pref: str = <typer.models.OptionInfo object>, cltv: str = <typer.models.OptionInfo object>, pubkey: str | None = <typer.models.OptionInfo object>)

Currently the result of get-route contains both the common format, and the original (implementation flavored) route. A future version of Orb switch to using the common route format.

Note

This command supports circular routes for both LND and CLN.

–cltv

The CLTV flag is required by CLN, but not LND.

–time-pref

This is also an awkward flag, as LND >= 0.15 can take a time-preference flag ranging from -1 and 1, however this flag is meaningless to CLN. So we keep the flag exposed, even though it does nothing with CLN.