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 { Option_EventZ } from '../structs/Option_EventZ.mjs';
81 import { Result_COption_EventZDecodeErrorZ } from '../structs/Result_COption_EventZDecodeErrorZ.mjs';
82 import { AcceptChannel } from '../structs/AcceptChannel.mjs';
83 import { OpenChannel } from '../structs/OpenChannel.mjs';
84 import { FundingCreated } from '../structs/FundingCreated.mjs';
85 import { FundingSigned } from '../structs/FundingSigned.mjs';
86 import { FundingLocked } from '../structs/FundingLocked.mjs';
87 import { AnnouncementSignatures } from '../structs/AnnouncementSignatures.mjs';
88 import { CommitmentUpdate } from '../structs/CommitmentUpdate.mjs';
89 import { RevokeAndACK } from '../structs/RevokeAndACK.mjs';
90 import { ClosingSigned } from '../structs/ClosingSigned.mjs';
91 import { Shutdown } from '../structs/Shutdown.mjs';
92 import { ChannelReestablish } from '../structs/ChannelReestablish.mjs';
93 import { ChannelAnnouncement } from '../structs/ChannelAnnouncement.mjs';
94 import { NodeAnnouncement } from '../structs/NodeAnnouncement.mjs';
95 import { ErrorMessage } from '../structs/ErrorMessage.mjs';
96 import { WarningMessage } from '../structs/WarningMessage.mjs';
97 import { ErrorAction } from '../structs/ErrorAction.mjs';
98 import { QueryChannelRange } from '../structs/QueryChannelRange.mjs';
99 import { QueryShortChannelIds } from '../structs/QueryShortChannelIds.mjs';
100 import { ReplyChannelRange } from '../structs/ReplyChannelRange.mjs';
101 import { MessageSendEvent } from '../structs/MessageSendEvent.mjs';
102 import { FixedPenaltyScorer } from '../structs/FixedPenaltyScorer.mjs';
103 import { Result_FixedPenaltyScorerDecodeErrorZ } from '../structs/Result_FixedPenaltyScorerDecodeErrorZ.mjs';
104 import { ScoringParameters } from '../structs/ScoringParameters.mjs';
105 import { Result_ScoringParametersDecodeErrorZ } from '../structs/Result_ScoringParametersDecodeErrorZ.mjs';
106 import { Scorer } from '../structs/Scorer.mjs';
107 import { Result_ScorerDecodeErrorZ } from '../structs/Result_ScorerDecodeErrorZ.mjs';
108 import { ProbabilisticScoringParameters } from '../structs/ProbabilisticScoringParameters.mjs';
109 import { Result_ProbabilisticScoringParametersDecodeErrorZ } from '../structs/Result_ProbabilisticScoringParametersDecodeErrorZ.mjs';
110 import { NetworkGraph } from '../structs/NetworkGraph.mjs';
111 import { TwoTuple_ProbabilisticScoringParametersNetworkGraphZ } from '../structs/TwoTuple_ProbabilisticScoringParametersNetworkGraphZ.mjs';
112 import { ProbabilisticScorer } from '../structs/ProbabilisticScorer.mjs';
113 import { Result_ProbabilisticScorerDecodeErrorZ } from '../structs/Result_ProbabilisticScorerDecodeErrorZ.mjs';
114 import { InitFeatures } from '../structs/InitFeatures.mjs';
115 import { Result_InitFeaturesDecodeErrorZ } from '../structs/Result_InitFeaturesDecodeErrorZ.mjs';
116 import { ChannelFeatures } from '../structs/ChannelFeatures.mjs';
117 import { Result_ChannelFeaturesDecodeErrorZ } from '../structs/Result_ChannelFeaturesDecodeErrorZ.mjs';
118 import { NodeFeatures } from '../structs/NodeFeatures.mjs';
119 import { Result_NodeFeaturesDecodeErrorZ } from '../structs/Result_NodeFeaturesDecodeErrorZ.mjs';
120 import { InvoiceFeatures } from '../structs/InvoiceFeatures.mjs';
121 import { Result_InvoiceFeaturesDecodeErrorZ } from '../structs/Result_InvoiceFeaturesDecodeErrorZ.mjs';
122 import { ChannelTypeFeatures } from '../structs/ChannelTypeFeatures.mjs';
123 import { Result_ChannelTypeFeaturesDecodeErrorZ } from '../structs/Result_ChannelTypeFeaturesDecodeErrorZ.mjs';
124 import { Result_DelayedPaymentOutputDescriptorDecodeErrorZ } from '../structs/Result_DelayedPaymentOutputDescriptorDecodeErrorZ.mjs';
125 import { Result_StaticPaymentOutputDescriptorDecodeErrorZ } from '../structs/Result_StaticPaymentOutputDescriptorDecodeErrorZ.mjs';
126 import { Result_SpendableOutputDescriptorDecodeErrorZ } from '../structs/Result_SpendableOutputDescriptorDecodeErrorZ.mjs';
127 import { TwoTuple_SignatureCVec_SignatureZZ } from '../structs/TwoTuple_SignatureCVec_SignatureZZ.mjs';
128 import { Result_C2Tuple_SignatureCVec_SignatureZZNoneZ } from '../structs/Result_C2Tuple_SignatureCVec_SignatureZZNoneZ.mjs';
129 import { Result_SignatureNoneZ } from '../structs/Result_SignatureNoneZ.mjs';
130 import { TwoTuple_SignatureSignatureZ } from '../structs/TwoTuple_SignatureSignatureZ.mjs';
131 import { Result_C2Tuple_SignatureSignatureZNoneZ } from '../structs/Result_C2Tuple_SignatureSignatureZNoneZ.mjs';
132 import { Result_SecretKeyNoneZ } from '../structs/Result_SecretKeyNoneZ.mjs';
133 import { ClosingTransaction } from '../structs/ClosingTransaction.mjs';
134 import { UnsignedChannelAnnouncement } from '../structs/UnsignedChannelAnnouncement.mjs';
135 import { BaseSign, BaseSignInterface } from '../structs/BaseSign.mjs';
136 import { Sign, SignInterface } from '../structs/Sign.mjs';
137 import { Result_SignDecodeErrorZ } from '../structs/Result_SignDecodeErrorZ.mjs';
138 import { Result_RecoverableSignatureNoneZ } from '../structs/Result_RecoverableSignatureNoneZ.mjs';
139 import { Result_CVec_CVec_u8ZZNoneZ } from '../structs/Result_CVec_CVec_u8ZZNoneZ.mjs';
140 import { InMemorySigner } from '../structs/InMemorySigner.mjs';
141 import { Result_InMemorySignerDecodeErrorZ } from '../structs/Result_InMemorySignerDecodeErrorZ.mjs';
142 import { Result_TransactionNoneZ } from '../structs/Result_TransactionNoneZ.mjs';
143 import { Option_u16Z } from '../structs/Option_u16Z.mjs';
144 import { APIError } from '../structs/APIError.mjs';
145 import { Result_NoneAPIErrorZ } from '../structs/Result_NoneAPIErrorZ.mjs';
146 import { Result__u832APIErrorZ } from '../structs/Result__u832APIErrorZ.mjs';
147 import { PaymentSendFailure } from '../structs/PaymentSendFailure.mjs';
148 import { Result_PaymentIdPaymentSendFailureZ } from '../structs/Result_PaymentIdPaymentSendFailureZ.mjs';
149 import { Result_NonePaymentSendFailureZ } from '../structs/Result_NonePaymentSendFailureZ.mjs';
150 import { TwoTuple_PaymentHashPaymentIdZ } from '../structs/TwoTuple_PaymentHashPaymentIdZ.mjs';
151 import { Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ } from '../structs/Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ.mjs';
152 import { NetAddress } from '../structs/NetAddress.mjs';
153 import { TwoTuple_PaymentHashPaymentSecretZ } from '../structs/TwoTuple_PaymentHashPaymentSecretZ.mjs';
154 import { Result_C2Tuple_PaymentHashPaymentSecretZNoneZ } from '../structs/Result_C2Tuple_PaymentHashPaymentSecretZNoneZ.mjs';
155 import { Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ } from '../structs/Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ.mjs';
156 import { Result_PaymentSecretNoneZ } from '../structs/Result_PaymentSecretNoneZ.mjs';
157 import { Result_PaymentSecretAPIErrorZ } from '../structs/Result_PaymentSecretAPIErrorZ.mjs';
158 import { Result_PaymentPreimageAPIErrorZ } from '../structs/Result_PaymentPreimageAPIErrorZ.mjs';
159 import { CounterpartyForwardingInfo } from '../structs/CounterpartyForwardingInfo.mjs';
160 import { Result_CounterpartyForwardingInfoDecodeErrorZ } from '../structs/Result_CounterpartyForwardingInfoDecodeErrorZ.mjs';
161 import { ChannelCounterparty } from '../structs/ChannelCounterparty.mjs';
162 import { Result_ChannelCounterpartyDecodeErrorZ } from '../structs/Result_ChannelCounterpartyDecodeErrorZ.mjs';
163 import { Result_ChannelDetailsDecodeErrorZ } from '../structs/Result_ChannelDetailsDecodeErrorZ.mjs';
164 import { PhantomRouteHints } from '../structs/PhantomRouteHints.mjs';
165 import { Result_PhantomRouteHintsDecodeErrorZ } from '../structs/Result_PhantomRouteHintsDecodeErrorZ.mjs';
166 import { ChannelMonitor } from '../structs/ChannelMonitor.mjs';
167 import { ChannelMonitorUpdate } from '../structs/ChannelMonitorUpdate.mjs';
168 import { Watch, WatchInterface } from '../structs/Watch.mjs';
169 import { BroadcasterInterface, BroadcasterInterfaceInterface } from '../structs/BroadcasterInterface.mjs';
170 import { KeysInterface, KeysInterfaceInterface } from '../structs/KeysInterface.mjs';
171 import { FeeEstimator, FeeEstimatorInterface } from '../structs/FeeEstimator.mjs';
172 import { Record } from '../structs/Record.mjs';
173 import { Logger, LoggerInterface } from '../structs/Logger.mjs';
174 import { ChannelManager } from '../structs/ChannelManager.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'
345 * An Event which you should probably take some action in response to.
347 * Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
348 * them directly as they don't round-trip exactly (for example FundingGenerationReady is never
349 * written as it makes no sense to respond to it after reconnecting to peers).
351 export class Event extends CommonBase {
352 protected constructor(_dummy: object, ptr: number) { super(ptr, bindings.Event_free); }
354 public static constr_from_ptr(ptr: number): Event {
355 const raw_ty: number = bindings.LDKEvent_ty_from_ptr(ptr);
357 case 0: return new Event_FundingGenerationReady(ptr);
358 case 1: return new Event_PaymentReceived(ptr);
359 case 2: return new Event_PaymentSent(ptr);
360 case 3: return new Event_PaymentPathFailed(ptr);
361 case 4: return new Event_PaymentFailed(ptr);
362 case 5: return new Event_PendingHTLCsForwardable(ptr);
363 case 6: return new Event_SpendableOutputs(ptr);
364 case 7: return new Event_PaymentForwarded(ptr);
365 case 8: return new Event_ChannelClosed(ptr);
366 case 9: return new Event_DiscardFunding(ptr);
367 case 10: return new Event_PaymentPathSuccessful(ptr);
368 case 11: return new Event_OpenChannelRequest(ptr);
370 throw new Error('oops, this should be unreachable'); // Unreachable without extending the (internal) bindings interface
374 public clone_ptr(): number {
375 const ret: number = bindings.Event_clone_ptr(this.ptr);
380 * Creates a copy of the Event
382 public clone(): Event {
383 const ret: number = bindings.Event_clone(this.ptr);
384 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
385 CommonBase.add_ref_from(ret_hu_conv, this);
390 * Utility method to constructs a new FundingGenerationReady-variant Event
392 public static constructor_funding_generation_ready(temporary_channel_id: Uint8Array, channel_value_satoshis: bigint, output_script: Uint8Array, user_channel_id: bigint): Event {
393 const ret: number = bindings.Event_funding_generation_ready(bindings.encodeUint8Array(bindings.check_arr_len(temporary_channel_id, 32)), channel_value_satoshis, bindings.encodeUint8Array(output_script), user_channel_id);
394 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
395 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
400 * Utility method to constructs a new PaymentReceived-variant Event
402 public static constructor_payment_received(payment_hash: Uint8Array, amt: bigint, purpose: PaymentPurpose): Event {
403 const ret: number = bindings.Event_payment_received(bindings.encodeUint8Array(bindings.check_arr_len(payment_hash, 32)), amt, CommonBase.get_ptr_of(purpose));
404 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
405 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
410 * Utility method to constructs a new PaymentSent-variant Event
412 public static constructor_payment_sent(payment_id: Uint8Array, payment_preimage: Uint8Array, payment_hash: Uint8Array, fee_paid_msat: Option_u64Z): Event {
413 const ret: number = bindings.Event_payment_sent(bindings.encodeUint8Array(bindings.check_arr_len(payment_id, 32)), bindings.encodeUint8Array(bindings.check_arr_len(payment_preimage, 32)), bindings.encodeUint8Array(bindings.check_arr_len(payment_hash, 32)), CommonBase.get_ptr_of(fee_paid_msat));
414 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
415 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
420 * Utility method to constructs a new PaymentPathFailed-variant Event
422 public static constructor_payment_path_failed(payment_id: Uint8Array, payment_hash: Uint8Array, rejected_by_dest: boolean, network_update: Option_NetworkUpdateZ, all_paths_failed: boolean, path: RouteHop[], short_channel_id: Option_u64Z, retry: RouteParameters): Event {
423 const ret: number = bindings.Event_payment_path_failed(bindings.encodeUint8Array(bindings.check_arr_len(payment_id, 32)), bindings.encodeUint8Array(bindings.check_arr_len(payment_hash, 32)), rejected_by_dest, CommonBase.get_ptr_of(network_update), all_paths_failed, bindings.encodeUint32Array(path != null ? path.map(path_conv_10 => path_conv_10 == null ? 0 : CommonBase.get_ptr_of(path_conv_10) & ~1) : null), CommonBase.get_ptr_of(short_channel_id), retry == null ? 0 : CommonBase.get_ptr_of(retry) & ~1);
424 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
425 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
430 * Utility method to constructs a new PaymentFailed-variant Event
432 public static constructor_payment_failed(payment_id: Uint8Array, payment_hash: Uint8Array): Event {
433 const ret: number = bindings.Event_payment_failed(bindings.encodeUint8Array(bindings.check_arr_len(payment_id, 32)), bindings.encodeUint8Array(bindings.check_arr_len(payment_hash, 32)));
434 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
435 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
440 * Utility method to constructs a new PendingHTLCsForwardable-variant Event
442 public static constructor_pending_htlcs_forwardable(time_forwardable: bigint): Event {
443 const ret: number = bindings.Event_pending_htlcs_forwardable(time_forwardable);
444 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
445 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
450 * Utility method to constructs a new SpendableOutputs-variant Event
452 public static constructor_spendable_outputs(outputs: SpendableOutputDescriptor[]): Event {
453 const ret: number = bindings.Event_spendable_outputs(bindings.encodeUint32Array(outputs != null ? outputs.map(outputs_conv_27 => CommonBase.get_ptr_of(outputs_conv_27)) : null));
454 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
455 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
460 * Utility method to constructs a new PaymentForwarded-variant Event
462 public static constructor_payment_forwarded(fee_earned_msat: Option_u64Z, claim_from_onchain_tx: boolean): Event {
463 const ret: number = bindings.Event_payment_forwarded(CommonBase.get_ptr_of(fee_earned_msat), claim_from_onchain_tx);
464 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
465 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
470 * Utility method to constructs a new ChannelClosed-variant Event
472 public static constructor_channel_closed(channel_id: Uint8Array, user_channel_id: bigint, reason: ClosureReason): Event {
473 const ret: number = bindings.Event_channel_closed(bindings.encodeUint8Array(bindings.check_arr_len(channel_id, 32)), user_channel_id, CommonBase.get_ptr_of(reason));
474 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
475 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
480 * Utility method to constructs a new DiscardFunding-variant Event
482 public static constructor_discard_funding(channel_id: Uint8Array, transaction: Uint8Array): Event {
483 const ret: number = bindings.Event_discard_funding(bindings.encodeUint8Array(bindings.check_arr_len(channel_id, 32)), bindings.encodeUint8Array(transaction));
484 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
485 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
490 * Utility method to constructs a new PaymentPathSuccessful-variant Event
492 public static constructor_payment_path_successful(payment_id: Uint8Array, payment_hash: Uint8Array, path: RouteHop[]): Event {
493 const ret: number = bindings.Event_payment_path_successful(bindings.encodeUint8Array(bindings.check_arr_len(payment_id, 32)), bindings.encodeUint8Array(bindings.check_arr_len(payment_hash, 32)), bindings.encodeUint32Array(path != null ? path.map(path_conv_10 => path_conv_10 == null ? 0 : CommonBase.get_ptr_of(path_conv_10) & ~1) : null));
494 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
495 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
500 * Utility method to constructs a new OpenChannelRequest-variant Event
502 public static constructor_open_channel_request(temporary_channel_id: Uint8Array, counterparty_node_id: Uint8Array, funding_satoshis: bigint, push_msat: bigint): Event {
503 const ret: number = bindings.Event_open_channel_request(bindings.encodeUint8Array(bindings.check_arr_len(temporary_channel_id, 32)), bindings.encodeUint8Array(bindings.check_arr_len(counterparty_node_id, 33)), funding_satoshis, push_msat);
504 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
505 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
510 * Serialize the Event object into a byte array which can be read by Event_read
512 public write(): Uint8Array {
513 const ret: number = bindings.Event_write(this.ptr);
514 const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
519 /** A Event of type FundingGenerationReady */
520 export class Event_FundingGenerationReady extends Event {
522 * The random channel_id we picked which you'll need to pass into
523 * ChannelManager::funding_transaction_generated.
525 public temporary_channel_id: Uint8Array;
527 * The value, in satoshis, that the output should have.
529 public channel_value_satoshis: bigint;
531 * The script which should be used in the transaction output.
533 public output_script: Uint8Array;
535 * The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
536 * an inbound channel.
538 * [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
540 public user_channel_id: bigint;
542 public constructor(ptr: number) {
544 const temporary_channel_id: number = bindings.LDKEvent_FundingGenerationReady_get_temporary_channel_id(ptr);
545 const temporary_channel_id_conv: Uint8Array = bindings.decodeUint8Array(temporary_channel_id);
546 this.temporary_channel_id = temporary_channel_id_conv;
547 this.channel_value_satoshis = bindings.LDKEvent_FundingGenerationReady_get_channel_value_satoshis(ptr);
548 const output_script: number = bindings.LDKEvent_FundingGenerationReady_get_output_script(ptr);
549 const output_script_conv: Uint8Array = bindings.decodeUint8Array(output_script);
550 this.output_script = output_script_conv;
551 this.user_channel_id = bindings.LDKEvent_FundingGenerationReady_get_user_channel_id(ptr);
554 /** A Event of type PaymentReceived */
555 export class Event_PaymentReceived extends Event {
557 * The hash for which the preimage should be handed to the ChannelManager. Note that LDK will
558 * not stop you from registering duplicate payment hashes for inbound payments.
560 public payment_hash: Uint8Array;
562 * The value, in thousandths of a satoshi, that this payment is for.
566 * Information for claiming this received payment, based on whether the purpose of the
567 * payment is to pay an invoice or to send a spontaneous payment.
569 public purpose: PaymentPurpose;
571 public constructor(ptr: number) {
573 const payment_hash: number = bindings.LDKEvent_PaymentReceived_get_payment_hash(ptr);
574 const payment_hash_conv: Uint8Array = bindings.decodeUint8Array(payment_hash);
575 this.payment_hash = payment_hash_conv;
576 this.amt = bindings.LDKEvent_PaymentReceived_get_amt(ptr);
577 const purpose: number = bindings.LDKEvent_PaymentReceived_get_purpose(ptr);
578 const purpose_hu_conv: PaymentPurpose = PaymentPurpose.constr_from_ptr(purpose);
579 CommonBase.add_ref_from(purpose_hu_conv, this);
580 this.purpose = purpose_hu_conv;
583 /** A Event of type PaymentSent */
584 export class Event_PaymentSent extends Event {
586 * The id returned by [`ChannelManager::send_payment`] and used with
587 * [`ChannelManager::retry_payment`].
589 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
590 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
592 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
594 public payment_id: Uint8Array;
596 * The preimage to the hash given to ChannelManager::send_payment.
597 * Note that this serves as a payment receipt, if you wish to have such a thing, you must
600 public payment_preimage: Uint8Array;
602 * The hash that was given to [`ChannelManager::send_payment`].
604 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
606 public payment_hash: Uint8Array;
608 * The total fee which was spent at intermediate hops in this payment, across all paths.
610 * Note that, like [`Route::get_total_fees`] this does *not* include any potential
611 * overpayment to the recipient node.
613 * If the recipient or an intermediate node misbehaves and gives us free money, this may
614 * overstate the amount paid, though this is unlikely.
616 * [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
618 public fee_paid_msat: Option_u64Z;
620 public constructor(ptr: number) {
622 const payment_id: number = bindings.LDKEvent_PaymentSent_get_payment_id(ptr);
623 const payment_id_conv: Uint8Array = bindings.decodeUint8Array(payment_id);
624 this.payment_id = payment_id_conv;
625 const payment_preimage: number = bindings.LDKEvent_PaymentSent_get_payment_preimage(ptr);
626 const payment_preimage_conv: Uint8Array = bindings.decodeUint8Array(payment_preimage);
627 this.payment_preimage = payment_preimage_conv;
628 const payment_hash: number = bindings.LDKEvent_PaymentSent_get_payment_hash(ptr);
629 const payment_hash_conv: Uint8Array = bindings.decodeUint8Array(payment_hash);
630 this.payment_hash = payment_hash_conv;
631 const fee_paid_msat: number = bindings.LDKEvent_PaymentSent_get_fee_paid_msat(ptr);
632 const fee_paid_msat_hu_conv: Option_u64Z = Option_u64Z.constr_from_ptr(fee_paid_msat);
633 CommonBase.add_ref_from(fee_paid_msat_hu_conv, this);
634 this.fee_paid_msat = fee_paid_msat_hu_conv;
637 /** A Event of type PaymentPathFailed */
638 export class Event_PaymentPathFailed extends Event {
640 * The id returned by [`ChannelManager::send_payment`] and used with
641 * [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
643 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
644 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
645 * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
647 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
649 public payment_id: Uint8Array;
651 * The hash that was given to [`ChannelManager::send_payment`].
653 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
655 public payment_hash: Uint8Array;
657 * Indicates the payment was rejected for some reason by the recipient. This implies that
658 * the payment has failed, not just the route in question. If this is not set, you may
659 * retry the payment via a different route.
661 public rejected_by_dest: boolean;
663 * Any failure information conveyed via the Onion return packet by a node along the failed
666 * Should be applied to the [`NetworkGraph`] so that routing decisions can take into
667 * account the update. [`NetGraphMsgHandler`] is capable of doing this.
669 * [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph
670 * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
672 public network_update: Option_NetworkUpdateZ;
674 * For both single-path and multi-path payments, this is set if all paths of the payment have
675 * failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
676 * larger MPP payment were still in flight when this event was generated.
678 * Note that if you are retrying individual MPP parts, using this value to determine if a
679 * payment has fully failed is race-y. Because multiple failures can happen prior to events
680 * being processed, you may retry in response to a first failure, with a second failure
681 * (with `all_paths_failed` set) still pending. Then, when the second failure is processed
682 * you will see `all_paths_failed` set even though the retry of the first failure still
683 * has an associated in-flight HTLC. See (1) for an example of such a failure.
685 * If you wish to retry individual MPP parts and learn when a payment has failed, you must
686 * call [`ChannelManager::abandon_payment`] and wait for a [`Event::PaymentFailed`] event.
688 * (1) <https://github.com/lightningdevkit/rust-lightning/issues/1164>
690 * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
692 public all_paths_failed: boolean;
694 * The payment path that failed.
696 public path: RouteHop[];
698 * The channel responsible for the failed payment path.
700 * If this is `Some`, then the corresponding channel should be avoided when the payment is
701 * retried. May be `None` for older [`Event`] serializations.
703 public short_channel_id: Option_u64Z;
705 * Parameters needed to compute a new [`Route`] when retrying the failed payment path.
707 * See [`find_route`] for details.
709 * [`Route`]: crate::routing::router::Route
710 * [`find_route`]: crate::routing::router::find_route
712 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
714 public retry: RouteParameters;
716 public constructor(ptr: number) {
718 const payment_id: number = bindings.LDKEvent_PaymentPathFailed_get_payment_id(ptr);
719 const payment_id_conv: Uint8Array = bindings.decodeUint8Array(payment_id);
720 this.payment_id = payment_id_conv;
721 const payment_hash: number = bindings.LDKEvent_PaymentPathFailed_get_payment_hash(ptr);
722 const payment_hash_conv: Uint8Array = bindings.decodeUint8Array(payment_hash);
723 this.payment_hash = payment_hash_conv;
724 this.rejected_by_dest = bindings.LDKEvent_PaymentPathFailed_get_rejected_by_dest(ptr);
725 const network_update: number = bindings.LDKEvent_PaymentPathFailed_get_network_update(ptr);
726 const network_update_hu_conv: Option_NetworkUpdateZ = Option_NetworkUpdateZ.constr_from_ptr(network_update);
727 CommonBase.add_ref_from(network_update_hu_conv, this);
728 this.network_update = network_update_hu_conv;
729 this.all_paths_failed = bindings.LDKEvent_PaymentPathFailed_get_all_paths_failed(ptr);
730 const path: number = bindings.LDKEvent_PaymentPathFailed_get_path(ptr);
731 const path_conv_10_len: number = bindings.getArrayLength(path);
732 const path_conv_10_arr: RouteHop[] = new Array(path_conv_10_len).fill(null);
733 for (var k = 0; k < path_conv_10_len; k++) {
734 const path_conv_10: number = bindings.getU32ArrayElem(path, k);
735 const path_conv_10_hu_conv: RouteHop = new RouteHop(null, path_conv_10);
736 CommonBase.add_ref_from(path_conv_10_hu_conv, this);
737 path_conv_10_arr[k] = path_conv_10_hu_conv;
739 bindings.freeWasmMemory(path)
740 this.path = path_conv_10_arr;
741 const short_channel_id: number = bindings.LDKEvent_PaymentPathFailed_get_short_channel_id(ptr);
742 const short_channel_id_hu_conv: Option_u64Z = Option_u64Z.constr_from_ptr(short_channel_id);
743 CommonBase.add_ref_from(short_channel_id_hu_conv, this);
744 this.short_channel_id = short_channel_id_hu_conv;
745 const retry: number = bindings.LDKEvent_PaymentPathFailed_get_retry(ptr);
746 const retry_hu_conv: RouteParameters = new RouteParameters(null, retry);
747 CommonBase.add_ref_from(retry_hu_conv, this);
748 this.retry = retry_hu_conv;
751 /** A Event of type PaymentFailed */
752 export class Event_PaymentFailed extends Event {
754 * The id returned by [`ChannelManager::send_payment`] and used with
755 * [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
757 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
758 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
759 * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
761 public payment_id: Uint8Array;
763 * The hash that was given to [`ChannelManager::send_payment`].
765 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
767 public payment_hash: Uint8Array;
769 public constructor(ptr: number) {
771 const payment_id: number = bindings.LDKEvent_PaymentFailed_get_payment_id(ptr);
772 const payment_id_conv: Uint8Array = bindings.decodeUint8Array(payment_id);
773 this.payment_id = payment_id_conv;
774 const payment_hash: number = bindings.LDKEvent_PaymentFailed_get_payment_hash(ptr);
775 const payment_hash_conv: Uint8Array = bindings.decodeUint8Array(payment_hash);
776 this.payment_hash = payment_hash_conv;
779 /** A Event of type PendingHTLCsForwardable */
780 export class Event_PendingHTLCsForwardable extends Event {
782 * The minimum amount of time that should be waited prior to calling
783 * process_pending_htlc_forwards. To increase the effort required to correlate payments,
784 * you should wait a random amount of time in roughly the range (now + time_forwardable,
785 * now + 5*time_forwardable).
787 public time_forwardable: bigint;
789 public constructor(ptr: number) {
791 this.time_forwardable = bindings.LDKEvent_PendingHTLCsForwardable_get_time_forwardable(ptr);
794 /** A Event of type SpendableOutputs */
795 export class Event_SpendableOutputs extends Event {
797 * The outputs which you should store as spendable by you.
799 public outputs: SpendableOutputDescriptor[];
801 public constructor(ptr: number) {
803 const outputs: number = bindings.LDKEvent_SpendableOutputs_get_outputs(ptr);
804 const outputs_conv_27_len: number = bindings.getArrayLength(outputs);
805 const outputs_conv_27_arr: SpendableOutputDescriptor[] = new Array(outputs_conv_27_len).fill(null);
806 for (var b = 0; b < outputs_conv_27_len; b++) {
807 const outputs_conv_27: number = bindings.getU32ArrayElem(outputs, b);
808 const outputs_conv_27_hu_conv: SpendableOutputDescriptor = SpendableOutputDescriptor.constr_from_ptr(outputs_conv_27);
809 CommonBase.add_ref_from(outputs_conv_27_hu_conv, this);
810 outputs_conv_27_arr[b] = outputs_conv_27_hu_conv;
812 bindings.freeWasmMemory(outputs)
813 this.outputs = outputs_conv_27_arr;
816 /** A Event of type PaymentForwarded */
817 export class Event_PaymentForwarded extends Event {
819 * The fee, in milli-satoshis, which was earned as a result of the payment.
821 * Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
822 * was pending, the amount the next hop claimed will have been rounded down to the nearest
823 * whole satoshi. Thus, the fee calculated here may be higher than expected as we still
824 * claimed the full value in millisatoshis from the source. In this case,
825 * `claim_from_onchain_tx` will be set.
827 * If the channel which sent us the payment has been force-closed, we will claim the funds
828 * via an on-chain transaction. In that case we do not yet know the on-chain transaction
829 * fees which we will spend and will instead set this to `None`. It is possible duplicate
830 * `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
833 public fee_earned_msat: Option_u64Z;
835 * If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
838 public claim_from_onchain_tx: boolean;
840 public constructor(ptr: number) {
842 const fee_earned_msat: number = bindings.LDKEvent_PaymentForwarded_get_fee_earned_msat(ptr);
843 const fee_earned_msat_hu_conv: Option_u64Z = Option_u64Z.constr_from_ptr(fee_earned_msat);
844 CommonBase.add_ref_from(fee_earned_msat_hu_conv, this);
845 this.fee_earned_msat = fee_earned_msat_hu_conv;
846 this.claim_from_onchain_tx = bindings.LDKEvent_PaymentForwarded_get_claim_from_onchain_tx(ptr);
849 /** A Event of type ChannelClosed */
850 export class Event_ChannelClosed extends Event {
852 * The channel_id of the channel which has been closed. Note that on-chain transactions
853 * resolving the channel are likely still awaiting confirmation.
855 public channel_id: Uint8Array;
857 * The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
858 * an inbound channel. This will always be zero for objects serialized with LDK versions
861 * [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
863 public user_channel_id: bigint;
865 * The reason the channel was closed.
867 public reason: ClosureReason;
869 public constructor(ptr: number) {
871 const channel_id: number = bindings.LDKEvent_ChannelClosed_get_channel_id(ptr);
872 const channel_id_conv: Uint8Array = bindings.decodeUint8Array(channel_id);
873 this.channel_id = channel_id_conv;
874 this.user_channel_id = bindings.LDKEvent_ChannelClosed_get_user_channel_id(ptr);
875 const reason: number = bindings.LDKEvent_ChannelClosed_get_reason(ptr);
876 const reason_hu_conv: ClosureReason = ClosureReason.constr_from_ptr(reason);
877 CommonBase.add_ref_from(reason_hu_conv, this);
878 this.reason = reason_hu_conv;
881 /** A Event of type DiscardFunding */
882 export class Event_DiscardFunding extends Event {
884 * The channel_id of the channel which has been closed.
886 public channel_id: Uint8Array;
888 * The full transaction received from the user
890 public transaction: Uint8Array;
892 public constructor(ptr: number) {
894 const channel_id: number = bindings.LDKEvent_DiscardFunding_get_channel_id(ptr);
895 const channel_id_conv: Uint8Array = bindings.decodeUint8Array(channel_id);
896 this.channel_id = channel_id_conv;
897 const transaction: number = bindings.LDKEvent_DiscardFunding_get_transaction(ptr);
898 const transaction_conv: Uint8Array = bindings.decodeUint8Array(transaction);
899 this.transaction = transaction_conv;
902 /** A Event of type PaymentPathSuccessful */
903 export class Event_PaymentPathSuccessful extends Event {
905 * The id returned by [`ChannelManager::send_payment`] and used with
906 * [`ChannelManager::retry_payment`].
908 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
909 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
911 public payment_id: Uint8Array;
913 * The hash that was given to [`ChannelManager::send_payment`].
915 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
917 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
919 public payment_hash: Uint8Array;
921 * The payment path that was successful.
923 * May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
925 public path: RouteHop[];
927 public constructor(ptr: number) {
929 const payment_id: number = bindings.LDKEvent_PaymentPathSuccessful_get_payment_id(ptr);
930 const payment_id_conv: Uint8Array = bindings.decodeUint8Array(payment_id);
931 this.payment_id = payment_id_conv;
932 const payment_hash: number = bindings.LDKEvent_PaymentPathSuccessful_get_payment_hash(ptr);
933 const payment_hash_conv: Uint8Array = bindings.decodeUint8Array(payment_hash);
934 this.payment_hash = payment_hash_conv;
935 const path: number = bindings.LDKEvent_PaymentPathSuccessful_get_path(ptr);
936 const path_conv_10_len: number = bindings.getArrayLength(path);
937 const path_conv_10_arr: RouteHop[] = new Array(path_conv_10_len).fill(null);
938 for (var k = 0; k < path_conv_10_len; k++) {
939 const path_conv_10: number = bindings.getU32ArrayElem(path, k);
940 const path_conv_10_hu_conv: RouteHop = new RouteHop(null, path_conv_10);
941 CommonBase.add_ref_from(path_conv_10_hu_conv, this);
942 path_conv_10_arr[k] = path_conv_10_hu_conv;
944 bindings.freeWasmMemory(path)
945 this.path = path_conv_10_arr;
948 /** A Event of type OpenChannelRequest */
949 export class Event_OpenChannelRequest extends Event {
951 * The temporary channel ID of the channel requested to be opened.
953 * When responding to the request, the `temporary_channel_id` should be passed
954 * back to the ChannelManager with [`ChannelManager::accept_inbound_channel`] to accept,
955 * or to [`ChannelManager::force_close_channel`] to reject.
957 * [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
958 * [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
960 public temporary_channel_id: Uint8Array;
962 * The node_id of the counterparty requesting to open the channel.
964 public counterparty_node_id: Uint8Array;
966 * The channel value of the requested channel.
968 public funding_satoshis: bigint;
970 * Our starting balance in the channel if the request is accepted, in milli-satoshi.
972 public push_msat: bigint;
974 public constructor(ptr: number) {
976 const temporary_channel_id: number = bindings.LDKEvent_OpenChannelRequest_get_temporary_channel_id(ptr);
977 const temporary_channel_id_conv: Uint8Array = bindings.decodeUint8Array(temporary_channel_id);
978 this.temporary_channel_id = temporary_channel_id_conv;
979 const counterparty_node_id: number = bindings.LDKEvent_OpenChannelRequest_get_counterparty_node_id(ptr);
980 const counterparty_node_id_conv: Uint8Array = bindings.decodeUint8Array(counterparty_node_id);
981 this.counterparty_node_id = counterparty_node_id_conv;
982 this.funding_satoshis = bindings.LDKEvent_OpenChannelRequest_get_funding_satoshis(ptr);
983 this.push_msat = bindings.LDKEvent_OpenChannelRequest_get_push_msat(ptr);