-
Notifications
You must be signed in to change notification settings - Fork 901
/
client.go
223 lines (200 loc) · 5.9 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
package shrexnd
import (
"context"
"errors"
"fmt"
"io"
"net"
"time"
"github.com/libp2p/go-libp2p/core/host"
"github.com/libp2p/go-libp2p/core/network"
"github.com/libp2p/go-libp2p/core/peer"
"github.com/libp2p/go-libp2p/core/protocol"
"github.com/celestiaorg/go-libp2p-messenger/serde"
"github.com/celestiaorg/nmt"
"github.com/celestiaorg/celestia-node/share"
"github.com/celestiaorg/celestia-node/share/p2p"
pb "github.com/celestiaorg/celestia-node/share/p2p/shrexnd/pb"
)
// Client implements client side of shrex/nd protocol to obtain namespaced shares data from remote
// peers.
type Client struct {
params *Parameters
protocolID protocol.ID
host host.Host
metrics *p2p.Metrics
}
// NewClient creates a new shrEx/nd client
func NewClient(params *Parameters, host host.Host) (*Client, error) {
if err := params.Validate(); err != nil {
return nil, fmt.Errorf("shrex-nd: client creation failed: %w", err)
}
return &Client{
host: host,
protocolID: p2p.ProtocolID(params.NetworkID(), protocolString),
params: params,
}, nil
}
// RequestND requests namespaced data from the given peer.
// Returns NamespacedShares with unverified inclusion proofs against the share.Root.
func (c *Client) RequestND(
ctx context.Context,
root *share.Root,
namespace share.Namespace,
peer peer.ID,
) (share.NamespacedShares, error) {
if err := namespace.ValidateForData(); err != nil {
return nil, err
}
shares, err := c.doRequest(ctx, root, namespace, peer)
if err == nil {
return shares, nil
}
if errors.Is(err, context.DeadlineExceeded) || errors.Is(err, context.Canceled) {
c.metrics.ObserveRequests(ctx, 1, p2p.StatusTimeout)
return nil, err
}
// some net.Errors also mean the context deadline was exceeded, but yamux/mocknet do not
// unwrap to a ctx err
var ne net.Error
if errors.As(err, &ne) && ne.Timeout() {
if deadline, _ := ctx.Deadline(); deadline.Before(time.Now()) {
c.metrics.ObserveRequests(ctx, 1, p2p.StatusTimeout)
return nil, context.DeadlineExceeded
}
}
if !errors.Is(err, p2p.ErrNotFound) && !errors.Is(err, p2p.ErrRateLimited) {
log.Warnw("client-nd: peer returned err", "err", err)
}
return nil, err
}
func (c *Client) doRequest(
ctx context.Context,
root *share.Root,
namespace share.Namespace,
peerID peer.ID,
) (share.NamespacedShares, error) {
stream, err := c.host.NewStream(ctx, peerID, c.protocolID)
if err != nil {
return nil, err
}
defer stream.Close()
c.setStreamDeadlines(ctx, stream)
req := &pb.GetSharesByNamespaceRequest{
RootHash: root.Hash(),
Namespace: namespace,
}
_, err = serde.Write(stream, req)
if err != nil {
c.metrics.ObserveRequests(ctx, 1, p2p.StatusSendReqErr)
stream.Reset() //nolint:errcheck
return nil, fmt.Errorf("client-nd: writing request: %w", err)
}
err = stream.CloseWrite()
if err != nil {
log.Debugw("client-nd: closing write side of the stream", "err", err)
}
if err := c.readStatus(ctx, stream); err != nil {
return nil, err
}
return c.readNamespacedShares(ctx, stream)
}
func (c *Client) readStatus(ctx context.Context, stream network.Stream) error {
var resp pb.GetSharesByNamespaceStatusResponse
_, err := serde.Read(stream, &resp)
if err != nil {
// server is overloaded and closed the stream
if errors.Is(err, io.EOF) {
c.metrics.ObserveRequests(ctx, 1, p2p.StatusRateLimited)
return p2p.ErrRateLimited
}
c.metrics.ObserveRequests(ctx, 1, p2p.StatusReadRespErr)
stream.Reset() //nolint:errcheck
return fmt.Errorf("client-nd: reading status response: %w", err)
}
return c.convertStatusToErr(ctx, resp.Status)
}
// readNamespacedShares converts proto Rows to share.NamespacedShares
func (c *Client) readNamespacedShares(
ctx context.Context,
stream network.Stream,
) (share.NamespacedShares, error) {
var shares share.NamespacedShares
for {
var row pb.NamespaceRowResponse
_, err := serde.Read(stream, &row)
if err != nil {
if errors.Is(err, io.EOF) {
// all data is received and steam is closed by server
return shares, nil
}
c.metrics.ObserveRequests(ctx, 1, p2p.StatusReadRespErr)
return nil, err
}
var proof nmt.Proof
if row.Proof != nil {
if len(row.Shares) != 0 {
proof = nmt.NewInclusionProof(
int(row.Proof.Start),
int(row.Proof.End),
row.Proof.Nodes,
row.Proof.IsMaxNamespaceIgnored,
)
} else {
proof = nmt.NewAbsenceProof(
int(row.Proof.Start),
int(row.Proof.End),
row.Proof.Nodes,
row.Proof.LeafHash,
row.Proof.IsMaxNamespaceIgnored,
)
}
}
shares = append(shares, share.NamespacedRow{
Shares: row.Shares,
Proof: &proof,
})
}
}
func (c *Client) setStreamDeadlines(ctx context.Context, stream network.Stream) {
// set read/write deadline to use context deadline if it exists
deadline, ok := ctx.Deadline()
if ok {
err := stream.SetDeadline(deadline)
if err == nil {
return
}
log.Debugw("client-nd: set stream deadline", "err", err)
}
// if deadline not set, client read deadline defaults to server write deadline
if c.params.ServerWriteTimeout != 0 {
err := stream.SetReadDeadline(time.Now().Add(c.params.ServerWriteTimeout))
if err != nil {
log.Debugw("client-nd: set read deadline", "err", err)
}
}
// if deadline not set, client write deadline defaults to server read deadline
if c.params.ServerReadTimeout != 0 {
err := stream.SetWriteDeadline(time.Now().Add(c.params.ServerReadTimeout))
if err != nil {
log.Debugw("client-nd: set write deadline", "err", err)
}
}
}
func (c *Client) convertStatusToErr(ctx context.Context, status pb.StatusCode) error {
switch status {
case pb.StatusCode_OK:
c.metrics.ObserveRequests(ctx, 1, p2p.StatusSuccess)
return nil
case pb.StatusCode_NOT_FOUND:
c.metrics.ObserveRequests(ctx, 1, p2p.StatusNotFound)
return p2p.ErrNotFound
case pb.StatusCode_INVALID:
log.Warn("client-nd: invalid request")
fallthrough
case pb.StatusCode_INTERNAL:
fallthrough
default:
return p2p.ErrInvalidResponse
}
}