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 { Level } from '../enums/Level.mjs';
9 import { Network } from '../enums/Network.mjs';
10 import { Recipient } from '../enums/Recipient.mjs';
11 import { Secp256k1Error } from '../enums/Secp256k1Error.mjs';
12 import { SemanticError } from '../enums/SemanticError.mjs';
13 import { SiPrefix } from '../enums/SiPrefix.mjs';
14 import { Result_NoneNoneZ } from '../structs/Result_NoneNoneZ.mjs';
15 import { CounterpartyCommitmentSecrets } from '../structs/CounterpartyCommitmentSecrets.mjs';
16 import { DecodeError } from '../structs/DecodeError.mjs';
17 import { Result_CounterpartyCommitmentSecretsDecodeErrorZ } from '../structs/Result_CounterpartyCommitmentSecretsDecodeErrorZ.mjs';
18 import { Result_SecretKeyErrorZ } from '../structs/Result_SecretKeyErrorZ.mjs';
19 import { Result_PublicKeyErrorZ } from '../structs/Result_PublicKeyErrorZ.mjs';
20 import { TxCreationKeys } from '../structs/TxCreationKeys.mjs';
21 import { Result_TxCreationKeysDecodeErrorZ } from '../structs/Result_TxCreationKeysDecodeErrorZ.mjs';
22 import { ChannelPublicKeys } from '../structs/ChannelPublicKeys.mjs';
23 import { Result_ChannelPublicKeysDecodeErrorZ } from '../structs/Result_ChannelPublicKeysDecodeErrorZ.mjs';
24 import { Result_TxCreationKeysErrorZ } from '../structs/Result_TxCreationKeysErrorZ.mjs';
25 import { Option_u32Z } from '../structs/Option_u32Z.mjs';
26 import { HTLCOutputInCommitment } from '../structs/HTLCOutputInCommitment.mjs';
27 import { Result_HTLCOutputInCommitmentDecodeErrorZ } from '../structs/Result_HTLCOutputInCommitmentDecodeErrorZ.mjs';
28 import { CounterpartyChannelTransactionParameters } from '../structs/CounterpartyChannelTransactionParameters.mjs';
29 import { Result_CounterpartyChannelTransactionParametersDecodeErrorZ } from '../structs/Result_CounterpartyChannelTransactionParametersDecodeErrorZ.mjs';
30 import { ChannelTransactionParameters } from '../structs/ChannelTransactionParameters.mjs';
31 import { Result_ChannelTransactionParametersDecodeErrorZ } from '../structs/Result_ChannelTransactionParametersDecodeErrorZ.mjs';
32 import { HolderCommitmentTransaction } from '../structs/HolderCommitmentTransaction.mjs';
33 import { Result_HolderCommitmentTransactionDecodeErrorZ } from '../structs/Result_HolderCommitmentTransactionDecodeErrorZ.mjs';
34 import { BuiltCommitmentTransaction } from '../structs/BuiltCommitmentTransaction.mjs';
35 import { Result_BuiltCommitmentTransactionDecodeErrorZ } from '../structs/Result_BuiltCommitmentTransactionDecodeErrorZ.mjs';
36 import { TrustedClosingTransaction } from '../structs/TrustedClosingTransaction.mjs';
37 import { Result_TrustedClosingTransactionNoneZ } from '../structs/Result_TrustedClosingTransactionNoneZ.mjs';
38 import { CommitmentTransaction } from '../structs/CommitmentTransaction.mjs';
39 import { Result_CommitmentTransactionDecodeErrorZ } from '../structs/Result_CommitmentTransactionDecodeErrorZ.mjs';
40 import { TrustedCommitmentTransaction } from '../structs/TrustedCommitmentTransaction.mjs';
41 import { Result_TrustedCommitmentTransactionNoneZ } from '../structs/Result_TrustedCommitmentTransactionNoneZ.mjs';
42 import { Result_CVec_SignatureZNoneZ } from '../structs/Result_CVec_SignatureZNoneZ.mjs';
43 import { ShutdownScript } from '../structs/ShutdownScript.mjs';
44 import { Result_ShutdownScriptDecodeErrorZ } from '../structs/Result_ShutdownScriptDecodeErrorZ.mjs';
45 import { InvalidShutdownScript } from '../structs/InvalidShutdownScript.mjs';
46 import { Result_ShutdownScriptInvalidShutdownScriptZ } from '../structs/Result_ShutdownScriptInvalidShutdownScriptZ.mjs';
47 import { RouteHop } from '../structs/RouteHop.mjs';
48 import { Result_RouteHopDecodeErrorZ } from '../structs/Result_RouteHopDecodeErrorZ.mjs';
49 import { Route } from '../structs/Route.mjs';
50 import { Result_RouteDecodeErrorZ } from '../structs/Result_RouteDecodeErrorZ.mjs';
51 import { RouteParameters } from '../structs/RouteParameters.mjs';
52 import { Result_RouteParametersDecodeErrorZ } from '../structs/Result_RouteParametersDecodeErrorZ.mjs';
53 import { RouteHint } from '../structs/RouteHint.mjs';
54 import { Option_u64Z } from '../structs/Option_u64Z.mjs';
55 import { PaymentParameters } from '../structs/PaymentParameters.mjs';
56 import { Result_PaymentParametersDecodeErrorZ } from '../structs/Result_PaymentParametersDecodeErrorZ.mjs';
57 import { RouteHintHop } from '../structs/RouteHintHop.mjs';
58 import { Result_RouteHintDecodeErrorZ } from '../structs/Result_RouteHintDecodeErrorZ.mjs';
59 import { Result_RouteHintHopDecodeErrorZ } from '../structs/Result_RouteHintHopDecodeErrorZ.mjs';
60 import { ChannelDetails } from '../structs/ChannelDetails.mjs';
61 import { LightningError } from '../structs/LightningError.mjs';
62 import { Result_RouteLightningErrorZ } from '../structs/Result_RouteLightningErrorZ.mjs';
63 import { Result_TxOutAccessErrorZ } from '../structs/Result_TxOutAccessErrorZ.mjs';
64 import { TwoTuple_usizeTransactionZ } from '../structs/TwoTuple_usizeTransactionZ.mjs';
65 import { Result_NoneChannelMonitorUpdateErrZ } from '../structs/Result_NoneChannelMonitorUpdateErrZ.mjs';
66 import { HTLCUpdate } from '../structs/HTLCUpdate.mjs';
67 import { OutPoint } from '../structs/OutPoint.mjs';
68 import { MonitorEvent } from '../structs/MonitorEvent.mjs';
69 import { Option_C2Tuple_usizeTransactionZZ } from '../structs/Option_C2Tuple_usizeTransactionZZ.mjs';
70 import { ClosureReason } from '../structs/ClosureReason.mjs';
71 import { Option_ClosureReasonZ } from '../structs/Option_ClosureReasonZ.mjs';
72 import { Result_COption_ClosureReasonZDecodeErrorZ } from '../structs/Result_COption_ClosureReasonZDecodeErrorZ.mjs';
73 import { ChannelUpdate } from '../structs/ChannelUpdate.mjs';
74 import { NetworkUpdate } from '../structs/NetworkUpdate.mjs';
75 import { Option_NetworkUpdateZ } from '../structs/Option_NetworkUpdateZ.mjs';
76 import { DelayedPaymentOutputDescriptor } from '../structs/DelayedPaymentOutputDescriptor.mjs';
77 import { StaticPaymentOutputDescriptor } from '../structs/StaticPaymentOutputDescriptor.mjs';
78 import { SpendableOutputDescriptor } from '../structs/SpendableOutputDescriptor.mjs';
79 import { PaymentPurpose } from '../structs/PaymentPurpose.mjs';
80 import { Event } from '../structs/Event.mjs';
81 import { Option_EventZ } from '../structs/Option_EventZ.mjs';
82 import { Result_COption_EventZDecodeErrorZ } from '../structs/Result_COption_EventZDecodeErrorZ.mjs';
83 import { AcceptChannel } from '../structs/AcceptChannel.mjs';
84 import { OpenChannel } from '../structs/OpenChannel.mjs';
85 import { FundingCreated } from '../structs/FundingCreated.mjs';
86 import { FundingSigned } from '../structs/FundingSigned.mjs';
87 import { FundingLocked } from '../structs/FundingLocked.mjs';
88 import { AnnouncementSignatures } from '../structs/AnnouncementSignatures.mjs';
89 import { CommitmentUpdate } from '../structs/CommitmentUpdate.mjs';
90 import { RevokeAndACK } from '../structs/RevokeAndACK.mjs';
91 import { ClosingSigned } from '../structs/ClosingSigned.mjs';
92 import { Shutdown } from '../structs/Shutdown.mjs';
93 import { ChannelReestablish } from '../structs/ChannelReestablish.mjs';
94 import { ChannelAnnouncement } from '../structs/ChannelAnnouncement.mjs';
95 import { NodeAnnouncement } from '../structs/NodeAnnouncement.mjs';
96 import { ErrorMessage } from '../structs/ErrorMessage.mjs';
97 import { WarningMessage } from '../structs/WarningMessage.mjs';
98 import { ErrorAction } from '../structs/ErrorAction.mjs';
99 import { QueryChannelRange } from '../structs/QueryChannelRange.mjs';
100 import { QueryShortChannelIds } from '../structs/QueryShortChannelIds.mjs';
101 import { ReplyChannelRange } from '../structs/ReplyChannelRange.mjs';
102 import { MessageSendEvent } from '../structs/MessageSendEvent.mjs';
103 import { FixedPenaltyScorer } from '../structs/FixedPenaltyScorer.mjs';
104 import { Result_FixedPenaltyScorerDecodeErrorZ } from '../structs/Result_FixedPenaltyScorerDecodeErrorZ.mjs';
105 import { ScoringParameters } from '../structs/ScoringParameters.mjs';
106 import { Result_ScoringParametersDecodeErrorZ } from '../structs/Result_ScoringParametersDecodeErrorZ.mjs';
107 import { Scorer } from '../structs/Scorer.mjs';
108 import { Result_ScorerDecodeErrorZ } from '../structs/Result_ScorerDecodeErrorZ.mjs';
109 import { ProbabilisticScoringParameters } from '../structs/ProbabilisticScoringParameters.mjs';
110 import { Result_ProbabilisticScoringParametersDecodeErrorZ } from '../structs/Result_ProbabilisticScoringParametersDecodeErrorZ.mjs';
111 import { NetworkGraph } from '../structs/NetworkGraph.mjs';
112 import { TwoTuple_ProbabilisticScoringParametersNetworkGraphZ } from '../structs/TwoTuple_ProbabilisticScoringParametersNetworkGraphZ.mjs';
113 import { ProbabilisticScorer } from '../structs/ProbabilisticScorer.mjs';
114 import { Result_ProbabilisticScorerDecodeErrorZ } from '../structs/Result_ProbabilisticScorerDecodeErrorZ.mjs';
115 import { InitFeatures } from '../structs/InitFeatures.mjs';
116 import { Result_InitFeaturesDecodeErrorZ } from '../structs/Result_InitFeaturesDecodeErrorZ.mjs';
117 import { ChannelFeatures } from '../structs/ChannelFeatures.mjs';
118 import { Result_ChannelFeaturesDecodeErrorZ } from '../structs/Result_ChannelFeaturesDecodeErrorZ.mjs';
119 import { NodeFeatures } from '../structs/NodeFeatures.mjs';
120 import { Result_NodeFeaturesDecodeErrorZ } from '../structs/Result_NodeFeaturesDecodeErrorZ.mjs';
121 import { InvoiceFeatures } from '../structs/InvoiceFeatures.mjs';
122 import { Result_InvoiceFeaturesDecodeErrorZ } from '../structs/Result_InvoiceFeaturesDecodeErrorZ.mjs';
123 import { ChannelTypeFeatures } from '../structs/ChannelTypeFeatures.mjs';
124 import { Result_ChannelTypeFeaturesDecodeErrorZ } from '../structs/Result_ChannelTypeFeaturesDecodeErrorZ.mjs';
125 import { Result_DelayedPaymentOutputDescriptorDecodeErrorZ } from '../structs/Result_DelayedPaymentOutputDescriptorDecodeErrorZ.mjs';
126 import { Result_StaticPaymentOutputDescriptorDecodeErrorZ } from '../structs/Result_StaticPaymentOutputDescriptorDecodeErrorZ.mjs';
127 import { Result_SpendableOutputDescriptorDecodeErrorZ } from '../structs/Result_SpendableOutputDescriptorDecodeErrorZ.mjs';
128 import { TwoTuple_SignatureCVec_SignatureZZ } from '../structs/TwoTuple_SignatureCVec_SignatureZZ.mjs';
129 import { Result_C2Tuple_SignatureCVec_SignatureZZNoneZ } from '../structs/Result_C2Tuple_SignatureCVec_SignatureZZNoneZ.mjs';
130 import { Result_SignatureNoneZ } from '../structs/Result_SignatureNoneZ.mjs';
131 import { TwoTuple_SignatureSignatureZ } from '../structs/TwoTuple_SignatureSignatureZ.mjs';
132 import { Result_C2Tuple_SignatureSignatureZNoneZ } from '../structs/Result_C2Tuple_SignatureSignatureZNoneZ.mjs';
133 import { Result_SecretKeyNoneZ } from '../structs/Result_SecretKeyNoneZ.mjs';
134 import { ClosingTransaction } from '../structs/ClosingTransaction.mjs';
135 import { UnsignedChannelAnnouncement } from '../structs/UnsignedChannelAnnouncement.mjs';
136 import { BaseSign, BaseSignInterface } from '../structs/BaseSign.mjs';
137 import { Sign, SignInterface } from '../structs/Sign.mjs';
138 import { Result_SignDecodeErrorZ } from '../structs/Result_SignDecodeErrorZ.mjs';
139 import { Result_RecoverableSignatureNoneZ } from '../structs/Result_RecoverableSignatureNoneZ.mjs';
140 import { Result_CVec_CVec_u8ZZNoneZ } from '../structs/Result_CVec_CVec_u8ZZNoneZ.mjs';
141 import { InMemorySigner } from '../structs/InMemorySigner.mjs';
142 import { Result_InMemorySignerDecodeErrorZ } from '../structs/Result_InMemorySignerDecodeErrorZ.mjs';
143 import { Result_TransactionNoneZ } from '../structs/Result_TransactionNoneZ.mjs';
144 import { Option_u16Z } from '../structs/Option_u16Z.mjs';
145 import { APIError } from '../structs/APIError.mjs';
146 import { Result_NoneAPIErrorZ } from '../structs/Result_NoneAPIErrorZ.mjs';
147 import { Result__u832APIErrorZ } from '../structs/Result__u832APIErrorZ.mjs';
148 import { PaymentSendFailure } from '../structs/PaymentSendFailure.mjs';
149 import { Result_PaymentIdPaymentSendFailureZ } from '../structs/Result_PaymentIdPaymentSendFailureZ.mjs';
150 import { Result_NonePaymentSendFailureZ } from '../structs/Result_NonePaymentSendFailureZ.mjs';
151 import { TwoTuple_PaymentHashPaymentIdZ } from '../structs/TwoTuple_PaymentHashPaymentIdZ.mjs';
152 import { Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ } from '../structs/Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ.mjs';
153 import { NetAddress } from '../structs/NetAddress.mjs';
154 import { TwoTuple_PaymentHashPaymentSecretZ } from '../structs/TwoTuple_PaymentHashPaymentSecretZ.mjs';
155 import { Result_C2Tuple_PaymentHashPaymentSecretZNoneZ } from '../structs/Result_C2Tuple_PaymentHashPaymentSecretZNoneZ.mjs';
156 import { Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ } from '../structs/Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ.mjs';
157 import { Result_PaymentSecretNoneZ } from '../structs/Result_PaymentSecretNoneZ.mjs';
158 import { Result_PaymentSecretAPIErrorZ } from '../structs/Result_PaymentSecretAPIErrorZ.mjs';
159 import { Result_PaymentPreimageAPIErrorZ } from '../structs/Result_PaymentPreimageAPIErrorZ.mjs';
160 import { CounterpartyForwardingInfo } from '../structs/CounterpartyForwardingInfo.mjs';
161 import { Result_CounterpartyForwardingInfoDecodeErrorZ } from '../structs/Result_CounterpartyForwardingInfoDecodeErrorZ.mjs';
162 import { ChannelCounterparty } from '../structs/ChannelCounterparty.mjs';
163 import { Result_ChannelCounterpartyDecodeErrorZ } from '../structs/Result_ChannelCounterpartyDecodeErrorZ.mjs';
164 import { Result_ChannelDetailsDecodeErrorZ } from '../structs/Result_ChannelDetailsDecodeErrorZ.mjs';
165 import { PhantomRouteHints } from '../structs/PhantomRouteHints.mjs';
166 import { Result_PhantomRouteHintsDecodeErrorZ } from '../structs/Result_PhantomRouteHintsDecodeErrorZ.mjs';
167 import { ChannelMonitor } from '../structs/ChannelMonitor.mjs';
168 import { ChannelMonitorUpdate } from '../structs/ChannelMonitorUpdate.mjs';
169 import { Watch, WatchInterface } from '../structs/Watch.mjs';
170 import { BroadcasterInterface, BroadcasterInterfaceInterface } from '../structs/BroadcasterInterface.mjs';
171 import { KeysInterface, KeysInterfaceInterface } from '../structs/KeysInterface.mjs';
172 import { FeeEstimator, FeeEstimatorInterface } from '../structs/FeeEstimator.mjs';
173 import { Record } from '../structs/Record.mjs';
174 import { Logger, LoggerInterface } from '../structs/Logger.mjs';
175 import { TwoTuple_BlockHashChannelManagerZ } from '../structs/TwoTuple_BlockHashChannelManagerZ.mjs';
176 import { Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ } from '../structs/Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.mjs';
177 import { ChannelConfig } from '../structs/ChannelConfig.mjs';
178 import { Result_ChannelConfigDecodeErrorZ } from '../structs/Result_ChannelConfigDecodeErrorZ.mjs';
179 import { Result_OutPointDecodeErrorZ } from '../structs/Result_OutPointDecodeErrorZ.mjs';
180 import { Type, TypeInterface } from '../structs/Type.mjs';
181 import { Option_TypeZ } from '../structs/Option_TypeZ.mjs';
182 import { Result_COption_TypeZDecodeErrorZ } from '../structs/Result_COption_TypeZDecodeErrorZ.mjs';
183 import { PaymentError } from '../structs/PaymentError.mjs';
184 import { Result_PaymentIdPaymentErrorZ } from '../structs/Result_PaymentIdPaymentErrorZ.mjs';
185 import { Result_SiPrefixNoneZ } from '../structs/Result_SiPrefixNoneZ.mjs';
186 import { Invoice } from '../structs/Invoice.mjs';
187 import { Result_InvoiceNoneZ } from '../structs/Result_InvoiceNoneZ.mjs';
188 import { SignedRawInvoice } from '../structs/SignedRawInvoice.mjs';
189 import { Result_SignedRawInvoiceNoneZ } from '../structs/Result_SignedRawInvoiceNoneZ.mjs';
190 import { RawInvoice } from '../structs/RawInvoice.mjs';
191 import { InvoiceSignature } from '../structs/InvoiceSignature.mjs';
192 import { ThreeTuple_RawInvoice_u832InvoiceSignatureZ } from '../structs/ThreeTuple_RawInvoice_u832InvoiceSignatureZ.mjs';
193 import { PayeePubKey } from '../structs/PayeePubKey.mjs';
194 import { Result_PayeePubKeyErrorZ } from '../structs/Result_PayeePubKeyErrorZ.mjs';
195 import { PrivateRoute } from '../structs/PrivateRoute.mjs';
196 import { PositiveTimestamp } from '../structs/PositiveTimestamp.mjs';
197 import { Result_PositiveTimestampCreationErrorZ } from '../structs/Result_PositiveTimestampCreationErrorZ.mjs';
198 import { Result_NoneSemanticErrorZ } from '../structs/Result_NoneSemanticErrorZ.mjs';
199 import { Result_InvoiceSemanticErrorZ } from '../structs/Result_InvoiceSemanticErrorZ.mjs';
200 import { Description } from '../structs/Description.mjs';
201 import { Result_DescriptionCreationErrorZ } from '../structs/Result_DescriptionCreationErrorZ.mjs';
202 import { Result_PrivateRouteCreationErrorZ } from '../structs/Result_PrivateRouteCreationErrorZ.mjs';
203 import { Result_StringErrorZ } from '../structs/Result_StringErrorZ.mjs';
204 import { Result_ChannelMonitorUpdateDecodeErrorZ } from '../structs/Result_ChannelMonitorUpdateDecodeErrorZ.mjs';
205 import { Option_MonitorEventZ } from '../structs/Option_MonitorEventZ.mjs';
206 import { Result_COption_MonitorEventZDecodeErrorZ } from '../structs/Result_COption_MonitorEventZDecodeErrorZ.mjs';
207 import { Result_HTLCUpdateDecodeErrorZ } from '../structs/Result_HTLCUpdateDecodeErrorZ.mjs';
208 import { TwoTuple_OutPointScriptZ } from '../structs/TwoTuple_OutPointScriptZ.mjs';
209 import { TwoTuple_u32ScriptZ } from '../structs/TwoTuple_u32ScriptZ.mjs';
210 import { TwoTuple_TxidCVec_C2Tuple_u32ScriptZZZ } from '../structs/TwoTuple_TxidCVec_C2Tuple_u32ScriptZZZ.mjs';
211 import { TwoTuple_u32TxOutZ } from '../structs/TwoTuple_u32TxOutZ.mjs';
212 import { TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ } from '../structs/TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ.mjs';
213 import { Balance } from '../structs/Balance.mjs';
214 import { TwoTuple_BlockHashChannelMonitorZ } from '../structs/TwoTuple_BlockHashChannelMonitorZ.mjs';
215 import { Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ } from '../structs/Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.mjs';
216 import { Result_NoneLightningErrorZ } from '../structs/Result_NoneLightningErrorZ.mjs';
217 import { TwoTuple_PublicKeyTypeZ } from '../structs/TwoTuple_PublicKeyTypeZ.mjs';
218 import { Result_boolLightningErrorZ } from '../structs/Result_boolLightningErrorZ.mjs';
219 import { ThreeTuple_ChannelAnnouncementChannelUpdateChannelUpdateZ } from '../structs/ThreeTuple_ChannelAnnouncementChannelUpdateChannelUpdateZ.mjs';
220 import { PeerHandleError } from '../structs/PeerHandleError.mjs';
221 import { Result_CVec_u8ZPeerHandleErrorZ } from '../structs/Result_CVec_u8ZPeerHandleErrorZ.mjs';
222 import { Result_NonePeerHandleErrorZ } from '../structs/Result_NonePeerHandleErrorZ.mjs';
223 import { Result_boolPeerHandleErrorZ } from '../structs/Result_boolPeerHandleErrorZ.mjs';
224 import { NodeId } from '../structs/NodeId.mjs';
225 import { Result_NodeIdDecodeErrorZ } from '../structs/Result_NodeIdDecodeErrorZ.mjs';
226 import { Result_COption_NetworkUpdateZDecodeErrorZ } from '../structs/Result_COption_NetworkUpdateZDecodeErrorZ.mjs';
227 import { Access, AccessInterface } from '../structs/Access.mjs';
228 import { Option_AccessZ } from '../structs/Option_AccessZ.mjs';
229 import { ChannelUpdateInfo } from '../structs/ChannelUpdateInfo.mjs';
230 import { Result_ChannelUpdateInfoDecodeErrorZ } from '../structs/Result_ChannelUpdateInfoDecodeErrorZ.mjs';
231 import { ChannelInfo } from '../structs/ChannelInfo.mjs';
232 import { Result_ChannelInfoDecodeErrorZ } from '../structs/Result_ChannelInfoDecodeErrorZ.mjs';
233 import { RoutingFees } from '../structs/RoutingFees.mjs';
234 import { Result_RoutingFeesDecodeErrorZ } from '../structs/Result_RoutingFeesDecodeErrorZ.mjs';
235 import { NodeAnnouncementInfo } from '../structs/NodeAnnouncementInfo.mjs';
236 import { Result_NodeAnnouncementInfoDecodeErrorZ } from '../structs/Result_NodeAnnouncementInfoDecodeErrorZ.mjs';
237 import { NodeInfo } from '../structs/NodeInfo.mjs';
238 import { Result_NodeInfoDecodeErrorZ } from '../structs/Result_NodeInfoDecodeErrorZ.mjs';
239 import { Result_NetworkGraphDecodeErrorZ } from '../structs/Result_NetworkGraphDecodeErrorZ.mjs';
240 import { Option_CVec_NetAddressZZ } from '../structs/Option_CVec_NetAddressZZ.mjs';
241 import { Result_NetAddressDecodeErrorZ } from '../structs/Result_NetAddressDecodeErrorZ.mjs';
242 import { UpdateAddHTLC } from '../structs/UpdateAddHTLC.mjs';
243 import { UpdateFulfillHTLC } from '../structs/UpdateFulfillHTLC.mjs';
244 import { UpdateFailHTLC } from '../structs/UpdateFailHTLC.mjs';
245 import { UpdateFailMalformedHTLC } from '../structs/UpdateFailMalformedHTLC.mjs';
246 import { Result_AcceptChannelDecodeErrorZ } from '../structs/Result_AcceptChannelDecodeErrorZ.mjs';
247 import { Result_AnnouncementSignaturesDecodeErrorZ } from '../structs/Result_AnnouncementSignaturesDecodeErrorZ.mjs';
248 import { Result_ChannelReestablishDecodeErrorZ } from '../structs/Result_ChannelReestablishDecodeErrorZ.mjs';
249 import { Result_ClosingSignedDecodeErrorZ } from '../structs/Result_ClosingSignedDecodeErrorZ.mjs';
250 import { ClosingSignedFeeRange } from '../structs/ClosingSignedFeeRange.mjs';
251 import { Result_ClosingSignedFeeRangeDecodeErrorZ } from '../structs/Result_ClosingSignedFeeRangeDecodeErrorZ.mjs';
252 import { CommitmentSigned } from '../structs/CommitmentSigned.mjs';
253 import { Result_CommitmentSignedDecodeErrorZ } from '../structs/Result_CommitmentSignedDecodeErrorZ.mjs';
254 import { Result_FundingCreatedDecodeErrorZ } from '../structs/Result_FundingCreatedDecodeErrorZ.mjs';
255 import { Result_FundingSignedDecodeErrorZ } from '../structs/Result_FundingSignedDecodeErrorZ.mjs';
256 import { Result_FundingLockedDecodeErrorZ } from '../structs/Result_FundingLockedDecodeErrorZ.mjs';
257 import { Init } from '../structs/Init.mjs';
258 import { Result_InitDecodeErrorZ } from '../structs/Result_InitDecodeErrorZ.mjs';
259 import { Result_OpenChannelDecodeErrorZ } from '../structs/Result_OpenChannelDecodeErrorZ.mjs';
260 import { Result_RevokeAndACKDecodeErrorZ } from '../structs/Result_RevokeAndACKDecodeErrorZ.mjs';
261 import { Result_ShutdownDecodeErrorZ } from '../structs/Result_ShutdownDecodeErrorZ.mjs';
262 import { Result_UpdateFailHTLCDecodeErrorZ } from '../structs/Result_UpdateFailHTLCDecodeErrorZ.mjs';
263 import { Result_UpdateFailMalformedHTLCDecodeErrorZ } from '../structs/Result_UpdateFailMalformedHTLCDecodeErrorZ.mjs';
264 import { UpdateFee } from '../structs/UpdateFee.mjs';
265 import { Result_UpdateFeeDecodeErrorZ } from '../structs/Result_UpdateFeeDecodeErrorZ.mjs';
266 import { Result_UpdateFulfillHTLCDecodeErrorZ } from '../structs/Result_UpdateFulfillHTLCDecodeErrorZ.mjs';
267 import { Result_UpdateAddHTLCDecodeErrorZ } from '../structs/Result_UpdateAddHTLCDecodeErrorZ.mjs';
268 import { Ping } from '../structs/Ping.mjs';
269 import { Result_PingDecodeErrorZ } from '../structs/Result_PingDecodeErrorZ.mjs';
270 import { Pong } from '../structs/Pong.mjs';
271 import { Result_PongDecodeErrorZ } from '../structs/Result_PongDecodeErrorZ.mjs';
272 import { Result_UnsignedChannelAnnouncementDecodeErrorZ } from '../structs/Result_UnsignedChannelAnnouncementDecodeErrorZ.mjs';
273 import { Result_ChannelAnnouncementDecodeErrorZ } from '../structs/Result_ChannelAnnouncementDecodeErrorZ.mjs';
274 import { UnsignedChannelUpdate } from '../structs/UnsignedChannelUpdate.mjs';
275 import { Result_UnsignedChannelUpdateDecodeErrorZ } from '../structs/Result_UnsignedChannelUpdateDecodeErrorZ.mjs';
276 import { Result_ChannelUpdateDecodeErrorZ } from '../structs/Result_ChannelUpdateDecodeErrorZ.mjs';
277 import { Result_ErrorMessageDecodeErrorZ } from '../structs/Result_ErrorMessageDecodeErrorZ.mjs';
278 import { Result_WarningMessageDecodeErrorZ } from '../structs/Result_WarningMessageDecodeErrorZ.mjs';
279 import { UnsignedNodeAnnouncement } from '../structs/UnsignedNodeAnnouncement.mjs';
280 import { Result_UnsignedNodeAnnouncementDecodeErrorZ } from '../structs/Result_UnsignedNodeAnnouncementDecodeErrorZ.mjs';
281 import { Result_NodeAnnouncementDecodeErrorZ } from '../structs/Result_NodeAnnouncementDecodeErrorZ.mjs';
282 import { Result_QueryShortChannelIdsDecodeErrorZ } from '../structs/Result_QueryShortChannelIdsDecodeErrorZ.mjs';
283 import { ReplyShortChannelIdsEnd } from '../structs/ReplyShortChannelIdsEnd.mjs';
284 import { Result_ReplyShortChannelIdsEndDecodeErrorZ } from '../structs/Result_ReplyShortChannelIdsEndDecodeErrorZ.mjs';
285 import { Result_QueryChannelRangeDecodeErrorZ } from '../structs/Result_QueryChannelRangeDecodeErrorZ.mjs';
286 import { Result_ReplyChannelRangeDecodeErrorZ } from '../structs/Result_ReplyChannelRangeDecodeErrorZ.mjs';
287 import { GossipTimestampFilter } from '../structs/GossipTimestampFilter.mjs';
288 import { Result_GossipTimestampFilterDecodeErrorZ } from '../structs/Result_GossipTimestampFilterDecodeErrorZ.mjs';
289 import { SignOrCreationError } from '../structs/SignOrCreationError.mjs';
290 import { Result_InvoiceSignOrCreationErrorZ } from '../structs/Result_InvoiceSignOrCreationErrorZ.mjs';
291 import { WatchedOutput } from '../structs/WatchedOutput.mjs';
292 import { Filter, FilterInterface } from '../structs/Filter.mjs';
293 import { Option_FilterZ } from '../structs/Option_FilterZ.mjs';
294 import { LockedChannelMonitor } from '../structs/LockedChannelMonitor.mjs';
295 import { Result_LockedChannelMonitorNoneZ } from '../structs/Result_LockedChannelMonitorNoneZ.mjs';
296 import { MessageSendEventsProvider, MessageSendEventsProviderInterface } from '../structs/MessageSendEventsProvider.mjs';
297 import { EventHandler, EventHandlerInterface } from '../structs/EventHandler.mjs';
298 import { EventsProvider, EventsProviderInterface } from '../structs/EventsProvider.mjs';
299 import { ChannelHandshakeConfig } from '../structs/ChannelHandshakeConfig.mjs';
300 import { ChannelHandshakeLimits } from '../structs/ChannelHandshakeLimits.mjs';
301 import { UserConfig } from '../structs/UserConfig.mjs';
302 import { BestBlock } from '../structs/BestBlock.mjs';
303 import { Listen, ListenInterface } from '../structs/Listen.mjs';
304 import { Confirm, ConfirmInterface } from '../structs/Confirm.mjs';
305 import { MonitorUpdateId } from '../structs/MonitorUpdateId.mjs';
306 import { Persist, PersistInterface } from '../structs/Persist.mjs';
307 import { ChainMonitor } from '../structs/ChainMonitor.mjs';
308 import { KeysManager } from '../structs/KeysManager.mjs';
309 import { PhantomKeysManager } from '../structs/PhantomKeysManager.mjs';
310 import { ChainParameters } from '../structs/ChainParameters.mjs';
311 import { ChannelMessageHandler, ChannelMessageHandlerInterface } from '../structs/ChannelMessageHandler.mjs';
312 import { ChannelManagerReadArgs } from '../structs/ChannelManagerReadArgs.mjs';
313 import { DataLossProtect } from '../structs/DataLossProtect.mjs';
314 import { RoutingMessageHandler, RoutingMessageHandlerInterface } from '../structs/RoutingMessageHandler.mjs';
315 import { CustomMessageReader, CustomMessageReaderInterface } from '../structs/CustomMessageReader.mjs';
316 import { CustomMessageHandler, CustomMessageHandlerInterface } from '../structs/CustomMessageHandler.mjs';
317 import { IgnoringMessageHandler } from '../structs/IgnoringMessageHandler.mjs';
318 import { ErroringMessageHandler } from '../structs/ErroringMessageHandler.mjs';
319 import { MessageHandler } from '../structs/MessageHandler.mjs';
320 import { SocketDescriptor, SocketDescriptorInterface } from '../structs/SocketDescriptor.mjs';
321 import { PeerManager } from '../structs/PeerManager.mjs';
322 import { DirectedChannelTransactionParameters } from '../structs/DirectedChannelTransactionParameters.mjs';
323 import { ReadOnlyNetworkGraph } from '../structs/ReadOnlyNetworkGraph.mjs';
324 import { NetGraphMsgHandler } from '../structs/NetGraphMsgHandler.mjs';
325 import { DirectedChannelInfo } from '../structs/DirectedChannelInfo.mjs';
326 import { EffectiveCapacity } from '../structs/EffectiveCapacity.mjs';
327 import { Score, ScoreInterface } from '../structs/Score.mjs';
328 import { LockableScore, LockableScoreInterface } from '../structs/LockableScore.mjs';
329 import { MultiThreadedLockableScore } from '../structs/MultiThreadedLockableScore.mjs';
330 import { RawDataPart } from '../structs/RawDataPart.mjs';
331 import { Sha256 } from '../structs/Sha256.mjs';
332 import { ExpiryTime } from '../structs/ExpiryTime.mjs';
333 import { MinFinalCltvExpiry } from '../structs/MinFinalCltvExpiry.mjs';
334 import { Fallback } from '../structs/Fallback.mjs';
335 import { Payer, PayerInterface } from '../structs/Payer.mjs';
336 import { Router, RouterInterface } from '../structs/Router.mjs';
337 import { InvoicePayer } from '../structs/InvoicePayer.mjs';
338 import { RetryAttempts } from '../structs/RetryAttempts.mjs';
339 import { DefaultRouter } from '../structs/DefaultRouter.mjs';
341 import { CommonBase, UInt5 } from './CommonBase.mjs';
342 import * as bindings from '../bindings.mjs'
346 * Manager which keeps track of a number of channels and sends messages to the appropriate
347 * channel, also tracking HTLC preimages and forwarding onion packets appropriately.
349 * Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
350 * to individual Channels.
352 * Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
353 * all peers during write/read (though does not modify this instance, only the instance being
354 * serialized). This will result in any channels which have not yet exchanged funding_created (ie
355 * called funding_transaction_generated for outbound channels).
357 * Note that you can be a bit lazier about writing out ChannelManager than you can be with
358 * ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
359 * returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
360 * happens out-of-band (and will prevent any other ChannelManager operations from occurring during
361 * the serialization process). If the deserialized version is out-of-date compared to the
362 * ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
363 * ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
365 * Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
366 * tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
367 * the \"reorg path\" (ie call block_disconnected() until you get to a common block and then call
368 * block_connected() to step towards your best block) upon deserialization before using the
371 * Note that ChannelManager is responsible for tracking liveness of its channels and generating
372 * ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
373 * spam due to quick disconnection/reconnection, updates are not sent until the channel has been
374 * offline for a full minute. In order to track this, you must call
375 * timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
377 * Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
378 * a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
379 * essentially you should default to using a SimpleRefChannelManager, and use a
380 * SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
381 * you're using lightning-net-tokio.
383 export class ChannelManager extends CommonBase {
385 public constructor(_dummy: object, ptr: number) {
386 super(ptr, bindings.ChannelManager_free);
390 * Constructs a new ChannelManager to hold several channels and route between them.
392 * This is the main \"logic hub\" for all channel-related actions, and implements
393 * ChannelMessageHandler.
395 * Non-proportional fees are fixed according to our risk using the provided fee estimator.
397 * panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
399 * Users need to notify the new ChannelManager when a new block is connected or
400 * disconnected using its `block_connected` and `block_disconnected` methods, starting
401 * from after `params.latest_hash`.
403 public static constructor_new(fee_est: FeeEstimator, chain_monitor: Watch, tx_broadcaster: BroadcasterInterface, logger: Logger, keys_manager: KeysInterface, config: UserConfig, params: ChainParameters): ChannelManager {
404 const ret: number = bindings.ChannelManager_new(fee_est == null ? 0 : CommonBase.get_ptr_of(fee_est), chain_monitor == null ? 0 : CommonBase.get_ptr_of(chain_monitor), tx_broadcaster == null ? 0 : CommonBase.get_ptr_of(tx_broadcaster), logger == null ? 0 : CommonBase.get_ptr_of(logger), keys_manager == null ? 0 : CommonBase.get_ptr_of(keys_manager), config == null ? 0 : CommonBase.get_ptr_of(config) & ~1, params == null ? 0 : CommonBase.get_ptr_of(params) & ~1);
405 const ret_hu_conv: ChannelManager = new ChannelManager(null, ret);
406 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
407 CommonBase.add_ref_from(ret_hu_conv, fee_est);
408 CommonBase.add_ref_from(ret_hu_conv, chain_monitor);
409 CommonBase.add_ref_from(ret_hu_conv, tx_broadcaster);
410 CommonBase.add_ref_from(ret_hu_conv, logger);
411 CommonBase.add_ref_from(ret_hu_conv, keys_manager);
416 * Gets the current configuration applied to all new channels, as
418 public get_current_default_configuration(): UserConfig {
419 const ret: number = bindings.ChannelManager_get_current_default_configuration(this.ptr);
420 const ret_hu_conv: UserConfig = new UserConfig(null, ret);
421 CommonBase.add_ref_from(ret_hu_conv, this);
426 * Creates a new outbound channel to the given remote node and with the given value.
428 * `user_channel_id` will be provided back as in
429 * [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
430 * correspond with which `create_channel` call. Note that the `user_channel_id` defaults to 0
431 * for inbound channels, so you may wish to avoid using 0 for `user_channel_id` here.
432 * `user_channel_id` has no meaning inside of LDK, it is simply copied to events and otherwise
435 * Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
436 * greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
438 * Note that we do not check if you are currently connected to the given peer. If no
439 * connection is available, the outbound `open_channel` message may fail to send, resulting in
440 * the channel eventually being silently forgotten (dropped on reload).
442 * Returns the new Channel's temporary `channel_id`. This ID will appear as
443 * [`Event::FundingGenerationReady::temporary_channel_id`] and in
444 * [`ChannelDetails::channel_id`] until after
445 * [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
446 * one derived from the funding transaction's TXID. If the counterparty rejects the channel
447 * immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
449 * [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
450 * [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
451 * [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
453 * Note that override_config (or a relevant inner pointer) may be NULL or all-0s to represent None
455 public create_channel(their_network_key: Uint8Array, channel_value_satoshis: bigint, push_msat: bigint, user_channel_id: bigint, override_config: UserConfig): Result__u832APIErrorZ {
456 const ret: number = bindings.ChannelManager_create_channel(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(their_network_key, 33)), channel_value_satoshis, push_msat, user_channel_id, override_config == null ? 0 : CommonBase.get_ptr_of(override_config) & ~1);
457 const ret_hu_conv: Result__u832APIErrorZ = Result__u832APIErrorZ.constr_from_ptr(ret);
462 * Gets the list of open channels, in random order. See ChannelDetail field documentation for
465 public list_channels(): ChannelDetails[] {
466 const ret: number = bindings.ChannelManager_list_channels(this.ptr);
467 const ret_conv_16_len: number = bindings.getArrayLength(ret);
468 const ret_conv_16_arr: ChannelDetails[] = new Array(ret_conv_16_len).fill(null);
469 for (var q = 0; q < ret_conv_16_len; q++) {
470 const ret_conv_16: number = bindings.getU32ArrayElem(ret, q);
471 const ret_conv_16_hu_conv: ChannelDetails = new ChannelDetails(null, ret_conv_16);
472 CommonBase.add_ref_from(ret_conv_16_hu_conv, this);
473 ret_conv_16_arr[q] = ret_conv_16_hu_conv;
475 bindings.freeWasmMemory(ret)
476 return ret_conv_16_arr;
480 * Gets the list of usable channels, in random order. Useful as an argument to
481 * get_route to ensure non-announced channels are used.
483 * These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
484 * documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
487 public list_usable_channels(): ChannelDetails[] {
488 const ret: number = bindings.ChannelManager_list_usable_channels(this.ptr);
489 const ret_conv_16_len: number = bindings.getArrayLength(ret);
490 const ret_conv_16_arr: ChannelDetails[] = new Array(ret_conv_16_len).fill(null);
491 for (var q = 0; q < ret_conv_16_len; q++) {
492 const ret_conv_16: number = bindings.getU32ArrayElem(ret, q);
493 const ret_conv_16_hu_conv: ChannelDetails = new ChannelDetails(null, ret_conv_16);
494 CommonBase.add_ref_from(ret_conv_16_hu_conv, this);
495 ret_conv_16_arr[q] = ret_conv_16_hu_conv;
497 bindings.freeWasmMemory(ret)
498 return ret_conv_16_arr;
502 * Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
503 * will be accepted on the given channel, and after additional timeout/the closing of all
504 * pending HTLCs, the channel will be closed on chain.
506 * If we are the channel initiator, we will pay between our [`Background`] and
507 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
509 * If our counterparty is the channel initiator, we will require a channel closing
510 * transaction feerate of at least our [`Background`] feerate or the feerate which
511 * would appear on a force-closure transaction, whichever is lower. We will allow our
512 * counterparty to pay as much fee as they'd like, however.
514 * May generate a SendShutdown message event on success, which should be relayed.
516 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
517 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
518 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
520 public close_channel(channel_id: Uint8Array): Result_NoneAPIErrorZ {
521 const ret: number = bindings.ChannelManager_close_channel(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(channel_id, 32)));
522 const ret_hu_conv: Result_NoneAPIErrorZ = Result_NoneAPIErrorZ.constr_from_ptr(ret);
527 * Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
528 * will be accepted on the given channel, and after additional timeout/the closing of all
529 * pending HTLCs, the channel will be closed on chain.
531 * `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
532 * the channel being closed or not:
533 * If we are the channel initiator, we will pay at least this feerate on the closing
534 * transaction. The upper-bound is set by
535 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
536 * estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
537 * If our counterparty is the channel initiator, we will refuse to accept a channel closure
538 * transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
539 * will appear on a force-closure transaction, whichever is lower).
541 * May generate a SendShutdown message event on success, which should be relayed.
543 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
544 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
545 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
547 public close_channel_with_target_feerate(channel_id: Uint8Array, target_feerate_sats_per_1000_weight: number): Result_NoneAPIErrorZ {
548 const ret: number = bindings.ChannelManager_close_channel_with_target_feerate(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(channel_id, 32)), target_feerate_sats_per_1000_weight);
549 const ret_hu_conv: Result_NoneAPIErrorZ = Result_NoneAPIErrorZ.constr_from_ptr(ret);
554 * Force closes a channel, immediately broadcasting the latest local commitment transaction to
555 * the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
557 public force_close_channel(channel_id: Uint8Array): Result_NoneAPIErrorZ {
558 const ret: number = bindings.ChannelManager_force_close_channel(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(channel_id, 32)));
559 const ret_hu_conv: Result_NoneAPIErrorZ = Result_NoneAPIErrorZ.constr_from_ptr(ret);
564 * Force close all channels, immediately broadcasting the latest local commitment transaction
565 * for each to the chain and rejecting new HTLCs on each.
567 public force_close_all_channels(): void {
568 bindings.ChannelManager_force_close_all_channels(this.ptr);
572 * Sends a payment along a given route.
574 * Value parameters are provided via the last hop in route, see documentation for RouteHop
575 * fields for more info.
577 * Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
578 * payment), we don't do anything to stop you! We always try to ensure that if the provided
579 * next hop knows the preimage to payment_hash they can claim an additional amount as
580 * specified in the last hop in the route! Thus, you should probably do your own
581 * payment_preimage tracking (which you should already be doing as they represent \"proof of
582 * payment\") and prevent double-sends yourself.
584 * May generate SendHTLCs message(s) event on success, which should be relayed.
586 * Each path may have a different return value, and PaymentSendValue may return a Vec with
587 * each entry matching the corresponding-index entry in the route paths, see
588 * PaymentSendFailure for more info.
590 * In general, a path may raise:
591 * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
592 * node public key) is specified.
593 * APIError::ChannelUnavailable if the next-hop channel is not available for updates
594 * (including due to previous monitor update failure or new permanent monitor update
596 * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
599 * Note that depending on the type of the PaymentSendFailure the HTLC may have been
600 * irrevocably committed to on our end. In such a case, do NOT retry the payment with a
601 * different route unless you intend to pay twice!
603 * payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
604 * the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
605 * newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
606 * must not contain multiple paths as multi-path payments require a recipient-provided
608 * If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
609 * bit set (either as required or as available). If multiple paths are present in the Route,
610 * we assume the invoice had the basic_mpp feature set.
612 * Note that payment_secret (or a relevant inner pointer) may be NULL or all-0s to represent None
614 public send_payment(route: Route, payment_hash: Uint8Array, payment_secret: Uint8Array): Result_PaymentIdPaymentSendFailureZ {
615 const ret: number = bindings.ChannelManager_send_payment(this.ptr, route == null ? 0 : CommonBase.get_ptr_of(route) & ~1, bindings.encodeUint8Array(bindings.check_arr_len(payment_hash, 32)), bindings.encodeUint8Array(bindings.check_arr_len(payment_secret, 32)));
616 const ret_hu_conv: Result_PaymentIdPaymentSendFailureZ = Result_PaymentIdPaymentSendFailureZ.constr_from_ptr(ret);
617 CommonBase.add_ref_from(this, route);
622 * Retries a payment along the given [`Route`].
624 * Errors returned are a superset of those returned from [`send_payment`], so see
625 * [`send_payment`] documentation for more details on errors. This method will also error if the
626 * retry amount puts the payment more than 10% over the payment's total amount, if the payment
627 * for the given `payment_id` cannot be found (likely due to timeout or success), or if
628 * further retries have been disabled with [`abandon_payment`].
630 * [`send_payment`]: [`ChannelManager::send_payment`]
631 * [`abandon_payment`]: [`ChannelManager::abandon_payment`]
633 public retry_payment(route: Route, payment_id: Uint8Array): Result_NonePaymentSendFailureZ {
634 const ret: number = bindings.ChannelManager_retry_payment(this.ptr, route == null ? 0 : CommonBase.get_ptr_of(route) & ~1, bindings.encodeUint8Array(bindings.check_arr_len(payment_id, 32)));
635 const ret_hu_conv: Result_NonePaymentSendFailureZ = Result_NonePaymentSendFailureZ.constr_from_ptr(ret);
636 CommonBase.add_ref_from(this, route);
641 * Signals that no further retries for the given payment will occur.
643 * After this method returns, any future calls to [`retry_payment`] for the given `payment_id`
644 * will fail with [`PaymentSendFailure::ParameterError`]. If no such event has been generated,
645 * an [`Event::PaymentFailed`] event will be generated as soon as there are no remaining
646 * pending HTLCs for this payment.
648 * Note that calling this method does *not* prevent a payment from succeeding. You must still
649 * wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
650 * determine the ultimate status of a payment.
652 * [`retry_payment`]: Self::retry_payment
653 * [`Event::PaymentFailed`]: events::Event::PaymentFailed
654 * [`Event::PaymentSent`]: events::Event::PaymentSent
656 public abandon_payment(payment_id: Uint8Array): void {
657 bindings.ChannelManager_abandon_payment(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(payment_id, 32)));
661 * Send a spontaneous payment, which is a payment that does not require the recipient to have
662 * generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
663 * the preimage, it must be a cryptographically secure random value that no intermediate node
664 * would be able to guess -- otherwise, an intermediate node may claim the payment and it will
665 * never reach the recipient.
667 * See [`send_payment`] documentation for more details on the return value of this function.
669 * Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
670 * [`send_payment`] for more information about the risks of duplicate preimage usage.
672 * Note that `route` must have exactly one path.
674 * [`send_payment`]: Self::send_payment
676 * Note that payment_preimage (or a relevant inner pointer) may be NULL or all-0s to represent None
678 public send_spontaneous_payment(route: Route, payment_preimage: Uint8Array): Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ {
679 const ret: number = bindings.ChannelManager_send_spontaneous_payment(this.ptr, route == null ? 0 : CommonBase.get_ptr_of(route) & ~1, bindings.encodeUint8Array(bindings.check_arr_len(payment_preimage, 32)));
680 const ret_hu_conv: Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ = Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ.constr_from_ptr(ret);
681 CommonBase.add_ref_from(this, route);
686 * Call this upon creation of a funding transaction for the given channel.
688 * Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
689 * or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
691 * Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
692 * for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
694 * May panic if the output found in the funding transaction is duplicative with some other
695 * channel (note that this should be trivially prevented by using unique funding transaction
698 * Do NOT broadcast the funding transaction yourself. When we have safely received our
699 * counterparty's signature the funding transaction will automatically be broadcast via the
700 * [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
702 * Note that this includes RBF or similar transaction replacement strategies - lightning does
703 * not currently support replacing a funding transaction on an existing channel. Instead,
704 * create a new channel with a conflicting funding transaction.
706 * [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
707 * [`Event::ChannelClosed`]: crate::util::events::Event::ChannelClosed
709 public funding_transaction_generated(temporary_channel_id: Uint8Array, funding_transaction: Uint8Array): Result_NoneAPIErrorZ {
710 const ret: number = bindings.ChannelManager_funding_transaction_generated(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(temporary_channel_id, 32)), bindings.encodeUint8Array(funding_transaction));
711 const ret_hu_conv: Result_NoneAPIErrorZ = Result_NoneAPIErrorZ.constr_from_ptr(ret);
716 * Regenerates channel_announcements and generates a signed node_announcement from the given
717 * arguments, providing them in corresponding events via
718 * [`get_and_clear_pending_msg_events`], if at least one public channel has been confirmed
719 * on-chain. This effectively re-broadcasts all channel announcements and sends our node
720 * announcement to ensure that the lightning P2P network is aware of the channels we have and
721 * our network addresses.
723 * `rgb` is a node \"color\" and `alias` is a printable human-readable string to describe this
724 * node to humans. They carry no in-protocol meaning.
726 * `addresses` represent the set (possibly empty) of socket addresses on which this node
727 * accepts incoming connections. These will be included in the node_announcement, publicly
728 * tying these addresses together and to this node. If you wish to preserve user privacy,
729 * addresses should likely contain only Tor Onion addresses.
731 * Panics if `addresses` is absurdly large (more than 500).
733 * [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
735 public broadcast_node_announcement(rgb: Uint8Array, alias: Uint8Array, addresses: NetAddress[]): void {
736 bindings.ChannelManager_broadcast_node_announcement(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(rgb, 3)), bindings.encodeUint8Array(bindings.check_arr_len(alias, 32)), bindings.encodeUint32Array(addresses != null ? addresses.map(addresses_conv_12 => CommonBase.get_ptr_of(addresses_conv_12)) : null));
740 * Processes HTLCs which are pending waiting on random forward delay.
742 * Should only really ever be called in response to a PendingHTLCsForwardable event.
743 * Will likely generate further events.
745 public process_pending_htlc_forwards(): void {
746 bindings.ChannelManager_process_pending_htlc_forwards(this.ptr);
750 * Performs actions which should happen on startup and roughly once per minute thereafter.
752 * This currently includes:
753 * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
754 * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
755 * than a minute, informing the network that they should no longer attempt to route over
758 * Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
761 public timer_tick_occurred(): void {
762 bindings.ChannelManager_timer_tick_occurred(this.ptr);
766 * Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
767 * after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
768 * along the path (including in our own channel on which we received it).
769 * Returns false if no payment was found to fail backwards, true if the process of failing the
770 * HTLC backwards has been started.
772 public fail_htlc_backwards(payment_hash: Uint8Array): boolean {
773 const ret: boolean = bindings.ChannelManager_fail_htlc_backwards(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(payment_hash, 32)));
778 * Provides a payment preimage in response to [`Event::PaymentReceived`], generating any
779 * [`MessageSendEvent`]s needed to claim the payment.
781 * Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
782 * [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
783 * event matches your expectation. If you fail to do so and call this method, you may provide
784 * the sender \"proof-of-payment\" when they did not fulfill the full expected payment.
786 * Returns whether any HTLCs were claimed, and thus if any new [`MessageSendEvent`]s are now
787 * pending for processing via [`get_and_clear_pending_msg_events`].
789 * [`Event::PaymentReceived`]: crate::util::events::Event::PaymentReceived
790 * [`create_inbound_payment`]: Self::create_inbound_payment
791 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
792 * [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
794 public claim_funds(payment_preimage: Uint8Array): boolean {
795 const ret: boolean = bindings.ChannelManager_claim_funds(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(payment_preimage, 32)));
800 * Gets the node_id held by this ChannelManager
802 public get_our_node_id(): Uint8Array {
803 const ret: number = bindings.ChannelManager_get_our_node_id(this.ptr);
804 const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
809 * Called to accept a request to open a channel after [`Event::OpenChannelRequest`] has been
812 * The `temporary_channel_id` parameter indicates which inbound channel should be accepted.
814 * [`Event::OpenChannelRequest`]: crate::util::events::Event::OpenChannelRequest
816 public accept_inbound_channel(temporary_channel_id: Uint8Array): Result_NoneAPIErrorZ {
817 const ret: number = bindings.ChannelManager_accept_inbound_channel(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(temporary_channel_id, 32)));
818 const ret_hu_conv: Result_NoneAPIErrorZ = Result_NoneAPIErrorZ.constr_from_ptr(ret);
823 * Gets a payment secret and payment hash for use in an invoice given to a third party wishing
826 * This differs from [`create_inbound_payment_for_hash`] only in that it generates the
827 * [`PaymentHash`] and [`PaymentPreimage`] for you.
829 * The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
830 * will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
831 * passed directly to [`claim_funds`].
833 * See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
835 * Note that a malicious eavesdropper can intuit whether an inbound payment was created by
836 * `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
840 * If you register an inbound payment with this method, then serialize the `ChannelManager`, then
841 * deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
843 * Errors if `min_value_msat` is greater than total bitcoin supply.
845 * [`claim_funds`]: Self::claim_funds
846 * [`PaymentReceived`]: events::Event::PaymentReceived
847 * [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
848 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
850 public create_inbound_payment(min_value_msat: Option_u64Z, invoice_expiry_delta_secs: number): Result_C2Tuple_PaymentHashPaymentSecretZNoneZ {
851 const ret: number = bindings.ChannelManager_create_inbound_payment(this.ptr, CommonBase.get_ptr_of(min_value_msat), invoice_expiry_delta_secs);
852 const ret_hu_conv: Result_C2Tuple_PaymentHashPaymentSecretZNoneZ = Result_C2Tuple_PaymentHashPaymentSecretZNoneZ.constr_from_ptr(ret);
857 * Legacy version of [`create_inbound_payment`]. Use this method if you wish to share
858 * serialized state with LDK node(s) running 0.0.103 and earlier.
861 * This method is deprecated and will be removed soon.
863 * [`create_inbound_payment`]: Self::create_inbound_payment
865 public create_inbound_payment_legacy(min_value_msat: Option_u64Z, invoice_expiry_delta_secs: number): Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ {
866 const ret: number = bindings.ChannelManager_create_inbound_payment_legacy(this.ptr, CommonBase.get_ptr_of(min_value_msat), invoice_expiry_delta_secs);
867 const ret_hu_conv: Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ = Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ.constr_from_ptr(ret);
872 * Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
873 * stored external to LDK.
875 * A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
876 * payment secret fetched via this method or [`create_inbound_payment`], and which is at least
877 * the `min_value_msat` provided here, if one is provided.
879 * The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
880 * note that LDK will not stop you from registering duplicate payment hashes for inbound
883 * `min_value_msat` should be set if the invoice being generated contains a value. Any payment
884 * received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
885 * before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
886 * sender \"proof-of-payment\" unless they have paid the required amount.
888 * `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
889 * in excess of the current time. This should roughly match the expiry time set in the invoice.
890 * After this many seconds, we will remove the inbound payment, resulting in any attempts to
891 * pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
892 * invoices when no timeout is set.
894 * Note that we use block header time to time-out pending inbound payments (with some margin
895 * to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
896 * accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
897 * If you need exact expiry semantics, you should enforce them upon receipt of
898 * [`PaymentReceived`].
900 * May panic if `invoice_expiry_delta_secs` is greater than one year.
902 * Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
903 * set to at least [`MIN_FINAL_CLTV_EXPIRY`].
905 * Note that a malicious eavesdropper can intuit whether an inbound payment was created by
906 * `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
910 * If you register an inbound payment with this method, then serialize the `ChannelManager`, then
911 * deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
913 * Errors if `min_value_msat` is greater than total bitcoin supply.
915 * [`create_inbound_payment`]: Self::create_inbound_payment
916 * [`PaymentReceived`]: events::Event::PaymentReceived
918 public create_inbound_payment_for_hash(payment_hash: Uint8Array, min_value_msat: Option_u64Z, invoice_expiry_delta_secs: number): Result_PaymentSecretNoneZ {
919 const ret: number = bindings.ChannelManager_create_inbound_payment_for_hash(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(payment_hash, 32)), CommonBase.get_ptr_of(min_value_msat), invoice_expiry_delta_secs);
920 const ret_hu_conv: Result_PaymentSecretNoneZ = Result_PaymentSecretNoneZ.constr_from_ptr(ret);
925 * Legacy version of [`create_inbound_payment_for_hash`]. Use this method if you wish to share
926 * serialized state with LDK node(s) running 0.0.103 and earlier.
929 * This method is deprecated and will be removed soon.
931 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
933 public create_inbound_payment_for_hash_legacy(payment_hash: Uint8Array, min_value_msat: Option_u64Z, invoice_expiry_delta_secs: number): Result_PaymentSecretAPIErrorZ {
934 const ret: number = bindings.ChannelManager_create_inbound_payment_for_hash_legacy(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(payment_hash, 32)), CommonBase.get_ptr_of(min_value_msat), invoice_expiry_delta_secs);
935 const ret_hu_conv: Result_PaymentSecretAPIErrorZ = Result_PaymentSecretAPIErrorZ.constr_from_ptr(ret);
940 * Gets an LDK-generated payment preimage from a payment hash and payment secret that were
941 * previously returned from [`create_inbound_payment`].
943 * [`create_inbound_payment`]: Self::create_inbound_payment
945 public get_payment_preimage(payment_hash: Uint8Array, payment_secret: Uint8Array): Result_PaymentPreimageAPIErrorZ {
946 const ret: number = bindings.ChannelManager_get_payment_preimage(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(payment_hash, 32)), bindings.encodeUint8Array(bindings.check_arr_len(payment_secret, 32)));
947 const ret_hu_conv: Result_PaymentPreimageAPIErrorZ = Result_PaymentPreimageAPIErrorZ.constr_from_ptr(ret);
952 * Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
953 * are used when constructing the phantom invoice's route hints.
955 * [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
957 public get_phantom_scid(): bigint {
958 const ret: bigint = bindings.ChannelManager_get_phantom_scid(this.ptr);
963 * Gets route hints for use in receiving [phantom node payments].
965 * [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
967 public get_phantom_route_hints(): PhantomRouteHints {
968 const ret: number = bindings.ChannelManager_get_phantom_route_hints(this.ptr);
969 const ret_hu_conv: PhantomRouteHints = new PhantomRouteHints(null, ret);
970 CommonBase.add_ref_from(ret_hu_conv, this);
975 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
976 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
978 public as_MessageSendEventsProvider(): MessageSendEventsProvider {
979 const ret: number = bindings.ChannelManager_as_MessageSendEventsProvider(this.ptr);
980 const ret_hu_conv: MessageSendEventsProvider = new MessageSendEventsProvider(null, ret);
981 CommonBase.add_ref_from(ret_hu_conv, this);
986 * Constructs a new EventsProvider which calls the relevant methods on this_arg.
987 * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
989 public as_EventsProvider(): EventsProvider {
990 const ret: number = bindings.ChannelManager_as_EventsProvider(this.ptr);
991 const ret_hu_conv: EventsProvider = new EventsProvider(null, ret);
992 CommonBase.add_ref_from(ret_hu_conv, this);
997 * Constructs a new Listen which calls the relevant methods on this_arg.
998 * This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
1000 public as_Listen(): Listen {
1001 const ret: number = bindings.ChannelManager_as_Listen(this.ptr);
1002 const ret_hu_conv: Listen = new Listen(null, ret);
1003 CommonBase.add_ref_from(ret_hu_conv, this);
1008 * Constructs a new Confirm which calls the relevant methods on this_arg.
1009 * This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
1011 public as_Confirm(): Confirm {
1012 const ret: number = bindings.ChannelManager_as_Confirm(this.ptr);
1013 const ret_hu_conv: Confirm = new Confirm(null, ret);
1014 CommonBase.add_ref_from(ret_hu_conv, this);
1019 * Blocks until ChannelManager needs to be persisted. Only one listener on
1020 * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
1023 public await_persistable_update(): void {
1024 bindings.ChannelManager_await_persistable_update(this.ptr);
1028 * Gets the latest best block which was connected either via the [`chain::Listen`] or
1029 * [`chain::Confirm`] interfaces.
1031 public current_best_block(): BestBlock {
1032 const ret: number = bindings.ChannelManager_current_best_block(this.ptr);
1033 const ret_hu_conv: BestBlock = new BestBlock(null, ret);
1034 CommonBase.add_ref_from(ret_hu_conv, this);
1039 * Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
1040 * This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
1042 public as_ChannelMessageHandler(): ChannelMessageHandler {
1043 const ret: number = bindings.ChannelManager_as_ChannelMessageHandler(this.ptr);
1044 const ret_hu_conv: ChannelMessageHandler = new ChannelMessageHandler(null, ret);
1045 CommonBase.add_ref_from(ret_hu_conv, this);
1050 * Serialize the ChannelManager object into a byte array which can be read by ChannelManager_read
1052 public write(): Uint8Array {
1053 const ret: number = bindings.ChannelManager_write(this.ptr);
1054 const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
1059 * Constructs a new Payer which calls the relevant methods on this_arg.
1060 * This copies the `inner` pointer in this_arg and thus the returned Payer must be freed before this_arg is
1062 public as_Payer(): Payer {
1063 const ret: number = bindings.ChannelManager_as_Payer(this.ptr);
1064 const ret_hu_conv: Payer = new Payer(null, ret);
1065 CommonBase.add_ref_from(ret_hu_conv, this);