DotNetLightning


Channel Type

Record fields

Record Field Description

ChannelOptions

Full Usage: ChannelOptions

Field type: ChannelOptions
Field type: ChannelOptions

ChannelPrivKeys

Full Usage: ChannelPrivKeys

Field type: ChannelPrivKeys
Field type: ChannelPrivKeys

Commitments

Full Usage: Commitments

Field type: Commitments
Field type: Commitments

NegotiatingState

Full Usage: NegotiatingState

Field type: NegotiatingState
Field type: NegotiatingState

NodeSecret

Full Usage: NodeSecret

Field type: NodeSecret
Field type: NodeSecret

RemoteNextCommitInfo

Full Usage: RemoteNextCommitInfo

Field type: Option<RemoteNextCommitInfo>
Field type: Option<RemoteNextCommitInfo>

SavedChannelState

Full Usage: SavedChannelState

Field type: SavedChannelState
Field type: SavedChannelState

Instance members

Instance member Description

this.AddHTLC

Full Usage: this.AddHTLC

Parameters:
Returns: Result<(Channel * UpdateAddHTLCMsg), ChannelError>
op : OperationAddHTLC
Returns: Result<(Channel * UpdateAddHTLCMsg), ChannelError>

this.ApplyClosingSigned

Full Usage: this.ApplyClosingSigned

Parameters:
Returns: Result<(Channel * ClosingSignedResponse), ChannelError>
msg : ClosingSignedMsg
Returns: Result<(Channel * ClosingSignedResponse), ChannelError>

this.ApplyCommitmentSigned

Full Usage: this.ApplyCommitmentSigned

Parameters:
Returns: Result<(Channel * RevokeAndACKMsg), ChannelError>
msg : CommitmentSignedMsg
Returns: Result<(Channel * RevokeAndACKMsg), ChannelError>

this.ApplyFundingConfirmedOnBC

Full Usage: this.ApplyFundingConfirmedOnBC

Parameters:
Returns: Result<(Channel * FundingLockedMsg), ChannelError>
height : BlockHeight
txindex : TxIndexInBlock
depth : BlockHeightOffset32
Returns: Result<(Channel * FundingLockedMsg), ChannelError>

this.ApplyFundingLocked

Full Usage: this.ApplyFundingLocked

Parameters:
Returns: Result<Channel, ChannelError>
fundingLockedMsg : FundingLockedMsg
Returns: Result<Channel, ChannelError>

this.ApplyRevokeAndACK

Full Usage: this.ApplyRevokeAndACK

Parameters:
Returns: Result<Channel, ChannelError>
msg : RevokeAndACKMsg
Returns: Result<Channel, ChannelError>

this.ApplyUpdateAddHTLC

Full Usage: this.ApplyUpdateAddHTLC

Parameters:
Returns: Result<Channel, ChannelError>
msg : UpdateAddHTLCMsg
height : BlockHeight
Returns: Result<Channel, ChannelError>

this.ApplyUpdateFailHTLC

Full Usage: this.ApplyUpdateFailHTLC

Parameters:
Returns: Result<Channel, ChannelError>
msg : UpdateFailHTLCMsg
Returns: Result<Channel, ChannelError>

this.ApplyUpdateFailMalformedHTLC

Full Usage: this.ApplyUpdateFailMalformedHTLC

Parameters:
Returns: Result<Channel, ChannelError>
msg : UpdateFailMalformedHTLCMsg
Returns: Result<Channel, ChannelError>

this.ApplyUpdateFee

Full Usage: this.ApplyUpdateFee

Parameters:
Returns: Result<Channel, ChannelError>
msg : UpdateFeeMsg
Returns: Result<Channel, ChannelError>

this.ApplyUpdateFulfillHTLC

Full Usage: this.ApplyUpdateFulfillHTLC

Parameters:
Returns: Result<Channel, ChannelError>
msg : UpdateFulfillHTLCMsg
Returns: Result<Channel, ChannelError>

this.Close

Full Usage: this.Close

Parameters:
Returns: Result<(Channel * ShutdownMsg), ChannelError>
localShutdownScriptPubKey : ShutdownScriptPubKey
Returns: Result<(Channel * ShutdownMsg), ChannelError>

this.CreateChannelReestablish

Full Usage: this.CreateChannelReestablish

Returns: ChannelReestablishMsg
Returns: ChannelReestablishMsg

this.FailHTLC

Full Usage: this.FailHTLC

Parameters:
Returns: Result<(Channel * UpdateFailHTLCMsg), ChannelError>
op : OperationFailHTLC
Returns: Result<(Channel * UpdateFailHTLCMsg), ChannelError>

this.FailMalformedHTLC

Full Usage: this.FailMalformedHTLC

