/
storageminer_idxprov.go
314 lines (274 loc) · 12.2 KB
/
storageminer_idxprov.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
package modules
import (
"context"
"fmt"
"github.com/filecoin-project/boost/build"
"github.com/filecoin-project/boost/indexprovider"
"github.com/filecoin-project/boost/node/config"
"github.com/filecoin-project/boost/node/modules/dtypes"
"github.com/filecoin-project/boost/retrievalmarket/types"
"github.com/filecoin-project/boost/util"
"github.com/filecoin-project/go-address"
datatransfer "github.com/filecoin-project/go-data-transfer"
"github.com/filecoin-project/go-data-transfer/transport/graphsync"
datatransferv2 "github.com/filecoin-project/go-data-transfer/v2"
lotus_dtypes "github.com/filecoin-project/lotus/node/modules/dtypes"
"github.com/ipfs/go-cid"
"github.com/ipfs/go-datastore"
"github.com/ipfs/go-datastore/namespace"
"github.com/ipld/go-ipld-prime"
"github.com/ipld/go-ipld-prime/datamodel"
"github.com/ipni/go-libipni/dagsync/dtsync"
provider "github.com/ipni/index-provider"
"github.com/ipni/index-provider/engine"
pubsub "github.com/libp2p/go-libp2p-pubsub"
"github.com/libp2p/go-libp2p/core/host"
"github.com/libp2p/go-libp2p/core/peer"
"go.uber.org/fx"
"golang.org/x/xerrors"
)
type IdxProv struct {
fx.In
fx.Lifecycle
Datastore lotus_dtypes.MetadataDS
}
func IndexProvider(cfg config.IndexProviderConfig) func(params IdxProv, marketHost host.Host, dt dtypes.ProviderDataTransfer, maddr lotus_dtypes.MinerAddress, ps *pubsub.PubSub, nn lotus_dtypes.NetworkName) (provider.Interface, error) {
if !cfg.Enable {
log.Warnf("Starting Boost with index provider disabled - no announcements will be made to the index provider")
return func(params IdxProv, marketHost host.Host, dt dtypes.ProviderDataTransfer, maddr lotus_dtypes.MinerAddress, ps *pubsub.PubSub, nn lotus_dtypes.NetworkName) (provider.Interface, error) {
return indexprovider.NewDisabledIndexProvider(), nil
}
}
return func(args IdxProv, marketHost host.Host, dt dtypes.ProviderDataTransfer, maddr lotus_dtypes.MinerAddress, ps *pubsub.PubSub, nn lotus_dtypes.NetworkName) (provider.Interface, error) {
topicName := cfg.TopicName
// If indexer topic name is left empty, infer it from the network name.
if topicName == "" {
// Use the same mechanism as the Dependency Injection (DI) to construct the topic name,
// so that we are certain it is consistent with the name allowed by the subscription
// filter.
//
// See: lp2p.GossipSub.
topicName = build.IndexerIngestTopic(dtypes.NetworkName(nn))
log.Debugw("Inferred indexer topic from network name", "topic", topicName)
}
marketHostAddrs := marketHost.Addrs()
marketHostAddrsStr := make([]string, 0, len(marketHostAddrs))
for _, a := range marketHostAddrs {
marketHostAddrsStr = append(marketHostAddrsStr, a.String())
}
ipds := namespace.Wrap(args.Datastore, datastore.NewKey("/index-provider"))
var opts = []engine.Option{
engine.WithDatastore(ipds),
engine.WithHost(marketHost),
engine.WithRetrievalAddrs(marketHostAddrsStr...),
engine.WithEntriesCacheCapacity(cfg.EntriesCacheCapacity),
engine.WithChainedEntries(cfg.EntriesChunkSize),
engine.WithTopicName(topicName),
engine.WithPurgeCacheOnStart(cfg.PurgeCacheOnStart),
}
llog := log.With(
"idxProvEnabled", cfg.Enable,
"pid", marketHost.ID(),
"topic", topicName,
"retAddrs", marketHost.Addrs())
// If announcements to the network are enabled, then set options for the publisher.
var e *engine.Engine
if cfg.Enable {
// Join the indexer topic using the market's pubsub instance. Otherwise, the provider
// engine would create its own instance of pubsub down the line in dagsync, which has
// no validators by default.
t, err := ps.Join(topicName)
if err != nil {
llog.Errorw("Failed to join indexer topic", "err", err)
return nil, xerrors.Errorf("joining indexer topic %s: %w", topicName, err)
}
// Get the miner ID and set as extra gossip data.
// The extra data is required by the lotus-specific index-provider gossip message validators.
ma := address.Address(maddr)
opts = append(opts,
engine.WithTopic(t),
engine.WithExtraGossipData(ma.Bytes()),
)
if cfg.Announce.AnnounceOverHttp {
opts = append(opts, engine.WithDirectAnnounce(cfg.Announce.DirectAnnounceURLs...))
}
// Advertisements can be served over the data transfer protocol
// (on graphsync) or over HTTP
if cfg.HttpPublisher.Enabled {
announceAddr, err := util.ToHttpMultiaddr(cfg.HttpPublisher.PublicHostname, cfg.HttpPublisher.Port)
if err != nil {
return nil, fmt.Errorf("parsing HTTP Publisher hostname '%s' / port %d: %w",
cfg.HttpPublisher.PublicHostname, cfg.HttpPublisher.Port, err)
}
opts = append(opts,
engine.WithPublisherKind(engine.HttpPublisher),
engine.WithHttpPublisherListenAddr(fmt.Sprintf("0.0.0.0:%d", cfg.HttpPublisher.Port)),
engine.WithHttpPublisherAnnounceAddr(announceAddr.String()),
)
llog = llog.With("publisher", "http", "announceAddr", announceAddr)
} else {
opts = append(opts,
engine.WithPublisherKind(engine.DataTransferPublisher),
engine.WithDataTransfer(dtV1ToIndexerDT(dt, func() ipld.LinkSystem {
return *e.LinkSystem()
})),
)
llog = llog.With("extraGossipData", ma, "publisher", "data-transfer")
}
} else {
opts = append(opts, engine.WithPublisherKind(engine.NoPublisher))
llog = llog.With("publisher", "none")
}
// Instantiate the index provider engine.
var err error
e, err = engine.New(opts...)
if err != nil {
return nil, xerrors.Errorf("creating indexer provider engine: %w", err)
}
llog.Info("Instantiated index provider engine")
args.Lifecycle.Append(fx.Hook{
OnStart: func(ctx context.Context) error {
// Note that the OnStart context is cancelled after startup. Its use in e.Start is
// to start up gossipsub publishers and restore cache, all of which are completed
// before e.Start returns. Therefore, it is fine to reuse the give context.
if err := e.Start(ctx); err != nil {
return xerrors.Errorf("starting indexer provider engine: %w", err)
}
log.Infof("Started index provider engine")
return nil
},
OnStop: func(_ context.Context) error {
if err := e.Shutdown(); err != nil {
return xerrors.Errorf("shutting down indexer provider engine: %w", err)
}
return nil
},
})
return e, nil
}
}
// The index provider needs to set up some go-data-transfer voucher code.
// Below we write a shim for the specific use case of index provider, that
// translates between the go-data-transfer v2 use case that the index provider
// implements and the go-data-transfer v1 code that boost imports.
func dtV1ToIndexerDT(dt dtypes.ProviderDataTransfer, linksys func() ipld.LinkSystem) datatransferv2.Manager {
return &indexerDT{dt: dt, linksys: linksys}
}
type indexerDT struct {
dt dtypes.ProviderDataTransfer
linksys func() ipld.LinkSystem
}
var _ datatransferv2.Manager = (*indexerDT)(nil)
func (i *indexerDT) RegisterVoucherType(voucherType datatransferv2.TypeIdentifier, validator datatransferv2.RequestValidator) error {
if voucherType == dtsync.LegsVoucherType {
return i.dt.RegisterVoucherType(&types.LegsVoucherDTv1{}, &dtv1ReqValidator{v: validator})
}
return fmt.Errorf("unrecognized voucher type: %s", voucherType)
}
func (i *indexerDT) RegisterTransportConfigurer(voucherType datatransferv2.TypeIdentifier, configurer datatransferv2.TransportConfigurer) error {
if voucherType == dtsync.LegsVoucherType {
return i.dt.RegisterTransportConfigurer(&types.LegsVoucherDTv1{}, func(chid datatransfer.ChannelID, voucher datatransfer.Voucher, transport datatransfer.Transport) {
gsTransport, ok := transport.(*graphsync.Transport)
if ok {
err := gsTransport.UseStore(chid, i.linksys())
if err != nil {
log.Warnf("setting store for legs voucher: %s", err)
}
} else {
log.Warnf("expected transport configurer to pass graphsync transport but got %T", transport)
}
})
}
return fmt.Errorf("unrecognized voucher type: %s", voucherType)
}
func (i *indexerDT) Start(ctx context.Context) error {
return fmt.Errorf("not implemented")
}
func (i *indexerDT) OnReady(readyFunc datatransferv2.ReadyFunc) {
}
func (i *indexerDT) Stop(ctx context.Context) error {
return fmt.Errorf("not implemented")
}
func (i *indexerDT) OpenPushDataChannel(ctx context.Context, to peer.ID, voucher datatransferv2.TypedVoucher, baseCid cid.Cid, selector datamodel.Node, options ...datatransferv2.TransferOption) (datatransferv2.ChannelID, error) {
return datatransferv2.ChannelID{}, fmt.Errorf("not implemented")
}
func (i *indexerDT) OpenPullDataChannel(ctx context.Context, to peer.ID, voucher datatransferv2.TypedVoucher, baseCid cid.Cid, selector datamodel.Node, options ...datatransferv2.TransferOption) (datatransferv2.ChannelID, error) {
return datatransferv2.ChannelID{}, fmt.Errorf("not implemented")
}
func (i *indexerDT) SendVoucher(ctx context.Context, chid datatransferv2.ChannelID, voucher datatransferv2.TypedVoucher) error {
return fmt.Errorf("not implemented")
}
func (i *indexerDT) SendVoucherResult(ctx context.Context, chid datatransferv2.ChannelID, voucherResult datatransferv2.TypedVoucher) error {
return fmt.Errorf("not implemented")
}
func (i *indexerDT) UpdateValidationStatus(ctx context.Context, chid datatransferv2.ChannelID, validationResult datatransferv2.ValidationResult) error {
return fmt.Errorf("not implemented")
}
func (i *indexerDT) CloseDataTransferChannel(ctx context.Context, chid datatransferv2.ChannelID) error {
return fmt.Errorf("not implemented")
}
func (i *indexerDT) PauseDataTransferChannel(ctx context.Context, chid datatransferv2.ChannelID) error {
return fmt.Errorf("not implemented")
}
func (i *indexerDT) ResumeDataTransferChannel(ctx context.Context, chid datatransferv2.ChannelID) error {
return fmt.Errorf("not implemented")
}
func (i *indexerDT) TransferChannelStatus(ctx context.Context, x datatransferv2.ChannelID) datatransferv2.Status {
return 0
}
func (i *indexerDT) ChannelState(ctx context.Context, chid datatransferv2.ChannelID) (datatransferv2.ChannelState, error) {
return nil, fmt.Errorf("not implemented")
}
func (i *indexerDT) SubscribeToEvents(subscriber datatransferv2.Subscriber) datatransferv2.Unsubscribe {
return func() {}
}
func (i *indexerDT) InProgressChannels(ctx context.Context) (map[datatransferv2.ChannelID]datatransferv2.ChannelState, error) {
return nil, fmt.Errorf("not implemented")
}
func (i *indexerDT) RestartDataTransferChannel(ctx context.Context, chid datatransferv2.ChannelID) error {
return fmt.Errorf("not implemented")
}
type dtv1ReqValidator struct {
v datatransferv2.RequestValidator
}
func (d *dtv1ReqValidator) ValidatePush(isRestart bool, chid datatransfer.ChannelID, sender peer.ID, voucher datatransfer.Voucher, baseCid cid.Cid, selector ipld.Node) (datatransfer.VoucherResult, error) {
d2v := dtsync.BindnodeRegistry.TypeToNode(&voucher.(*types.LegsVoucherDTv1).Voucher)
res, err := d.v.ValidatePush(toChannelIDV2(chid), sender, d2v, baseCid, selector)
if err != nil {
return nil, err
}
if !res.Accepted {
return nil, datatransfer.ErrRejected
}
return toVoucherResult(res)
}
func (d *dtv1ReqValidator) ValidatePull(isRestart bool, chid datatransfer.ChannelID, receiver peer.ID, voucher datatransfer.Voucher, baseCid cid.Cid, selector ipld.Node) (datatransfer.VoucherResult, error) {
d2v := dtsync.BindnodeRegistry.TypeToNode(&voucher.(*types.LegsVoucherDTv1).Voucher)
res, err := d.v.ValidatePull(toChannelIDV2(chid), receiver, d2v, baseCid, selector)
if err != nil {
return nil, err
}
if !res.Accepted {
return nil, datatransfer.ErrRejected
}
return toVoucherResult(res)
}
func toVoucherResult(res datatransferv2.ValidationResult) (datatransfer.VoucherResult, error) {
voucherResVoucher := res.VoucherResult.Voucher
vri, err := dtsync.BindnodeRegistry.TypeFromNode(voucherResVoucher, &dtsync.VoucherResult{})
if err != nil {
return nil, fmt.Errorf("getting VoucherResult from ValidationResult: %w", err)
}
vr := vri.(*dtsync.VoucherResult)
if vr == nil {
return nil, fmt.Errorf("got nil VoucherResult from ValidationResult")
}
return &types.LegsVoucherResultDtv1{VoucherResult: *vr, VoucherType: res.VoucherResult.Type}, nil
}
func toChannelIDV2(chid datatransfer.ChannelID) datatransferv2.ChannelID {
return datatransferv2.ChannelID{
Initiator: chid.Initiator,
Responder: chid.Responder,
ID: datatransferv2.TransferID(chid.ID),
}
}