This repository has been archived by the owner on May 13, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 346
/
account.go
324 lines (276 loc) · 9.92 KB
/
account.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
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
// Copyright 2017 Monax Industries Limited
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package account
import (
"encoding/json"
"fmt"
"github.com/hyperledger/burrow/binary"
"github.com/hyperledger/burrow/crypto"
ptypes "github.com/hyperledger/burrow/permission/types"
"github.com/tendermint/go-amino"
)
var GlobalPermissionsAddress = crypto.Address(binary.Zero160)
type Addressable interface {
// Get the 20 byte EVM address of this account
Address() crypto.Address
// Public key from which the Address is derived
PublicKey() crypto.PublicKey
}
// The default immutable interface to an account
type Account interface {
Addressable
// The value held by this account in terms of the chain-native token
Balance() uint64
// The EVM byte code held by this account (or equivalently, this contract)
Code() Bytecode
// The sequence number of this account, incremented each time a mutation of the
// Account is persisted to the blockchain state
Sequence() uint64
// The hash of all the values in this accounts storage (typically the root of some subtree
// in the merkle tree of global storage state)
StorageRoot() []byte
// The permission flags and roles for this account
Permissions() ptypes.AccountPermissions
// Obtain a deterministic serialisation of this account
// (i.e. update order and Go runtime independent)
Encode() ([]byte, error)
// String representation of the account
String() string
}
type MutableAccount interface {
Account
// Set public key (needed for lazy initialisation), should also set the dependent address
SetPublicKey(pubKey crypto.PublicKey) MutableAccount
// Subtract amount from account balance (will panic if amount is greater than balance)
SubtractFromBalance(amount uint64) (MutableAccount, error)
// Add amount to balance (will panic if amount plus balance is a uint64 overflow)
AddToBalance(amount uint64) (MutableAccount, error)
// Set EVM byte code associated with account
SetCode(code []byte) MutableAccount
// Increment Sequence number by 1 (capturing the current Sequence number as the index for any pending mutations)
IncSequence() MutableAccount
// Set the storage root hash
SetStorageRoot(storageRoot []byte) MutableAccount
// Set account permissions
SetPermissions(permissions ptypes.AccountPermissions) MutableAccount
// Get a pointer this account's AccountPermissions in order to mutate them
MutablePermissions() *ptypes.AccountPermissions
// Create a complete copy of this MutableAccount that is itself mutable
Copy() MutableAccount
}
// -------------------------------------------------
// ConcreteAccount
// ConcreteAccount is the canonical serialisation and bash-in-place object for an Account
type ConcreteAccount struct {
Address crypto.Address
PublicKey crypto.PublicKey
Sequence uint64
Balance uint64
Code Bytecode
StorageRoot []byte
Permissions ptypes.AccountPermissions
}
func NewConcreteAccount(pubKey crypto.PublicKey) ConcreteAccount {
return ConcreteAccount{
Address: pubKey.Address(),
PublicKey: pubKey,
}
}
func NewConcreteAccountFromSecret(secret string) ConcreteAccount {
return NewConcreteAccount(crypto.PrivateKeyFromSecret(secret, crypto.CurveTypeEd25519).GetPublicKey())
}
// Return as immutable Account
func (acc ConcreteAccount) Account() Account {
return concreteAccountWrapper{&acc}
}
// Return as mutable MutableAccount
func (acc ConcreteAccount) MutableAccount() MutableAccount {
return concreteAccountWrapper{&acc}
}
func (acc *ConcreteAccount) Copy() *ConcreteAccount {
accCopy := *acc
return &accCopy
}
func (acc *ConcreteAccount) String() string {
if acc == nil {
return "Account{nil}"
}
return fmt.Sprintf("Account{Address: %s; Sequence: %v; PublicKey: %v Balance: %v; CodeBytes: %v; StorageRoot: 0x%X; Permissions: %s}",
acc.Address, acc.Sequence, acc.PublicKey, acc.Balance, len(acc.Code), acc.StorageRoot, acc.Permissions)
}
// ConcreteAccount
// -------------------------------------------------
// Conversions
//
// Using the naming convention is this package of 'As<Type>' being
// a conversion from Account to <Type> and 'From<Type>' being conversion
// from <Type> to Account. Conversions are done by copying
// Returns a mutable, serialisable ConcreteAccount by copying from account
func AsConcreteAccount(account Account) *ConcreteAccount {
if account == nil {
return nil
}
// Avoid a copy
if ca, ok := account.(concreteAccountWrapper); ok {
return ca.ConcreteAccount
}
return &ConcreteAccount{
Address: account.Address(),
PublicKey: account.PublicKey(),
Balance: account.Balance(),
Code: account.Code(),
Sequence: account.Sequence(),
StorageRoot: account.StorageRoot(),
Permissions: account.Permissions(),
}
}
// Creates an otherwise zeroed Account from an Addressable and returns it as MutableAccount
func FromAddressable(addressable Addressable) MutableAccount {
return ConcreteAccount{
Address: addressable.Address(),
PublicKey: addressable.PublicKey(),
// Since nil slices and maps compare differently to empty ones
Code: Bytecode{},
StorageRoot: []byte{},
Permissions: ptypes.AccountPermissions{
Roles: []string{},
},
}.MutableAccount()
}
// Returns an immutable account by copying from account
func AsAccount(account Account) Account {
if account == nil {
return nil
}
return AsConcreteAccount(account).Account()
}
// Returns a MutableAccount by copying from account
func AsMutableAccount(account Account) MutableAccount {
if account == nil {
return nil
}
return AsConcreteAccount(account).MutableAccount()
}
//----------------------------------------------
// concreteAccount Wrapper
// concreteAccountWrapper wraps ConcreteAccount to provide a immutable read-only view
// via its implementation of Account and a mutable implementation via its implementation of
// MutableAccount
type concreteAccountWrapper struct {
*ConcreteAccount `json:"unwrap"`
}
var _ Account = concreteAccountWrapper{}
func (caw concreteAccountWrapper) Address() crypto.Address {
return caw.ConcreteAccount.Address
}
func (caw concreteAccountWrapper) PublicKey() crypto.PublicKey {
return caw.ConcreteAccount.PublicKey
}
func (caw concreteAccountWrapper) Balance() uint64 {
return caw.ConcreteAccount.Balance
}
func (caw concreteAccountWrapper) Code() Bytecode {
return caw.ConcreteAccount.Code
}
func (caw concreteAccountWrapper) Sequence() uint64 {
return caw.ConcreteAccount.Sequence
}
func (caw concreteAccountWrapper) StorageRoot() []byte {
return caw.ConcreteAccount.StorageRoot
}
func (caw concreteAccountWrapper) Permissions() ptypes.AccountPermissions {
return caw.ConcreteAccount.Permissions
}
func (caw concreteAccountWrapper) Encode() ([]byte, error) {
return caw.ConcreteAccount.Encode()
}
func (caw concreteAccountWrapper) String() string {
return caw.ConcreteAccount.String()
}
func (caw concreteAccountWrapper) MarshalJSON() ([]byte, error) {
return json.Marshal(caw.ConcreteAccount)
}
// Account mutation via MutableAccount interface
var _ MutableAccount = concreteAccountWrapper{}
func (caw concreteAccountWrapper) SetPublicKey(pubKey crypto.PublicKey) MutableAccount {
caw.ConcreteAccount.PublicKey = pubKey
addressFromPubKey := pubKey.Address()
// We don't want the wrong public key to take control of an account so we panic here
if caw.ConcreteAccount.Address != addressFromPubKey {
panic(fmt.Errorf("attempt to set public key of account %s to %v, "+
"but that public key has address %s",
caw.ConcreteAccount.Address, pubKey, addressFromPubKey))
}
return caw
}
func (caw concreteAccountWrapper) SubtractFromBalance(amount uint64) (MutableAccount, error) {
if amount > caw.Balance() {
return nil, fmt.Errorf("insufficient funds: attempt to subtract %v from the balance of %s",
amount, caw.ConcreteAccount)
}
caw.ConcreteAccount.Balance -= amount
return caw, nil
}
func (caw concreteAccountWrapper) AddToBalance(amount uint64) (MutableAccount, error) {
if binary.IsUint64SumOverflow(caw.Balance(), amount) {
return nil, fmt.Errorf("uint64 overflow: attempt to add %v to the balance of %s",
amount, caw.ConcreteAccount)
}
caw.ConcreteAccount.Balance += amount
return caw, nil
}
func (caw concreteAccountWrapper) SetCode(code []byte) MutableAccount {
caw.ConcreteAccount.Code = code
return caw
}
func (caw concreteAccountWrapper) IncSequence() MutableAccount {
caw.ConcreteAccount.Sequence += 1
return caw
}
func (caw concreteAccountWrapper) SetStorageRoot(storageRoot []byte) MutableAccount {
caw.ConcreteAccount.StorageRoot = storageRoot
return caw
}
func (caw concreteAccountWrapper) SetPermissions(permissions ptypes.AccountPermissions) MutableAccount {
caw.ConcreteAccount.Permissions = permissions
return caw
}
func (caw concreteAccountWrapper) MutablePermissions() *ptypes.AccountPermissions {
return &caw.ConcreteAccount.Permissions
}
func (caw concreteAccountWrapper) Copy() MutableAccount {
return concreteAccountWrapper{caw.ConcreteAccount.Copy()}
}
// concreteAccount Wrapper
//----------------------------------------------
// Encoding/decoding
var cdc = amino.NewCodec()
func (acc *ConcreteAccount) Encode() ([]byte, error) {
return cdc.MarshalBinary(acc)
}
func Decode(accBytes []byte) (Account, error) {
ca, err := DecodeConcrete(accBytes)
if err != nil {
return nil, err
}
return ca.Account(), nil
}
func DecodeConcrete(accBytes []byte) (*ConcreteAccount, error) {
ca := new(ConcreteAccount)
err := cdc.UnmarshalBinary(accBytes, ca)
if err != nil {
return nil, fmt.Errorf("could not convert decoded account to *ConcreteAccount: %v", err)
}
return ca, nil
}