rfq

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 23, 2024 License: MIT Imports: 28 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	MockPriceOracleServiceAddress = "use_mock_price_oracle_service_" +
		"promise_to_not_use_on_mainnet"

	// MinAssetsPerBTC is the minimum number of asset units that one BTC
	// should cost. If the value is lower, then one asset unit would cost
	// too much to be able to represent small amounts of satoshis. With this
	// value, one asset unit would still cost 1k sats.
	MinAssetsPerBTC = 100_000
)
View Source 
const (
	// DefaultTimeout is the default timeout used for context operations.
	DefaultTimeout = 30 * time.Second

	// CacheCleanupInterval is the interval at which local runtime caches
	// are cleaned up.
	CacheCleanupInterval = 30 * time.Second
)
View Source 
const (

	// DefaultAcceptPriceDeviationPpm is the default price deviation in
	// parts per million that is accepted by the RFQ negotiator.
	//
	// NOTE: This value is set to 5% (50,000 ppm).
	DefaultAcceptPriceDeviationPpm = 50_000
)
View Source 
const (
	// RfqRpcOracleAddrScheme is the URL address scheme used by an RPC price
	// oracle service.
	RfqRpcOracleAddrScheme string = "rfqrpc"
)
View Source 
const Subsystem = "RFQS"

Subsystem defines the logging code for this subsystem.

Variables

This section is empty.

Functions

func DisableLog 

func DisableLog()

DisableLog disables all library log output. Logging output is disabled by default until UseLogger is called.

func UseLogger 

func UseLogger(logger btclog.Logger)

UseLogger uses a specified Logger to output package logging info. This should be used in preference to SetLogWriter if the caller is also using btclog.

Types

type AcceptHtlcEvent 

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
}

AcceptHtlcEvent is an event that is sent to the accept HTLCs channel when an HTLC is accepted.

func NewAcceptHtlcEvent 

func NewAcceptHtlcEvent(htlc lndclient.InterceptedHtlc,
	policy Policy) *AcceptHtlcEvent

NewAcceptHtlcEvent creates a new AcceptedHtlcEvent.

func (*AcceptHtlcEvent) Timestamp 

func (q *AcceptHtlcEvent) Timestamp() time.Time

Timestamp returns the event creation UTC timestamp.

type AssetForwardPolicy 

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

AssetForwardPolicy is a struct that holds the terms which determine whether a channel HTLC for an asset-to-asset forward is accepted or rejected.

func NewAssetForwardPolicy 

func NewAssetForwardPolicy(incoming, outgoing Policy) (*AssetForwardPolicy,
	error)

NewAssetForwardPolicy creates a new asset forward policy.

func (*AssetForwardPolicy) CheckHtlcCompliance 

func (a *AssetForwardPolicy) CheckHtlcCompliance(
	htlc lndclient.InterceptedHtlc) error

CheckHtlcCompliance returns an error if the given HTLC intercept descriptor does not satisfy the subject policy.

func (*AssetForwardPolicy) Expiry 

func (a *AssetForwardPolicy) Expiry() uint64

Expiry returns the policy's expiry time as a unix timestamp in seconds. The returned expiry time is the earliest expiry time of the incoming and outgoing policies.

func (*AssetForwardPolicy) GenerateInterceptorResponse 

func (a *AssetForwardPolicy) GenerateInterceptorResponse(
	htlc lndclient.InterceptedHtlc) (*lndclient.InterceptedHtlcResponse,
	error)

GenerateInterceptorResponse generates an interceptor response for the policy.

func (*AssetForwardPolicy) HasExpired 

func (a *AssetForwardPolicy) HasExpired() bool

HasExpired returns true if the policy has expired.

func (*AssetForwardPolicy) Scid 

func (a *AssetForwardPolicy) Scid() uint64

Scid returns the serialised short channel ID (SCID) of the channel to which the policy applies. This is the SCID of the incoming policy.

type AssetPurchasePolicy 

type AssetPurchasePolicy struct {

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

	// AssetAmount is the amount of the tap asset that is being requested.
	AssetAmount uint64

	// BidPrice is the milli-satoshi per asset unit price that was
	// negotiated.
	BidPrice lnwire.MilliSatoshi
	// contains filtered or unexported fields
}

