aboutsummaryrefslogtreecommitdiffstats
path: root/simulation/config/config.go
blob: 797145c0bfcd552824c6d29861795bd514103a79 (plain) (blame)
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
// Copyright 2018 The dexon-consensus Authors
// This file is part of the dexon-consensus library.
//
// The dexon-consensus library is free software: you can redistribute it
// and/or modify it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation, either version 3 of the License,
// or (at your option) any later version.
//
// The dexon-consensus library is distributed in the hope that it will be
// useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
// General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the dexon-consensus library. If not, see
// <http://www.gnu.org/licenses/>.

package config

import (
    "fmt"
    "math"
    "os"

    "github.com/dexon-foundation/dexon-consensus/core"
    "github.com/dexon-foundation/dexon-consensus/core/test"
    "github.com/naoina/toml"
)

// Consensus settings.
type Consensus struct {
    PhiRatio         float32
    K                int
    NumChains        uint32
    GenesisCRS       string `toml:"genesis_crs"`
    LambdaBA         int    `toml:"lambda_ba"`
    LambdaDKG        int    `toml:"lambda_dkg"`
    RoundInterval    int
    NotarySetSize    uint32
    DKGSetSize       uint32 `toml:"dkg_set_size"`
    MinBlockInterval int
}

// Legacy config.
type Legacy struct {
    ProposeIntervalMean  float64
    ProposeIntervalSigma float64
}

// Node config for the simulation.
type Node struct {
    Consensus Consensus
    Legacy    Legacy
    Num       uint32
    MaxBlock  uint64
    Changes   []Change
}

// Networking config.
type Networking struct {
    Type       test.NetworkType
    PeerServer string

    Mean          float64
    Sigma         float64
    LossRateValue float64
}

// Scheduler Settings.
type Scheduler struct {
    WorkerNum int
}

// Change represent future configuration changes.
type Change struct {
    Round uint64
    Type  string
    Value string
}

// RegisterChange reigster this change to a test.Governance instance.
func (c Change) RegisterChange(gov *test.Governance) error {
    if c.Round < core.ConfigRoundShift {
        panic(fmt.Errorf(
            "attempt to register config change that never be executed: %v",
            c.Round))
    }
    t := StateChangeTypeFromString(c.Type)
    return gov.RegisterConfigChange(
        c.Round, t, StateChangeValueFromString(t, c.Value))
}

// Config represents the configuration for simulation.
type Config struct {
    Title      string
    Node       Node
    Networking Networking
    Scheduler  Scheduler
}

// GenerateDefault generates a default configuration file.
func GenerateDefault(path string) error {
    f, err := os.Create(path)
    if err != nil {
        return err
    }
    defer f.Close()

    config := Config{
        Title: "DEXON Consensus Simulation Config",
        Node: Node{
            Consensus: Consensus{
                PhiRatio:         float32(2) / 3,
                K:                1,
                NumChains:        7,
                GenesisCRS:       "In DEXON we trust.",
                LambdaBA:         250,
                LambdaDKG:        1000,
                RoundInterval:    30 * 1000,
                NotarySetSize:    7,
                DKGSetSize:       7,
                MinBlockInterval: 750,
            },
            Legacy: Legacy{
                ProposeIntervalMean:  500,
                ProposeIntervalSigma: 50,
            },
            Num:      7,
            MaxBlock: math.MaxUint64,
        },
        Networking: Networking{
            Type:          test.NetworkTypeTCPLocal,
            PeerServer:    "127.0.0.1",
            Mean:          100,
            Sigma:         10,
            LossRateValue: 0,
        },
        Scheduler: Scheduler{
            WorkerNum: 2,
        },
    }

    if err := toml.NewEncoder(f).Encode(&config); err != nil {
        return err
    }
    return nil
}

// Read reads the config from a file.
func Read(path string) (*Config, error) {
    f, err := os.Open(path)
    if err != nil {
        return nil, err
    }
    defer f.Close()

    var config Config

    if err := toml.NewDecoder(f).Decode(&config); err != nil {
        return nil, err
    }
    return &config, nil
}