WIP: manage sell offers in the negotiator

Author: ffranr

rfqmsg/request.go

@@ -102,7 +102,7 @@ type requestMsgData struct {
 	// ID is the unique identifier of the request for quote (RFQ).
 	ID ID
 
-	// // AssetID represents the identifier of the asset for which the peer
+	// AssetID represents the identifier of the asset for which the peer
 	// is requesting a quote.
 	AssetID *asset.ID
 

rfqservice/negotiator.go

@@ -1,9 +1,12 @@
 package rfqservice
 
 import (
+	"encoding/hex"
 	"fmt"
 	"sync"
 
+	"github.com/btcsuite/btcd/btcec/v2"
+	"github.com/lightninglabs/taproot-assets/asset"
 	"github.com/lightninglabs/taproot-assets/fn"
 	"github.com/lightninglabs/taproot-assets/rfqmsg"
 )
@@ -28,6 +31,12 @@ type Negotiator struct {
 	// messages.
 	outgoingMessages chan<- rfqmsg.OutgoingMsg
 
+	// assetSellOffers is a map (keyed on asset) that holds the asset sell
+	// offers that the negotiator has received.
+	assetSellOffers map[string]AssetSellOffer
+
+	assetGroupSellOffers map[string]AssetSellOffer
+
 	// ContextGuard provides a wait group and main quit channel that can be
 	// used to create guarded contexts.
 	*fn.ContextGuard
@@ -104,6 +113,9 @@ func (n *Negotiator) handlePriceOracleResponse(request rfqmsg.Request,
 
 // HandleIncomingQuoteRequest handles an incoming quote request.
 func (n *Negotiator) HandleIncomingQuoteRequest(req rfqmsg.Request) error {
+	// Ensure that we have a sell offer for the asset that is being
+	// requested.
+
 	// If there is no price oracle available, then we cannot proceed with
 	// the negotiation. We will reject the quote request with an error.
 	if n.cfg.PriceOracle == nil {
@@ -141,6 +153,90 @@ func (n *Negotiator) HandleIncomingQuoteRequest(req rfqmsg.Request) error {
 	return nil
 }
 
+// AssetSellOffer is a struct that represents an asset sell offer. This
+// data structure describes the maximum amount of an asset that is available
+// for sale.
+type AssetSellOffer 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
+
+	// MaxAssetAmount is the maximum amount of the asset under offer.
+	MaxAssetAmount uint64
+}
+
+// Validate validates the asset sell offer.
+func (a *AssetSellOffer) Validate() error {
+	if a.AssetID == nil && a.AssetGroupKey == nil {
+		return fmt.Errorf("asset ID is nil and asset group key is nil")
+	}
+
+	if a.AssetID != nil && a.AssetGroupKey != nil {
+		return fmt.Errorf("asset ID and asset group key are both set")
+	}
+
+	if a.MaxAssetAmount == 0 {
+		return fmt.Errorf("max asset amount is zero")
+	}
+
+	return nil
+}
+
+// UpsertAssetSellOffer upserts an asset sell offer with the negotiator.
+func (n *Negotiator) UpsertAssetSellOffer(offer AssetSellOffer) error {
+	// Validate the offer.
+	err := offer.Validate()
+	if err != nil {
+		return fmt.Errorf("invalid asset sell offer: %w", err)
+	}
+
+	// Store the offer in the appropriate map.
+	//
+	// If the asset group key is not nil, then we will use it as the key for
+	// the offer. Otherwise, we will use the asset ID as the key.
+	switch {
+	case offer.AssetGroupKey != nil:
+		compressedKey := offer.AssetGroupKey.SerializeCompressed()
+		keyStr := hex.EncodeToString(compressedKey)
+
+		n.assetGroupSellOffers[keyStr] = offer
+
+	case offer.AssetID != nil:
+		idStr := offer.AssetID.String()
+		n.assetSellOffers[idStr] = offer
+	}
+
+	return nil
+}
+
+// RemoveAssetSellOffer removes an asset sell offer from the negotiator.
+func (n *Negotiator) RemoveAssetSellOffer(assetID *asset.ID,
+	assetGroupKey *btcec.PublicKey) error {
+
+	// Remove the offer from the appropriate map.
+	//
+	// If the asset group key is not nil, then we will use it as the key for
+	// the offer. Otherwise, we will use the asset ID as the key.
+	switch {
+	case assetGroupKey != nil:
+		compressedKey := assetGroupKey.SerializeCompressed()
+		keyStr := hex.EncodeToString(compressedKey)
+
+		delete(n.assetGroupSellOffers, keyStr)
+
+	case assetID != nil:
+		idStr := assetID.String()
+		delete(n.assetSellOffers, idStr)
+
+	default:
+		return fmt.Errorf("asset ID and asset group key are both nil")
+	}
+
+	return nil
+}
+
 // mainEventLoop executes the main event handling loop.
 func (n *Negotiator) mainEventLoop() {
 	log.Debug("Starting negotiator event loop")

rfqservice/rfq.go

@@ -6,6 +6,8 @@ import (
 	"sync"
 	"time"
 
+	"github.com/btcsuite/btcd/btcec/v2"
+	"github.com/lightninglabs/taproot-assets/asset"
 	"github.com/lightninglabs/taproot-assets/fn"
 	"github.com/lightninglabs/taproot-assets/rfqmsg"
 )
@@ -289,3 +291,27 @@ func (m *Manager) mainEventLoop() {
 		}
 	}
 }
+
+// UpsertAssetSellOffer upserts an asset sell offer with the RFQ manager.
+func (m *Manager) UpsertAssetSellOffer(offer AssetSellOffer) error {
+	// Store the asset sell offer in the negotiator.
+	err := m.negotiator.UpsertAssetSellOffer(offer)
+	if err != nil {
+		return fmt.Errorf("error registering asset sell offer: %w", err)
+	}
+
+	return nil
+}
+
+// RemoveAssetSellOffer removes an asset sell offer from the RFQ manager.
+func (m *Manager) RemoveAssetSellOffer(assetID *asset.ID,
+	assetGroupKey *btcec.PublicKey) error {
+
+	// Remove the asset sell offer from the negotiator.
+	err := m.negotiator.RemoveAssetSellOffer(assetID, assetGroupKey)
+	if err != nil {
+		return fmt.Errorf("error removing asset sell offer: %w", err)
+	}
+
+	return nil
+}

rfqservice/stream.go

@@ -89,9 +89,6 @@ func (h *StreamHandler) handleIncomingQuoteRequest(
 			"from a wire message: %w", err)
 	}
 
-	// TODO(ffranr): Determine whether to keep or discard the RFQ message
-	//  based on the peer's ID and the asset's ID.
-
 	// Send the quote request to the RFQ manager.
 	var msg rfqmsg.IncomingMsg = quoteRequest
 	sendSuccess := fn.SendOrQuit(h.incomingMessages, msg, h.Quit)

rpcserver.go

@@ -4510,6 +4510,49 @@ func (r *rpcServer) RemoveUTXOLease(ctx context.Context,
 	return &wrpc.RemoveUTXOLeaseResponse{}, nil
 }
 
+//func (r *rpcServer) UpsertAssetSellOffer(ctx context.Context,
+//	in *taprpc.BurnAssetRequest) (*taprpc.BurnAssetResponse, error) {
+//
+//	var assetID asset.ID
+//	switch {
+//	case len(in.GetAssetId()) > 0:
+//		copy(assetID[:], in.GetAssetId())
+//
+//	case len(in.GetAssetIdStr()) > 0:
+//		assetIDBytes, err := hex.DecodeString(in.GetAssetIdStr())
+//		if err != nil {
+//			return nil, fmt.Errorf("error decoding asset ID: %w",
+//				err)
+//		}
+//
+//		copy(assetID[:], assetIDBytes)
+//
+//	default:
+//		return nil, fmt.Errorf("asset ID must be specified")
+//	}
+//
+//	var groupKey *btcec.PublicKey
+//	assetGroup, err := r.cfg.TapAddrBook.QueryAssetGroup(ctx, assetID)
+//	switch {
+//	case err == nil && assetGroup.GroupKey != nil:
+//		// We found the asset group, so we can use the group key to
+//		// burn the asset.
+//		groupKey = &assetGroup.GroupPubKey
+//	case errors.Is(err, address.ErrAssetGroupUnknown):
+//		// We don't know the asset group, so we'll try to burn the
+//		// asset using the asset ID only.
+//		rpcsLog.Debug("Asset group key not found, asset may not be " +
+//			"part of a group")
+//	case err != nil:
+//		return nil, fmt.Errorf("error querying asset group: %w", err)
+//	}
+//
+//	var serializedGroupKey []byte
+//	if groupKey != nil {
+//		serializedGroupKey = groupKey.SerializeCompressed()
+//	}
+//}
+
 // MarshalAssetFedSyncCfg returns an RPC ready asset specific federation sync
 // config.
 func MarshalAssetFedSyncCfg(

tapdb/sqlc/migrations/000015_rfq.down.sql

@@ -0,0 +1 @@
+DROP TABLE IF EXISTS asset_sell_offers;

tapdb/sqlc/migrations/000015_rfq.up.sql

@@ -0,0 +1,9 @@
+-- asset_sell_offers is a table that stores the set of all asset sell offers
+-- that are applicable to the RFQ negotiation process.
+CREATE TABLE IF NOT EXISTS asset_sell_offers (
+    txn_id BIGINT PRIMARY KEY,
+
+    asset_id BIGINT REFERENCES assets(asset_id),
+
+    max_amount BIGINT NOT NULL
+);