-
Notifications
You must be signed in to change notification settings - Fork 17
/
directcandidatesource.go
235 lines (217 loc) · 6.7 KB
/
directcandidatesource.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
package retriever
import (
"context"
"sync"
datatransfer "github.com/filecoin-project/go-data-transfer/v2"
"github.com/filecoin-project/lassie/pkg/internal/lp2ptransports"
"github.com/filecoin-project/lassie/pkg/types"
bsnet "github.com/ipfs/boxo/bitswap/network"
"github.com/ipfs/go-cid"
gsnet "github.com/ipfs/go-graphsync/network"
"github.com/ipni/go-libipni/metadata"
"github.com/libp2p/go-libp2p/core/host"
"github.com/libp2p/go-libp2p/core/peer"
)
var _ types.CandidateSource = &DirectCandidateSource{}
// DirectCandidateSource finds candidate protocols from a fixed set of peers
type DirectCandidateSource struct {
h host.Host
providers []types.Provider
}
type Option func(*DirectCandidateSource)
// WithLibp2pCandidateDiscovery sets a libp2p Host for the DirectCandidateFinder.
// If a Host is set, the providers will be queried to discover available protocols, otherwise
// all protocols will be assumed by default.
func WithLibp2pCandidateDiscovery(h host.Host) Option {
return func(d *DirectCandidateSource) {
d.h = h
}
}
// NewDirectCandidateSource returns a new DirectCandidateFinder for the given providers
func NewDirectCandidateSource(providers []types.Provider, opts ...Option) *DirectCandidateSource {
d := &DirectCandidateSource{
providers: providers,
}
for _, opt := range opts {
opt(d)
}
return d
}
type candidateSender struct {
ctx context.Context
cancel context.CancelFunc
rootCid cid.Cid
candidateResults chan<- types.FindCandidatesResult
}
func (cs candidateSender) sendCandidate(addr peer.AddrInfo, protocols ...metadata.Protocol) error {
select {
case <-cs.ctx.Done():
return cs.ctx.Err()
case cs.candidateResults <- types.FindCandidatesResult{Candidate: types.RetrievalCandidate{
MinerPeer: addr,
RootCid: cs.rootCid,
Metadata: metadata.Default.New(protocols...),
}}:
return nil
}
}
func (cs candidateSender) sendError(err error) error {
select {
case <-cs.ctx.Done():
return cs.ctx.Err()
case cs.candidateResults <- types.FindCandidatesResult{Err: err}:
cs.cancel()
return nil
}
}
// FindCandidates finds supported protocols for each peer
// TODO: Cache the results?
func (d *DirectCandidateSource) FindCandidates(ctx context.Context, c cid.Cid, cb func(types.RetrievalCandidate)) error {
candidateResults := make(chan types.FindCandidatesResult)
ctx, cancel := context.WithCancel(ctx)
defer cancel()
cs := candidateSender{ctx, cancel, c, candidateResults}
var wg sync.WaitGroup
for _, provider := range d.providers {
// if protocols are specified, just use those
if len(provider.Protocols) > 0 {
cb(types.RetrievalCandidate{
MinerPeer: provider.Peer,
RootCid: cs.rootCid,
Metadata: metadata.Default.New(provider.Protocols...),
})
continue
}
// if it's http, it'll be in the multiaddr and we can't probe it
if d.trySendHTTPCandidate(provider, c, cb) {
continue
}
// if we have no libp2p host, just assume all protocols are available
if d.h == nil {
cb(types.RetrievalCandidate{
MinerPeer: provider.Peer,
RootCid: cs.rootCid,
Metadata: metadata.Default.New(metadata.IpfsGatewayHttp{}, metadata.Bitswap{}, &metadata.GraphsyncFilecoinV1{}),
})
continue
}
wg.Add(1)
provider := provider
go func() {
defer wg.Done()
// probe it
err := d.h.Connect(ctx, provider.Peer)
// don't add peers that we can't connect to
if err != nil {
_ = cs.sendError(err)
return
}
// check for support for Boost libp2p transports protocol
transportsClient := lp2ptransports.NewTransportsClient(d.h)
qr, err := transportsClient.SendQuery(ctx, provider.Peer.ID)
if err == nil {
logger.Debugw("retrieving metadata from transports protocol", "peer", provider.Peer.ID)
// if present, construct metadata from Boost libp2p transports response
d.retrievalCandidatesFromTransportsProtocol(ctx, qr, provider.Peer, cs)
} else {
logger.Debugw("retrieving metadata from libp2p protocol list", "peer", provider.Peer.ID)
// if not present, just make guesses based on list of supported libp2p
// protocols catalogued via identify protocol
d.retrievalCandidatesFromProtocolProbing(ctx, provider.Peer, cs)
}
}()
}
go func() {
wg.Wait()
close(candidateResults)
}()
for {
select {
case <-ctx.Done():
return ctx.Err()
case result, ok := <-candidateResults:
if !ok {
return nil
}
if result.Err != nil {
return result.Err
}
cb(result.Candidate)
}
}
}
func (d *DirectCandidateSource) trySendHTTPCandidate(provider types.Provider, rootCid cid.Cid, cb func(types.RetrievalCandidate)) bool {
if len(provider.Peer.Addrs) != 1 {
return false
}
for _, proto := range provider.Peer.Addrs[0].Protocols() {
if proto.Name == "http" || proto.Name == "https" {
cb(types.RetrievalCandidate{
MinerPeer: provider.Peer,
RootCid: rootCid,
Metadata: metadata.Default.New(metadata.IpfsGatewayHttp{}),
})
return true
}
}
return false
}
func (d *DirectCandidateSource) retrievalCandidatesFromProtocolProbing(ctx context.Context, provider peer.AddrInfo, cs candidateSender) {
var protocols []metadata.Protocol
s, err := d.h.NewStream(ctx, provider.ID,
bsnet.ProtocolBitswap,
bsnet.ProtocolBitswapOneOne,
bsnet.ProtocolBitswapOneZero,
bsnet.ProtocolBitswapNoVers,
)
if err == nil {
s.Close()
protocols = append(protocols, &metadata.Bitswap{})
}
// must support both graphsync & data transfer to do graphsync filecoin v1 retrieval
s, err = d.h.NewStream(ctx, provider.ID,
gsnet.ProtocolGraphsync_2_0_0)
if err == nil {
s.Close()
s, err = d.h.NewStream(ctx, provider.ID, datatransfer.ProtocolDataTransfer1_2)
if err == nil {
s.Close()
protocols = append(protocols, &metadata.GraphsyncFilecoinV1{})
}
}
_ = cs.sendCandidate(provider, protocols...)
}
func (d *DirectCandidateSource) retrievalCandidatesFromTransportsProtocol(ctx context.Context, qr *lp2ptransports.QueryResponse, provider peer.AddrInfo, cs candidateSender) {
for _, protocol := range qr.Protocols {
// try to parse addr infos directly
addrs, err := peer.AddrInfosFromP2pAddrs(protocol.Addresses...)
// if no peer id is present, use provider's id
if err != nil {
addrs = []peer.AddrInfo{{
ID: provider.ID,
Addrs: protocol.Addresses,
}}
}
switch protocol.Name {
case "libp2p":
for _, addr := range addrs {
if err := cs.sendCandidate(addr, &metadata.GraphsyncFilecoinV1{}); err != nil {
return
}
}
case "bitswap":
for _, addr := range addrs {
if err := cs.sendCandidate(addr, &metadata.Bitswap{}); err != nil {
return
}
}
case "http":
for _, addr := range addrs {
if err := cs.sendCandidate(addr, &metadata.IpfsGatewayHttp{}); err != nil {
return
}
}
default:
}
}
}