Merge pull request #2833 from filecoin-project/feat/list-retrieval-deals

Add CLI to list retrieval deals

api/api_storage.go

@@ -72,6 +72,7 @@ type StorageMiner interface {
 
 	MarketImportDealData(ctx context.Context, propcid cid.Cid, path string) error
 	MarketListDeals(ctx context.Context) ([]storagemarket.StorageDeal, error)
+	MarketListRetrievalDeals(ctx context.Context) ([]retrievalmarket.ProviderDealState, error)
 	MarketListIncompleteDeals(ctx context.Context) ([]storagemarket.MinerDeal, error)
 	MarketSetAsk(ctx context.Context, price types.BigInt, verifiedPrice types.BigInt, duration abi.ChainEpoch, minPieceSize abi.PaddedPieceSize, maxPieceSize abi.PaddedPieceSize) error
 	MarketGetAsk(ctx context.Context) (*storagemarket.SignedStorageAsk, error)

api/apistruct/struct.go

@@ -215,6 +215,7 @@ type StorageMinerStruct struct {
 
 		MarketImportDealData      func(context.Context, cid.Cid, string) error                                                                                                                                 `perm:"write"`
 		MarketListDeals           func(ctx context.Context) ([]storagemarket.StorageDeal, error)                                                                                                               `perm:"read"`
+		MarketListRetrievalDeals  func(ctx context.Context) ([]retrievalmarket.ProviderDealState, error)                                                                                                       `perm:"read"`
 		MarketListIncompleteDeals func(ctx context.Context) ([]storagemarket.MinerDeal, error)                                                                                                                 `perm:"read"`
 		MarketSetAsk              func(ctx context.Context, price types.BigInt, verifiedPrice types.BigInt, duration abi.ChainEpoch, minPieceSize abi.PaddedPieceSize, maxPieceSize abi.PaddedPieceSize) error `perm:"admin"`
 		MarketGetAsk              func(ctx context.Context) (*storagemarket.SignedStorageAsk, error)                                                                                                           `perm:"read"`
@@ -396,6 +397,7 @@ func (c *FullNodeStruct) ClientMinerQueryOffer(ctx context.Context, miner addres
 func (c *FullNodeStruct) ClientStartDeal(ctx context.Context, params *api.StartDealParams) (*cid.Cid, error) {
 	return c.Internal.ClientStartDeal(ctx, params)
 }
+
 func (c *FullNodeStruct) ClientGetDealInfo(ctx context.Context, deal cid.Cid) (*api.DealInfo, error) {
 	return c.Internal.ClientGetDealInfo(ctx, deal)
 }
@@ -989,6 +991,10 @@ func (c *StorageMinerStruct) MarketListDeals(ctx context.Context) ([]storagemark
 	return c.Internal.MarketListDeals(ctx)
 }
 
+func (c *StorageMinerStruct) MarketListRetrievalDeals(ctx context.Context) ([]retrievalmarket.ProviderDealState, error) {
+	return c.Internal.MarketListRetrievalDeals(ctx)
+}
+
 func (c *StorageMinerStruct) MarketListIncompleteDeals(ctx context.Context) ([]storagemarket.MinerDeal, error) {
 	return c.Internal.MarketListIncompleteDeals(ctx)
 }

cmd/lotus-storage-miner/retrieval-deals.go

@@ -2,9 +2,13 @@ package main
 
 import (
 	"fmt"
+	"os"
+	"text/tabwriter"
+
+	"github.com/filecoin-project/go-fil-markets/retrievalmarket"
+	"github.com/urfave/cli/v2"
 
 	lcli "github.com/filecoin-project/lotus/cli"
-	"github.com/urfave/cli/v2"
 )
 
 var retrievalDealsCmd = &cli.Command{
@@ -12,6 +16,7 @@ var retrievalDealsCmd = &cli.Command{
 	Usage: "Manage retrieval deals and related configuration",
 	Subcommands: []*cli.Command{
 		retrievalDealSelectionCmd,
+		retrievalDealsListCmd,
 	},
 }
 
@@ -111,3 +116,41 @@ var retrievalDealSelectionRejectCmd = &cli.Command{
 		return nil
 	},
 }
+
+var retrievalDealsListCmd = &cli.Command{
+	Name:  "list",
+	Usage: "List all active retrieval deals for this miner",
+	Action: func(cctx *cli.Context) error {
+		api, closer, err := lcli.GetStorageMinerAPI(cctx)
+		if err != nil {
+			return err
+		}
+		defer closer()
+
+		deals, err := api.MarketListRetrievalDeals(lcli.DaemonContext(cctx))
+		if err != nil {
+			return err
+		}
+
+		w := tabwriter.NewWriter(os.Stdout, 2, 4, 2, ' ', 0)
+
+		_, _ = fmt.Fprintf(w, "Receiver\tDealID\tPayload\tState\tPricePerByte\tBytesSent\tMessage\n")
+
+		for _, deal := range deals {
+			payloadCid := deal.PayloadCID.String()
+
+			_, _ = fmt.Fprintf(w,
+				"%s\t%d\t%s\t%s\t%s\t%d\t%s\n",
+				deal.Receiver.String(),
+				deal.ID,
+				"..."+payloadCid[len(payloadCid)-8:],
+				retrievalmarket.DealStatuses[deal.Status],
+				deal.PricePerByte.String(),
+				deal.TotalSent,
+				deal.Message,
+			)
+		}
+
+		return w.Flush()
+	},
+}

node/impl/storminer.go

@@ -287,6 +287,17 @@ func (sm *StorageMinerAPI) MarketListDeals(ctx context.Context) ([]storagemarket
 	return sm.StorageProvider.ListDeals(ctx)
 }
 
+func (sm *StorageMinerAPI) MarketListRetrievalDeals(ctx context.Context) ([]retrievalmarket.ProviderDealState, error) {
+	var out []retrievalmarket.ProviderDealState
+	deals := sm.RetrievalProvider.ListDeals()
+
+	for _, deal := range deals {
+		out = append(out, deal)
+	}
+
+	return out, nil
+}
+
 func (sm *StorageMinerAPI) MarketListIncompleteDeals(ctx context.Context) ([]storagemarket.MinerDeal, error) {
 	return sm.StorageProvider.ListLocalDeals()
 }
@@ -317,6 +328,10 @@ func (sm *StorageMinerAPI) DealsList(ctx context.Context) ([]storagemarket.Stora
 	return sm.StorageProvider.ListDeals(ctx)
 }
 
+func (sm *StorageMinerAPI) RetrievalDealsList(ctx context.Context) (map[retrievalmarket.ProviderDealIdentifier]retrievalmarket.ProviderDealState, error) {
+	return sm.RetrievalProvider.ListDeals(), nil
+}
+
 func (sm *StorageMinerAPI) DealsConsiderOnlineStorageDeals(ctx context.Context) (bool, error) {
 	return sm.ConsiderOnlineStorageDealsConfigFunc()
 }