[TS] Update auto-generated bindings
[ldk-java] / ts / structs / Invoice.mts
1 import { TxOut } from '../structs/TxOut.mjs';
2 import { AccessError } from '../enums/AccessError.mjs';
3 import { COption_NoneZ } from '../enums/COption_NoneZ.mjs';
4 import { ChannelMonitorUpdateErr } from '../enums/ChannelMonitorUpdateErr.mjs';
5 import { ConfirmationTarget } from '../enums/ConfirmationTarget.mjs';
6 import { CreationError } from '../enums/CreationError.mjs';
7 import { Currency } from '../enums/Currency.mjs';
8 import { Level } from '../enums/Level.mjs';
9 import { Network } from '../enums/Network.mjs';
10 import { Recipient } from '../enums/Recipient.mjs';
11 import { Secp256k1Error } from '../enums/Secp256k1Error.mjs';
12 import { SemanticError } from '../enums/SemanticError.mjs';
13 import { SiPrefix } from '../enums/SiPrefix.mjs';
14 import { Result_NoneNoneZ } from '../structs/Result_NoneNoneZ.mjs';
15 import { CounterpartyCommitmentSecrets } from '../structs/CounterpartyCommitmentSecrets.mjs';
16 import { DecodeError } from '../structs/DecodeError.mjs';
17 import { Result_CounterpartyCommitmentSecretsDecodeErrorZ } from '../structs/Result_CounterpartyCommitmentSecretsDecodeErrorZ.mjs';
18 import { Result_SecretKeyErrorZ } from '../structs/Result_SecretKeyErrorZ.mjs';
19 import { Result_PublicKeyErrorZ } from '../structs/Result_PublicKeyErrorZ.mjs';
20 import { TxCreationKeys } from '../structs/TxCreationKeys.mjs';
21 import { Result_TxCreationKeysDecodeErrorZ } from '../structs/Result_TxCreationKeysDecodeErrorZ.mjs';
22 import { ChannelPublicKeys } from '../structs/ChannelPublicKeys.mjs';
23 import { Result_ChannelPublicKeysDecodeErrorZ } from '../structs/Result_ChannelPublicKeysDecodeErrorZ.mjs';
24 import { Result_TxCreationKeysErrorZ } from '../structs/Result_TxCreationKeysErrorZ.mjs';
25 import { Option_u32Z } from '../structs/Option_u32Z.mjs';
26 import { HTLCOutputInCommitment } from '../structs/HTLCOutputInCommitment.mjs';
27 import { Result_HTLCOutputInCommitmentDecodeErrorZ } from '../structs/Result_HTLCOutputInCommitmentDecodeErrorZ.mjs';
28 import { CounterpartyChannelTransactionParameters } from '../structs/CounterpartyChannelTransactionParameters.mjs';
29 import { Result_CounterpartyChannelTransactionParametersDecodeErrorZ } from '../structs/Result_CounterpartyChannelTransactionParametersDecodeErrorZ.mjs';
30 import { ChannelTransactionParameters } from '../structs/ChannelTransactionParameters.mjs';
31 import { Result_ChannelTransactionParametersDecodeErrorZ } from '../structs/Result_ChannelTransactionParametersDecodeErrorZ.mjs';
32 import { HolderCommitmentTransaction } from '../structs/HolderCommitmentTransaction.mjs';
33 import { Result_HolderCommitmentTransactionDecodeErrorZ } from '../structs/Result_HolderCommitmentTransactionDecodeErrorZ.mjs';
34 import { BuiltCommitmentTransaction } from '../structs/BuiltCommitmentTransaction.mjs';
35 import { Result_BuiltCommitmentTransactionDecodeErrorZ } from '../structs/Result_BuiltCommitmentTransactionDecodeErrorZ.mjs';
36 import { TrustedClosingTransaction } from '../structs/TrustedClosingTransaction.mjs';
37 import { Result_TrustedClosingTransactionNoneZ } from '../structs/Result_TrustedClosingTransactionNoneZ.mjs';
38 import { CommitmentTransaction } from '../structs/CommitmentTransaction.mjs';
39 import { Result_CommitmentTransactionDecodeErrorZ } from '../structs/Result_CommitmentTransactionDecodeErrorZ.mjs';
40 import { TrustedCommitmentTransaction } from '../structs/TrustedCommitmentTransaction.mjs';
41 import { Result_TrustedCommitmentTransactionNoneZ } from '../structs/Result_TrustedCommitmentTransactionNoneZ.mjs';
42 import { Result_CVec_SignatureZNoneZ } from '../structs/Result_CVec_SignatureZNoneZ.mjs';
43 import { ShutdownScript } from '../structs/ShutdownScript.mjs';
44 import { Result_ShutdownScriptDecodeErrorZ } from '../structs/Result_ShutdownScriptDecodeErrorZ.mjs';
45 import { InvalidShutdownScript } from '../structs/InvalidShutdownScript.mjs';
46 import { Result_ShutdownScriptInvalidShutdownScriptZ } from '../structs/Result_ShutdownScriptInvalidShutdownScriptZ.mjs';
47 import { RouteHop } from '../structs/RouteHop.mjs';
48 import { Result_RouteHopDecodeErrorZ } from '../structs/Result_RouteHopDecodeErrorZ.mjs';
49 import { Route } from '../structs/Route.mjs';
50 import { Result_RouteDecodeErrorZ } from '../structs/Result_RouteDecodeErrorZ.mjs';
51 import { RouteParameters } from '../structs/RouteParameters.mjs';
52 import { Result_RouteParametersDecodeErrorZ } from '../structs/Result_RouteParametersDecodeErrorZ.mjs';
53 import { RouteHint } from '../structs/RouteHint.mjs';
54 import { Option_u64Z } from '../structs/Option_u64Z.mjs';
55 import { PaymentParameters } from '../structs/PaymentParameters.mjs';
56 import { Result_PaymentParametersDecodeErrorZ } from '../structs/Result_PaymentParametersDecodeErrorZ.mjs';
57 import { RouteHintHop } from '../structs/RouteHintHop.mjs';
58 import { Result_RouteHintDecodeErrorZ } from '../structs/Result_RouteHintDecodeErrorZ.mjs';
59 import { Result_RouteHintHopDecodeErrorZ } from '../structs/Result_RouteHintHopDecodeErrorZ.mjs';
60 import { ChannelDetails } from '../structs/ChannelDetails.mjs';
61 import { LightningError } from '../structs/LightningError.mjs';
62 import { Result_RouteLightningErrorZ } from '../structs/Result_RouteLightningErrorZ.mjs';
63 import { Result_TxOutAccessErrorZ } from '../structs/Result_TxOutAccessErrorZ.mjs';
64 import { TwoTuple_usizeTransactionZ } from '../structs/TwoTuple_usizeTransactionZ.mjs';
65 import { Result_NoneChannelMonitorUpdateErrZ } from '../structs/Result_NoneChannelMonitorUpdateErrZ.mjs';
66 import { HTLCUpdate } from '../structs/HTLCUpdate.mjs';
67 import { OutPoint } from '../structs/OutPoint.mjs';
68 import { MonitorEvent } from '../structs/MonitorEvent.mjs';
69 import { Option_C2Tuple_usizeTransactionZZ } from '../structs/Option_C2Tuple_usizeTransactionZZ.mjs';
70 import { ClosureReason } from '../structs/ClosureReason.mjs';
71 import { Option_ClosureReasonZ } from '../structs/Option_ClosureReasonZ.mjs';
72 import { Result_COption_ClosureReasonZDecodeErrorZ } from '../structs/Result_COption_ClosureReasonZDecodeErrorZ.mjs';
73 import { ChannelUpdate } from '../structs/ChannelUpdate.mjs';
74 import { NetworkUpdate } from '../structs/NetworkUpdate.mjs';
75 import { Option_NetworkUpdateZ } from '../structs/Option_NetworkUpdateZ.mjs';
76 import { DelayedPaymentOutputDescriptor } from '../structs/DelayedPaymentOutputDescriptor.mjs';
77 import { StaticPaymentOutputDescriptor } from '../structs/StaticPaymentOutputDescriptor.mjs';
78 import { SpendableOutputDescriptor } from '../structs/SpendableOutputDescriptor.mjs';
79 import { PaymentPurpose } from '../structs/PaymentPurpose.mjs';
80 import { Event } from '../structs/Event.mjs';
81 import { Option_EventZ } from '../structs/Option_EventZ.mjs';
82 import { Result_COption_EventZDecodeErrorZ } from '../structs/Result_COption_EventZDecodeErrorZ.mjs';
83 import { AcceptChannel } from '../structs/AcceptChannel.mjs';
84 import { OpenChannel } from '../structs/OpenChannel.mjs';
85 import { FundingCreated } from '../structs/FundingCreated.mjs';
86 import { FundingSigned } from '../structs/FundingSigned.mjs';
87 import { FundingLocked } from '../structs/FundingLocked.mjs';
88 import { AnnouncementSignatures } from '../structs/AnnouncementSignatures.mjs';
89 import { CommitmentUpdate } from '../structs/CommitmentUpdate.mjs';
90 import { RevokeAndACK } from '../structs/RevokeAndACK.mjs';
91 import { ClosingSigned } from '../structs/ClosingSigned.mjs';
92 import { Shutdown } from '../structs/Shutdown.mjs';
93 import { ChannelReestablish } from '../structs/ChannelReestablish.mjs';
94 import { ChannelAnnouncement } from '../structs/ChannelAnnouncement.mjs';
95 import { NodeAnnouncement } from '../structs/NodeAnnouncement.mjs';
96 import { ErrorMessage } from '../structs/ErrorMessage.mjs';
97 import { WarningMessage } from '../structs/WarningMessage.mjs';
98 import { ErrorAction } from '../structs/ErrorAction.mjs';
99 import { QueryChannelRange } from '../structs/QueryChannelRange.mjs';
100 import { QueryShortChannelIds } from '../structs/QueryShortChannelIds.mjs';
101 import { ReplyChannelRange } from '../structs/ReplyChannelRange.mjs';
102 import { MessageSendEvent } from '../structs/MessageSendEvent.mjs';
103 import { FixedPenaltyScorer } from '../structs/FixedPenaltyScorer.mjs';
104 import { Result_FixedPenaltyScorerDecodeErrorZ } from '../structs/Result_FixedPenaltyScorerDecodeErrorZ.mjs';
105 import { ScoringParameters } from '../structs/ScoringParameters.mjs';
106 import { Result_ScoringParametersDecodeErrorZ } from '../structs/Result_ScoringParametersDecodeErrorZ.mjs';
107 import { Scorer } from '../structs/Scorer.mjs';
108 import { Result_ScorerDecodeErrorZ } from '../structs/Result_ScorerDecodeErrorZ.mjs';
109 import { ProbabilisticScoringParameters } from '../structs/ProbabilisticScoringParameters.mjs';
110 import { Result_ProbabilisticScoringParametersDecodeErrorZ } from '../structs/Result_ProbabilisticScoringParametersDecodeErrorZ.mjs';
111 import { NetworkGraph } from '../structs/NetworkGraph.mjs';
112 import { TwoTuple_ProbabilisticScoringParametersNetworkGraphZ } from '../structs/TwoTuple_ProbabilisticScoringParametersNetworkGraphZ.mjs';
113 import { ProbabilisticScorer } from '../structs/ProbabilisticScorer.mjs';
114 import { Result_ProbabilisticScorerDecodeErrorZ } from '../structs/Result_ProbabilisticScorerDecodeErrorZ.mjs';
115 import { InitFeatures } from '../structs/InitFeatures.mjs';
116 import { Result_InitFeaturesDecodeErrorZ } from '../structs/Result_InitFeaturesDecodeErrorZ.mjs';
117 import { ChannelFeatures } from '../structs/ChannelFeatures.mjs';
118 import { Result_ChannelFeaturesDecodeErrorZ } from '../structs/Result_ChannelFeaturesDecodeErrorZ.mjs';
119 import { NodeFeatures } from '../structs/NodeFeatures.mjs';
120 import { Result_NodeFeaturesDecodeErrorZ } from '../structs/Result_NodeFeaturesDecodeErrorZ.mjs';
121 import { InvoiceFeatures } from '../structs/InvoiceFeatures.mjs';
122 import { Result_InvoiceFeaturesDecodeErrorZ } from '../structs/Result_InvoiceFeaturesDecodeErrorZ.mjs';
123 import { ChannelTypeFeatures } from '../structs/ChannelTypeFeatures.mjs';
124 import { Result_ChannelTypeFeaturesDecodeErrorZ } from '../structs/Result_ChannelTypeFeaturesDecodeErrorZ.mjs';
125 import { Result_DelayedPaymentOutputDescriptorDecodeErrorZ } from '../structs/Result_DelayedPaymentOutputDescriptorDecodeErrorZ.mjs';
126 import { Result_StaticPaymentOutputDescriptorDecodeErrorZ } from '../structs/Result_StaticPaymentOutputDescriptorDecodeErrorZ.mjs';
127 import { Result_SpendableOutputDescriptorDecodeErrorZ } from '../structs/Result_SpendableOutputDescriptorDecodeErrorZ.mjs';
128 import { TwoTuple_SignatureCVec_SignatureZZ } from '../structs/TwoTuple_SignatureCVec_SignatureZZ.mjs';
129 import { Result_C2Tuple_SignatureCVec_SignatureZZNoneZ } from '../structs/Result_C2Tuple_SignatureCVec_SignatureZZNoneZ.mjs';
130 import { Result_SignatureNoneZ } from '../structs/Result_SignatureNoneZ.mjs';
131 import { TwoTuple_SignatureSignatureZ } from '../structs/TwoTuple_SignatureSignatureZ.mjs';
132 import { Result_C2Tuple_SignatureSignatureZNoneZ } from '../structs/Result_C2Tuple_SignatureSignatureZNoneZ.mjs';
133 import { Result_SecretKeyNoneZ } from '../structs/Result_SecretKeyNoneZ.mjs';
134 import { ClosingTransaction } from '../structs/ClosingTransaction.mjs';
135 import { UnsignedChannelAnnouncement } from '../structs/UnsignedChannelAnnouncement.mjs';
136 import { BaseSign, BaseSignInterface } from '../structs/BaseSign.mjs';
137 import { Sign, SignInterface } from '../structs/Sign.mjs';
138 import { Result_SignDecodeErrorZ } from '../structs/Result_SignDecodeErrorZ.mjs';
139 import { Result_RecoverableSignatureNoneZ } from '../structs/Result_RecoverableSignatureNoneZ.mjs';
140 import { Result_CVec_CVec_u8ZZNoneZ } from '../structs/Result_CVec_CVec_u8ZZNoneZ.mjs';
141 import { InMemorySigner } from '../structs/InMemorySigner.mjs';
142 import { Result_InMemorySignerDecodeErrorZ } from '../structs/Result_InMemorySignerDecodeErrorZ.mjs';
143 import { Result_TransactionNoneZ } from '../structs/Result_TransactionNoneZ.mjs';
144 import { Option_u16Z } from '../structs/Option_u16Z.mjs';
145 import { APIError } from '../structs/APIError.mjs';
146 import { Result_NoneAPIErrorZ } from '../structs/Result_NoneAPIErrorZ.mjs';
147 import { Result__u832APIErrorZ } from '../structs/Result__u832APIErrorZ.mjs';
148 import { PaymentSendFailure } from '../structs/PaymentSendFailure.mjs';
149 import { Result_PaymentIdPaymentSendFailureZ } from '../structs/Result_PaymentIdPaymentSendFailureZ.mjs';
150 import { Result_NonePaymentSendFailureZ } from '../structs/Result_NonePaymentSendFailureZ.mjs';
151 import { TwoTuple_PaymentHashPaymentIdZ } from '../structs/TwoTuple_PaymentHashPaymentIdZ.mjs';
152 import { Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ } from '../structs/Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ.mjs';
153 import { NetAddress } from '../structs/NetAddress.mjs';
154 import { TwoTuple_PaymentHashPaymentSecretZ } from '../structs/TwoTuple_PaymentHashPaymentSecretZ.mjs';
155 import { Result_C2Tuple_PaymentHashPaymentSecretZNoneZ } from '../structs/Result_C2Tuple_PaymentHashPaymentSecretZNoneZ.mjs';
156 import { Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ } from '../structs/Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ.mjs';
157 import { Result_PaymentSecretNoneZ } from '../structs/Result_PaymentSecretNoneZ.mjs';
158 import { Result_PaymentSecretAPIErrorZ } from '../structs/Result_PaymentSecretAPIErrorZ.mjs';
159 import { Result_PaymentPreimageAPIErrorZ } from '../structs/Result_PaymentPreimageAPIErrorZ.mjs';
160 import { CounterpartyForwardingInfo } from '../structs/CounterpartyForwardingInfo.mjs';
161 import { Result_CounterpartyForwardingInfoDecodeErrorZ } from '../structs/Result_CounterpartyForwardingInfoDecodeErrorZ.mjs';
162 import { ChannelCounterparty } from '../structs/ChannelCounterparty.mjs';
163 import { Result_ChannelCounterpartyDecodeErrorZ } from '../structs/Result_ChannelCounterpartyDecodeErrorZ.mjs';
164 import { Result_ChannelDetailsDecodeErrorZ } from '../structs/Result_ChannelDetailsDecodeErrorZ.mjs';
165 import { PhantomRouteHints } from '../structs/PhantomRouteHints.mjs';
166 import { Result_PhantomRouteHintsDecodeErrorZ } from '../structs/Result_PhantomRouteHintsDecodeErrorZ.mjs';
167 import { ChannelMonitor } from '../structs/ChannelMonitor.mjs';
168 import { ChannelMonitorUpdate } from '../structs/ChannelMonitorUpdate.mjs';
169 import { Watch, WatchInterface } from '../structs/Watch.mjs';
170 import { BroadcasterInterface, BroadcasterInterfaceInterface } from '../structs/BroadcasterInterface.mjs';
171 import { KeysInterface, KeysInterfaceInterface } from '../structs/KeysInterface.mjs';
172 import { FeeEstimator, FeeEstimatorInterface } from '../structs/FeeEstimator.mjs';
173 import { Record } from '../structs/Record.mjs';
174 import { Logger, LoggerInterface } from '../structs/Logger.mjs';
175 import { ChannelManager } from '../structs/ChannelManager.mjs';
176 import { TwoTuple_BlockHashChannelManagerZ } from '../structs/TwoTuple_BlockHashChannelManagerZ.mjs';
177 import { Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ } from '../structs/Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.mjs';
178 import { ChannelConfig } from '../structs/ChannelConfig.mjs';
179 import { Result_ChannelConfigDecodeErrorZ } from '../structs/Result_ChannelConfigDecodeErrorZ.mjs';
180 import { Result_OutPointDecodeErrorZ } from '../structs/Result_OutPointDecodeErrorZ.mjs';
181 import { Type, TypeInterface } from '../structs/Type.mjs';
182 import { Option_TypeZ } from '../structs/Option_TypeZ.mjs';
183 import { Result_COption_TypeZDecodeErrorZ } from '../structs/Result_COption_TypeZDecodeErrorZ.mjs';
184 import { PaymentError } from '../structs/PaymentError.mjs';
185 import { Result_PaymentIdPaymentErrorZ } from '../structs/Result_PaymentIdPaymentErrorZ.mjs';
186 import { Result_SiPrefixNoneZ } from '../structs/Result_SiPrefixNoneZ.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';
340
341 import { CommonBase, UInt5 } from './CommonBase.mjs';
342 import * as bindings from '../bindings.mjs'
343
344
345 /**
346  * Represents a syntactically and semantically correct lightning BOLT11 invoice.
347  * 
348  * There are three ways to construct an `Invoice`:
349  * 1. using `InvoiceBuilder`
350  * 2. using `Invoice::from_signed(SignedRawInvoice)`
351  * 3. using `str::parse::<Invoice>(&str)`
352  */
353 export class Invoice extends CommonBase {
354         /* @internal */
355         public constructor(_dummy: object, ptr: number) {
356                 super(ptr, bindings.Invoice_free);
357         }
358
359         /**
360          * Checks if two Invoices contain equal inner contents.
361          * This ignores pointers and is_owned flags and looks at the values in fields.
362          * Two objects with NULL inner values will be considered "equal" here.
363          */
364         public eq(b: Invoice): boolean {
365                 const ret: boolean = bindings.Invoice_eq(this.ptr, b == null ? 0 : CommonBase.get_ptr_of(b) & ~1);
366                 CommonBase.add_ref_from(this, b);
367                 return ret;
368         }
369
370         public clone_ptr(): number {
371                 const ret: number = bindings.Invoice_clone_ptr(this.ptr);
372                 return ret;
373         }
374
375         /**
376          * Creates a copy of the Invoice
377          */
378         public clone(): Invoice {
379                 const ret: number = bindings.Invoice_clone(this.ptr);
380                 const ret_hu_conv: Invoice = new Invoice(null, ret);
381                 CommonBase.add_ref_from(ret_hu_conv, this);
382                 return ret_hu_conv;
383         }
384
385         /**
386          * Transform the `Invoice` into it's unchecked version
387          */
388         public into_signed_raw(): SignedRawInvoice {
389                 const ret: number = bindings.Invoice_into_signed_raw(this.ptr);
390                 const ret_hu_conv: SignedRawInvoice = new SignedRawInvoice(null, ret);
391                 CommonBase.add_ref_from(ret_hu_conv, this);
392                 return ret_hu_conv;
393         }
394
395         /**
396          * Check that the invoice is signed correctly and that key recovery works
397          */
398         public check_signature(): Result_NoneSemanticErrorZ {
399                 const ret: number = bindings.Invoice_check_signature(this.ptr);
400                 const ret_hu_conv: Result_NoneSemanticErrorZ = Result_NoneSemanticErrorZ.constr_from_ptr(ret);
401                 return ret_hu_conv;
402         }
403
404         /**
405          * Constructs an `Invoice` from a `SignedRawInvoice` by checking all its invariants.
406          * ```
407          * use lightning_invoice::*;
408          * 
409          * let invoice = \"lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\\
410          * h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\\
411          * 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\\
412          * h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\\
413          * j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\\
414          * ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\\
415          * guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\\
416          * ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\\
417          * p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\\
418          * 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\\
419          * j5r6drg6k6zcqj0fcwg\";
420          * 
421          * let signed = invoice.parse::<SignedRawInvoice>().unwrap();
422          * 
423          * assert!(Invoice::from_signed(signed).is_ok());
424          * ```
425          */
426         public static constructor_from_signed(signed_invoice: SignedRawInvoice): Result_InvoiceSemanticErrorZ {
427                 const ret: number = bindings.Invoice_from_signed(signed_invoice == null ? 0 : CommonBase.get_ptr_of(signed_invoice) & ~1);
428                 const ret_hu_conv: Result_InvoiceSemanticErrorZ = Result_InvoiceSemanticErrorZ.constr_from_ptr(ret);
429                 return ret_hu_conv;
430         }
431
432         /**
433          * Returns the `Invoice`'s timestamp as a duration since the Unix epoch
434          */
435         public duration_since_epoch(): bigint {
436                 const ret: bigint = bindings.Invoice_duration_since_epoch(this.ptr);
437                 return ret;
438         }
439
440         /**
441          * Returns the hash to which we will receive the preimage on completion of the payment
442          */
443         public payment_hash(): Uint8Array {
444                 const ret: number = bindings.Invoice_payment_hash(this.ptr);
445                 const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
446                 return ret_conv;
447         }
448
449         /**
450          * Get the payee's public key if one was included in the invoice
451          * 
452          * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
453          */
454         public payee_pub_key(): Uint8Array {
455                 const ret: number = bindings.Invoice_payee_pub_key(this.ptr);
456                 const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
457                 return ret_conv;
458         }
459
460         /**
461          * Get the payment secret if one was included in the invoice
462          */
463         public payment_secret(): Uint8Array {
464                 const ret: number = bindings.Invoice_payment_secret(this.ptr);
465                 const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
466                 return ret_conv;
467         }
468
469         /**
470          * Get the invoice features if they were included in the invoice
471          * 
472          * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
473          */
474         public features(): InvoiceFeatures {
475                 const ret: number = bindings.Invoice_features(this.ptr);
476                 const ret_hu_conv: InvoiceFeatures = new InvoiceFeatures(null, ret);
477                 CommonBase.add_ref_from(ret_hu_conv, this);
478                 return ret_hu_conv;
479         }
480
481         /**
482          * Recover the payee's public key (only to be used if none was included in the invoice)
483          */
484         public recover_payee_pub_key(): Uint8Array {
485                 const ret: number = bindings.Invoice_recover_payee_pub_key(this.ptr);
486                 const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
487                 return ret_conv;
488         }
489
490         /**
491          * Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
492          */
493         public expiry_time(): bigint {
494                 const ret: bigint = bindings.Invoice_expiry_time(this.ptr);
495                 return ret;
496         }
497
498         /**
499          * Returns whether the expiry time would pass at the given point in time.
500          * `at_time` is the timestamp as a duration since the Unix epoch.
501          */
502         public would_expire(at_time: bigint): boolean {
503                 const ret: boolean = bindings.Invoice_would_expire(this.ptr, at_time);
504                 return ret;
505         }
506
507         /**
508          * Returns the invoice's `min_final_cltv_expiry` time, if present, otherwise
509          * [`DEFAULT_MIN_FINAL_CLTV_EXPIRY`].
510          */
511         public min_final_cltv_expiry(): bigint {
512                 const ret: bigint = bindings.Invoice_min_final_cltv_expiry(this.ptr);
513                 return ret;
514         }
515
516         /**
517          * Returns a list of all routes included in the invoice
518          */
519         public private_routes(): PrivateRoute[] {
520                 const ret: number = bindings.Invoice_private_routes(this.ptr);
521                 const ret_conv_14_len: number = bindings.getArrayLength(ret);
522                 const ret_conv_14_arr: PrivateRoute[] = new Array(ret_conv_14_len).fill(null);
523                 for (var o = 0; o < ret_conv_14_len; o++) {
524                         const ret_conv_14: number = bindings.getU32ArrayElem(ret, o);
525                         const ret_conv_14_hu_conv: PrivateRoute = new PrivateRoute(null, ret_conv_14);
526                         CommonBase.add_ref_from(ret_conv_14_hu_conv, this);
527                         ret_conv_14_arr[o] = ret_conv_14_hu_conv;
528                 }
529                 bindings.freeWasmMemory(ret)
530                 return ret_conv_14_arr;
531         }
532
533         /**
534          * Returns a list of all routes included in the invoice as the underlying hints
535          */
536         public route_hints(): RouteHint[] {
537                 const ret: number = bindings.Invoice_route_hints(this.ptr);
538                 const ret_conv_11_len: number = bindings.getArrayLength(ret);
539                 const ret_conv_11_arr: RouteHint[] = new Array(ret_conv_11_len).fill(null);
540                 for (var l = 0; l < ret_conv_11_len; l++) {
541                         const ret_conv_11: number = bindings.getU32ArrayElem(ret, l);
542                         const ret_conv_11_hu_conv: RouteHint = new RouteHint(null, ret_conv_11);
543                         CommonBase.add_ref_from(ret_conv_11_hu_conv, this);
544                         ret_conv_11_arr[l] = ret_conv_11_hu_conv;
545                 }
546                 bindings.freeWasmMemory(ret)
547                 return ret_conv_11_arr;
548         }
549
550         /**
551          * Returns the currency for which the invoice was issued
552          */
553         public currency(): Currency {
554                 const ret: Currency = bindings.Invoice_currency(this.ptr);
555                 return ret;
556         }
557
558         /**
559          * Returns the amount if specified in the invoice as millisatoshis.
560          */
561         public amount_milli_satoshis(): Option_u64Z {
562                 const ret: number = bindings.Invoice_amount_milli_satoshis(this.ptr);
563                 const ret_hu_conv: Option_u64Z = Option_u64Z.constr_from_ptr(ret);
564                 CommonBase.add_ref_from(ret_hu_conv, this);
565                 return ret_hu_conv;
566         }
567
568         /**
569          * Read a Invoice object from a string
570          */
571         public static constructor_from_str(s: string): Result_InvoiceNoneZ {
572                 const ret: number = bindings.Invoice_from_str(bindings.encodeString(s));
573                 const ret_hu_conv: Result_InvoiceNoneZ = Result_InvoiceNoneZ.constr_from_ptr(ret);
574                 return ret_hu_conv;
575         }
576
577         /**
578          * Get the string representation of a Invoice object
579          */
580         public to_str(): string {
581                 const ret: number = bindings.Invoice_to_str(this.ptr);
582                 const ret_conv: string = bindings.decodeString(ret);
583                 return ret_conv;
584         }
585
586 }