aboutsummaryrefslogtreecommitdiffstats
path: root/simulation/node.go
blob: 8c37f65db5c54d9aafffe77222c6049fd5a6aab2 (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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
// 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 simulation

import (
    "encoding/json"
    "fmt"
    "os"
    "time"

    "github.com/dexon-foundation/dexon-consensus/common"
    "github.com/dexon-foundation/dexon-consensus/core"
    "github.com/dexon-foundation/dexon-consensus/core/blockdb"
    "github.com/dexon-foundation/dexon-consensus/core/crypto"
    "github.com/dexon-foundation/dexon-consensus/core/test"
    "github.com/dexon-foundation/dexon-consensus/core/types"
    "github.com/dexon-foundation/dexon-consensus/simulation/config"
    "github.com/dexon-foundation/dexon/log"
)

type infoStatus string

const (
    statusInit     infoStatus = "init"
    statusNormal   infoStatus = "normal"
    statusShutdown infoStatus = "shutdown"
)

type messageType string

const (
    shutdownAck    messageType = "shutdownAck"
    blockTimestamp messageType = "blockTimestamps"
)

// message is a struct for peer sending message to server.
type message struct {
    Type    messageType     `json:"type"`
    Payload json.RawMessage `json:"payload"`
}

// node represents a node in DexCon.
type node struct {
    app       core.Application
    db        blockdb.BlockDatabase
    gov       *test.Governance
    netModule *test.Network
    ID        types.NodeID
    prvKey    crypto.PrivateKey
    consensus *core.Consensus
}

// newNode returns a new empty node.
func newNode(
    prvKey crypto.PrivateKey,
    config config.Config) *node {
    pubKey := prvKey.PublicKey()
    netModule := test.NewNetwork(
        pubKey,
        &test.NormalLatencyModel{
            Mean:  config.Networking.Mean,
            Sigma: config.Networking.Sigma,
        },
        test.NewDefaultMarshaller(&jsonMarshaller{}),
        test.NetworkConfig{
            Type:       config.Networking.Type,
            PeerServer: config.Networking.PeerServer,
            PeerPort:   peerPort,
        })
    id := types.NewNodeID(pubKey)
    db, err := blockdb.NewMemBackedBlockDB(id.String() + ".blockdb")
    if err != nil {
        panic(err)
    }
    // Sync config to state in governance.
    cConfig := config.Node.Consensus
    gov, err := test.NewGovernance(
        []crypto.PublicKey{pubKey}, time.Millisecond, core.ConfigRoundShift)
    if err != nil {
        panic(err)
    }
    gov.State().RequestChange(test.StateChangeK, cConfig.K)
    gov.State().RequestChange(test.StateChangePhiRatio, cConfig.PhiRatio)
    gov.State().RequestChange(test.StateChangeNumChains, cConfig.ChainNum)
    gov.State().RequestChange(
        test.StateChangeNotarySetSize, cConfig.NotarySetSize)
    gov.State().RequestChange(test.StateChangeDKGSetSize, cConfig.DKGSetSize)
    gov.State().RequestChange(test.StateChangeLambdaBA, time.Duration(
        cConfig.LambdaBA)*time.Millisecond)
    gov.State().RequestChange(test.StateChangeLambdaDKG, time.Duration(
        cConfig.LambdaDKG)*time.Millisecond)
    gov.State().RequestChange(test.StateChangeRoundInterval, time.Duration(
        cConfig.RoundInterval)*time.Millisecond)
    gov.State().RequestChange(
        test.StateChangeMinBlockInterval,
        3*time.Duration(cConfig.LambdaBA)*time.Millisecond)
    gov.State().ProposeCRS(0, crypto.Keccak256Hash([]byte(cConfig.GenesisCRS)))
    return &node{
        ID:        id,
        prvKey:    prvKey,
        app:       newSimApp(id, netModule, gov.State()),
        gov:       gov,
        db:        db,
        netModule: netModule,
    }
}

// GetID returns the ID of node.
func (n *node) GetID() types.NodeID {
    return n.ID
}

// run starts the node.
func (n *node) run(serverEndpoint interface{}, dMoment time.Time) {
    // Run network.
    if err := n.netModule.Setup(serverEndpoint); err != nil {
        panic(err)
    }
    msgChannel := n.netModule.ReceiveChanForNode()
    peers := n.netModule.Peers()
    go n.netModule.Run()
    // Run consensus.
    hashes := make(common.Hashes, 0, len(peers))
    for _, pubKey := range peers {
        nID := types.NewNodeID(pubKey)
        n.gov.State().RequestChange(test.StateAddNode, pubKey)
        hashes = append(hashes, nID.Hash)
    }
    // This notification is implictly called in full node.
    n.gov.NotifyRoundHeight(0, 0)
    // Setup of governance is ready, can be switched to remote mode.
    n.gov.SwitchToRemoteMode(n.netModule)
    // Setup Consensus.
    logger := log.New()
    logger.SetHandler(log.StreamHandler(os.Stderr, log.LogfmtFormat()))
    n.consensus = core.NewConsensus(
        dMoment,
        n.app,
        n.gov,
        n.db,
        n.netModule,
        n.prvKey,
        logger)
    go n.consensus.Run(&types.Block{})

    // Blocks forever.
MainLoop:
    for {
        msg := <-msgChannel
        switch val := msg.(type) {
        case infoStatus:
            if val == statusShutdown {
                break MainLoop
            }
        default:
            panic(fmt.Errorf("unexpected message from server: %v", val))
        }
    }
    // Cleanup.
    n.consensus.Stop()
    if err := n.db.Close(); err != nil {
        fmt.Println(err)
    }
    n.netModule.Report(&message{
        Type: shutdownAck,
    })
    // TODO(mission): once we have a way to know if consensus is stopped, stop
    //                the network module.
    return
}