feat(clientstates): handle payment chanel ready to go (#677)

handle GetOrCreatePaymentChannel returns cid.Undef as payment channel being ready to use

docs/retrievalclient.mmd

@@ -79,6 +79,7 @@ stateDiagram-v2
 	DealStatusCheckFunds --> DealStatusPaymentChannelAddingFunds : ClientEventPaymentChannelAddingFunds
 	DealStatusPaymentChannelCreating --> DealStatusPaymentChannelAllocatingLane : ClientEventPaymentChannelReady
 	DealStatusPaymentChannelAddingFunds --> DealStatusOngoing : ClientEventPaymentChannelReady
+	DealStatusAccepted --> DealStatusPaymentChannelAllocatingLane : ClientEventPaymentChannelReady
 	DealStatusCheckFunds --> DealStatusOngoing : ClientEventPaymentChannelReady
 	DealStatusPaymentChannelAddingInitialFunds --> DealStatusPaymentChannelAllocatingLane : ClientEventPaymentChannelReady
 	DealStatusPaymentChannelAllocatingLane --> DealStatusFailing : ClientEventAllocateLaneErrored

retrievalmarket/impl/clientstates/client_fsm.go

@@ -119,8 +119,7 @@ var ClientEvents = fsm.Events{
 		// created for an earlier deal but the initial funding for this deal
 		// was being added, then we still need to allocate a payment channel
 		// lane
-		From(rm.DealStatusPaymentChannelCreating).To(rm.DealStatusPaymentChannelAllocatingLane).
-		From(rm.DealStatusPaymentChannelAddingInitialFunds).To(rm.DealStatusPaymentChannelAllocatingLane).
+		FromMany(rm.DealStatusPaymentChannelCreating, rm.DealStatusPaymentChannelAddingInitialFunds, rm.DealStatusAccepted).To(rm.DealStatusPaymentChannelAllocatingLane).
 		// If the payment channel ran out of funds and needed to be topped up,
 		// then the payment channel lane already exists so just move straight
 		// to the ongoing state

retrievalmarket/impl/clientstates/client_states.go

@@ -3,6 +3,7 @@ package clientstates
 import (
 	"context"
 
+	"github.com/ipfs/go-cid"
 	logging "github.com/ipfs/go-log/v2"
 	peer "github.com/libp2p/go-libp2p-core/peer"
 
@@ -59,6 +60,9 @@ func SetupPaymentChannelStart(ctx fsm.Context, environment ClientDealEnvironment
 		return ctx.Trigger(rm.ClientEventPaymentChannelCreateInitiated, msgCID)
 	}
 
+	if msgCID == cid.Undef {
+		return ctx.Trigger(rm.ClientEventPaymentChannelReady, paych)
+	}
 	return ctx.Trigger(rm.ClientEventPaymentChannelAddingFunds, msgCID, paych)
 }
 

retrievalmarket/impl/clientstates/client_states_test.go

@@ -6,6 +6,7 @@ import (
 	"math/rand"
 	"testing"
 
+	"github.com/ipfs/go-cid"
 	peer "github.com/libp2p/go-libp2p-core/peer"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -141,6 +142,19 @@ func TestSetupPaymentChannel(t *testing.T) {
 		require.Equal(t, expectedPayCh, dealState.PaymentInfo.PayCh)
 	})
 
+	t.Run("payment channel fully ready", func(t *testing.T) {
+		envParams := testnodes.TestRetrievalClientNodeParams{
+			AddFundsOnly: true,
+			PayCh:        expectedPayCh,
+			AddFundsCID:  cid.Undef,
+		}
+		dealState := makeDealState(retrievalmarket.DealStatusAccepted)
+		runSetupPaymentChannel(t, envParams, dealState)
+		require.Empty(t, dealState.Message)
+		require.Equal(t, dealState.Status, retrievalmarket.DealStatusPaymentChannelAllocatingLane)
+		require.Equal(t, expectedPayCh, dealState.PaymentInfo.PayCh)
+	})
+
 	t.Run("when create payment channel fails", func(t *testing.T) {
 		dealState := makeDealState(retrievalmarket.DealStatusAccepted)
 		envParams := testnodes.TestRetrievalClientNodeParams{