AssetPurchasePolicy is a struct that holds the terms which determine whether an asset purchase channel HTLC is accepted or rejected.

func NewAssetPurchasePolicy 

func NewAssetPurchasePolicy(quote rfqmsg.SellAccept) *AssetPurchasePolicy

NewAssetPurchasePolicy creates a new asset purchase policy.

func (*AssetPurchasePolicy) CheckHtlcCompliance 

func (c *AssetPurchasePolicy) CheckHtlcCompliance(
	htlc lndclient.InterceptedHtlc) error

CheckHtlcCompliance returns an error if the given HTLC intercept descriptor does not satisfy the subject policy.

func (*AssetPurchasePolicy) Expiry 

func (c *AssetPurchasePolicy) Expiry() uint64

Expiry returns the policy's expiry time as a unix timestamp in seconds.

func (*AssetPurchasePolicy) GenerateInterceptorResponse 

func (c *AssetPurchasePolicy) GenerateInterceptorResponse(
	htlc lndclient.InterceptedHtlc) (*lndclient.InterceptedHtlcResponse,
	error)

GenerateInterceptorResponse generates an interceptor response for the policy.

func (*AssetPurchasePolicy) HasExpired 

func (c *AssetPurchasePolicy) HasExpired() bool

HasExpired returns true if the policy has expired.

func (*AssetPurchasePolicy) Scid 

func (c *AssetPurchasePolicy) Scid() uint64

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

type AssetSalePolicy 

type AssetSalePolicy struct {
	ID rfqmsg.ID

	// MaxAssetAmount is the maximum amount of the asset that is being
	// requested.
	MaxAssetAmount uint64

	// AskPrice is the asking price of the quote in milli-satoshis per asset
	// unit.
	AskPrice lnwire.MilliSatoshi
	// contains filtered or unexported fields
}

AssetSalePolicy is a struct that holds the terms which determine whether an asset sale channel HTLC is accepted or rejected.

func NewAssetSalePolicy 

func NewAssetSalePolicy(quote rfqmsg.BuyAccept) *AssetSalePolicy

NewAssetSalePolicy creates a new asset sale policy.

func (*AssetSalePolicy) CheckHtlcCompliance 

func (c *AssetSalePolicy) CheckHtlcCompliance(
	htlc lndclient.InterceptedHtlc) error

CheckHtlcCompliance returns an error if the given HTLC intercept descriptor does not satisfy the subject policy.

func (*AssetSalePolicy) Expiry 

func (c *AssetSalePolicy) Expiry() uint64

Expiry returns the policy's expiry time as a unix timestamp.

func (*AssetSalePolicy) GenerateInterceptorResponse 

func (c *AssetSalePolicy) GenerateInterceptorResponse(
	htlc lndclient.InterceptedHtlc) (*lndclient.InterceptedHtlcResponse,
	error)

GenerateInterceptorResponse generates an interceptor response for the policy.

func (*AssetSalePolicy) HasExpired 

func (c *AssetSalePolicy) HasExpired() bool

HasExpired returns true if the policy has expired.

func (*AssetSalePolicy) Scid 

func (c *AssetSalePolicy) Scid() uint64

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

type BuyOffer 

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
}

BuyOffer is a struct that represents an asset buy offer. This data structure describes the maximum amount of an asset that this node is willing to purchase.

A buy offer is passive (unlike a buy order), meaning that it does not actively lead to a buy request being sent to a peer. Instead, it is used by the node to selectively accept or reject incoming asset sell quote requests before price is considered.

func (*BuyOffer) Validate 

func (a *BuyOffer) Validate() error

Validate validates the asset buy offer.

type BuyOrder 

type BuyOrder struct {
	// AssetID is the ID of the asset that the buyer is interested in.
	AssetID *asset.ID

	// AssetGroupKey is the public key of the asset group that the buyer is
	// interested in.
	AssetGroupKey *btcec.PublicKey

	// MinAssetAmount is the minimum amount of the asset that the buyer is
	// willing to accept.
	MinAssetAmount uint64

	// MaxBid is the maximum bid price that the buyer is willing to pay.
	MaxBid lnwire.MilliSatoshi

	// Expiry is the unix timestamp at which the buy order expires.
	Expiry uint64

	// Peer is the peer that the buy order is intended for. This field is
	// optional.
	Peer *route.Vertex
}

