All files / src/sdk WERR_errors.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
 
57x
 
 
 
 
57x
 
 
 
 
 
 
57x
 
 
 
 
 
 
57x
 
 
 
 
 
 
57x
 
 
 
 
 
 
57x
 
 
 
 
57x
 
 
 
 
57x
 
 
 
 
57x
 
 
 
 
 
 
 
57x
 
 
 
 
2x
2x
 
 
 
57x
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
import { WalletNetwork } from "./Wallet.interfaces"
import { WalletError } from "./WalletError"
 
/**
 * Not implemented.
 */
export class WERR_NOT_IMPLEMENTED extends WalletError { constructor (message?: string) { super('WERR_NOT_IMPLEMENTED', message ?? 'Not implemented.') } }
 
/**
 * An internal error has occurred.
 * 
 * This is an example of an error with an optional custom `message`.
 */
export class WERR_INTERNAL extends WalletError { constructor (message?: string) { super('WERR_INTERNAL', message ?? 'An internal error has occurred.') } }
 
/**
 * The ${parameter} parameter is invalid.
 * 
 * This is an example of an error object with a custom property `parameter` and templated `message`.
 */
export class WERR_INVALID_OPERATION extends WalletError { constructor (message?: string) { super('WERR_INVALID_OPERATION', message ?? `An invalid operation was requested.`) } }
 
/**
 * The ${parameter} parameter is invalid.
 * 
 * This is an example of an error object with a custom property `parameter` and templated `message`.
 */
export class WERR_INVALID_PARAMETER extends WalletError { constructor (public parameter: string, mustBe?: string) { super('WERR_INVALID_PARAMETER', `The ${parameter} parameter must be ${mustBe ?? 'valid.'}`) } }
 
/**
 * The required ${parameter} parameter is missing.
 * 
 * This is an example of an error object with a custom property `parameter`
 */
export class WERR_MISSING_PARAMETER extends WalletError { constructor (public parameter: string) { super('WERR_MISSING_PARAMETER', `The required ${parameter} parameter is missing.`) } }
 
/**
 * The request is invalid.
 */
export class WERR_BAD_REQUEST extends WalletError { constructor (message?: string) { super('WERR_BAD_REQUEST', message ?? 'The request is invalid.') } }
 
/**
 * Configured network chain is invalid or does not match across services.
 */
export class WERR_NETWORK_CHAIN extends WalletError { constructor (message?: string) { super('WERR_NETWORK_CHAIN', message ?? 'Configured network chain is invalid or does not match across services.') } }
 
/**
 * Access is denied due to an authorization error.
 */
export class WERR_UNAUTHORIZED extends WalletError { constructor (message?: string) { super('WERR_UNAUTHORIZED', message ?? 'Access is denied due to an authorization error.') } }
 
/**
 * Insufficient funds in the available inputs to cover the cost of the required outputs
 * and the transaction fee (${moreSatoshisNeeded} more satoshis are needed,
 * for a total of ${totalSatoshisNeeded}), plus whatever would be required in order
 * to pay the fee to unlock and spend the outputs used to provide the additional satoshis.
 */
export class WERR_INSUFFICIENT_FUNDS extends WalletError {
    /**
     * @param totalSatoshisNeeded Total satoshis required to fund transactions after net of required inputs and outputs.
     * @param moreSatoshisNeeded Shortfall on total satoshis required to fund transactions after net of required inputs and outputs.
     */
    constructor(public totalSatoshisNeeded: number, public moreSatoshisNeeded: number) {
        super('WERR_INSUFFICIENT_FUNDS', `Insufficient funds in the available inputs to cover the cost of the required outputs and the transaction fee (${moreSatoshisNeeded} more satoshis are needed, for a total of ${totalSatoshisNeeded}), plus whatever would be required in order to pay the fee to unlock and spend the outputs used to provide the additional satoshis.`)
    }
}
 
export class WERR_INVALID_PUBLIC_KEY extends WalletError {
    /**
     * @param key The invalid public key that caused the error.
     * @param environment Optional environment flag to control whether the key is included in the message.
     */
    constructor(public key: string, network: WalletNetwork = 'mainnet') {
        const message =
            network === 'mainnet'
                ? `The provided public key "${key}" is invalid or malformed.`
                : `The provided public key is invalid or malformed.`
        super(
            'WERR_INVALID_PUBLIC_KEY',
            message,
        )
    }
}