X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=ts%2Fstructs%2FChannelDetails.mts;h=a758ec89f6eefb8526ee4ade60d6b028d38c8f7e;hb=f51e303f0ebe8fa1c9dcbd57324aab6266b5fd79;hp=047966858ad48720e6dddb20148a23c02d78c791;hpb=2a65456aa0b540060dcf3ca707a54dc98cc3f38a;p=ldk-java diff --git a/ts/structs/ChannelDetails.mts b/ts/structs/ChannelDetails.mts index 04796685..a758ec89 100644 --- a/ts/structs/ChannelDetails.mts +++ b/ts/structs/ChannelDetails.mts @@ -3,14 +3,18 @@ import { AccessError } from '../enums/AccessError.mjs'; import { COption_NoneZ } from '../enums/COption_NoneZ.mjs'; import { ChannelMonitorUpdateErr } from '../enums/ChannelMonitorUpdateErr.mjs'; import { ConfirmationTarget } from '../enums/ConfirmationTarget.mjs'; +import { CreationError } from '../enums/CreationError.mjs'; +import { Currency } from '../enums/Currency.mjs'; import { Level } from '../enums/Level.mjs'; import { Network } from '../enums/Network.mjs'; +import { Recipient } from '../enums/Recipient.mjs'; import { Secp256k1Error } from '../enums/Secp256k1Error.mjs'; -import { ChannelConfig } from '../structs/ChannelConfig.mjs'; +import { SemanticError } from '../enums/SemanticError.mjs'; +import { SiPrefix } from '../enums/SiPrefix.mjs'; +import { Result_NoneNoneZ } from '../structs/Result_NoneNoneZ.mjs'; +import { CounterpartyCommitmentSecrets } from '../structs/CounterpartyCommitmentSecrets.mjs'; import { DecodeError } from '../structs/DecodeError.mjs'; -import { Result_ChannelConfigDecodeErrorZ } from '../structs/Result_ChannelConfigDecodeErrorZ.mjs'; -import { OutPoint } from '../structs/OutPoint.mjs'; -import { Result_OutPointDecodeErrorZ } from '../structs/Result_OutPointDecodeErrorZ.mjs'; +import { Result_CounterpartyCommitmentSecretsDecodeErrorZ } from '../structs/Result_CounterpartyCommitmentSecretsDecodeErrorZ.mjs'; import { Result_SecretKeyErrorZ } from '../structs/Result_SecretKeyErrorZ.mjs'; import { Result_PublicKeyErrorZ } from '../structs/Result_PublicKeyErrorZ.mjs'; import { TxCreationKeys } from '../structs/TxCreationKeys.mjs'; @@ -40,61 +44,41 @@ import { ShutdownScript } from '../structs/ShutdownScript.mjs'; import { Result_ShutdownScriptDecodeErrorZ } from '../structs/Result_ShutdownScriptDecodeErrorZ.mjs'; import { InvalidShutdownScript } from '../structs/InvalidShutdownScript.mjs'; import { Result_ShutdownScriptInvalidShutdownScriptZ } from '../structs/Result_ShutdownScriptInvalidShutdownScriptZ.mjs'; -import { Type, TypeInterface } from '../structs/Type.mjs'; -import { Option_TypeZ } from '../structs/Option_TypeZ.mjs'; -import { Result_COption_TypeZDecodeErrorZ } from '../structs/Result_COption_TypeZDecodeErrorZ.mjs'; -import { Result_StringErrorZ } from '../structs/Result_StringErrorZ.mjs'; -import { ChannelMonitorUpdate } from '../structs/ChannelMonitorUpdate.mjs'; -import { Result_ChannelMonitorUpdateDecodeErrorZ } from '../structs/Result_ChannelMonitorUpdateDecodeErrorZ.mjs'; -import { HTLCUpdate } from '../structs/HTLCUpdate.mjs'; -import { MonitorEvent } from '../structs/MonitorEvent.mjs'; -import { Option_MonitorEventZ } from '../structs/Option_MonitorEventZ.mjs'; -import { Result_COption_MonitorEventZDecodeErrorZ } from '../structs/Result_COption_MonitorEventZDecodeErrorZ.mjs'; -import { Result_HTLCUpdateDecodeErrorZ } from '../structs/Result_HTLCUpdateDecodeErrorZ.mjs'; -import { Result_NoneNoneZ } from '../structs/Result_NoneNoneZ.mjs'; -import { TwoTuple_OutPointScriptZ } from '../structs/TwoTuple_OutPointScriptZ.mjs'; -import { TwoTuple_u32ScriptZ } from '../structs/TwoTuple_u32ScriptZ.mjs'; -import { TwoTuple_TxidCVec_C2Tuple_u32ScriptZZZ } from '../structs/TwoTuple_TxidCVec_C2Tuple_u32ScriptZZZ.mjs'; -import { PaymentPurpose } from '../structs/PaymentPurpose.mjs'; -import { Option_u64Z } from '../structs/Option_u64Z.mjs'; -import { ChannelUpdate } from '../structs/ChannelUpdate.mjs'; -import { NetworkUpdate } from '../structs/NetworkUpdate.mjs'; -import { Option_NetworkUpdateZ } from '../structs/Option_NetworkUpdateZ.mjs'; import { RouteHop } from '../structs/RouteHop.mjs'; -import { RouteParameters } from '../structs/RouteParameters.mjs'; -import { DelayedPaymentOutputDescriptor } from '../structs/DelayedPaymentOutputDescriptor.mjs'; -import { StaticPaymentOutputDescriptor } from '../structs/StaticPaymentOutputDescriptor.mjs'; -import { SpendableOutputDescriptor } from '../structs/SpendableOutputDescriptor.mjs'; -import { ClosureReason } from '../structs/ClosureReason.mjs'; -import { Event } from '../structs/Event.mjs'; -import { TwoTuple_usizeTransactionZ } from '../structs/TwoTuple_usizeTransactionZ.mjs'; -import { TwoTuple_u32TxOutZ } from '../structs/TwoTuple_u32TxOutZ.mjs'; -import { TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ } from '../structs/TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ.mjs'; -import { Balance } from '../structs/Balance.mjs'; -import { TwoTuple_SignatureCVec_SignatureZZ } from '../structs/TwoTuple_SignatureCVec_SignatureZZ.mjs'; -import { Result_C2Tuple_SignatureCVec_SignatureZZNoneZ } from '../structs/Result_C2Tuple_SignatureCVec_SignatureZZNoneZ.mjs'; -import { Result_SignatureNoneZ } from '../structs/Result_SignatureNoneZ.mjs'; -import { ClosingTransaction } from '../structs/ClosingTransaction.mjs'; -import { UnsignedChannelAnnouncement } from '../structs/UnsignedChannelAnnouncement.mjs'; -import { BaseSign, BaseSignInterface } from '../structs/BaseSign.mjs'; -import { Sign, SignInterface } from '../structs/Sign.mjs'; -import { ChannelMonitor } from '../structs/ChannelMonitor.mjs'; -import { TwoTuple_BlockHashChannelMonitorZ } from '../structs/TwoTuple_BlockHashChannelMonitorZ.mjs'; -import { Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ } from '../structs/Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.mjs'; import { Result_RouteHopDecodeErrorZ } from '../structs/Result_RouteHopDecodeErrorZ.mjs'; import { Route } from '../structs/Route.mjs'; import { Result_RouteDecodeErrorZ } from '../structs/Result_RouteDecodeErrorZ.mjs'; +import { RouteParameters } from '../structs/RouteParameters.mjs'; import { Result_RouteParametersDecodeErrorZ } from '../structs/Result_RouteParametersDecodeErrorZ.mjs'; import { RouteHint } from '../structs/RouteHint.mjs'; -import { Payee } from '../structs/Payee.mjs'; -import { Result_PayeeDecodeErrorZ } from '../structs/Result_PayeeDecodeErrorZ.mjs'; +import { Option_u64Z } from '../structs/Option_u64Z.mjs'; +import { PaymentParameters } from '../structs/PaymentParameters.mjs'; +import { Result_PaymentParametersDecodeErrorZ } from '../structs/Result_PaymentParametersDecodeErrorZ.mjs'; import { RouteHintHop } from '../structs/RouteHintHop.mjs'; import { Result_RouteHintDecodeErrorZ } from '../structs/Result_RouteHintDecodeErrorZ.mjs'; import { Result_RouteHintHopDecodeErrorZ } from '../structs/Result_RouteHintHopDecodeErrorZ.mjs'; import { LightningError } from '../structs/LightningError.mjs'; import { Result_RouteLightningErrorZ } from '../structs/Result_RouteLightningErrorZ.mjs'; -import { Result_NoneLightningErrorZ } from '../structs/Result_NoneLightningErrorZ.mjs'; -import { TwoTuple_PublicKeyTypeZ } from '../structs/TwoTuple_PublicKeyTypeZ.mjs'; +import { Result_TxOutAccessErrorZ } from '../structs/Result_TxOutAccessErrorZ.mjs'; +import { TwoTuple_usizeTransactionZ } from '../structs/TwoTuple_usizeTransactionZ.mjs'; +import { Result_NoneChannelMonitorUpdateErrZ } from '../structs/Result_NoneChannelMonitorUpdateErrZ.mjs'; +import { HTLCUpdate } from '../structs/HTLCUpdate.mjs'; +import { OutPoint } from '../structs/OutPoint.mjs'; +import { MonitorEvent } from '../structs/MonitorEvent.mjs'; +import { Option_C2Tuple_usizeTransactionZZ } from '../structs/Option_C2Tuple_usizeTransactionZZ.mjs'; +import { ClosureReason } from '../structs/ClosureReason.mjs'; +import { Option_ClosureReasonZ } from '../structs/Option_ClosureReasonZ.mjs'; +import { Result_COption_ClosureReasonZDecodeErrorZ } from '../structs/Result_COption_ClosureReasonZDecodeErrorZ.mjs'; +import { ChannelUpdate } from '../structs/ChannelUpdate.mjs'; +import { NetworkUpdate } from '../structs/NetworkUpdate.mjs'; +import { Option_NetworkUpdateZ } from '../structs/Option_NetworkUpdateZ.mjs'; +import { DelayedPaymentOutputDescriptor } from '../structs/DelayedPaymentOutputDescriptor.mjs'; +import { StaticPaymentOutputDescriptor } from '../structs/StaticPaymentOutputDescriptor.mjs'; +import { SpendableOutputDescriptor } from '../structs/SpendableOutputDescriptor.mjs'; +import { PaymentPurpose } from '../structs/PaymentPurpose.mjs'; +import { Event } from '../structs/Event.mjs'; +import { Option_EventZ } from '../structs/Option_EventZ.mjs'; +import { Result_COption_EventZDecodeErrorZ } from '../structs/Result_COption_EventZDecodeErrorZ.mjs'; import { AcceptChannel } from '../structs/AcceptChannel.mjs'; import { OpenChannel } from '../structs/OpenChannel.mjs'; import { FundingCreated } from '../structs/FundingCreated.mjs'; @@ -109,55 +93,151 @@ import { ChannelReestablish } from '../structs/ChannelReestablish.mjs'; import { ChannelAnnouncement } from '../structs/ChannelAnnouncement.mjs'; import { NodeAnnouncement } from '../structs/NodeAnnouncement.mjs'; import { ErrorMessage } from '../structs/ErrorMessage.mjs'; +import { WarningMessage } from '../structs/WarningMessage.mjs'; import { ErrorAction } from '../structs/ErrorAction.mjs'; import { QueryChannelRange } from '../structs/QueryChannelRange.mjs'; import { QueryShortChannelIds } from '../structs/QueryShortChannelIds.mjs'; import { ReplyChannelRange } from '../structs/ReplyChannelRange.mjs'; import { MessageSendEvent } from '../structs/MessageSendEvent.mjs'; +import { FixedPenaltyScorer } from '../structs/FixedPenaltyScorer.mjs'; +import { Result_FixedPenaltyScorerDecodeErrorZ } from '../structs/Result_FixedPenaltyScorerDecodeErrorZ.mjs'; +import { ScoringParameters } from '../structs/ScoringParameters.mjs'; +import { Result_ScoringParametersDecodeErrorZ } from '../structs/Result_ScoringParametersDecodeErrorZ.mjs'; +import { Scorer } from '../structs/Scorer.mjs'; +import { Result_ScorerDecodeErrorZ } from '../structs/Result_ScorerDecodeErrorZ.mjs'; +import { ProbabilisticScoringParameters } from '../structs/ProbabilisticScoringParameters.mjs'; +import { Result_ProbabilisticScoringParametersDecodeErrorZ } from '../structs/Result_ProbabilisticScoringParametersDecodeErrorZ.mjs'; +import { NetworkGraph } from '../structs/NetworkGraph.mjs'; +import { TwoTuple_ProbabilisticScoringParametersNetworkGraphZ } from '../structs/TwoTuple_ProbabilisticScoringParametersNetworkGraphZ.mjs'; +import { ProbabilisticScorer } from '../structs/ProbabilisticScorer.mjs'; +import { Result_ProbabilisticScorerDecodeErrorZ } from '../structs/Result_ProbabilisticScorerDecodeErrorZ.mjs'; +import { InitFeatures } from '../structs/InitFeatures.mjs'; +import { Result_InitFeaturesDecodeErrorZ } from '../structs/Result_InitFeaturesDecodeErrorZ.mjs'; +import { ChannelFeatures } from '../structs/ChannelFeatures.mjs'; +import { Result_ChannelFeaturesDecodeErrorZ } from '../structs/Result_ChannelFeaturesDecodeErrorZ.mjs'; +import { NodeFeatures } from '../structs/NodeFeatures.mjs'; +import { Result_NodeFeaturesDecodeErrorZ } from '../structs/Result_NodeFeaturesDecodeErrorZ.mjs'; +import { InvoiceFeatures } from '../structs/InvoiceFeatures.mjs'; +import { Result_InvoiceFeaturesDecodeErrorZ } from '../structs/Result_InvoiceFeaturesDecodeErrorZ.mjs'; +import { ChannelTypeFeatures } from '../structs/ChannelTypeFeatures.mjs'; +import { Result_ChannelTypeFeaturesDecodeErrorZ } from '../structs/Result_ChannelTypeFeaturesDecodeErrorZ.mjs'; +import { Result_DelayedPaymentOutputDescriptorDecodeErrorZ } from '../structs/Result_DelayedPaymentOutputDescriptorDecodeErrorZ.mjs'; +import { Result_StaticPaymentOutputDescriptorDecodeErrorZ } from '../structs/Result_StaticPaymentOutputDescriptorDecodeErrorZ.mjs'; +import { Result_SpendableOutputDescriptorDecodeErrorZ } from '../structs/Result_SpendableOutputDescriptorDecodeErrorZ.mjs'; +import { TwoTuple_SignatureCVec_SignatureZZ } from '../structs/TwoTuple_SignatureCVec_SignatureZZ.mjs'; +import { Result_C2Tuple_SignatureCVec_SignatureZZNoneZ } from '../structs/Result_C2Tuple_SignatureCVec_SignatureZZNoneZ.mjs'; +import { Result_SignatureNoneZ } from '../structs/Result_SignatureNoneZ.mjs'; +import { TwoTuple_SignatureSignatureZ } from '../structs/TwoTuple_SignatureSignatureZ.mjs'; +import { Result_C2Tuple_SignatureSignatureZNoneZ } from '../structs/Result_C2Tuple_SignatureSignatureZNoneZ.mjs'; +import { Result_SecretKeyNoneZ } from '../structs/Result_SecretKeyNoneZ.mjs'; +import { ClosingTransaction } from '../structs/ClosingTransaction.mjs'; +import { UnsignedChannelAnnouncement } from '../structs/UnsignedChannelAnnouncement.mjs'; +import { BaseSign, BaseSignInterface } from '../structs/BaseSign.mjs'; +import { Sign, SignInterface } from '../structs/Sign.mjs'; +import { Result_SignDecodeErrorZ } from '../structs/Result_SignDecodeErrorZ.mjs'; +import { Result_RecoverableSignatureNoneZ } from '../structs/Result_RecoverableSignatureNoneZ.mjs'; +import { Result_CVec_CVec_u8ZZNoneZ } from '../structs/Result_CVec_CVec_u8ZZNoneZ.mjs'; +import { InMemorySigner } from '../structs/InMemorySigner.mjs'; +import { Result_InMemorySignerDecodeErrorZ } from '../structs/Result_InMemorySignerDecodeErrorZ.mjs'; +import { Result_TransactionNoneZ } from '../structs/Result_TransactionNoneZ.mjs'; +import { Option_u16Z } from '../structs/Option_u16Z.mjs'; +import { APIError } from '../structs/APIError.mjs'; +import { Result_NoneAPIErrorZ } from '../structs/Result_NoneAPIErrorZ.mjs'; +import { Result__u832APIErrorZ } from '../structs/Result__u832APIErrorZ.mjs'; +import { PaymentSendFailure } from '../structs/PaymentSendFailure.mjs'; +import { Result_PaymentIdPaymentSendFailureZ } from '../structs/Result_PaymentIdPaymentSendFailureZ.mjs'; +import { Result_NonePaymentSendFailureZ } from '../structs/Result_NonePaymentSendFailureZ.mjs'; +import { TwoTuple_PaymentHashPaymentIdZ } from '../structs/TwoTuple_PaymentHashPaymentIdZ.mjs'; +import { Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ } from '../structs/Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ.mjs'; +import { NetAddress } from '../structs/NetAddress.mjs'; +import { TwoTuple_PaymentHashPaymentSecretZ } from '../structs/TwoTuple_PaymentHashPaymentSecretZ.mjs'; +import { Result_C2Tuple_PaymentHashPaymentSecretZNoneZ } from '../structs/Result_C2Tuple_PaymentHashPaymentSecretZNoneZ.mjs'; +import { Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ } from '../structs/Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ.mjs'; +import { Result_PaymentSecretNoneZ } from '../structs/Result_PaymentSecretNoneZ.mjs'; +import { Result_PaymentSecretAPIErrorZ } from '../structs/Result_PaymentSecretAPIErrorZ.mjs'; +import { Result_PaymentPreimageAPIErrorZ } from '../structs/Result_PaymentPreimageAPIErrorZ.mjs'; +import { CounterpartyForwardingInfo } from '../structs/CounterpartyForwardingInfo.mjs'; +import { Result_CounterpartyForwardingInfoDecodeErrorZ } from '../structs/Result_CounterpartyForwardingInfoDecodeErrorZ.mjs'; +import { ChannelCounterparty } from '../structs/ChannelCounterparty.mjs'; +import { Result_ChannelCounterpartyDecodeErrorZ } from '../structs/Result_ChannelCounterpartyDecodeErrorZ.mjs'; +import { Result_ChannelDetailsDecodeErrorZ } from '../structs/Result_ChannelDetailsDecodeErrorZ.mjs'; +import { PhantomRouteHints } from '../structs/PhantomRouteHints.mjs'; +import { Result_PhantomRouteHintsDecodeErrorZ } from '../structs/Result_PhantomRouteHintsDecodeErrorZ.mjs'; +import { ChannelMonitor } from '../structs/ChannelMonitor.mjs'; +import { ChannelMonitorUpdate } from '../structs/ChannelMonitorUpdate.mjs'; +import { Watch, WatchInterface } from '../structs/Watch.mjs'; +import { BroadcasterInterface, BroadcasterInterfaceInterface } from '../structs/BroadcasterInterface.mjs'; +import { KeysInterface, KeysInterfaceInterface } from '../structs/KeysInterface.mjs'; +import { FeeEstimator, FeeEstimatorInterface } from '../structs/FeeEstimator.mjs'; +import { Record } from '../structs/Record.mjs'; +import { Logger, LoggerInterface } from '../structs/Logger.mjs'; +import { ChannelManager } from '../structs/ChannelManager.mjs'; +import { TwoTuple_BlockHashChannelManagerZ } from '../structs/TwoTuple_BlockHashChannelManagerZ.mjs'; +import { Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ } from '../structs/Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.mjs'; +import { ChannelConfig } from '../structs/ChannelConfig.mjs'; +import { Result_ChannelConfigDecodeErrorZ } from '../structs/Result_ChannelConfigDecodeErrorZ.mjs'; +import { Result_OutPointDecodeErrorZ } from '../structs/Result_OutPointDecodeErrorZ.mjs'; +import { Type, TypeInterface } from '../structs/Type.mjs'; +import { Option_TypeZ } from '../structs/Option_TypeZ.mjs'; +import { Result_COption_TypeZDecodeErrorZ } from '../structs/Result_COption_TypeZDecodeErrorZ.mjs'; +import { PaymentError } from '../structs/PaymentError.mjs'; +import { Result_PaymentIdPaymentErrorZ } from '../structs/Result_PaymentIdPaymentErrorZ.mjs'; +import { Result_SiPrefixNoneZ } from '../structs/Result_SiPrefixNoneZ.mjs'; +import { Invoice } from '../structs/Invoice.mjs'; +import { Result_InvoiceNoneZ } from '../structs/Result_InvoiceNoneZ.mjs'; +import { SignedRawInvoice } from '../structs/SignedRawInvoice.mjs'; +import { Result_SignedRawInvoiceNoneZ } from '../structs/Result_SignedRawInvoiceNoneZ.mjs'; +import { RawInvoice } from '../structs/RawInvoice.mjs'; +import { InvoiceSignature } from '../structs/InvoiceSignature.mjs'; +import { ThreeTuple_RawInvoice_u832InvoiceSignatureZ } from '../structs/ThreeTuple_RawInvoice_u832InvoiceSignatureZ.mjs'; +import { PayeePubKey } from '../structs/PayeePubKey.mjs'; +import { Result_PayeePubKeyErrorZ } from '../structs/Result_PayeePubKeyErrorZ.mjs'; +import { PrivateRoute } from '../structs/PrivateRoute.mjs'; +import { PositiveTimestamp } from '../structs/PositiveTimestamp.mjs'; +import { Result_PositiveTimestampCreationErrorZ } from '../structs/Result_PositiveTimestampCreationErrorZ.mjs'; +import { Result_NoneSemanticErrorZ } from '../structs/Result_NoneSemanticErrorZ.mjs'; +import { Result_InvoiceSemanticErrorZ } from '../structs/Result_InvoiceSemanticErrorZ.mjs'; +import { Description } from '../structs/Description.mjs'; +import { Result_DescriptionCreationErrorZ } from '../structs/Result_DescriptionCreationErrorZ.mjs'; +import { Result_PrivateRouteCreationErrorZ } from '../structs/Result_PrivateRouteCreationErrorZ.mjs'; +import { Result_StringErrorZ } from '../structs/Result_StringErrorZ.mjs'; +import { Result_ChannelMonitorUpdateDecodeErrorZ } from '../structs/Result_ChannelMonitorUpdateDecodeErrorZ.mjs'; +import { Option_MonitorEventZ } from '../structs/Option_MonitorEventZ.mjs'; +import { Result_COption_MonitorEventZDecodeErrorZ } from '../structs/Result_COption_MonitorEventZDecodeErrorZ.mjs'; +import { Result_HTLCUpdateDecodeErrorZ } from '../structs/Result_HTLCUpdateDecodeErrorZ.mjs'; +import { TwoTuple_OutPointScriptZ } from '../structs/TwoTuple_OutPointScriptZ.mjs'; +import { TwoTuple_u32ScriptZ } from '../structs/TwoTuple_u32ScriptZ.mjs'; +import { TwoTuple_TxidCVec_C2Tuple_u32ScriptZZZ } from '../structs/TwoTuple_TxidCVec_C2Tuple_u32ScriptZZZ.mjs'; +import { TwoTuple_u32TxOutZ } from '../structs/TwoTuple_u32TxOutZ.mjs'; +import { TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ } from '../structs/TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ.mjs'; +import { Balance } from '../structs/Balance.mjs'; +import { TwoTuple_BlockHashChannelMonitorZ } from '../structs/TwoTuple_BlockHashChannelMonitorZ.mjs'; +import { Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ } from '../structs/Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.mjs'; +import { Result_NoneLightningErrorZ } from '../structs/Result_NoneLightningErrorZ.mjs'; +import { TwoTuple_PublicKeyTypeZ } from '../structs/TwoTuple_PublicKeyTypeZ.mjs'; import { Result_boolLightningErrorZ } from '../structs/Result_boolLightningErrorZ.mjs'; import { ThreeTuple_ChannelAnnouncementChannelUpdateChannelUpdateZ } from '../structs/ThreeTuple_ChannelAnnouncementChannelUpdateChannelUpdateZ.mjs'; import { PeerHandleError } from '../structs/PeerHandleError.mjs'; import { Result_CVec_u8ZPeerHandleErrorZ } from '../structs/Result_CVec_u8ZPeerHandleErrorZ.mjs'; import { Result_NonePeerHandleErrorZ } from '../structs/Result_NonePeerHandleErrorZ.mjs'; import { Result_boolPeerHandleErrorZ } from '../structs/Result_boolPeerHandleErrorZ.mjs'; -import { Result_TxOutAccessErrorZ } from '../structs/Result_TxOutAccessErrorZ.mjs'; -import { Result_NoneChannelMonitorUpdateErrZ } from '../structs/Result_NoneChannelMonitorUpdateErrZ.mjs'; -import { Option_C2Tuple_usizeTransactionZZ } from '../structs/Option_C2Tuple_usizeTransactionZZ.mjs'; -import { Option_ClosureReasonZ } from '../structs/Option_ClosureReasonZ.mjs'; -import { Result_COption_ClosureReasonZDecodeErrorZ } from '../structs/Result_COption_ClosureReasonZDecodeErrorZ.mjs'; -import { Option_EventZ } from '../structs/Option_EventZ.mjs'; -import { Result_COption_EventZDecodeErrorZ } from '../structs/Result_COption_EventZDecodeErrorZ.mjs'; import { NodeId } from '../structs/NodeId.mjs'; import { Result_NodeIdDecodeErrorZ } from '../structs/Result_NodeIdDecodeErrorZ.mjs'; import { Result_COption_NetworkUpdateZDecodeErrorZ } from '../structs/Result_COption_NetworkUpdateZDecodeErrorZ.mjs'; import { Access, AccessInterface } from '../structs/Access.mjs'; import { Option_AccessZ } from '../structs/Option_AccessZ.mjs'; -import { DirectionalChannelInfo } from '../structs/DirectionalChannelInfo.mjs'; -import { Result_DirectionalChannelInfoDecodeErrorZ } from '../structs/Result_DirectionalChannelInfoDecodeErrorZ.mjs'; +import { ChannelUpdateInfo } from '../structs/ChannelUpdateInfo.mjs'; +import { Result_ChannelUpdateInfoDecodeErrorZ } from '../structs/Result_ChannelUpdateInfoDecodeErrorZ.mjs'; import { ChannelInfo } from '../structs/ChannelInfo.mjs'; import { Result_ChannelInfoDecodeErrorZ } from '../structs/Result_ChannelInfoDecodeErrorZ.mjs'; import { RoutingFees } from '../structs/RoutingFees.mjs'; import { Result_RoutingFeesDecodeErrorZ } from '../structs/Result_RoutingFeesDecodeErrorZ.mjs'; -import { NetAddress } from '../structs/NetAddress.mjs'; import { NodeAnnouncementInfo } from '../structs/NodeAnnouncementInfo.mjs'; import { Result_NodeAnnouncementInfoDecodeErrorZ } from '../structs/Result_NodeAnnouncementInfoDecodeErrorZ.mjs'; import { NodeInfo } from '../structs/NodeInfo.mjs'; import { Result_NodeInfoDecodeErrorZ } from '../structs/Result_NodeInfoDecodeErrorZ.mjs'; -import { NetworkGraph } from '../structs/NetworkGraph.mjs'; import { Result_NetworkGraphDecodeErrorZ } from '../structs/Result_NetworkGraphDecodeErrorZ.mjs'; import { Option_CVec_NetAddressZZ } from '../structs/Option_CVec_NetAddressZZ.mjs'; -import { ScoringParameters } from '../structs/ScoringParameters.mjs'; -import { Result_ScoringParametersDecodeErrorZ } from '../structs/Result_ScoringParametersDecodeErrorZ.mjs'; -import { InitFeatures } from '../structs/InitFeatures.mjs'; -import { Result_InitFeaturesDecodeErrorZ } from '../structs/Result_InitFeaturesDecodeErrorZ.mjs'; -import { ChannelFeatures } from '../structs/ChannelFeatures.mjs'; -import { Result_ChannelFeaturesDecodeErrorZ } from '../structs/Result_ChannelFeaturesDecodeErrorZ.mjs'; -import { NodeFeatures } from '../structs/NodeFeatures.mjs'; -import { Result_NodeFeaturesDecodeErrorZ } from '../structs/Result_NodeFeaturesDecodeErrorZ.mjs'; -import { InvoiceFeatures } from '../structs/InvoiceFeatures.mjs'; -import { Result_InvoiceFeaturesDecodeErrorZ } from '../structs/Result_InvoiceFeaturesDecodeErrorZ.mjs'; -import { ChannelTypeFeatures } from '../structs/ChannelTypeFeatures.mjs'; -import { Result_ChannelTypeFeaturesDecodeErrorZ } from '../structs/Result_ChannelTypeFeaturesDecodeErrorZ.mjs'; import { Result_NetAddressDecodeErrorZ } from '../structs/Result_NetAddressDecodeErrorZ.mjs'; import { UpdateAddHTLC } from '../structs/UpdateAddHTLC.mjs'; import { UpdateFulfillHTLC } from '../structs/UpdateFulfillHTLC.mjs'; @@ -195,6 +275,7 @@ import { UnsignedChannelUpdate } from '../structs/UnsignedChannelUpdate.mjs'; import { Result_UnsignedChannelUpdateDecodeErrorZ } from '../structs/Result_UnsignedChannelUpdateDecodeErrorZ.mjs'; import { Result_ChannelUpdateDecodeErrorZ } from '../structs/Result_ChannelUpdateDecodeErrorZ.mjs'; import { Result_ErrorMessageDecodeErrorZ } from '../structs/Result_ErrorMessageDecodeErrorZ.mjs'; +import { Result_WarningMessageDecodeErrorZ } from '../structs/Result_WarningMessageDecodeErrorZ.mjs'; import { UnsignedNodeAnnouncement } from '../structs/UnsignedNodeAnnouncement.mjs'; import { Result_UnsignedNodeAnnouncementDecodeErrorZ } from '../structs/Result_UnsignedNodeAnnouncementDecodeErrorZ.mjs'; import { Result_NodeAnnouncementDecodeErrorZ } from '../structs/Result_NodeAnnouncementDecodeErrorZ.mjs'; @@ -205,44 +286,13 @@ import { Result_QueryChannelRangeDecodeErrorZ } from '../structs/Result_QueryCha import { Result_ReplyChannelRangeDecodeErrorZ } from '../structs/Result_ReplyChannelRangeDecodeErrorZ.mjs'; import { GossipTimestampFilter } from '../structs/GossipTimestampFilter.mjs'; import { Result_GossipTimestampFilterDecodeErrorZ } from '../structs/Result_GossipTimestampFilterDecodeErrorZ.mjs'; -import { Result_DelayedPaymentOutputDescriptorDecodeErrorZ } from '../structs/Result_DelayedPaymentOutputDescriptorDecodeErrorZ.mjs'; -import { Result_StaticPaymentOutputDescriptorDecodeErrorZ } from '../structs/Result_StaticPaymentOutputDescriptorDecodeErrorZ.mjs'; -import { Result_SpendableOutputDescriptorDecodeErrorZ } from '../structs/Result_SpendableOutputDescriptorDecodeErrorZ.mjs'; -import { Result_SignDecodeErrorZ } from '../structs/Result_SignDecodeErrorZ.mjs'; -import { Result_RecoverableSignatureNoneZ } from '../structs/Result_RecoverableSignatureNoneZ.mjs'; -import { Result_CVec_CVec_u8ZZNoneZ } from '../structs/Result_CVec_CVec_u8ZZNoneZ.mjs'; -import { InMemorySigner } from '../structs/InMemorySigner.mjs'; -import { Result_InMemorySignerDecodeErrorZ } from '../structs/Result_InMemorySignerDecodeErrorZ.mjs'; -import { Result_TransactionNoneZ } from '../structs/Result_TransactionNoneZ.mjs'; +import { SignOrCreationError } from '../structs/SignOrCreationError.mjs'; +import { Result_InvoiceSignOrCreationErrorZ } from '../structs/Result_InvoiceSignOrCreationErrorZ.mjs'; import { WatchedOutput } from '../structs/WatchedOutput.mjs'; import { Filter, FilterInterface } from '../structs/Filter.mjs'; import { Option_FilterZ } from '../structs/Option_FilterZ.mjs'; import { LockedChannelMonitor } from '../structs/LockedChannelMonitor.mjs'; import { Result_LockedChannelMonitorNoneZ } from '../structs/Result_LockedChannelMonitorNoneZ.mjs'; -import { APIError } from '../structs/APIError.mjs'; -import { Result_NoneAPIErrorZ } from '../structs/Result_NoneAPIErrorZ.mjs'; -import { Option_u16Z } from '../structs/Option_u16Z.mjs'; -import { Result__u832APIErrorZ } from '../structs/Result__u832APIErrorZ.mjs'; -import { PaymentSendFailure } from '../structs/PaymentSendFailure.mjs'; -import { Result_PaymentIdPaymentSendFailureZ } from '../structs/Result_PaymentIdPaymentSendFailureZ.mjs'; -import { Result_NonePaymentSendFailureZ } from '../structs/Result_NonePaymentSendFailureZ.mjs'; -import { TwoTuple_PaymentHashPaymentIdZ } from '../structs/TwoTuple_PaymentHashPaymentIdZ.mjs'; -import { Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ } from '../structs/Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ.mjs'; -import { TwoTuple_PaymentHashPaymentSecretZ } from '../structs/TwoTuple_PaymentHashPaymentSecretZ.mjs'; -import { Result_C2Tuple_PaymentHashPaymentSecretZNoneZ } from '../structs/Result_C2Tuple_PaymentHashPaymentSecretZNoneZ.mjs'; -import { Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ } from '../structs/Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ.mjs'; -import { Result_PaymentSecretNoneZ } from '../structs/Result_PaymentSecretNoneZ.mjs'; -import { Result_PaymentSecretAPIErrorZ } from '../structs/Result_PaymentSecretAPIErrorZ.mjs'; -import { Result_PaymentPreimageAPIErrorZ } from '../structs/Result_PaymentPreimageAPIErrorZ.mjs'; -import { Watch, WatchInterface } from '../structs/Watch.mjs'; -import { BroadcasterInterface, BroadcasterInterfaceInterface } from '../structs/BroadcasterInterface.mjs'; -import { KeysInterface, KeysInterfaceInterface } from '../structs/KeysInterface.mjs'; -import { FeeEstimator, FeeEstimatorInterface } from '../structs/FeeEstimator.mjs'; -import { Record } from '../structs/Record.mjs'; -import { Logger, LoggerInterface } from '../structs/Logger.mjs'; -import { ChannelManager } from '../structs/ChannelManager.mjs'; -import { TwoTuple_BlockHashChannelManagerZ } from '../structs/TwoTuple_BlockHashChannelManagerZ.mjs'; -import { Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ } from '../structs/Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.mjs'; import { MessageSendEventsProvider, MessageSendEventsProviderInterface } from '../structs/MessageSendEventsProvider.mjs'; import { EventHandler, EventHandlerInterface } from '../structs/EventHandler.mjs'; import { EventsProvider, EventsProviderInterface } from '../structs/EventsProvider.mjs'; @@ -256,9 +306,8 @@ import { MonitorUpdateId } from '../structs/MonitorUpdateId.mjs'; import { Persist, PersistInterface } from '../structs/Persist.mjs'; import { ChainMonitor } from '../structs/ChainMonitor.mjs'; import { KeysManager } from '../structs/KeysManager.mjs'; +import { PhantomKeysManager } from '../structs/PhantomKeysManager.mjs'; import { ChainParameters } from '../structs/ChainParameters.mjs'; -import { CounterpartyForwardingInfo } from '../structs/CounterpartyForwardingInfo.mjs'; -import { ChannelCounterparty } from '../structs/ChannelCounterparty.mjs'; import { ChannelMessageHandler, ChannelMessageHandlerInterface } from '../structs/ChannelMessageHandler.mjs'; import { ChannelManagerReadArgs } from '../structs/ChannelManagerReadArgs.mjs'; import { DataLossProtect } from '../structs/DataLossProtect.mjs'; @@ -273,30 +322,60 @@ import { PeerManager } from '../structs/PeerManager.mjs'; import { DirectedChannelTransactionParameters } from '../structs/DirectedChannelTransactionParameters.mjs'; import { ReadOnlyNetworkGraph } from '../structs/ReadOnlyNetworkGraph.mjs'; import { NetGraphMsgHandler } from '../structs/NetGraphMsgHandler.mjs'; +import { DirectedChannelInfo } from '../structs/DirectedChannelInfo.mjs'; +import { EffectiveCapacity } from '../structs/EffectiveCapacity.mjs'; import { Score, ScoreInterface } from '../structs/Score.mjs'; import { LockableScore, LockableScoreInterface } from '../structs/LockableScore.mjs'; import { MultiThreadedLockableScore } from '../structs/MultiThreadedLockableScore.mjs'; - -import CommonBase from './CommonBase.mjs'; +import { RawDataPart } from '../structs/RawDataPart.mjs'; +import { Sha256 } from '../structs/Sha256.mjs'; +import { ExpiryTime } from '../structs/ExpiryTime.mjs'; +import { MinFinalCltvExpiry } from '../structs/MinFinalCltvExpiry.mjs'; +import { Fallback } from '../structs/Fallback.mjs'; +import { Payer, PayerInterface } from '../structs/Payer.mjs'; +import { Router, RouterInterface } from '../structs/Router.mjs'; +import { InvoicePayer } from '../structs/InvoicePayer.mjs'; +import { RetryAttempts } from '../structs/RetryAttempts.mjs'; +import { DefaultRouter } from '../structs/DefaultRouter.mjs'; + +import { CommonBase, UInt5 } from './CommonBase.mjs'; import * as bindings from '../bindings.mjs' -import * as InternalUtils from '../InternalUtils.mjs' +/** + * Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels + */ export class ChannelDetails extends CommonBase { /* @internal */ public constructor(_dummy: object, ptr: number) { super(ptr, bindings.ChannelDetails_free); } + /** + * The channel's ID (prior to funding transaction generation, this is a random 32 bytes, + * thereafter this is the txid of the funding transaction xor the funding transaction output). + * Note that this means this value is *not* persistent - it can change once during the + * lifetime of the channel. + */ public get_channel_id(): Uint8Array { - const ret: Uint8Array = bindings.ChannelDetails_get_channel_id(this.ptr); - return ret; + const ret: number = bindings.ChannelDetails_get_channel_id(this.ptr); + const ret_conv: Uint8Array = bindings.decodeUint8Array(ret); + return ret_conv; } + /** + * The channel's ID (prior to funding transaction generation, this is a random 32 bytes, + * thereafter this is the txid of the funding transaction xor the funding transaction output). + * Note that this means this value is *not* persistent - it can change once during the + * lifetime of the channel. + */ public set_channel_id(val: Uint8Array): void { - bindings.ChannelDetails_set_channel_id(this.ptr, InternalUtils.check_arr_len(val, 32)); + bindings.ChannelDetails_set_channel_id(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(val, 32))); } + /** + * Parameters which apply to our counterparty. See individual fields for more information. + */ public get_counterparty(): ChannelCounterparty { const ret: number = bindings.ChannelDetails_get_counterparty(this.ptr); const ret_hu_conv: ChannelCounterparty = new ChannelCounterparty(null, ret); @@ -304,10 +383,22 @@ export class ChannelDetails extends CommonBase { return ret_hu_conv; } + /** + * Parameters which apply to our counterparty. See individual fields for more information. + */ public set_counterparty(val: ChannelCounterparty): void { bindings.ChannelDetails_set_counterparty(this.ptr, val == null ? 0 : CommonBase.get_ptr_of(val) & ~1); } + /** + * The Channel's funding transaction output, if we've negotiated the funding transaction with + * our counterparty already. + * + * Note that, if this has been set, `channel_id` will be equivalent to + * `funding_txo.unwrap().to_channel_id()`. + * + * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None + */ public get_funding_txo(): OutPoint { const ret: number = bindings.ChannelDetails_get_funding_txo(this.ptr); const ret_hu_conv: OutPoint = new OutPoint(null, ret); @@ -315,10 +406,23 @@ export class ChannelDetails extends CommonBase { return ret_hu_conv; } + /** + * The Channel's funding transaction output, if we've negotiated the funding transaction with + * our counterparty already. + * + * Note that, if this has been set, `channel_id` will be equivalent to + * `funding_txo.unwrap().to_channel_id()`. + * + * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None + */ public set_funding_txo(val: OutPoint): void { bindings.ChannelDetails_set_funding_txo(this.ptr, val == null ? 0 : CommonBase.get_ptr_of(val) & ~1); } + /** + * The position of the funding transaction in the chain. None if the funding transaction has + * not yet been confirmed and the channel fully opened. + */ public get_short_channel_id(): Option_u64Z { const ret: number = bindings.ChannelDetails_get_short_channel_id(this.ptr); const ret_hu_conv: Option_u64Z = Option_u64Z.constr_from_ptr(ret); @@ -326,19 +430,40 @@ export class ChannelDetails extends CommonBase { return ret_hu_conv; } + /** + * The position of the funding transaction in the chain. None if the funding transaction has + * not yet been confirmed and the channel fully opened. + */ public set_short_channel_id(val: Option_u64Z): void { bindings.ChannelDetails_set_short_channel_id(this.ptr, CommonBase.get_ptr_of(val)); } - public get_channel_value_satoshis(): number { - const ret: number = bindings.ChannelDetails_get_channel_value_satoshis(this.ptr); + /** + * The value, in satoshis, of this channel as appears in the funding output + */ + public get_channel_value_satoshis(): bigint { + const ret: bigint = bindings.ChannelDetails_get_channel_value_satoshis(this.ptr); return ret; } - public set_channel_value_satoshis(val: number): void { + /** + * The value, in satoshis, of this channel as appears in the funding output + */ + public set_channel_value_satoshis(val: bigint): void { bindings.ChannelDetails_set_channel_value_satoshis(this.ptr, val); } + /** + * The value, in satoshis, that must always be held in the channel for us. This value ensures + * that if we broadcast a revoked state, our counterparty can punish us by claiming at least + * this value on chain. + * + * This value is not included in [`outbound_capacity_msat`] as it can never be spent. + * + * This value will be `None` for outbound channels until the counterparty accepts the channel. + * + * [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat + */ public get_unspendable_punishment_reserve(): Option_u64Z { const ret: number = bindings.ChannelDetails_get_unspendable_punishment_reserve(this.ptr); const ret_hu_conv: Option_u64Z = Option_u64Z.constr_from_ptr(ret); @@ -346,46 +471,146 @@ export class ChannelDetails extends CommonBase { return ret_hu_conv; } + /** + * The value, in satoshis, that must always be held in the channel for us. This value ensures + * that if we broadcast a revoked state, our counterparty can punish us by claiming at least + * this value on chain. + * + * This value is not included in [`outbound_capacity_msat`] as it can never be spent. + * + * This value will be `None` for outbound channels until the counterparty accepts the channel. + * + * [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat + */ public set_unspendable_punishment_reserve(val: Option_u64Z): void { bindings.ChannelDetails_set_unspendable_punishment_reserve(this.ptr, CommonBase.get_ptr_of(val)); } - public get_user_channel_id(): number { - const ret: number = bindings.ChannelDetails_get_user_channel_id(this.ptr); + /** + * The `user_channel_id` passed in to create_channel, or 0 if the channel was inbound. + */ + public get_user_channel_id(): bigint { + const ret: bigint = bindings.ChannelDetails_get_user_channel_id(this.ptr); return ret; } - public set_user_channel_id(val: number): void { + /** + * The `user_channel_id` passed in to create_channel, or 0 if the channel was inbound. + */ + public set_user_channel_id(val: bigint): void { bindings.ChannelDetails_set_user_channel_id(this.ptr, val); } - public get_balance_msat(): number { - const ret: number = bindings.ChannelDetails_get_balance_msat(this.ptr); + /** + * Our total balance. This is the amount we would get if we close the channel. + * This value is not exact. Due to various in-flight changes and feerate changes, exactly this + * amount is not likely to be recoverable on close. + * + * This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose + * balance is not available for inclusion in new outbound HTLCs). This further does not include + * any pending outgoing HTLCs which are awaiting some other resolution to be sent. + * This does not consider any on-chain fees. + * + * See also [`ChannelDetails::outbound_capacity_msat`] + */ + public get_balance_msat(): bigint { + const ret: bigint = bindings.ChannelDetails_get_balance_msat(this.ptr); return ret; } - public set_balance_msat(val: number): void { + /** + * Our total balance. This is the amount we would get if we close the channel. + * This value is not exact. Due to various in-flight changes and feerate changes, exactly this + * amount is not likely to be recoverable on close. + * + * This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose + * balance is not available for inclusion in new outbound HTLCs). This further does not include + * any pending outgoing HTLCs which are awaiting some other resolution to be sent. + * This does not consider any on-chain fees. + * + * See also [`ChannelDetails::outbound_capacity_msat`] + */ + public set_balance_msat(val: bigint): void { bindings.ChannelDetails_set_balance_msat(this.ptr, val); } - public get_outbound_capacity_msat(): number { - const ret: number = bindings.ChannelDetails_get_outbound_capacity_msat(this.ptr); + /** + * The available outbound capacity for sending HTLCs to the remote peer. This does not include + * any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not + * available for inclusion in new outbound HTLCs). This further does not include any pending + * outgoing HTLCs which are awaiting some other resolution to be sent. + * + * See also [`ChannelDetails::balance_msat`] + * + * This value is not exact. Due to various in-flight changes, feerate changes, and our + * conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we + * should be able to spend nearly this amount. + */ + public get_outbound_capacity_msat(): bigint { + const ret: bigint = bindings.ChannelDetails_get_outbound_capacity_msat(this.ptr); return ret; } - public set_outbound_capacity_msat(val: number): void { + /** + * The available outbound capacity for sending HTLCs to the remote peer. This does not include + * any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not + * available for inclusion in new outbound HTLCs). This further does not include any pending + * outgoing HTLCs which are awaiting some other resolution to be sent. + * + * See also [`ChannelDetails::balance_msat`] + * + * This value is not exact. Due to various in-flight changes, feerate changes, and our + * conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we + * should be able to spend nearly this amount. + */ + public set_outbound_capacity_msat(val: bigint): void { bindings.ChannelDetails_set_outbound_capacity_msat(this.ptr, val); } - public get_inbound_capacity_msat(): number { - const ret: number = bindings.ChannelDetails_get_inbound_capacity_msat(this.ptr); + /** + * The available inbound capacity for the remote peer to send HTLCs to us. This does not + * include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not + * available for inclusion in new inbound HTLCs). + * Note that there are some corner cases not fully handled here, so the actual available + * inbound capacity may be slightly higher than this. + * + * This value is not exact. Due to various in-flight changes, feerate changes, and our + * counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable. + * However, our counterparty should be able to spend nearly this amount. + */ + public get_inbound_capacity_msat(): bigint { + const ret: bigint = bindings.ChannelDetails_get_inbound_capacity_msat(this.ptr); return ret; } - public set_inbound_capacity_msat(val: number): void { + /** + * The available inbound capacity for the remote peer to send HTLCs to us. This does not + * include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not + * available for inclusion in new inbound HTLCs). + * Note that there are some corner cases not fully handled here, so the actual available + * inbound capacity may be slightly higher than this. + * + * This value is not exact. Due to various in-flight changes, feerate changes, and our + * counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable. + * However, our counterparty should be able to spend nearly this amount. + */ + public set_inbound_capacity_msat(val: bigint): void { bindings.ChannelDetails_set_inbound_capacity_msat(this.ptr, val); } + /** + * The number of required confirmations on the funding transaction before the funding will be + * considered \"locked\". This number is selected by the channel fundee (i.e. us if + * [`is_outbound`] is *not* set), and can be selected for inbound channels with + * [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with + * [`ChannelHandshakeLimits::max_minimum_depth`]. + * + * This value will be `None` for outbound channels until the counterparty accepts the channel. + * + * [`is_outbound`]: ChannelDetails::is_outbound + * [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth + * [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth + */ public get_confirmations_required(): Option_u32Z { const ret: number = bindings.ChannelDetails_get_confirmations_required(this.ptr); const ret_hu_conv: Option_u32Z = Option_u32Z.constr_from_ptr(ret); @@ -393,10 +618,32 @@ export class ChannelDetails extends CommonBase { return ret_hu_conv; } + /** + * The number of required confirmations on the funding transaction before the funding will be + * considered \"locked\". This number is selected by the channel fundee (i.e. us if + * [`is_outbound`] is *not* set), and can be selected for inbound channels with + * [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with + * [`ChannelHandshakeLimits::max_minimum_depth`]. + * + * This value will be `None` for outbound channels until the counterparty accepts the channel. + * + * [`is_outbound`]: ChannelDetails::is_outbound + * [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth + * [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth + */ public set_confirmations_required(val: Option_u32Z): void { bindings.ChannelDetails_set_confirmations_required(this.ptr, CommonBase.get_ptr_of(val)); } + /** + * The number of blocks (after our commitment transaction confirms) that we will need to wait + * until we can claim our funds after we force-close the channel. During this time our + * counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty + * force-closes the channel and broadcasts a commitment transaction we do not have to wait any + * time to claim our non-HTLC-encumbered funds. + * + * This value will be `None` for outbound channels until the counterparty accepts the channel. + */ public get_force_close_spend_delay(): Option_u16Z { const ret: number = bindings.ChannelDetails_get_force_close_spend_delay(this.ptr); const ret_hu_conv: Option_u16Z = Option_u16Z.constr_from_ptr(ret); @@ -404,48 +651,102 @@ export class ChannelDetails extends CommonBase { return ret_hu_conv; } + /** + * The number of blocks (after our commitment transaction confirms) that we will need to wait + * until we can claim our funds after we force-close the channel. During this time our + * counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty + * force-closes the channel and broadcasts a commitment transaction we do not have to wait any + * time to claim our non-HTLC-encumbered funds. + * + * This value will be `None` for outbound channels until the counterparty accepts the channel. + */ public set_force_close_spend_delay(val: Option_u16Z): void { bindings.ChannelDetails_set_force_close_spend_delay(this.ptr, CommonBase.get_ptr_of(val)); } + /** + * True if the channel was initiated (and thus funded) by us. + */ public get_is_outbound(): boolean { const ret: boolean = bindings.ChannelDetails_get_is_outbound(this.ptr); return ret; } + /** + * True if the channel was initiated (and thus funded) by us. + */ public set_is_outbound(val: boolean): void { bindings.ChannelDetails_set_is_outbound(this.ptr, val); } + /** + * True if the channel is confirmed, funding_locked messages have been exchanged, and the + * channel is not currently being shut down. `funding_locked` message exchange implies the + * required confirmation count has been reached (and we were connected to the peer at some + * point after the funding transaction received enough confirmations). The required + * confirmation count is provided in [`confirmations_required`]. + * + * [`confirmations_required`]: ChannelDetails::confirmations_required + */ public get_is_funding_locked(): boolean { const ret: boolean = bindings.ChannelDetails_get_is_funding_locked(this.ptr); return ret; } + /** + * True if the channel is confirmed, funding_locked messages have been exchanged, and the + * channel is not currently being shut down. `funding_locked` message exchange implies the + * required confirmation count has been reached (and we were connected to the peer at some + * point after the funding transaction received enough confirmations). The required + * confirmation count is provided in [`confirmations_required`]. + * + * [`confirmations_required`]: ChannelDetails::confirmations_required + */ public set_is_funding_locked(val: boolean): void { bindings.ChannelDetails_set_is_funding_locked(this.ptr, val); } + /** + * True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b) + * the peer is connected, and (c) the channel is not currently negotiating a shutdown. + * + * This is a strict superset of `is_funding_locked`. + */ public get_is_usable(): boolean { const ret: boolean = bindings.ChannelDetails_get_is_usable(this.ptr); return ret; } + /** + * True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b) + * the peer is connected, and (c) the channel is not currently negotiating a shutdown. + * + * This is a strict superset of `is_funding_locked`. + */ public set_is_usable(val: boolean): void { bindings.ChannelDetails_set_is_usable(this.ptr, val); } + /** + * True if this channel is (or will be) publicly-announced. + */ public get_is_public(): boolean { const ret: boolean = bindings.ChannelDetails_get_is_public(this.ptr); return ret; } + /** + * True if this channel is (or will be) publicly-announced. + */ public set_is_public(val: boolean): void { bindings.ChannelDetails_set_is_public(this.ptr, val); } - public static constructor_new(channel_id_arg: Uint8Array, counterparty_arg: ChannelCounterparty, funding_txo_arg: OutPoint, short_channel_id_arg: Option_u64Z, channel_value_satoshis_arg: number, unspendable_punishment_reserve_arg: Option_u64Z, user_channel_id_arg: number, balance_msat_arg: number, outbound_capacity_msat_arg: number, inbound_capacity_msat_arg: number, confirmations_required_arg: Option_u32Z, force_close_spend_delay_arg: Option_u16Z, is_outbound_arg: boolean, is_funding_locked_arg: boolean, is_usable_arg: boolean, is_public_arg: boolean): ChannelDetails { - const ret: number = bindings.ChannelDetails_new(InternalUtils.check_arr_len(channel_id_arg, 32), counterparty_arg == null ? 0 : CommonBase.get_ptr_of(counterparty_arg) & ~1, funding_txo_arg == null ? 0 : CommonBase.get_ptr_of(funding_txo_arg) & ~1, CommonBase.get_ptr_of(short_channel_id_arg), channel_value_satoshis_arg, CommonBase.get_ptr_of(unspendable_punishment_reserve_arg), user_channel_id_arg, balance_msat_arg, outbound_capacity_msat_arg, inbound_capacity_msat_arg, CommonBase.get_ptr_of(confirmations_required_arg), CommonBase.get_ptr_of(force_close_spend_delay_arg), is_outbound_arg, is_funding_locked_arg, is_usable_arg, is_public_arg); + /** + * Constructs a new ChannelDetails given each field + */ + public static constructor_new(channel_id_arg: Uint8Array, counterparty_arg: ChannelCounterparty, funding_txo_arg: OutPoint, short_channel_id_arg: Option_u64Z, channel_value_satoshis_arg: bigint, unspendable_punishment_reserve_arg: Option_u64Z, user_channel_id_arg: bigint, balance_msat_arg: bigint, outbound_capacity_msat_arg: bigint, inbound_capacity_msat_arg: bigint, confirmations_required_arg: Option_u32Z, force_close_spend_delay_arg: Option_u16Z, is_outbound_arg: boolean, is_funding_locked_arg: boolean, is_usable_arg: boolean, is_public_arg: boolean): ChannelDetails { + const ret: number = bindings.ChannelDetails_new(bindings.encodeUint8Array(bindings.check_arr_len(channel_id_arg, 32)), counterparty_arg == null ? 0 : CommonBase.get_ptr_of(counterparty_arg) & ~1, funding_txo_arg == null ? 0 : CommonBase.get_ptr_of(funding_txo_arg) & ~1, CommonBase.get_ptr_of(short_channel_id_arg), channel_value_satoshis_arg, CommonBase.get_ptr_of(unspendable_punishment_reserve_arg), user_channel_id_arg, balance_msat_arg, outbound_capacity_msat_arg, inbound_capacity_msat_arg, CommonBase.get_ptr_of(confirmations_required_arg), CommonBase.get_ptr_of(force_close_spend_delay_arg), is_outbound_arg, is_funding_locked_arg, is_usable_arg, is_public_arg); const ret_hu_conv: ChannelDetails = new ChannelDetails(null, ret); CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv); return ret_hu_conv; @@ -456,6 +757,9 @@ export class ChannelDetails extends CommonBase { return ret; } + /** + * Creates a copy of the ChannelDetails + */ public clone(): ChannelDetails { const ret: number = bindings.ChannelDetails_clone(this.ptr); const ret_hu_conv: ChannelDetails = new ChannelDetails(null, ret); @@ -463,4 +767,22 @@ export class ChannelDetails extends CommonBase { return ret_hu_conv; } + /** + * Serialize the ChannelDetails object into a byte array which can be read by ChannelDetails_read + */ + public write(): Uint8Array { + const ret: number = bindings.ChannelDetails_write(this.ptr); + const ret_conv: Uint8Array = bindings.decodeUint8Array(ret); + return ret_conv; + } + + /** + * Read a ChannelDetails from a byte array, created by ChannelDetails_write + */ + public static constructor_read(ser: Uint8Array): Result_ChannelDetailsDecodeErrorZ { + const ret: number = bindings.ChannelDetails_read(bindings.encodeUint8Array(ser)); + const ret_hu_conv: Result_ChannelDetailsDecodeErrorZ = Result_ChannelDetailsDecodeErrorZ.constr_from_ptr(ret); + return ret_hu_conv; + } + }