forked from filecoin-project/go-fil-markets
-
Notifications
You must be signed in to change notification settings - Fork 2
/
client.go
468 lines (420 loc) · 15.3 KB
/
client.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
package retrievalimpl
import (
"context"
"errors"
"sync"
"github.com/hannahhoward/go-pubsub"
bstore "github.com/ipfs/boxo/blockstore"
"github.com/ipfs/go-cid"
"github.com/ipfs/go-datastore"
logging "github.com/ipfs/go-log/v2"
selectorparse "github.com/ipld/go-ipld-prime/traversal/selector/parse"
"github.com/libp2p/go-libp2p/core/peer"
"golang.org/x/xerrors"
"github.com/filecoin-project/go-address"
datatransfer "github.com/filecoin-project/go-data-transfer"
versionedfsm "github.com/filecoin-project/go-ds-versioning/pkg/fsm"
"github.com/filecoin-project/go-state-types/abi"
"github.com/filecoin-project/go-state-types/big"
"github.com/filecoin-project/go-statemachine/fsm"
"github.com/filecoin-project/boost-gfm/discovery"
"github.com/filecoin-project/boost-gfm/retrievalmarket"
"github.com/filecoin-project/boost-gfm/retrievalmarket/impl/clientstates"
"github.com/filecoin-project/boost-gfm/retrievalmarket/impl/dtutils"
"github.com/filecoin-project/boost-gfm/retrievalmarket/migrations"
rmnet "github.com/filecoin-project/boost-gfm/retrievalmarket/network"
"github.com/filecoin-project/boost-gfm/shared"
)
var log = logging.Logger("retrieval")
// Client is the production implementation of the RetrievalClient interface
type Client struct {
network rmnet.RetrievalMarketNetwork
dataTransfer datatransfer.Manager
node retrievalmarket.RetrievalClientNode
dealIDGen *shared.TimeCounter
subscribers *pubsub.PubSub
readySub *pubsub.PubSub
resolver discovery.PeerResolver
stateMachines fsm.Group
migrateStateMachines func(context.Context) error
bstores retrievalmarket.BlockstoreAccessor
// Guards concurrent access to Retrieve method
retrieveLk sync.Mutex
}
type internalEvent struct {
evt retrievalmarket.ClientEvent
state retrievalmarket.ClientDealState
}
func dispatcher(evt pubsub.Event, subscriberFn pubsub.SubscriberFn) error {
ie, ok := evt.(internalEvent)
if !ok {
return errors.New("wrong type of event")
}
cb, ok := subscriberFn.(retrievalmarket.ClientSubscriber)
if !ok {
return errors.New("wrong type of event")
}
log.Debugw("process retrieval client listeners", "name", retrievalmarket.ClientEvents[ie.evt], "proposal cid", ie.state.ID)
cb(ie.evt, ie.state)
return nil
}
var _ retrievalmarket.RetrievalClient = &Client{}
// NewClient creates a new retrieval client
func NewClient(
network rmnet.RetrievalMarketNetwork,
dataTransfer datatransfer.Manager,
node retrievalmarket.RetrievalClientNode,
resolver discovery.PeerResolver,
ds datastore.Batching,
ba retrievalmarket.BlockstoreAccessor,
) (retrievalmarket.RetrievalClient, error) {
c := &Client{
network: network,
dataTransfer: dataTransfer,
node: node,
resolver: resolver,
dealIDGen: shared.NewTimeCounter(),
subscribers: pubsub.New(dispatcher),
readySub: pubsub.New(shared.ReadyDispatcher),
bstores: ba,
}
retrievalMigrations, err := migrations.ClientMigrations.Build()
if err != nil {
return nil, err
}
c.stateMachines, c.migrateStateMachines, err = versionedfsm.NewVersionedFSM(ds, fsm.Parameters{
Environment: &clientDealEnvironment{c},
StateType: retrievalmarket.ClientDealState{},
StateKeyField: "Status",
Events: clientstates.ClientEvents,
StateEntryFuncs: clientstates.ClientStateEntryFuncs,
FinalityStates: clientstates.ClientFinalityStates,
Notifier: c.notifySubscribers,
}, retrievalMigrations, "2")
if err != nil {
return nil, err
}
err = dataTransfer.RegisterVoucherResultType(&retrievalmarket.DealResponse{})
if err != nil {
return nil, err
}
err = dataTransfer.RegisterVoucherResultType(&migrations.DealResponse0{})
if err != nil {
return nil, err
}
err = dataTransfer.RegisterVoucherType(&retrievalmarket.DealProposal{}, nil)
if err != nil {
return nil, err
}
err = dataTransfer.RegisterVoucherType(&migrations.DealProposal0{}, nil)
if err != nil {
return nil, err
}
err = dataTransfer.RegisterVoucherType(&retrievalmarket.DealPayment{}, nil)
if err != nil {
return nil, err
}
err = dataTransfer.RegisterVoucherType(&migrations.DealPayment0{}, nil)
if err != nil {
return nil, err
}
dataTransfer.SubscribeToEvents(dtutils.ClientDataTransferSubscriber(c.stateMachines))
transportConfigurer := dtutils.TransportConfigurer(network.ID(), &clientStoreGetter{c})
err = dataTransfer.RegisterTransportConfigurer(&retrievalmarket.DealProposal{}, transportConfigurer)
if err != nil {
return nil, err
}
err = dataTransfer.RegisterTransportConfigurer(&migrations.DealProposal0{}, transportConfigurer)
if err != nil {
return nil, err
}
return c, nil
}
func (c *Client) NextID() retrievalmarket.DealID {
return retrievalmarket.DealID(c.dealIDGen.Next())
}
// Start initialized the Client, performing relevant database migrations
func (c *Client) Start(ctx context.Context) error {
go func() {
err := c.migrateStateMachines(ctx)
if err != nil {
log.Errorf("Migrating retrieval client state machines: %s", err.Error())
}
err = c.readySub.Publish(err)
if err != nil {
log.Warnf("Publish retrieval client ready event: %s", err.Error())
}
}()
return nil
}
// OnReady registers a listener for when the client has finished starting up
func (c *Client) OnReady(ready shared.ReadyFunc) {
c.readySub.Subscribe(ready)
}
// FindProviders uses PeerResolver interface to locate a list of providers who may have a given payload CID.
func (c *Client) FindProviders(payloadCID cid.Cid) []retrievalmarket.RetrievalPeer {
peers, err := c.resolver.GetPeers(payloadCID)
if err != nil {
log.Errorf("failed to get peers: %s", err)
return []retrievalmarket.RetrievalPeer{}
}
return peers
}
/*
Query sends a retrieval query to a specific retrieval provider, to determine
if the provider can serve a retrieval request and what its specific parameters for
the request are.
The client creates a new `RetrievalQueryStream` for the chosen peer ID,
and calls `WriteQuery` on it, which constructs a data-transfer message and writes it to the Query stream.
*/
func (c *Client) Query(ctx context.Context, p retrievalmarket.RetrievalPeer, payloadCID cid.Cid, params retrievalmarket.QueryParams) (retrievalmarket.QueryResponse, error) {
err := c.addMultiaddrs(ctx, p)
if err != nil {
log.Warn(err)
return retrievalmarket.QueryResponseUndefined, err
}
s, err := c.network.NewQueryStream(p.ID)
if err != nil {
log.Warn(err)
return retrievalmarket.QueryResponseUndefined, err
}
defer s.Close()
err = s.WriteQuery(retrievalmarket.Query{
PayloadCID: payloadCID,
QueryParams: params,
})
if err != nil {
log.Warn(err)
return retrievalmarket.QueryResponseUndefined, err
}
return s.ReadQueryResponse()
}
// Retrieve initiates the retrieval deal flow, which involves multiple requests and responses
//
// To start this processes, the client creates a new `RetrievalDealStream`. Currently, this connection is
// kept open through the entire deal until completion or failure. Make deals pauseable as well as surviving
// a restart is a planned future feature.
//
// Retrieve should be called after using FindProviders and Query are used to identify an appropriate provider to
// retrieve the deal from. The parameters identified in Query should be passed to Retrieve to ensure the
// greatest likelihood the provider will accept the deal
//
// When called, the client takes the following actions:
//
// 1. Creates a deal ID using the next value from its `storedCounter`.
//
// 2. Constructs a `DealProposal` with deal terms
//
// 3. Tells its statemachine to begin tracking this deal state by dealID.
//
// 4. Constructs a `blockio.SelectorVerifier` and adds it to its dealID-keyed map of block verifiers.
//
// 5. Triggers a `ClientEventOpen` event on its statemachine.
//
// From then on, the statemachine controls the deal flow in the client. Other components may listen for events in this flow by calling
// `SubscribeToEvents` on the Client. The Client handles consuming blocks it receives from the provider, via `ConsumeBlocks` function
//
// Retrieve can use an ID generated through NextID, or can generate an ID if the user passes a zero value.
//
// Use NextID when it's necessary to reserve an ID ahead of time, e.g. to
// associate it with a given blockstore in the BlockstoreAccessor.
//
// Documentation of the client state machine can be found at https://godoc.org/github.com/filecoin-project/go-fil-markets/retrievalmarket/impl/clientstates
func (c *Client) Retrieve(
ctx context.Context,
id retrievalmarket.DealID,
payloadCID cid.Cid,
params retrievalmarket.Params,
totalFunds abi.TokenAmount,
p retrievalmarket.RetrievalPeer,
clientWallet address.Address,
minerWallet address.Address,
) (retrievalmarket.DealID, error) {
c.retrieveLk.Lock()
defer c.retrieveLk.Unlock()
err := c.addMultiaddrs(ctx, p)
if err != nil {
return 0, err
}
// assign a new ID.
if id == 0 {
next := c.dealIDGen.Next()
id = retrievalmarket.DealID(next)
}
dealState := retrievalmarket.ClientDealState{
DealProposal: retrievalmarket.DealProposal{
PayloadCID: payloadCID,
ID: id,
Params: params,
},
TotalFunds: totalFunds,
ClientWallet: clientWallet,
MinerWallet: minerWallet,
TotalReceived: 0,
CurrentInterval: params.PaymentInterval,
BytesPaidFor: 0,
PaymentRequested: abi.NewTokenAmount(0),
FundsSpent: abi.NewTokenAmount(0),
Status: retrievalmarket.DealStatusNew,
Sender: p.ID,
UnsealFundsPaid: big.Zero(),
}
// start the deal processing
err = c.stateMachines.Begin(dealState.ID, &dealState)
if err != nil {
return 0, err
}
err = c.stateMachines.Send(dealState.ID, retrievalmarket.ClientEventOpen)
if err != nil {
return 0, err
}
return id, nil
}
func (c *Client) notifySubscribers(eventName fsm.EventName, state fsm.StateType) {
evt := eventName.(retrievalmarket.ClientEvent)
ds := state.(retrievalmarket.ClientDealState)
_ = c.subscribers.Publish(internalEvent{evt, ds})
}
func (c *Client) addMultiaddrs(ctx context.Context, p retrievalmarket.RetrievalPeer) error {
tok, _, err := c.node.GetChainHead(ctx)
if err != nil {
return err
}
maddrs, err := c.node.GetKnownAddresses(ctx, p, tok)
if err != nil {
return err
}
if len(maddrs) > 0 {
c.network.AddAddrs(p.ID, maddrs)
}
return nil
}
// SubscribeToEvents allows another component to listen for events on the RetrievalClient
// in order to track deals as they progress through the deal flow
func (c *Client) SubscribeToEvents(subscriber retrievalmarket.ClientSubscriber) retrievalmarket.Unsubscribe {
return retrievalmarket.Unsubscribe(c.subscribers.Subscribe(subscriber))
}
// V1
// TryRestartInsufficientFunds attempts to restart any deals stuck in the insufficient funds state
// after funds are added to a given payment channel
func (c *Client) TryRestartInsufficientFunds(paymentChannel address.Address) error {
var deals []retrievalmarket.ClientDealState
err := c.stateMachines.List(&deals)
if err != nil {
return err
}
for _, deal := range deals {
if deal.Status == retrievalmarket.DealStatusInsufficientFunds && deal.PaymentInfo.PayCh == paymentChannel {
if err := c.stateMachines.Send(deal.ID, retrievalmarket.ClientEventRecheckFunds); err != nil {
return err
}
}
}
return nil
}
// CancelDeal attempts to cancel an in progress deal
func (c *Client) CancelDeal(dealID retrievalmarket.DealID) error {
return c.stateMachines.Send(dealID, retrievalmarket.ClientEventCancel)
}
// GetDeal returns a given deal by deal ID, if it exists
func (c *Client) GetDeal(dealID retrievalmarket.DealID) (retrievalmarket.ClientDealState, error) {
var out retrievalmarket.ClientDealState
if err := c.stateMachines.Get(dealID).Get(&out); err != nil {
return retrievalmarket.ClientDealState{}, err
}
return out, nil
}
// ListDeals lists all known retrieval deals
func (c *Client) ListDeals() (map[retrievalmarket.DealID]retrievalmarket.ClientDealState, error) {
var deals []retrievalmarket.ClientDealState
err := c.stateMachines.List(&deals)
if err != nil {
return nil, err
}
dealMap := make(map[retrievalmarket.DealID]retrievalmarket.ClientDealState)
for _, deal := range deals {
dealMap[deal.ID] = deal
}
return dealMap, nil
}
var _ clientstates.ClientDealEnvironment = &clientDealEnvironment{}
type clientDealEnvironment struct {
c *Client
}
// Node returns the node interface for this deal
func (c *clientDealEnvironment) Node() retrievalmarket.RetrievalClientNode {
return c.c.node
}
func (c *clientDealEnvironment) OpenDataTransfer(ctx context.Context, to peer.ID, proposal *retrievalmarket.DealProposal, legacy bool) (datatransfer.ChannelID, error) {
sel := selectorparse.CommonSelector_ExploreAllRecursively
if proposal.SelectorSpecified() {
var err error
sel, err = retrievalmarket.DecodeNode(proposal.Selector)
if err != nil {
return datatransfer.ChannelID{}, xerrors.Errorf("selector is invalid: %w", err)
}
}
var vouch datatransfer.Voucher = proposal
if legacy {
vouch = &migrations.DealProposal0{
PayloadCID: proposal.PayloadCID,
ID: proposal.ID,
Params0: migrations.Params0{
Selector: proposal.Selector,
PieceCID: proposal.PieceCID,
PricePerByte: proposal.PricePerByte,
PaymentInterval: proposal.PaymentInterval,
PaymentIntervalIncrease: proposal.PaymentIntervalIncrease,
UnsealPrice: proposal.UnsealPrice,
},
}
}
return c.c.dataTransfer.OpenPullDataChannel(ctx, to, vouch, proposal.PayloadCID, sel)
}
func (c *clientDealEnvironment) SendDataTransferVoucher(ctx context.Context, channelID datatransfer.ChannelID, payment *retrievalmarket.DealPayment, legacy bool) error {
var vouch datatransfer.Voucher = payment
if legacy {
vouch = &migrations.DealPayment0{
ID: payment.ID,
PaymentChannel: payment.PaymentChannel,
PaymentVoucher: payment.PaymentVoucher,
}
}
return c.c.dataTransfer.SendVoucher(ctx, channelID, vouch)
}
func (c *clientDealEnvironment) CloseDataTransfer(ctx context.Context, channelID datatransfer.ChannelID) error {
// When we close the data transfer, we also send a cancel message to the peer.
// Make sure we don't wait too long to send the message.
ctx, cancel := context.WithTimeout(ctx, shared.CloseDataTransferTimeout)
defer cancel()
err := c.c.dataTransfer.CloseDataTransferChannel(ctx, channelID)
if shared.IsCtxDone(err) {
log.Warnf("failed to send cancel data transfer channel %s to provider within timeout %s",
channelID, shared.CloseDataTransferTimeout)
return nil
}
return err
}
// FinalizeBlockstore is called when all blocks have been received
func (c *clientDealEnvironment) FinalizeBlockstore(ctx context.Context, dealID retrievalmarket.DealID) error {
return c.c.bstores.Done(dealID)
}
type clientStoreGetter struct {
c *Client
}
func (csg *clientStoreGetter) Get(_ peer.ID, id retrievalmarket.DealID) (bstore.Blockstore, error) {
var deal retrievalmarket.ClientDealState
err := csg.c.stateMachines.Get(id).Get(&deal)
if err != nil {
return nil, err
}
return csg.c.bstores.Get(id, deal.PayloadCID)
}
// ClientFSMParameterSpec is a valid set of parameters for a client deal FSM - used in doc generation
var ClientFSMParameterSpec = fsm.Parameters{
Environment: &clientDealEnvironment{},
StateType: retrievalmarket.ClientDealState{},
StateKeyField: "Status",
Events: clientstates.ClientEvents,
StateEntryFuncs: clientstates.ClientStateEntryFuncs,
}