BuyOrder is a struct that represents a buy order.

type ChannelLister 

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

ChannelLister is an interface that provides a list of channels that are available for routing.

type CliConfig 

type CliConfig struct {
	PriceOracleAddress string `` /* 215-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 */

	MockOracleSatsPerAsset uint64 `` /* 289-byte string literal not displayed */
}

CliConfig is a struct that holds tapd cli configuration options for the RFQ service.

nolint: lll

func (*CliConfig) Validate 

func (c *CliConfig) Validate() error

Validate returns an error if the configuration is invalid.

type HtlcInterceptor 

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

HtlcInterceptor is an interface that abstracts the hash time locked contract (HTLC) intercept functionality.

type IncomingRejectQuoteEvent 

type IncomingRejectQuoteEvent struct {

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

IncomingRejectQuoteEvent is an event that is broadcast when the RFQ manager receives a reject quote message from a peer.

func NewIncomingRejectQuoteEvent 

func NewIncomingRejectQuoteEvent(
	reject *rfqmsg.Reject) *IncomingRejectQuoteEvent

NewIncomingRejectQuoteEvent creates a new IncomingRejectQuoteEvent.

func (*IncomingRejectQuoteEvent) Timestamp 

func (q *IncomingRejectQuoteEvent) Timestamp() time.Time

Timestamp returns the event creation UTC timestamp.

type InvalidQuoteRespEvent 

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
}

InvalidQuoteRespEvent is an event that is broadcast when the RFQ manager receives an unacceptable quote response message from a peer.

func NewInvalidQuoteRespEvent 

func NewInvalidQuoteRespEvent(quoteResponse rfqmsg.QuoteResponse,
	status QuoteRespStatus) *InvalidQuoteRespEvent

NewInvalidQuoteRespEvent creates a new InvalidBuyRespEvent.

func (*InvalidQuoteRespEvent) Timestamp 

func (q *InvalidQuoteRespEvent) Timestamp() time.Time

Timestamp returns the event creation UTC timestamp.

type Manager 

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
}

Manager is a struct that manages the request for quote (RFQ) system.

func NewManager 

func NewManager(cfg ManagerCfg) (*Manager, error)

NewManager creates a new RFQ manager.

func (*Manager) LocalAcceptedBuyQuotes 

func (m *Manager) LocalAcceptedBuyQuotes() map[SerialisedScid]rfqmsg.BuyAccept

LocalAcceptedBuyQuotes returns buy quotes that were accepted by our node and have been requested by our peers. These quotes are exclusively available to our node for the acquisition of assets.

func (*Manager) LocalAcceptedSellQuotes 

func (m *Manager) LocalAcceptedSellQuotes() map[SerialisedScid]rfqmsg.SellAccept

LocalAcceptedSellQuotes returns sell quotes that were accepted by our node and have been requested by our peers. These quotes are exclusively available to our node for the sale of assets.

func (*Manager) PeerAcceptedBuyQuotes 

func (m *Manager) PeerAcceptedBuyQuotes() map[SerialisedScid]rfqmsg.BuyAccept

PeerAcceptedBuyQuotes returns buy quotes that were requested by our node and have been accepted by our peers. These quotes are exclusively available to our node for the acquisition of assets.

func (*Manager) PeerAcceptedSellQuotes 

func (m *Manager) PeerAcceptedSellQuotes() map[SerialisedScid]rfqmsg.SellAccept

PeerAcceptedSellQuotes returns sell quotes that were requested by our node and have been accepted by our peers. These quotes are exclusively available to our node for the sale of assets.

func (*Manager) RegisterSubscriber 

func (m *Manager) RegisterSubscriber(
	receiver *fn.EventReceiver[fn.Event],
	deliverExisting bool, deliverFrom uint64) error

RegisterSubscriber adds a new subscriber to the set of subscribers that will be notified of any new events that are broadcast.

