Struct lightning::ln::channelmanager::ChannelManager

pub struct ChannelManager { /* fields omitted */ }

Manager which keeps track of a number of channels and sends messages to the appropriate channel, also tracking HTLC preimages and forwarding onion packets appropriately. Implements ChannelMessageHandler, handling the multi-channel parts and passing things through to individual Channels.

Methods

impl ChannelManager

fn new(
    our_network_key: SecretKey,
    fee_proportional_millionths: u32,
    announce_channels_publicly: bool,
    network: Network,
    feeest: Arc<FeeEstimator>,
    monitor: Arc<ManyChannelMonitor>,
    chain_monitor: Arc<ChainWatchInterface>
) -> Result<Arc<ChannelManager>, Error>

Constructs a new ChannelManager to hold several channels and route between them. This is the main "logic hub" for all channel-related actions, and implements ChannelMessageHandler. fee_proportional_millionths is an optional fee to charge any payments routed through us. Non-proportional fees are fixed according to our risk using the provided fee estimator. panics if channel_value_satoshis is >= (1 << 24)!

fn create_channel(
    &self,
    their_network_key: PublicKey,
    channel_value_satoshis: u64,
    user_id: u64
) -> Result<OpenChannel, HandleError>

fn send_payment(
    &self,
    route: &Route,
    payment_hash: [u8; 32]
) -> Result<Option<(UpdateAddHTLC, CommitmentSigned)>, HandleError>

Sends a payment along a given route, returning the UpdateAddHTLC message to give to the first hop in route. Value parameters are provided via the last hop in route, see documentation for RouteHop fields for more info. See-also docs on Channel::send_htlc_and_commit.

fn funding_transaction_generated(
    &self,
    temporary_channel_id: &Uint256,
    funding_txo: (Sha256dHash, u16)
)

Call this upon creation of a funding transaction for the given channel. Panics if a funding transaction has already been provided for this channel.

fn process_pending_htlc_forward(&self)

fn claim_funds(&self, payment_preimage: [u8; 32]) -> bool

Provides a payment preimage in response to a PaymentReceived event, returning true and generating message events for the net layer to claim the payment, if possible. Thus, you should probably kick the net layer to go send messages if this returns true!

fn get_our_node_id(&self) -> PublicKey

Gets the node_id held by this ChannelManager

Trait Implementations

impl EventsProvider for ChannelManager

fn get_and_clear_pending_events(&self) -> Vec<Event>

impl ChainListener for ChannelManager

fn block_connected(
    &self,
    header: &BlockHeader,
    height: u32,
    txn_matched: &[&Transaction],
    indexes_of_txn_matched: &[u32]
)

Notifies a listener that a block was connected. Note that if a new script/transaction is watched during a block_connected call, the block must be re-scanned with the new script/transaction and block_connected should be called again with the same header and (at least) the new transactions. This also means those counting confirmations using block_connected callbacks should watch for duplicate headers and not count them towards confirmations!

fn block_disconnected(&self, header: &BlockHeader)

Notifies a listener that a block was disconnected. Unlike block_connected, this must never be called twice for the same disconnect event.

impl ChannelMessageHandler for ChannelManager

fn handle_open_channel(
    &self,
    their_node_id: &PublicKey,
    msg: &OpenChannel
) -> Result<AcceptChannel, HandleError>

fn handle_accept_channel(
    &self,
    their_node_id: &PublicKey,
    msg: &AcceptChannel
) -> Result<(), HandleError>

fn handle_funding_created(
    &self,
    their_node_id: &PublicKey,
    msg: &FundingCreated
) -> Result<FundingSigned, HandleError>

fn handle_funding_signed(
    &self,
    their_node_id: &PublicKey,
    msg: &FundingSigned
) -> Result<(), HandleError>

fn handle_funding_locked(
    &self,
    their_node_id: &PublicKey,
    msg: &FundingLocked
) -> Result<Option<AnnouncementSignatures>, HandleError>

fn handle_shutdown(
    &self,
    _their_node_id: &PublicKey,
    _msg: &Shutdown
) -> Result<(), HandleError>

fn handle_closing_signed(
    &self,
    _their_node_id: &PublicKey,
    _msg: &ClosingSigned
) -> Result<(), HandleError>

fn handle_update_add_htlc(
    &self,
    their_node_id: &PublicKey,
    msg: &UpdateAddHTLC
) -> Result<(), HandleError>

fn handle_update_fulfill_htlc(
    &self,
    their_node_id: &PublicKey,
    msg: &UpdateFulfillHTLC
) -> Result<Option<(Vec<UpdateAddHTLC>, CommitmentSigned)>, HandleError>

fn handle_update_fail_htlc(
    &self,
    their_node_id: &PublicKey,
    msg: &UpdateFailHTLC
) -> Result<Option<(Vec<UpdateAddHTLC>, CommitmentSigned)>, HandleError>

fn handle_update_fail_malformed_htlc(
    &self,
    their_node_id: &PublicKey,
    msg: &UpdateFailMalformedHTLC
) -> Result<Option<(Vec<UpdateAddHTLC>, CommitmentSigned)>, HandleError>

fn handle_commitment_signed(
    &self,
    their_node_id: &PublicKey,
    msg: &CommitmentSigned
) -> Result<RevokeAndACK, HandleError>

fn handle_revoke_and_ack(
    &self,
    their_node_id: &PublicKey,
    msg: &RevokeAndACK
) -> Result<(), HandleError>

fn handle_update_fee(
    &self,
    their_node_id: &PublicKey,
    msg: &UpdateFee
) -> Result<(), HandleError>

fn handle_announcement_signatures(
    &self,
    their_node_id: &PublicKey,
    msg: &AnnouncementSignatures
) -> Result<(), HandleError>