assets: add basic asset client

Author: sputn1ck

assets/client.go

@@ -0,0 +1,212 @@
+package assets
+
+import (
+	"context"
+	"encoding/hex"
+	"fmt"
+	"os"
+	"sync"
+	"time"
+
+	"github.com/btcsuite/btcd/btcutil"
+	"github.com/lightninglabs/taproot-assets/tapcfg"
+	"github.com/lightninglabs/taproot-assets/taprpc"
+	"github.com/lightninglabs/taproot-assets/taprpc/priceoraclerpc"
+	"github.com/lightninglabs/taproot-assets/taprpc/rfqrpc"
+	"github.com/lightninglabs/taproot-assets/taprpc/tapchannelrpc"
+	"github.com/lightninglabs/taproot-assets/taprpc/universerpc"
+	"github.com/lightningnetwork/lnd/lnrpc"
+	"github.com/lightningnetwork/lnd/macaroons"
+	"google.golang.org/grpc"
+	"google.golang.org/grpc/credentials"
+	"gopkg.in/macaroon.v2"
+)
+
+var (
+	maxMsgRecvSize    = grpc.MaxCallRecvMsgSize(400 * 1024 * 1024)
+	defaultRfqTimeout = time.Second * 60
+)
+
+// TapdConfig is a struct that holds the configuration options to connect to a
+// taproot assets daemon.
+type TapdConfig struct {
+	Activate     bool          `long:"activate" description:"Activate the Tap daemon"`
+	Host         string        `long:"host" description:"The host of the Tap daemon, in the format of host:port"`
+	MacaroonPath string        `long:"macaroonpath" description:"Path to the admin macaroon"`
+	TLSPath      string        `long:"tlspath" description:"Path to the TLS certificate"`
+	RFQtimeout   time.Duration `long:"rfqtimeout" description:"The Timeout we wait for tapd peer to accept RFQ"`
+}
+
+// DefaultTapdConfig returns a default configuration to connect to a taproot
+// assets daemon.
+func DefaultTapdConfig() *TapdConfig {
+	defaultConf := tapcfg.DefaultConfig()
+	return &TapdConfig{
+		Activate:     false,
+		Host:         "localhost:10029",
+		MacaroonPath: defaultConf.RpcConf.MacaroonPath,
+		TLSPath:      defaultConf.RpcConf.TLSCertPath,
+		RFQtimeout:   defaultRfqTimeout,
+	}
+}
+
+// TapdClient is a client for the Tap daemon.
+type TapdClient struct {
+	sync.Mutex
+	taprpc.TaprootAssetsClient
+	tapchannelrpc.TaprootAssetChannelsClient
+	priceoraclerpc.PriceOracleClient
+	rfqrpc.RfqClient
+	universerpc.UniverseClient
+
+	cfg            *TapdConfig
+	assetNameCache map[string]string
+	cc             *grpc.ClientConn
+}
+
+// NewTapdClient returns a new taproot assets client.
+func NewTapdClient(config *TapdConfig) (*TapdClient, error) {
+	// Create the client connection to the server.
+	conn, err := getClientConn(config)
+	if err != nil {
+		return nil, err
+	}
+
+	// Create the TapdClient.
+	client := &TapdClient{
+		assetNameCache:             make(map[string]string),
+		cc:                         conn,
+		cfg:                        config,
+		TaprootAssetsClient:        taprpc.NewTaprootAssetsClient(conn),
+		TaprootAssetChannelsClient: tapchannelrpc.NewTaprootAssetChannelsClient(conn),
+		PriceOracleClient:          priceoraclerpc.NewPriceOracleClient(conn),
+		RfqClient:                  rfqrpc.NewRfqClient(conn),
+		UniverseClient:             universerpc.NewUniverseClient(conn),
+	}
+
+	return client, nil
+}
+
+// Close closes the client connection to the server.
+func (c *TapdClient) Close() {
+	c.cc.Close()
+}
+
+// GetRfqForAsset returns a RFQ for the given asset with the given amount and
+// to the given peer.
+func (c *TapdClient) GetRfqForAsset(ctx context.Context,
+	satAmount btcutil.Amount, assetId, peerPubkey []byte,
+	expiry int64, feeLimitMultiplier float64) (
+	*rfqrpc.PeerAcceptedSellQuote, error) {
+
+	feeLimit, err := lnrpc.UnmarshallAmt(
+		int64(satAmount)+int64(satAmount.MulF64(feeLimitMultiplier)), 0,
+	)
+	if err != nil {
+		return nil, err
+	}
+
+	rfq, err := c.RfqClient.AddAssetSellOrder(
+		ctx, &rfqrpc.AddAssetSellOrderRequest{
+			AssetSpecifier: &rfqrpc.AssetSpecifier{
+				Id: &rfqrpc.AssetSpecifier_AssetId{
+					AssetId: assetId,
+				},
+			},
+			PeerPubKey:     peerPubkey,
+			PaymentMaxAmt:  uint64(feeLimit),
+			Expiry:         uint64(expiry),
+			TimeoutSeconds: uint32(c.cfg.RFQtimeout.Seconds()),
+		})
+	if err != nil {
+		return nil, err
+	}
+	if rfq.GetInvalidQuote() != nil {
+		return nil, fmt.Errorf("invalid RFQ: %v", rfq.GetInvalidQuote())
+	}
+	if rfq.GetRejectedQuote() != nil {
+		return nil, fmt.Errorf("rejected RFQ: %v",
+			rfq.GetRejectedQuote())
+	}
+
+	if rfq.GetAcceptedQuote() != nil {
+		return rfq.GetAcceptedQuote(), nil
+	}
+
+	return nil, fmt.Errorf("no accepted quote")
+}
+
+// GetAssetName returns the human-readable name of the asset.
+func (c *TapdClient) GetAssetName(ctx context.Context,
+	assetId []byte) (string, error) {
+
+	c.Lock()
+	defer c.Unlock()
+	assetIdStr := hex.EncodeToString(assetId)
+	if name, ok := c.assetNameCache[assetIdStr]; ok {
+		return name, nil
+	}
+
+	assetStats, err := c.UniverseClient.QueryAssetStats(
+		ctx, &universerpc.AssetStatsQuery{
+			AssetIdFilter: assetId,
+		},
+	)
+	if err != nil {
+		return "", err
+	}
+
+	if len(assetStats.AssetStats) == 0 {
+		return "", fmt.Errorf("asset not found")
+	}
+
+	var assetName string
+
+	// If the asset belongs to a group, return the group name.
+	if assetStats.AssetStats[0].GroupAnchor != nil {
+		assetName = assetStats.AssetStats[0].GroupAnchor.AssetName
+	} else {
+		assetName = assetStats.AssetStats[0].Asset.AssetName
+	}
+
+	c.assetNameCache[assetIdStr] = assetName
+
+	return assetName, nil
+}
+
+func getClientConn(config *TapdConfig) (*grpc.ClientConn, error) {
+	// Load the specified TLS certificate and build transport credentials.
+	creds, err := credentials.NewClientTLSFromFile(config.TLSPath, "")
+	if err != nil {
+		return nil, err
+	}
+
+	// Load the specified macaroon file.
+	macBytes, err := os.ReadFile(config.MacaroonPath)
+	if err != nil {
+		return nil, err
+	}
+	mac := &macaroon.Macaroon{}
+	if err := mac.UnmarshalBinary(macBytes); err != nil {
+		return nil, err
+	}
+
+	macaroon, err := macaroons.NewMacaroonCredential(mac)
+	if err != nil {
+		return nil, err
+	}
+	// Create the DialOptions with the macaroon credentials.
+	opts := []grpc.DialOption{
+		grpc.WithTransportCredentials(creds),
+		grpc.WithPerRPCCredentials(macaroon),
+		grpc.WithDefaultCallOptions(maxMsgRecvSize),
+	}
+
+	// Dial the gRPC server.
+	conn, err := grpc.Dial(config.Host, opts...)
+	if err != nil {
+		return nil, err
+	}
+
+	return conn, nil
+}