-
Notifications
You must be signed in to change notification settings - Fork 18
/
asset.go
409 lines (367 loc) · 10.2 KB
/
asset.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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
// Copyright (C) 2023 Gobalsky Labs Limited
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package types
import (
"errors"
"fmt"
"code.vegaprotocol.io/vega/libs/crypto"
"code.vegaprotocol.io/vega/libs/num"
"code.vegaprotocol.io/vega/libs/stringer"
proto "code.vegaprotocol.io/vega/protos/vega"
)
var (
ErrMissingERC20ContractAddress = errors.New("missing erc20 contract address")
ErrMissingBuiltinAssetField = errors.New("missing builtin asset field")
ErrInvalidAssetNameEmpty = errors.New("invalid asset, name must not be empty")
ErrInvalidAssetSymbolEmpty = errors.New("invalid asset, symbol must not be empty")
ErrInvalidAssetDecimalPlacesZero = errors.New("invalid asset, decimal places must not be zero")
ErrInvalidAssetQuantumZero = errors.New("invalid asset, quantum must not be zero")
ErrLifetimeLimitMustBePositive = errors.New("lifetime limit must be positive")
ErrWithdrawThresholdMustBePositive = errors.New("withdraw threshold must be positive")
)
type AssetStatus = proto.Asset_Status
const (
// Default value, always invalid.
AssetStatusUnspecified AssetStatus = proto.Asset_STATUS_UNSPECIFIED
// Asset is proposed and under vote.
AssetStatusProposed AssetStatus = proto.Asset_STATUS_PROPOSED
// Asset has been rejected from governance.
AssetStatusRejected AssetStatus = proto.Asset_STATUS_REJECTED
// Asset is pending listing from the bridge.
AssetStatusPendingListing AssetStatus = proto.Asset_STATUS_PENDING_LISTING
// Asset is fully usable in the network.
AssetStatusEnabled AssetStatus = proto.Asset_STATUS_ENABLED
)
type Asset struct {
// Internal identifier of the asset
ID string
// Name of the asset (e.g: Great British Pound)
Details *AssetDetails
// Status of the asset
Status AssetStatus
}
type isAssetDetails interface {
isAssetDetails()
adIntoProto() interface{}
DeepClone() isAssetDetails
Validate() (ProposalError, error)
String() string
}
func (a Asset) IntoProto() *proto.Asset {
var details *proto.AssetDetails
if a.Details != nil {
details = a.Details.IntoProto()
}
return &proto.Asset{
Id: a.ID,
Details: details,
Status: a.Status,
}
}
func (a Asset) DeepClone() *Asset {
cpy := a
if a.Details == nil {
return &cpy
}
cpy.Details.Quantum = a.Details.Quantum
if a.Details.Source != nil {
cpy.Details.Source = a.Details.Source.DeepClone()
}
return &cpy
}
func AssetFromProto(p *proto.Asset) (*Asset, error) {
var (
details *AssetDetails
err error
)
if p.Details != nil {
details, err = AssetDetailsFromProto(p.Details)
if err != nil {
return nil, err
}
}
return &Asset{
ID: p.Id,
Details: details,
Status: p.Status,
}, nil
}
type AssetDetails struct {
Name string
Symbol string
Decimals uint64
Quantum num.Decimal
// *AssetDetailsBuiltinAsset
// *AssetDetailsErc20
Source isAssetDetails
}
func (a AssetDetails) String() string {
return fmt.Sprintf(
"name(%s) symbol(%s) quantum(%s) decimals(%d) source(%s)",
a.Name,
a.Symbol,
a.Quantum.String(),
a.Decimals,
stringer.ObjToString(a.Source),
)
}
func (a AssetDetails) Validate() (ProposalError, error) {
if len(a.Name) == 0 {
return ProposalErrorInvalidAssetDetails, ErrInvalidAssetNameEmpty
}
if len(a.Symbol) == 0 {
return ProposalErrorInvalidAssetDetails, ErrInvalidAssetSymbolEmpty
}
if a.Quantum.IsZero() {
return ProposalErrorInvalidAssetDetails, ErrInvalidAssetQuantumZero
}
return ProposalErrorUnspecified, nil
}
func (a AssetDetails) IntoProto() *proto.AssetDetails {
r := &proto.AssetDetails{
Name: a.Name,
Symbol: a.Symbol,
Decimals: a.Decimals,
Quantum: a.Quantum.String(),
}
if a.Source == nil {
return r
}
src := a.Source.adIntoProto()
switch s := src.(type) {
case *proto.AssetDetails_Erc20:
r.Source = s
case *proto.AssetDetails_BuiltinAsset:
r.Source = s
}
return r
}
func (a AssetDetails) GetERC20() *ERC20 {
switch s := a.Source.(type) {
case *AssetDetailsErc20:
return s.ERC20
default:
return nil
}
}
func (a AssetDetails) DeepClone() *AssetDetails {
var src isAssetDetails
if a.Source != nil {
src = a.Source.DeepClone()
}
cpy := &AssetDetails{
Name: a.Name,
Symbol: a.Symbol,
Decimals: a.Decimals,
Source: src,
}
cpy.Quantum = a.Quantum
return cpy
}
func AssetDetailsFromProto(p *proto.AssetDetails) (*AssetDetails, error) {
var (
src isAssetDetails
err error
)
switch st := p.Source.(type) {
case *proto.AssetDetails_Erc20:
src, err = AssetDetailsERC20FromProto(st)
if err != nil {
return nil, err
}
case *proto.AssetDetails_BuiltinAsset:
src = AssetDetailsBuiltinFromProto(st)
}
min := num.DecimalZero()
if len(p.Quantum) > 0 {
var err error
min, err = num.DecimalFromString(p.Quantum)
if err != nil {
return nil, fmt.Errorf("invalid quantum: %w", err)
}
}
return &AssetDetails{
Name: p.Name,
Symbol: p.Symbol,
Decimals: p.Decimals,
Quantum: min,
Source: src,
}, nil
}
type AssetDetailsBuiltinAsset struct {
BuiltinAsset *BuiltinAsset
}
func (a AssetDetailsBuiltinAsset) String() string {
return fmt.Sprintf(
"builtinAsset(%s)",
stringer.PtrToString(a.BuiltinAsset),
)
}
func (a AssetDetailsBuiltinAsset) IntoProto() *proto.AssetDetails_BuiltinAsset {
p := &proto.AssetDetails_BuiltinAsset{
BuiltinAsset: &proto.BuiltinAsset{},
}
if a.BuiltinAsset != nil && a.BuiltinAsset.MaxFaucetAmountMint != nil {
p.BuiltinAsset.MaxFaucetAmountMint = a.BuiltinAsset.MaxFaucetAmountMint.String()
}
return p
}
func (a AssetDetailsBuiltinAsset) adIntoProto() interface{} {
return a.IntoProto()
}
func (AssetDetailsBuiltinAsset) isAssetDetails() {}
func (a AssetDetailsBuiltinAsset) DeepClone() isAssetDetails {
cpy := a
if a.BuiltinAsset == nil {
return &cpy
}
if a.BuiltinAsset.MaxFaucetAmountMint != nil {
cpy.BuiltinAsset.MaxFaucetAmountMint = a.BuiltinAsset.MaxFaucetAmountMint.Clone()
}
return &cpy
}
func (a AssetDetailsBuiltinAsset) Validate() (ProposalError, error) {
if a.BuiltinAsset.MaxFaucetAmountMint.IsZero() {
return ProposalErrorMissingBuiltinAssetField, ErrMissingBuiltinAssetField
}
return ProposalErrorUnspecified, nil
}
func AssetDetailsBuiltinFromProto(p *proto.AssetDetails_BuiltinAsset) *AssetDetailsBuiltinAsset {
if p.BuiltinAsset.MaxFaucetAmountMint != "" {
max, _ := num.UintFromString(p.BuiltinAsset.MaxFaucetAmountMint, 10)
return &AssetDetailsBuiltinAsset{
BuiltinAsset: &BuiltinAsset{
MaxFaucetAmountMint: max,
},
}
}
return &AssetDetailsBuiltinAsset{}
}
// BuiltinAsset is a Vega internal asset.
type BuiltinAsset struct {
MaxFaucetAmountMint *num.Uint
}
func (a BuiltinAsset) String() string {
return fmt.Sprintf(
"maxFaucetAmountMint(%s)",
stringer.PtrToString(a.MaxFaucetAmountMint),
)
}
type AssetDetailsErc20 struct {
ERC20 *ERC20
}
func (a AssetDetailsErc20) String() string {
return fmt.Sprintf(
"erc20(%s)",
stringer.PtrToString(a.ERC20),
)
}
func (a AssetDetailsErc20) IntoProto() *proto.AssetDetails_Erc20 {
lifetimeLimit := "0"
if a.ERC20.LifetimeLimit != nil {
lifetimeLimit = a.ERC20.LifetimeLimit.String()
}
withdrawThreshold := "0"
if a.ERC20.WithdrawThreshold != nil {
withdrawThreshold = a.ERC20.WithdrawThreshold.String()
}
return &proto.AssetDetails_Erc20{
Erc20: &proto.ERC20{
ContractAddress: a.ERC20.ContractAddress,
LifetimeLimit: lifetimeLimit,
WithdrawThreshold: withdrawThreshold,
},
}
}
func (a AssetDetailsErc20) adIntoProto() interface{} {
return a.IntoProto()
}
func (AssetDetailsErc20) isAssetDetails() {}
func (a AssetDetailsErc20) DeepClone() isAssetDetails {
if a.ERC20 == nil {
return &AssetDetailsErc20{}
}
return &AssetDetailsErc20{
ERC20: a.ERC20.DeepClone(),
}
}
func (a AssetDetailsErc20) Validate() (ProposalError, error) {
if len(a.ERC20.ContractAddress) <= 0 {
return ProposalErrorMissingErc20ContractAddress, ErrMissingERC20ContractAddress
}
// if a.ERC20.LifetimeLimit.EQ(num.Zero()) {
// return ProposalErrorInvalidAsset, ErrLifetimeLimitMustBePositive
// }
// if a.ERC20.WithdrawThreshold.EQ(num.Zero()) {
// return ProposalErrorInvalidAsset, ErrWithdrawThresholdMustBePositive
// }
return ProposalErrorUnspecified, nil
}
func AssetDetailsERC20FromProto(p *proto.AssetDetails_Erc20) (*AssetDetailsErc20, error) {
var (
lifetimeLimit = num.UintZero()
withdrawThreshold = num.UintZero()
overflow bool
)
if len(p.Erc20.LifetimeLimit) > 0 {
lifetimeLimit, overflow = num.UintFromString(p.Erc20.LifetimeLimit, 10)
if overflow {
return nil, errors.New("invalid lifetime limit")
}
}
if len(p.Erc20.WithdrawThreshold) > 0 {
withdrawThreshold, overflow = num.UintFromString(p.Erc20.WithdrawThreshold, 10)
if overflow {
return nil, errors.New("invalid withdraw threshold")
}
}
return &AssetDetailsErc20{
ERC20: &ERC20{
ContractAddress: crypto.EthereumChecksumAddress(p.Erc20.ContractAddress),
LifetimeLimit: lifetimeLimit,
WithdrawThreshold: withdrawThreshold,
},
}, nil
}
// An ERC20 token based asset, living on the ethereum network.
type ERC20 struct {
ContractAddress string
LifetimeLimit *num.Uint
WithdrawThreshold *num.Uint
}
func (e ERC20) DeepClone() *ERC20 {
cpy := &ERC20{
ContractAddress: e.ContractAddress,
}
if e.LifetimeLimit != nil {
cpy.LifetimeLimit = e.LifetimeLimit.Clone()
} else {
cpy.LifetimeLimit = num.UintZero()
}
if e.WithdrawThreshold != nil {
cpy.WithdrawThreshold = e.WithdrawThreshold.Clone()
} else {
cpy.WithdrawThreshold = num.UintZero()
}
return cpy
}
func (e ERC20) String() string {
return fmt.Sprintf(
"contractAddress(%s) lifetimeLimit(%s) withdrawThreshold(%s)",
e.ContractAddress,
stringer.PtrToString(e.LifetimeLimit),
stringer.PtrToString(e.WithdrawThreshold),
)
}