rfq

type AcceptHtlcEvent struct {

	// Htlc is the intercepted HTLC.
	Htlc lndclient.InterceptedHtlc

	// Policy is the policy with which the HTLC is compliant.
	Policy Policy
	// contains filtered or unexported fields
}

type AssetForwardPolicy struct {
	// contains filtered or unexported fields
}

type AssetPurchasePolicy struct {

	// AssetSpecifier is the identifier for the specific asset or asset
	// group to which this policy applies.
	AssetSpecifier asset.Specifier

	// AcceptedQuoteId is the ID of the accepted quote.
	AcceptedQuoteId rfqmsg.ID

	// CurrentAssetAmountMsat is the total amount that is held currently in
	// accepted HTLCs.
	CurrentAmountMsat lnwire.MilliSatoshi

	// BidAssetRate is the quote's asset to BTC conversion rate.
	BidAssetRate rfqmath.BigIntFixedPoint

	// PaymentMaxAmt is the maximum agreed BTC payment.
	PaymentMaxAmt lnwire.MilliSatoshi
	// contains filtered or unexported fields
}

type AssetSalePolicy struct {
	// AssetSpecifier is the identifier for the specific asset or asset
	// group to which this policy applies.
	AssetSpecifier asset.Specifier

	// AcceptedQuoteId is the unique identifier of the RFQ session quote
	// accept message that the policy is associated with.
	AcceptedQuoteId rfqmsg.ID

	// MaxOutboundAssetAmount represents the maximum asset amount permitted
	// by policy for outbound transactions. It sets an upper limit on the
	// amount of assets this node is willing to divest within the remit of
	// the policy.
	MaxOutboundAssetAmount uint64

	// CurrentAssetAmountMsat is the total amount that is held currently in
	// accepted HTLCs.
	CurrentAmountMsat lnwire.MilliSatoshi

	// AskAssetRate is the quote's asking asset unit to BTC conversion rate.
	AskAssetRate rfqmath.BigIntFixedPoint
	// contains filtered or unexported fields
}

type BuyAcceptMap map[SerialisedScid]rfqmsg.BuyAccept

type BuyOffer struct {
	// AssetID represents the identifier of the subject asset.
	AssetID *asset.ID

	// AssetGroupKey is the public group key of the subject asset.
	AssetGroupKey *btcec.PublicKey

	// MaxUnits is the maximum amount of the asset which this node is
	// willing to purchase.
	MaxUnits uint64
}

type BuyOrder struct {
	// AssetSpecifier is the asset that the buyer is interested in.
	AssetSpecifier asset.Specifier

	// AssetMaxAmt is the maximum amount of the asset that the provider must
	// be willing to offer.
	AssetMaxAmt uint64

	// Expiry is the time at which the order expires.
	Expiry time.Time

	// Peer is the peer that the buy order is intended for. This field is
	// optional.
	//
	// TODO(ffranr): Currently, this field must be specified. In the future,
	//  the negotiator should be able to determine the optimal peer.
	Peer fn.Option[route.Vertex]
}

type ChannelLister interface {
	// ListChannels returns a list of channels that are available for
	// routing.
	ListChannels(ctx context.Context) ([]lndclient.ChannelInfo, error)
}

type CliConfig struct {
	PriceOracleAddress string `` /* 215-byte string literal not displayed */

	AcceptPriceDeviationPpm uint64 `` /* 132-byte string literal not displayed */

	SkipAcceptQuotePriceCheck bool `long:"skipacceptquotepricecheck" description:"Accept any price quote returned by RFQ peer, skipping price validation"`

	MockOracleAssetsPerBTC uint64 `` /* 270-byte string literal not displayed */

	// TODO(ffranr): Remove in favour of MockOracleAssetsPerBTC.
	MockOracleSatsPerAsset uint64 `` /* 289-byte string literal not displayed */
}

type HtlcInterceptor interface {
	// InterceptHtlcs intercepts HTLCs, using the handling function provided
	// to respond to HTLCs.
	InterceptHtlcs(context.Context, lndclient.HtlcInterceptHandler) error
}

type HtlcSubscriber interface {
	// SubscribeHtlcEvents subscribes to a stream of events related to
	// HTLC updates.
	SubscribeHtlcEvents(ctx context.Context) (<-chan *routerrpc.HtlcEvent,
		<-chan error, error)
}

type IncomingRejectQuoteEvent struct {

	// Reject is the rejected quote.
	rfqmsg.Reject
	// contains filtered or unexported fields
}

type InvalidQuoteRespEvent struct {

	// QuoteResponse is the quote response received from the peer which was
	// deemed invalid.
	QuoteResponse rfqmsg.QuoteResponse

	// Status is the status of the quote response.
	Status QuoteRespStatus
	// contains filtered or unexported fields
}

