forked from klaytn/klaytn
/
bridge_addr_journal.go
174 lines (156 loc) · 4.98 KB
/
bridge_addr_journal.go
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
// Modifications Copyright 2019 The klaytn Authors
// Copyright 2017 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum 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 go-ethereum 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 go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
//
// This file is derived from core/tx_journal.go (2018/06/04).
// Modified and improved for the klaytn development.
package sc
import (
"errors"
"github.com/klaytn/klaytn/common"
"github.com/klaytn/klaytn/node/sc/bridgepool"
"github.com/klaytn/klaytn/ser/rlp"
"io"
"os"
)
var (
errNoActiveAddressJournal = errors.New("no active address journal")
errDuplicatedJournal = errors.New("duplicated journal is inserted")
errEmptyBridgeAddress = errors.New("empty bridge address is not allowed")
)
// bridgeAddrJournal is a rotating log of addresses with the aim of storing locally
// created addresses to allow deployed bridge contracts to survive node restarts.
type bridgeAddrJournal struct {
path string // Filesystem path to store the addresses at
writer io.WriteCloser // Output stream to write new addresses into
cache map[common.Address]*BridgeJournal
}
// newBridgeAddrJournal creates a new bridge addr journal to
func newBridgeAddrJournal(path string) *bridgeAddrJournal {
return &bridgeAddrJournal{
path: path,
cache: make(map[common.Address]*BridgeJournal),
}
}
// load parses a address journal dump from disk, loading its contents into
// the specified pool.
func (journal *bridgeAddrJournal) load(add func(journal BridgeJournal) error) error {
// Skip the parsing if the journal file doens't exist at all
if _, err := os.Stat(journal.path); os.IsNotExist(err) {
return nil
}
// Open the journal for loading any past addresses
input, err := os.Open(journal.path)
if err != nil {
return err
}
defer input.Close()
// Temporarily discard any journal additions (don't double add on load)
journal.writer = new(bridgepool.DevNull)
defer func() { journal.writer = nil }()
// Inject all addresses from the journal into the pool
stream := rlp.NewStream(input, 0)
total, dropped := 0, 0
var (
failure error
)
for {
// Parse the next address and terminate on error
addr := new(BridgeJournal)
if err = stream.Decode(addr); err != nil {
if err != io.EOF {
failure = err
}
break
}
total++
if err := add(*addr); err != nil {
failure = err
dropped++
}
}
logger.Info("Loaded local bridge journal", "addrs", total, "dropped", dropped)
return failure
}
// insert adds the specified address to the local disk journal.
func (journal *bridgeAddrJournal) insert(localAddress common.Address, remoteAddress common.Address) error {
if journal.cache[localAddress] != nil {
return errDuplicatedJournal
}
if journal.writer == nil {
return errNoActiveAddressJournal
}
empty := common.Address{}
if localAddress == empty || remoteAddress == empty {
return errEmptyBridgeAddress
}
// TODO-Klaytn-ServiceChain: support false paired
item := BridgeJournal{
localAddress,
remoteAddress,
false,
}
if err := rlp.Encode(journal.writer, &item); err != nil {
return err
}
journal.cache[localAddress] = &item
return nil
}
// rotate regenerates the addresses journal based on the current contents of
// the address pool.
func (journal *bridgeAddrJournal) rotate(all []*BridgeJournal) error {
// Close the current journal (if any is open)
if journal.writer != nil {
if err := journal.writer.Close(); err != nil {
return err
}
journal.writer = nil
}
// Generate a new journal with the contents of the current pool
replacement, err := os.OpenFile(journal.path+".new", os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0755)
if err != nil {
return err
}
journaled := 0
for _, journal := range all {
if err = rlp.Encode(replacement, journal); err != nil {
replacement.Close()
return err
}
journaled++
}
replacement.Close()
// Replace the live journal with the newly generated one
if err = os.Rename(journal.path+".new", journal.path); err != nil {
return err
}
sink, err := os.OpenFile(journal.path, os.O_WRONLY|os.O_APPEND, 0755)
if err != nil {
return err
}
journal.writer = sink
logger.Info("Regenerated local addr journal", "addrs", journaled, "accounts", len(all))
return nil
}
// close flushes the addresses journal contents to disk and closes the file.
func (journal *bridgeAddrJournal) close() error {
var err error
if journal.writer != nil {
err = journal.writer.Close()
journal.writer = nil
}
return err
}