-
Notifications
You must be signed in to change notification settings - Fork 6
/
format.ts
302 lines (254 loc) · 9.83 KB
/
format.ts
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
// Number formatting in our app should follow the guide in this doc:
// https://www.notion.so/uniswaplabs/Number-standards-fbb9f533f10e4e22820722c2f66d23c0
const FIVE_DECIMALS_MAX_TWO_DECIMALS_MIN = new Intl.NumberFormat('en-US', {
notation: 'standard',
maximumFractionDigits: 5,
minimumFractionDigits: 2,
})
const FIVE_DECIMALS_MAX_TWO_DECIMALS_MIN_NO_COMMAS = new Intl.NumberFormat('en-US', {
notation: 'standard',
maximumFractionDigits: 5,
minimumFractionDigits: 2,
useGrouping: false,
})
const NO_DECIMALS = new Intl.NumberFormat('en-US', {
notation: 'standard',
maximumFractionDigits: 0,
minimumFractionDigits: 0,
})
const THREE_DECIMALS = new Intl.NumberFormat('en-US', {
notation: 'standard',
maximumFractionDigits: 3,
minimumFractionDigits: 3,
})
const THREE_DECIMALS_USD = new Intl.NumberFormat('en-US', {
notation: 'standard',
maximumFractionDigits: 3,
minimumFractionDigits: 3,
currency: 'USD',
style: 'currency',
})
const TWO_DECIMALS = new Intl.NumberFormat('en-US', {
notation: 'standard',
maximumFractionDigits: 2,
minimumFractionDigits: 2,
})
const TWO_DECIMALS_USD = new Intl.NumberFormat('en-US', {
notation: 'standard',
maximumFractionDigits: 2,
minimumFractionDigits: 2,
currency: 'USD',
style: 'currency',
})
const SHORTHAND_ONE_DECIMAL = new Intl.NumberFormat('en-US', {
notation: 'compact',
minimumFractionDigits: 1,
maximumFractionDigits: 1,
})
const SHORTHAND_TWO_DECIMALS = new Intl.NumberFormat('en-US', {
notation: 'compact',
minimumFractionDigits: 2,
maximumFractionDigits: 2,
})
const SHORTHAND_USD_TWO_DECIMALS = new Intl.NumberFormat('en-US', {
notation: 'compact',
minimumFractionDigits: 2,
maximumFractionDigits: 2,
currency: 'USD',
style: 'currency',
})
const SHORTHAND_USD_ONE_DECIMAL = new Intl.NumberFormat('en-US', {
notation: 'compact',
minimumFractionDigits: 1,
maximumFractionDigits: 1,
currency: 'USD',
style: 'currency',
})
const SIX_SIG_FIGS_TWO_DECIMALS = new Intl.NumberFormat('en-US', {
notation: 'standard',
maximumSignificantDigits: 6,
minimumSignificantDigits: 3,
maximumFractionDigits: 2,
minimumFractionDigits: 2,
})
const SIX_SIG_FIGS_NO_COMMAS = new Intl.NumberFormat('en-US', {
notation: 'standard',
maximumSignificantDigits: 6,
useGrouping: false,
})
const SIX_SIG_FIGS_TWO_DECIMALS_NO_COMMAS = new Intl.NumberFormat('en-US', {
notation: 'standard',
maximumSignificantDigits: 6,
minimumSignificantDigits: 3,
maximumFractionDigits: 2,
minimumFractionDigits: 2,
useGrouping: false,
})
const THREE_SIG_FIGS_USD = new Intl.NumberFormat('en-US', {
notation: 'standard',
minimumSignificantDigits: 3,
maximumSignificantDigits: 3,
currency: 'USD',
style: 'currency',
})
type Format = Intl.NumberFormat | string
// each rule must contain either an `upperBound` or an `exact` value.
// upperBound => number will use that formatter as long as it is < upperBound
// exact => number will use that formatter if it is === exact
type FormatterRule =
| { upperBound?: undefined; exact: number; formatter: Format }
| { upperBound: number; exact?: undefined; formatter: Format }
// these formatter objects dictate which formatter rule to use based on the interval that
// the number falls into. for example, based on the rule set below, if your number
// falls between 1 and 1e6, you'd use TWO_DECIMALS as the formatter.
const tokenNonTxFormatter: FormatterRule[] = [
{ exact: 0, formatter: '0' },
{ upperBound: 0.001, formatter: '<0.001' },
{ upperBound: 1, formatter: THREE_DECIMALS },
{ upperBound: 1e6, formatter: TWO_DECIMALS },
{ upperBound: 1e15, formatter: SHORTHAND_TWO_DECIMALS },
{ upperBound: Infinity, formatter: '>999T' },
]
const tokenTxFormatter: FormatterRule[] = [
{ exact: 0, formatter: '0' },
{ upperBound: 0.00001, formatter: '<0.00001' },
{ upperBound: 1, formatter: FIVE_DECIMALS_MAX_TWO_DECIMALS_MIN },
{ upperBound: 10000, formatter: SIX_SIG_FIGS_TWO_DECIMALS },
{ upperBound: Infinity, formatter: TWO_DECIMALS },
]
const swapTradeAmountFormatter: FormatterRule[] = [
{ exact: 0, formatter: '0' },
{ upperBound: 0.1, formatter: SIX_SIG_FIGS_NO_COMMAS },
{ upperBound: 1, formatter: FIVE_DECIMALS_MAX_TWO_DECIMALS_MIN_NO_COMMAS },
{ upperBound: Infinity, formatter: SIX_SIG_FIGS_TWO_DECIMALS_NO_COMMAS },
]
const fiatTokenDetailsFormatter: FormatterRule[] = [
{ upperBound: 0.00000001, formatter: '<$0.00000001' },
{ upperBound: 0.1, formatter: THREE_SIG_FIGS_USD },
{ upperBound: 1.05, formatter: THREE_DECIMALS_USD },
{ upperBound: 1e6, formatter: TWO_DECIMALS_USD },
{ upperBound: Infinity, formatter: SHORTHAND_USD_TWO_DECIMALS },
]
const fiatTokenPricesFormatter: FormatterRule[] = [
{ upperBound: 0.00000001, formatter: '<$0.00000001' },
{ upperBound: 1, formatter: THREE_SIG_FIGS_USD },
{ upperBound: 1e6, formatter: TWO_DECIMALS_USD },
{ upperBound: Infinity, formatter: SHORTHAND_USD_TWO_DECIMALS },
]
const fiatTokenStatsFormatter: FormatterRule[] = [
// if token stat value is 0, we probably don't have the data for it, so show '-' as a placeholder
{ exact: 0, formatter: '-' },
{ upperBound: 0.01, formatter: '<$0.01' },
{ upperBound: 1000, formatter: TWO_DECIMALS_USD },
{ upperBound: Infinity, formatter: SHORTHAND_USD_ONE_DECIMAL },
]
const fiatGasPriceFormatter: FormatterRule[] = [
{ upperBound: 0.01, formatter: '<$0.01' },
{ upperBound: 1e6, formatter: TWO_DECIMALS_USD },
{ upperBound: Infinity, formatter: SHORTHAND_USD_TWO_DECIMALS },
]
const fiatTokenQuantityFormatter = [{ exact: 0, formatter: '$0.00' }, ...fiatGasPriceFormatter]
const portfolioBalanceFormatter: FormatterRule[] = [
{ exact: 0, formatter: '$0.00' },
{ upperBound: Infinity, formatter: TWO_DECIMALS_USD },
]
const ntfTokenFloorPriceFormatter: FormatterRule[] = [
{ exact: 0, formatter: '0' },
{ upperBound: 0.001, formatter: '<0.001' },
{ upperBound: 1, formatter: THREE_DECIMALS },
{ upperBound: 1000, formatter: TWO_DECIMALS },
{ upperBound: 1e15, formatter: SHORTHAND_TWO_DECIMALS },
{ upperBound: Infinity, formatter: '>999T' },
]
const ntfCollectionStatsFormatter: FormatterRule[] = [
{ upperBound: 1000, formatter: NO_DECIMALS },
{ upperBound: Infinity, formatter: SHORTHAND_ONE_DECIMAL },
]
export enum NumberType {
// used for token quantities in non-transaction contexts (e.g. portfolio balances)
TokenNonTx = 'token-non-tx',
// used for token quantities in transaction contexts (e.g. swap, send)
TokenTx = 'token-tx',
// this formatter is only used for displaying the swap trade output amount
// in the text input boxes. Output amounts on review screen should use the above TokenTx formatter
SwapTradeAmount = 'swap-trade-amount',
// fiat prices in any component that belongs in the Token Details flow (except for token stats)
FiatTokenDetails = 'fiat-token-details',
// fiat prices everywhere except Token Details flow
FiatTokenPrice = 'fiat-token-price',
// fiat values for market cap, TVL, volume in the Token Details screen
FiatTokenStats = 'fiat-token-stats',
// fiat price of token balances
FiatTokenQuantity = 'fiat-token-quantity',
// fiat gas prices
FiatGasPrice = 'fiat-gas-price',
// portfolio balance
PortfolioBalance = 'portfolio-balance',
// nft floor price denominated in a token (e.g, ETH)
NFTTokenFloorPrice = 'nft-token-floor-price',
// nft collection stats like number of items, holder, and sales
NFTCollectionStats = 'nft-collection-stats',
}
const TYPE_TO_FORMATTER_RULES = {
[NumberType.TokenNonTx]: tokenNonTxFormatter,
[NumberType.TokenTx]: tokenTxFormatter,
[NumberType.SwapTradeAmount]: swapTradeAmountFormatter,
[NumberType.FiatTokenQuantity]: fiatTokenQuantityFormatter,
[NumberType.FiatTokenDetails]: fiatTokenDetailsFormatter,
[NumberType.FiatTokenPrice]: fiatTokenPricesFormatter,
[NumberType.FiatTokenStats]: fiatTokenStatsFormatter,
[NumberType.FiatGasPrice]: fiatGasPriceFormatter,
[NumberType.PortfolioBalance]: portfolioBalanceFormatter,
[NumberType.NFTTokenFloorPrice]: ntfTokenFloorPriceFormatter,
[NumberType.NFTCollectionStats]: ntfCollectionStatsFormatter,
}
function getFormatterRule(input: number, type: NumberType): Format {
const rules = TYPE_TO_FORMATTER_RULES[type]
for (const rule of rules) {
if (
(rule.exact !== undefined && input === rule.exact) ||
(rule.upperBound !== undefined && input < rule.upperBound)
) {
return rule.formatter
}
}
throw new Error(`formatter for type ${type} not configured correctly`)
}
export function formatNumber(
input?: number | null,
type: NumberType = NumberType.TokenNonTx,
placeholder = '-'
): string {
if (input === null || input === undefined) {
return placeholder
}
const formatter = getFormatterRule(input, type)
if (typeof formatter === 'string') return formatter
return formatter.format(input)
}
/**
* Very simple date formatter
* Feel free to add more options / adapt to your needs.
*/
export function formatDate(date: Date): string {
return date.toLocaleString('en-US', {
day: 'numeric', // numeric, 2-digit
year: 'numeric', // numeric, 2-digit
month: 'short', // numeric, 2-digit, long, short, narrow
hour: 'numeric', // numeric, 2-digit
minute: 'numeric', // numeric, 2-digit
})
}
export function formatNumberOrString(price: number | null | undefined, type: NumberType): string {
if (price === null || price === undefined) return '-'
if (typeof price === 'string') return formatNumber(parseFloat(price), type)
return formatNumber(price, type)
}
export function formatUSDPrice(price: number | undefined | null, type: NumberType = NumberType.FiatTokenPrice): string {
return formatNumberOrString(price, type)
}
/** Formats USD and non-USD prices */
export function formatFiatPrice(price: number | undefined | null, currency = 'USD'): string {
if (price === null || price === undefined) return '-'
return new Intl.NumberFormat('en-US', { style: 'currency', currency }).format(price)
}