forked from OpenBazaar/openbazaar-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
currency_definition.go
442 lines (415 loc) · 24.7 KB
/
currency_definition.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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
package repo
import (
"errors"
"fmt"
"strings"
"time"
)
func init() {
if err := bootstrapCurrencyDictionaries(); err != nil {
panic(err)
}
}
type (
// CurrencyCode is a string-based currency symbol
CurrencyCode string
// CurrencyDefinition defines the characteristics of a currency
CurrencyDefinition struct {
// Name describes the colloquial term for the currency
Name string `json:"name,omitempty"`
// Code describes the currency as an uppercase string similar to ISO 4217
Code CurrencyCode `json:"code"`
// Divisibility indicates the number of decimal places the currency can be divided in
// base10. Ex: 8 suggests a maximum divisibility of 0.00000001
Divisibility uint `json:"divisibility"`
// CurrencyType indicates whether the currency is "fiat" or "crypto" currency
CurrencyType string `json:"currencyType,omitempty"`
// BlockTime is the general/approximate duration for a block to be mined
BlockTime time.Duration `json:"-"`
}
// CurrencyDictionaryProcessingError represents a list of errors after
// processing a CurrencyDictionary
CurrencyDictionaryProcessingError map[string]error
// CurrencyDictionary represents a collection of CurrencyDefinitions keyed
// by their CurrencyCode in string form
CurrencyDictionary struct {
definitions map[string]CurrencyDefinition
}
)
const (
Fiat = "fiat"
Crypto = "crypto"
DefaultCryptoDivisibility = 8
NilCurrencyCode = CurrencyCode("")
DefaultBlockTime = 10 * time.Minute
)
var (
ErrCurrencyCodeLengthInvalid = errors.New("invalid length for currency code, must be three characters or four characters and begin with a 'T'")
ErrCurrencyCodeTestSymbolInvalid = errors.New("invalid test indicator for currency code, four characters must begin with a 'T'")
ErrCurrencyDefinitionUndefined = errors.New("unknown currency")
ErrCurrencyTypeInvalid = errors.New("currency type must be crypto or fiat")
ErrCurrencyDivisibilityNonPositive = errors.New("currency divisibility most be greater than zero")
ErrDictionaryIndexMismatchedCode = errors.New("dictionary index mismatched with definition currency code")
ErrDictionaryCurrencyCodeCollision = errors.New("currency code is used by more than one currency")
NilCurrencyDefinition = CurrencyDefinition{Name: "", Code: NilCurrencyCode, Divisibility: 0, CurrencyType: "", BlockTime: 0 * time.Second}
// holds validated dictionary singleton after initial load
validatedMainnetCurrencies *CurrencyDictionary
validatedTestnetCurrencies *CurrencyDictionary
validatedFiatCurrencies *CurrencyDictionary
validatedAllCurrencies *CurrencyDictionary
mainnetCryptoDefinitions = map[string]CurrencyDefinition{
"BTC": {Name: "Bitcoin", Code: CurrencyCode("BTC"), CurrencyType: Crypto, Divisibility: 8, BlockTime: DefaultBlockTime},
"BCH": {Name: "Bitcoin Cash", Code: CurrencyCode("BCH"), CurrencyType: Crypto, Divisibility: 8, BlockTime: DefaultBlockTime},
"LTC": {Name: "Litecoin", Code: CurrencyCode("LTC"), CurrencyType: Crypto, Divisibility: 8, BlockTime: 150 * time.Second},
"ZEC": {Name: "Zcash", Code: CurrencyCode("ZEC"), CurrencyType: Crypto, Divisibility: 8, BlockTime: DefaultBlockTime},
"ETH": {Name: "Ethereum", Code: CurrencyCode("ETH"), CurrencyType: Crypto, Divisibility: 18, BlockTime: 10 * time.Second},
}
testnetCryptoDefinitions = map[string]CurrencyDefinition{
"TBTC": {Name: "Testnet Bitcoin", Code: CurrencyCode("TBTC"), CurrencyType: Crypto, Divisibility: 8, BlockTime: DefaultBlockTime},
"TBCH": {Name: "Testnet Bitcoin Cash", Code: CurrencyCode("TBCH"), CurrencyType: Crypto, Divisibility: 8, BlockTime: DefaultBlockTime},
"TLTC": {Name: "Testnet Litecoin", Code: CurrencyCode("TLTC"), CurrencyType: Crypto, Divisibility: 8, BlockTime: 150 * time.Second},
"TZEC": {Name: "Testnet Zcash", Code: CurrencyCode("TZEC"), CurrencyType: Crypto, Divisibility: 8, BlockTime: DefaultBlockTime},
"TETH": {Name: "Testnet Ethereum", Code: CurrencyCode("TETH"), CurrencyType: Crypto, Divisibility: 18, BlockTime: 10 * time.Second},
}
fiatDefinitions = map[string]CurrencyDefinition{
"AED": {Name: "UAE Dirham", Code: CurrencyCode("AED"), CurrencyType: Fiat, Divisibility: 2},
"AFN": {Name: "Afghani", Code: CurrencyCode("AFN"), CurrencyType: Fiat, Divisibility: 2},
"ALL": {Name: "Lek", Code: CurrencyCode("ALL"), CurrencyType: Fiat, Divisibility: 2},
"AMD": {Name: "Armenian Dram", Code: CurrencyCode("AMD"), CurrencyType: Fiat, Divisibility: 2},
"ANG": {Name: "Netherlands Antillean Guilder", Code: CurrencyCode("ANG"), CurrencyType: Fiat, Divisibility: 2},
"AOA": {Name: "Kwanza", Code: CurrencyCode("AOA"), CurrencyType: Fiat, Divisibility: 2},
"ARS": {Name: "Argentine Peso", Code: CurrencyCode("ARS"), CurrencyType: Fiat, Divisibility: 2},
"AUD": {Name: "Australian Dollar", Code: CurrencyCode("AUD"), CurrencyType: Fiat, Divisibility: 2},
"AWG": {Name: "Aruban Florin", Code: CurrencyCode("AWG"), CurrencyType: Fiat, Divisibility: 2},
"AZN": {Name: "Azerbaijanian Manat", Code: CurrencyCode("AZN"), CurrencyType: Fiat, Divisibility: 2},
"BAM": {Name: "Convertible Mark", Code: CurrencyCode("BAM"), CurrencyType: Fiat, Divisibility: 2},
"BBD": {Name: "Barbados Dollar", Code: CurrencyCode("BBD"), CurrencyType: Fiat, Divisibility: 2},
"BDT": {Name: "Taka", Code: CurrencyCode("BDT"), CurrencyType: Fiat, Divisibility: 2},
"BGN": {Name: "Bulgarian Lev", Code: CurrencyCode("BGN"), CurrencyType: Fiat, Divisibility: 2},
"BHD": {Name: "Bahraini Dinar", Code: CurrencyCode("BHD"), CurrencyType: Fiat, Divisibility: 2},
"BIF": {Name: "Burundi Franc", Code: CurrencyCode("BIF"), CurrencyType: Fiat, Divisibility: 2},
"BMD": {Name: "Bermudian Dollar", Code: CurrencyCode("BMD"), CurrencyType: Fiat, Divisibility: 2},
"BND": {Name: "Brunei Dollar", Code: CurrencyCode("BND"), CurrencyType: Fiat, Divisibility: 2},
"BOB": {Name: "Boliviano", Code: CurrencyCode("BOB"), CurrencyType: Fiat, Divisibility: 2},
"BRL": {Name: "Brazilian Real", Code: CurrencyCode("BRL"), CurrencyType: Fiat, Divisibility: 2},
"BSD": {Name: "Bahamian Dollar", Code: CurrencyCode("BSD"), CurrencyType: Fiat, Divisibility: 2},
"BTN": {Name: "Ngultrum", Code: CurrencyCode("BTN"), CurrencyType: Fiat, Divisibility: 2},
"BWP": {Name: "Pula", Code: CurrencyCode("BWP"), CurrencyType: Fiat, Divisibility: 2},
"BYR": {Name: "Belarussian Ruble", Code: CurrencyCode("BYR"), CurrencyType: Fiat, Divisibility: 2},
"BZD": {Name: "Belize Dollar", Code: CurrencyCode("BZD"), CurrencyType: Fiat, Divisibility: 2},
"CAD": {Name: "Canadian Dollar", Code: CurrencyCode("CAD"), CurrencyType: Fiat, Divisibility: 2},
"CDF": {Name: "Congolese Franc", Code: CurrencyCode("CDF"), CurrencyType: Fiat, Divisibility: 2},
"CHF": {Name: "Swiss Franc", Code: CurrencyCode("CHF"), CurrencyType: Fiat, Divisibility: 2},
"CLP": {Name: "Chilean Peso", Code: CurrencyCode("CLP"), CurrencyType: Fiat, Divisibility: 2},
"CNY": {Name: "Yuan Renminbi", Code: CurrencyCode("CNY"), CurrencyType: Fiat, Divisibility: 2},
"COP": {Name: "Colombian Peso", Code: CurrencyCode("COP"), CurrencyType: Fiat, Divisibility: 2},
"CRC": {Name: "Costa Rican Colon", Code: CurrencyCode("CRC"), CurrencyType: Fiat, Divisibility: 2},
"CUP": {Name: "Cuban Peso", Code: CurrencyCode("CUP"), CurrencyType: Fiat, Divisibility: 2},
"CVE": {Name: "Cabo Verde Escudo", Code: CurrencyCode("CVE"), CurrencyType: Fiat, Divisibility: 2},
"CZK": {Name: "Czech Koruna", Code: CurrencyCode("CZK"), CurrencyType: Fiat, Divisibility: 2},
"DJF": {Name: "Djibouti Franc", Code: CurrencyCode("DJF"), CurrencyType: Fiat, Divisibility: 2},
"DKK": {Name: "Danish Krone", Code: CurrencyCode("DKK"), CurrencyType: Fiat, Divisibility: 2},
"DOP": {Name: "Dominican Peso", Code: CurrencyCode("DOP"), CurrencyType: Fiat, Divisibility: 2},
"DZD": {Name: "Algerian Dinar", Code: CurrencyCode("DZD"), CurrencyType: Fiat, Divisibility: 2},
"EGP": {Name: "Egyptian Pound", Code: CurrencyCode("EGP"), CurrencyType: Fiat, Divisibility: 2},
"ERN": {Name: "Nakfa", Code: CurrencyCode("ERN"), CurrencyType: Fiat, Divisibility: 2},
"ETB": {Name: "Ethiopian Birr", Code: CurrencyCode("ETB"), CurrencyType: Fiat, Divisibility: 2},
"EUR": {Name: "Euro", Code: CurrencyCode("EUR"), CurrencyType: Fiat, Divisibility: 2},
"FJD": {Name: "Fiji Dollar", Code: CurrencyCode("FJD"), CurrencyType: Fiat, Divisibility: 2},
"FKP": {Name: "Falkland Islands Pound", Code: CurrencyCode("FKP"), CurrencyType: Fiat, Divisibility: 2},
"GBP": {Name: "Pound Sterling", Code: CurrencyCode("GBP"), CurrencyType: Fiat, Divisibility: 2},
"GEL": {Name: "Lari", Code: CurrencyCode("GEL"), CurrencyType: Fiat, Divisibility: 2},
"GHS": {Name: "Ghana Cedi", Code: CurrencyCode("GHS"), CurrencyType: Fiat, Divisibility: 2},
"GIP": {Name: "Gibraltar Pound", Code: CurrencyCode("GIP"), CurrencyType: Fiat, Divisibility: 2},
"GMD": {Name: "Dalasi", Code: CurrencyCode("GMD"), CurrencyType: Fiat, Divisibility: 2},
"GNF": {Name: "Guinea Franc", Code: CurrencyCode("GNF"), CurrencyType: Fiat, Divisibility: 2},
"GTQ": {Name: "Quetzal", Code: CurrencyCode("GTQ"), CurrencyType: Fiat, Divisibility: 2},
"GYD": {Name: "Guyana Dollar", Code: CurrencyCode("GYD"), CurrencyType: Fiat, Divisibility: 2},
"HKD": {Name: "Hong Kong Dollar", Code: CurrencyCode("HKD"), CurrencyType: Fiat, Divisibility: 2},
"HNL": {Name: "Lempira", Code: CurrencyCode("HNL"), CurrencyType: Fiat, Divisibility: 2},
"HRK": {Name: "Kuna", Code: CurrencyCode("HRK"), CurrencyType: Fiat, Divisibility: 2},
"HTG": {Name: "Gourde", Code: CurrencyCode("HTG"), CurrencyType: Fiat, Divisibility: 2},
"HUF": {Name: "Forint", Code: CurrencyCode("HUF"), CurrencyType: Fiat, Divisibility: 2},
"IDR": {Name: "Rupiah", Code: CurrencyCode("IDR"), CurrencyType: Fiat, Divisibility: 2},
"ILS": {Name: "New Israeli Sheqel", Code: CurrencyCode("ILS"), CurrencyType: Fiat, Divisibility: 2},
"INR": {Name: "Indian Rupee", Code: CurrencyCode("INR"), CurrencyType: Fiat, Divisibility: 2},
"IQD": {Name: "Iraqi Dinar", Code: CurrencyCode("IQD"), CurrencyType: Fiat, Divisibility: 2},
"IRR": {Name: "Iranian Rial", Code: CurrencyCode("IRR"), CurrencyType: Fiat, Divisibility: 2},
"ISK": {Name: "Iceland Krona", Code: CurrencyCode("ISK"), CurrencyType: Fiat, Divisibility: 2},
"JMD": {Name: "Jamaican Dollar", Code: CurrencyCode("JMD"), CurrencyType: Fiat, Divisibility: 2},
"JOD": {Name: "Jordanian Dinar", Code: CurrencyCode("JOD"), CurrencyType: Fiat, Divisibility: 2},
"JPY": {Name: "Yen", Code: CurrencyCode("JPY"), CurrencyType: Fiat, Divisibility: 2},
"KES": {Name: "Kenyan Shilling", Code: CurrencyCode("KES"), CurrencyType: Fiat, Divisibility: 2},
"KGS": {Name: "Som", Code: CurrencyCode("KGS"), CurrencyType: Fiat, Divisibility: 2},
"KHR": {Name: "Riel", Code: CurrencyCode("KHR"), CurrencyType: Fiat, Divisibility: 2},
"KMF": {Name: "Comoro Franc", Code: CurrencyCode("KMF"), CurrencyType: Fiat, Divisibility: 2},
"KPW": {Name: "North Korean Won", Code: CurrencyCode("KPW"), CurrencyType: Fiat, Divisibility: 2},
"KRW": {Name: "Won", Code: CurrencyCode("KRW"), CurrencyType: Fiat, Divisibility: 2},
"KWD": {Name: "Kuwaiti Dinar", Code: CurrencyCode("KWD"), CurrencyType: Fiat, Divisibility: 2},
"KYD": {Name: "Cayman Islands Dollar", Code: CurrencyCode("KYD"), CurrencyType: Fiat, Divisibility: 2},
"KZT": {Name: "Tenge", Code: CurrencyCode("KZT"), CurrencyType: Fiat, Divisibility: 2},
"LAK": {Name: "Kip", Code: CurrencyCode("LAK"), CurrencyType: Fiat, Divisibility: 2},
"LBP": {Name: "Lebanese Pound", Code: CurrencyCode("LBP"), CurrencyType: Fiat, Divisibility: 2},
"LKR": {Name: "Sri Lanka Rupee", Code: CurrencyCode("LKR"), CurrencyType: Fiat, Divisibility: 2},
"LRD": {Name: "Liberian Dollar", Code: CurrencyCode("LRD"), CurrencyType: Fiat, Divisibility: 2},
"LSL": {Name: "Loti", Code: CurrencyCode("LSL"), CurrencyType: Fiat, Divisibility: 2},
"LYD": {Name: "Libyan Dinar", Code: CurrencyCode("LYD"), CurrencyType: Fiat, Divisibility: 2},
"MAD": {Name: "Moroccan Dirham", Code: CurrencyCode("MAD"), CurrencyType: Fiat, Divisibility: 2},
"MDL": {Name: "Moldovan Leu", Code: CurrencyCode("MDL"), CurrencyType: Fiat, Divisibility: 2},
"MGA": {Name: "Malagasy Ariary", Code: CurrencyCode("MGA"), CurrencyType: Fiat, Divisibility: 2},
"MKD": {Name: "Denar", Code: CurrencyCode("MKD"), CurrencyType: Fiat, Divisibility: 2},
"MMK": {Name: "Kyat", Code: CurrencyCode("MMK"), CurrencyType: Fiat, Divisibility: 2},
"MNT": {Name: "Tugrik", Code: CurrencyCode("MNT"), CurrencyType: Fiat, Divisibility: 2},
"MOP": {Name: "Pataca", Code: CurrencyCode("MOP"), CurrencyType: Fiat, Divisibility: 2},
"MRO": {Name: "Ouguiya", Code: CurrencyCode("MRO"), CurrencyType: Fiat, Divisibility: 2},
"MUR": {Name: "Mauritius Rupee", Code: CurrencyCode("MUR"), CurrencyType: Fiat, Divisibility: 2},
"MVR": {Name: "Rufiyaa", Code: CurrencyCode("MVR"), CurrencyType: Fiat, Divisibility: 2},
"MWK": {Name: "Kwacha", Code: CurrencyCode("MWK"), CurrencyType: Fiat, Divisibility: 2},
"MXN": {Name: "Mexican Peso", Code: CurrencyCode("MXN"), CurrencyType: Fiat, Divisibility: 2},
"MYR": {Name: "Malaysian Ringgit", Code: CurrencyCode("MYR"), CurrencyType: Fiat, Divisibility: 2},
"MZN": {Name: "Mozambique Metical", Code: CurrencyCode("MZN"), CurrencyType: Fiat, Divisibility: 2},
"NAD": {Name: "Namibia Dollar", Code: CurrencyCode("NAD"), CurrencyType: Fiat, Divisibility: 2},
"NGN": {Name: "Naira", Code: CurrencyCode("NGN"), CurrencyType: Fiat, Divisibility: 2},
"NIO": {Name: "Cordoba Oro", Code: CurrencyCode("NIO"), CurrencyType: Fiat, Divisibility: 2},
"NOK": {Name: "Norwegian Krone", Code: CurrencyCode("NOK"), CurrencyType: Fiat, Divisibility: 2},
"NPR": {Name: "Nepalese Rupee", Code: CurrencyCode("NPR"), CurrencyType: Fiat, Divisibility: 2},
"NZD": {Name: "New Zealand Dollar", Code: CurrencyCode("NZD"), CurrencyType: Fiat, Divisibility: 2},
"OMR": {Name: "Rial Omani", Code: CurrencyCode("OMR"), CurrencyType: Fiat, Divisibility: 2},
"PAB": {Name: "Balboa", Code: CurrencyCode("PAB"), CurrencyType: Fiat, Divisibility: 2},
"PEN": {Name: "Nuevo Sol", Code: CurrencyCode("PEN"), CurrencyType: Fiat, Divisibility: 2},
"PGK": {Name: "Kina", Code: CurrencyCode("PGK"), CurrencyType: Fiat, Divisibility: 2},
"PHP": {Name: "Philippine Peso", Code: CurrencyCode("PHP"), CurrencyType: Fiat, Divisibility: 2},
"PKR": {Name: "Pakistan Rupee", Code: CurrencyCode("PKR"), CurrencyType: Fiat, Divisibility: 2},
"PLN": {Name: "Zloty", Code: CurrencyCode("PLN"), CurrencyType: Fiat, Divisibility: 2},
"PYG": {Name: "Guarani", Code: CurrencyCode("PYG"), CurrencyType: Fiat, Divisibility: 2},
"QAR": {Name: "Qatari Rial", Code: CurrencyCode("QAR"), CurrencyType: Fiat, Divisibility: 2},
"RON": {Name: "Romanian Leu", Code: CurrencyCode("RON"), CurrencyType: Fiat, Divisibility: 2},
"RSD": {Name: "Serbian Dinar", Code: CurrencyCode("RSD"), CurrencyType: Fiat, Divisibility: 2},
"RUB": {Name: "Russian Ruble", Code: CurrencyCode("RUB"), CurrencyType: Fiat, Divisibility: 2},
"RWF": {Name: "Rwanda Franc", Code: CurrencyCode("RWF"), CurrencyType: Fiat, Divisibility: 2},
"SAR": {Name: "Saudi Riyal", Code: CurrencyCode("SAR"), CurrencyType: Fiat, Divisibility: 2},
"SBD": {Name: "Solomon Islands Dollar", Code: CurrencyCode("SBD"), CurrencyType: Fiat, Divisibility: 2},
"SCR": {Name: "Seychelles Rupee", Code: CurrencyCode("SCR"), CurrencyType: Fiat, Divisibility: 2},
"SDG": {Name: "Sudanese Pound", Code: CurrencyCode("SDG"), CurrencyType: Fiat, Divisibility: 2},
"SEK": {Name: "Swedish Krona", Code: CurrencyCode("SEK"), CurrencyType: Fiat, Divisibility: 2},
"SGD": {Name: "Singapore Dollar", Code: CurrencyCode("SGD"), CurrencyType: Fiat, Divisibility: 2},
"SHP": {Name: "Saint Helena Pound", Code: CurrencyCode("SHP"), CurrencyType: Fiat, Divisibility: 2},
"SLL": {Name: "Leone", Code: CurrencyCode("SLL"), CurrencyType: Fiat, Divisibility: 2},
"SOS": {Name: "Somali Shilling", Code: CurrencyCode("SOS"), CurrencyType: Fiat, Divisibility: 2},
"SRD": {Name: "Surinam Dollar", Code: CurrencyCode("SRD"), CurrencyType: Fiat, Divisibility: 2},
"SSP": {Name: "South Sudanese Pound", Code: CurrencyCode("SSP"), CurrencyType: Fiat, Divisibility: 2},
"STD": {Name: "Dobra", Code: CurrencyCode("STD"), CurrencyType: Fiat, Divisibility: 2},
"SVC": {Name: "El Salvador Colon", Code: CurrencyCode("SVC"), CurrencyType: Fiat, Divisibility: 2},
"SYP": {Name: "Syrian Pound", Code: CurrencyCode("SYP"), CurrencyType: Fiat, Divisibility: 2},
"SZL": {Name: "Lilangeni", Code: CurrencyCode("SZL"), CurrencyType: Fiat, Divisibility: 2},
"THB": {Name: "Baht", Code: CurrencyCode("THB"), CurrencyType: Fiat, Divisibility: 2},
"TJS": {Name: "Somoni", Code: CurrencyCode("TJS"), CurrencyType: Fiat, Divisibility: 2},
"TMT": {Name: "Turkmenistan New Manat", Code: CurrencyCode("TMT"), CurrencyType: Fiat, Divisibility: 2},
"TND": {Name: "Tunisian Dinar", Code: CurrencyCode("TND"), CurrencyType: Fiat, Divisibility: 2},
"TOP": {Name: "Paanga", Code: CurrencyCode("TOP"), CurrencyType: Fiat, Divisibility: 2},
"TRY": {Name: "Turkish Lira", Code: CurrencyCode("TRY"), CurrencyType: Fiat, Divisibility: 2},
"TTD": {Name: "Trinidad and Tobago Dollar", Code: CurrencyCode("TTD"), CurrencyType: Fiat, Divisibility: 2},
"TWD": {Name: "New Taiwan Dollar", Code: CurrencyCode("TWD"), CurrencyType: Fiat, Divisibility: 2},
"TZS": {Name: "Tanzanian Shilling", Code: CurrencyCode("TZS"), CurrencyType: Fiat, Divisibility: 2},
"UAH": {Name: "Hryvnia", Code: CurrencyCode("UAH"), CurrencyType: Fiat, Divisibility: 2},
"UGX": {Name: "Uganda Shilling", Code: CurrencyCode("UGX"), CurrencyType: Fiat, Divisibility: 2},
"USD": {Name: "United States Dollar", Code: CurrencyCode("USD"), CurrencyType: Fiat, Divisibility: 2},
"UYU": {Name: "Peso Uruguayo", Code: CurrencyCode("UYU"), CurrencyType: Fiat, Divisibility: 2},
"UZS": {Name: "Uzbekistan Sum", Code: CurrencyCode("UZS"), CurrencyType: Fiat, Divisibility: 2},
"VEF": {Name: "Bolivar", Code: CurrencyCode("VEF"), CurrencyType: Fiat, Divisibility: 2},
"VND": {Name: "Dong", Code: CurrencyCode("VND"), CurrencyType: Fiat, Divisibility: 2},
"VUV": {Name: "Vatu", Code: CurrencyCode("VUV"), CurrencyType: Fiat, Divisibility: 2},
"WST": {Name: "Tala", Code: CurrencyCode("WST"), CurrencyType: Fiat, Divisibility: 2},
"XAF": {Name: "CFA Franc BEAC", Code: CurrencyCode("XAF"), CurrencyType: Fiat, Divisibility: 2},
"XCD": {Name: "East Caribbean Dollar", Code: CurrencyCode("XCD"), CurrencyType: Fiat, Divisibility: 2},
"XOF": {Name: "CFA Franc BCEAO", Code: CurrencyCode("XOF"), CurrencyType: Fiat, Divisibility: 2},
"XPF": {Name: "CFP Franc", Code: CurrencyCode("XPF"), CurrencyType: Fiat, Divisibility: 2},
"XSU": {Name: "Sucre", Code: CurrencyCode("XSU"), CurrencyType: Fiat, Divisibility: 2},
"YER": {Name: "Yemeni Rial", Code: CurrencyCode("YER"), CurrencyType: Fiat, Divisibility: 2},
"ZAR": {Name: "Rand", Code: CurrencyCode("ZAR"), CurrencyType: Fiat, Divisibility: 2},
"ZMW": {Name: "Zambian Kwacha", Code: CurrencyCode("ZMW"), CurrencyType: Fiat, Divisibility: 2},
"ZWL": {Name: "Zimbabwe Dollar", Code: CurrencyCode("ZWL"), CurrencyType: Fiat, Divisibility: 2},
}
)
// String returns a readable representation of CurrencyCode
func (c CurrencyCode) String() string {
if string(c) == "" {
return "NIL"
}
return string(c)
}
// NewUnknownCryptoDefinition returns a suitable crypto definition
// when one does not already exist in local dictionaries
func NewUnknownCryptoDefinition(code string, div uint) CurrencyDefinition {
if div == 0 {
div = DefaultCryptoDivisibility
}
return CurrencyDefinition{
Name: fmt.Sprintf("Unknown Currency (%s)", code),
Code: CurrencyCode(code),
Divisibility: div,
CurrencyType: Crypto,
}
}
// String returns a readable representation of CurrencyDefinition
func (c CurrencyDefinition) String() string {
if c == NilCurrencyDefinition {
return fmt.Sprintf("%s (%sdiv%d)", "nil", c.Code.String(), 0)
}
return fmt.Sprintf("%s (%sdiv%d)", c.Name, c.Code.String(), c.Divisibility)
}
// CurrencyCode returns the CurrencyCode of the definition
func (c CurrencyDefinition) CurrencyCode() CurrencyCode { return c.Code }
// Error satisfies the Error interface without needing the process the set of errors
func (c CurrencyDictionaryProcessingError) Error() string {
return fmt.Sprintf("dictionary contains %d invalid definitions", len(c))
}
func (c CurrencyDictionaryProcessingError) All() []string {
var errs []string
for code, err := range c {
errs = append(errs, fmt.Sprintf("%s: %s", code, err.Error()))
}
return errs
}
func bootstrapCurrencyDictionaries() error {
var err error
validatedMainnetCurrencies, err = NewCurrencyDictionary(mainnetCryptoDefinitions)
if err != nil {
return fmt.Errorf("building mainnet currency dictionary: %s", err)
}
validatedTestnetCurrencies, err = NewCurrencyDictionary(testnetCryptoDefinitions)
if err != nil {
return fmt.Errorf("building testnet currency dictionary: %s", err)
}
validatedFiatCurrencies, err = NewCurrencyDictionary(fiatDefinitions)
if err != nil {
return fmt.Errorf("building fiat currency dictionary: %s", err)
}
var allDefs = make(map[string]CurrencyDefinition)
for i, d := range fiatDefinitions {
if _, ok := allDefs[i]; ok {
return fmt.Errorf("unhandled currency code collision for (%s)", i)
}
allDefs[i] = d
}
for i, d := range testnetCryptoDefinitions {
if _, ok := allDefs[i]; ok {
return fmt.Errorf("unhandled currency code collision for (%s)", i)
}
allDefs[i] = d
}
for i, d := range mainnetCryptoDefinitions {
if _, ok := allDefs[i]; ok {
return fmt.Errorf("unhandled currency code collision for (%s)", i)
}
allDefs[i] = d
}
validatedAllCurrencies, err = NewCurrencyDictionary(allDefs)
if err != nil {
return fmt.Errorf("building all currency dictionary: %s", err)
}
return nil
}
// MainnetCurrencies returns the mainnet crypto currency definition singleton
func MainnetCurrencies() *CurrencyDictionary {
return validatedMainnetCurrencies
}
// TestnetCurrencies returns the mainnet crypto currency definition singleton
func TestnetCurrencies() *CurrencyDictionary {
return validatedTestnetCurrencies
}
// FiatCurrencies returns the mainnet crypto currency definition singleton
func FiatCurrencies() *CurrencyDictionary {
return validatedFiatCurrencies
}
// AllCurrencies returns the singleton representing all known currency definitions
func AllCurrencies() *CurrencyDictionary {
return validatedAllCurrencies
}
// NewCurrencyDictionary returns a CurrencyDictionary for managing CurrencyDefinitions
func NewCurrencyDictionary(defs map[string]CurrencyDefinition) (*CurrencyDictionary, error) {
var (
errs = make(CurrencyDictionaryProcessingError)
validDefs = make(map[string]CurrencyDefinition)
)
for code, def := range defs {
if err := def.Valid(); err != nil {
errs[code] = err
continue
}
if code != def.Code.String() {
errs[code] = ErrDictionaryIndexMismatchedCode
continue
}
validDefs[code] = def
}
if len(errs) > 0 {
return &CurrencyDictionary{}, errs
}
return &CurrencyDictionary{definitions: validDefs}, nil
}
// Valid asserts that the CurrencyDefinition is either valid or has at least one error
func (c CurrencyDefinition) Valid() error {
if c.Equal(NilCurrencyDefinition) {
return ErrCurrencyDefinitionUndefined
}
if c.Code == NilCurrencyCode {
return ErrCurrencyCodeLengthInvalid
}
if c.CurrencyType != Crypto && c.CurrencyType != Fiat {
return ErrCurrencyTypeInvalid
}
if c.Divisibility == 0 {
return ErrCurrencyDivisibilityNonPositive
}
return nil
}
// Equal indicates if the receiver and other have the same code
// and divisibility
func (c CurrencyDefinition) Equal(other CurrencyDefinition) bool {
if c.Code != other.Code {
return false
}
if c.Divisibility != other.Divisibility {
return false
}
if c.CurrencyType != other.CurrencyType {
return false
}
return true
}
// ConfirmationsPerHour will calculate the no of confirmations in 1 hr
// this is valid only for a crypto
func (c CurrencyDefinition) ConfirmationsPerHour() uint32 {
if c.CurrencyType != "crypto" {
return 1
}
if c.BlockTime.Seconds() <= 0 {
return 1
}
return uint32((1.0 * 60 * 60) / c.BlockTime.Seconds())
}
// Lookup returns the CurrencyDefinition out of the loaded dictionary. Lookup normalizes the code
// before lookup and recommends using CurrencyDefinition.CurrencyCode().String() from the
// response as a normalized code.
func (c CurrencyDictionary) Lookup(code string) (CurrencyDefinition, error) {
if len(c.definitions) == 0 {
return NilCurrencyDefinition, ErrCurrencyDefinitionUndefined
}
var (
upcase = strings.ToUpper(code)
def, ok = c.definitions[upcase]
)
if !ok {
return NilCurrencyDefinition, ErrCurrencyDefinitionUndefined
}
return def, nil
}
// AsMap returns a cloned map of all known the definitions
func (c CurrencyDictionary) AsMap() map[string]CurrencyDefinition {
var defCopy = make(map[string]CurrencyDefinition, len(c.definitions))
for i, d := range c.definitions {
defCopy[i] = d
}
return defCopy
}