refactor: rename PledgeCollateral to DealCollateral (#563)

Author: dirkmc

README.md

@@ -142,7 +142,7 @@ boostd --vv init \
        --api-sealer=`lotus-miner auth api-info --perm=admin` \
        --api-sector-index=`lotus-miner auth api-info --perm=admin` \
        --wallet-publish-storage-deals=`lotus wallet new bls` \
-       --wallet-collateral-pledge=`lotus wallet new bls` \
+       --wallet-deal-collateral=`lotus wallet new bls` \
        --max-staging-deals-bytes=50000000000
 ```
 

cmd/boostd/init.go

@@ -58,8 +58,8 @@ var initCmd = &cli.Command{
 			Required: true,
 		},
 		&cli.StringFlag{
-			Name:     "wallet-collateral-pledge",
-			Usage:    "wallet to be used for pledging collateral",
+			Name:     "wallet-deal-collateral",
+			Usage:    "wallet to be used for deal collateral",
 			Required: true,
 		},
 		&cli.Int64Flag{
@@ -138,8 +138,8 @@ var migrateFlags = []cli.Flag{
 		Required: true,
 	},
 	&cli.StringFlag{
-		Name:     "wallet-collateral-pledge",
-		Usage:    "wallet to be used for pledging collateral",
+		Name:     "wallet-deal-collateral",
+		Usage:    "wallet to be used for deal collateral",
 		Required: true,
 	},
 	&cli.Int64Flag{
@@ -531,13 +531,13 @@ func initBoost(ctx context.Context, cctx *cli.Context, marketsRepo lotus_repo.Lo
 		return nil, fmt.Errorf("failed to parse wallet-publish-storage-deals: %s; err: %w", cctx.String("wallet-publish-storage-deals"), err)
 	}
 
-	walletCP, err := address.NewFromString(cctx.String("wallet-collateral-pledge"))
+	walletCP, err := address.NewFromString(cctx.String("wallet-deal-collateral"))
 	if err != nil {
-		return nil, fmt.Errorf("failed to parse wallet-collateral-pledge: %s; err: %w", cctx.String("wallet-collateral-pledge"), err)
+		return nil, fmt.Errorf("failed to parse wallet-deal-collateral: %s; err: %w", cctx.String("wallet-deal-collateral"), err)
 	}
 
 	if walletPSD.String() == walletCP.String() {
-		return nil, fmt.Errorf("wallets for PublishStorageDeals and pledging collateral must be different")
+		return nil, fmt.Errorf("wallets for PublishStorageDeals and deal collateral must be different")
 	}
 
 	if cctx.Int64("max-staging-deals-bytes") <= 0 {
@@ -659,7 +659,7 @@ func setMinerApiConfig(cctx *cli.Context, rcfg *config.Boost, dialCheck bool) er
 func setCommonConfig(cctx *cli.Context, rcfg *config.Boost, bp *boostParams) {
 	rcfg.Dealmaking.MaxStagingDealsBytes = cctx.Int64("max-staging-deals-bytes")
 	rcfg.Wallets.Miner = bp.minerActor.String()
-	rcfg.Wallets.PledgeCollateral = bp.walletCP.String()
+	rcfg.Wallets.DealCollateral = bp.walletCP.String()
 	rcfg.Wallets.PublishStorageDeals = bp.walletPSD.String()
 }
 

documentation/devnet.md

@@ -112,7 +112,7 @@ boostd -vv init \
   --api-sealer=$MINER_API_INFO \
   --api-sector-index=$MINER_API_INFO \
   --wallet-publish-storage-deals=$PUBMSG_WALLET \
-  --wallet-collateral-pledge=$COLLAT_WALLET \
+  --wallet-deal-collateral=$COLLAT_WALLET \
   --max-staging-deals-bytes=2000000000
 ```
 

fundmanager/fundmanager.go

@@ -31,7 +31,7 @@ type Config struct {
 	// The address of the storage miner, used as the target address when
 	// moving funds to escrow
 	StorageMiner address.Address
-	// Wallet used as source of pledge collateral when moving funds to
+	// Wallet used as source of deal collateral when moving funds to
 	// escrow
 	CollatWallet address.Address
 	// Wallet used to send the publish message (and pay gas fees)
@@ -192,7 +192,7 @@ func (m *FundManager) persistTagged(ctx context.Context, dealUuid uuid.UUID, dea
 	return nil
 }
 
-// MoveFundsToEscrow moves funds from the pledge collateral wallet into escrow with
+// MoveFundsToEscrow moves funds from the deal collateral wallet into escrow with
 // the storage market actor
 func (m *FundManager) MoveFundsToEscrow(ctx context.Context, amt abi.TokenAmount) (cid.Cid, error) {
 	msgCid, err := m.api.MarketAddBalance(ctx, m.cfg.CollatWallet, m.cfg.StorageMiner, amt)
@@ -214,13 +214,13 @@ func (m *FundManager) BalanceMarket(ctx context.Context) (storagemarket.Balance,
 	return toSharedBalance(bal), nil
 }
 
-// BalancePledgeCollateral returns the amount of funds in the wallet used for
-// pledging collateral for deal making
-func (m *FundManager) BalancePledgeCollateral(ctx context.Context) (abi.TokenAmount, error) {
+// BalanceDealCollateral returns the amount of funds in the wallet used for
+// collateral for deal making
+func (m *FundManager) BalanceDealCollateral(ctx context.Context) (abi.TokenAmount, error) {
 	return m.api.WalletBalance(ctx, m.cfg.CollatWallet)
 }
 
-func (m *FundManager) AddressPledgeCollateral() address.Address {
+func (m *FundManager) AddressDealCollateral() address.Address {
 	return m.cfg.CollatWallet
 }
 

gql/resolver_funds.go

@@ -44,9 +44,9 @@ func (r *resolver) Funds(ctx context.Context) (*funds, error) {
 		return nil, fmt.Errorf("getting publish message balance: %w", err)
 	}
 
-	balCollateral, err := r.fundMgr.BalancePledgeCollateral(ctx)
+	balCollateral, err := r.fundMgr.BalanceDealCollateral(ctx)
 	if err != nil {
-		return nil, fmt.Errorf("getting pledge collateral balance: %w", err)
+		return nil, fmt.Errorf("getting deal collateral balance: %w", err)
 	}
 
 	return &funds{
@@ -56,7 +56,7 @@ func (r *resolver) Funds(ctx context.Context) (*funds, error) {
 			Locked:    gqltypes.BigInt{Int: balMkt.Locked},
 		},
 		Collateral: fundsWallet{
-			Address: r.fundMgr.AddressPledgeCollateral().String(),
+			Address: r.fundMgr.AddressDealCollateral().String(),
 			Balance: gqltypes.BigInt{Int: balCollateral},
 		},
 		PubMsg: fundsWallet{

gql/schema.graphql

@@ -365,7 +365,7 @@ type RootMutation {
   """Publish all pending deals now"""
   dealPublishNow: Boolean!
 
-  """Top-up the available pledge collateral in escrow for deal publishing"""
+  """Top-up the available deal collateral in escrow for deal publishing"""
   fundsMoveToEscrow(amount: BigInt!): Boolean!
 
   """Update the Storage Ask (price of doing a storage deal)"""

node/builder.go

@@ -409,9 +409,13 @@ func ConfigBoost(c interface{}) Option {
 		return Error(errors.New("retrieval pricing policy must be either default or external"))
 	}
 
-	walletPledgeCollat, err := address.NewFromString(cfg.Wallets.PledgeCollateral)
+	collatWalletStr := cfg.Wallets.DealCollateral
+	if collatWalletStr == "" && cfg.Wallets.PledgeCollateral != "" { // nolint:staticcheck
+		collatWalletStr = cfg.Wallets.PledgeCollateral // nolint:staticcheck
+	}
+	walletDealCollat, err := address.NewFromString(collatWalletStr)
 	if err != nil {
-		return Error(fmt.Errorf("failed to parse cfg.Wallets.PledgeCollateral: %s; err: %w", cfg.Wallets.PledgeCollateral, err))
+		return Error(fmt.Errorf("failed to parse deal collateral wallet: '%s'; err: %w", collatWalletStr, err))
 	}
 	walletPSD, err := address.NewFromString(cfg.Wallets.PublishStorageDeals)
 	if err != nil {
@@ -441,7 +445,7 @@ func ConfigBoost(c interface{}) Option {
 
 		Override(new(*fundmanager.FundManager), fundmanager.New(fundmanager.Config{
 			StorageMiner: walletMiner,
-			CollatWallet: walletPledgeCollat,
+			CollatWallet: walletDealCollat,
 			PubMsgWallet: walletPSD,
 			PubMsgBalMin: abi.TokenAmount(cfg.Dealmaking.PublishMsgMaxFee),
 		})),

node/config/doc_gen.go

@@ -58,7 +58,9 @@ type WalletsConfig struct {
 	// The wallet used to send PublishStorageDeals messages.
 	// Must be a control or worker address of the miner.
 	PublishStorageDeals string
-	// The wallet used as the source for pledge collateral
+	// The wallet used as the source for storage deal collateral
+	DealCollateral string
+	// Deprecated: Renamed to DealCollateral
 	PledgeCollateral string
 }