aboutsummaryrefslogtreecommitdiffstats
path: root/simulation/config/config.go
blob: 02c077b416b402a2f7e6915d4c541713ec7016c4 (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
// Copyright 2018 The dexon-consensus-core Authors
// This file is part of the dexon-consensus-core library.
//
// The dexon-consensus-core 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-core 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-core library. If not, see
// <http://www.gnu.org/licenses/>.

package config

import (
    "math"
    "os"

    "github.com/naoina/toml"
)

// NetworkType is the simulation network type.
type NetworkType string

// NetworkType enums.
const (
    NetworkTypeFake     NetworkType = "fake"
    NetworkTypeTCP      NetworkType = "tcp"
    NetworkTypeTCPLocal NetworkType = "tcp-local"
)

// Consensus settings.
type Consensus struct {
    PhiRatio float32
    K        int
}

// Validator config for the simulation.
type Validator struct {
    Consensus            Consensus
    Num                  int
    ProposeIntervalMean  float64
    ProposeIntervalSigma float64
    MaxBlock             uint64
}

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

    Mean          float64
    Sigma         float64
    LossRateValue float64
}

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

// 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",
        Validator: Validator{
            Consensus: Consensus{
                PhiRatio: 0.66667,
                K:        2,
            },
            Num:                  7,
            ProposeIntervalMean:  500,
            ProposeIntervalSigma: 30,
            MaxBlock:             math.MaxUint64,
        },
        Networking: Networking{
            Type:          NetworkTypeFake,
            PeerServer:    "peer.server",
            Mean:          100,
            Sigma:         10,
            LossRateValue: 0,
        },
    }

    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
}