Struct BlocktankClient

pub struct BlocktankClient { /* private fields */ }

Implementations

impl BlocktankClient

pub fn new(base_url: Option<&str>) -> Result<Self>

Creates a new BlocktankClient instance with the given base URL or default if not provided

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

Get general service information.

pub async fn estimate_order_fee( &self, lsp_balance_sat: u64, channel_expiry_weeks: u32, options: Option<CreateOrderOptions>, ) -> Result<IBtEstimateFeeResponse>

Estimates the fee to create a channel order without actually creating an order.

pub async fn estimate_order_fee_full( &self, lsp_balance_sat: u64, channel_expiry_weeks: u32, options: Option<CreateOrderOptions>, ) -> Result<IBtEstimateFeeResponse2>

Estimates the fee to create a channel order without actually creating an order. Includes network and service fee.

pub async fn create_order( &self, lsp_balance_sat: u64, channel_expiry_weeks: u32, options: Option<CreateOrderOptions>, ) -> Result<IBtOrder>

Creates a new channel order

pub async fn get_order(&self, order_id: &str) -> Result<IBtOrder>

Get order by order id. Returns an error if it doesn’t find the order.

pub async fn get_orders(&self, order_ids: &[String]) -> Result<Vec<IBtOrder>>

Get multiple orders by order ids.

pub async fn open_channel( &self, order_id: &str, connection_string_or_pubkey: &str, ) -> Result<IBtOrder>

Open channel to a specific node.

pub async fn get_min_zero_conf_tx_fee( &self, order_id: &str, ) -> Result<IBt0ConfMinTxFeeWindow>

Get minimum 0-conf transaction fee for an order.

pub async fn create_cjit_entry( &self, channel_size_sat: u64, invoice_sat: u64, invoice_description: &str, node_id: &str, channel_expiry_weeks: u32, options: Option<CreateCjitOptions>, ) -> Result<ICJitEntry>

Create a new CJIT entry for Just-In-Time channel open.

pub async fn get_cjit_entry(&self, entry_id: &str) -> Result<ICJitEntry>

Get CJIT entry by id. Returns an error if it doesn’t find the entry.

pub async fn bitkit_log(&self, node_id: &str, message: &str) -> Result<()>

Sends a log message from Bitkit to Blocktank. Heavily rate limited.

pub async fn regtest_mine(&self, count: Option<u32>) -> Result<()>

Mines a number of blocks on the regtest network.

pub async fn regtest_deposit( &self, address: &str, amount_sat: Option<u64>, ) -> Result<String>

Deposits a number of satoshis to an address on the regtest network. Returns the transaction ID of the deposit.

pub async fn regtest_pay( &self, invoice: &str, amount_sat: Option<u64>, ) -> Result<String>

Pays an invoice on the regtest network. Returns the payment ID.

pub async fn regtest_get_payment( &self, payment_id: &str, ) -> Result<IBtBolt11Invoice>

Get paid invoice on the regtest network by payment ID.

pub async fn regtest_close_channel( &self, funding_tx_id: &str, vout: u32, force_close_after_s: Option<u64>, ) -> Result<String>

Closes a channel on the regtest network. Returns the closing transaction ID.

pub async fn register_device( &self, device_token: &str, public_key: &str, features: &[String], node_id: &str, iso_timestamp: &str, signature: &str, is_production: Option<bool>, custom_url: Option<&str>, ) -> Result<String>

Registers a device with Blocktank

pub async fn test_notification( &self, device_token: &str, secret_message: &str, notification_type: Option<&str>, custom_url: Option<&str>, ) -> Result<String>

Sends a test notification to a registered device

Trait Implementations

impl Clone for BlocktankClient

fn clone(&self) -> BlocktankClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlocktankClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.