1 import { TxOut } from '../structs/TxOut.mjs';
2 import { BigEndianScalar } from '../structs/BigEndianScalar.mjs';
3 import { AccessError } from '../enums/AccessError.mjs';
4 import { COption_NoneZ } from '../enums/COption_NoneZ.mjs';
5 import { ChannelMonitorUpdateStatus } from '../enums/ChannelMonitorUpdateStatus.mjs';
6 import { ConfirmationTarget } from '../enums/ConfirmationTarget.mjs';
7 import { CreationError } from '../enums/CreationError.mjs';
8 import { Currency } from '../enums/Currency.mjs';
9 import { HTLCClaim } from '../enums/HTLCClaim.mjs';
10 import { IOError } from '../enums/IOError.mjs';
11 import { Level } from '../enums/Level.mjs';
12 import { Network } from '../enums/Network.mjs';
13 import { Recipient } from '../enums/Recipient.mjs';
14 import { Secp256k1Error } from '../enums/Secp256k1Error.mjs';
15 import { SemanticError } from '../enums/SemanticError.mjs';
16 import { SiPrefix } from '../enums/SiPrefix.mjs';
17 import { Bech32Error } from '../structs/Bech32Error.mjs';
18 import { Option_HTLCClaimZ } from '../structs/Option_HTLCClaimZ.mjs';
19 import { Result_NoneNoneZ } from '../structs/Result_NoneNoneZ.mjs';
20 import { CounterpartyCommitmentSecrets } from '../structs/CounterpartyCommitmentSecrets.mjs';
21 import { DecodeError } from '../structs/DecodeError.mjs';
22 import { Result_CounterpartyCommitmentSecretsDecodeErrorZ } from '../structs/Result_CounterpartyCommitmentSecretsDecodeErrorZ.mjs';
23 import { TxCreationKeys } from '../structs/TxCreationKeys.mjs';
24 import { Result_TxCreationKeysDecodeErrorZ } from '../structs/Result_TxCreationKeysDecodeErrorZ.mjs';
25 import { ChannelPublicKeys } from '../structs/ChannelPublicKeys.mjs';
26 import { Result_ChannelPublicKeysDecodeErrorZ } from '../structs/Result_ChannelPublicKeysDecodeErrorZ.mjs';
27 import { Option_u32Z } from '../structs/Option_u32Z.mjs';
28 import { HTLCOutputInCommitment } from '../structs/HTLCOutputInCommitment.mjs';
29 import { Result_HTLCOutputInCommitmentDecodeErrorZ } from '../structs/Result_HTLCOutputInCommitmentDecodeErrorZ.mjs';
30 import { CounterpartyChannelTransactionParameters } from '../structs/CounterpartyChannelTransactionParameters.mjs';
31 import { Result_CounterpartyChannelTransactionParametersDecodeErrorZ } from '../structs/Result_CounterpartyChannelTransactionParametersDecodeErrorZ.mjs';
32 import { ChannelTransactionParameters } from '../structs/ChannelTransactionParameters.mjs';
33 import { Result_ChannelTransactionParametersDecodeErrorZ } from '../structs/Result_ChannelTransactionParametersDecodeErrorZ.mjs';
34 import { HolderCommitmentTransaction } from '../structs/HolderCommitmentTransaction.mjs';
35 import { Result_HolderCommitmentTransactionDecodeErrorZ } from '../structs/Result_HolderCommitmentTransactionDecodeErrorZ.mjs';
36 import { BuiltCommitmentTransaction } from '../structs/BuiltCommitmentTransaction.mjs';
37 import { Result_BuiltCommitmentTransactionDecodeErrorZ } from '../structs/Result_BuiltCommitmentTransactionDecodeErrorZ.mjs';
38 import { TrustedClosingTransaction } from '../structs/TrustedClosingTransaction.mjs';
39 import { Result_TrustedClosingTransactionNoneZ } from '../structs/Result_TrustedClosingTransactionNoneZ.mjs';
40 import { CommitmentTransaction } from '../structs/CommitmentTransaction.mjs';
41 import { Result_CommitmentTransactionDecodeErrorZ } from '../structs/Result_CommitmentTransactionDecodeErrorZ.mjs';
42 import { TrustedCommitmentTransaction } from '../structs/TrustedCommitmentTransaction.mjs';
43 import { Result_TrustedCommitmentTransactionNoneZ } from '../structs/Result_TrustedCommitmentTransactionNoneZ.mjs';
44 import { Result_CVec_SignatureZNoneZ } from '../structs/Result_CVec_SignatureZNoneZ.mjs';
45 import { ShutdownScript } from '../structs/ShutdownScript.mjs';
46 import { Result_ShutdownScriptDecodeErrorZ } from '../structs/Result_ShutdownScriptDecodeErrorZ.mjs';
47 import { InvalidShutdownScript } from '../structs/InvalidShutdownScript.mjs';
48 import { Result_ShutdownScriptInvalidShutdownScriptZ } from '../structs/Result_ShutdownScriptInvalidShutdownScriptZ.mjs';
49 import { BlindedPath } from '../structs/BlindedPath.mjs';
50 import { Result_BlindedPathNoneZ } from '../structs/Result_BlindedPathNoneZ.mjs';
51 import { Result_BlindedPathDecodeErrorZ } from '../structs/Result_BlindedPathDecodeErrorZ.mjs';
52 import { BlindedHop } from '../structs/BlindedHop.mjs';
53 import { Result_BlindedHopDecodeErrorZ } from '../structs/Result_BlindedHopDecodeErrorZ.mjs';
54 import { ChannelDetails } from '../structs/ChannelDetails.mjs';
55 import { Route } from '../structs/Route.mjs';
56 import { LightningError } from '../structs/LightningError.mjs';
57 import { Result_RouteLightningErrorZ } from '../structs/Result_RouteLightningErrorZ.mjs';
58 import { RouteHop } from '../structs/RouteHop.mjs';
59 import { Option_u64Z } from '../structs/Option_u64Z.mjs';
60 import { InFlightHtlcs } from '../structs/InFlightHtlcs.mjs';
61 import { Result_InFlightHtlcsDecodeErrorZ } from '../structs/Result_InFlightHtlcsDecodeErrorZ.mjs';
62 import { Result_RouteHopDecodeErrorZ } from '../structs/Result_RouteHopDecodeErrorZ.mjs';
63 import { Result_RouteDecodeErrorZ } from '../structs/Result_RouteDecodeErrorZ.mjs';
64 import { RouteParameters } from '../structs/RouteParameters.mjs';
65 import { Result_RouteParametersDecodeErrorZ } from '../structs/Result_RouteParametersDecodeErrorZ.mjs';
66 import { RouteHint } from '../structs/RouteHint.mjs';
67 import { PaymentParameters } from '../structs/PaymentParameters.mjs';
68 import { Result_PaymentParametersDecodeErrorZ } from '../structs/Result_PaymentParametersDecodeErrorZ.mjs';
69 import { RouteHintHop } from '../structs/RouteHintHop.mjs';
70 import { Result_RouteHintDecodeErrorZ } from '../structs/Result_RouteHintDecodeErrorZ.mjs';
71 import { Result_RouteHintHopDecodeErrorZ } from '../structs/Result_RouteHintHopDecodeErrorZ.mjs';
72 import { PaymentPurpose } from '../structs/PaymentPurpose.mjs';
73 import { Result_PaymentPurposeDecodeErrorZ } from '../structs/Result_PaymentPurposeDecodeErrorZ.mjs';
74 import { ClosureReason } from '../structs/ClosureReason.mjs';
75 import { Option_ClosureReasonZ } from '../structs/Option_ClosureReasonZ.mjs';
76 import { Result_COption_ClosureReasonZDecodeErrorZ } from '../structs/Result_COption_ClosureReasonZDecodeErrorZ.mjs';
77 import { HTLCDestination } from '../structs/HTLCDestination.mjs';
78 import { Option_HTLCDestinationZ } from '../structs/Option_HTLCDestinationZ.mjs';
79 import { Result_COption_HTLCDestinationZDecodeErrorZ } from '../structs/Result_COption_HTLCDestinationZDecodeErrorZ.mjs';
80 import { Option_u128Z } from '../structs/Option_u128Z.mjs';
81 import { ChannelUpdate } from '../structs/ChannelUpdate.mjs';
82 import { NetworkUpdate } from '../structs/NetworkUpdate.mjs';
83 import { Option_NetworkUpdateZ } from '../structs/Option_NetworkUpdateZ.mjs';
84 import { OutPoint } from '../structs/OutPoint.mjs';
85 import { DelayedPaymentOutputDescriptor } from '../structs/DelayedPaymentOutputDescriptor.mjs';
86 import { StaticPaymentOutputDescriptor } from '../structs/StaticPaymentOutputDescriptor.mjs';
87 import { SpendableOutputDescriptor } from '../structs/SpendableOutputDescriptor.mjs';
88 import { ChannelTypeFeatures } from '../structs/ChannelTypeFeatures.mjs';
89 import { Event } from '../structs/Event.mjs';
90 import { Option_EventZ } from '../structs/Option_EventZ.mjs';
91 import { Result_COption_EventZDecodeErrorZ } from '../structs/Result_COption_EventZDecodeErrorZ.mjs';
92 import { AcceptChannel } from '../structs/AcceptChannel.mjs';
93 import { OpenChannel } from '../structs/OpenChannel.mjs';
94 import { FundingCreated } from '../structs/FundingCreated.mjs';
95 import { FundingSigned } from '../structs/FundingSigned.mjs';
96 import { ChannelReady } from '../structs/ChannelReady.mjs';
97 import { AnnouncementSignatures } from '../structs/AnnouncementSignatures.mjs';
98 import { CommitmentUpdate } from '../structs/CommitmentUpdate.mjs';
99 import { RevokeAndACK } from '../structs/RevokeAndACK.mjs';
100 import { ClosingSigned } from '../structs/ClosingSigned.mjs';
101 import { Shutdown } from '../structs/Shutdown.mjs';
102 import { ChannelReestablish } from '../structs/ChannelReestablish.mjs';
103 import { ChannelAnnouncement } from '../structs/ChannelAnnouncement.mjs';
104 import { ErrorMessage } from '../structs/ErrorMessage.mjs';
105 import { WarningMessage } from '../structs/WarningMessage.mjs';
106 import { ErrorAction } from '../structs/ErrorAction.mjs';
107 import { QueryChannelRange } from '../structs/QueryChannelRange.mjs';
108 import { QueryShortChannelIds } from '../structs/QueryShortChannelIds.mjs';
109 import { ReplyChannelRange } from '../structs/ReplyChannelRange.mjs';
110 import { GossipTimestampFilter } from '../structs/GossipTimestampFilter.mjs';
111 import { MessageSendEvent } from '../structs/MessageSendEvent.mjs';
112 import { Result_TxOutAccessErrorZ } from '../structs/Result_TxOutAccessErrorZ.mjs';
113 import { TwoTuple_usizeTransactionZ } from '../structs/TwoTuple_usizeTransactionZ.mjs';
114 import { TwoTuple_TxidBlockHashZ } from '../structs/TwoTuple_TxidBlockHashZ.mjs';
115 import { HTLCUpdate } from '../structs/HTLCUpdate.mjs';
116 import { MonitorEvent } from '../structs/MonitorEvent.mjs';
117 import { ThreeTuple_OutPointCVec_MonitorEventZPublicKeyZ } from '../structs/ThreeTuple_OutPointCVec_MonitorEventZPublicKeyZ.mjs';
118 import { FixedPenaltyScorer } from '../structs/FixedPenaltyScorer.mjs';
119 import { Result_FixedPenaltyScorerDecodeErrorZ } from '../structs/Result_FixedPenaltyScorerDecodeErrorZ.mjs';
120 import { TwoTuple_u64u64Z } from '../structs/TwoTuple_u64u64Z.mjs';
121 import { Option_C2Tuple_u64u64ZZ } from '../structs/Option_C2Tuple_u64u64ZZ.mjs';
122 import { NodeId } from '../structs/NodeId.mjs';
123 import { Record } from '../structs/Record.mjs';
124 import { Logger, LoggerInterface } from '../structs/Logger.mjs';
125 import { NetworkGraph } from '../structs/NetworkGraph.mjs';
126 import { ProbabilisticScorer } from '../structs/ProbabilisticScorer.mjs';
127 import { Result_ProbabilisticScorerDecodeErrorZ } from '../structs/Result_ProbabilisticScorerDecodeErrorZ.mjs';
128 import { InitFeatures } from '../structs/InitFeatures.mjs';
129 import { Result_InitFeaturesDecodeErrorZ } from '../structs/Result_InitFeaturesDecodeErrorZ.mjs';
130 import { ChannelFeatures } from '../structs/ChannelFeatures.mjs';
131 import { Result_ChannelFeaturesDecodeErrorZ } from '../structs/Result_ChannelFeaturesDecodeErrorZ.mjs';
132 import { NodeFeatures } from '../structs/NodeFeatures.mjs';
133 import { Result_NodeFeaturesDecodeErrorZ } from '../structs/Result_NodeFeaturesDecodeErrorZ.mjs';
134 import { InvoiceFeatures } from '../structs/InvoiceFeatures.mjs';
135 import { Result_InvoiceFeaturesDecodeErrorZ } from '../structs/Result_InvoiceFeaturesDecodeErrorZ.mjs';
136 import { Result_ChannelTypeFeaturesDecodeErrorZ } from '../structs/Result_ChannelTypeFeaturesDecodeErrorZ.mjs';
137 import { OfferFeatures } from '../structs/OfferFeatures.mjs';
138 import { Result_OfferFeaturesDecodeErrorZ } from '../structs/Result_OfferFeaturesDecodeErrorZ.mjs';
139 import { InvoiceRequestFeatures } from '../structs/InvoiceRequestFeatures.mjs';
140 import { Result_InvoiceRequestFeaturesDecodeErrorZ } from '../structs/Result_InvoiceRequestFeaturesDecodeErrorZ.mjs';
141 import { Result_NodeIdDecodeErrorZ } from '../structs/Result_NodeIdDecodeErrorZ.mjs';
142 import { Result_COption_NetworkUpdateZDecodeErrorZ } from '../structs/Result_COption_NetworkUpdateZDecodeErrorZ.mjs';
143 import { Access, AccessInterface } from '../structs/Access.mjs';
144 import { Option_AccessZ } from '../structs/Option_AccessZ.mjs';
145 import { Result_boolLightningErrorZ } from '../structs/Result_boolLightningErrorZ.mjs';
146 import { ThreeTuple_ChannelAnnouncementChannelUpdateChannelUpdateZ } from '../structs/ThreeTuple_ChannelAnnouncementChannelUpdateChannelUpdateZ.mjs';
147 import { Option_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ } from '../structs/Option_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ.mjs';
148 import { Result_NoneLightningErrorZ } from '../structs/Result_NoneLightningErrorZ.mjs';
149 import { ChannelUpdateInfo } from '../structs/ChannelUpdateInfo.mjs';
150 import { Result_ChannelUpdateInfoDecodeErrorZ } from '../structs/Result_ChannelUpdateInfoDecodeErrorZ.mjs';
151 import { ChannelInfo } from '../structs/ChannelInfo.mjs';
152 import { Result_ChannelInfoDecodeErrorZ } from '../structs/Result_ChannelInfoDecodeErrorZ.mjs';
153 import { RoutingFees } from '../structs/RoutingFees.mjs';
154 import { Result_RoutingFeesDecodeErrorZ } from '../structs/Result_RoutingFeesDecodeErrorZ.mjs';
155 import { Hostname } from '../structs/Hostname.mjs';
156 import { NetAddress } from '../structs/NetAddress.mjs';
157 import { NodeAnnouncementInfo } from '../structs/NodeAnnouncementInfo.mjs';
158 import { Result_NodeAnnouncementInfoDecodeErrorZ } from '../structs/Result_NodeAnnouncementInfoDecodeErrorZ.mjs';
159 import { NodeAlias } from '../structs/NodeAlias.mjs';
160 import { Result_NodeAliasDecodeErrorZ } from '../structs/Result_NodeAliasDecodeErrorZ.mjs';
161 import { NodeInfo } from '../structs/NodeInfo.mjs';
162 import { Result_NodeInfoDecodeErrorZ } from '../structs/Result_NodeInfoDecodeErrorZ.mjs';
163 import { Result_NetworkGraphDecodeErrorZ } from '../structs/Result_NetworkGraphDecodeErrorZ.mjs';
164 import { Option_CVec_NetAddressZZ } from '../structs/Option_CVec_NetAddressZZ.mjs';
165 import { Result_DelayedPaymentOutputDescriptorDecodeErrorZ } from '../structs/Result_DelayedPaymentOutputDescriptorDecodeErrorZ.mjs';
166 import { Result_StaticPaymentOutputDescriptorDecodeErrorZ } from '../structs/Result_StaticPaymentOutputDescriptorDecodeErrorZ.mjs';
167 import { Result_SpendableOutputDescriptorDecodeErrorZ } from '../structs/Result_SpendableOutputDescriptorDecodeErrorZ.mjs';
168 import { TwoTuple_SignatureCVec_SignatureZZ } from '../structs/TwoTuple_SignatureCVec_SignatureZZ.mjs';
169 import { Result_C2Tuple_SignatureCVec_SignatureZZNoneZ } from '../structs/Result_C2Tuple_SignatureCVec_SignatureZZNoneZ.mjs';
170 import { Result_SignatureNoneZ } from '../structs/Result_SignatureNoneZ.mjs';
171 import { TwoTuple_SignatureSignatureZ } from '../structs/TwoTuple_SignatureSignatureZ.mjs';
172 import { Result_C2Tuple_SignatureSignatureZNoneZ } from '../structs/Result_C2Tuple_SignatureSignatureZNoneZ.mjs';
173 import { Result_SecretKeyNoneZ } from '../structs/Result_SecretKeyNoneZ.mjs';
174 import { Result_PublicKeyNoneZ } from '../structs/Result_PublicKeyNoneZ.mjs';
175 import { Option_ScalarZ } from '../structs/Option_ScalarZ.mjs';
176 import { Result_SharedSecretNoneZ } from '../structs/Result_SharedSecretNoneZ.mjs';
177 import { ClosingTransaction } from '../structs/ClosingTransaction.mjs';
178 import { UnsignedChannelAnnouncement } from '../structs/UnsignedChannelAnnouncement.mjs';
179 import { BaseSign, BaseSignInterface } from '../structs/BaseSign.mjs';
180 import { Sign, SignInterface } from '../structs/Sign.mjs';
181 import { Result_SignDecodeErrorZ } from '../structs/Result_SignDecodeErrorZ.mjs';
182 import { Result_RecoverableSignatureNoneZ } from '../structs/Result_RecoverableSignatureNoneZ.mjs';
183 import { Result_CVec_CVec_u8ZZNoneZ } from '../structs/Result_CVec_CVec_u8ZZNoneZ.mjs';
184 import { InMemorySigner } from '../structs/InMemorySigner.mjs';
185 import { Result_InMemorySignerDecodeErrorZ } from '../structs/Result_InMemorySignerDecodeErrorZ.mjs';
186 import { Result_TransactionNoneZ } from '../structs/Result_TransactionNoneZ.mjs';
187 import { Option_u16Z } from '../structs/Option_u16Z.mjs';
188 import { APIError } from '../structs/APIError.mjs';
189 import { Result_NoneAPIErrorZ } from '../structs/Result_NoneAPIErrorZ.mjs';
190 import { Result__u832APIErrorZ } from '../structs/Result__u832APIErrorZ.mjs';
191 import { PaymentSendFailure } from '../structs/PaymentSendFailure.mjs';
192 import { Result_NonePaymentSendFailureZ } from '../structs/Result_NonePaymentSendFailureZ.mjs';
193 import { Result_PaymentHashPaymentSendFailureZ } from '../structs/Result_PaymentHashPaymentSendFailureZ.mjs';
194 import { TwoTuple_PaymentHashPaymentIdZ } from '../structs/TwoTuple_PaymentHashPaymentIdZ.mjs';
195 import { Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ } from '../structs/Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ.mjs';
196 import { TwoTuple_PaymentHashPaymentSecretZ } from '../structs/TwoTuple_PaymentHashPaymentSecretZ.mjs';
197 import { Result_C2Tuple_PaymentHashPaymentSecretZNoneZ } from '../structs/Result_C2Tuple_PaymentHashPaymentSecretZNoneZ.mjs';
198 import { Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ } from '../structs/Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ.mjs';
199 import { Result_PaymentSecretNoneZ } from '../structs/Result_PaymentSecretNoneZ.mjs';
200 import { Result_PaymentSecretAPIErrorZ } from '../structs/Result_PaymentSecretAPIErrorZ.mjs';
201 import { Result_PaymentPreimageAPIErrorZ } from '../structs/Result_PaymentPreimageAPIErrorZ.mjs';
202 import { CounterpartyForwardingInfo } from '../structs/CounterpartyForwardingInfo.mjs';
203 import { Result_CounterpartyForwardingInfoDecodeErrorZ } from '../structs/Result_CounterpartyForwardingInfoDecodeErrorZ.mjs';
204 import { ChannelCounterparty } from '../structs/ChannelCounterparty.mjs';
205 import { Result_ChannelCounterpartyDecodeErrorZ } from '../structs/Result_ChannelCounterpartyDecodeErrorZ.mjs';
206 import { Result_ChannelDetailsDecodeErrorZ } from '../structs/Result_ChannelDetailsDecodeErrorZ.mjs';
207 import { PhantomRouteHints } from '../structs/PhantomRouteHints.mjs';
208 import { Result_PhantomRouteHintsDecodeErrorZ } from '../structs/Result_PhantomRouteHintsDecodeErrorZ.mjs';
209 import { ChannelMonitor } from '../structs/ChannelMonitor.mjs';
210 import { ChannelMonitorUpdate } from '../structs/ChannelMonitorUpdate.mjs';
211 import { Watch, WatchInterface } from '../structs/Watch.mjs';
212 import { BroadcasterInterface, BroadcasterInterfaceInterface } from '../structs/BroadcasterInterface.mjs';
213 import { KeysInterface, KeysInterfaceInterface } from '../structs/KeysInterface.mjs';
214 import { FeeEstimator, FeeEstimatorInterface } from '../structs/FeeEstimator.mjs';
215 import { ChannelManager } from '../structs/ChannelManager.mjs';
216 import { TwoTuple_BlockHashChannelManagerZ } from '../structs/TwoTuple_BlockHashChannelManagerZ.mjs';
217 import { Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ } from '../structs/Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.mjs';
218 import { ChannelConfig } from '../structs/ChannelConfig.mjs';
219 import { Result_ChannelConfigDecodeErrorZ } from '../structs/Result_ChannelConfigDecodeErrorZ.mjs';
220 import { Result_OutPointDecodeErrorZ } from '../structs/Result_OutPointDecodeErrorZ.mjs';
221 import { Type, TypeInterface } from '../structs/Type.mjs';
222 import { Option_TypeZ } from '../structs/Option_TypeZ.mjs';
223 import { Result_COption_TypeZDecodeErrorZ } from '../structs/Result_COption_TypeZDecodeErrorZ.mjs';
224 import { PaymentError } from '../structs/PaymentError.mjs';
225 import { Result_PaymentIdPaymentErrorZ } from '../structs/Result_PaymentIdPaymentErrorZ.mjs';
226 import { Result_NonePaymentErrorZ } from '../structs/Result_NonePaymentErrorZ.mjs';
227 import { Result_StringErrorZ } from '../structs/Result_StringErrorZ.mjs';
228 import { Result_PublicKeyErrorZ } from '../structs/Result_PublicKeyErrorZ.mjs';
229 import { Result_ChannelMonitorUpdateDecodeErrorZ } from '../structs/Result_ChannelMonitorUpdateDecodeErrorZ.mjs';
230 import { Option_MonitorEventZ } from '../structs/Option_MonitorEventZ.mjs';
231 import { Result_COption_MonitorEventZDecodeErrorZ } from '../structs/Result_COption_MonitorEventZDecodeErrorZ.mjs';
232 import { Result_HTLCUpdateDecodeErrorZ } from '../structs/Result_HTLCUpdateDecodeErrorZ.mjs';
233 import { TwoTuple_OutPointScriptZ } from '../structs/TwoTuple_OutPointScriptZ.mjs';
234 import { TwoTuple_u32ScriptZ } from '../structs/TwoTuple_u32ScriptZ.mjs';
235 import { TwoTuple_TxidCVec_C2Tuple_u32ScriptZZZ } from '../structs/TwoTuple_TxidCVec_C2Tuple_u32ScriptZZZ.mjs';
236 import { TwoTuple_u32TxOutZ } from '../structs/TwoTuple_u32TxOutZ.mjs';
237 import { TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ } from '../structs/TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ.mjs';
238 import { Balance } from '../structs/Balance.mjs';
239 import { TwoTuple_BlockHashChannelMonitorZ } from '../structs/TwoTuple_BlockHashChannelMonitorZ.mjs';
240 import { Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ } from '../structs/Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.mjs';
241 import { TwoTuple_PublicKeyTypeZ } from '../structs/TwoTuple_PublicKeyTypeZ.mjs';
242 import { CustomOnionMessageContents, CustomOnionMessageContentsInterface } from '../structs/CustomOnionMessageContents.mjs';
243 import { Option_CustomOnionMessageContentsZ } from '../structs/Option_CustomOnionMessageContentsZ.mjs';
244 import { Result_COption_CustomOnionMessageContentsZDecodeErrorZ } from '../structs/Result_COption_CustomOnionMessageContentsZDecodeErrorZ.mjs';
245 import { Option_NetAddressZ } from '../structs/Option_NetAddressZ.mjs';
246 import { PeerHandleError } from '../structs/PeerHandleError.mjs';
247 import { Result_CVec_u8ZPeerHandleErrorZ } from '../structs/Result_CVec_u8ZPeerHandleErrorZ.mjs';
248 import { Result_NonePeerHandleErrorZ } from '../structs/Result_NonePeerHandleErrorZ.mjs';
249 import { Result_boolPeerHandleErrorZ } from '../structs/Result_boolPeerHandleErrorZ.mjs';
250 import { SendError } from '../structs/SendError.mjs';
251 import { Result_NoneSendErrorZ } from '../structs/Result_NoneSendErrorZ.mjs';
252 import { GraphSyncError } from '../structs/GraphSyncError.mjs';
253 import { Result_u32GraphSyncErrorZ } from '../structs/Result_u32GraphSyncErrorZ.mjs';
254 import { ParseError } from '../structs/ParseError.mjs';
255 import { Result_SiPrefixParseErrorZ } from '../structs/Result_SiPrefixParseErrorZ.mjs';
256 import { Invoice } from '../structs/Invoice.mjs';
257 import { ParseOrSemanticError } from '../structs/ParseOrSemanticError.mjs';
258 import { Result_InvoiceParseOrSemanticErrorZ } from '../structs/Result_InvoiceParseOrSemanticErrorZ.mjs';
259 import { SignedRawInvoice } from '../structs/SignedRawInvoice.mjs';
260 import { Result_SignedRawInvoiceParseErrorZ } from '../structs/Result_SignedRawInvoiceParseErrorZ.mjs';
261 import { RawInvoice } from '../structs/RawInvoice.mjs';
262 import { InvoiceSignature } from '../structs/InvoiceSignature.mjs';
263 import { ThreeTuple_RawInvoice_u832InvoiceSignatureZ } from '../structs/ThreeTuple_RawInvoice_u832InvoiceSignatureZ.mjs';
264 import { PayeePubKey } from '../structs/PayeePubKey.mjs';
265 import { Result_PayeePubKeyErrorZ } from '../structs/Result_PayeePubKeyErrorZ.mjs';
266 import { PrivateRoute } from '../structs/PrivateRoute.mjs';
267 import { PositiveTimestamp } from '../structs/PositiveTimestamp.mjs';
268 import { Result_PositiveTimestampCreationErrorZ } from '../structs/Result_PositiveTimestampCreationErrorZ.mjs';
269 import { Result_NoneSemanticErrorZ } from '../structs/Result_NoneSemanticErrorZ.mjs';
270 import { Result_InvoiceSemanticErrorZ } from '../structs/Result_InvoiceSemanticErrorZ.mjs';
271 import { Description } from '../structs/Description.mjs';
272 import { Result_DescriptionCreationErrorZ } from '../structs/Result_DescriptionCreationErrorZ.mjs';
273 import { Result_PrivateRouteCreationErrorZ } from '../structs/Result_PrivateRouteCreationErrorZ.mjs';
274 import { Result_NoneErrorZ } from '../structs/Result_NoneErrorZ.mjs';
275 import { Result_NetAddressDecodeErrorZ } from '../structs/Result_NetAddressDecodeErrorZ.mjs';
276 import { UpdateAddHTLC } from '../structs/UpdateAddHTLC.mjs';
277 import { UpdateFulfillHTLC } from '../structs/UpdateFulfillHTLC.mjs';
278 import { UpdateFailHTLC } from '../structs/UpdateFailHTLC.mjs';
279 import { UpdateFailMalformedHTLC } from '../structs/UpdateFailMalformedHTLC.mjs';
280 import { Result_AcceptChannelDecodeErrorZ } from '../structs/Result_AcceptChannelDecodeErrorZ.mjs';
281 import { Result_AnnouncementSignaturesDecodeErrorZ } from '../structs/Result_AnnouncementSignaturesDecodeErrorZ.mjs';
282 import { Result_ChannelReestablishDecodeErrorZ } from '../structs/Result_ChannelReestablishDecodeErrorZ.mjs';
283 import { Result_ClosingSignedDecodeErrorZ } from '../structs/Result_ClosingSignedDecodeErrorZ.mjs';
284 import { ClosingSignedFeeRange } from '../structs/ClosingSignedFeeRange.mjs';
285 import { Result_ClosingSignedFeeRangeDecodeErrorZ } from '../structs/Result_ClosingSignedFeeRangeDecodeErrorZ.mjs';
286 import { CommitmentSigned } from '../structs/CommitmentSigned.mjs';
287 import { Result_CommitmentSignedDecodeErrorZ } from '../structs/Result_CommitmentSignedDecodeErrorZ.mjs';
288 import { Result_FundingCreatedDecodeErrorZ } from '../structs/Result_FundingCreatedDecodeErrorZ.mjs';
289 import { Result_FundingSignedDecodeErrorZ } from '../structs/Result_FundingSignedDecodeErrorZ.mjs';
290 import { Result_ChannelReadyDecodeErrorZ } from '../structs/Result_ChannelReadyDecodeErrorZ.mjs';
291 import { Init } from '../structs/Init.mjs';
292 import { Result_InitDecodeErrorZ } from '../structs/Result_InitDecodeErrorZ.mjs';
293 import { Result_OpenChannelDecodeErrorZ } from '../structs/Result_OpenChannelDecodeErrorZ.mjs';
294 import { Result_RevokeAndACKDecodeErrorZ } from '../structs/Result_RevokeAndACKDecodeErrorZ.mjs';
295 import { Result_ShutdownDecodeErrorZ } from '../structs/Result_ShutdownDecodeErrorZ.mjs';
296 import { Result_UpdateFailHTLCDecodeErrorZ } from '../structs/Result_UpdateFailHTLCDecodeErrorZ.mjs';
297 import { Result_UpdateFailMalformedHTLCDecodeErrorZ } from '../structs/Result_UpdateFailMalformedHTLCDecodeErrorZ.mjs';
298 import { UpdateFee } from '../structs/UpdateFee.mjs';
299 import { Result_UpdateFeeDecodeErrorZ } from '../structs/Result_UpdateFeeDecodeErrorZ.mjs';
300 import { Result_UpdateFulfillHTLCDecodeErrorZ } from '../structs/Result_UpdateFulfillHTLCDecodeErrorZ.mjs';
301 import { Result_UpdateAddHTLCDecodeErrorZ } from '../structs/Result_UpdateAddHTLCDecodeErrorZ.mjs';
302 import { OnionMessage } from '../structs/OnionMessage.mjs';
303 import { Result_OnionMessageDecodeErrorZ } from '../structs/Result_OnionMessageDecodeErrorZ.mjs';
304 import { Ping } from '../structs/Ping.mjs';
305 import { Result_PingDecodeErrorZ } from '../structs/Result_PingDecodeErrorZ.mjs';
306 import { Pong } from '../structs/Pong.mjs';
307 import { Result_PongDecodeErrorZ } from '../structs/Result_PongDecodeErrorZ.mjs';
308 import { Result_UnsignedChannelAnnouncementDecodeErrorZ } from '../structs/Result_UnsignedChannelAnnouncementDecodeErrorZ.mjs';
309 import { Result_ChannelAnnouncementDecodeErrorZ } from '../structs/Result_ChannelAnnouncementDecodeErrorZ.mjs';
310 import { UnsignedChannelUpdate } from '../structs/UnsignedChannelUpdate.mjs';
311 import { Result_UnsignedChannelUpdateDecodeErrorZ } from '../structs/Result_UnsignedChannelUpdateDecodeErrorZ.mjs';
312 import { Result_ChannelUpdateDecodeErrorZ } from '../structs/Result_ChannelUpdateDecodeErrorZ.mjs';
313 import { Result_ErrorMessageDecodeErrorZ } from '../structs/Result_ErrorMessageDecodeErrorZ.mjs';
314 import { Result_WarningMessageDecodeErrorZ } from '../structs/Result_WarningMessageDecodeErrorZ.mjs';
315 import { UnsignedNodeAnnouncement } from '../structs/UnsignedNodeAnnouncement.mjs';
316 import { Result_UnsignedNodeAnnouncementDecodeErrorZ } from '../structs/Result_UnsignedNodeAnnouncementDecodeErrorZ.mjs';
317 import { NodeAnnouncement } from '../structs/NodeAnnouncement.mjs';
318 import { Result_NodeAnnouncementDecodeErrorZ } from '../structs/Result_NodeAnnouncementDecodeErrorZ.mjs';
319 import { Result_QueryShortChannelIdsDecodeErrorZ } from '../structs/Result_QueryShortChannelIdsDecodeErrorZ.mjs';
320 import { ReplyShortChannelIdsEnd } from '../structs/ReplyShortChannelIdsEnd.mjs';
321 import { Result_ReplyShortChannelIdsEndDecodeErrorZ } from '../structs/Result_ReplyShortChannelIdsEndDecodeErrorZ.mjs';
322 import { Result_QueryChannelRangeDecodeErrorZ } from '../structs/Result_QueryChannelRangeDecodeErrorZ.mjs';
323 import { Result_ReplyChannelRangeDecodeErrorZ } from '../structs/Result_ReplyChannelRangeDecodeErrorZ.mjs';
324 import { Result_GossipTimestampFilterDecodeErrorZ } from '../structs/Result_GossipTimestampFilterDecodeErrorZ.mjs';
325 import { SignOrCreationError } from '../structs/SignOrCreationError.mjs';
326 import { Result_InvoiceSignOrCreationErrorZ } from '../structs/Result_InvoiceSignOrCreationErrorZ.mjs';
327 import { WatchedOutput } from '../structs/WatchedOutput.mjs';
328 import { Filter, FilterInterface } from '../structs/Filter.mjs';
329 import { Option_FilterZ } from '../structs/Option_FilterZ.mjs';
330 import { LockedChannelMonitor } from '../structs/LockedChannelMonitor.mjs';
331 import { Result_LockedChannelMonitorNoneZ } from '../structs/Result_LockedChannelMonitorNoneZ.mjs';
332 import { MonitorUpdateId } from '../structs/MonitorUpdateId.mjs';
333 import { TwoTuple_OutPointCVec_MonitorUpdateIdZZ } from '../structs/TwoTuple_OutPointCVec_MonitorUpdateIdZZ.mjs';
334 import { MessageSendEventsProvider, MessageSendEventsProviderInterface } from '../structs/MessageSendEventsProvider.mjs';
335 import { OnionMessageProvider, OnionMessageProviderInterface } from '../structs/OnionMessageProvider.mjs';
336 import { EventHandler, EventHandlerInterface } from '../structs/EventHandler.mjs';
337 import { EventsProvider, EventsProviderInterface } from '../structs/EventsProvider.mjs';
338 import { BigSize } from '../structs/BigSize.mjs';
339 import { ChannelUsage } from '../structs/ChannelUsage.mjs';
340 import { Score, ScoreInterface } from '../structs/Score.mjs';
341 import { LockableScore, LockableScoreInterface } from '../structs/LockableScore.mjs';
342 import { WriteableScore, WriteableScoreInterface } from '../structs/WriteableScore.mjs';
343 import { Persister, PersisterInterface } from '../structs/Persister.mjs';
344 import { PrintableString } from '../structs/PrintableString.mjs';
345 import { FutureCallback, FutureCallbackInterface } from '../structs/FutureCallback.mjs';
346 import { Future } from '../structs/Future.mjs';
347 import { ChannelHandshakeConfig } from '../structs/ChannelHandshakeConfig.mjs';
348 import { ChannelHandshakeLimits } from '../structs/ChannelHandshakeLimits.mjs';
349 import { UserConfig } from '../structs/UserConfig.mjs';
350 import { BestBlock } from '../structs/BestBlock.mjs';
351 import { Listen, ListenInterface } from '../structs/Listen.mjs';
352 import { Confirm, ConfirmInterface } from '../structs/Confirm.mjs';
353 import { Persist, PersistInterface } from '../structs/Persist.mjs';
354 import { ChainMonitor } from '../structs/ChainMonitor.mjs';
355 import { KeysManager } from '../structs/KeysManager.mjs';
356 import { PhantomKeysManager } from '../structs/PhantomKeysManager.mjs';
357 import { ChainParameters } from '../structs/ChainParameters.mjs';
358 import { ChannelMessageHandler, ChannelMessageHandlerInterface } from '../structs/ChannelMessageHandler.mjs';
359 import { ChannelManagerReadArgs } from '../structs/ChannelManagerReadArgs.mjs';
360 import { ExpandedKey } from '../structs/ExpandedKey.mjs';
361 import { DataLossProtect } from '../structs/DataLossProtect.mjs';
362 import { RoutingMessageHandler, RoutingMessageHandlerInterface } from '../structs/RoutingMessageHandler.mjs';
363 import { OnionMessageHandler, OnionMessageHandlerInterface } from '../structs/OnionMessageHandler.mjs';
364 import { CustomMessageReader, CustomMessageReaderInterface } from '../structs/CustomMessageReader.mjs';
365 import { CustomMessageHandler, CustomMessageHandlerInterface } from '../structs/CustomMessageHandler.mjs';
366 import { IgnoringMessageHandler } from '../structs/IgnoringMessageHandler.mjs';
367 import { CustomOnionMessageHandler, CustomOnionMessageHandlerInterface } from '../structs/CustomOnionMessageHandler.mjs';
368 import { ErroringMessageHandler } from '../structs/ErroringMessageHandler.mjs';
369 import { MessageHandler } from '../structs/MessageHandler.mjs';
370 import { SocketDescriptor, SocketDescriptorInterface } from '../structs/SocketDescriptor.mjs';
371 import { PeerManager } from '../structs/PeerManager.mjs';
372 import { DirectedChannelTransactionParameters } from '../structs/DirectedChannelTransactionParameters.mjs';
373 import { ReadOnlyNetworkGraph } from '../structs/ReadOnlyNetworkGraph.mjs';
374 import { P2PGossipSync } from '../structs/P2PGossipSync.mjs';
375 import { DirectedChannelInfo } from '../structs/DirectedChannelInfo.mjs';
376 import { EffectiveCapacity } from '../structs/EffectiveCapacity.mjs';
377 import { DefaultRouter } from '../structs/DefaultRouter.mjs';
378 import { Router, RouterInterface } from '../structs/Router.mjs';
379 import { ScorerAccountingForInFlightHtlcs } from '../structs/ScorerAccountingForInFlightHtlcs.mjs';
380 import { MultiThreadedLockableScore } from '../structs/MultiThreadedLockableScore.mjs';
381 import { MultiThreadedScoreLock } from '../structs/MultiThreadedScoreLock.mjs';
382 import { OnionMessenger } from '../structs/OnionMessenger.mjs';
383 import { Destination } from '../structs/Destination.mjs';
384 import { OnionMessageContents } from '../structs/OnionMessageContents.mjs';
385 import { RapidGossipSync } from '../structs/RapidGossipSync.mjs';
386 import { RawDataPart } from '../structs/RawDataPart.mjs';
387 import { Sha256 } from '../structs/Sha256.mjs';
388 import { ExpiryTime } from '../structs/ExpiryTime.mjs';
389 import { MinFinalCltvExpiry } from '../structs/MinFinalCltvExpiry.mjs';
390 import { Fallback } from '../structs/Fallback.mjs';
391 import { Payer, PayerInterface } from '../structs/Payer.mjs';
392 import { InvoicePayer } from '../structs/InvoicePayer.mjs';
393 import { Retry } from '../structs/Retry.mjs';
395 import { CommonBase, UInt5, WitnessVersion, UnqualifiedError } from './CommonBase.mjs';
396 import * as bindings from '../bindings.mjs'
400 * Parameters for configuring [`ProbabilisticScorer`].
402 * Used to configure base, liquidity, and amount penalties, the sum of which comprises the channel
403 * penalty (i.e., the amount in msats willing to be paid to avoid routing through the channel).
405 * The penalty applied to any channel by the [`ProbabilisticScorer`] is the sum of each of the
408 export class ProbabilisticScoringParameters extends CommonBase {
410 public constructor(_dummy: null, ptr: bigint) {
411 super(ptr, bindings.ProbabilisticScoringParameters_free);
415 * A fixed penalty in msats to apply to each channel.
417 * Default value: 500 msat
419 public get_base_penalty_msat(): bigint {
420 const ret: bigint = bindings.ProbabilisticScoringParameters_get_base_penalty_msat(this.ptr);
425 * A fixed penalty in msats to apply to each channel.
427 * Default value: 500 msat
429 public set_base_penalty_msat(val: bigint): void {
430 bindings.ProbabilisticScoringParameters_set_base_penalty_msat(this.ptr, val);
434 * A multiplier used with the payment amount to calculate a fixed penalty applied to each
435 * channel, in excess of the [`base_penalty_msat`].
437 * The purpose of the amount penalty is to avoid having fees dominate the channel cost (i.e.,
438 * fees plus penalty) for large payments. The penalty is computed as the product of this
439 * multiplier and `2^30`ths of the payment amount.
441 * ie `base_penalty_amount_multiplier_msat * amount_msat / 2^30`
443 * Default value: 8,192 msat
445 * [`base_penalty_msat`]: Self::base_penalty_msat
447 public get_base_penalty_amount_multiplier_msat(): bigint {
448 const ret: bigint = bindings.ProbabilisticScoringParameters_get_base_penalty_amount_multiplier_msat(this.ptr);
453 * A multiplier used with the payment amount to calculate a fixed penalty applied to each
454 * channel, in excess of the [`base_penalty_msat`].
456 * The purpose of the amount penalty is to avoid having fees dominate the channel cost (i.e.,
457 * fees plus penalty) for large payments. The penalty is computed as the product of this
458 * multiplier and `2^30`ths of the payment amount.
460 * ie `base_penalty_amount_multiplier_msat * amount_msat / 2^30`
462 * Default value: 8,192 msat
464 * [`base_penalty_msat`]: Self::base_penalty_msat
466 public set_base_penalty_amount_multiplier_msat(val: bigint): void {
467 bindings.ProbabilisticScoringParameters_set_base_penalty_amount_multiplier_msat(this.ptr, val);
471 * A multiplier used in conjunction with the negative `log10` of the channel's success
472 * probability for a payment, as determined by our latest estimates of the channel's
473 * liquidity, to determine the liquidity penalty.
475 * The penalty is based in part on the knowledge learned from prior successful and unsuccessful
476 * payments. This knowledge is decayed over time based on [`liquidity_offset_half_life`]. The
477 * penalty is effectively limited to `2 * liquidity_penalty_multiplier_msat` (corresponding to
478 * lower bounding the success probability to `0.01`) when the amount falls within the
479 * uncertainty bounds of the channel liquidity balance. Amounts above the upper bound will
480 * result in a `u64::max_value` penalty, however.
482 * `-log10(success_probability) * liquidity_penalty_multiplier_msat`
484 * Default value: 30,000 msat
486 * [`liquidity_offset_half_life`]: Self::liquidity_offset_half_life
488 public get_liquidity_penalty_multiplier_msat(): bigint {
489 const ret: bigint = bindings.ProbabilisticScoringParameters_get_liquidity_penalty_multiplier_msat(this.ptr);
494 * A multiplier used in conjunction with the negative `log10` of the channel's success
495 * probability for a payment, as determined by our latest estimates of the channel's
496 * liquidity, to determine the liquidity penalty.
498 * The penalty is based in part on the knowledge learned from prior successful and unsuccessful
499 * payments. This knowledge is decayed over time based on [`liquidity_offset_half_life`]. The
500 * penalty is effectively limited to `2 * liquidity_penalty_multiplier_msat` (corresponding to
501 * lower bounding the success probability to `0.01`) when the amount falls within the
502 * uncertainty bounds of the channel liquidity balance. Amounts above the upper bound will
503 * result in a `u64::max_value` penalty, however.
505 * `-log10(success_probability) * liquidity_penalty_multiplier_msat`
507 * Default value: 30,000 msat
509 * [`liquidity_offset_half_life`]: Self::liquidity_offset_half_life
511 public set_liquidity_penalty_multiplier_msat(val: bigint): void {
512 bindings.ProbabilisticScoringParameters_set_liquidity_penalty_multiplier_msat(this.ptr, val);
516 * Whenever this amount of time elapses since the last update to a channel's liquidity bounds,
517 * the distance from the bounds to \"zero\" is cut in half. In other words, the lower-bound on
518 * the available liquidity is halved and the upper-bound moves half-way to the channel's total
521 * Because halving the liquidity bounds grows the uncertainty on the channel's liquidity,
522 * the penalty for an amount within the new bounds may change. See the [`ProbabilisticScorer`]
523 * struct documentation for more info on the way the liquidity bounds are used.
525 * For example, if the channel's capacity is 1 million sats, and the current upper and lower
526 * liquidity bounds are 200,000 sats and 600,000 sats, after this amount of time the upper
527 * and lower liquidity bounds will be decayed to 100,000 and 800,000 sats.
529 * Default value: 6 hours
533 * When built with the `no-std` feature, time will never elapse. Therefore, the channel
534 * liquidity knowledge will never decay except when the bounds cross.
536 public get_liquidity_offset_half_life(): bigint {
537 const ret: bigint = bindings.ProbabilisticScoringParameters_get_liquidity_offset_half_life(this.ptr);
542 * Whenever this amount of time elapses since the last update to a channel's liquidity bounds,
543 * the distance from the bounds to \"zero\" is cut in half. In other words, the lower-bound on
544 * the available liquidity is halved and the upper-bound moves half-way to the channel's total
547 * Because halving the liquidity bounds grows the uncertainty on the channel's liquidity,
548 * the penalty for an amount within the new bounds may change. See the [`ProbabilisticScorer`]
549 * struct documentation for more info on the way the liquidity bounds are used.
551 * For example, if the channel's capacity is 1 million sats, and the current upper and lower
552 * liquidity bounds are 200,000 sats and 600,000 sats, after this amount of time the upper
553 * and lower liquidity bounds will be decayed to 100,000 and 800,000 sats.
555 * Default value: 6 hours
559 * When built with the `no-std` feature, time will never elapse. Therefore, the channel
560 * liquidity knowledge will never decay except when the bounds cross.
562 public set_liquidity_offset_half_life(val: bigint): void {
563 bindings.ProbabilisticScoringParameters_set_liquidity_offset_half_life(this.ptr, val);
567 * A multiplier used in conjunction with a payment amount and the negative `log10` of the
568 * channel's success probability for the payment, as determined by our latest estimates of the
569 * channel's liquidity, to determine the amount penalty.
571 * The purpose of the amount penalty is to avoid having fees dominate the channel cost (i.e.,
572 * fees plus penalty) for large payments. The penalty is computed as the product of this
573 * multiplier and `2^20`ths of the payment amount, weighted by the negative `log10` of the
574 * success probability.
576 * `-log10(success_probability) * liquidity_penalty_amount_multiplier_msat * amount_msat / 2^20`
578 * In practice, this means for 0.1 success probability (`-log10(0.1) == 1`) each `2^20`th of
579 * the amount will result in a penalty of the multiplier. And, as the success probability
580 * decreases, the negative `log10` weighting will increase dramatically. For higher success
581 * probabilities, the multiplier will have a decreasing effect as the negative `log10` will
584 * Default value: 192 msat
586 public get_liquidity_penalty_amount_multiplier_msat(): bigint {
587 const ret: bigint = bindings.ProbabilisticScoringParameters_get_liquidity_penalty_amount_multiplier_msat(this.ptr);
592 * A multiplier used in conjunction with a payment amount and the negative `log10` of the
593 * channel's success probability for the payment, as determined by our latest estimates of the
594 * channel's liquidity, to determine the amount penalty.
596 * The purpose of the amount penalty is to avoid having fees dominate the channel cost (i.e.,
597 * fees plus penalty) for large payments. The penalty is computed as the product of this
598 * multiplier and `2^20`ths of the payment amount, weighted by the negative `log10` of the
599 * success probability.
601 * `-log10(success_probability) * liquidity_penalty_amount_multiplier_msat * amount_msat / 2^20`
603 * In practice, this means for 0.1 success probability (`-log10(0.1) == 1`) each `2^20`th of
604 * the amount will result in a penalty of the multiplier. And, as the success probability
605 * decreases, the negative `log10` weighting will increase dramatically. For higher success
606 * probabilities, the multiplier will have a decreasing effect as the negative `log10` will
609 * Default value: 192 msat
611 public set_liquidity_penalty_amount_multiplier_msat(val: bigint): void {
612 bindings.ProbabilisticScoringParameters_set_liquidity_penalty_amount_multiplier_msat(this.ptr, val);
616 * A multiplier used in conjunction with the negative `log10` of the channel's success
617 * probability for the payment, as determined based on the history of our estimates of the
618 * channel's available liquidity, to determine a penalty.
620 * This penalty is similar to [`liquidity_penalty_multiplier_msat`], however, instead of using
621 * only our latest estimate for the current liquidity available in the channel, it estimates
622 * success probability based on the estimated liquidity available in the channel through
623 * history. Specifically, every time we update our liquidity bounds on a given channel, we
624 * track which of several buckets those bounds fall into, exponentially decaying the
625 * probability of each bucket as new samples are added.
627 * Default value: 10,000 msat
629 * [`liquidity_penalty_multiplier_msat`]: Self::liquidity_penalty_multiplier_msat
631 public get_historical_liquidity_penalty_multiplier_msat(): bigint {
632 const ret: bigint = bindings.ProbabilisticScoringParameters_get_historical_liquidity_penalty_multiplier_msat(this.ptr);
637 * A multiplier used in conjunction with the negative `log10` of the channel's success
638 * probability for the payment, as determined based on the history of our estimates of the
639 * channel's available liquidity, to determine a penalty.
641 * This penalty is similar to [`liquidity_penalty_multiplier_msat`], however, instead of using
642 * only our latest estimate for the current liquidity available in the channel, it estimates
643 * success probability based on the estimated liquidity available in the channel through
644 * history. Specifically, every time we update our liquidity bounds on a given channel, we
645 * track which of several buckets those bounds fall into, exponentially decaying the
646 * probability of each bucket as new samples are added.
648 * Default value: 10,000 msat
650 * [`liquidity_penalty_multiplier_msat`]: Self::liquidity_penalty_multiplier_msat
652 public set_historical_liquidity_penalty_multiplier_msat(val: bigint): void {
653 bindings.ProbabilisticScoringParameters_set_historical_liquidity_penalty_multiplier_msat(this.ptr, val);
657 * A multiplier used in conjunction with the payment amount and the negative `log10` of the
658 * channel's success probability for the payment, as determined based on the history of our
659 * estimates of the channel's available liquidity, to determine a penalty.
661 * The purpose of the amount penalty is to avoid having fees dominate the channel cost for
662 * large payments. The penalty is computed as the product of this multiplier and the `2^20`ths
663 * of the payment amount, weighted by the negative `log10` of the success probability.
665 * This penalty is similar to [`liquidity_penalty_amount_multiplier_msat`], however, instead
666 * of using only our latest estimate for the current liquidity available in the channel, it
667 * estimates success probability based on the estimated liquidity available in the channel
668 * through history. Specifically, every time we update our liquidity bounds on a given
669 * channel, we track which of several buckets those bounds fall into, exponentially decaying
670 * the probability of each bucket as new samples are added.
672 * Default value: 64 msat
674 * [`liquidity_penalty_amount_multiplier_msat`]: Self::liquidity_penalty_amount_multiplier_msat
676 public get_historical_liquidity_penalty_amount_multiplier_msat(): bigint {
677 const ret: bigint = bindings.ProbabilisticScoringParameters_get_historical_liquidity_penalty_amount_multiplier_msat(this.ptr);
682 * A multiplier used in conjunction with the payment amount and the negative `log10` of the
683 * channel's success probability for the payment, as determined based on the history of our
684 * estimates of the channel's available liquidity, to determine a penalty.
686 * The purpose of the amount penalty is to avoid having fees dominate the channel cost for
687 * large payments. The penalty is computed as the product of this multiplier and the `2^20`ths
688 * of the payment amount, weighted by the negative `log10` of the success probability.
690 * This penalty is similar to [`liquidity_penalty_amount_multiplier_msat`], however, instead
691 * of using only our latest estimate for the current liquidity available in the channel, it
692 * estimates success probability based on the estimated liquidity available in the channel
693 * through history. Specifically, every time we update our liquidity bounds on a given
694 * channel, we track which of several buckets those bounds fall into, exponentially decaying
695 * the probability of each bucket as new samples are added.
697 * Default value: 64 msat
699 * [`liquidity_penalty_amount_multiplier_msat`]: Self::liquidity_penalty_amount_multiplier_msat
701 public set_historical_liquidity_penalty_amount_multiplier_msat(val: bigint): void {
702 bindings.ProbabilisticScoringParameters_set_historical_liquidity_penalty_amount_multiplier_msat(this.ptr, val);
706 * If we aren't learning any new datapoints for a channel, the historical liquidity bounds
707 * tracking can simply live on with increasingly stale data. Instead, when a channel has not
708 * seen a liquidity estimate update for this amount of time, the historical datapoints are
711 * Note that after 16 or more half lives all historical data will be completely gone.
713 * Default value: 14 days
715 public get_historical_no_updates_half_life(): bigint {
716 const ret: bigint = bindings.ProbabilisticScoringParameters_get_historical_no_updates_half_life(this.ptr);
721 * If we aren't learning any new datapoints for a channel, the historical liquidity bounds
722 * tracking can simply live on with increasingly stale data. Instead, when a channel has not
723 * seen a liquidity estimate update for this amount of time, the historical datapoints are
726 * Note that after 16 or more half lives all historical data will be completely gone.
728 * Default value: 14 days
730 public set_historical_no_updates_half_life(val: bigint): void {
731 bindings.ProbabilisticScoringParameters_set_historical_no_updates_half_life(this.ptr, val);
735 * This penalty is applied when `htlc_maximum_msat` is equal to or larger than half of the
736 * channel's capacity, which makes us prefer nodes with a smaller `htlc_maximum_msat`. We
737 * treat such nodes preferentially as this makes balance discovery attacks harder to execute,
738 * thereby creating an incentive to restrict `htlc_maximum_msat` and improve privacy.
740 * Default value: 250 msat
742 public get_anti_probing_penalty_msat(): bigint {
743 const ret: bigint = bindings.ProbabilisticScoringParameters_get_anti_probing_penalty_msat(this.ptr);
748 * This penalty is applied when `htlc_maximum_msat` is equal to or larger than half of the
749 * channel's capacity, which makes us prefer nodes with a smaller `htlc_maximum_msat`. We
750 * treat such nodes preferentially as this makes balance discovery attacks harder to execute,
751 * thereby creating an incentive to restrict `htlc_maximum_msat` and improve privacy.
753 * Default value: 250 msat
755 public set_anti_probing_penalty_msat(val: bigint): void {
756 bindings.ProbabilisticScoringParameters_set_anti_probing_penalty_msat(this.ptr, val);
760 * This penalty is applied when the amount we're attempting to send over a channel exceeds our
761 * current estimate of the channel's available liquidity.
763 * Note that in this case all other penalties, including the
764 * [`liquidity_penalty_multiplier_msat`] and [`liquidity_penalty_amount_multiplier_msat`]-based
765 * penalties, as well as the [`base_penalty_msat`] and the [`anti_probing_penalty_msat`], if
766 * applicable, are still included in the overall penalty.
768 * If you wish to avoid creating paths with such channels entirely, setting this to a value of
769 * `u64::max_value()` will guarantee that.
771 * Default value: 1_0000_0000_000 msat (1 Bitcoin)
773 * [`liquidity_penalty_multiplier_msat`]: Self::liquidity_penalty_multiplier_msat
774 * [`liquidity_penalty_amount_multiplier_msat`]: Self::liquidity_penalty_amount_multiplier_msat
775 * [`base_penalty_msat`]: Self::base_penalty_msat
776 * [`anti_probing_penalty_msat`]: Self::anti_probing_penalty_msat
778 public get_considered_impossible_penalty_msat(): bigint {
779 const ret: bigint = bindings.ProbabilisticScoringParameters_get_considered_impossible_penalty_msat(this.ptr);
784 * This penalty is applied when the amount we're attempting to send over a channel exceeds our
785 * current estimate of the channel's available liquidity.
787 * Note that in this case all other penalties, including the
788 * [`liquidity_penalty_multiplier_msat`] and [`liquidity_penalty_amount_multiplier_msat`]-based
789 * penalties, as well as the [`base_penalty_msat`] and the [`anti_probing_penalty_msat`], if
790 * applicable, are still included in the overall penalty.
792 * If you wish to avoid creating paths with such channels entirely, setting this to a value of
793 * `u64::max_value()` will guarantee that.
795 * Default value: 1_0000_0000_000 msat (1 Bitcoin)
797 * [`liquidity_penalty_multiplier_msat`]: Self::liquidity_penalty_multiplier_msat
798 * [`liquidity_penalty_amount_multiplier_msat`]: Self::liquidity_penalty_amount_multiplier_msat
799 * [`base_penalty_msat`]: Self::base_penalty_msat
800 * [`anti_probing_penalty_msat`]: Self::anti_probing_penalty_msat
802 public set_considered_impossible_penalty_msat(val: bigint): void {
803 bindings.ProbabilisticScoringParameters_set_considered_impossible_penalty_msat(this.ptr, val);
806 public clone_ptr(): bigint {
807 const ret: bigint = bindings.ProbabilisticScoringParameters_clone_ptr(this.ptr);
812 * Creates a copy of the ProbabilisticScoringParameters
814 public clone(): ProbabilisticScoringParameters {
815 const ret: bigint = bindings.ProbabilisticScoringParameters_clone(this.ptr);
816 const ret_hu_conv: ProbabilisticScoringParameters = new ProbabilisticScoringParameters(null, ret);
817 CommonBase.add_ref_from(ret_hu_conv, this);
822 * Marks all nodes in the given list as banned, i.e.,
823 * they will be avoided during path finding.
825 public add_banned_from_list(node_ids: NodeId[]): void {
826 bindings.ProbabilisticScoringParameters_add_banned_from_list(this.ptr, bindings.encodeUint64Array(node_ids != null ? node_ids.map(node_ids_conv_8 => node_ids_conv_8 == null ? 0n : CommonBase.get_ptr_of(node_ids_conv_8)) : null));
827 node_ids.forEach((node_ids_conv_8: NodeId) => { CommonBase.add_ref_from(this, node_ids_conv_8); });
831 * Creates a "default" ProbabilisticScoringParameters. See struct and individual field documentaiton for details on which values are used.
833 public static constructor_default(): ProbabilisticScoringParameters {
834 const ret: bigint = bindings.ProbabilisticScoringParameters_default();
835 const ret_hu_conv: ProbabilisticScoringParameters = new ProbabilisticScoringParameters(null, ret);
836 CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);