1 import { TxOut } from '../structs/TxOut.mjs';
2 import { AccessError } from '../enums/AccessError.mjs';
3 import { COption_NoneZ } from '../enums/COption_NoneZ.mjs';
4 import { ChannelMonitorUpdateErr } from '../enums/ChannelMonitorUpdateErr.mjs';
5 import { ConfirmationTarget } from '../enums/ConfirmationTarget.mjs';
6 import { CreationError } from '../enums/CreationError.mjs';
7 import { Currency } from '../enums/Currency.mjs';
8 import { IOError } from '../enums/IOError.mjs';
9 import { Level } from '../enums/Level.mjs';
10 import { Network } from '../enums/Network.mjs';
11 import { Recipient } from '../enums/Recipient.mjs';
12 import { Secp256k1Error } from '../enums/Secp256k1Error.mjs';
13 import { SemanticError } from '../enums/SemanticError.mjs';
14 import { SiPrefix } from '../enums/SiPrefix.mjs';
15 import { Bech32Error } from '../structs/Bech32Error.mjs';
16 import { Result_NoneNoneZ } from '../structs/Result_NoneNoneZ.mjs';
17 import { CounterpartyCommitmentSecrets } from '../structs/CounterpartyCommitmentSecrets.mjs';
18 import { DecodeError } from '../structs/DecodeError.mjs';
19 import { Result_CounterpartyCommitmentSecretsDecodeErrorZ } from '../structs/Result_CounterpartyCommitmentSecretsDecodeErrorZ.mjs';
20 import { Result_SecretKeyErrorZ } from '../structs/Result_SecretKeyErrorZ.mjs';
21 import { Result_PublicKeyErrorZ } from '../structs/Result_PublicKeyErrorZ.mjs';
22 import { TxCreationKeys } from '../structs/TxCreationKeys.mjs';
23 import { Result_TxCreationKeysDecodeErrorZ } from '../structs/Result_TxCreationKeysDecodeErrorZ.mjs';
24 import { ChannelPublicKeys } from '../structs/ChannelPublicKeys.mjs';
25 import { Result_ChannelPublicKeysDecodeErrorZ } from '../structs/Result_ChannelPublicKeysDecodeErrorZ.mjs';
26 import { Result_TxCreationKeysErrorZ } from '../structs/Result_TxCreationKeysErrorZ.mjs';
27 import { Option_u32Z } from '../structs/Option_u32Z.mjs';
28 import { HTLCOutputInCommitment } from '../structs/HTLCOutputInCommitment.mjs';
29 import { Result_HTLCOutputInCommitmentDecodeErrorZ } from '../structs/Result_HTLCOutputInCommitmentDecodeErrorZ.mjs';
30 import { CounterpartyChannelTransactionParameters } from '../structs/CounterpartyChannelTransactionParameters.mjs';
31 import { Result_CounterpartyChannelTransactionParametersDecodeErrorZ } from '../structs/Result_CounterpartyChannelTransactionParametersDecodeErrorZ.mjs';
32 import { ChannelTransactionParameters } from '../structs/ChannelTransactionParameters.mjs';
33 import { Result_ChannelTransactionParametersDecodeErrorZ } from '../structs/Result_ChannelTransactionParametersDecodeErrorZ.mjs';
34 import { HolderCommitmentTransaction } from '../structs/HolderCommitmentTransaction.mjs';
35 import { Result_HolderCommitmentTransactionDecodeErrorZ } from '../structs/Result_HolderCommitmentTransactionDecodeErrorZ.mjs';
36 import { BuiltCommitmentTransaction } from '../structs/BuiltCommitmentTransaction.mjs';
37 import { Result_BuiltCommitmentTransactionDecodeErrorZ } from '../structs/Result_BuiltCommitmentTransactionDecodeErrorZ.mjs';
38 import { TrustedClosingTransaction } from '../structs/TrustedClosingTransaction.mjs';
39 import { Result_TrustedClosingTransactionNoneZ } from '../structs/Result_TrustedClosingTransactionNoneZ.mjs';
40 import { CommitmentTransaction } from '../structs/CommitmentTransaction.mjs';
41 import { Result_CommitmentTransactionDecodeErrorZ } from '../structs/Result_CommitmentTransactionDecodeErrorZ.mjs';
42 import { TrustedCommitmentTransaction } from '../structs/TrustedCommitmentTransaction.mjs';
43 import { Result_TrustedCommitmentTransactionNoneZ } from '../structs/Result_TrustedCommitmentTransactionNoneZ.mjs';
44 import { Result_CVec_SignatureZNoneZ } from '../structs/Result_CVec_SignatureZNoneZ.mjs';
45 import { ShutdownScript } from '../structs/ShutdownScript.mjs';
46 import { Result_ShutdownScriptDecodeErrorZ } from '../structs/Result_ShutdownScriptDecodeErrorZ.mjs';
47 import { InvalidShutdownScript } from '../structs/InvalidShutdownScript.mjs';
48 import { Result_ShutdownScriptInvalidShutdownScriptZ } from '../structs/Result_ShutdownScriptInvalidShutdownScriptZ.mjs';
49 import { RouteHop } from '../structs/RouteHop.mjs';
50 import { Result_RouteHopDecodeErrorZ } from '../structs/Result_RouteHopDecodeErrorZ.mjs';
51 import { Route } from '../structs/Route.mjs';
52 import { Result_RouteDecodeErrorZ } from '../structs/Result_RouteDecodeErrorZ.mjs';
53 import { RouteParameters } from '../structs/RouteParameters.mjs';
54 import { Result_RouteParametersDecodeErrorZ } from '../structs/Result_RouteParametersDecodeErrorZ.mjs';
55 import { RouteHint } from '../structs/RouteHint.mjs';
56 import { Option_u64Z } from '../structs/Option_u64Z.mjs';
57 import { PaymentParameters } from '../structs/PaymentParameters.mjs';
58 import { Result_PaymentParametersDecodeErrorZ } from '../structs/Result_PaymentParametersDecodeErrorZ.mjs';
59 import { RouteHintHop } from '../structs/RouteHintHop.mjs';
60 import { Result_RouteHintDecodeErrorZ } from '../structs/Result_RouteHintDecodeErrorZ.mjs';
61 import { Result_RouteHintHopDecodeErrorZ } from '../structs/Result_RouteHintHopDecodeErrorZ.mjs';
62 import { LightningError } from '../structs/LightningError.mjs';
63 import { Result_RouteLightningErrorZ } from '../structs/Result_RouteLightningErrorZ.mjs';
64 import { PaymentPurpose } from '../structs/PaymentPurpose.mjs';
65 import { Result_PaymentPurposeDecodeErrorZ } from '../structs/Result_PaymentPurposeDecodeErrorZ.mjs';
66 import { ClosureReason } from '../structs/ClosureReason.mjs';
67 import { Option_ClosureReasonZ } from '../structs/Option_ClosureReasonZ.mjs';
68 import { Result_COption_ClosureReasonZDecodeErrorZ } from '../structs/Result_COption_ClosureReasonZDecodeErrorZ.mjs';
69 import { ChannelUpdate } from '../structs/ChannelUpdate.mjs';
70 import { NetworkUpdate } from '../structs/NetworkUpdate.mjs';
71 import { Option_NetworkUpdateZ } from '../structs/Option_NetworkUpdateZ.mjs';
72 import { OutPoint } from '../structs/OutPoint.mjs';
73 import { DelayedPaymentOutputDescriptor } from '../structs/DelayedPaymentOutputDescriptor.mjs';
74 import { StaticPaymentOutputDescriptor } from '../structs/StaticPaymentOutputDescriptor.mjs';
75 import { SpendableOutputDescriptor } from '../structs/SpendableOutputDescriptor.mjs';
76 import { ChannelTypeFeatures } from '../structs/ChannelTypeFeatures.mjs';
77 import { Event } from '../structs/Event.mjs';
78 import { Option_EventZ } from '../structs/Option_EventZ.mjs';
79 import { Result_COption_EventZDecodeErrorZ } from '../structs/Result_COption_EventZDecodeErrorZ.mjs';
80 import { AcceptChannel } from '../structs/AcceptChannel.mjs';
81 import { OpenChannel } from '../structs/OpenChannel.mjs';
82 import { FundingCreated } from '../structs/FundingCreated.mjs';
83 import { FundingSigned } from '../structs/FundingSigned.mjs';
84 import { ChannelReady } from '../structs/ChannelReady.mjs';
85 import { AnnouncementSignatures } from '../structs/AnnouncementSignatures.mjs';
86 import { CommitmentUpdate } from '../structs/CommitmentUpdate.mjs';
87 import { RevokeAndACK } from '../structs/RevokeAndACK.mjs';
88 import { ClosingSigned } from '../structs/ClosingSigned.mjs';
89 import { Shutdown } from '../structs/Shutdown.mjs';
90 import { ChannelReestablish } from '../structs/ChannelReestablish.mjs';
91 import { ChannelAnnouncement } from '../structs/ChannelAnnouncement.mjs';
92 import { NodeAnnouncement } from '../structs/NodeAnnouncement.mjs';
93 import { ErrorMessage } from '../structs/ErrorMessage.mjs';
94 import { WarningMessage } from '../structs/WarningMessage.mjs';
95 import { ErrorAction } from '../structs/ErrorAction.mjs';
96 import { QueryChannelRange } from '../structs/QueryChannelRange.mjs';
97 import { QueryShortChannelIds } from '../structs/QueryShortChannelIds.mjs';
98 import { ReplyChannelRange } from '../structs/ReplyChannelRange.mjs';
99 import { GossipTimestampFilter } from '../structs/GossipTimestampFilter.mjs';
100 import { MessageSendEvent } from '../structs/MessageSendEvent.mjs';
101 import { Result_TxOutAccessErrorZ } from '../structs/Result_TxOutAccessErrorZ.mjs';
102 import { TwoTuple_usizeTransactionZ } from '../structs/TwoTuple_usizeTransactionZ.mjs';
103 import { Result_NoneChannelMonitorUpdateErrZ } from '../structs/Result_NoneChannelMonitorUpdateErrZ.mjs';
104 import { HTLCUpdate } from '../structs/HTLCUpdate.mjs';
105 import { MonitorEvent } from '../structs/MonitorEvent.mjs';
106 import { TwoTuple_OutPointCVec_MonitorEventZZ } from '../structs/TwoTuple_OutPointCVec_MonitorEventZZ.mjs';
107 import { Option_C2Tuple_usizeTransactionZZ } from '../structs/Option_C2Tuple_usizeTransactionZZ.mjs';
108 import { FixedPenaltyScorer } from '../structs/FixedPenaltyScorer.mjs';
109 import { Result_FixedPenaltyScorerDecodeErrorZ } from '../structs/Result_FixedPenaltyScorerDecodeErrorZ.mjs';
110 import { TwoTuple_u64u64Z } from '../structs/TwoTuple_u64u64Z.mjs';
111 import { Option_C2Tuple_u64u64ZZ } from '../structs/Option_C2Tuple_u64u64ZZ.mjs';
112 import { NodeId } from '../structs/NodeId.mjs';
113 import { Record } from '../structs/Record.mjs';
114 import { Logger, LoggerInterface } from '../structs/Logger.mjs';
115 import { NetworkGraph } from '../structs/NetworkGraph.mjs';
116 import { ProbabilisticScorer } from '../structs/ProbabilisticScorer.mjs';
117 import { Result_ProbabilisticScorerDecodeErrorZ } from '../structs/Result_ProbabilisticScorerDecodeErrorZ.mjs';
118 import { InitFeatures } from '../structs/InitFeatures.mjs';
119 import { Result_InitFeaturesDecodeErrorZ } from '../structs/Result_InitFeaturesDecodeErrorZ.mjs';
120 import { ChannelFeatures } from '../structs/ChannelFeatures.mjs';
121 import { Result_ChannelFeaturesDecodeErrorZ } from '../structs/Result_ChannelFeaturesDecodeErrorZ.mjs';
122 import { NodeFeatures } from '../structs/NodeFeatures.mjs';
123 import { Result_NodeFeaturesDecodeErrorZ } from '../structs/Result_NodeFeaturesDecodeErrorZ.mjs';
124 import { InvoiceFeatures } from '../structs/InvoiceFeatures.mjs';
125 import { Result_InvoiceFeaturesDecodeErrorZ } from '../structs/Result_InvoiceFeaturesDecodeErrorZ.mjs';
126 import { Result_ChannelTypeFeaturesDecodeErrorZ } from '../structs/Result_ChannelTypeFeaturesDecodeErrorZ.mjs';
127 import { Result_NodeIdDecodeErrorZ } from '../structs/Result_NodeIdDecodeErrorZ.mjs';
128 import { Result_COption_NetworkUpdateZDecodeErrorZ } from '../structs/Result_COption_NetworkUpdateZDecodeErrorZ.mjs';
129 import { Access, AccessInterface } from '../structs/Access.mjs';
130 import { Option_AccessZ } from '../structs/Option_AccessZ.mjs';
131 import { Result_boolLightningErrorZ } from '../structs/Result_boolLightningErrorZ.mjs';
132 import { ThreeTuple_ChannelAnnouncementChannelUpdateChannelUpdateZ } from '../structs/ThreeTuple_ChannelAnnouncementChannelUpdateChannelUpdateZ.mjs';
133 import { Result_NoneLightningErrorZ } from '../structs/Result_NoneLightningErrorZ.mjs';
134 import { ChannelUpdateInfo } from '../structs/ChannelUpdateInfo.mjs';
135 import { Result_ChannelUpdateInfoDecodeErrorZ } from '../structs/Result_ChannelUpdateInfoDecodeErrorZ.mjs';
136 import { ChannelInfo } from '../structs/ChannelInfo.mjs';
137 import { Result_ChannelInfoDecodeErrorZ } from '../structs/Result_ChannelInfoDecodeErrorZ.mjs';
138 import { RoutingFees } from '../structs/RoutingFees.mjs';
139 import { Result_RoutingFeesDecodeErrorZ } from '../structs/Result_RoutingFeesDecodeErrorZ.mjs';
140 import { NetAddress } from '../structs/NetAddress.mjs';
141 import { NodeAnnouncementInfo } from '../structs/NodeAnnouncementInfo.mjs';
142 import { Result_NodeAnnouncementInfoDecodeErrorZ } from '../structs/Result_NodeAnnouncementInfoDecodeErrorZ.mjs';
143 import { NodeAlias } from '../structs/NodeAlias.mjs';
144 import { Result_NodeAliasDecodeErrorZ } from '../structs/Result_NodeAliasDecodeErrorZ.mjs';
145 import { NodeInfo } from '../structs/NodeInfo.mjs';
146 import { Result_NodeInfoDecodeErrorZ } from '../structs/Result_NodeInfoDecodeErrorZ.mjs';
147 import { Result_NetworkGraphDecodeErrorZ } from '../structs/Result_NetworkGraphDecodeErrorZ.mjs';
148 import { Option_CVec_NetAddressZZ } from '../structs/Option_CVec_NetAddressZZ.mjs';
149 import { Result_DelayedPaymentOutputDescriptorDecodeErrorZ } from '../structs/Result_DelayedPaymentOutputDescriptorDecodeErrorZ.mjs';
150 import { Result_StaticPaymentOutputDescriptorDecodeErrorZ } from '../structs/Result_StaticPaymentOutputDescriptorDecodeErrorZ.mjs';
151 import { Result_SpendableOutputDescriptorDecodeErrorZ } from '../structs/Result_SpendableOutputDescriptorDecodeErrorZ.mjs';
152 import { TwoTuple_SignatureCVec_SignatureZZ } from '../structs/TwoTuple_SignatureCVec_SignatureZZ.mjs';
153 import { Result_C2Tuple_SignatureCVec_SignatureZZNoneZ } from '../structs/Result_C2Tuple_SignatureCVec_SignatureZZNoneZ.mjs';
154 import { Result_SignatureNoneZ } from '../structs/Result_SignatureNoneZ.mjs';
155 import { TwoTuple_SignatureSignatureZ } from '../structs/TwoTuple_SignatureSignatureZ.mjs';
156 import { Result_C2Tuple_SignatureSignatureZNoneZ } from '../structs/Result_C2Tuple_SignatureSignatureZNoneZ.mjs';
157 import { Result_SecretKeyNoneZ } from '../structs/Result_SecretKeyNoneZ.mjs';
158 import { ClosingTransaction } from '../structs/ClosingTransaction.mjs';
159 import { UnsignedChannelAnnouncement } from '../structs/UnsignedChannelAnnouncement.mjs';
160 import { BaseSign, BaseSignInterface } from '../structs/BaseSign.mjs';
161 import { Sign, SignInterface } from '../structs/Sign.mjs';
162 import { Result_SignDecodeErrorZ } from '../structs/Result_SignDecodeErrorZ.mjs';
163 import { Result_RecoverableSignatureNoneZ } from '../structs/Result_RecoverableSignatureNoneZ.mjs';
164 import { Result_CVec_CVec_u8ZZNoneZ } from '../structs/Result_CVec_CVec_u8ZZNoneZ.mjs';
165 import { InMemorySigner } from '../structs/InMemorySigner.mjs';
166 import { Result_InMemorySignerDecodeErrorZ } from '../structs/Result_InMemorySignerDecodeErrorZ.mjs';
167 import { Result_TransactionNoneZ } from '../structs/Result_TransactionNoneZ.mjs';
168 import { Option_u16Z } from '../structs/Option_u16Z.mjs';
169 import { APIError } from '../structs/APIError.mjs';
170 import { Result_NoneAPIErrorZ } from '../structs/Result_NoneAPIErrorZ.mjs';
171 import { Result__u832APIErrorZ } from '../structs/Result__u832APIErrorZ.mjs';
172 import { PaymentSendFailure } from '../structs/PaymentSendFailure.mjs';
173 import { Result_PaymentIdPaymentSendFailureZ } from '../structs/Result_PaymentIdPaymentSendFailureZ.mjs';
174 import { Result_NonePaymentSendFailureZ } from '../structs/Result_NonePaymentSendFailureZ.mjs';
175 import { TwoTuple_PaymentHashPaymentIdZ } from '../structs/TwoTuple_PaymentHashPaymentIdZ.mjs';
176 import { Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ } from '../structs/Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ.mjs';
177 import { TwoTuple_PaymentHashPaymentSecretZ } from '../structs/TwoTuple_PaymentHashPaymentSecretZ.mjs';
178 import { Result_C2Tuple_PaymentHashPaymentSecretZNoneZ } from '../structs/Result_C2Tuple_PaymentHashPaymentSecretZNoneZ.mjs';
179 import { Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ } from '../structs/Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ.mjs';
180 import { Result_PaymentSecretNoneZ } from '../structs/Result_PaymentSecretNoneZ.mjs';
181 import { Result_PaymentSecretAPIErrorZ } from '../structs/Result_PaymentSecretAPIErrorZ.mjs';
182 import { Result_PaymentPreimageAPIErrorZ } from '../structs/Result_PaymentPreimageAPIErrorZ.mjs';
183 import { CounterpartyForwardingInfo } from '../structs/CounterpartyForwardingInfo.mjs';
184 import { Result_CounterpartyForwardingInfoDecodeErrorZ } from '../structs/Result_CounterpartyForwardingInfoDecodeErrorZ.mjs';
185 import { ChannelCounterparty } from '../structs/ChannelCounterparty.mjs';
186 import { Result_ChannelCounterpartyDecodeErrorZ } from '../structs/Result_ChannelCounterpartyDecodeErrorZ.mjs';
187 import { Result_ChannelDetailsDecodeErrorZ } from '../structs/Result_ChannelDetailsDecodeErrorZ.mjs';
188 import { PhantomRouteHints } from '../structs/PhantomRouteHints.mjs';
189 import { Result_PhantomRouteHintsDecodeErrorZ } from '../structs/Result_PhantomRouteHintsDecodeErrorZ.mjs';
190 import { ChannelMonitor } from '../structs/ChannelMonitor.mjs';
191 import { ChannelMonitorUpdate } from '../structs/ChannelMonitorUpdate.mjs';
192 import { Watch, WatchInterface } from '../structs/Watch.mjs';
193 import { BroadcasterInterface, BroadcasterInterfaceInterface } from '../structs/BroadcasterInterface.mjs';
194 import { KeysInterface, KeysInterfaceInterface } from '../structs/KeysInterface.mjs';
195 import { FeeEstimator, FeeEstimatorInterface } from '../structs/FeeEstimator.mjs';
196 import { ChannelManager } from '../structs/ChannelManager.mjs';
197 import { TwoTuple_BlockHashChannelManagerZ } from '../structs/TwoTuple_BlockHashChannelManagerZ.mjs';
198 import { Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ } from '../structs/Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.mjs';
199 import { ChannelConfig } from '../structs/ChannelConfig.mjs';
200 import { Result_ChannelConfigDecodeErrorZ } from '../structs/Result_ChannelConfigDecodeErrorZ.mjs';
201 import { Result_OutPointDecodeErrorZ } from '../structs/Result_OutPointDecodeErrorZ.mjs';
202 import { Type, TypeInterface } from '../structs/Type.mjs';
203 import { Option_TypeZ } from '../structs/Option_TypeZ.mjs';
204 import { Result_COption_TypeZDecodeErrorZ } from '../structs/Result_COption_TypeZDecodeErrorZ.mjs';
205 import { PaymentError } from '../structs/PaymentError.mjs';
206 import { Result_PaymentIdPaymentErrorZ } from '../structs/Result_PaymentIdPaymentErrorZ.mjs';
207 import { ParseError } from '../structs/ParseError.mjs';
208 import { Result_SiPrefixParseErrorZ } from '../structs/Result_SiPrefixParseErrorZ.mjs';
209 import { Invoice } from '../structs/Invoice.mjs';
210 import { ParseOrSemanticError } from '../structs/ParseOrSemanticError.mjs';
211 import { Result_InvoiceParseOrSemanticErrorZ } from '../structs/Result_InvoiceParseOrSemanticErrorZ.mjs';
212 import { SignedRawInvoice } from '../structs/SignedRawInvoice.mjs';
213 import { Result_SignedRawInvoiceParseErrorZ } from '../structs/Result_SignedRawInvoiceParseErrorZ.mjs';
214 import { RawInvoice } from '../structs/RawInvoice.mjs';
215 import { InvoiceSignature } from '../structs/InvoiceSignature.mjs';
216 import { ThreeTuple_RawInvoice_u832InvoiceSignatureZ } from '../structs/ThreeTuple_RawInvoice_u832InvoiceSignatureZ.mjs';
217 import { PayeePubKey } from '../structs/PayeePubKey.mjs';
218 import { Result_PayeePubKeyErrorZ } from '../structs/Result_PayeePubKeyErrorZ.mjs';
219 import { PrivateRoute } from '../structs/PrivateRoute.mjs';
220 import { PositiveTimestamp } from '../structs/PositiveTimestamp.mjs';
221 import { Result_PositiveTimestampCreationErrorZ } from '../structs/Result_PositiveTimestampCreationErrorZ.mjs';
222 import { Result_NoneSemanticErrorZ } from '../structs/Result_NoneSemanticErrorZ.mjs';
223 import { Result_InvoiceSemanticErrorZ } from '../structs/Result_InvoiceSemanticErrorZ.mjs';
224 import { Description } from '../structs/Description.mjs';
225 import { Result_DescriptionCreationErrorZ } from '../structs/Result_DescriptionCreationErrorZ.mjs';
226 import { Result_PrivateRouteCreationErrorZ } from '../structs/Result_PrivateRouteCreationErrorZ.mjs';
227 import { Result_StringErrorZ } from '../structs/Result_StringErrorZ.mjs';
228 import { Result_ChannelMonitorUpdateDecodeErrorZ } from '../structs/Result_ChannelMonitorUpdateDecodeErrorZ.mjs';
229 import { Option_MonitorEventZ } from '../structs/Option_MonitorEventZ.mjs';
230 import { Result_COption_MonitorEventZDecodeErrorZ } from '../structs/Result_COption_MonitorEventZDecodeErrorZ.mjs';
231 import { Result_HTLCUpdateDecodeErrorZ } from '../structs/Result_HTLCUpdateDecodeErrorZ.mjs';
232 import { TwoTuple_OutPointScriptZ } from '../structs/TwoTuple_OutPointScriptZ.mjs';
233 import { TwoTuple_u32ScriptZ } from '../structs/TwoTuple_u32ScriptZ.mjs';
234 import { TwoTuple_TxidCVec_C2Tuple_u32ScriptZZZ } from '../structs/TwoTuple_TxidCVec_C2Tuple_u32ScriptZZZ.mjs';
235 import { TwoTuple_u32TxOutZ } from '../structs/TwoTuple_u32TxOutZ.mjs';
236 import { TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ } from '../structs/TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ.mjs';
237 import { Balance } from '../structs/Balance.mjs';
238 import { TwoTuple_BlockHashChannelMonitorZ } from '../structs/TwoTuple_BlockHashChannelMonitorZ.mjs';
239 import { Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ } from '../structs/Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.mjs';
240 import { TwoTuple_PublicKeyTypeZ } from '../structs/TwoTuple_PublicKeyTypeZ.mjs';
241 import { Option_NetAddressZ } from '../structs/Option_NetAddressZ.mjs';
242 import { PeerHandleError } from '../structs/PeerHandleError.mjs';
243 import { Result_CVec_u8ZPeerHandleErrorZ } from '../structs/Result_CVec_u8ZPeerHandleErrorZ.mjs';
244 import { Result_NonePeerHandleErrorZ } from '../structs/Result_NonePeerHandleErrorZ.mjs';
245 import { Result_boolPeerHandleErrorZ } from '../structs/Result_boolPeerHandleErrorZ.mjs';
246 import { Result_NoneErrorZ } from '../structs/Result_NoneErrorZ.mjs';
247 import { Result_NetAddressDecodeErrorZ } from '../structs/Result_NetAddressDecodeErrorZ.mjs';
248 import { UpdateAddHTLC } from '../structs/UpdateAddHTLC.mjs';
249 import { UpdateFulfillHTLC } from '../structs/UpdateFulfillHTLC.mjs';
250 import { UpdateFailHTLC } from '../structs/UpdateFailHTLC.mjs';
251 import { UpdateFailMalformedHTLC } from '../structs/UpdateFailMalformedHTLC.mjs';
252 import { Result_AcceptChannelDecodeErrorZ } from '../structs/Result_AcceptChannelDecodeErrorZ.mjs';
253 import { Result_AnnouncementSignaturesDecodeErrorZ } from '../structs/Result_AnnouncementSignaturesDecodeErrorZ.mjs';
254 import { Result_ChannelReestablishDecodeErrorZ } from '../structs/Result_ChannelReestablishDecodeErrorZ.mjs';
255 import { Result_ClosingSignedDecodeErrorZ } from '../structs/Result_ClosingSignedDecodeErrorZ.mjs';
256 import { ClosingSignedFeeRange } from '../structs/ClosingSignedFeeRange.mjs';
257 import { Result_ClosingSignedFeeRangeDecodeErrorZ } from '../structs/Result_ClosingSignedFeeRangeDecodeErrorZ.mjs';
258 import { CommitmentSigned } from '../structs/CommitmentSigned.mjs';
259 import { Result_CommitmentSignedDecodeErrorZ } from '../structs/Result_CommitmentSignedDecodeErrorZ.mjs';
260 import { Result_FundingCreatedDecodeErrorZ } from '../structs/Result_FundingCreatedDecodeErrorZ.mjs';
261 import { Result_FundingSignedDecodeErrorZ } from '../structs/Result_FundingSignedDecodeErrorZ.mjs';
262 import { Result_ChannelReadyDecodeErrorZ } from '../structs/Result_ChannelReadyDecodeErrorZ.mjs';
263 import { Init } from '../structs/Init.mjs';
264 import { Result_InitDecodeErrorZ } from '../structs/Result_InitDecodeErrorZ.mjs';
265 import { Result_OpenChannelDecodeErrorZ } from '../structs/Result_OpenChannelDecodeErrorZ.mjs';
266 import { Result_RevokeAndACKDecodeErrorZ } from '../structs/Result_RevokeAndACKDecodeErrorZ.mjs';
267 import { Result_ShutdownDecodeErrorZ } from '../structs/Result_ShutdownDecodeErrorZ.mjs';
268 import { Result_UpdateFailHTLCDecodeErrorZ } from '../structs/Result_UpdateFailHTLCDecodeErrorZ.mjs';
269 import { Result_UpdateFailMalformedHTLCDecodeErrorZ } from '../structs/Result_UpdateFailMalformedHTLCDecodeErrorZ.mjs';
270 import { UpdateFee } from '../structs/UpdateFee.mjs';
271 import { Result_UpdateFeeDecodeErrorZ } from '../structs/Result_UpdateFeeDecodeErrorZ.mjs';
272 import { Result_UpdateFulfillHTLCDecodeErrorZ } from '../structs/Result_UpdateFulfillHTLCDecodeErrorZ.mjs';
273 import { Result_UpdateAddHTLCDecodeErrorZ } from '../structs/Result_UpdateAddHTLCDecodeErrorZ.mjs';
274 import { Ping } from '../structs/Ping.mjs';
275 import { Result_PingDecodeErrorZ } from '../structs/Result_PingDecodeErrorZ.mjs';
276 import { Pong } from '../structs/Pong.mjs';
277 import { Result_PongDecodeErrorZ } from '../structs/Result_PongDecodeErrorZ.mjs';
278 import { Result_UnsignedChannelAnnouncementDecodeErrorZ } from '../structs/Result_UnsignedChannelAnnouncementDecodeErrorZ.mjs';
279 import { Result_ChannelAnnouncementDecodeErrorZ } from '../structs/Result_ChannelAnnouncementDecodeErrorZ.mjs';
280 import { UnsignedChannelUpdate } from '../structs/UnsignedChannelUpdate.mjs';
281 import { Result_UnsignedChannelUpdateDecodeErrorZ } from '../structs/Result_UnsignedChannelUpdateDecodeErrorZ.mjs';
282 import { Result_ChannelUpdateDecodeErrorZ } from '../structs/Result_ChannelUpdateDecodeErrorZ.mjs';
283 import { Result_ErrorMessageDecodeErrorZ } from '../structs/Result_ErrorMessageDecodeErrorZ.mjs';
284 import { Result_WarningMessageDecodeErrorZ } from '../structs/Result_WarningMessageDecodeErrorZ.mjs';
285 import { UnsignedNodeAnnouncement } from '../structs/UnsignedNodeAnnouncement.mjs';
286 import { Result_UnsignedNodeAnnouncementDecodeErrorZ } from '../structs/Result_UnsignedNodeAnnouncementDecodeErrorZ.mjs';
287 import { Result_NodeAnnouncementDecodeErrorZ } from '../structs/Result_NodeAnnouncementDecodeErrorZ.mjs';
288 import { Result_QueryShortChannelIdsDecodeErrorZ } from '../structs/Result_QueryShortChannelIdsDecodeErrorZ.mjs';
289 import { ReplyShortChannelIdsEnd } from '../structs/ReplyShortChannelIdsEnd.mjs';
290 import { Result_ReplyShortChannelIdsEndDecodeErrorZ } from '../structs/Result_ReplyShortChannelIdsEndDecodeErrorZ.mjs';
291 import { Result_QueryChannelRangeDecodeErrorZ } from '../structs/Result_QueryChannelRangeDecodeErrorZ.mjs';
292 import { Result_ReplyChannelRangeDecodeErrorZ } from '../structs/Result_ReplyChannelRangeDecodeErrorZ.mjs';
293 import { Result_GossipTimestampFilterDecodeErrorZ } from '../structs/Result_GossipTimestampFilterDecodeErrorZ.mjs';
294 import { SignOrCreationError } from '../structs/SignOrCreationError.mjs';
295 import { Result_InvoiceSignOrCreationErrorZ } from '../structs/Result_InvoiceSignOrCreationErrorZ.mjs';
296 import { WatchedOutput } from '../structs/WatchedOutput.mjs';
297 import { Filter, FilterInterface } from '../structs/Filter.mjs';
298 import { Option_FilterZ } from '../structs/Option_FilterZ.mjs';
299 import { LockedChannelMonitor } from '../structs/LockedChannelMonitor.mjs';
300 import { Result_LockedChannelMonitorNoneZ } from '../structs/Result_LockedChannelMonitorNoneZ.mjs';
301 import { MessageSendEventsProvider, MessageSendEventsProviderInterface } from '../structs/MessageSendEventsProvider.mjs';
302 import { EventHandler, EventHandlerInterface } from '../structs/EventHandler.mjs';
303 import { EventsProvider, EventsProviderInterface } from '../structs/EventsProvider.mjs';
304 import { BigSize } from '../structs/BigSize.mjs';
305 import { ChannelUsage } from '../structs/ChannelUsage.mjs';
306 import { Score, ScoreInterface } from '../structs/Score.mjs';
307 import { MultiThreadedLockableScore } from '../structs/MultiThreadedLockableScore.mjs';
308 import { Persister, PersisterInterface } from '../structs/Persister.mjs';
309 import { ChannelHandshakeConfig } from '../structs/ChannelHandshakeConfig.mjs';
310 import { ChannelHandshakeLimits } from '../structs/ChannelHandshakeLimits.mjs';
311 import { UserConfig } from '../structs/UserConfig.mjs';
312 import { BestBlock } from '../structs/BestBlock.mjs';
313 import { Listen, ListenInterface } from '../structs/Listen.mjs';
314 import { Confirm, ConfirmInterface } from '../structs/Confirm.mjs';
315 import { MonitorUpdateId } from '../structs/MonitorUpdateId.mjs';
316 import { Persist, PersistInterface } from '../structs/Persist.mjs';
317 import { ChainMonitor } from '../structs/ChainMonitor.mjs';
318 import { KeysManager } from '../structs/KeysManager.mjs';
319 import { PhantomKeysManager } from '../structs/PhantomKeysManager.mjs';
320 import { ChainParameters } from '../structs/ChainParameters.mjs';
321 import { ChannelMessageHandler, ChannelMessageHandlerInterface } from '../structs/ChannelMessageHandler.mjs';
322 import { ChannelManagerReadArgs } from '../structs/ChannelManagerReadArgs.mjs';
323 import { ExpandedKey } from '../structs/ExpandedKey.mjs';
324 import { DataLossProtect } from '../structs/DataLossProtect.mjs';
325 import { RoutingMessageHandler, RoutingMessageHandlerInterface } from '../structs/RoutingMessageHandler.mjs';
326 import { CustomMessageReader, CustomMessageReaderInterface } from '../structs/CustomMessageReader.mjs';
327 import { CustomMessageHandler, CustomMessageHandlerInterface } from '../structs/CustomMessageHandler.mjs';
328 import { IgnoringMessageHandler } from '../structs/IgnoringMessageHandler.mjs';
329 import { ErroringMessageHandler } from '../structs/ErroringMessageHandler.mjs';
330 import { MessageHandler } from '../structs/MessageHandler.mjs';
331 import { SocketDescriptor, SocketDescriptorInterface } from '../structs/SocketDescriptor.mjs';
332 import { PeerManager } from '../structs/PeerManager.mjs';
333 import { DirectedChannelTransactionParameters } from '../structs/DirectedChannelTransactionParameters.mjs';
334 import { ReadOnlyNetworkGraph } from '../structs/ReadOnlyNetworkGraph.mjs';
335 import { P2PGossipSync } from '../structs/P2PGossipSync.mjs';
336 import { DirectedChannelInfo } from '../structs/DirectedChannelInfo.mjs';
337 import { EffectiveCapacity } from '../structs/EffectiveCapacity.mjs';
338 import { LockableScore, LockableScoreInterface } from '../structs/LockableScore.mjs';
339 import { ProbabilisticScoringParameters } from '../structs/ProbabilisticScoringParameters.mjs';
340 import { RawDataPart } from '../structs/RawDataPart.mjs';
341 import { Sha256 } from '../structs/Sha256.mjs';
342 import { ExpiryTime } from '../structs/ExpiryTime.mjs';
343 import { MinFinalCltvExpiry } from '../structs/MinFinalCltvExpiry.mjs';
344 import { Fallback } from '../structs/Fallback.mjs';
345 import { Payer, PayerInterface } from '../structs/Payer.mjs';
346 import { Router, RouterInterface } from '../structs/Router.mjs';
347 import { InvoicePayer } from '../structs/InvoicePayer.mjs';
348 import { Retry } from '../structs/Retry.mjs';
349 import { DefaultRouter } from '../structs/DefaultRouter.mjs';
351 import { CommonBase, UInt5, WitnessVersion, UnqualifiedError } from './CommonBase.mjs';
352 import * as bindings from '../bindings.mjs'
356 * Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
358 export class ChannelDetails extends CommonBase {
360 public constructor(_dummy: object, ptr: number) {
361 super(ptr, bindings.ChannelDetails_free);
365 * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
366 * thereafter this is the txid of the funding transaction xor the funding transaction output).
367 * Note that this means this value is *not* persistent - it can change once during the
368 * lifetime of the channel.
370 public get_channel_id(): Uint8Array {
371 const ret: number = bindings.ChannelDetails_get_channel_id(this.ptr);
372 const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
377 * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
378 * thereafter this is the txid of the funding transaction xor the funding transaction output).
379 * Note that this means this value is *not* persistent - it can change once during the
380 * lifetime of the channel.
382 public set_channel_id(val: Uint8Array): void {
383 bindings.ChannelDetails_set_channel_id(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(val, 32)));
387 * Parameters which apply to our counterparty. See individual fields for more information.
389 public get_counterparty(): ChannelCounterparty {
390 const ret: number = bindings.ChannelDetails_get_counterparty(this.ptr);
391 const ret_hu_conv: ChannelCounterparty = new ChannelCounterparty(null, ret);
392 CommonBase.add_ref_from(ret_hu_conv, this);
397 * Parameters which apply to our counterparty. See individual fields for more information.
399 public set_counterparty(val: ChannelCounterparty): void {
400 bindings.ChannelDetails_set_counterparty(this.ptr, val == null ? 0 : CommonBase.get_ptr_of(val) & ~1);
404 * The Channel's funding transaction output, if we've negotiated the funding transaction with
405 * our counterparty already.
407 * Note that, if this has been set, `channel_id` will be equivalent to
408 * `funding_txo.unwrap().to_channel_id()`.
410 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
412 public get_funding_txo(): OutPoint {
413 const ret: number = bindings.ChannelDetails_get_funding_txo(this.ptr);
414 const ret_hu_conv: OutPoint = new OutPoint(null, ret);
415 CommonBase.add_ref_from(ret_hu_conv, this);
420 * The Channel's funding transaction output, if we've negotiated the funding transaction with
421 * our counterparty already.
423 * Note that, if this has been set, `channel_id` will be equivalent to
424 * `funding_txo.unwrap().to_channel_id()`.
426 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
428 public set_funding_txo(val: OutPoint): void {
429 bindings.ChannelDetails_set_funding_txo(this.ptr, val == null ? 0 : CommonBase.get_ptr_of(val) & ~1);
433 * The features which this channel operates with. See individual features for more info.
435 * `None` until negotiation completes and the channel type is finalized.
437 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
439 public get_channel_type(): ChannelTypeFeatures {
440 const ret: number = bindings.ChannelDetails_get_channel_type(this.ptr);
441 const ret_hu_conv: ChannelTypeFeatures = new ChannelTypeFeatures(null, ret);
442 CommonBase.add_ref_from(ret_hu_conv, this);
447 * The features which this channel operates with. See individual features for more info.
449 * `None` until negotiation completes and the channel type is finalized.
451 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
453 public set_channel_type(val: ChannelTypeFeatures): void {
454 bindings.ChannelDetails_set_channel_type(this.ptr, val == null ? 0 : CommonBase.get_ptr_of(val) & ~1);
458 * The position of the funding transaction in the chain. None if the funding transaction has
459 * not yet been confirmed and the channel fully opened.
461 * Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
462 * payments instead of this. See [`get_inbound_payment_scid`].
464 * For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
465 * be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
467 * [`inbound_scid_alias`]: Self::inbound_scid_alias
468 * [`outbound_scid_alias`]: Self::outbound_scid_alias
469 * [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
470 * [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
471 * [`confirmations_required`]: Self::confirmations_required
473 public get_short_channel_id(): Option_u64Z {
474 const ret: number = bindings.ChannelDetails_get_short_channel_id(this.ptr);
475 const ret_hu_conv: Option_u64Z = Option_u64Z.constr_from_ptr(ret);
476 CommonBase.add_ref_from(ret_hu_conv, this);
481 * The position of the funding transaction in the chain. None if the funding transaction has
482 * not yet been confirmed and the channel fully opened.
484 * Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
485 * payments instead of this. See [`get_inbound_payment_scid`].
487 * For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
488 * be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
490 * [`inbound_scid_alias`]: Self::inbound_scid_alias
491 * [`outbound_scid_alias`]: Self::outbound_scid_alias
492 * [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
493 * [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
494 * [`confirmations_required`]: Self::confirmations_required
496 public set_short_channel_id(val: Option_u64Z): void {
497 bindings.ChannelDetails_set_short_channel_id(this.ptr, CommonBase.get_ptr_of(val));
501 * An optional [`short_channel_id`] alias for this channel, randomly generated by us and
502 * usable in place of [`short_channel_id`] to reference the channel in outbound routes when
503 * the channel has not yet been confirmed (as long as [`confirmations_required`] is
506 * This will be `None` as long as the channel is not available for routing outbound payments.
508 * [`short_channel_id`]: Self::short_channel_id
509 * [`confirmations_required`]: Self::confirmations_required
511 public get_outbound_scid_alias(): Option_u64Z {
512 const ret: number = bindings.ChannelDetails_get_outbound_scid_alias(this.ptr);
513 const ret_hu_conv: Option_u64Z = Option_u64Z.constr_from_ptr(ret);
514 CommonBase.add_ref_from(ret_hu_conv, this);
519 * An optional [`short_channel_id`] alias for this channel, randomly generated by us and
520 * usable in place of [`short_channel_id`] to reference the channel in outbound routes when
521 * the channel has not yet been confirmed (as long as [`confirmations_required`] is
524 * This will be `None` as long as the channel is not available for routing outbound payments.
526 * [`short_channel_id`]: Self::short_channel_id
527 * [`confirmations_required`]: Self::confirmations_required
529 public set_outbound_scid_alias(val: Option_u64Z): void {
530 bindings.ChannelDetails_set_outbound_scid_alias(this.ptr, CommonBase.get_ptr_of(val));
534 * An optional [`short_channel_id`] alias for this channel, randomly generated by our
535 * counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
536 * counterparty will recognize the alias provided here in place of the [`short_channel_id`]
537 * when they see a payment to be routed to us.
539 * Our counterparty may choose to rotate this value at any time, though will always recognize
540 * previous values for inbound payment forwarding.
542 * [`short_channel_id`]: Self::short_channel_id
544 public get_inbound_scid_alias(): Option_u64Z {
545 const ret: number = bindings.ChannelDetails_get_inbound_scid_alias(this.ptr);
546 const ret_hu_conv: Option_u64Z = Option_u64Z.constr_from_ptr(ret);
547 CommonBase.add_ref_from(ret_hu_conv, this);
552 * An optional [`short_channel_id`] alias for this channel, randomly generated by our
553 * counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
554 * counterparty will recognize the alias provided here in place of the [`short_channel_id`]
555 * when they see a payment to be routed to us.
557 * Our counterparty may choose to rotate this value at any time, though will always recognize
558 * previous values for inbound payment forwarding.
560 * [`short_channel_id`]: Self::short_channel_id
562 public set_inbound_scid_alias(val: Option_u64Z): void {
563 bindings.ChannelDetails_set_inbound_scid_alias(this.ptr, CommonBase.get_ptr_of(val));
567 * The value, in satoshis, of this channel as appears in the funding output
569 public get_channel_value_satoshis(): bigint {
570 const ret: bigint = bindings.ChannelDetails_get_channel_value_satoshis(this.ptr);
575 * The value, in satoshis, of this channel as appears in the funding output
577 public set_channel_value_satoshis(val: bigint): void {
578 bindings.ChannelDetails_set_channel_value_satoshis(this.ptr, val);
582 * The value, in satoshis, that must always be held in the channel for us. This value ensures
583 * that if we broadcast a revoked state, our counterparty can punish us by claiming at least
584 * this value on chain.
586 * This value is not included in [`outbound_capacity_msat`] as it can never be spent.
588 * This value will be `None` for outbound channels until the counterparty accepts the channel.
590 * [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
592 public get_unspendable_punishment_reserve(): Option_u64Z {
593 const ret: number = bindings.ChannelDetails_get_unspendable_punishment_reserve(this.ptr);
594 const ret_hu_conv: Option_u64Z = Option_u64Z.constr_from_ptr(ret);
595 CommonBase.add_ref_from(ret_hu_conv, this);
600 * The value, in satoshis, that must always be held in the channel for us. This value ensures
601 * that if we broadcast a revoked state, our counterparty can punish us by claiming at least
602 * this value on chain.
604 * This value is not included in [`outbound_capacity_msat`] as it can never be spent.
606 * This value will be `None` for outbound channels until the counterparty accepts the channel.
608 * [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
610 public set_unspendable_punishment_reserve(val: Option_u64Z): void {
611 bindings.ChannelDetails_set_unspendable_punishment_reserve(this.ptr, CommonBase.get_ptr_of(val));
615 * The `user_channel_id` passed in to create_channel, or 0 if the channel was inbound.
617 public get_user_channel_id(): bigint {
618 const ret: bigint = bindings.ChannelDetails_get_user_channel_id(this.ptr);
623 * The `user_channel_id` passed in to create_channel, or 0 if the channel was inbound.
625 public set_user_channel_id(val: bigint): void {
626 bindings.ChannelDetails_set_user_channel_id(this.ptr, val);
630 * Our total balance. This is the amount we would get if we close the channel.
631 * This value is not exact. Due to various in-flight changes and feerate changes, exactly this
632 * amount is not likely to be recoverable on close.
634 * This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
635 * balance is not available for inclusion in new outbound HTLCs). This further does not include
636 * any pending outgoing HTLCs which are awaiting some other resolution to be sent.
637 * This does not consider any on-chain fees.
639 * See also [`ChannelDetails::outbound_capacity_msat`]
641 public get_balance_msat(): bigint {
642 const ret: bigint = bindings.ChannelDetails_get_balance_msat(this.ptr);
647 * Our total balance. This is the amount we would get if we close the channel.
648 * This value is not exact. Due to various in-flight changes and feerate changes, exactly this
649 * amount is not likely to be recoverable on close.
651 * This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
652 * balance is not available for inclusion in new outbound HTLCs). This further does not include
653 * any pending outgoing HTLCs which are awaiting some other resolution to be sent.
654 * This does not consider any on-chain fees.
656 * See also [`ChannelDetails::outbound_capacity_msat`]
658 public set_balance_msat(val: bigint): void {
659 bindings.ChannelDetails_set_balance_msat(this.ptr, val);
663 * The available outbound capacity for sending HTLCs to the remote peer. This does not include
664 * any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
665 * available for inclusion in new outbound HTLCs). This further does not include any pending
666 * outgoing HTLCs which are awaiting some other resolution to be sent.
668 * See also [`ChannelDetails::balance_msat`]
670 * This value is not exact. Due to various in-flight changes, feerate changes, and our
671 * conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
672 * should be able to spend nearly this amount.
674 public get_outbound_capacity_msat(): bigint {
675 const ret: bigint = bindings.ChannelDetails_get_outbound_capacity_msat(this.ptr);
680 * The available outbound capacity for sending HTLCs to the remote peer. This does not include
681 * any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
682 * available for inclusion in new outbound HTLCs). This further does not include any pending
683 * outgoing HTLCs which are awaiting some other resolution to be sent.
685 * See also [`ChannelDetails::balance_msat`]
687 * This value is not exact. Due to various in-flight changes, feerate changes, and our
688 * conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
689 * should be able to spend nearly this amount.
691 public set_outbound_capacity_msat(val: bigint): void {
692 bindings.ChannelDetails_set_outbound_capacity_msat(this.ptr, val);
696 * The available outbound capacity for sending a single HTLC to the remote peer. This is
697 * similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
698 * the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
699 * to use a limit as close as possible to the HTLC limit we can currently send.
701 * See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
703 public get_next_outbound_htlc_limit_msat(): bigint {
704 const ret: bigint = bindings.ChannelDetails_get_next_outbound_htlc_limit_msat(this.ptr);
709 * The available outbound capacity for sending a single HTLC to the remote peer. This is
710 * similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
711 * the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
712 * to use a limit as close as possible to the HTLC limit we can currently send.
714 * See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
716 public set_next_outbound_htlc_limit_msat(val: bigint): void {
717 bindings.ChannelDetails_set_next_outbound_htlc_limit_msat(this.ptr, val);
721 * The available inbound capacity for the remote peer to send HTLCs to us. This does not
722 * include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
723 * available for inclusion in new inbound HTLCs).
724 * Note that there are some corner cases not fully handled here, so the actual available
725 * inbound capacity may be slightly higher than this.
727 * This value is not exact. Due to various in-flight changes, feerate changes, and our
728 * counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
729 * However, our counterparty should be able to spend nearly this amount.
731 public get_inbound_capacity_msat(): bigint {
732 const ret: bigint = bindings.ChannelDetails_get_inbound_capacity_msat(this.ptr);
737 * The available inbound capacity for the remote peer to send HTLCs to us. This does not
738 * include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
739 * available for inclusion in new inbound HTLCs).
740 * Note that there are some corner cases not fully handled here, so the actual available
741 * inbound capacity may be slightly higher than this.
743 * This value is not exact. Due to various in-flight changes, feerate changes, and our
744 * counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
745 * However, our counterparty should be able to spend nearly this amount.
747 public set_inbound_capacity_msat(val: bigint): void {
748 bindings.ChannelDetails_set_inbound_capacity_msat(this.ptr, val);
752 * The number of required confirmations on the funding transaction before the funding will be
753 * considered \"locked\". This number is selected by the channel fundee (i.e. us if
754 * [`is_outbound`] is *not* set), and can be selected for inbound channels with
755 * [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
756 * [`ChannelHandshakeLimits::max_minimum_depth`].
758 * This value will be `None` for outbound channels until the counterparty accepts the channel.
760 * [`is_outbound`]: ChannelDetails::is_outbound
761 * [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
762 * [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
764 public get_confirmations_required(): Option_u32Z {
765 const ret: number = bindings.ChannelDetails_get_confirmations_required(this.ptr);
766 const ret_hu_conv: Option_u32Z = Option_u32Z.constr_from_ptr(ret);
767 CommonBase.add_ref_from(ret_hu_conv, this);
772 * The number of required confirmations on the funding transaction before the funding will be
773 * considered \"locked\". This number is selected by the channel fundee (i.e. us if
774 * [`is_outbound`] is *not* set), and can be selected for inbound channels with
775 * [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
776 * [`ChannelHandshakeLimits::max_minimum_depth`].
778 * This value will be `None` for outbound channels until the counterparty accepts the channel.
780 * [`is_outbound`]: ChannelDetails::is_outbound
781 * [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
782 * [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
784 public set_confirmations_required(val: Option_u32Z): void {
785 bindings.ChannelDetails_set_confirmations_required(this.ptr, CommonBase.get_ptr_of(val));
789 * The number of blocks (after our commitment transaction confirms) that we will need to wait
790 * until we can claim our funds after we force-close the channel. During this time our
791 * counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
792 * force-closes the channel and broadcasts a commitment transaction we do not have to wait any
793 * time to claim our non-HTLC-encumbered funds.
795 * This value will be `None` for outbound channels until the counterparty accepts the channel.
797 public get_force_close_spend_delay(): Option_u16Z {
798 const ret: number = bindings.ChannelDetails_get_force_close_spend_delay(this.ptr);
799 const ret_hu_conv: Option_u16Z = Option_u16Z.constr_from_ptr(ret);
800 CommonBase.add_ref_from(ret_hu_conv, this);
805 * The number of blocks (after our commitment transaction confirms) that we will need to wait
806 * until we can claim our funds after we force-close the channel. During this time our
807 * counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
808 * force-closes the channel and broadcasts a commitment transaction we do not have to wait any
809 * time to claim our non-HTLC-encumbered funds.
811 * This value will be `None` for outbound channels until the counterparty accepts the channel.
813 public set_force_close_spend_delay(val: Option_u16Z): void {
814 bindings.ChannelDetails_set_force_close_spend_delay(this.ptr, CommonBase.get_ptr_of(val));
818 * True if the channel was initiated (and thus funded) by us.
820 public get_is_outbound(): boolean {
821 const ret: boolean = bindings.ChannelDetails_get_is_outbound(this.ptr);
826 * True if the channel was initiated (and thus funded) by us.
828 public set_is_outbound(val: boolean): void {
829 bindings.ChannelDetails_set_is_outbound(this.ptr, val);
833 * True if the channel is confirmed, channel_ready messages have been exchanged, and the
834 * channel is not currently being shut down. `channel_ready` message exchange implies the
835 * required confirmation count has been reached (and we were connected to the peer at some
836 * point after the funding transaction received enough confirmations). The required
837 * confirmation count is provided in [`confirmations_required`].
839 * [`confirmations_required`]: ChannelDetails::confirmations_required
841 public get_is_channel_ready(): boolean {
842 const ret: boolean = bindings.ChannelDetails_get_is_channel_ready(this.ptr);
847 * True if the channel is confirmed, channel_ready messages have been exchanged, and the
848 * channel is not currently being shut down. `channel_ready` message exchange implies the
849 * required confirmation count has been reached (and we were connected to the peer at some
850 * point after the funding transaction received enough confirmations). The required
851 * confirmation count is provided in [`confirmations_required`].
853 * [`confirmations_required`]: ChannelDetails::confirmations_required
855 public set_is_channel_ready(val: boolean): void {
856 bindings.ChannelDetails_set_is_channel_ready(this.ptr, val);
860 * True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
861 * the peer is connected, and (c) the channel is not currently negotiating a shutdown.
863 * This is a strict superset of `is_channel_ready`.
865 public get_is_usable(): boolean {
866 const ret: boolean = bindings.ChannelDetails_get_is_usable(this.ptr);
871 * True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
872 * the peer is connected, and (c) the channel is not currently negotiating a shutdown.
874 * This is a strict superset of `is_channel_ready`.
876 public set_is_usable(val: boolean): void {
877 bindings.ChannelDetails_set_is_usable(this.ptr, val);
881 * True if this channel is (or will be) publicly-announced.
883 public get_is_public(): boolean {
884 const ret: boolean = bindings.ChannelDetails_get_is_public(this.ptr);
889 * True if this channel is (or will be) publicly-announced.
891 public set_is_public(val: boolean): void {
892 bindings.ChannelDetails_set_is_public(this.ptr, val);
896 * The smallest value HTLC (in msat) we will accept, for this channel. This field
897 * is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
899 public get_inbound_htlc_minimum_msat(): Option_u64Z {
900 const ret: number = bindings.ChannelDetails_get_inbound_htlc_minimum_msat(this.ptr);
901 const ret_hu_conv: Option_u64Z = Option_u64Z.constr_from_ptr(ret);
902 CommonBase.add_ref_from(ret_hu_conv, this);
907 * The smallest value HTLC (in msat) we will accept, for this channel. This field
908 * is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
910 public set_inbound_htlc_minimum_msat(val: Option_u64Z): void {
911 bindings.ChannelDetails_set_inbound_htlc_minimum_msat(this.ptr, CommonBase.get_ptr_of(val));
915 * The largest value HTLC (in msat) we currently will accept, for this channel.
917 public get_inbound_htlc_maximum_msat(): Option_u64Z {
918 const ret: number = bindings.ChannelDetails_get_inbound_htlc_maximum_msat(this.ptr);
919 const ret_hu_conv: Option_u64Z = Option_u64Z.constr_from_ptr(ret);
920 CommonBase.add_ref_from(ret_hu_conv, this);
925 * The largest value HTLC (in msat) we currently will accept, for this channel.
927 public set_inbound_htlc_maximum_msat(val: Option_u64Z): void {
928 bindings.ChannelDetails_set_inbound_htlc_maximum_msat(this.ptr, CommonBase.get_ptr_of(val));
932 * Set of configurable parameters that affect channel operation.
934 * This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
936 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
938 public get_config(): ChannelConfig {
939 const ret: number = bindings.ChannelDetails_get_config(this.ptr);
940 const ret_hu_conv: ChannelConfig = new ChannelConfig(null, ret);
941 CommonBase.add_ref_from(ret_hu_conv, this);
946 * Set of configurable parameters that affect channel operation.
948 * This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
950 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
952 public set_config(val: ChannelConfig): void {
953 bindings.ChannelDetails_set_config(this.ptr, val == null ? 0 : CommonBase.get_ptr_of(val) & ~1);
957 * Constructs a new ChannelDetails given each field
959 public static constructor_new(channel_id_arg: Uint8Array, counterparty_arg: ChannelCounterparty, funding_txo_arg: OutPoint, channel_type_arg: ChannelTypeFeatures, short_channel_id_arg: Option_u64Z, outbound_scid_alias_arg: Option_u64Z, inbound_scid_alias_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, next_outbound_htlc_limit_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_channel_ready_arg: boolean, is_usable_arg: boolean, is_public_arg: boolean, inbound_htlc_minimum_msat_arg: Option_u64Z, inbound_htlc_maximum_msat_arg: Option_u64Z, config_arg: ChannelConfig): ChannelDetails {
960 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, channel_type_arg == null ? 0 : CommonBase.get_ptr_of(channel_type_arg) & ~1, CommonBase.get_ptr_of(short_channel_id_arg), CommonBase.get_ptr_of(outbound_scid_alias_arg), CommonBase.get_ptr_of(inbound_scid_alias_arg), channel_value_satoshis_arg, CommonBase.get_ptr_of(unspendable_punishment_reserve_arg), user_channel_id_arg, balance_msat_arg, outbound_capacity_msat_arg, next_outbound_htlc_limit_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_channel_ready_arg, is_usable_arg, is_public_arg, CommonBase.get_ptr_of(inbound_htlc_minimum_msat_arg), CommonBase.get_ptr_of(inbound_htlc_maximum_msat_arg), config_arg == null ? 0 : CommonBase.get_ptr_of(config_arg) & ~1);
961 const ret_hu_conv: ChannelDetails = new ChannelDetails(null, ret);
962 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
966 public clone_ptr(): number {
967 const ret: number = bindings.ChannelDetails_clone_ptr(this.ptr);
972 * Creates a copy of the ChannelDetails
974 public clone(): ChannelDetails {
975 const ret: number = bindings.ChannelDetails_clone(this.ptr);
976 const ret_hu_conv: ChannelDetails = new ChannelDetails(null, ret);
977 CommonBase.add_ref_from(ret_hu_conv, this);
982 * Gets the current SCID which should be used to identify this channel for inbound payments.
983 * This should be used for providing invoice hints or in any other context where our
984 * counterparty will forward a payment to us.
986 * This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
987 * [`ChannelDetails::short_channel_id`]. See those for more information.
989 public get_inbound_payment_scid(): Option_u64Z {
990 const ret: number = bindings.ChannelDetails_get_inbound_payment_scid(this.ptr);
991 const ret_hu_conv: Option_u64Z = Option_u64Z.constr_from_ptr(ret);
992 CommonBase.add_ref_from(ret_hu_conv, this);
997 * Gets the current SCID which should be used to identify this channel for outbound payments.
998 * This should be used in [`Route`]s to describe the first hop or in other contexts where
999 * we're sending or forwarding a payment outbound over this channel.
1001 * This is either the [`ChannelDetails::short_channel_id`], if set, or the
1002 * [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1004 public get_outbound_payment_scid(): Option_u64Z {
1005 const ret: number = bindings.ChannelDetails_get_outbound_payment_scid(this.ptr);
1006 const ret_hu_conv: Option_u64Z = Option_u64Z.constr_from_ptr(ret);
1007 CommonBase.add_ref_from(ret_hu_conv, this);
1012 * Serialize the ChannelDetails object into a byte array which can be read by ChannelDetails_read
1014 public write(): Uint8Array {
1015 const ret: number = bindings.ChannelDetails_write(this.ptr);
1016 const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
1021 * Read a ChannelDetails from a byte array, created by ChannelDetails_write
1023 public static constructor_read(ser: Uint8Array): Result_ChannelDetailsDecodeErrorZ {
1024 const ret: number = bindings.ChannelDetails_read(bindings.encodeUint8Array(ser));
1025 const ret_hu_conv: Result_ChannelDetailsDecodeErrorZ = Result_ChannelDetailsDecodeErrorZ.constr_from_ptr(ret);