aboutsummaryrefslogtreecommitdiffstats
path: root/simulation/app.go
blob: 87672fd5e03f4f97b1a848393919e7afac870850 (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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
// 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 simulation

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

    "github.com/dexon-foundation/dexon-consensus-core/common"
    "github.com/dexon-foundation/dexon-consensus-core/core/types"
)

// simApp is an DEXON app for simulation.
type simApp struct {
    ValidatorID types.ValidatorID
    Outputs     []*types.Block
    Early       bool
    netModule   *network
    DeliverID   int
    // blockSeen stores the time when block is delivered by Total Ordering.
    blockSeen map[common.Hash]time.Time
    // uncofirmBlocks stores the blocks whose timestamps are not ready.
    unconfirmedBlocks map[types.ValidatorID]common.Hashes
    blockByHash       map[common.Hash]*types.Block
    blockByHashMutex  sync.RWMutex
}

// newSimApp returns point to a new instance of simApp.
func newSimApp(id types.ValidatorID, netModule *network) *simApp {
    return &simApp{
        ValidatorID:       id,
        netModule:         netModule,
        DeliverID:         0,
        blockSeen:         make(map[common.Hash]time.Time),
        unconfirmedBlocks: make(map[types.ValidatorID]common.Hashes),
        blockByHash:       make(map[common.Hash]*types.Block),
    }
}

// BlockConfirmed implements core.Application.
func (a *simApp) BlockConfirmed(block *types.Block) {
    a.blockByHashMutex.Lock()
    defer a.blockByHashMutex.Unlock()

    // TODO(jimmy-dexon) : Remove block in this hash if it's no longer needed.
    a.blockByHash[block.Hash] = block
}

// VerifyPayloads implements core.Application.
func (a *simApp) VerifyPayloads(payloads []byte) bool {
    return true
}

// getAckedBlocks will return all unconfirmed blocks' hash with lower Height
// than the block with ackHash.
func (a *simApp) getAckedBlocks(ackHash common.Hash) (output common.Hashes) {
    // TODO(jimmy-dexon): Why there are some acks never seen?
    ackBlock, exist := a.blockByHash[ackHash]
    if !exist {
        return
    }
    hashes, exist := a.unconfirmedBlocks[ackBlock.ProposerID]
    if !exist {
        return
    }
    for i, blockHash := range hashes {
        if a.blockByHash[blockHash].Position.Height > ackBlock.Position.Height {
            output, a.unconfirmedBlocks[ackBlock.ProposerID] = hashes[:i], hashes[i:]
            break
        }
    }

    // All of the Height of unconfirmed blocks are lower than the acked block.
    if len(output) == 0 {
        output, a.unconfirmedBlocks[ackBlock.ProposerID] = hashes, common.Hashes{}
    }
    return
}

// PreparePayload implements core.Application.
func (a *simApp) PreparePayload(position types.Position) []byte {
    return []byte{}
}

// StronglyAcked is called when a block is strongly acked by DEXON
// Reliabe Broadcast algorithm.
func (a *simApp) StronglyAcked(blockHash common.Hash) {
}

// TotalOrderingDeliver is called when blocks are delivered by the total
// ordering algorithm.
func (a *simApp) TotalOrderingDeliver(blockHashes common.Hashes, early bool) {
    now := time.Now()
    blocks := make([]*types.Block, len(blockHashes))
    a.blockByHashMutex.RLock()
    defer a.blockByHashMutex.RUnlock()
    for idx := range blockHashes {
        blocks[idx] = a.blockByHash[blockHashes[idx]]
    }
    a.Outputs = blocks
    a.Early = early
    fmt.Println("OUTPUT", a.ValidatorID, a.Early, a.Outputs)

    confirmLatency := []time.Duration{}

    payload := []timestampMessage{}
    for _, block := range blocks {
        if block.ProposerID == a.ValidatorID {
            confirmLatency = append(confirmLatency,
                now.Sub(block.Timestamp))
        }
        for _, hash := range block.Acks {
            for _, blockHash := range a.getAckedBlocks(hash) {
                payload = append(payload, timestampMessage{
                    BlockHash: blockHash,
                    Event:     timestampAck,
                    Timestamp: now,
                })
                delete(a.blockSeen, block.Hash)
            }
        }
    }
    if len(payload) > 0 {
        jsonPayload, err := json.Marshal(payload)
        if err != nil {
            fmt.Println(err)
        } else {
            msg := &message{
                Type:    blockTimestamp,
                Payload: jsonPayload,
            }
            a.netModule.report(msg)
        }
    }

    blockList := &BlockList{
        ID:             a.DeliverID,
        BlockHash:      blockHashes,
        ConfirmLatency: confirmLatency,
    }
    a.netModule.report(blockList)
    a.DeliverID++
    for _, block := range blocks {
        a.blockSeen[block.Hash] = now
        a.unconfirmedBlocks[block.ProposerID] = append(
            a.unconfirmedBlocks[block.ProposerID], block.Hash)
    }
}

// DeliverBlock is called when a block in compaction chain is delivered.
func (a *simApp) DeliverBlock(blockHash common.Hash, timestamp time.Time) {
    seenTime, exist := a.blockSeen[blockHash]
    if !exist {
        return
    }
    now := time.Now()
    payload := []timestampMessage{
        {
            BlockHash: blockHash,
            Event:     blockSeen,
            Timestamp: seenTime,
        },
        {
            BlockHash: blockHash,
            Event:     timestampConfirm,
            Timestamp: now,
        },
    }
    jsonPayload, err := json.Marshal(payload)
    if err != nil {
        fmt.Println(err)
        return
    }
    msg := &message{
        Type:    blockTimestamp,
        Payload: jsonPayload,
    }
    a.netModule.report(msg)
}

// WitnessAckDeliver is called when a witness ack is created.
func (a *simApp) WitnessAckDeliver(witnessAck *types.WitnessAck) {
}