TODO(ffranr): Add support for delivering existing events to new subscribers.

func (*Manager) RemoveAssetSellOffer 

func (m *Manager) RemoveAssetSellOffer(assetID *asset.ID,
	assetGroupKey *btcec.PublicKey) error

RemoveAssetSellOffer removes an asset sell offer from the RFQ manager.

func (*Manager) RemoveSubscriber 

func (m *Manager) RemoveSubscriber(
	subscriber *fn.EventReceiver[fn.Event]) error

RemoveSubscriber removes a subscriber from the set of subscribers that will be notified of any new events that are broadcast.

func (*Manager) Start 

func (m *Manager) Start() error

Start attempts to start a new RFQ manager.

func (*Manager) Stop 

func (m *Manager) Stop() error

Stop attempts to stop the RFQ manager.

func (*Manager) UpsertAssetBuyOffer 

func (m *Manager) UpsertAssetBuyOffer(offer BuyOffer) error

UpsertAssetBuyOffer upserts an asset buy offer for management by the RFQ system. If the offer already exists for the given asset, it will be updated.

func (*Manager) UpsertAssetBuyOrder 

func (m *Manager) UpsertAssetBuyOrder(order BuyOrder) error

UpsertAssetBuyOrder upserts an asset buy order for management.

func (*Manager) UpsertAssetSellOffer 

func (m *Manager) UpsertAssetSellOffer(offer SellOffer) error

UpsertAssetSellOffer upserts an asset sell offer for management by the RFQ system. If the offer already exists for the given asset, it will be updated.

func (*Manager) UpsertAssetSellOrder 

func (m *Manager) UpsertAssetSellOrder(order SellOrder) error

UpsertAssetSellOrder upserts an asset sell order for management.

type ManagerCfg 

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

	// 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

	// 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
}

ManagerCfg is a struct that holds the configuration parameters for the RFQ manager.

type MockPriceOracle 

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

MockPriceOracle is a mock implementation of the PriceOracle interface. It returns the suggested rate as the exchange rate.

func NewMockPriceOracle 

func NewMockPriceOracle(expiryDelay, assetsPerBTC uint64) *MockPriceOracle

NewMockPriceOracle creates a new mock price oracle.

func NewMockPriceOracleSatPerAsset 

func NewMockPriceOracleSatPerAsset(expiryDelay uint64,
	satPerAsset btcutil.Amount) *MockPriceOracle

NewMockPriceOracleSatPerAsset creates a new mock price oracle with a specified satoshis per asset rate.

func (*MockPriceOracle) QueryAskPrice 

func (m *MockPriceOracle) QueryAskPrice(_ context.Context,
	_ *asset.ID, _ *btcec.PublicKey, _ uint64,
	_ *lnwire.MilliSatoshi) (*OracleAskResponse, error)

QueryAskPrice returns the ask price for the given asset amount.

func (*MockPriceOracle) QueryBidPrice 

func (m *MockPriceOracle) QueryBidPrice(_ context.Context, _ *asset.ID,
	_ *btcec.PublicKey, _ uint64) (*OracleBidResponse, error)

QueryBidPrice returns a bid price for the given asset amount.

type Negotiator 

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
}

Negotiator is a struct that handles the negotiation of quotes. It is a RFQ subsystem. It determines whether a quote request is accepted or rejected.

func NewNegotiator 

func NewNegotiator(cfg NegotiatorCfg) (*Negotiator, error)

NewNegotiator creates a new quote negotiator.

func (*Negotiator) HandleIncomingBuyAccept 

func (n *Negotiator) HandleIncomingBuyAccept(msg rfqmsg.BuyAccept,
	finalise func(rfqmsg.BuyAccept, fn.Option[InvalidQuoteRespEvent]))

HandleIncomingBuyAccept handles an incoming buy accept message. This method is called when a peer accepts a quote request from this node. The method checks the price and expiry time of the quote accept message. Once validation is complete, the finalise callback function is called.

func (*Negotiator) HandleIncomingBuyRequest 

func (n *Negotiator) HandleIncomingBuyRequest(
	request rfqmsg.BuyRequest) error

