/
resolutionError.ts
109 lines (104 loc) · 4.26 KB
/
resolutionError.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
import { ResolutionMethod } from '../publicTypes';
/**
* Alias for Resolution error handler function
* @internal
*/
type ResolutionErrorHandler = (error: ResolutionErrorOptions) => string;
/** Explains Resolution Error options */
type ResolutionErrorOptions = {
providerMessage?: string;
method?: ResolutionMethod;
methodName?: string;
domain?: string;
currencyTicker?: string;
recordName?: string;
};
export enum ResolutionErrorCode {
UnregisteredDomain = 'UnregisteredDomain',
UnspecifiedResolver = 'UnspecifiedResolver',
UnsupportedDomain = 'UnsupportedDomain',
UnsupportedMethod = 'UnsupportedMethod',
UnspecifiedCurrency = 'UnspecifiedCurrency',
NamingServiceDown = 'NamingServiceDown',
UnsupportedCurrency = 'UnsupportedCurrency',
IncorrectResolverInterface = 'IncorrectResolverInterface',
RecordNotFound = 'RecordNotFound',
ServiceProviderError = 'ServiceProviderError',
InvalidTwitterVerification = 'InvalidTwitterVerification',
}
/**
* @internal
* Internal Mapping object from ResolutionErrorCode to a ResolutionErrorHandler
*/
const HandlersByCode = {
[ResolutionErrorCode.UnregisteredDomain]: (params: { domain: string }) =>
`Domain ${params.domain} is not registered`,
[ResolutionErrorCode.UnspecifiedResolver]: (params: { domain: string }) =>
`Domain ${params.domain} is not configured`,
[ResolutionErrorCode.UnsupportedDomain]: (params: { domain: string }) =>
`Domain ${params.domain} is not supported`,
[ResolutionErrorCode.UnsupportedMethod]: (params: {
methodName: string;
domain: string;
}) => `Method ${params.methodName} is not supported for ${params.domain}`,
[ResolutionErrorCode.UnspecifiedCurrency]: (params: {
domain: string;
currencyTicker: string;
}) =>
`Domain ${params.domain} has no ${params.currencyTicker} attached to it`,
[ResolutionErrorCode.NamingServiceDown]: (params: {
method: ResolutionMethod;
}) => `${params.method} naming service is down at the moment`,
[ResolutionErrorCode.InvalidTwitterVerification]: (params: {
domain?: string;
}) => `Domain ${params.domain} has invalid Twitter signature verification`,
[ResolutionErrorCode.UnsupportedCurrency]: (params: {
currencyTicker: string;
}) => `${params.currencyTicker} is not supported`,
[ResolutionErrorCode.IncorrectResolverInterface]: (params: {
method: ResolutionMethod;
}) => `Domain resolver is configured incorrectly for ${params.method}`,
[ResolutionErrorCode.RecordNotFound]: (params: {
recordName: string;
domain: string;
}) => `No ${params.recordName} record found for ${params.domain}`,
[ResolutionErrorCode.ServiceProviderError]: (params: {
providerMessage?: string;
}) => `< ${params.providerMessage} >`,
};
/**
* Resolution Error class is designed to control every error being thrown by Resolution
* @param code - Error Code
* - UnsupportedDomain - domain is not supported by current Resolution instance
* - NamingServiceDown - blockchain API is down
* - UnregisteredDomain - domain is not owned by any address
* - UnspecifiedResolver - domain has no resolver specified
* - UnspecifiedCurrency - domain resolver doesn't have any address of specified currency
* - UnsupportedCurrency - currency is not supported
* - IncorrectResolverInterface - ResolverInterface is incorrected
* - RecordNotFound - No record was found
* @param domain - Domain name that was being used
* @param method
*/
export class ResolutionError extends Error {
readonly code: ResolutionErrorCode;
readonly domain?: string;
readonly method?: string;
readonly currencyTicker?: string;
constructor(code: ResolutionErrorCode, options: ResolutionErrorOptions = {}) {
const resolutionErrorHandler: ResolutionErrorHandler = HandlersByCode[code];
const { domain, method, currencyTicker } = options;
let message = resolutionErrorHandler(options);
if (code === ResolutionErrorCode.UnspecifiedCurrency) {
message += `\nResolutionErrorCode ${code} is deprecated and will be removed in the future. Use RecordNotFound code instead.`;
}
super(message);
this.code = code;
this.domain = domain;
this.method = method;
this.currencyTicker = currencyTicker;
this.name = 'ResolutionError';
Object.setPrototypeOf(this, ResolutionError.prototype);
}
}
export default ResolutionError;