type Manager struct {

	// ContextGuard provides a wait group and main quit channel that can be
	// used to create guarded contexts.
	*fn.ContextGuard
	// contains filtered or unexported fields
}

type ManagerCfg struct {
	// PeerMessenger is the peer messenger. This component provides the RFQ
	// manager with the ability to send and receive raw peer messages.
	PeerMessenger PeerMessenger

	// HtlcInterceptor is the HTLC interceptor. This component is used to
	// intercept and accept/reject HTLCs.
	HtlcInterceptor HtlcInterceptor

	// HtlcSubscriber is a subscriber that is used to retrieve live HTLC
	// event updates.
	HtlcSubscriber HtlcSubscriber

	// PriceOracle is the price oracle that the RFQ manager will use to
	// determine whether a quote is accepted or rejected.
	PriceOracle PriceOracle

	// ChannelLister is the channel lister that the RFQ manager will use to
	// determine the available channels for routing.
	ChannelLister ChannelLister

	// AliasManager is the SCID alias manager. This component is injected
	// into the manager once lnd and tapd are hooked together.
	AliasManager ScidAliasManager

	// AcceptPriceDeviationPpm is the price deviation in
	// parts per million that is accepted by the RFQ negotiator.
	//
	// Example: 50,000 ppm => price deviation is set to 5% .
	AcceptPriceDeviationPpm uint64

	// SkipAcceptQuotePriceCheck is a flag that, when set, will cause the
	// RFQ negotiator to skip price validation on incoming quote accept
	// messages (this means that the price oracle will not be queried).
	SkipAcceptQuotePriceCheck bool

	// ErrChan is the main error channel which will be used to report back
	// critical errors to the main server.
	ErrChan chan<- error
}

type MockPriceOracle struct {
	// Mock is the underlying mock object used to track method invocations
	// in tests.
	mock.Mock
	// contains filtered or unexported fields
}

type Negotiator struct {

	// ContextGuard provides a wait group and main quit channel that can be
	// used to create guarded contexts.
	*fn.ContextGuard
	// contains filtered or unexported fields
}

type NegotiatorCfg struct {
	// PriceOracle is the price oracle that the negotiator will use to
	// determine whether a quote is accepted or rejected.
	PriceOracle PriceOracle

	// OutgoingMessages is a channel which is populated with outgoing peer
	// messages. These are messages which are destined to be sent to peers.
	OutgoingMessages chan<- rfqmsg.OutgoingMsg

	// AcceptPriceDeviationPpm specifies the maximum allowable price
	// deviation in parts per million (PPM). This parameter defines the
	// threshold for the price returned by the price oracle service,
	// indicating how much it can deviate from a peer's quote accept price
	// for the node to consider using the accepted quote.
	AcceptPriceDeviationPpm uint64

	// SkipAcceptQuotePriceCheck is a flag that, if set, will skip the
	// price check when validating an incoming quote accept message. This is
	// useful for testing purposes.
	SkipAcceptQuotePriceCheck bool

	// ErrChan is a channel that is populated with errors by this subsystem.
	ErrChan chan<- error
}

type OracleAddr = url.URL

type OracleError struct {
	// Code is a code which uniquely identifies the error type.
	Code uint8

	// Msg is a human-readable error message.
	Msg string
}

type OracleResponse struct {
	// AssetRate is the asset to BTC rate. Other asset in the transfer is
	// assumed to be BTC and therefore not included in the response.
	AssetRate rfqmsg.AssetRate

	// Err is an optional error returned by the price oracle service.
	Err *OracleError
}

type OrderHandler struct {

	// ContextGuard provides a wait group and main quit channel that can be
	// used to create guarded contexts.
	*fn.ContextGuard
	// contains filtered or unexported fields
}

type OrderHandlerCfg struct {
	// CleanupInterval is the interval at which the order handler cleans up
	// expired accepted quotes from its local cache.
	CleanupInterval time.Duration

	// HtlcInterceptor is the HTLC interceptor. This component is used to
	// intercept and accept/reject HTLCs.
	HtlcInterceptor HtlcInterceptor

	// AcceptHtlcEvents is a channel that receives accepted HTLCs.
	AcceptHtlcEvents chan<- *AcceptHtlcEvent

	// HtlcSubscriber is a subscriber that is used to retrieve live HTLC
	// event updates.
	HtlcSubscriber HtlcSubscriber
}

type PeerAcceptedBuyQuoteEvent struct {

	// BuyAccept is the accepted asset buy quote.
	rfqmsg.BuyAccept
	// contains filtered or unexported fields
}

type PeerAcceptedSellQuoteEvent struct {

	// SellAccept is the accepted asset sell quote.
	rfqmsg.SellAccept
	// contains filtered or unexported fields
}

