Struct Gatewayd

pub struct Gatewayd {
    pub(crate) process: ProcessHandle,
    pub ln: Option<LightningNode>,
    pub addr: String,
    pub(crate) lightning_node_addr: String,
}

Fields

process: ProcessHandle

ln: Option<LightningNode>

addr: String

lightning_node_addr: String

Implementations

impl Gatewayd

pub async fn new( process_mgr: &ProcessManager, ln: LightningNode, ) -> Result<Self>

pub fn ln_type(&self) -> LightningNodeType

pub async fn terminate(self) -> Result<()>

pub fn set_lightning_node(&mut self, ln_node: LightningNode)

pub async fn stop_lightning_node(&mut self) -> Result<()>

pub async fn restart_with_bin( &mut self, process_mgr: &ProcessManager, gatewayd_path: &PathBuf, gateway_cli_path: &PathBuf, gateway_cln_extension_path: &PathBuf, bitcoind: Bitcoind, ) -> Result<()>

Restarts the gateway using the provided bin_path, which is useful for testing upgrades.

pub fn cmd(&self) -> Command

pub fn change_password(&self, old_password: &str, new_password: &str) -> Command

pub async fn get_info(&self) -> Result<Value>

pub async fn gateway_id(&self) -> Result<String>

pub async fn lightning_pubkey(&self) -> Result<PublicKey>

pub async fn connect_fed(&self, fed: &Federation) -> Result<()>

pub async fn recover_fed(&self, fed: &Federation) -> Result<()>

pub async fn backup_to_fed(&self, fed: &Federation) -> Result<()>

pub fn lightning_node_type(&self) -> LightningNodeType

pub async fn get_pegin_addr(&self, fed_id: &str) -> Result<String>

pub async fn get_ln_onchain_address(&self) -> Result<String>

pub async fn get_mnemonic(&self) -> Result<MnemonicResponse>

pub async fn leave_federation(&self, federation_id: FederationId) -> Result<()>

pub async fn create_invoice(&self, amount_msats: u64) -> Result<Bolt11Invoice>

pub async fn pay_invoice(&self, invoice: Bolt11Invoice) -> Result<()>

pub async fn send_ecash( &self, federation_id: String, amount_msats: u64, ) -> Result<String>

pub async fn receive_ecash(&self, ecash: String) -> Result<()>

pub async fn get_balances(&self) -> Result<GatewayBalances>

pub async fn ecash_balance(&self, federation_id: String) -> Result<u64>

pub async fn send_onchain( &self, bitcoind: &Bitcoind, amount: BitcoinAmountOrAll, fee_rate: u64, ) -> Result<()>

pub async fn close_all_channels(&self, bitcoind: Bitcoind) -> Result<()>

pub async fn open_channel( &self, gw: &Gatewayd, channel_size_sats: u64, push_amount_sats: Option<u64>, ) -> Result<Option<Txid>>

Open a channel with the gateway’s lightning node. Returns the txid of the funding transaction if the gateway is a new enough version to return it. Otherwise, returns None.

TODO(support:v0.5): Remove the Option<Txid> return type and just return Txid.

pub async fn list_active_channels(&self) -> Result<Vec<ChannelInfo>>

pub async fn wait_for_block_height( &self, target_block_height: u64, ) -> Result<()>

Trait Implementations

impl Clone for Gatewayd

fn clone(&self) -> Gatewayd

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.