feat(storagemarket): new fund manager node interface

remove internal fund manager. switch to using release/reserve on node. Correct language around
ensure/reserve

docs/storageclient.mmd

@@ -6,11 +6,11 @@ stateDiagram-v2
 	state "StorageDealExpired" as 8
 	state "StorageDealSlashed" as 9
 	state "StorageDealFailing" as 11
-	state "StorageDealFundsEnsured" as 12
+	state "StorageDealFundsReserved" as 12
 	state "StorageDealCheckForAcceptance" as 13
 	state "StorageDealStartDataTransfer" as 16
 	state "StorageDealTransferring" as 17
-	state "StorageDealEnsureClientFunds" as 21
+	state "StorageDealReserveClientFunds" as 21
 	state "StorageDealClientFunding" as 23
 	state "StorageDealError" as 26
 	state "StorageDealClientTransferRestart" as 28
@@ -21,7 +21,7 @@ stateDiagram-v2
 	12 : On entry runs ProposeDeal
 	13 : On entry runs CheckForDealAcceptance
 	16 : On entry runs InitiateDataTransfer
-	21 : On entry runs EnsureClientFunds
+	21 : On entry runs ReserveClientFunds
 	23 : On entry runs WaitForFunding
 	28 : On entry runs RestartDataTransfer
 	[*] --> 0
@@ -33,10 +33,10 @@ stateDiagram-v2
 	end note
 	0 --> 21 : ClientEventOpen
 	21 --> 23 : ClientEventFundingInitiated
-	21 --> 11 : ClientEventEnsureFundsFailed
-	23 --> 11 : ClientEventEnsureFundsFailed
-	21 --> 12 : ClientEventFundsEnsured
-	23 --> 12 : ClientEventFundsEnsured
+	21 --> 11 : ClientEventReserveFundsFailed
+	23 --> 11 : ClientEventReserveFundsFailed
+	21 --> 12 : ClientEventFundingComplete
+	23 --> 12 : ClientEventFundingComplete
 	12 --> 26 : ClientEventWriteProposalFailed
 	12 --> 11 : ClientEventReadResponseFailed
 	12 --> 11 : ClientEventResponseVerificationFailed

docs/storageprovider.mmd

@@ -13,7 +13,7 @@ stateDiagram-v2
 	state "StorageDealTransferring" as 17
 	state "StorageDealWaitingForData" as 18
 	state "StorageDealVerifyData" as 19
-	state "StorageDealEnsureProviderFunds" as 20
+	state "StorageDealReserveProviderFunds" as 20
 	state "StorageDealProviderFunding" as 22
 	state "StorageDealPublish" as 24
 	state "StorageDealPublishing" as 25
@@ -28,7 +28,7 @@ stateDiagram-v2
 	14 : On entry runs ValidateDealProposal
 	15 : On entry runs DecideOnProposal
 	19 : On entry runs VerifyData
-	20 : On entry runs EnsureProviderFunds
+	20 : On entry runs ReserveProviderFunds
 	22 : On entry runs WaitForFunding
 	24 : On entry runs PublishDeal
 	25 : On entry runs WaitForPublish

shared_testutil/test_deal_funds.go

@@ -3,8 +3,6 @@ package shared_testutil
 import (
 	"github.com/filecoin-project/go-state-types/abi"
 	"github.com/filecoin-project/go-state-types/big"
-
-	"github.com/filecoin-project/go-fil-markets/storagemarket/impl/funds"
 )
 
 func NewTestDealFunds() *TestDealFunds {
@@ -34,5 +32,3 @@ func (f *TestDealFunds) Release(amount abi.TokenAmount) (abi.TokenAmount, error)
 	f.ReleaseCalls = append(f.ReleaseCalls, amount)
 	return f.reserved, nil
 }
-
-var _ funds.DealFunds = &TestDealFunds{}

storagemarket/README.md