HandleIncomingBuyRequest handles an incoming asset buy quote request.

func (*Negotiator) HandleIncomingSellAccept 

func (n *Negotiator) HandleIncomingSellAccept(msg rfqmsg.SellAccept,
	finalise func(rfqmsg.SellAccept, fn.Option[InvalidQuoteRespEvent]))

HandleIncomingSellAccept handles an incoming sell accept message. This method is called when a peer accepts a quote request from this node. The method checks the price and expiry time of the quote accept message. Once validation is complete, the finalise callback function is called.

func (*Negotiator) HandleIncomingSellRequest 

func (n *Negotiator) HandleIncomingSellRequest(
	request rfqmsg.SellRequest) error

HandleIncomingSellRequest handles an incoming asset sell quote request. This is a request by our peer to sell an asset to us.

func (*Negotiator) HandleOutgoingBuyOrder 

func (n *Negotiator) HandleOutgoingBuyOrder(buyOrder BuyOrder) error

HandleOutgoingBuyOrder handles an outgoing buy order by constructing buy requests and passing them to the outgoing messages channel. These requests are sent to peers.

func (*Negotiator) HandleOutgoingSellOrder 

func (n *Negotiator) HandleOutgoingSellOrder(order SellOrder)

HandleOutgoingSellOrder handles an outgoing sell order by constructing sell requests and passing them to the outgoing messages channel. These requests are sent to peers.

func (*Negotiator) HasAssetBuyOffer 

func (n *Negotiator) HasAssetBuyOffer(assetID *asset.ID,
	assetGroupKey *btcec.PublicKey, assetAmt uint64) bool

HasAssetBuyOffer returns true if the negotiator has an asset buy offer which matches the given asset ID/group and asset amount.

TODO(ffranr): This method should return errors which can be used to differentiate between a missing offer and an invalid offer.

func (*Negotiator) HasAssetSellOffer 

func (n *Negotiator) HasAssetSellOffer(assetID *asset.ID,
	assetGroupKey *btcec.PublicKey, assetAmt uint64) bool

HasAssetSellOffer returns true if the negotiator has an asset sell offer which matches the given asset ID/group and asset amount.

TODO(ffranr): This method should return errors which can be used to differentiate between a missing offer and an invalid offer.

func (*Negotiator) RemoveAssetSellOffer 

func (n *Negotiator) RemoveAssetSellOffer(assetID *asset.ID,
	assetGroupKey *btcec.PublicKey) error

RemoveAssetSellOffer removes an asset sell offer from the negotiator.

func (*Negotiator) Start 

func (n *Negotiator) Start() error

Start starts the service.

func (*Negotiator) Stop 

func (n *Negotiator) Stop() error

Stop stops the handler.

func (*Negotiator) UpsertAssetBuyOffer 

func (n *Negotiator) UpsertAssetBuyOffer(offer BuyOffer) error

UpsertAssetBuyOffer upserts an asset buy offer. If the offer already exists for the given asset, it will be updated.

func (*Negotiator) UpsertAssetSellOffer 

func (n *Negotiator) UpsertAssetSellOffer(offer SellOffer) error

UpsertAssetSellOffer upserts an asset sell offer. If the offer already exists for the given asset, it will be updated.

type NegotiatorCfg 

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
}

NegotiatorCfg holds the configuration for the negotiator.

type OracleAddr 

type OracleAddr = url.URL

OracleAddr is a type alias for a URL type that represents a price oracle service address.

func ParsePriceOracleAddress 

func ParsePriceOracleAddress(addrStr string) (*OracleAddr, error)

ParsePriceOracleAddress parses a price oracle service address string and returns a URL type instance.

type OracleAskResponse 

