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 { Bech32Error } from '../structs/Bech32Error.mjs';
15 import { Result_NoneNoneZ } from '../structs/Result_NoneNoneZ.mjs';
16 import { CounterpartyCommitmentSecrets } from '../structs/CounterpartyCommitmentSecrets.mjs';
17 import { DecodeError } from '../structs/DecodeError.mjs';
18 import { Result_CounterpartyCommitmentSecretsDecodeErrorZ } from '../structs/Result_CounterpartyCommitmentSecretsDecodeErrorZ.mjs';
19 import { Result_SecretKeyErrorZ } from '../structs/Result_SecretKeyErrorZ.mjs';
20 import { Result_PublicKeyErrorZ } from '../structs/Result_PublicKeyErrorZ.mjs';
21 import { TxCreationKeys } from '../structs/TxCreationKeys.mjs';
22 import { Result_TxCreationKeysDecodeErrorZ } from '../structs/Result_TxCreationKeysDecodeErrorZ.mjs';
23 import { ChannelPublicKeys } from '../structs/ChannelPublicKeys.mjs';
24 import { Result_ChannelPublicKeysDecodeErrorZ } from '../structs/Result_ChannelPublicKeysDecodeErrorZ.mjs';
25 import { Result_TxCreationKeysErrorZ } from '../structs/Result_TxCreationKeysErrorZ.mjs';
26 import { Option_u32Z } from '../structs/Option_u32Z.mjs';
27 import { HTLCOutputInCommitment } from '../structs/HTLCOutputInCommitment.mjs';
28 import { Result_HTLCOutputInCommitmentDecodeErrorZ } from '../structs/Result_HTLCOutputInCommitmentDecodeErrorZ.mjs';
29 import { CounterpartyChannelTransactionParameters } from '../structs/CounterpartyChannelTransactionParameters.mjs';
30 import { Result_CounterpartyChannelTransactionParametersDecodeErrorZ } from '../structs/Result_CounterpartyChannelTransactionParametersDecodeErrorZ.mjs';
31 import { ChannelTransactionParameters } from '../structs/ChannelTransactionParameters.mjs';
32 import { Result_ChannelTransactionParametersDecodeErrorZ } from '../structs/Result_ChannelTransactionParametersDecodeErrorZ.mjs';
33 import { HolderCommitmentTransaction } from '../structs/HolderCommitmentTransaction.mjs';
34 import { Result_HolderCommitmentTransactionDecodeErrorZ } from '../structs/Result_HolderCommitmentTransactionDecodeErrorZ.mjs';
35 import { BuiltCommitmentTransaction } from '../structs/BuiltCommitmentTransaction.mjs';
36 import { Result_BuiltCommitmentTransactionDecodeErrorZ } from '../structs/Result_BuiltCommitmentTransactionDecodeErrorZ.mjs';
37 import { TrustedClosingTransaction } from '../structs/TrustedClosingTransaction.mjs';
38 import { Result_TrustedClosingTransactionNoneZ } from '../structs/Result_TrustedClosingTransactionNoneZ.mjs';
39 import { CommitmentTransaction } from '../structs/CommitmentTransaction.mjs';
40 import { Result_CommitmentTransactionDecodeErrorZ } from '../structs/Result_CommitmentTransactionDecodeErrorZ.mjs';
41 import { TrustedCommitmentTransaction } from '../structs/TrustedCommitmentTransaction.mjs';
42 import { Result_TrustedCommitmentTransactionNoneZ } from '../structs/Result_TrustedCommitmentTransactionNoneZ.mjs';
43 import { Result_CVec_SignatureZNoneZ } from '../structs/Result_CVec_SignatureZNoneZ.mjs';
44 import { ShutdownScript } from '../structs/ShutdownScript.mjs';
45 import { Result_ShutdownScriptDecodeErrorZ } from '../structs/Result_ShutdownScriptDecodeErrorZ.mjs';
46 import { InvalidShutdownScript } from '../structs/InvalidShutdownScript.mjs';
47 import { Result_ShutdownScriptInvalidShutdownScriptZ } from '../structs/Result_ShutdownScriptInvalidShutdownScriptZ.mjs';
48 import { RouteHop } from '../structs/RouteHop.mjs';
49 import { Result_RouteHopDecodeErrorZ } from '../structs/Result_RouteHopDecodeErrorZ.mjs';
50 import { Route } from '../structs/Route.mjs';
51 import { Result_RouteDecodeErrorZ } from '../structs/Result_RouteDecodeErrorZ.mjs';
52 import { RouteParameters } from '../structs/RouteParameters.mjs';
53 import { Result_RouteParametersDecodeErrorZ } from '../structs/Result_RouteParametersDecodeErrorZ.mjs';
54 import { RouteHint } from '../structs/RouteHint.mjs';
55 import { Option_u64Z } from '../structs/Option_u64Z.mjs';
56 import { PaymentParameters } from '../structs/PaymentParameters.mjs';
57 import { Result_PaymentParametersDecodeErrorZ } from '../structs/Result_PaymentParametersDecodeErrorZ.mjs';
58 import { RouteHintHop } from '../structs/RouteHintHop.mjs';
59 import { Result_RouteHintDecodeErrorZ } from '../structs/Result_RouteHintDecodeErrorZ.mjs';
60 import { Result_RouteHintHopDecodeErrorZ } from '../structs/Result_RouteHintHopDecodeErrorZ.mjs';
61 import { ChannelDetails } from '../structs/ChannelDetails.mjs';
62 import { LightningError } from '../structs/LightningError.mjs';
63 import { Result_RouteLightningErrorZ } from '../structs/Result_RouteLightningErrorZ.mjs';
64 import { Result_TxOutAccessErrorZ } from '../structs/Result_TxOutAccessErrorZ.mjs';
65 import { TwoTuple_usizeTransactionZ } from '../structs/TwoTuple_usizeTransactionZ.mjs';
66 import { Result_NoneChannelMonitorUpdateErrZ } from '../structs/Result_NoneChannelMonitorUpdateErrZ.mjs';
67 import { HTLCUpdate } from '../structs/HTLCUpdate.mjs';
68 import { OutPoint } from '../structs/OutPoint.mjs';
69 import { MonitorEvent } from '../structs/MonitorEvent.mjs';
70 import { Option_C2Tuple_usizeTransactionZZ } from '../structs/Option_C2Tuple_usizeTransactionZZ.mjs';
71 import { ClosureReason } from '../structs/ClosureReason.mjs';
72 import { Option_ClosureReasonZ } from '../structs/Option_ClosureReasonZ.mjs';
73 import { Result_COption_ClosureReasonZDecodeErrorZ } from '../structs/Result_COption_ClosureReasonZDecodeErrorZ.mjs';
74 import { ChannelUpdate } from '../structs/ChannelUpdate.mjs';
75 import { NetworkUpdate } from '../structs/NetworkUpdate.mjs';
76 import { Option_NetworkUpdateZ } from '../structs/Option_NetworkUpdateZ.mjs';
77 import { DelayedPaymentOutputDescriptor } from '../structs/DelayedPaymentOutputDescriptor.mjs';
78 import { StaticPaymentOutputDescriptor } from '../structs/StaticPaymentOutputDescriptor.mjs';
79 import { SpendableOutputDescriptor } from '../structs/SpendableOutputDescriptor.mjs';
80 import { PaymentPurpose } from '../structs/PaymentPurpose.mjs';
81 import { ChannelTypeFeatures } from '../structs/ChannelTypeFeatures.mjs';
82 import { Option_EventZ } from '../structs/Option_EventZ.mjs';
83 import { Result_COption_EventZDecodeErrorZ } from '../structs/Result_COption_EventZDecodeErrorZ.mjs';
84 import { AcceptChannel } from '../structs/AcceptChannel.mjs';
85 import { OpenChannel } from '../structs/OpenChannel.mjs';
86 import { FundingCreated } from '../structs/FundingCreated.mjs';
87 import { FundingSigned } from '../structs/FundingSigned.mjs';
88 import { FundingLocked } from '../structs/FundingLocked.mjs';
89 import { AnnouncementSignatures } from '../structs/AnnouncementSignatures.mjs';
90 import { CommitmentUpdate } from '../structs/CommitmentUpdate.mjs';
91 import { RevokeAndACK } from '../structs/RevokeAndACK.mjs';
92 import { ClosingSigned } from '../structs/ClosingSigned.mjs';
93 import { Shutdown } from '../structs/Shutdown.mjs';
94 import { ChannelReestablish } from '../structs/ChannelReestablish.mjs';
95 import { ChannelAnnouncement } from '../structs/ChannelAnnouncement.mjs';
96 import { NodeAnnouncement } from '../structs/NodeAnnouncement.mjs';
97 import { ErrorMessage } from '../structs/ErrorMessage.mjs';
98 import { WarningMessage } from '../structs/WarningMessage.mjs';
99 import { ErrorAction } from '../structs/ErrorAction.mjs';
100 import { QueryChannelRange } from '../structs/QueryChannelRange.mjs';
101 import { QueryShortChannelIds } from '../structs/QueryShortChannelIds.mjs';
102 import { ReplyChannelRange } from '../structs/ReplyChannelRange.mjs';
103 import { GossipTimestampFilter } from '../structs/GossipTimestampFilter.mjs';
104 import { MessageSendEvent } from '../structs/MessageSendEvent.mjs';
105 import { FixedPenaltyScorer } from '../structs/FixedPenaltyScorer.mjs';
106 import { Result_FixedPenaltyScorerDecodeErrorZ } from '../structs/Result_FixedPenaltyScorerDecodeErrorZ.mjs';
107 import { ScoringParameters } from '../structs/ScoringParameters.mjs';
108 import { Result_ScoringParametersDecodeErrorZ } from '../structs/Result_ScoringParametersDecodeErrorZ.mjs';
109 import { Scorer } from '../structs/Scorer.mjs';
110 import { Result_ScorerDecodeErrorZ } from '../structs/Result_ScorerDecodeErrorZ.mjs';
111 import { NetworkGraph } from '../structs/NetworkGraph.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 { Result_ChannelTypeFeaturesDecodeErrorZ } from '../structs/Result_ChannelTypeFeaturesDecodeErrorZ.mjs';
123 import { Result_DelayedPaymentOutputDescriptorDecodeErrorZ } from '../structs/Result_DelayedPaymentOutputDescriptorDecodeErrorZ.mjs';
124 import { Result_StaticPaymentOutputDescriptorDecodeErrorZ } from '../structs/Result_StaticPaymentOutputDescriptorDecodeErrorZ.mjs';
125 import { Result_SpendableOutputDescriptorDecodeErrorZ } from '../structs/Result_SpendableOutputDescriptorDecodeErrorZ.mjs';
126 import { TwoTuple_SignatureCVec_SignatureZZ } from '../structs/TwoTuple_SignatureCVec_SignatureZZ.mjs';
127 import { Result_C2Tuple_SignatureCVec_SignatureZZNoneZ } from '../structs/Result_C2Tuple_SignatureCVec_SignatureZZNoneZ.mjs';
128 import { Result_SignatureNoneZ } from '../structs/Result_SignatureNoneZ.mjs';
129 import { TwoTuple_SignatureSignatureZ } from '../structs/TwoTuple_SignatureSignatureZ.mjs';
130 import { Result_C2Tuple_SignatureSignatureZNoneZ } from '../structs/Result_C2Tuple_SignatureSignatureZNoneZ.mjs';
131 import { Result_SecretKeyNoneZ } from '../structs/Result_SecretKeyNoneZ.mjs';
132 import { ClosingTransaction } from '../structs/ClosingTransaction.mjs';
133 import { UnsignedChannelAnnouncement } from '../structs/UnsignedChannelAnnouncement.mjs';
134 import { BaseSign, BaseSignInterface } from '../structs/BaseSign.mjs';
135 import { Sign, SignInterface } from '../structs/Sign.mjs';
136 import { Result_SignDecodeErrorZ } from '../structs/Result_SignDecodeErrorZ.mjs';
137 import { Result_RecoverableSignatureNoneZ } from '../structs/Result_RecoverableSignatureNoneZ.mjs';
138 import { Result_CVec_CVec_u8ZZNoneZ } from '../structs/Result_CVec_CVec_u8ZZNoneZ.mjs';
139 import { InMemorySigner } from '../structs/InMemorySigner.mjs';
140 import { Result_InMemorySignerDecodeErrorZ } from '../structs/Result_InMemorySignerDecodeErrorZ.mjs';
141 import { Result_TransactionNoneZ } from '../structs/Result_TransactionNoneZ.mjs';
142 import { Option_u16Z } from '../structs/Option_u16Z.mjs';
143 import { APIError } from '../structs/APIError.mjs';
144 import { Result_NoneAPIErrorZ } from '../structs/Result_NoneAPIErrorZ.mjs';
145 import { Result__u832APIErrorZ } from '../structs/Result__u832APIErrorZ.mjs';
146 import { PaymentSendFailure } from '../structs/PaymentSendFailure.mjs';
147 import { Result_PaymentIdPaymentSendFailureZ } from '../structs/Result_PaymentIdPaymentSendFailureZ.mjs';
148 import { Result_NonePaymentSendFailureZ } from '../structs/Result_NonePaymentSendFailureZ.mjs';
149 import { TwoTuple_PaymentHashPaymentIdZ } from '../structs/TwoTuple_PaymentHashPaymentIdZ.mjs';
150 import { Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ } from '../structs/Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ.mjs';
151 import { NetAddress } from '../structs/NetAddress.mjs';
152 import { TwoTuple_PaymentHashPaymentSecretZ } from '../structs/TwoTuple_PaymentHashPaymentSecretZ.mjs';
153 import { Result_C2Tuple_PaymentHashPaymentSecretZNoneZ } from '../structs/Result_C2Tuple_PaymentHashPaymentSecretZNoneZ.mjs';
154 import { Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ } from '../structs/Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ.mjs';
155 import { Result_PaymentSecretNoneZ } from '../structs/Result_PaymentSecretNoneZ.mjs';
156 import { Result_PaymentSecretAPIErrorZ } from '../structs/Result_PaymentSecretAPIErrorZ.mjs';
157 import { Result_PaymentPreimageAPIErrorZ } from '../structs/Result_PaymentPreimageAPIErrorZ.mjs';
158 import { CounterpartyForwardingInfo } from '../structs/CounterpartyForwardingInfo.mjs';
159 import { Result_CounterpartyForwardingInfoDecodeErrorZ } from '../structs/Result_CounterpartyForwardingInfoDecodeErrorZ.mjs';
160 import { ChannelCounterparty } from '../structs/ChannelCounterparty.mjs';
161 import { Result_ChannelCounterpartyDecodeErrorZ } from '../structs/Result_ChannelCounterpartyDecodeErrorZ.mjs';
162 import { Result_ChannelDetailsDecodeErrorZ } from '../structs/Result_ChannelDetailsDecodeErrorZ.mjs';
163 import { PhantomRouteHints } from '../structs/PhantomRouteHints.mjs';
164 import { Result_PhantomRouteHintsDecodeErrorZ } from '../structs/Result_PhantomRouteHintsDecodeErrorZ.mjs';
165 import { ChannelMonitor } from '../structs/ChannelMonitor.mjs';
166 import { ChannelMonitorUpdate } from '../structs/ChannelMonitorUpdate.mjs';
167 import { Watch, WatchInterface } from '../structs/Watch.mjs';
168 import { BroadcasterInterface, BroadcasterInterfaceInterface } from '../structs/BroadcasterInterface.mjs';
169 import { KeysInterface, KeysInterfaceInterface } from '../structs/KeysInterface.mjs';
170 import { FeeEstimator, FeeEstimatorInterface } from '../structs/FeeEstimator.mjs';
171 import { Record } from '../structs/Record.mjs';
172 import { Logger, LoggerInterface } from '../structs/Logger.mjs';
173 import { ChannelManager } from '../structs/ChannelManager.mjs';
174 import { TwoTuple_BlockHashChannelManagerZ } from '../structs/TwoTuple_BlockHashChannelManagerZ.mjs';
175 import { Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ } from '../structs/Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.mjs';
176 import { ChannelConfig } from '../structs/ChannelConfig.mjs';
177 import { Result_ChannelConfigDecodeErrorZ } from '../structs/Result_ChannelConfigDecodeErrorZ.mjs';
178 import { Result_OutPointDecodeErrorZ } from '../structs/Result_OutPointDecodeErrorZ.mjs';
179 import { Type, TypeInterface } from '../structs/Type.mjs';
180 import { Option_TypeZ } from '../structs/Option_TypeZ.mjs';
181 import { Result_COption_TypeZDecodeErrorZ } from '../structs/Result_COption_TypeZDecodeErrorZ.mjs';
182 import { PaymentError } from '../structs/PaymentError.mjs';
183 import { Result_PaymentIdPaymentErrorZ } from '../structs/Result_PaymentIdPaymentErrorZ.mjs';
184 import { ParseError } from '../structs/ParseError.mjs';
185 import { Result_SiPrefixParseErrorZ } from '../structs/Result_SiPrefixParseErrorZ.mjs';
186 import { Invoice } from '../structs/Invoice.mjs';
187 import { ParseOrSemanticError } from '../structs/ParseOrSemanticError.mjs';
188 import { Result_InvoiceParseOrSemanticErrorZ } from '../structs/Result_InvoiceParseOrSemanticErrorZ.mjs';
189 import { SignedRawInvoice } from '../structs/SignedRawInvoice.mjs';
190 import { Result_SignedRawInvoiceParseErrorZ } from '../structs/Result_SignedRawInvoiceParseErrorZ.mjs';
191 import { RawInvoice } from '../structs/RawInvoice.mjs';
192 import { InvoiceSignature } from '../structs/InvoiceSignature.mjs';
193 import { ThreeTuple_RawInvoice_u832InvoiceSignatureZ } from '../structs/ThreeTuple_RawInvoice_u832InvoiceSignatureZ.mjs';
194 import { PayeePubKey } from '../structs/PayeePubKey.mjs';
195 import { Result_PayeePubKeyErrorZ } from '../structs/Result_PayeePubKeyErrorZ.mjs';
196 import { PrivateRoute } from '../structs/PrivateRoute.mjs';
197 import { PositiveTimestamp } from '../structs/PositiveTimestamp.mjs';
198 import { Result_PositiveTimestampCreationErrorZ } from '../structs/Result_PositiveTimestampCreationErrorZ.mjs';
199 import { Result_NoneSemanticErrorZ } from '../structs/Result_NoneSemanticErrorZ.mjs';
200 import { Result_InvoiceSemanticErrorZ } from '../structs/Result_InvoiceSemanticErrorZ.mjs';
201 import { Description } from '../structs/Description.mjs';
202 import { Result_DescriptionCreationErrorZ } from '../structs/Result_DescriptionCreationErrorZ.mjs';
203 import { Result_PrivateRouteCreationErrorZ } from '../structs/Result_PrivateRouteCreationErrorZ.mjs';
204 import { Result_StringErrorZ } from '../structs/Result_StringErrorZ.mjs';
205 import { Result_ChannelMonitorUpdateDecodeErrorZ } from '../structs/Result_ChannelMonitorUpdateDecodeErrorZ.mjs';
206 import { Option_MonitorEventZ } from '../structs/Option_MonitorEventZ.mjs';
207 import { Result_COption_MonitorEventZDecodeErrorZ } from '../structs/Result_COption_MonitorEventZDecodeErrorZ.mjs';
208 import { Result_HTLCUpdateDecodeErrorZ } from '../structs/Result_HTLCUpdateDecodeErrorZ.mjs';
209 import { TwoTuple_OutPointScriptZ } from '../structs/TwoTuple_OutPointScriptZ.mjs';
210 import { TwoTuple_u32ScriptZ } from '../structs/TwoTuple_u32ScriptZ.mjs';
211 import { TwoTuple_TxidCVec_C2Tuple_u32ScriptZZZ } from '../structs/TwoTuple_TxidCVec_C2Tuple_u32ScriptZZZ.mjs';
212 import { TwoTuple_u32TxOutZ } from '../structs/TwoTuple_u32TxOutZ.mjs';
213 import { TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ } from '../structs/TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ.mjs';
214 import { Balance } from '../structs/Balance.mjs';
215 import { TwoTuple_BlockHashChannelMonitorZ } from '../structs/TwoTuple_BlockHashChannelMonitorZ.mjs';
216 import { Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ } from '../structs/Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.mjs';
217 import { Result_NoneLightningErrorZ } from '../structs/Result_NoneLightningErrorZ.mjs';
218 import { TwoTuple_PublicKeyTypeZ } from '../structs/TwoTuple_PublicKeyTypeZ.mjs';
219 import { Result_boolLightningErrorZ } from '../structs/Result_boolLightningErrorZ.mjs';
220 import { ThreeTuple_ChannelAnnouncementChannelUpdateChannelUpdateZ } from '../structs/ThreeTuple_ChannelAnnouncementChannelUpdateChannelUpdateZ.mjs';
221 import { Option_NetAddressZ } from '../structs/Option_NetAddressZ.mjs';
222 import { PeerHandleError } from '../structs/PeerHandleError.mjs';
223 import { Result_CVec_u8ZPeerHandleErrorZ } from '../structs/Result_CVec_u8ZPeerHandleErrorZ.mjs';
224 import { Result_NonePeerHandleErrorZ } from '../structs/Result_NonePeerHandleErrorZ.mjs';
225 import { Result_boolPeerHandleErrorZ } from '../structs/Result_boolPeerHandleErrorZ.mjs';
226 import { NodeId } from '../structs/NodeId.mjs';
227 import { Result_NodeIdDecodeErrorZ } from '../structs/Result_NodeIdDecodeErrorZ.mjs';
228 import { Result_COption_NetworkUpdateZDecodeErrorZ } from '../structs/Result_COption_NetworkUpdateZDecodeErrorZ.mjs';
229 import { Access, AccessInterface } from '../structs/Access.mjs';
230 import { Option_AccessZ } from '../structs/Option_AccessZ.mjs';
231 import { ChannelUpdateInfo } from '../structs/ChannelUpdateInfo.mjs';
232 import { Result_ChannelUpdateInfoDecodeErrorZ } from '../structs/Result_ChannelUpdateInfoDecodeErrorZ.mjs';
233 import { ChannelInfo } from '../structs/ChannelInfo.mjs';
234 import { Result_ChannelInfoDecodeErrorZ } from '../structs/Result_ChannelInfoDecodeErrorZ.mjs';
235 import { RoutingFees } from '../structs/RoutingFees.mjs';
236 import { Result_RoutingFeesDecodeErrorZ } from '../structs/Result_RoutingFeesDecodeErrorZ.mjs';
237 import { NodeAnnouncementInfo } from '../structs/NodeAnnouncementInfo.mjs';
238 import { Result_NodeAnnouncementInfoDecodeErrorZ } from '../structs/Result_NodeAnnouncementInfoDecodeErrorZ.mjs';
239 import { NodeInfo } from '../structs/NodeInfo.mjs';
240 import { Result_NodeInfoDecodeErrorZ } from '../structs/Result_NodeInfoDecodeErrorZ.mjs';
241 import { Result_NetworkGraphDecodeErrorZ } from '../structs/Result_NetworkGraphDecodeErrorZ.mjs';
242 import { Option_CVec_NetAddressZZ } from '../structs/Option_CVec_NetAddressZZ.mjs';
243 import { Result_NetAddressDecodeErrorZ } from '../structs/Result_NetAddressDecodeErrorZ.mjs';
244 import { UpdateAddHTLC } from '../structs/UpdateAddHTLC.mjs';
245 import { UpdateFulfillHTLC } from '../structs/UpdateFulfillHTLC.mjs';
246 import { UpdateFailHTLC } from '../structs/UpdateFailHTLC.mjs';
247 import { UpdateFailMalformedHTLC } from '../structs/UpdateFailMalformedHTLC.mjs';
248 import { Result_AcceptChannelDecodeErrorZ } from '../structs/Result_AcceptChannelDecodeErrorZ.mjs';
249 import { Result_AnnouncementSignaturesDecodeErrorZ } from '../structs/Result_AnnouncementSignaturesDecodeErrorZ.mjs';
250 import { Result_ChannelReestablishDecodeErrorZ } from '../structs/Result_ChannelReestablishDecodeErrorZ.mjs';
251 import { Result_ClosingSignedDecodeErrorZ } from '../structs/Result_ClosingSignedDecodeErrorZ.mjs';
252 import { ClosingSignedFeeRange } from '../structs/ClosingSignedFeeRange.mjs';
253 import { Result_ClosingSignedFeeRangeDecodeErrorZ } from '../structs/Result_ClosingSignedFeeRangeDecodeErrorZ.mjs';
254 import { CommitmentSigned } from '../structs/CommitmentSigned.mjs';
255 import { Result_CommitmentSignedDecodeErrorZ } from '../structs/Result_CommitmentSignedDecodeErrorZ.mjs';
256 import { Result_FundingCreatedDecodeErrorZ } from '../structs/Result_FundingCreatedDecodeErrorZ.mjs';
257 import { Result_FundingSignedDecodeErrorZ } from '../structs/Result_FundingSignedDecodeErrorZ.mjs';
258 import { Result_FundingLockedDecodeErrorZ } from '../structs/Result_FundingLockedDecodeErrorZ.mjs';
259 import { Init } from '../structs/Init.mjs';
260 import { Result_InitDecodeErrorZ } from '../structs/Result_InitDecodeErrorZ.mjs';
261 import { Result_OpenChannelDecodeErrorZ } from '../structs/Result_OpenChannelDecodeErrorZ.mjs';
262 import { Result_RevokeAndACKDecodeErrorZ } from '../structs/Result_RevokeAndACKDecodeErrorZ.mjs';
263 import { Result_ShutdownDecodeErrorZ } from '../structs/Result_ShutdownDecodeErrorZ.mjs';
264 import { Result_UpdateFailHTLCDecodeErrorZ } from '../structs/Result_UpdateFailHTLCDecodeErrorZ.mjs';
265 import { Result_UpdateFailMalformedHTLCDecodeErrorZ } from '../structs/Result_UpdateFailMalformedHTLCDecodeErrorZ.mjs';
266 import { UpdateFee } from '../structs/UpdateFee.mjs';
267 import { Result_UpdateFeeDecodeErrorZ } from '../structs/Result_UpdateFeeDecodeErrorZ.mjs';
268 import { Result_UpdateFulfillHTLCDecodeErrorZ } from '../structs/Result_UpdateFulfillHTLCDecodeErrorZ.mjs';
269 import { Result_UpdateAddHTLCDecodeErrorZ } from '../structs/Result_UpdateAddHTLCDecodeErrorZ.mjs';
270 import { Ping } from '../structs/Ping.mjs';
271 import { Result_PingDecodeErrorZ } from '../structs/Result_PingDecodeErrorZ.mjs';
272 import { Pong } from '../structs/Pong.mjs';
273 import { Result_PongDecodeErrorZ } from '../structs/Result_PongDecodeErrorZ.mjs';
274 import { Result_UnsignedChannelAnnouncementDecodeErrorZ } from '../structs/Result_UnsignedChannelAnnouncementDecodeErrorZ.mjs';
275 import { Result_ChannelAnnouncementDecodeErrorZ } from '../structs/Result_ChannelAnnouncementDecodeErrorZ.mjs';
276 import { UnsignedChannelUpdate } from '../structs/UnsignedChannelUpdate.mjs';
277 import { Result_UnsignedChannelUpdateDecodeErrorZ } from '../structs/Result_UnsignedChannelUpdateDecodeErrorZ.mjs';
278 import { Result_ChannelUpdateDecodeErrorZ } from '../structs/Result_ChannelUpdateDecodeErrorZ.mjs';
279 import { Result_ErrorMessageDecodeErrorZ } from '../structs/Result_ErrorMessageDecodeErrorZ.mjs';
280 import { Result_WarningMessageDecodeErrorZ } from '../structs/Result_WarningMessageDecodeErrorZ.mjs';
281 import { UnsignedNodeAnnouncement } from '../structs/UnsignedNodeAnnouncement.mjs';
282 import { Result_UnsignedNodeAnnouncementDecodeErrorZ } from '../structs/Result_UnsignedNodeAnnouncementDecodeErrorZ.mjs';
283 import { Result_NodeAnnouncementDecodeErrorZ } from '../structs/Result_NodeAnnouncementDecodeErrorZ.mjs';
284 import { Result_QueryShortChannelIdsDecodeErrorZ } from '../structs/Result_QueryShortChannelIdsDecodeErrorZ.mjs';
285 import { ReplyShortChannelIdsEnd } from '../structs/ReplyShortChannelIdsEnd.mjs';
286 import { Result_ReplyShortChannelIdsEndDecodeErrorZ } from '../structs/Result_ReplyShortChannelIdsEndDecodeErrorZ.mjs';
287 import { Result_QueryChannelRangeDecodeErrorZ } from '../structs/Result_QueryChannelRangeDecodeErrorZ.mjs';
288 import { Result_ReplyChannelRangeDecodeErrorZ } from '../structs/Result_ReplyChannelRangeDecodeErrorZ.mjs';
289 import { Result_GossipTimestampFilterDecodeErrorZ } from '../structs/Result_GossipTimestampFilterDecodeErrorZ.mjs';
290 import { SignOrCreationError } from '../structs/SignOrCreationError.mjs';
291 import { Result_InvoiceSignOrCreationErrorZ } from '../structs/Result_InvoiceSignOrCreationErrorZ.mjs';
292 import { WatchedOutput } from '../structs/WatchedOutput.mjs';
293 import { Filter, FilterInterface } from '../structs/Filter.mjs';
294 import { Option_FilterZ } from '../structs/Option_FilterZ.mjs';
295 import { LockedChannelMonitor } from '../structs/LockedChannelMonitor.mjs';
296 import { Result_LockedChannelMonitorNoneZ } from '../structs/Result_LockedChannelMonitorNoneZ.mjs';
297 import { MessageSendEventsProvider, MessageSendEventsProviderInterface } from '../structs/MessageSendEventsProvider.mjs';
298 import { EventHandler, EventHandlerInterface } from '../structs/EventHandler.mjs';
299 import { EventsProvider, EventsProviderInterface } from '../structs/EventsProvider.mjs';
300 import { ChannelHandshakeConfig } from '../structs/ChannelHandshakeConfig.mjs';
301 import { ChannelHandshakeLimits } from '../structs/ChannelHandshakeLimits.mjs';
302 import { UserConfig } from '../structs/UserConfig.mjs';
303 import { BestBlock } from '../structs/BestBlock.mjs';
304 import { Listen, ListenInterface } from '../structs/Listen.mjs';
305 import { Confirm, ConfirmInterface } from '../structs/Confirm.mjs';
306 import { MonitorUpdateId } from '../structs/MonitorUpdateId.mjs';
307 import { Persist, PersistInterface } from '../structs/Persist.mjs';
308 import { ChainMonitor } from '../structs/ChainMonitor.mjs';
309 import { KeysManager } from '../structs/KeysManager.mjs';
310 import { PhantomKeysManager } from '../structs/PhantomKeysManager.mjs';
311 import { ChainParameters } from '../structs/ChainParameters.mjs';
312 import { ChannelMessageHandler, ChannelMessageHandlerInterface } from '../structs/ChannelMessageHandler.mjs';
313 import { ChannelManagerReadArgs } from '../structs/ChannelManagerReadArgs.mjs';
314 import { DataLossProtect } from '../structs/DataLossProtect.mjs';
315 import { RoutingMessageHandler, RoutingMessageHandlerInterface } from '../structs/RoutingMessageHandler.mjs';
316 import { CustomMessageReader, CustomMessageReaderInterface } from '../structs/CustomMessageReader.mjs';
317 import { CustomMessageHandler, CustomMessageHandlerInterface } from '../structs/CustomMessageHandler.mjs';
318 import { IgnoringMessageHandler } from '../structs/IgnoringMessageHandler.mjs';
319 import { ErroringMessageHandler } from '../structs/ErroringMessageHandler.mjs';
320 import { MessageHandler } from '../structs/MessageHandler.mjs';
321 import { SocketDescriptor, SocketDescriptorInterface } from '../structs/SocketDescriptor.mjs';
322 import { PeerManager } from '../structs/PeerManager.mjs';
323 import { DirectedChannelTransactionParameters } from '../structs/DirectedChannelTransactionParameters.mjs';
324 import { ReadOnlyNetworkGraph } from '../structs/ReadOnlyNetworkGraph.mjs';
325 import { NetGraphMsgHandler } from '../structs/NetGraphMsgHandler.mjs';
326 import { DirectedChannelInfo } from '../structs/DirectedChannelInfo.mjs';
327 import { EffectiveCapacity } from '../structs/EffectiveCapacity.mjs';
328 import { Score, ScoreInterface } from '../structs/Score.mjs';
329 import { LockableScore, LockableScoreInterface } from '../structs/LockableScore.mjs';
330 import { MultiThreadedLockableScore } from '../structs/MultiThreadedLockableScore.mjs';
331 import { ProbabilisticScoringParameters } from '../structs/ProbabilisticScoringParameters.mjs';
332 import { RawDataPart } from '../structs/RawDataPart.mjs';
333 import { Sha256 } from '../structs/Sha256.mjs';
334 import { ExpiryTime } from '../structs/ExpiryTime.mjs';
335 import { MinFinalCltvExpiry } from '../structs/MinFinalCltvExpiry.mjs';
336 import { Fallback } from '../structs/Fallback.mjs';
337 import { Payer, PayerInterface } from '../structs/Payer.mjs';
338 import { Router, RouterInterface } from '../structs/Router.mjs';
339 import { InvoicePayer } from '../structs/InvoicePayer.mjs';
340 import { RetryAttempts } from '../structs/RetryAttempts.mjs';
341 import { DefaultRouter } from '../structs/DefaultRouter.mjs';
343 import { CommonBase, UInt5, UnqualifiedError } from './CommonBase.mjs';
344 import * as bindings from '../bindings.mjs'
347 * An Event which you should probably take some action in response to.
349 * Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
350 * them directly as they don't round-trip exactly (for example FundingGenerationReady is never
351 * written as it makes no sense to respond to it after reconnecting to peers).
353 export class Event extends CommonBase {
354 protected constructor(_dummy: object, ptr: number) { super(ptr, bindings.Event_free); }
356 public static constr_from_ptr(ptr: number): Event {
357 const raw_ty: number = bindings.LDKEvent_ty_from_ptr(ptr);
359 case 0: return new Event_FundingGenerationReady(ptr);
360 case 1: return new Event_PaymentReceived(ptr);
361 case 2: return new Event_PaymentSent(ptr);
362 case 3: return new Event_PaymentPathFailed(ptr);
363 case 4: return new Event_PaymentFailed(ptr);
364 case 5: return new Event_PendingHTLCsForwardable(ptr);
365 case 6: return new Event_SpendableOutputs(ptr);
366 case 7: return new Event_PaymentForwarded(ptr);
367 case 8: return new Event_ChannelClosed(ptr);
368 case 9: return new Event_DiscardFunding(ptr);
369 case 10: return new Event_PaymentPathSuccessful(ptr);
370 case 11: return new Event_OpenChannelRequest(ptr);
372 throw new Error('oops, this should be unreachable'); // Unreachable without extending the (internal) bindings interface
376 public clone_ptr(): number {
377 const ret: number = bindings.Event_clone_ptr(this.ptr);
382 * Creates a copy of the Event
384 public clone(): Event {
385 const ret: number = bindings.Event_clone(this.ptr);
386 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
387 CommonBase.add_ref_from(ret_hu_conv, this);
392 * Utility method to constructs a new FundingGenerationReady-variant Event
394 public static constructor_funding_generation_ready(temporary_channel_id: Uint8Array, channel_value_satoshis: bigint, output_script: Uint8Array, user_channel_id: bigint): Event {
395 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);
396 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
397 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
402 * Utility method to constructs a new PaymentReceived-variant Event
404 public static constructor_payment_received(payment_hash: Uint8Array, amt: bigint, purpose: PaymentPurpose): Event {
405 const ret: number = bindings.Event_payment_received(bindings.encodeUint8Array(bindings.check_arr_len(payment_hash, 32)), amt, CommonBase.get_ptr_of(purpose));
406 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
407 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
412 * Utility method to constructs a new PaymentSent-variant Event
414 public static constructor_payment_sent(payment_id: Uint8Array, payment_preimage: Uint8Array, payment_hash: Uint8Array, fee_paid_msat: Option_u64Z): Event {
415 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));
416 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
417 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
422 * Utility method to constructs a new PaymentPathFailed-variant Event
424 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 {
425 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);
426 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
427 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
432 * Utility method to constructs a new PaymentFailed-variant Event
434 public static constructor_payment_failed(payment_id: Uint8Array, payment_hash: Uint8Array): Event {
435 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)));
436 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
437 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
442 * Utility method to constructs a new PendingHTLCsForwardable-variant Event
444 public static constructor_pending_htlcs_forwardable(time_forwardable: bigint): Event {
445 const ret: number = bindings.Event_pending_htlcs_forwardable(time_forwardable);
446 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
447 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
452 * Utility method to constructs a new SpendableOutputs-variant Event
454 public static constructor_spendable_outputs(outputs: SpendableOutputDescriptor[]): Event {
455 const ret: number = bindings.Event_spendable_outputs(bindings.encodeUint32Array(outputs != null ? outputs.map(outputs_conv_27 => CommonBase.get_ptr_of(outputs_conv_27)) : null));
456 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
457 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
462 * Utility method to constructs a new PaymentForwarded-variant Event
464 public static constructor_payment_forwarded(fee_earned_msat: Option_u64Z, claim_from_onchain_tx: boolean): Event {
465 const ret: number = bindings.Event_payment_forwarded(CommonBase.get_ptr_of(fee_earned_msat), claim_from_onchain_tx);
466 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
467 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
472 * Utility method to constructs a new ChannelClosed-variant Event
474 public static constructor_channel_closed(channel_id: Uint8Array, user_channel_id: bigint, reason: ClosureReason): Event {
475 const ret: number = bindings.Event_channel_closed(bindings.encodeUint8Array(bindings.check_arr_len(channel_id, 32)), user_channel_id, CommonBase.get_ptr_of(reason));
476 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
477 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
482 * Utility method to constructs a new DiscardFunding-variant Event
484 public static constructor_discard_funding(channel_id: Uint8Array, transaction: Uint8Array): Event {
485 const ret: number = bindings.Event_discard_funding(bindings.encodeUint8Array(bindings.check_arr_len(channel_id, 32)), bindings.encodeUint8Array(transaction));
486 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
487 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
492 * Utility method to constructs a new PaymentPathSuccessful-variant Event
494 public static constructor_payment_path_successful(payment_id: Uint8Array, payment_hash: Uint8Array, path: RouteHop[]): Event {
495 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));
496 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
497 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
502 * Utility method to constructs a new OpenChannelRequest-variant Event
504 public static constructor_open_channel_request(temporary_channel_id: Uint8Array, counterparty_node_id: Uint8Array, funding_satoshis: bigint, push_msat: bigint, channel_type: ChannelTypeFeatures): Event {
505 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, channel_type == null ? 0 : CommonBase.get_ptr_of(channel_type) & ~1);
506 const ret_hu_conv: Event = Event.constr_from_ptr(ret);
507 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
512 * Serialize the Event object into a byte array which can be read by Event_read
514 public write(): Uint8Array {
515 const ret: number = bindings.Event_write(this.ptr);
516 const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
521 /** A Event of type FundingGenerationReady */
522 export class Event_FundingGenerationReady extends Event {
524 * The random channel_id we picked which you'll need to pass into
525 * ChannelManager::funding_transaction_generated.
527 public temporary_channel_id: Uint8Array;
529 * The value, in satoshis, that the output should have.
531 public channel_value_satoshis: bigint;
533 * The script which should be used in the transaction output.
535 public output_script: Uint8Array;
537 * The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
538 * an inbound channel.
540 * [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
542 public user_channel_id: bigint;
544 public constructor(ptr: number) {
546 const temporary_channel_id: number = bindings.LDKEvent_FundingGenerationReady_get_temporary_channel_id(ptr);
547 const temporary_channel_id_conv: Uint8Array = bindings.decodeUint8Array(temporary_channel_id);
548 this.temporary_channel_id = temporary_channel_id_conv;
549 this.channel_value_satoshis = bindings.LDKEvent_FundingGenerationReady_get_channel_value_satoshis(ptr);
550 const output_script: number = bindings.LDKEvent_FundingGenerationReady_get_output_script(ptr);
551 const output_script_conv: Uint8Array = bindings.decodeUint8Array(output_script);
552 this.output_script = output_script_conv;
553 this.user_channel_id = bindings.LDKEvent_FundingGenerationReady_get_user_channel_id(ptr);
556 /** A Event of type PaymentReceived */
557 export class Event_PaymentReceived extends Event {
559 * The hash for which the preimage should be handed to the ChannelManager. Note that LDK will
560 * not stop you from registering duplicate payment hashes for inbound payments.
562 public payment_hash: Uint8Array;
564 * The value, in thousandths of a satoshi, that this payment is for.
568 * Information for claiming this received payment, based on whether the purpose of the
569 * payment is to pay an invoice or to send a spontaneous payment.
571 public purpose: PaymentPurpose;
573 public constructor(ptr: number) {
575 const payment_hash: number = bindings.LDKEvent_PaymentReceived_get_payment_hash(ptr);
576 const payment_hash_conv: Uint8Array = bindings.decodeUint8Array(payment_hash);
577 this.payment_hash = payment_hash_conv;
578 this.amt = bindings.LDKEvent_PaymentReceived_get_amt(ptr);
579 const purpose: number = bindings.LDKEvent_PaymentReceived_get_purpose(ptr);
580 const purpose_hu_conv: PaymentPurpose = PaymentPurpose.constr_from_ptr(purpose);
581 CommonBase.add_ref_from(purpose_hu_conv, this);
582 this.purpose = purpose_hu_conv;
585 /** A Event of type PaymentSent */
586 export class Event_PaymentSent extends Event {
588 * The id returned by [`ChannelManager::send_payment`] and used with
589 * [`ChannelManager::retry_payment`].
591 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
592 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
594 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
596 public payment_id: Uint8Array;
598 * The preimage to the hash given to ChannelManager::send_payment.
599 * Note that this serves as a payment receipt, if you wish to have such a thing, you must
602 public payment_preimage: Uint8Array;
604 * The hash that was given to [`ChannelManager::send_payment`].
606 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
608 public payment_hash: Uint8Array;
610 * The total fee which was spent at intermediate hops in this payment, across all paths.
612 * Note that, like [`Route::get_total_fees`] this does *not* include any potential
613 * overpayment to the recipient node.
615 * If the recipient or an intermediate node misbehaves and gives us free money, this may
616 * overstate the amount paid, though this is unlikely.
618 * [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
620 public fee_paid_msat: Option_u64Z;
622 public constructor(ptr: number) {
624 const payment_id: number = bindings.LDKEvent_PaymentSent_get_payment_id(ptr);
625 const payment_id_conv: Uint8Array = bindings.decodeUint8Array(payment_id);
626 this.payment_id = payment_id_conv;
627 const payment_preimage: number = bindings.LDKEvent_PaymentSent_get_payment_preimage(ptr);
628 const payment_preimage_conv: Uint8Array = bindings.decodeUint8Array(payment_preimage);
629 this.payment_preimage = payment_preimage_conv;
630 const payment_hash: number = bindings.LDKEvent_PaymentSent_get_payment_hash(ptr);
631 const payment_hash_conv: Uint8Array = bindings.decodeUint8Array(payment_hash);
632 this.payment_hash = payment_hash_conv;
633 const fee_paid_msat: number = bindings.LDKEvent_PaymentSent_get_fee_paid_msat(ptr);
634 const fee_paid_msat_hu_conv: Option_u64Z = Option_u64Z.constr_from_ptr(fee_paid_msat);
635 CommonBase.add_ref_from(fee_paid_msat_hu_conv, this);
636 this.fee_paid_msat = fee_paid_msat_hu_conv;
639 /** A Event of type PaymentPathFailed */
640 export class Event_PaymentPathFailed extends Event {
642 * The id returned by [`ChannelManager::send_payment`] and used with
643 * [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
645 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
646 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
647 * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
649 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
651 public payment_id: Uint8Array;
653 * The hash that was given to [`ChannelManager::send_payment`].
655 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
657 public payment_hash: Uint8Array;
659 * Indicates the payment was rejected for some reason by the recipient. This implies that
660 * the payment has failed, not just the route in question. If this is not set, you may
661 * retry the payment via a different route.
663 public rejected_by_dest: boolean;
665 * Any failure information conveyed via the Onion return packet by a node along the failed
668 * Should be applied to the [`NetworkGraph`] so that routing decisions can take into
669 * account the update. [`NetGraphMsgHandler`] is capable of doing this.
671 * [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph
672 * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
674 public network_update: Option_NetworkUpdateZ;
676 * For both single-path and multi-path payments, this is set if all paths of the payment have
677 * failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
678 * larger MPP payment were still in flight when this event was generated.
680 * Note that if you are retrying individual MPP parts, using this value to determine if a
681 * payment has fully failed is race-y. Because multiple failures can happen prior to events
682 * being processed, you may retry in response to a first failure, with a second failure
683 * (with `all_paths_failed` set) still pending. Then, when the second failure is processed
684 * you will see `all_paths_failed` set even though the retry of the first failure still
685 * has an associated in-flight HTLC. See (1) for an example of such a failure.
687 * If you wish to retry individual MPP parts and learn when a payment has failed, you must
688 * call [`ChannelManager::abandon_payment`] and wait for a [`Event::PaymentFailed`] event.
690 * (1) <https://github.com/lightningdevkit/rust-lightning/issues/1164>
692 * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
694 public all_paths_failed: boolean;
696 * The payment path that failed.
698 public path: RouteHop[];
700 * The channel responsible for the failed payment path.
702 * If this is `Some`, then the corresponding channel should be avoided when the payment is
703 * retried. May be `None` for older [`Event`] serializations.
705 public short_channel_id: Option_u64Z;
707 * Parameters needed to compute a new [`Route`] when retrying the failed payment path.
709 * See [`find_route`] for details.
711 * [`Route`]: crate::routing::router::Route
712 * [`find_route`]: crate::routing::router::find_route
714 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
716 public retry: RouteParameters;
718 public constructor(ptr: number) {
720 const payment_id: number = bindings.LDKEvent_PaymentPathFailed_get_payment_id(ptr);
721 const payment_id_conv: Uint8Array = bindings.decodeUint8Array(payment_id);
722 this.payment_id = payment_id_conv;
723 const payment_hash: number = bindings.LDKEvent_PaymentPathFailed_get_payment_hash(ptr);
724 const payment_hash_conv: Uint8Array = bindings.decodeUint8Array(payment_hash);
725 this.payment_hash = payment_hash_conv;
726 this.rejected_by_dest = bindings.LDKEvent_PaymentPathFailed_get_rejected_by_dest(ptr);
727 const network_update: number = bindings.LDKEvent_PaymentPathFailed_get_network_update(ptr);
728 const network_update_hu_conv: Option_NetworkUpdateZ = Option_NetworkUpdateZ.constr_from_ptr(network_update);
729 CommonBase.add_ref_from(network_update_hu_conv, this);
730 this.network_update = network_update_hu_conv;
731 this.all_paths_failed = bindings.LDKEvent_PaymentPathFailed_get_all_paths_failed(ptr);
732 const path: number = bindings.LDKEvent_PaymentPathFailed_get_path(ptr);
733 const path_conv_10_len: number = bindings.getArrayLength(path);
734 const path_conv_10_arr: RouteHop[] = new Array(path_conv_10_len).fill(null);
735 for (var k = 0; k < path_conv_10_len; k++) {
736 const path_conv_10: number = bindings.getU32ArrayElem(path, k);
737 const path_conv_10_hu_conv: RouteHop = new RouteHop(null, path_conv_10);
738 CommonBase.add_ref_from(path_conv_10_hu_conv, this);
739 path_conv_10_arr[k] = path_conv_10_hu_conv;
741 bindings.freeWasmMemory(path)
742 this.path = path_conv_10_arr;
743 const short_channel_id: number = bindings.LDKEvent_PaymentPathFailed_get_short_channel_id(ptr);
744 const short_channel_id_hu_conv: Option_u64Z = Option_u64Z.constr_from_ptr(short_channel_id);
745 CommonBase.add_ref_from(short_channel_id_hu_conv, this);
746 this.short_channel_id = short_channel_id_hu_conv;
747 const retry: number = bindings.LDKEvent_PaymentPathFailed_get_retry(ptr);
748 const retry_hu_conv: RouteParameters = new RouteParameters(null, retry);
749 CommonBase.add_ref_from(retry_hu_conv, this);
750 this.retry = retry_hu_conv;
753 /** A Event of type PaymentFailed */
754 export class Event_PaymentFailed extends Event {
756 * The id returned by [`ChannelManager::send_payment`] and used with
757 * [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
759 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
760 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
761 * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
763 public payment_id: Uint8Array;
765 * The hash that was given to [`ChannelManager::send_payment`].
767 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
769 public payment_hash: Uint8Array;
771 public constructor(ptr: number) {
773 const payment_id: number = bindings.LDKEvent_PaymentFailed_get_payment_id(ptr);
774 const payment_id_conv: Uint8Array = bindings.decodeUint8Array(payment_id);
775 this.payment_id = payment_id_conv;
776 const payment_hash: number = bindings.LDKEvent_PaymentFailed_get_payment_hash(ptr);
777 const payment_hash_conv: Uint8Array = bindings.decodeUint8Array(payment_hash);
778 this.payment_hash = payment_hash_conv;
781 /** A Event of type PendingHTLCsForwardable */
782 export class Event_PendingHTLCsForwardable extends Event {
784 * The minimum amount of time that should be waited prior to calling
785 * process_pending_htlc_forwards. To increase the effort required to correlate payments,
786 * you should wait a random amount of time in roughly the range (now + time_forwardable,
787 * now + 5*time_forwardable).
789 public time_forwardable: bigint;
791 public constructor(ptr: number) {
793 this.time_forwardable = bindings.LDKEvent_PendingHTLCsForwardable_get_time_forwardable(ptr);
796 /** A Event of type SpendableOutputs */
797 export class Event_SpendableOutputs extends Event {
799 * The outputs which you should store as spendable by you.
801 public outputs: SpendableOutputDescriptor[];
803 public constructor(ptr: number) {
805 const outputs: number = bindings.LDKEvent_SpendableOutputs_get_outputs(ptr);
806 const outputs_conv_27_len: number = bindings.getArrayLength(outputs);
807 const outputs_conv_27_arr: SpendableOutputDescriptor[] = new Array(outputs_conv_27_len).fill(null);
808 for (var b = 0; b < outputs_conv_27_len; b++) {
809 const outputs_conv_27: number = bindings.getU32ArrayElem(outputs, b);
810 const outputs_conv_27_hu_conv: SpendableOutputDescriptor = SpendableOutputDescriptor.constr_from_ptr(outputs_conv_27);
811 CommonBase.add_ref_from(outputs_conv_27_hu_conv, this);
812 outputs_conv_27_arr[b] = outputs_conv_27_hu_conv;
814 bindings.freeWasmMemory(outputs)
815 this.outputs = outputs_conv_27_arr;
818 /** A Event of type PaymentForwarded */
819 export class Event_PaymentForwarded extends Event {
821 * The fee, in milli-satoshis, which was earned as a result of the payment.
823 * Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
824 * was pending, the amount the next hop claimed will have been rounded down to the nearest
825 * whole satoshi. Thus, the fee calculated here may be higher than expected as we still
826 * claimed the full value in millisatoshis from the source. In this case,
827 * `claim_from_onchain_tx` will be set.
829 * If the channel which sent us the payment has been force-closed, we will claim the funds
830 * via an on-chain transaction. In that case we do not yet know the on-chain transaction
831 * fees which we will spend and will instead set this to `None`. It is possible duplicate
832 * `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
835 public fee_earned_msat: Option_u64Z;
837 * If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
840 public claim_from_onchain_tx: boolean;
842 public constructor(ptr: number) {
844 const fee_earned_msat: number = bindings.LDKEvent_PaymentForwarded_get_fee_earned_msat(ptr);
845 const fee_earned_msat_hu_conv: Option_u64Z = Option_u64Z.constr_from_ptr(fee_earned_msat);
846 CommonBase.add_ref_from(fee_earned_msat_hu_conv, this);
847 this.fee_earned_msat = fee_earned_msat_hu_conv;
848 this.claim_from_onchain_tx = bindings.LDKEvent_PaymentForwarded_get_claim_from_onchain_tx(ptr);
851 /** A Event of type ChannelClosed */
852 export class Event_ChannelClosed extends Event {
854 * The channel_id of the channel which has been closed. Note that on-chain transactions
855 * resolving the channel are likely still awaiting confirmation.
857 public channel_id: Uint8Array;
859 * The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
860 * channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
861 * [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
862 * `user_channel_id` will be 0 for an inbound channel.
863 * This will always be zero for objects serialized with LDK versions prior to 0.0.102.
865 * [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
866 * [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
867 * [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
869 public user_channel_id: bigint;
871 * The reason the channel was closed.
873 public reason: ClosureReason;
875 public constructor(ptr: number) {
877 const channel_id: number = bindings.LDKEvent_ChannelClosed_get_channel_id(ptr);
878 const channel_id_conv: Uint8Array = bindings.decodeUint8Array(channel_id);
879 this.channel_id = channel_id_conv;
880 this.user_channel_id = bindings.LDKEvent_ChannelClosed_get_user_channel_id(ptr);
881 const reason: number = bindings.LDKEvent_ChannelClosed_get_reason(ptr);
882 const reason_hu_conv: ClosureReason = ClosureReason.constr_from_ptr(reason);
883 CommonBase.add_ref_from(reason_hu_conv, this);
884 this.reason = reason_hu_conv;
887 /** A Event of type DiscardFunding */
888 export class Event_DiscardFunding extends Event {
890 * The channel_id of the channel which has been closed.
892 public channel_id: Uint8Array;
894 * The full transaction received from the user
896 public transaction: Uint8Array;
898 public constructor(ptr: number) {
900 const channel_id: number = bindings.LDKEvent_DiscardFunding_get_channel_id(ptr);
901 const channel_id_conv: Uint8Array = bindings.decodeUint8Array(channel_id);
902 this.channel_id = channel_id_conv;
903 const transaction: number = bindings.LDKEvent_DiscardFunding_get_transaction(ptr);
904 const transaction_conv: Uint8Array = bindings.decodeUint8Array(transaction);
905 this.transaction = transaction_conv;
908 /** A Event of type PaymentPathSuccessful */
909 export class Event_PaymentPathSuccessful extends Event {
911 * The id returned by [`ChannelManager::send_payment`] and used with
912 * [`ChannelManager::retry_payment`].
914 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
915 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
917 public payment_id: Uint8Array;
919 * The hash that was given to [`ChannelManager::send_payment`].
921 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
923 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
925 public payment_hash: Uint8Array;
927 * The payment path that was successful.
929 * May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
931 public path: RouteHop[];
933 public constructor(ptr: number) {
935 const payment_id: number = bindings.LDKEvent_PaymentPathSuccessful_get_payment_id(ptr);
936 const payment_id_conv: Uint8Array = bindings.decodeUint8Array(payment_id);
937 this.payment_id = payment_id_conv;
938 const payment_hash: number = bindings.LDKEvent_PaymentPathSuccessful_get_payment_hash(ptr);
939 const payment_hash_conv: Uint8Array = bindings.decodeUint8Array(payment_hash);
940 this.payment_hash = payment_hash_conv;
941 const path: number = bindings.LDKEvent_PaymentPathSuccessful_get_path(ptr);
942 const path_conv_10_len: number = bindings.getArrayLength(path);
943 const path_conv_10_arr: RouteHop[] = new Array(path_conv_10_len).fill(null);
944 for (var k = 0; k < path_conv_10_len; k++) {
945 const path_conv_10: number = bindings.getU32ArrayElem(path, k);
946 const path_conv_10_hu_conv: RouteHop = new RouteHop(null, path_conv_10);
947 CommonBase.add_ref_from(path_conv_10_hu_conv, this);
948 path_conv_10_arr[k] = path_conv_10_hu_conv;
950 bindings.freeWasmMemory(path)
951 this.path = path_conv_10_arr;
954 /** A Event of type OpenChannelRequest */
955 export class Event_OpenChannelRequest extends Event {
957 * The temporary channel ID of the channel requested to be opened.
959 * When responding to the request, the `temporary_channel_id` should be passed
960 * back to the ChannelManager with [`ChannelManager::accept_inbound_channel`] to accept,
961 * or to [`ChannelManager::force_close_channel`] to reject.
963 * [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
964 * [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
966 public temporary_channel_id: Uint8Array;
968 * The node_id of the counterparty requesting to open the channel.
970 public counterparty_node_id: Uint8Array;
972 * The channel value of the requested channel.
974 public funding_satoshis: bigint;
976 * Our starting balance in the channel if the request is accepted, in milli-satoshi.
978 public push_msat: bigint;
980 * The features that this channel will operate with. If you reject the channel, a
981 * well-behaved counterparty may automatically re-attempt the channel with a new set of
984 * Note that if [`ChannelTypeFeatures::supports_scid_privacy`] returns true on this type,
985 * the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
988 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
990 public channel_type: ChannelTypeFeatures;
992 public constructor(ptr: number) {
994 const temporary_channel_id: number = bindings.LDKEvent_OpenChannelRequest_get_temporary_channel_id(ptr);
995 const temporary_channel_id_conv: Uint8Array = bindings.decodeUint8Array(temporary_channel_id);
996 this.temporary_channel_id = temporary_channel_id_conv;
997 const counterparty_node_id: number = bindings.LDKEvent_OpenChannelRequest_get_counterparty_node_id(ptr);
998 const counterparty_node_id_conv: Uint8Array = bindings.decodeUint8Array(counterparty_node_id);
999 this.counterparty_node_id = counterparty_node_id_conv;
1000 this.funding_satoshis = bindings.LDKEvent_OpenChannelRequest_get_funding_satoshis(ptr);
1001 this.push_msat = bindings.LDKEvent_OpenChannelRequest_get_push_msat(ptr);
1002 const channel_type: number = bindings.LDKEvent_OpenChannelRequest_get_channel_type(ptr);
1003 const channel_type_hu_conv: ChannelTypeFeatures = new ChannelTypeFeatures(null, channel_type);
1004 CommonBase.add_ref_from(channel_type_hu_conv, this);
1005 this.channel_type = channel_type_hu_conv;