mirror of https://github.com/poanetwork/gecko.git
Clarify that the snowball byzantine struct is only for testing
This commit is contained in:
parent
6c34fd79eb
commit
12297cb0d2
|
@ -1,48 +0,0 @@
|
|||
// (c) 2019-2020, Ava Labs, Inc. All rights reserved.
|
||||
// See the file LICENSE for licensing terms.
|
||||
|
||||
package snowball
|
||||
|
||||
import (
|
||||
"github.com/ava-labs/gecko/ids"
|
||||
)
|
||||
|
||||
// ByzantineFactory implements Factory by returning a byzantine struct
|
||||
type ByzantineFactory struct{}
|
||||
|
||||
// New implements Factory
|
||||
func (ByzantineFactory) New() Consensus { return &Byzantine{} }
|
||||
|
||||
// Byzantine is a naive implementation of a multi-choice snowball instance
|
||||
type Byzantine struct {
|
||||
// params contains all the configurations of a snowball instance
|
||||
params Parameters
|
||||
|
||||
// Hardcode the preference
|
||||
preference ids.ID
|
||||
}
|
||||
|
||||
// Initialize implements the Consensus interface
|
||||
func (b *Byzantine) Initialize(params Parameters, choice ids.ID) {
|
||||
b.params = params
|
||||
b.preference = choice
|
||||
}
|
||||
|
||||
// Parameters implements the Consensus interface
|
||||
func (b *Byzantine) Parameters() Parameters { return b.params }
|
||||
|
||||
// Add implements the Consensus interface
|
||||
func (b *Byzantine) Add(choice ids.ID) {}
|
||||
|
||||
// Preference implements the Consensus interface
|
||||
func (b *Byzantine) Preference() ids.ID { return b.preference }
|
||||
|
||||
// RecordPoll implements the Consensus interface
|
||||
func (b *Byzantine) RecordPoll(votes ids.Bag) {}
|
||||
|
||||
// RecordUnsuccessfulPoll implements the Consensus interface
|
||||
func (b *Byzantine) RecordUnsuccessfulPoll() {}
|
||||
|
||||
// Finalized implements the Consensus interface
|
||||
func (b *Byzantine) Finalized() bool { return true }
|
||||
func (b *Byzantine) String() string { return b.preference.String() }
|
|
@ -1,54 +0,0 @@
|
|||
// (c) 2019-2020, Ava Labs, Inc. All rights reserved.
|
||||
// See the file LICENSE for licensing terms.
|
||||
|
||||
package snowball
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/ava-labs/gecko/ids"
|
||||
"github.com/prometheus/client_golang/prometheus"
|
||||
)
|
||||
|
||||
func TestByzantine(t *testing.T) {
|
||||
params := Parameters{
|
||||
Metrics: prometheus.NewRegistry(),
|
||||
K: 1, Alpha: 1, BetaVirtuous: 3, BetaRogue: 5,
|
||||
}
|
||||
|
||||
byzFactory := ByzantineFactory{}
|
||||
byz := byzFactory.New()
|
||||
byz.Initialize(params, Blue)
|
||||
|
||||
if ret := byz.Parameters(); ret != params {
|
||||
t.Fatalf("Should have returned the correct params")
|
||||
}
|
||||
|
||||
byz.Add(Green)
|
||||
|
||||
if pref := byz.Preference(); !pref.Equals(Blue) {
|
||||
t.Fatalf("Wrong preference, expected %s returned %s", Blue, pref)
|
||||
}
|
||||
|
||||
oneGreen := ids.Bag{}
|
||||
oneGreen.Add(Green)
|
||||
byz.RecordPoll(oneGreen)
|
||||
|
||||
if pref := byz.Preference(); !pref.Equals(Blue) {
|
||||
t.Fatalf("Wrong preference, expected %s returned %s", Blue, pref)
|
||||
}
|
||||
|
||||
byz.RecordUnsuccessfulPoll()
|
||||
|
||||
if pref := byz.Preference(); !pref.Equals(Blue) {
|
||||
t.Fatalf("Wrong preference, expected %s returned %s", Blue, pref)
|
||||
}
|
||||
|
||||
if final := byz.Finalized(); !final {
|
||||
t.Fatalf("Should be marked as accepted")
|
||||
}
|
||||
|
||||
if str := byz.String(); str != Blue.String() {
|
||||
t.Fatalf("Wrong string, expected %s returned %s", Blue, str)
|
||||
}
|
||||
}
|
|
@ -11,6 +11,46 @@ import (
|
|||
"github.com/ava-labs/gecko/ids"
|
||||
)
|
||||
|
||||
// ByzantineFactory implements Factory by returning a byzantine struct
|
||||
type ByzantineFactory struct{}
|
||||
|
||||
// New implements Factory
|
||||
func (ByzantineFactory) New() Consensus { return &Byzantine{} }
|
||||
|
||||
// Byzantine is a naive implementation of a multi-choice snowball instance
|
||||
type Byzantine struct {
|
||||
// params contains all the configurations of a snowball instance
|
||||
params Parameters
|
||||
|
||||
// Hardcode the preference
|
||||
preference ids.ID
|
||||
}
|
||||
|
||||
// Initialize implements the Consensus interface
|
||||
func (b *Byzantine) Initialize(params Parameters, choice ids.ID) {
|
||||
b.params = params
|
||||
b.preference = choice
|
||||
}
|
||||
|
||||
// Parameters implements the Consensus interface
|
||||
func (b *Byzantine) Parameters() Parameters { return b.params }
|
||||
|
||||
// Add implements the Consensus interface
|
||||
func (b *Byzantine) Add(choice ids.ID) {}
|
||||
|
||||
// Preference implements the Consensus interface
|
||||
func (b *Byzantine) Preference() ids.ID { return b.preference }
|
||||
|
||||
// RecordPoll implements the Consensus interface
|
||||
func (b *Byzantine) RecordPoll(votes ids.Bag) {}
|
||||
|
||||
// RecordUnsuccessfulPoll implements the Consensus interface
|
||||
func (b *Byzantine) RecordUnsuccessfulPoll() {}
|
||||
|
||||
// Finalized implements the Consensus interface
|
||||
func (b *Byzantine) Finalized() bool { return true }
|
||||
func (b *Byzantine) String() string { return b.preference.String() }
|
||||
|
||||
var (
|
||||
Red = ids.Empty.Prefix(0)
|
||||
Blue = ids.Empty.Prefix(1)
|
||||
|
|
Loading…
Reference in New Issue