type OracleAskResponse struct {
	// AskPrice is the asking price of the quote.
	AskPrice *lnwire.MilliSatoshi

	// Expiry is the price expiryDelay lifetime unix timestamp.
	Expiry uint64

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

OracleAskResponse is a struct that holds the price oracle's suggested ask price for an asset.

type OracleBidResponse 

type OracleBidResponse struct {
	// BidPrice is the suggested bid price for the asset amount.
	BidPrice *lnwire.MilliSatoshi

	// Expiry is the price expiry lifetime unix timestamp in seconds.
	Expiry uint64

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

OracleBidResponse is a struct that holds the price oracle's suggested bid price for an asset.

type OracleError 

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

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

OracleError is a struct that holds an error returned by the price oracle service.

func (*OracleError) Error 

func (o *OracleError) Error() string

Error returns a human-readable string representation of the error.

type OrderHandler 

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
}

OrderHandler orchestrates management of accepted quote bundles. It monitors HTLCs (Hash Time Locked Contracts), and determines acceptance/rejection based on the terms of the associated accepted quote.

func NewOrderHandler 

func NewOrderHandler(cfg OrderHandlerCfg) (*OrderHandler, error)

NewOrderHandler creates a new struct instance.

func (*OrderHandler) RegisterAssetPurchasePolicy 

func (h *OrderHandler) RegisterAssetPurchasePolicy(
	sellAccept rfqmsg.SellAccept)

RegisterAssetPurchasePolicy generates and registers an asset buy policy with the order handler. This function takes an incoming sell accept message as an argument.

func (*OrderHandler) RegisterAssetSalePolicy 

func (h *OrderHandler) RegisterAssetSalePolicy(buyAccept rfqmsg.BuyAccept)

RegisterAssetSalePolicy generates and registers an asset sale policy with the order handler. This function takes an outgoing buy accept message as an argument.

func (*OrderHandler) Start 

func (h *OrderHandler) Start() error

Start starts the service.

func (*OrderHandler) Stop 

func (h *OrderHandler) Stop() error

Stop stops the handler.

type OrderHandlerCfg 

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
}

OrderHandlerCfg is a struct that holds the configuration parameters for the order handler service.

type PeerAcceptedBuyQuoteEvent 

type PeerAcceptedBuyQuoteEvent struct {

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

PeerAcceptedBuyQuoteEvent is an event that is broadcast when the RFQ manager receives an accept quote message from a peer. This is a quote which was requested by our node and has been accepted by a peer.

func NewPeerAcceptedBuyQuoteEvent 

func NewPeerAcceptedBuyQuoteEvent(
	buyAccept *rfqmsg.BuyAccept) *PeerAcceptedBuyQuoteEvent

NewPeerAcceptedBuyQuoteEvent creates a new PeerAcceptedBuyQuoteEvent.

func (*PeerAcceptedBuyQuoteEvent) Timestamp 

func (q *PeerAcceptedBuyQuoteEvent) Timestamp() time.Time

Timestamp returns the event creation UTC timestamp.

type PeerAcceptedSellQuoteEvent 

type PeerAcceptedSellQuoteEvent struct {

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

PeerAcceptedSellQuoteEvent is an event that is broadcast when the RFQ manager receives an asset sell request accept quote message from a peer. This is a quote which was requested by our node and has been accepted by a peer.

func NewPeerAcceptedSellQuoteEvent 

func NewPeerAcceptedSellQuoteEvent(
	sellAccept *rfqmsg.SellAccept) *PeerAcceptedSellQuoteEvent

NewPeerAcceptedSellQuoteEvent creates a new PeerAcceptedSellQuoteEvent.

func (*PeerAcceptedSellQuoteEvent) Timestamp 

func (q *PeerAcceptedSellQuoteEvent) Timestamp() time.Time

Timestamp returns the event creation UTC timestamp.

type PeerMessenger 

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
}

PeerMessenger is an interface that abstracts the peer message transport layer.

type Policy 

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

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

Policy is an interface that abstracts the terms which determine whether an asset sale/purchase channel HTLC is accepted or rejected.

type PriceOracle 

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, assetId *asset.ID,
		assetGroupKey *btcec.PublicKey, assetAmount uint64,
		suggestedBidPrice *lnwire.MilliSatoshi) (*OracleAskResponse,
		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, assetId *asset.ID,
		assetGroupKey *btcec.PublicKey,
		assetAmount uint64) (*OracleBidResponse, error)
}

PriceOracle is an interface that provides exchange rate information for assets.

type QuoteRespStatus 

type QuoteRespStatus uint8

QuoteRespStatus is an enumeration of possible quote response statuses. 