@@ -62,7 +62,8 @@ Implement the [`StorageCommon`](#StorageCommon), [`StorageProviderNode`](#Storag
  functions are:
 * [`GetChainHead`](#GetChainHead)
 * [`AddFunds`](#AddFunds)
-* [`EnsureFunds`](#EnsureFunds)
+* [`ReserveFunds`](#ReserveFunds)
+* [`ReleaseFunds`](#ReleaseFunds)
 * [`GetBalance`](#GetBalance)
 * [`VerifySignature`](#VerifySignature)
 * [`WaitForMessage`](#WaitForMessage)
@@ -76,14 +77,21 @@ func AddFunds(ctx context.Context, addr address.Address, amount abi.TokenAmount)
 
 Send `amount` to `addr` by posting a message on chain. Return the message CID.
 
-#### EnsureFunds
+#### ReserveFunds
 ```go
-func EnsureFunds(ctx context.Context, addr, wallet address.Address, amount abi.TokenAmount, 
-            tok shared.TipSetToken) (cid.Cid, error)
+func ReserveFunds(ctx context.Context, addr, wallet address.Address, amount abi.TokenAmount) (cid.Cid, error)
 ```
 
-Make sure `addr` has `amount` funds and if not, `wallet` should send any needed balance to
-  `addr` by posting a message on chain. Returns the message CID.
+Add `amount` to the total reserved funds for `addr`. If total available balance for `addr` in StorageMarketActor is not greater than total reserved, `wallet` should send any needed balance to `addr` by posting a message on chain. Returns the message CID.
+
+#### ReserveFunds
+```go
+func ReleaseFunds(ctx context.Context, addr address.Address, amount abi.TokenAmount) (cid.Cid, error)
+```
+
+Release `amount` funds from reserved total for `addr`. No withdrawal is performed for `addr` in the storage market actor but the funds released become
+available for future withdrawal
+(if new total reserved < total available in SMA) 
 
 #### GetBalance
 ```go

storagemarket/dealstatus.go

@@ -47,8 +47,8 @@ const (
 	// StorageDealError
 	StorageDealFailing
 
-	// StorageDealFundsEnsured means we've deposited funds as necessary to create a deal, ready to move forward
-	StorageDealFundsEnsured
+	// StorageDealFundsReserved means we've deposited funds as necessary to create a deal, ready to move forward
+	StorageDealFundsReserved
 
 	// StorageDealCheckForAcceptance means the client is waiting for a provider to seal and publish a deal
 	StorageDealCheckForAcceptance
@@ -72,11 +72,11 @@ const (
 	// StorageDealVerifyData means data has been transferred and we are attempting to verify it against the PieceCID
 	StorageDealVerifyData
 
-	// StorageDealEnsureProviderFunds means that provider is making sure it has adequate funds for the deal in the StorageMarketActor
-	StorageDealEnsureProviderFunds
+	// StorageDealReserveProviderFunds means that provider is making sure it has adequate funds for the deal in the StorageMarketActor
+	StorageDealReserveProviderFunds
 
-	// StorageDealEnsureClientFunds means that client is making sure it has adequate funds for the deal in the StorageMarketActor
-	StorageDealEnsureClientFunds
+	// StorageDealReserveClientFunds means that client is making sure it has adequate funds for the deal in the StorageMarketActor
+	StorageDealReserveClientFunds
 
 	// StorageDealProviderFunding means that the provider has deposited funds in the StorageMarketActor and it is waiting
 	// to see the funds appear in its balance
@@ -119,14 +119,14 @@ var DealStates = map[StorageDealStatus]string{
 	StorageDealSlashed:                 "StorageDealSlashed",
 	StorageDealRejecting:               "StorageDealRejecting",
 	StorageDealFailing:                 "StorageDealFailing",
-	StorageDealFundsEnsured:            "StorageDealFundsEnsured",
+	StorageDealFundsReserved:           "StorageDealFundsReserved",
 	StorageDealCheckForAcceptance:      "StorageDealCheckForAcceptance",
 	StorageDealValidating:              "StorageDealValidating",
 	StorageDealTransferring:            "StorageDealTransferring",
 	StorageDealWaitingForData:          "StorageDealWaitingForData",
 	StorageDealVerifyData:              "StorageDealVerifyData",
-	StorageDealEnsureProviderFunds:     "StorageDealEnsureProviderFunds",
-	StorageDealEnsureClientFunds:       "StorageDealEnsureClientFunds",
+	StorageDealReserveProviderFunds:    "StorageDealReserveProviderFunds",
+	StorageDealReserveClientFunds:      "StorageDealReserveClientFunds",
 	StorageDealProviderFunding:         "StorageDealProviderFunding",
 	StorageDealClientFunding:           "StorageDealClientFunding",
 	StorageDealPublish:                 "StorageDealPublish",

storagemarket/events.go

@@ -7,8 +7,8 @@ const (
 	// ClientEventOpen indicates a new deal was started
 	ClientEventOpen ClientEvent = iota
 
-	// ClientEventEnsureFundsFailed happens when attempting to ensure the client has enough funds available fails
-	ClientEventEnsureFundsFailed
+	// ClientEventReserveFundsFailed happens when attempting to reserve funds for a deal fails
+	ClientEventReserveFundsFailed
 
 	// ClientEventFundingInitiated happens when a client has sent a message adding funds to its balance
 	ClientEventFundingInitiated
@@ -19,8 +19,8 @@ const (
 	// ClientEventFundsReleased happens when a client released funds for a deal (updating our tracked funds)
 	ClientEventFundsReleased
 
-	// ClientEventFundsEnsured happens when a client successfully ensures it has funds for a deal
-	ClientEventFundsEnsured
+	// ClientEventFundingComplete happens when a client successfully reserves funds for a deal
+	ClientEventFundingComplete
 
 	// ClientEventWriteProposalFailed indicates an attempt to send a deal proposal to a provider failed
 	ClientEventWriteProposalFailed
@@ -101,11 +101,11 @@ const (
 // ClientEvents maps client event codes to string names
 var ClientEvents = map[ClientEvent]string{
 	ClientEventOpen:                       "ClientEventOpen",
-	ClientEventEnsureFundsFailed:          "ClientEventEnsureFundsFailed",
+	ClientEventReserveFundsFailed:         "ClientEventReserveFundsFailed",
 	ClientEventFundingInitiated:           "ClientEventFundingInitiated",
 	ClientEventFundsReserved:              "ClientEventFundsReserved",
 	ClientEventFundsReleased:              "ClientEventFundsReleased",
-	ClientEventFundsEnsured:               "ClientEventFundsEnsured",
+	ClientEventFundingComplete:            "ClientEventFundingComplete",
 	ClientEventWriteProposalFailed:        "ClientEventWriteProposalFailed",
 	ClientEventInitiateDataTransfer:       "ClientEventInitiateDataTransfer",
 	ClientEventDataTransferInitiated:      "ClientEventDataTransferInitiated",

storagemarket/impl/client.go

@@ -34,7 +34,6 @@ import (
 	"github.com/filecoin-project/go-fil-markets/storagemarket/impl/clientstates"
 	"github.com/filecoin-project/go-fil-markets/storagemarket/impl/clientutils"
 	"github.com/filecoin-project/go-fil-markets/storagemarket/impl/dtutils"
-	"github.com/filecoin-project/go-fil-markets/storagemarket/impl/funds"
 	"github.com/filecoin-project/go-fil-markets/storagemarket/impl/requestvalidation"
 	"github.com/filecoin-project/go-fil-markets/storagemarket/migrations"
 	"github.com/filecoin-project/go-fil-markets/storagemarket/network"
@@ -61,7 +60,6 @@ type Client struct {
 	statemachines        fsm.Group
 	migrateStateMachines func(context.Context) error
 	pollingInterval      time.Duration
-	dealFunds            funds.DealFunds
 
 	unsubDataTransfer datatransfer.Unsubscribe
 }
@@ -86,7 +84,6 @@ func NewClient(
 	discovery *discoveryimpl.Local,
 	ds datastore.Batching,
 	scn storagemarket.StorageClientNode,
-	dealFunds funds.DealFunds,
 	options ...StorageClientOption,
 ) (*Client, error) {
 	carIO := cario.NewCarIO()
@@ -101,7 +98,6 @@ func NewClient(
 		pubSub:          pubsub.New(clientDispatcher),
 		readySub:        pubsub.New(shared.ReadyDispatcher),
 		pollingInterval: DefaultPollingInterval,
-		dealFunds:       dealFunds,
 	}
 	storageMigrations, err := migrations.ClientMigrations.Build()
 	if err != nil {

storagemarket/impl/client_environments.go

@@ -12,7 +12,6 @@ import (
 	"github.com/filecoin-project/go-multistore"
 
 	"github.com/filecoin-project/go-fil-markets/storagemarket"
-	"github.com/filecoin-project/go-fil-markets/storagemarket/impl/funds"
 	"github.com/filecoin-project/go-fil-markets/storagemarket/network"
 )
 
@@ -50,10 +49,6 @@ func (c *clientDealEnvironment) PollingInterval() time.Duration {
 	return c.c.pollingInterval
 }
 
-func (c *clientDealEnvironment) DealFunds() funds.DealFunds {
-	return c.c.dealFunds
-}
-
 type clientStoreGetter struct {
 	c *Client
 }

storagemarket/impl/client_test.go

@@ -125,7 +125,6 @@ func TestClient_Migrations(t *testing.T) {
 		deps.PeerResolver,
 		clientDs,
 		deps.ClientNode,
-		deps.ClientDealFunds,
 		storageimpl.DealPollingInterval(0),
 	)
 	require.NoError(t, err)

storagemarket/impl/clientstates/client_fsm.go

@@ -15,21 +15,21 @@ import (
 // ClientEvents are the events that can happen in a storage client
 var ClientEvents = fsm.Events{
 	fsm.Event(storagemarket.ClientEventOpen).
-		From(storagemarket.StorageDealUnknown).To(storagemarket.StorageDealEnsureClientFunds),
+		From(storagemarket.StorageDealUnknown).To(storagemarket.StorageDealReserveClientFunds),
 	fsm.Event(storagemarket.ClientEventFundingInitiated).
-		From(storagemarket.StorageDealEnsureClientFunds).To(storagemarket.StorageDealClientFunding).
+		From(storagemarket.StorageDealReserveClientFunds).To(storagemarket.StorageDealClientFunding).
 		Action(func(deal *storagemarket.ClientDeal, mcid cid.Cid) error {
 			deal.AddFundsCid = &mcid
 			return nil
 		}),
-	fsm.Event(storagemarket.ClientEventEnsureFundsFailed).
-		FromMany(storagemarket.StorageDealClientFunding, storagemarket.StorageDealEnsureClientFunds).To(storagemarket.StorageDealFailing).
+	fsm.Event(storagemarket.ClientEventReserveFundsFailed).
+		FromMany(storagemarket.StorageDealClientFunding, storagemarket.StorageDealReserveClientFunds).To(storagemarket.StorageDealFailing).
 		Action(func(deal *storagemarket.ClientDeal, err error) error {
 			deal.Message = xerrors.Errorf("adding market funds failed: %w", err).Error()
 			return nil
 		}),
 	fsm.Event(storagemarket.ClientEventFundsReserved).
-		From(storagemarket.StorageDealEnsureClientFunds).ToJustRecord().
+		From(storagemarket.StorageDealReserveClientFunds).ToJustRecord().
 		Action(func(deal *storagemarket.ClientDeal, fundsReserved abi.TokenAmount) error {
 			if deal.FundsReserved.Nil() {
 				deal.FundsReserved = fundsReserved
@@ -44,31 +44,31 @@ var ClientEvents = fsm.Events{
 			deal.FundsReserved = big.Subtract(deal.FundsReserved, fundsReleased)
 			return nil
 		}),
-	fsm.Event(storagemarket.ClientEventFundsEnsured).
-		FromMany(storagemarket.StorageDealEnsureClientFunds, storagemarket.StorageDealClientFunding).To(storagemarket.StorageDealFundsEnsured),
+	fsm.Event(storagemarket.ClientEventFundingComplete).
+		FromMany(storagemarket.StorageDealReserveClientFunds, storagemarket.StorageDealClientFunding).To(storagemarket.StorageDealFundsReserved),
 	fsm.Event(storagemarket.ClientEventWriteProposalFailed).
-		From(storagemarket.StorageDealFundsEnsured).To(storagemarket.StorageDealError).
+		From(storagemarket.StorageDealFundsReserved).To(storagemarket.StorageDealError).
 		Action(func(deal *storagemarket.ClientDeal, err error) error {
 			deal.Message = xerrors.Errorf("sending proposal to storage provider failed: %w", err).Error()
 			return nil
 		}),
 	fsm.Event(storagemarket.ClientEventReadResponseFailed).
-		From(storagemarket.StorageDealFundsEnsured).To(storagemarket.StorageDealFailing).
+		From(storagemarket.StorageDealFundsReserved).To(storagemarket.StorageDealFailing).
 		Action(func(deal *storagemarket.ClientDeal, err error) error {
 			deal.Message = xerrors.Errorf("error reading Response message: %w", err).Error()
 			return nil
 		}),
 	fsm.Event(storagemarket.ClientEventResponseVerificationFailed).
-		From(storagemarket.StorageDealFundsEnsured).To(storagemarket.StorageDealFailing).
+		From(storagemarket.StorageDealFundsReserved).To(storagemarket.StorageDealFailing).
 		Action(func(deal *storagemarket.ClientDeal) error {
 			deal.Message = "unable to verify signature on deal response"
 			return nil
 		}),
 	fsm.Event(storagemarket.ClientEventInitiateDataTransfer).
-		From(storagemarket.StorageDealFundsEnsured).To(storagemarket.StorageDealStartDataTransfer),
+		From(storagemarket.StorageDealFundsReserved).To(storagemarket.StorageDealStartDataTransfer),
 
 	fsm.Event(storagemarket.ClientEventUnexpectedDealState).
-		From(storagemarket.StorageDealFundsEnsured).To(storagemarket.StorageDealFailing).
+		From(storagemarket.StorageDealFundsReserved).To(storagemarket.StorageDealFailing).
 		Action(func(deal *storagemarket.ClientDeal, status storagemarket.StorageDealStatus, providerMessage string) error {
 			deal.Message = xerrors.Errorf("unexpected deal status while waiting for data request: %d (%s). Provider message: %s", status, storagemarket.DealStates[status], providerMessage).Error()
 			return nil
@@ -187,9 +187,9 @@ var ClientEvents = fsm.Events{
 
 // ClientStateEntryFuncs are the handlers for different states in a storage client
 var ClientStateEntryFuncs = fsm.StateEntryFuncs{
-	storagemarket.StorageDealEnsureClientFunds:     EnsureClientFunds,
+	storagemarket.StorageDealReserveClientFunds:    ReserveClientFunds,
 	storagemarket.StorageDealClientFunding:         WaitForFunding,
-	storagemarket.StorageDealFundsEnsured:          ProposeDeal,
+	storagemarket.StorageDealFundsReserved:         ProposeDeal,
 	storagemarket.StorageDealStartDataTransfer:     InitiateDataTransfer,
 	storagemarket.StorageDealClientTransferRestart: RestartDataTransfer,
 	storagemarket.StorageDealCheckForAcceptance:    CheckForDealAcceptance,