type PeerMessenger interface {
	// SubscribeCustomMessages creates a subscription to raw messages
	// received from our peers.
	SubscribeCustomMessages(
		ctx context.Context) (<-chan lndclient.CustomMessage,
		<-chan error, error)

	// SendCustomMessage sends a raw message to a peer.
	SendCustomMessage(context.Context, lndclient.CustomMessage) error
}

type Policy interface {
	// CheckHtlcCompliance returns an error if the given HTLC intercept
	// descriptor does not satisfy the subject policy.
	CheckHtlcCompliance(htlc lndclient.InterceptedHtlc) error

	// Expiry returns the policy's expiry time as a unix timestamp.
	Expiry() uint64

	// HasExpired returns true if the policy has expired.
	HasExpired() bool

	// Scid returns the serialised short channel ID (SCID) of the channel to
	// which the policy applies.
	Scid() uint64

	// TrackAcceptedHtlc makes the policy aware of this new accepted HTLC.
	// This is important in cases where the set of existing HTLCs may affect
	// whether the next compliance check passes.
	TrackAcceptedHtlc(circuitKey models.CircuitKey, amt lnwire.MilliSatoshi)

	// UntrackHtlc stops tracking the uniquely identified HTLC.
	UntrackHtlc(circuitKey models.CircuitKey)

	// GenerateInterceptorResponse generates an interceptor response for the
	// HTLC interceptor from the policy.
	GenerateInterceptorResponse(
		lndclient.InterceptedHtlc) (*lndclient.InterceptedHtlcResponse,
		error)
}

type PriceOracle interface {
	// QueryAskPrice returns the ask price for a given asset amount.
	// The ask price is the amount the oracle suggests a peer should accept
	// from another peer to provide the specified asset amount.
	QueryAskPrice(ctx context.Context, assetSpecifier asset.Specifier,
		assetMaxAmt fn.Option[uint64],
		paymentMaxAmt fn.Option[lnwire.MilliSatoshi],
		assetRateHint fn.Option[rfqmsg.AssetRate]) (
		*OracleResponse, error)

	// QueryBidPrice returns the bid price for a given asset amount.
	// The bid price is the amount the oracle suggests a peer should pay
	// to another peer to receive the specified asset amount.
	QueryBidPrice(ctx context.Context, assetSpecifier asset.Specifier,
		assetMaxAmt fn.Option[uint64],
		paymentMaxAmt fn.Option[lnwire.MilliSatoshi],
		assetRateHint fn.Option[rfqmsg.AssetRate]) (
		*OracleResponse, error)
}

type QuoteRespStatus uint8

type RpcPriceOracle struct {
	// contains filtered or unexported fields
}

type ScidAliasManager interface {
	// AddLocalAlias adds a database mapping from the passed alias to the
	// passed base SCID.
	AddLocalAlias(ctx context.Context, alias,
		baseScid lnwire.ShortChannelID) error

	// DeleteLocalAlias removes a mapping from the database and the
	// Manager's maps.
	DeleteLocalAlias(ctx context.Context, alias,
		baseScid lnwire.ShortChannelID) error
}

type SellAcceptMap map[SerialisedScid]rfqmsg.SellAccept

type SellOffer struct {
	// AssetID represents the identifier of the subject asset.
	AssetID *asset.ID

	// AssetGroupKey is the public group key of the subject asset.
	AssetGroupKey *btcec.PublicKey

	// MaxUnits is the maximum amount of the asset under offer.
	MaxUnits uint64
}

type SellOrder struct {
	// AssetSpecifier is the asset that the seller is interested in.
	AssetSpecifier asset.Specifier

	// PaymentMaxAmt is the maximum msat amount that the responding peer
	// must agree to pay.
	PaymentMaxAmt lnwire.MilliSatoshi

	// Expiry is the time at which the order expires.
	Expiry time.Time

	// Peer is the peer that the buy order is intended for. This field is
	// optional.
	Peer fn.Option[route.Vertex]
}

type SerialisedScid = rfqmsg.SerialisedScid

type StreamHandler struct {

	// ContextGuard provides a wait group and main quit channel that can be
	// used to create guarded contexts.
	*fn.ContextGuard
	// contains filtered or unexported fields
}

type StreamHandlerCfg struct {
	// PeerMessenger is the peer messenger. This component provides the RFQ
	// manager with the ability to send and receive raw peer messages.
	PeerMessenger PeerMessenger

	// IncomingMessages is a channel which is populated with incoming
	// (received) RFQ messages. These messages have been extracted from the
	// raw peer wire messages by the stream handler service.
	IncomingMessages chan<- rfqmsg.IncomingMsg
}