const (
	// InvalidRateTickQuoteRespStatus indicates that the rate tick in the
	// quote response is invalid.
	InvalidRateTickQuoteRespStatus QuoteRespStatus = 0

	// InvalidExpiryQuoteRespStatus indicates that the expiry in the quote
	// response is invalid.
	InvalidExpiryQuoteRespStatus QuoteRespStatus = 1

	// PriceOracleQueryErrQuoteRespStatus indicates that an error occurred
	// when querying the price oracle whilst evaluating the quote response.
	PriceOracleQueryErrQuoteRespStatus QuoteRespStatus = 2
)

type RpcPriceOracle 

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

RpcPriceOracle is a price oracle that uses an external RPC server to get exchange rate information.

func NewRpcPriceOracle 

func NewRpcPriceOracle(addrStr string, dialInsecure bool) (*RpcPriceOracle,
	error)

NewRpcPriceOracle creates a new RPC price oracle handle given the address of the price oracle RPC server.

func (*RpcPriceOracle) QueryAskPrice 

func (r *RpcPriceOracle) QueryAskPrice(ctx context.Context,
	assetId *asset.ID, assetGroupKey *btcec.PublicKey, assetAmount uint64,
	bidPrice *lnwire.MilliSatoshi) (*OracleAskResponse, error)

QueryAskPrice returns the ask price for the given asset amount.

func (*RpcPriceOracle) QueryBidPrice 

func (r *RpcPriceOracle) QueryBidPrice(ctx context.Context, assetId *asset.ID,
	assetGroupKey *btcec.PublicKey,
	maxAssetAmount uint64) (*OracleBidResponse, error)

QueryBidPrice returns a bid price for the given asset amount.

type ScidAliasManager 

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
}

ScidAliasManager is an interface that can add short channel ID (SCID) aliases to the local SCID alias store.

type SellOffer 

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
}

SellOffer is a struct that represents an asset sell offer. This data structure describes the maximum amount of an asset that is available for sale.

A sell offer is passive (unlike a buy order), meaning that it does not actively lead to a bid request from a peer. Instead, it is used by the node to selectively accept or reject incoming quote requests early before price considerations.

func (*SellOffer) Validate 

func (a *SellOffer) Validate() error

Validate validates the asset sell offer.

type SellOrder 

type SellOrder struct {
	// AssetID is the ID of the asset to sell.
	AssetID *asset.ID

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

	// MaxAssetAmount is the maximum amount of the asset that can be sold as
	// part of the order.
	MaxAssetAmount uint64

	// MinAsk is the minimum ask price that the seller is willing to accept.
	MinAsk lnwire.MilliSatoshi

	// Expiry is the unix timestamp at which the order expires.
	Expiry uint64

	// Peer is the peer that the buy order is intended for. This field is
	// optional.
	Peer *route.Vertex
}

SellOrder is a struct that represents an asset sell order.

type SerialisedScid 

type SerialisedScid = rfqmsg.SerialisedScid

SerialisedScid is a serialised short channel id (SCID).

type StreamHandler 

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
}

StreamHandler is a struct that handles incoming and outgoing peer RFQ stream messages.

This component subscribes to incoming raw peer messages (custom messages). It processes those messages with the aim of extracting relevant request for quotes (RFQs).

func NewStreamHandler 

func NewStreamHandler(ctx context.Context,
	cfg StreamHandlerCfg) (*StreamHandler, error)

NewStreamHandler creates and starts a new RFQ stream handler.

TODO(ffranr): Pass in a signer so that we can create a signature over output message fields.

func (*StreamHandler) HandleOutgoingMessage 

func (h *StreamHandler) HandleOutgoingMessage(
	outgoingMsg rfqmsg.OutgoingMsg) error

HandleOutgoingMessage handles an outgoing RFQ message.

func (*StreamHandler) Start 

func (h *StreamHandler) Start() error

Start starts the service.

func (*StreamHandler) Stop 

func (h *StreamHandler) Stop() error

Stop stops the handler.

type StreamHandlerCfg 

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
}

StreamHandlerCfg is a struct that holds the configuration parameters for the RFQ peer message stream handler.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.