Parameters:
Returns: Result<(Channel * UpdateFailMalformedHTLCMsg), ChannelError>
op : OperationFailMalformedHTLC
Returns: Result<(Channel * UpdateFailMalformedHTLCMsg), ChannelError>

this.FulFillHTLC

Full Usage: this.FulFillHTLC

Parameters:
Returns: Result<(Channel * UpdateFulfillHTLCMsg), ChannelError>
cmd : OperationFulfillHTLC
Returns: Result<(Channel * UpdateFulfillHTLCMsg), ChannelError>

this.LocalHasChanges

Full Usage: this.LocalHasChanges

Returns: bool
Returns: bool

this.RemoteHasChanges

Full Usage: this.RemoteHasChanges

Returns: bool
Returns: bool

this.RemoteShutdown

Full Usage: this.RemoteShutdown

Parameters:
Returns: Result<(Channel * Option<ShutdownMsg> * Option<ClosingSignedMsg>), ChannelError>
msg : ShutdownMsg
localShutdownScriptPubKey : ShutdownScriptPubKey
Returns: Result<(Channel * Option<ShutdownMsg> * Option<ClosingSignedMsg>), ChannelError>

this.SignCommitment

Full Usage: this.SignCommitment

Returns: Result<(Channel * CommitmentSignedMsg), ChannelError>
Returns: Result<(Channel * CommitmentSignedMsg), ChannelError>

this.SpendableBalance

Full Usage: this.SpendableBalance

Returns: LNMoney
Returns: LNMoney

this.UpdateFee

Full Usage: this.UpdateFee

Parameters:
Returns: Result<(Channel * UpdateFeeMsg), ChannelError>
op : OperationUpdateFee
Returns: Result<(Channel * UpdateFeeMsg), ChannelError>

Static members

Static member Description

Channel.NewInbound(channelHandshakeLimits, channelOptions, announceChannel, nodeMasterPrivKey, channelIndex, network, remoteNodeId, minimumDepth, shutdownScriptPubKey, openChannelMsg, localParams, remoteInit)

Full Usage: Channel.NewInbound(channelHandshakeLimits, channelOptions, announceChannel, nodeMasterPrivKey, channelIndex, network, remoteNodeId, minimumDepth, shutdownScriptPubKey, openChannelMsg, localParams, remoteInit)

Parameters:
Returns: Result<(AcceptChannelMsg * ChannelWaitingForFundingCreated), ChannelError>
channelHandshakeLimits : ChannelHandshakeLimits
channelOptions : ChannelOptions
announceChannel : bool
nodeMasterPrivKey : NodeMasterPrivKey
channelIndex : int
network : Network
remoteNodeId : NodeId
minimumDepth : BlockHeightOffset32
shutdownScriptPubKey : Option<ShutdownScriptPubKey>
openChannelMsg : OpenChannelMsg
localParams : LocalParams
remoteInit : InitMsg
Returns: Result<(AcceptChannelMsg * ChannelWaitingForFundingCreated), ChannelError>

Channel.NewOutbound(channelHandshakeLimits, channelOptions, announceChannel, nodeMasterPrivKey, channelIndex, network, remoteNodeId, shutdownScriptPubKey, temporaryChannelId, fundingSatoshis, pushMSat, initFeeRatePerKw, localParams, remoteInit)

Full Usage: Channel.NewOutbound(channelHandshakeLimits, channelOptions, announceChannel, nodeMasterPrivKey, channelIndex, network, remoteNodeId, shutdownScriptPubKey, temporaryChannelId, fundingSatoshis, pushMSat, initFeeRatePerKw, localParams, remoteInit)

Parameters:
Returns: Result<(OpenChannelMsg * ChannelWaitingForAcceptChannel), ChannelError>
channelHandshakeLimits : ChannelHandshakeLimits
channelOptions : ChannelOptions
announceChannel : bool
nodeMasterPrivKey : NodeMasterPrivKey
channelIndex : int
network : Network
remoteNodeId : NodeId
shutdownScriptPubKey : Option<ShutdownScriptPubKey>
temporaryChannelId : ChannelId
fundingSatoshis : Money
pushMSat : LNMoney
initFeeRatePerKw : FeeRatePerKw
localParams : LocalParams
remoteInit : InitMsg
Returns: Result<(OpenChannelMsg * ChannelWaitingForAcceptChannel), ChannelError>

Channel.SpendableBalanceFromParts(savedChannelState) (remoteNextCommitInfo) (commitments)

Full Usage: Channel.SpendableBalanceFromParts(savedChannelState) (remoteNextCommitInfo) (commitments)

Parameters:
Returns: LNMoney
savedChannelState : SavedChannelState
remoteNextCommitInfo : Option<RemoteNextCommitInfo>
commitments : Commitments
Returns: LNMoney