-
Notifications
You must be signed in to change notification settings - Fork 1
/
interfaces.go
171 lines (130 loc) · 5.65 KB
/
interfaces.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
// Copyright (c) 2018 Aidos Developer
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
// This is a rewrite of https://github.com/ripple/rippled/src/ripple/consensus
// covered by:
//------------------------------------------------------------------------------
/*
This file is part of rippled: https://github.com/ripple/rippled
Copyright (c) 2012-2017 Ripple Labs Inc.
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
package consensus
import (
"encoding/hex"
"time"
)
type unixTime int64
//NodeID is a id for a node.
type NodeID [32]byte
func (nid NodeID) String() string {
return hex.EncodeToString(nid[:])
}
//TxID is a id for a tx.
type TxID [32]byte
func (tid TxID) String() string {
return hex.EncodeToString(tid[:])
}
//TxSetID is a id for a txset.
type TxSetID [32]byte
func (tsid TxSetID) String() string {
return hex.EncodeToString(tsid[:])
}
//LedgerID is a id for a ledger.
type LedgerID [32]byte
func (lid LedgerID) String() string {
return hex.EncodeToString(lid[:])
}
//ValidationID is a id for a ledger.
type ValidationID [32]byte
//ProposalID is a id for a Proposal.
type ProposalID [32]byte
//Seq is a sequence no.
type Seq uint64
// TxT is a single transaction
type TxT interface {
ID() TxID
}
//The ValidationAdaptor template implements a set of helper functions that
//plug the consensus algorithm into a specific application. It also identifies
//the types that play important roles in Consensus (transactions, ledgers, ...).
//Normally you should use Peer and PeerInterface instead.
type ValidationAdaptor interface {
// Attempt to acquire a specific ledger.
AcquireLedger(LedgerID) (*Ledger, error)
// Handle a newly stale validation, this should do minimal work since
// it is called by Validations while it may be iterating Validations
// under lock
OnStale(*Validation)
// Flush the remaining validations (typically done on shutdown)
Flush(remaining map[NodeID]*Validation)
// Return the current network time (used to determine staleness)
Now() time.Time
}
//The Adaptor template implements a set of helper functions that
//plug the consensus algorithm into a specific application. It also identifies
//the types that play important roles in Consensus (transactions, ledgers, ...).
//Normally you should use Peer and PeerInterface instead.
type Adaptor interface {
//-----------------------------------------------------------------------
//
// Attempt to acquire a specific ledger.
AcquireLedger(LedgerID) (*Ledger, error)
// Acquire the transaction set associated with a proposed position.
AcquireTxSet(TxSetID) (TxSet, error)
// Whether any transactions are in the open ledger
HasOpenTransactions() bool
// Number of proposers that have validated the given ledger
ProposersValidated(LedgerID) uint
// Number of proposers that have validated a ledger descended from the
// given ledger; if prevLedger.id() != prevLedgerID, use prevLedgerID
// for the determination
ProposersFinished(*Ledger, LedgerID) uint
// Return the ID of the last closed (and validated) ledger that the
// application thinks consensus should use as the prior ledger.
GetPrevLedger(LedgerID, *Ledger, Mode) LedgerID
// Called whenever consensus operating mode changes
OnModeChange(Mode, Mode)
// Called when ledger closes
OnClose(*Ledger, time.Time, Mode) *Result
// Called when ledger is accepted by consensus
OnAccept(*Result, *Ledger, time.Duration, *CloseTimes, Mode)
// Propose the position to peers.
Propose(*Proposal)
// Share a received peer proposal with other peer's.
SharePosition(*Proposal)
// Share a disputed transaction with peers
ShareTx(TxT)
// Share given transaction set with peers
ShareTxset(TxSet)
//ShouldAccept returns false if we should wait accept
ShouldAccept(*Result) bool
//UpdateOurProposal updates our proposal from otherss proposals
UpdateOurProposal(props map[NodeID]*Proposal, ourSet, newSet TxSet) TxSet
}
type clock interface {
Now() time.Time
}