forked from ethersphere/bee
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pseudosettle.go
443 lines (370 loc) · 12.6 KB
/
pseudosettle.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
// Copyright 2020 The Swarm Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package pseudosettle
import (
"context"
"errors"
"fmt"
"math/big"
"strings"
"sync"
"time"
"github.com/ethersphere/bee/pkg/log"
"github.com/ethersphere/bee/pkg/p2p"
"github.com/ethersphere/bee/pkg/p2p/protobuf"
"github.com/ethersphere/bee/pkg/settlement"
pb "github.com/ethersphere/bee/pkg/settlement/pseudosettle/pb"
"github.com/ethersphere/bee/pkg/storage"
"github.com/ethersphere/bee/pkg/swarm"
)
// loggerName is the tree path name of the logger for this package.
const loggerName = "pseudosettle"
const (
protocolName = "pseudosettle"
protocolVersion = "1.0.0"
streamName = "pseudosettle"
)
var (
SettlementReceivedPrefix = "pseudosettle_total_received_"
SettlementSentPrefix = "pseudosettle_total_sent_"
ErrSettlementTooSoon = errors.New("settlement too soon")
ErrNoPseudoSettlePeer = errors.New("settlement peer not found")
ErrDisconnectAllowanceCheckFailed = errors.New("settlement allowance below enforced amount")
ErrTimeOutOfSyncAlleged = errors.New("settlement allowance timestamps from peer were decreasing")
ErrTimeOutOfSyncRecent = errors.New("settlement allowance timestamps from peer differed from our measurement by more than 2 seconds")
ErrTimeOutOfSyncInterval = errors.New("settlement allowance interval from peer differed from local interval by more than 3 seconds")
ErrRefreshmentBelowExpected = errors.New("refreshment below expected")
ErrRefreshmentAboveExpected = errors.New("refreshment above expected")
)
type Service struct {
streamer p2p.Streamer
logger log.Logger
store storage.StateStorer
accounting settlement.Accounting
metrics metrics
refreshRate *big.Int
lightRefreshRate *big.Int
p2pService p2p.Service
timeNow func() time.Time
peersMu sync.Mutex
peers map[string]*pseudoSettlePeer
}
type pseudoSettlePeer struct {
lock sync.Mutex // lock to be held during receiving a payment from this peer
fullNode bool
}
type lastPayment struct {
Timestamp int64
CheckTimestamp int64
Total *big.Int
}
func New(streamer p2p.Streamer, logger log.Logger, store storage.StateStorer, accounting settlement.Accounting, refreshRate, lightRefreshRate *big.Int, p2pService p2p.Service) *Service {
return &Service{
streamer: streamer,
logger: logger.WithName(loggerName).Register(),
metrics: newMetrics(),
store: store,
accounting: accounting,
p2pService: p2pService,
refreshRate: refreshRate,
lightRefreshRate: lightRefreshRate,
timeNow: time.Now,
peers: make(map[string]*pseudoSettlePeer),
}
}
func (s *Service) Protocol() p2p.ProtocolSpec {
return p2p.ProtocolSpec{
Name: protocolName,
Version: protocolVersion,
StreamSpecs: []p2p.StreamSpec{
{
Name: streamName,
Handler: s.handler,
},
},
ConnectIn: s.init,
ConnectOut: s.init,
DisconnectIn: s.terminate,
DisconnectOut: s.terminate,
}
}
func (s *Service) init(ctx context.Context, p p2p.Peer) error {
s.peersMu.Lock()
defer s.peersMu.Unlock()
_, ok := s.peers[p.Address.String()]
if !ok {
peerData := &pseudoSettlePeer{fullNode: p.FullNode}
s.peers[p.Address.String()] = peerData
}
go s.accounting.Connect(p.Address, p.FullNode)
return nil
}
func (s *Service) terminate(p p2p.Peer) error {
s.peersMu.Lock()
defer s.peersMu.Unlock()
delete(s.peers, p.Address.String())
go s.accounting.Disconnect(p.Address)
return nil
}
func totalKey(peer swarm.Address, prefix string) string {
return fmt.Sprintf("%v%v", prefix, peer.String())
}
func totalKeyPeer(key []byte, prefix string) (peer swarm.Address, err error) {
k := string(key)
split := strings.SplitAfter(k, prefix)
if len(split) != 2 {
return swarm.ZeroAddress, errors.New("no peer in key")
}
return swarm.ParseHexAddress(split[1])
}
// peerAllowance computes the maximum incoming payment value we accept
// this is the time based allowance or the peers actual debt, whichever is less
func (s *Service) peerAllowance(peer swarm.Address, fullNode bool) (limit *big.Int, stamp int64, err error) {
var lastTime lastPayment
err = s.store.Get(totalKey(peer, SettlementReceivedPrefix), &lastTime)
if err != nil {
if !errors.Is(err, storage.ErrNotFound) {
return nil, 0, err
}
lastTime.Timestamp = int64(0)
}
currentTime := s.timeNow().Unix()
if currentTime == lastTime.Timestamp {
return nil, 0, ErrSettlementTooSoon
}
var refreshRateUsed *big.Int
if fullNode {
refreshRateUsed = s.refreshRate
} else {
refreshRateUsed = s.lightRefreshRate
}
maxAllowance := new(big.Int).Mul(big.NewInt(currentTime-lastTime.Timestamp), refreshRateUsed)
peerDebt, err := s.accounting.PeerDebt(peer)
if err != nil {
return nil, 0, err
}
if peerDebt.Cmp(maxAllowance) >= 0 {
return maxAllowance, currentTime, nil
}
return peerDebt, currentTime, nil
}
func (s *Service) handler(ctx context.Context, p p2p.Peer, stream p2p.Stream) (err error) {
loggerV1 := s.logger.V(1).Register()
w, r := protobuf.NewWriterAndReader(stream)
defer func() {
if err != nil {
_ = stream.Reset()
s.metrics.ReceivedPseudoSettlementsErrors.Inc()
} else {
stream.FullClose()
}
}()
var req pb.Payment
if err := r.ReadMsgWithContext(ctx, &req); err != nil {
return fmt.Errorf("read request from peer %v: %w", p.Address, err)
}
attemptedAmount := big.NewInt(0).SetBytes(req.Amount)
paymentAmount := new(big.Int).Set(attemptedAmount)
s.peersMu.Lock()
pseudoSettlePeer, ok := s.peers[p.Address.String()]
s.peersMu.Unlock()
if !ok {
return ErrNoPseudoSettlePeer
}
pseudoSettlePeer.lock.Lock()
defer pseudoSettlePeer.lock.Unlock()
allowance, timestamp, err := s.peerAllowance(p.Address, pseudoSettlePeer.fullNode)
if err != nil {
return err
}
if allowance.Cmp(attemptedAmount) < 0 {
paymentAmount.Set(allowance)
}
loggerV1.Debug("pseudosettle accepting payment message from peer", "peer_address", p.Address, "amount", paymentAmount)
if paymentAmount.Cmp(big.NewInt(0)) < 0 {
paymentAmount.Set(big.NewInt(0))
}
err = w.WriteMsgWithContext(ctx, &pb.PaymentAck{
Amount: paymentAmount.Bytes(),
Timestamp: timestamp,
})
if err != nil {
return err
}
var lastTime lastPayment
err = s.store.Get(totalKey(p.Address, SettlementReceivedPrefix), &lastTime)
if err != nil {
if !errors.Is(err, storage.ErrNotFound) {
return err
}
lastTime.Total = big.NewInt(0)
}
lastTime.Total = lastTime.Total.Add(lastTime.Total, paymentAmount)
lastTime.Timestamp = timestamp
err = s.store.Put(totalKey(p.Address, SettlementReceivedPrefix), lastTime)
if err != nil {
return err
}
receivedPaymentF64, _ := big.NewFloat(0).SetInt(paymentAmount).Float64()
s.metrics.TotalReceivedPseudoSettlements.Add(receivedPaymentF64)
s.metrics.ReceivedPseudoSettlements.Inc()
return s.accounting.NotifyRefreshmentReceived(p.Address, paymentAmount, timestamp)
}
// Pay initiates a payment to the given peer
func (s *Service) Pay(ctx context.Context, peer swarm.Address, amount *big.Int) {
loggerV1 := s.logger.V(1).Register()
ctx, cancel := context.WithTimeout(ctx, 5*time.Second)
defer cancel()
var err error
defer func() {
if err != nil {
s.metrics.SentPseudoSettlementsErrors.Inc()
}
}()
var lastTime lastPayment
err = s.store.Get(totalKey(peer, SettlementSentPrefix), &lastTime)
if err != nil {
if !errors.Is(err, storage.ErrNotFound) {
s.accounting.NotifyRefreshmentSent(peer, nil, nil, 0, 0, err)
return
}
lastTime.Total = big.NewInt(0)
lastTime.Timestamp = 0
}
stream, err := s.streamer.NewStream(ctx, peer, nil, protocolName, protocolVersion, streamName)
if err != nil {
s.accounting.NotifyRefreshmentSent(peer, nil, nil, 0, 0, err)
return
}
defer func() {
if err != nil {
_ = stream.Reset()
} else {
_ = stream.FullClose()
}
}()
loggerV1.Debug("pseudosettle sending payment message to peer", "peer_address", peer, "amount", amount)
w, r := protobuf.NewWriterAndReader(stream)
err = w.WriteMsgWithContext(ctx, &pb.Payment{
Amount: amount.Bytes(),
})
if err != nil {
s.accounting.NotifyRefreshmentSent(peer, nil, nil, 0, 0, err)
return
}
var paymentAck pb.PaymentAck
err = r.ReadMsgWithContext(ctx, &paymentAck)
if err != nil {
s.accounting.NotifyRefreshmentSent(peer, nil, nil, 0, 0, err)
return
}
checkTime := s.timeNow().UnixMilli()
acceptedAmount := new(big.Int).SetBytes(paymentAck.Amount)
if acceptedAmount.Cmp(amount) > 0 {
err = fmt.Errorf("pseudosettle: peer %v: %w", peer, ErrRefreshmentAboveExpected)
s.accounting.NotifyRefreshmentSent(peer, nil, nil, 0, 0, err)
return
}
experiencedInterval := checkTime/1000 - lastTime.CheckTimestamp
allegedInterval := paymentAck.Timestamp - lastTime.Timestamp
if allegedInterval < 0 {
s.accounting.NotifyRefreshmentSent(peer, nil, nil, 0, 0, ErrTimeOutOfSyncAlleged)
return
}
experienceDifferenceRecent := paymentAck.Timestamp - checkTime/1000
if experienceDifferenceRecent < -2 || experienceDifferenceRecent > 2 {
s.accounting.NotifyRefreshmentSent(peer, nil, nil, 0, 0, ErrTimeOutOfSyncRecent)
return
}
experienceDifferenceInterval := experiencedInterval - allegedInterval
if experienceDifferenceInterval < -3 || experienceDifferenceInterval > 3 {
s.accounting.NotifyRefreshmentSent(peer, nil, nil, 0, 0, ErrTimeOutOfSyncInterval)
return
}
lastTime.Total = lastTime.Total.Add(lastTime.Total, acceptedAmount)
lastTime.Timestamp = paymentAck.Timestamp
lastTime.CheckTimestamp = checkTime / 1000
err = s.store.Put(totalKey(peer, SettlementSentPrefix), lastTime)
if err != nil {
s.accounting.NotifyRefreshmentSent(peer, nil, nil, 0, 0, err)
return
}
amountFloat, _ := new(big.Float).SetInt(acceptedAmount).Float64()
s.metrics.TotalSentPseudoSettlements.Add(amountFloat)
s.metrics.SentPseudoSettlements.Inc()
s.accounting.NotifyRefreshmentSent(peer, amount, acceptedAmount, checkTime, allegedInterval, nil)
}
func (s *Service) SetAccounting(accounting settlement.Accounting) {
s.accounting = accounting
}
// TotalSent returns the total amount sent to a peer
func (s *Service) TotalSent(peer swarm.Address) (totalSent *big.Int, err error) {
var lastTime lastPayment
err = s.store.Get(totalKey(peer, SettlementSentPrefix), &lastTime)
if err != nil {
if !errors.Is(err, storage.ErrNotFound) {
return nil, settlement.ErrPeerNoSettlements
}
lastTime.Total = big.NewInt(0)
}
return lastTime.Total, nil
}
// TotalReceived returns the total amount received from a peer
func (s *Service) TotalReceived(peer swarm.Address) (totalReceived *big.Int, err error) {
var lastTime lastPayment
err = s.store.Get(totalKey(peer, SettlementReceivedPrefix), &lastTime)
if err != nil {
if !errors.Is(err, storage.ErrNotFound) {
return nil, settlement.ErrPeerNoSettlements
}
lastTime.Total = big.NewInt(0)
}
return lastTime.Total, nil
}
// SettlementsSent returns all stored sent settlement values for a given type of prefix
func (s *Service) SettlementsSent() (map[string]*big.Int, error) {
sent := make(map[string]*big.Int)
err := s.store.Iterate(SettlementSentPrefix, func(key, val []byte) (stop bool, err error) {
addr, err := totalKeyPeer(key, SettlementSentPrefix)
if err != nil {
return false, fmt.Errorf("parse address from key: %s: %w", string(key), err)
}
if _, ok := sent[addr.String()]; !ok {
var storevalue lastPayment
err = s.store.Get(totalKey(addr, SettlementSentPrefix), &storevalue)
if err != nil {
return false, fmt.Errorf("get peer %s settlement balance: %w", addr.String(), err)
}
sent[addr.String()] = storevalue.Total
}
return false, nil
})
if err != nil {
return nil, err
}
return sent, nil
}
// SettlementsReceived returns all stored received settlement values for a given type of prefix
func (s *Service) SettlementsReceived() (map[string]*big.Int, error) {
received := make(map[string]*big.Int)
err := s.store.Iterate(SettlementReceivedPrefix, func(key, val []byte) (stop bool, err error) {
addr, err := totalKeyPeer(key, SettlementReceivedPrefix)
if err != nil {
return false, fmt.Errorf("parse address from key: %s: %w", string(key), err)
}
if _, ok := received[addr.String()]; !ok {
var storevalue lastPayment
err = s.store.Get(totalKey(addr, SettlementReceivedPrefix), &storevalue)
if err != nil {
return false, fmt.Errorf("get peer %s settlement balance: %w", addr.String(), err)
}
received[addr.String()] = storevalue.Total
}
return false, nil
})
if err != nil {
return nil, err
}
return received, nil
}