@umbra-privacy/sdk 1.0.0 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (181) hide show
  1. package/README.md +104 -25
  2. package/dist/{addresses-Brzgurv_.d.ts → addresses-B7HybtbJ.d.ts} +2 -1
  3. package/dist/{addresses-D_0YAS6B.d.cts → addresses-CTVY1oi7.d.cts} +2 -1
  4. package/dist/arcium-BXXlryfe.d.cts +20 -0
  5. package/dist/arcium-BXXlryfe.d.ts +20 -0
  6. package/dist/chunk-3LS5P32X.cjs +10892 -0
  7. package/dist/chunk-3LS5P32X.cjs.map +1 -0
  8. package/dist/chunk-4RHXVBNI.js +203 -0
  9. package/dist/chunk-4RHXVBNI.js.map +1 -0
  10. package/dist/chunk-4TZVXB5G.js +324 -0
  11. package/dist/chunk-4TZVXB5G.js.map +1 -0
  12. package/dist/chunk-5GUSMQ74.cjs +549 -0
  13. package/dist/chunk-5GUSMQ74.cjs.map +1 -0
  14. package/dist/chunk-5KPQXPQM.js +36 -0
  15. package/dist/chunk-5KPQXPQM.js.map +1 -0
  16. package/dist/chunk-AXD7LXYY.cjs +405 -0
  17. package/dist/chunk-AXD7LXYY.cjs.map +1 -0
  18. package/dist/{chunk-HOEXDXRC.cjs → chunk-BL6WXLPV.cjs} +32 -360
  19. package/dist/chunk-BL6WXLPV.cjs.map +1 -0
  20. package/dist/chunk-CFFLOE7D.cjs +598 -0
  21. package/dist/chunk-CFFLOE7D.cjs.map +1 -0
  22. package/dist/{chunk-BM7N6N7E.js → chunk-CFTW5WNG.js} +3 -325
  23. package/dist/chunk-CFTW5WNG.js.map +1 -0
  24. package/dist/chunk-DD2WCK4C.js +327 -0
  25. package/dist/chunk-DD2WCK4C.js.map +1 -0
  26. package/dist/chunk-DMPMQ74B.cjs +246 -0
  27. package/dist/chunk-DMPMQ74B.cjs.map +1 -0
  28. package/dist/{chunk-2Q75CQQJ.js → chunk-EEKF4553.js} +2 -2
  29. package/dist/chunk-EEKF4553.js.map +1 -0
  30. package/dist/chunk-ENVYYEM4.cjs +113 -0
  31. package/dist/chunk-ENVYYEM4.cjs.map +1 -0
  32. package/dist/chunk-FQX6ZYGJ.js +500 -0
  33. package/dist/chunk-FQX6ZYGJ.js.map +1 -0
  34. package/dist/chunk-FSK2ICMB.cjs +39 -0
  35. package/dist/chunk-FSK2ICMB.cjs.map +1 -0
  36. package/dist/chunk-FZYWLQAF.cjs +355 -0
  37. package/dist/chunk-FZYWLQAF.cjs.map +1 -0
  38. package/dist/chunk-GP26R377.js +436 -0
  39. package/dist/chunk-GP26R377.js.map +1 -0
  40. package/dist/chunk-HA5FLM63.js +393 -0
  41. package/dist/chunk-HA5FLM63.js.map +1 -0
  42. package/dist/chunk-INJ73LXQ.js +1107 -0
  43. package/dist/chunk-INJ73LXQ.js.map +1 -0
  44. package/dist/chunk-KMRROOME.js +10750 -0
  45. package/dist/chunk-KMRROOME.js.map +1 -0
  46. package/dist/{chunk-MDFSBU5W.cjs → chunk-LTCKPTZC.cjs} +2 -351
  47. package/dist/chunk-LTCKPTZC.cjs.map +1 -0
  48. package/dist/chunk-MKNCBUFA.js +564 -0
  49. package/dist/chunk-MKNCBUFA.js.map +1 -0
  50. package/dist/chunk-NKVMSABR.cjs +207 -0
  51. package/dist/chunk-NKVMSABR.cjs.map +1 -0
  52. package/dist/chunk-OFDWNWCL.js +70 -0
  53. package/dist/chunk-OFDWNWCL.js.map +1 -0
  54. package/dist/chunk-QJAUUYZU.cjs +331 -0
  55. package/dist/chunk-QJAUUYZU.cjs.map +1 -0
  56. package/dist/chunk-TLR7A64G.js +103 -0
  57. package/dist/chunk-TLR7A64G.js.map +1 -0
  58. package/dist/{chunk-MVKTV3FT.cjs → chunk-TQQZGNOI.cjs} +2 -2
  59. package/dist/chunk-TQQZGNOI.cjs.map +1 -0
  60. package/dist/chunk-UOFYS6M3.js +219 -0
  61. package/dist/chunk-UOFYS6M3.js.map +1 -0
  62. package/dist/chunk-UXMQI6B7.js +2406 -0
  63. package/dist/chunk-UXMQI6B7.js.map +1 -0
  64. package/dist/chunk-WN75ORDT.js +571 -0
  65. package/dist/chunk-WN75ORDT.js.map +1 -0
  66. package/dist/chunk-Y55PYKXH.cjs +595 -0
  67. package/dist/chunk-Y55PYKXH.cjs.map +1 -0
  68. package/dist/chunk-YEZBTYCP.cjs +77 -0
  69. package/dist/chunk-YEZBTYCP.cjs.map +1 -0
  70. package/dist/chunk-ZQOIYCGA.cjs +1126 -0
  71. package/dist/chunk-ZQOIYCGA.cjs.map +1 -0
  72. package/dist/chunk-ZY3TSHMJ.cjs +2665 -0
  73. package/dist/chunk-ZY3TSHMJ.cjs.map +1 -0
  74. package/dist/client-DkVBHMWb.d.cts +2613 -0
  75. package/dist/client-V4AF6Bz9.d.ts +2613 -0
  76. package/dist/common/pda/index.cjs +145 -0
  77. package/dist/common/pda/index.cjs.map +1 -0
  78. package/dist/common/pda/index.d.cts +1250 -0
  79. package/dist/common/pda/index.d.ts +1250 -0
  80. package/dist/common/pda/index.js +8 -0
  81. package/dist/common/pda/index.js.map +1 -0
  82. package/dist/constants/index.cjs +38 -164
  83. package/dist/constants/index.cjs.map +1 -1
  84. package/dist/constants/index.d.cts +8 -425
  85. package/dist/constants/index.d.ts +8 -425
  86. package/dist/constants/index.js +15 -124
  87. package/dist/constants/index.js.map +1 -1
  88. package/dist/crypto/index.cjs +583 -0
  89. package/dist/crypto/index.cjs.map +1 -0
  90. package/dist/crypto/index.d.cts +6731 -0
  91. package/dist/crypto/index.d.ts +6731 -0
  92. package/dist/crypto/index.js +14 -0
  93. package/dist/crypto/index.js.map +1 -0
  94. package/dist/{cryptography-BTGC72u-.d.ts → cryptography-BFSJcvi6.d.ts} +3 -2465
  95. package/dist/{cryptography-BTGC72u-.d.cts → cryptography-D6tPDh-Y.d.cts} +3 -2465
  96. package/dist/errors/index.cjs +64 -54
  97. package/dist/errors/index.d.cts +7 -797
  98. package/dist/errors/index.d.ts +7 -797
  99. package/dist/errors/index.js +3 -1
  100. package/dist/errors-B9EoPeWV.d.cts +593 -0
  101. package/dist/errors-B9EoPeWV.d.ts +593 -0
  102. package/dist/errors-DAIrstEL.d.cts +300 -0
  103. package/dist/errors-DPNMfyh0.d.ts +300 -0
  104. package/dist/index-BG0yjL7C.d.cts +6006 -0
  105. package/dist/index-ByynoyBO.d.ts +6006 -0
  106. package/dist/index.cjs +5133 -16116
  107. package/dist/index.cjs.map +1 -1
  108. package/dist/index.d.cts +1031 -7685
  109. package/dist/index.d.ts +1031 -7685
  110. package/dist/index.js +3228 -14905
  111. package/dist/index.js.map +1 -1
  112. package/dist/interfaces/index.d.cts +14 -6
  113. package/dist/interfaces/index.d.ts +14 -6
  114. package/dist/interfaces-43cReBcS.d.cts +3346 -0
  115. package/dist/interfaces-B8xKNl_6.d.ts +997 -0
  116. package/dist/interfaces-D2NO6kDD.d.cts +997 -0
  117. package/dist/interfaces-z_xYJlgV.d.ts +3346 -0
  118. package/dist/math/index.cjs +115 -0
  119. package/dist/math/index.cjs.map +1 -0
  120. package/dist/math/index.d.cts +1327 -0
  121. package/dist/math/index.d.ts +1327 -0
  122. package/dist/math/index.js +10 -0
  123. package/dist/math/index.js.map +1 -0
  124. package/dist/networks-RMd3abPE.d.ts +44 -0
  125. package/dist/networks-yAoO8peQ.d.cts +44 -0
  126. package/dist/relayer-NRRMSMNB.js +4 -0
  127. package/dist/relayer-NRRMSMNB.js.map +1 -0
  128. package/dist/relayer-RJHEIXJG.cjs +21 -0
  129. package/dist/relayer-RJHEIXJG.cjs.map +1 -0
  130. package/dist/solana/index.cjs +56 -0
  131. package/dist/solana/index.cjs.map +1 -0
  132. package/dist/solana/index.d.cts +105 -0
  133. package/dist/solana/index.d.ts +105 -0
  134. package/dist/solana/index.js +7 -0
  135. package/dist/solana/index.js.map +1 -0
  136. package/dist/{index-CLj_zWSD.d.ts → temporal-BbRaEPoO.d.ts} +1 -1
  137. package/dist/{index-CX6_pIRS.d.cts → temporal-oUj7iCaq.d.cts} +1 -1
  138. package/dist/transaction-forwarder-5mAMTjw6.d.ts +1155 -0
  139. package/dist/transaction-forwarder-C6gMUG7a.d.cts +1155 -0
  140. package/dist/types/index.cjs +232 -231
  141. package/dist/types/index.d.cts +15 -1485
  142. package/dist/types/index.d.ts +15 -1485
  143. package/dist/types/index.js +2 -1
  144. package/dist/types-BohhvPth.d.cts +87 -0
  145. package/dist/types-CW0oTT0j.d.ts +87 -0
  146. package/dist/types-C_V_CaKK.d.cts +2468 -0
  147. package/dist/types-C_V_CaKK.d.ts +2468 -0
  148. package/dist/types-Ca7frykr.d.ts +793 -0
  149. package/dist/types-CuKeoI19.d.cts +1296 -0
  150. package/dist/types-CxfTIpN9.d.ts +1052 -0
  151. package/dist/{types-n-sHFcgr.d.ts → types-D1jDUjfN.d.ts} +2 -2
  152. package/dist/types-DKEDUlH9.d.ts +1296 -0
  153. package/dist/types-EKuIfxTz.d.cts +1052 -0
  154. package/dist/{types-BBuELtY8.d.cts → types-IMGYmlv-.d.cts} +2 -2
  155. package/dist/types-PwNLi_2k.d.cts +793 -0
  156. package/dist/utils/index.cjs +823 -525
  157. package/dist/utils/index.d.cts +1711 -4021
  158. package/dist/utils/index.d.ts +1711 -4021
  159. package/dist/utils/index.js +9 -3
  160. package/dist/{versions-D9PqsEvj.d.cts → versions-BRlR36EA.d.cts} +1 -0
  161. package/dist/{versions-D9PqsEvj.d.ts → versions-BRlR36EA.d.ts} +1 -0
  162. package/package.json +79 -18
  163. package/dist/chunk-2Q75CQQJ.js.map +0 -1
  164. package/dist/chunk-BM7N6N7E.js.map +0 -1
  165. package/dist/chunk-GXKSUB2U.cjs +0 -4416
  166. package/dist/chunk-GXKSUB2U.cjs.map +0 -1
  167. package/dist/chunk-HOEXDXRC.cjs.map +0 -1
  168. package/dist/chunk-MDFSBU5W.cjs.map +0 -1
  169. package/dist/chunk-MQY7HDIA.js +0 -600
  170. package/dist/chunk-MQY7HDIA.js.map +0 -1
  171. package/dist/chunk-MVKTV3FT.cjs.map +0 -1
  172. package/dist/chunk-PG2J6V6Y.js +0 -4094
  173. package/dist/chunk-PG2J6V6Y.js.map +0 -1
  174. package/dist/chunk-VEGLTTYQ.cjs +0 -621
  175. package/dist/chunk-VEGLTTYQ.cjs.map +0 -1
  176. package/dist/chunk-WVHQ46DD.js +0 -758
  177. package/dist/chunk-WVHQ46DD.js.map +0 -1
  178. package/dist/index-B9pDY73x.d.ts +0 -12933
  179. package/dist/index-D33yo0qB.d.cts +0 -12933
  180. package/dist/networks-C-orpSFW.d.ts +0 -65
  181. package/dist/networks-FxYERGD1.d.cts +0 -65
@@ -0,0 +1,203 @@
1
+ import { __name } from './chunk-7QVYU63E.js';
2
+ import { address } from '@solana/kit';
3
+
4
+ var ENDPOINTS = {
5
+ /** Fetches relayer address, supported mints, and active stealth pool indices. */
6
+ RELAYER_INFO: `/v1/relayer/info`,
7
+ /** Submits a claim request (relayer builds transactions from crypto data). */
8
+ CLAIM_SUBMIT: `/v1/claims`,
9
+ /** Polls claim status by request ID. `{id}` is replaced at call time. */
10
+ CLAIM_STATUS: `/v1/claims/{id}`
11
+ };
12
+ var RelayerError = class _RelayerError extends Error {
13
+ static {
14
+ __name(this, "RelayerError");
15
+ }
16
+ /** The relayer operation that failed (e.g. `"getRelayerAddress"`, `"claimSubmit"`). */
17
+ operation;
18
+ /** HTTP status code if the server responded, `undefined` for transport errors. */
19
+ statusCode;
20
+ /** Machine-readable error code from the API error body. */
21
+ errorCode;
22
+ constructor(operation, message, statusCode, errorCode, cause) {
23
+ super(`Relayer operation '${operation}' failed: ${message}`);
24
+ this.name = "RelayerError";
25
+ this.operation = operation;
26
+ this.statusCode = statusCode;
27
+ this.errorCode = errorCode;
28
+ this.cause = cause;
29
+ if (Error.captureStackTrace !== void 0) {
30
+ Error.captureStackTrace(this, _RelayerError);
31
+ }
32
+ }
33
+ };
34
+ async function makeRequest(endpoint, fetchImpl, options) {
35
+ const { method = "GET", body, operation } = options;
36
+ try {
37
+ const requestInit = {
38
+ method,
39
+ headers: {
40
+ "Content-Type": "application/json",
41
+ Accept: "application/json"
42
+ }
43
+ };
44
+ if (body !== void 0) {
45
+ requestInit.body = JSON.stringify(body);
46
+ }
47
+ const response = await fetchImpl(endpoint, requestInit);
48
+ const data = await response.json();
49
+ if (!response.ok) {
50
+ const errorData = data;
51
+ const message = errorData.error?.message ?? errorData.message ?? `HTTP ${String(response.status)}`;
52
+ const code = errorData.error?.code ?? errorData.error_code;
53
+ throw new RelayerError(operation, message, response.status, code);
54
+ }
55
+ return data;
56
+ } catch (error) {
57
+ if (error instanceof RelayerError) {
58
+ throw error;
59
+ }
60
+ throw new RelayerError(
61
+ operation,
62
+ error instanceof Error ? error.message : "Unknown error",
63
+ void 0,
64
+ void 0,
65
+ error instanceof Error ? error : void 0
66
+ );
67
+ }
68
+ }
69
+ __name(makeRequest, "makeRequest");
70
+ function convertClaimStatusResponse(api) {
71
+ return {
72
+ requestId: api.request_id,
73
+ status: api.status,
74
+ variant: api.variant,
75
+ resolvedVariant: api.resolved_variant,
76
+ txSignature: api.tx_signature,
77
+ callbackSignature: api.callback_signature,
78
+ computationAccount: api.computation_account,
79
+ failureReason: api.failure_reason,
80
+ createdAt: api.created_at,
81
+ updatedAt: api.updated_at
82
+ };
83
+ }
84
+ __name(convertClaimStatusResponse, "convertClaimStatusResponse");
85
+ function getUmbraRelayer(args, deps) {
86
+ const { apiEndpoint } = args;
87
+ const fetchImpl = deps?.fetch ?? globalThis.fetch;
88
+ if (apiEndpoint === "") {
89
+ throw new RelayerError("initialization", "apiEndpoint must be a non-empty string");
90
+ }
91
+ const normalizedEndpoint = apiEndpoint.replace(/\/$/, "");
92
+ let cachedAddress = null;
93
+ let cachedInfo = null;
94
+ async function fetchInfo() {
95
+ if (cachedInfo !== null) {
96
+ return cachedInfo;
97
+ }
98
+ const response = await makeRequest(
99
+ `${normalizedEndpoint}${ENDPOINTS.RELAYER_INFO}`,
100
+ fetchImpl,
101
+ { operation: "getRelayerInfo" }
102
+ );
103
+ cachedInfo = response;
104
+ cachedAddress = address(response.address);
105
+ return response;
106
+ }
107
+ __name(fetchInfo, "fetchInfo");
108
+ return {
109
+ apiEndpoint: normalizedEndpoint,
110
+ async getFeePayer() {
111
+ if (cachedAddress !== null) {
112
+ return cachedAddress;
113
+ }
114
+ const info = await fetchInfo();
115
+ return address(info.address);
116
+ },
117
+ async getRelayerAddress() {
118
+ if (cachedAddress !== null) {
119
+ return cachedAddress;
120
+ }
121
+ const info = await fetchInfo();
122
+ return address(info.address);
123
+ },
124
+ async getSupportedMints() {
125
+ const info = await fetchInfo();
126
+ return {
127
+ relayer: info.address,
128
+ mints: info.supported_mints,
129
+ count: BigInt(info.supported_mints.length)
130
+ };
131
+ },
132
+ async submitClaim(request) {
133
+ const response = await makeRequest(
134
+ `${normalizedEndpoint}${ENDPOINTS.CLAIM_SUBMIT}`,
135
+ fetchImpl,
136
+ { method: "POST", body: request, operation: "claimSubmit" }
137
+ );
138
+ return {
139
+ requestId: response.request_id,
140
+ status: response.status
141
+ };
142
+ },
143
+ async pollClaimStatus(requestId) {
144
+ const url = `${normalizedEndpoint}${ENDPOINTS.CLAIM_STATUS.replace("{id}", requestId)}`;
145
+ const response = await makeRequest(url, fetchImpl, {
146
+ operation: "claimStatus"
147
+ });
148
+ return convertClaimStatusResponse(response);
149
+ }
150
+ };
151
+ }
152
+ __name(getUmbraRelayer, "getUmbraRelayer");
153
+ var TERMINAL_CLAIM_STATUSES = /* @__PURE__ */ new Set([
154
+ "completed",
155
+ "failed",
156
+ "timed_out"
157
+ ]);
158
+ async function pollClaimUntilTerminal(pollClaimStatus, requestId, options) {
159
+ const pollingIntervalMs = options?.pollingIntervalMs ?? 3e3;
160
+ const timeoutMs = options?.timeoutMs ?? 12e4;
161
+ const onProgress = options?.onProgress;
162
+ const startTime = Date.now();
163
+ while (true) {
164
+ const status = await pollClaimStatus(requestId);
165
+ if (onProgress !== void 0) {
166
+ onProgress({
167
+ requestId: status.requestId,
168
+ status: status.status,
169
+ resolvedVariant: status.resolvedVariant,
170
+ txSignature: status.txSignature,
171
+ callbackSignature: status.callbackSignature,
172
+ failureReason: status.failureReason
173
+ });
174
+ }
175
+ if (TERMINAL_CLAIM_STATUSES.has(status.status)) {
176
+ const result = {
177
+ requestId: status.requestId,
178
+ status: status.status,
179
+ txSignature: status.txSignature,
180
+ callbackSignature: status.callbackSignature,
181
+ resolvedVariant: status.resolvedVariant,
182
+ failureReason: status.failureReason
183
+ };
184
+ return result;
185
+ }
186
+ if (Date.now() - startTime >= timeoutMs) {
187
+ const timedOutResult = {
188
+ requestId: status.requestId,
189
+ status: "timed_out",
190
+ failureReason: `Polling timed out after ${String(timeoutMs)}ms (last status: ${String(status.status)})`
191
+ };
192
+ return timedOutResult;
193
+ }
194
+ await new Promise((resolve) => {
195
+ setTimeout(resolve, pollingIntervalMs);
196
+ });
197
+ }
198
+ }
199
+ __name(pollClaimUntilTerminal, "pollClaimUntilTerminal");
200
+
201
+ export { RelayerError, getUmbraRelayer, pollClaimUntilTerminal };
202
+ //# sourceMappingURL=chunk-4RHXVBNI.js.map
203
+ //# sourceMappingURL=chunk-4RHXVBNI.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/umbra/relayer.ts"],"names":[],"mappings":";;;AAkDA,IAAM,SAAA,GAAY;AAAA;AAAA,EAEhB,YAAA,EAAc,CAAA,gBAAA,CAAA;AAAA;AAAA,EAEd,YAAA,EAAc,CAAA,UAAA,CAAA;AAAA;AAAA,EAEd,YAAA,EAAc,CAAA,eAAA;AAChB,CAAA;AAgBO,IAAM,YAAA,GAAN,MAAM,aAAA,SAAqB,KAAA,CAAM;AAAA,EAzExC;AAyEwC,IAAA,MAAA,CAAA,IAAA,EAAA,cAAA,CAAA;AAAA;AAAA;AAAA,EAEtB,SAAA;AAAA;AAAA,EAEA,UAAA;AAAA;AAAA,EAEA,SAAA;AAAA,EAEhB,WAAA,CACE,SAAA,EACA,OAAA,EACA,UAAA,EACA,WACA,KAAA,EACA;AACA,IAAA,KAAA,CAAM,CAAA,mBAAA,EAAsB,SAAS,CAAA,UAAA,EAAa,OAAO,CAAA,CAAE,CAAA;AAC3D,IAAA,IAAA,CAAK,IAAA,GAAO,cAAA;AACZ,IAAA,IAAA,CAAK,SAAA,GAAY,SAAA;AACjB,IAAA,IAAA,CAAK,UAAA,GAAa,UAAA;AAClB,IAAA,IAAA,CAAK,SAAA,GAAY,SAAA;AACjB,IAAA,IAAA,CAAK,KAAA,GAAQ,KAAA;AAEb,IAAA,IAAI,KAAA,CAAM,sBAAsB,MAAA,EAAW;AACzC,MAAA,KAAA,CAAM,iBAAA,CAAkB,MAAM,aAAY,CAAA;AAAA,IAC5C;AAAA,EACF;AACF;AAoDA,eAAe,WAAA,CACb,QAAA,EACA,SAAA,EACA,OAAA,EAKY;AACZ,EAAA,MAAM,EAAE,MAAA,GAAS,KAAA,EAAO,IAAA,EAAM,WAAU,GAAI,OAAA;AAE5C,EAAA,IAAI;AACF,IAAA,MAAM,WAAA,GAA2B;AAAA,MAC/B,MAAA;AAAA,MACA,OAAA,EAAS;AAAA,QACP,cAAA,EAAgB,kBAAA;AAAA,QAChB,MAAA,EAAQ;AAAA;AACV,KACF;AACA,IAAA,IAAI,SAAS,KAAA,CAAA,EAAW;AACtB,MAAA,WAAA,CAAY,IAAA,GAAO,IAAA,CAAK,SAAA,CAAU,IAAI,CAAA;AAAA,IACxC;AACA,IAAA,MAAM,QAAA,GAAW,MAAM,SAAA,CAAU,QAAA,EAAU,WAAW,CAAA;AAEtD,IAAA,MAAM,IAAA,GAAQ,MAAM,QAAA,CAAS,IAAA,EAAK;AAElC,IAAA,IAAI,CAAC,SAAS,EAAA,EAAI;AAChB,MAAA,MAAM,SAAA,GAAY,IAAA;AAClB,MAAA,MAAM,OAAA,GACJ,SAAA,CAAU,KAAA,EAAO,OAAA,IAAW,SAAA,CAAU,WAAW,CAAA,KAAA,EAAQ,MAAA,CAAO,QAAA,CAAS,MAAM,CAAC,CAAA,CAAA;AAClF,MAAA,MAAM,IAAA,GAAO,SAAA,CAAU,KAAA,EAAO,IAAA,IAAQ,SAAA,CAAU,UAAA;AAChD,MAAA,MAAM,IAAI,YAAA,CAAa,SAAA,EAAW,OAAA,EAAS,QAAA,CAAS,QAAQ,IAAI,CAAA;AAAA,IAClE;AAEA,IAAA,OAAO,IAAA;AAAA,EACT,SAAS,KAAA,EAAO;AACd,IAAA,IAAI,iBAAiB,YAAA,EAAc;AACjC,MAAA,MAAM,KAAA;AAAA,IACR;AACA,IAAA,MAAM,IAAI,YAAA;AAAA,MACR,SAAA;AAAA,MACA,KAAA,YAAiB,KAAA,GAAQ,KAAA,CAAM,OAAA,GAAU,eAAA;AAAA,MACzC,MAAA;AAAA,MACA,MAAA;AAAA,MACA,KAAA,YAAiB,QAAQ,KAAA,GAAQ;AAAA,KACnC;AAAA,EACF;AACF;AA/Ce,MAAA,CAAA,WAAA,EAAA,aAAA,CAAA;AAkDf,SAAS,2BAA2B,GAAA,EAAkD;AACpF,EAAA,OAAO;AAAA,IACL,WAAW,GAAA,CAAI,UAAA;AAAA,IACf,QAAQ,GAAA,CAAI,MAAA;AAAA,IACZ,SAAS,GAAA,CAAI,OAAA;AAAA,IACb,iBAAiB,GAAA,CAAI,gBAAA;AAAA,IACrB,aAAa,GAAA,CAAI,YAAA;AAAA,IACjB,mBAAmB,GAAA,CAAI,kBAAA;AAAA,IACvB,oBAAoB,GAAA,CAAI,mBAAA;AAAA,IACxB,eAAe,GAAA,CAAI,cAAA;AAAA,IACnB,WAAW,GAAA,CAAI,UAAA;AAAA,IACf,WAAW,GAAA,CAAI;AAAA,GACjB;AACF;AAbS,MAAA,CAAA,0BAAA,EAAA,4BAAA,CAAA;AAkDF,SAAS,eAAA,CACd,MACA,IAAA,EACe;AACf,EAAA,MAAM,EAAE,aAAY,GAAI,IAAA;AACxB,EAAA,MAAM,SAAA,GAAY,IAAA,EAAM,KAAA,IAAS,UAAA,CAAW,KAAA;AAE5C,EAAA,IAAI,gBAAgB,EAAA,EAAI;AACtB,IAAA,MAAM,IAAI,YAAA,CAAa,gBAAA,EAAkB,wCAAwC,CAAA;AAAA,EACnF;AAEA,EAAA,MAAM,kBAAA,GAAqB,WAAA,CAAY,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAA;AAGxD,EAAA,IAAI,aAAA,GAAgC,IAAA;AACpC,EAAA,IAAI,UAAA,GAA4C,IAAA;AAEhD,EAAA,eAAe,SAAA,GAA6C;AAC1D,IAAA,IAAI,eAAe,IAAA,EAAM;AACvB,MAAA,OAAO,UAAA;AAAA,IACT;AACA,IAAA,MAAM,WAAW,MAAM,WAAA;AAAA,MACrB,CAAA,EAAG,kBAAkB,CAAA,EAAG,SAAA,CAAU,YAAY,CAAA,CAAA;AAAA,MAC9C,SAAA;AAAA,MACA,EAAE,WAAW,gBAAA;AAAiB,KAChC;AACA,IAAA,UAAA,GAAa,QAAA;AACb,IAAA,aAAA,GAAgB,OAAA,CAAQ,SAAS,OAAO,CAAA;AACxC,IAAA,OAAO,QAAA;AAAA,EACT;AAZe,EAAA,MAAA,CAAA,SAAA,EAAA,WAAA,CAAA;AAcf,EAAA,OAAO;AAAA,IACL,WAAA,EAAa,kBAAA;AAAA,IAEb,MAAM,WAAA,GAAgC;AACpC,MAAA,IAAI,kBAAkB,IAAA,EAAM;AAC1B,QAAA,OAAO,aAAA;AAAA,MACT;AACA,MAAA,MAAM,IAAA,GAAO,MAAM,SAAA,EAAU;AAC7B,MAAA,OAAO,OAAA,CAAQ,KAAK,OAAO,CAAA;AAAA,IAC7B,CAAA;AAAA,IAEA,MAAM,iBAAA,GAAsC;AAC1C,MAAA,IAAI,kBAAkB,IAAA,EAAM;AAC1B,QAAA,OAAO,aAAA;AAAA,MACT;AACA,MAAA,MAAM,IAAA,GAAO,MAAM,SAAA,EAAU;AAC7B,MAAA,OAAO,OAAA,CAAQ,KAAK,OAAO,CAAA;AAAA,IAC7B,CAAA;AAAA,IAEA,MAAM,iBAAA,GAAqD;AACzD,MAAA,MAAM,IAAA,GAAO,MAAM,SAAA,EAAU;AAC7B,MAAA,OAAO;AAAA,QACL,SAAS,IAAA,CAAK,OAAA;AAAA,QACd,OAAO,IAAA,CAAK,eAAA;AAAA,QACZ,KAAA,EAAO,MAAA,CAAO,IAAA,CAAK,eAAA,CAAgB,MAAM;AAAA,OAC3C;AAAA,IACF,CAAA;AAAA,IAEA,MAAM,YAAY,OAAA,EAAqD;AACrE,MAAA,MAAM,WAAW,MAAM,WAAA;AAAA,QACrB,CAAA,EAAG,kBAAkB,CAAA,EAAG,SAAA,CAAU,YAAY,CAAA,CAAA;AAAA,QAC9C,SAAA;AAAA,QACA,EAAE,MAAA,EAAQ,MAAA,EAAQ,IAAA,EAAM,OAAA,EAAS,WAAW,aAAA;AAAc,OAC5D;AACA,MAAA,OAAO;AAAA,QACL,WAAW,QAAA,CAAS,UAAA;AAAA,QACpB,QAAQ,QAAA,CAAS;AAAA,OACnB;AAAA,IACF,CAAA;AAAA,IAEA,MAAM,gBAAgB,SAAA,EAAiD;AACrE,MAAA,MAAM,GAAA,GAAM,GAAG,kBAAkB,CAAA,EAAG,UAAU,YAAA,CAAa,OAAA,CAAQ,MAAA,EAAQ,SAAS,CAAC,CAAA,CAAA;AACrF,MAAA,MAAM,QAAA,GAAW,MAAM,WAAA,CAAoC,GAAA,EAAK,SAAA,EAAW;AAAA,QACzE,SAAA,EAAW;AAAA,OACZ,CAAA;AACD,MAAA,OAAO,2BAA2B,QAAQ,CAAA;AAAA,IAC5C;AAAA,GACF;AACF;AA/EgB,MAAA,CAAA,eAAA,EAAA,iBAAA,CAAA;AAyFhB,IAAM,uBAAA,uBAAwD,GAAA,CAAI;AAAA,EAChE,WAAA;AAAA,EACA,QAAA;AAAA,EACA;AACF,CAAC,CAAA;AAgBD,eAAsB,sBAAA,CACpB,eAAA,EACA,SAAA,EACA,OAAA,EAY2B;AAC3B,EAAA,MAAM,iBAAA,GAA4B,SAAS,iBAAA,IAAqB,GAAA;AAChE,EAAA,MAAM,SAAA,GAAoB,SAAS,SAAA,IAAa,IAAA;AAChD,EAAA,MAAM,aAAa,OAAA,EAAS,UAAA;AAE5B,EAAA,MAAM,SAAA,GAAoB,KAAK,GAAA,EAAI;AAGnC,EAAA,OAAO,IAAA,EAAM;AACX,IAAA,MAAM,MAAA,GAA8B,MAAM,eAAA,CAAgB,SAAS,CAAA;AAEnE,IAAA,IAAI,eAAe,MAAA,EAAW;AAC5B,MAAA,UAAA,CAAW;AAAA,QACT,WAAW,MAAA,CAAO,SAAA;AAAA,QAClB,QAAQ,MAAA,CAAO,MAAA;AAAA,QACf,iBAAiB,MAAA,CAAO,eAAA;AAAA,QACxB,aAAa,MAAA,CAAO,WAAA;AAAA,QACpB,mBAAmB,MAAA,CAAO,iBAAA;AAAA,QAC1B,eAAe,MAAA,CAAO;AAAA,OACvB,CAAA;AAAA,IACH;AAEA,IAAA,IAAI,uBAAA,CAAwB,GAAA,CAAI,MAAA,CAAO,MAAM,CAAA,EAAG;AAC9C,MAAA,MAAM,MAAA,GAA2B;AAAA,QAC/B,WAAW,MAAA,CAAO,SAAA;AAAA,QAClB,QAAQ,MAAA,CAAO,MAAA;AAAA,QACf,aAAa,MAAA,CAAO,WAAA;AAAA,QACpB,mBAAmB,MAAA,CAAO,iBAAA;AAAA,QAC1B,iBAAiB,MAAA,CAAO,eAAA;AAAA,QACxB,eAAe,MAAA,CAAO;AAAA,OACxB;AACA,MAAA,OAAO,MAAA;AAAA,IACT;AAEA,IAAA,IAAI,IAAA,CAAK,GAAA,EAAI,GAAI,SAAA,IAAa,SAAA,EAAW;AACvC,MAAA,MAAM,cAAA,GAAmC;AAAA,QACvC,WAAW,MAAA,CAAO,SAAA;AAAA,QAClB,MAAA,EAAQ,WAAA;AAAA,QACR,aAAA,EAAe,2BAA2B,MAAA,CAAO,SAAS,CAAC,CAAA,iBAAA,EAAoB,MAAA,CAAO,MAAA,CAAO,MAAM,CAAC,CAAA,CAAA;AAAA,OACtG;AACA,MAAA,OAAO,cAAA;AAAA,IACT;AAEA,IAAA,MAAM,IAAI,OAAA,CAAc,CAAC,OAAA,KAAY;AACnC,MAAA,UAAA,CAAW,SAAS,iBAAiB,CAAA;AAAA,IACvC,CAAC,CAAA;AAAA,EACH;AACF;AA9DsB,MAAA,CAAA,sBAAA,EAAA,wBAAA,CAAA","file":"chunk-4RHXVBNI.js","sourcesContent":["/**\n * Relayer Module (V2 API).\n *\n * @remarks\n * This module provides the `getUmbraRelayer` factory for creating relayer instances\n * that interact with the Umbra relayer's V2 API. The relayer builds, signs, and\n * submits claim transactions on behalf of users.\n *\n * **What is the Relayer?**\n * The Umbra relayer is a semi-trusted intermediary that submits privacy-preserving\n * transactions on behalf of users. It receives cryptographic data (ZK proofs,\n * nullifiers, linker encryptions) and builds all Solana transactions server-side.\n *\n * **Trust Model (Semi-Trusted):**\n * The relayer is SEMI-TRUSTED. It can observe transaction contents (amounts,\n * mints, timing) because it must broadcast them. However, it CANNOT:\n * - Steal funds — ZK proofs and nullifier commitments prevent double-spending\n * - Forge signatures — Transactions use cryptographic commitments verified on-chain\n * - Link sender to recipient — Merkle commitments and ZK proofs sever that link\n *\n * **API Endpoints Used:**\n * - `GET /v1/relayer/info` — Get relayer address, supported mints, active pools\n * - `POST /v1/claims` — Submit a claim request (relayer builds transactions)\n * - `GET /v1/claims/{id}` — Poll claim status\n *\n * @packageDocumentation\n */\n\nimport { address, type Address } from \"@solana/kit\";\nimport type { U32 } from \"../types\";\nimport type {\n IUmbraRelayer,\n GetUmbraRelayerArgs,\n GetUmbraRelayerDeps,\n SupportedMintsResponse,\n ClaimRequest,\n ClaimSubmitResponse,\n ClaimStatusResponse,\n ClaimStatus,\n ClaimBatchResult,\n} from \"./interfaces\";\n\n// ============================================================================\n// Constants\n// ============================================================================\n\n/**\n * Canonical endpoint paths for all relayer API operations.\n * @internal\n */\nconst ENDPOINTS = {\n /** Fetches relayer address, supported mints, and active stealth pool indices. */\n RELAYER_INFO: `/v1/relayer/info`,\n /** Submits a claim request (relayer builds transactions from crypto data). */\n CLAIM_SUBMIT: `/v1/claims`,\n /** Polls claim status by request ID. `{id}` is replaced at call time. */\n CLAIM_STATUS: `/v1/claims/{id}`,\n} as const;\n\n// ============================================================================\n// Error Class\n// ============================================================================\n\n/**\n * Error class for relayer-related failures.\n *\n * @remarks\n * Thrown when relayer API calls fail due to network issues, invalid responses,\n * transaction rejections, or server errors. Provides structured fields for\n * programmatic error handling.\n *\n * @public\n */\nexport class RelayerError extends Error {\n /** The relayer operation that failed (e.g. `\"getRelayerAddress\"`, `\"claimSubmit\"`). */\n public readonly operation: string;\n /** HTTP status code if the server responded, `undefined` for transport errors. */\n public readonly statusCode: number | undefined;\n /** Machine-readable error code from the API error body. */\n public readonly errorCode: string | undefined;\n\n constructor(\n operation: string,\n message: string,\n statusCode?: number,\n errorCode?: string,\n cause?: Error,\n ) {\n super(`Relayer operation '${operation}' failed: ${message}`);\n this.name = \"RelayerError\";\n this.operation = operation;\n this.statusCode = statusCode;\n this.errorCode = errorCode;\n this.cause = cause;\n\n if (Error.captureStackTrace !== undefined) {\n Error.captureStackTrace(this, RelayerError);\n }\n }\n}\n\n// ============================================================================\n// Internal Types (API Response Shapes)\n// ============================================================================\n\n/** @internal */\ninterface ApiErrorResponse {\n error?: {\n code: string;\n message: string;\n };\n success?: false;\n error_code?: string;\n message?: string;\n}\n\n/** Shape of `GET /v1/relayer/info` response. @internal */\ninterface ApiRelayerInfoResponse {\n address: string;\n supported_mints: string[];\n active_stealth_pool_indices: string[];\n}\n\n/** Shape of `POST /v1/claims` response. @internal */\ninterface ApiClaimSubmitResponse {\n request_id: string;\n status: \"received\";\n}\n\n/** Shape of `GET /v1/claims/{id}` response. @internal */\ninterface ApiClaimStatusResponse {\n request_id: string;\n status: string;\n variant: string;\n resolved_variant?: string;\n tx_signature?: string;\n callback_signature?: string;\n computation_account?: string;\n failure_reason?: string | null;\n created_at: string;\n updated_at: string;\n}\n\n// ============================================================================\n// Internal Helpers\n// ============================================================================\n\n/**\n * Generic HTTP request helper with structured error handling.\n * @internal\n */\nasync function makeRequest<T>(\n endpoint: string,\n fetchImpl: typeof globalThis.fetch,\n options: {\n method?: \"GET\" | \"POST\";\n body?: unknown;\n operation: string;\n },\n): Promise<T> {\n const { method = \"GET\", body, operation } = options;\n\n try {\n const requestInit: RequestInit = {\n method,\n headers: {\n \"Content-Type\": \"application/json\",\n Accept: \"application/json\",\n },\n };\n if (body !== undefined) {\n requestInit.body = JSON.stringify(body);\n }\n const response = await fetchImpl(endpoint, requestInit);\n\n const data = (await response.json()) as T | ApiErrorResponse;\n\n if (!response.ok) {\n const errorData = data as ApiErrorResponse;\n const message =\n errorData.error?.message ?? errorData.message ?? `HTTP ${String(response.status)}`;\n const code = errorData.error?.code ?? errorData.error_code;\n throw new RelayerError(operation, message, response.status, code);\n }\n\n return data as T;\n } catch (error) {\n if (error instanceof RelayerError) {\n throw error;\n }\n throw new RelayerError(\n operation,\n error instanceof Error ? error.message : \"Unknown error\",\n undefined,\n undefined,\n error instanceof Error ? error : undefined,\n );\n }\n}\n\n/** Converts wire-format claim status response to SDK type. @internal */\nfunction convertClaimStatusResponse(api: ApiClaimStatusResponse): ClaimStatusResponse {\n return {\n requestId: api.request_id,\n status: api.status as ClaimStatus,\n variant: api.variant as ClaimStatusResponse[\"variant\"],\n resolvedVariant: api.resolved_variant,\n txSignature: api.tx_signature,\n callbackSignature: api.callback_signature,\n computationAccount: api.computation_account,\n failureReason: api.failure_reason,\n createdAt: api.created_at,\n updatedAt: api.updated_at,\n };\n}\n\n// ============================================================================\n// Core Relayer Factory\n// ============================================================================\n\n/**\n * Creates an Umbra relayer instance.\n *\n * @remarks\n * The returned `IUmbraRelayer` object provides all methods needed by claim\n * services: relayer info, claim submission, and status polling. Pass it\n * directly as the `relayer` dependency to any claim function.\n *\n * **Address caching:**\n * `getRelayerAddress()` and `getFeePayer()` cache the result after the first\n * HTTP call. The cache is per-instance.\n *\n * @param args - Required arguments\n * @param args.apiEndpoint - The base URL of the relayer API\n * @param deps - Optional dependencies for testing\n * @param deps.fetch - Custom fetch implementation; defaults to `globalThis.fetch`\n * @returns An {@link IUmbraRelayer} instance\n *\n * @example\n * ```typescript\n * const relayer = getUmbraRelayer({ apiEndpoint: \"https://relayer.umbra.finance\" });\n *\n * // Use directly with claim functions\n * const claim = getSelfClaimableUtxoToEncryptedBalanceClaimerFunction(\n * { client },\n * { zkProver, relayer },\n * );\n * ```\n *\n * @public\n */\nexport function getUmbraRelayer(\n args: GetUmbraRelayerArgs,\n deps?: GetUmbraRelayerDeps,\n): IUmbraRelayer {\n const { apiEndpoint } = args;\n const fetchImpl = deps?.fetch ?? globalThis.fetch;\n\n if (apiEndpoint === \"\") {\n throw new RelayerError(\"initialization\", \"apiEndpoint must be a non-empty string\");\n }\n\n const normalizedEndpoint = apiEndpoint.replace(/\\/$/, \"\");\n\n // Shared cache for relayer address (used by both getFeePayer and getRelayerAddress)\n let cachedAddress: Address | null = null;\n let cachedInfo: ApiRelayerInfoResponse | null = null;\n\n async function fetchInfo(): Promise<ApiRelayerInfoResponse> {\n if (cachedInfo !== null) {\n return cachedInfo;\n }\n const response = await makeRequest<ApiRelayerInfoResponse>(\n `${normalizedEndpoint}${ENDPOINTS.RELAYER_INFO}`,\n fetchImpl,\n { operation: \"getRelayerInfo\" },\n );\n cachedInfo = response;\n cachedAddress = address(response.address);\n return response;\n }\n\n return {\n apiEndpoint: normalizedEndpoint,\n\n async getFeePayer(): Promise<Address> {\n if (cachedAddress !== null) {\n return cachedAddress;\n }\n const info = await fetchInfo();\n return address(info.address);\n },\n\n async getRelayerAddress(): Promise<Address> {\n if (cachedAddress !== null) {\n return cachedAddress;\n }\n const info = await fetchInfo();\n return address(info.address);\n },\n\n async getSupportedMints(): Promise<SupportedMintsResponse> {\n const info = await fetchInfo();\n return {\n relayer: info.address,\n mints: info.supported_mints,\n count: BigInt(info.supported_mints.length) as U32,\n };\n },\n\n async submitClaim(request: ClaimRequest): Promise<ClaimSubmitResponse> {\n const response = await makeRequest<ApiClaimSubmitResponse>(\n `${normalizedEndpoint}${ENDPOINTS.CLAIM_SUBMIT}`,\n fetchImpl,\n { method: \"POST\", body: request, operation: \"claimSubmit\" },\n );\n return {\n requestId: response.request_id,\n status: response.status,\n };\n },\n\n async pollClaimStatus(requestId: string): Promise<ClaimStatusResponse> {\n const url = `${normalizedEndpoint}${ENDPOINTS.CLAIM_STATUS.replace(\"{id}\", requestId)}`;\n const response = await makeRequest<ApiClaimStatusResponse>(url, fetchImpl, {\n operation: \"claimStatus\",\n });\n return convertClaimStatusResponse(response);\n },\n };\n}\n\n// ============================================================================\n// Claim Polling Utility\n// ============================================================================\n\n/**\n * Terminal claim statuses. Polling stops when the status matches one of these.\n * @internal\n */\nconst TERMINAL_CLAIM_STATUSES: ReadonlySet<ClaimStatus> = new Set([\n \"completed\",\n \"failed\",\n \"timed_out\",\n]);\n\n/**\n * Polls a claim request until it reaches a terminal status or times out.\n *\n * @remarks\n * Terminal statuses are: `completed`, `failed`, `timed_out`.\n * The `onProgress` callback is invoked after each poll with the latest status.\n *\n * @param pollClaimStatus - Function to poll claim status\n * @param requestId - The claim request ID to poll\n * @param options - Polling configuration\n * @returns The final {@link ClaimBatchResult}\n *\n * @public\n */\nexport async function pollClaimUntilTerminal(\n pollClaimStatus: (requestId: string) => Promise<ClaimStatusResponse>,\n requestId: string,\n options?: {\n pollingIntervalMs?: number;\n timeoutMs?: number;\n onProgress?: (event: {\n readonly requestId: string;\n readonly status: ClaimStatus;\n readonly resolvedVariant?: string;\n readonly txSignature?: string;\n readonly callbackSignature?: string;\n readonly failureReason?: string | null;\n }) => void;\n },\n): Promise<ClaimBatchResult> {\n const pollingIntervalMs: number = options?.pollingIntervalMs ?? 3000;\n const timeoutMs: number = options?.timeoutMs ?? 120_000;\n const onProgress = options?.onProgress;\n\n const startTime: number = Date.now();\n\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- polling loop\n while (true) {\n const status: ClaimStatusResponse = await pollClaimStatus(requestId);\n\n if (onProgress !== undefined) {\n onProgress({\n requestId: status.requestId,\n status: status.status,\n resolvedVariant: status.resolvedVariant,\n txSignature: status.txSignature,\n callbackSignature: status.callbackSignature,\n failureReason: status.failureReason,\n });\n }\n\n if (TERMINAL_CLAIM_STATUSES.has(status.status)) {\n const result: ClaimBatchResult = {\n requestId: status.requestId,\n status: status.status,\n txSignature: status.txSignature,\n callbackSignature: status.callbackSignature,\n resolvedVariant: status.resolvedVariant,\n failureReason: status.failureReason,\n };\n return result;\n }\n\n if (Date.now() - startTime >= timeoutMs) {\n const timedOutResult: ClaimBatchResult = {\n requestId: status.requestId,\n status: \"timed_out\" as ClaimStatus,\n failureReason: `Polling timed out after ${String(timeoutMs)}ms (last status: ${String(status.status)})`,\n };\n return timedOutResult;\n }\n\n await new Promise<void>((resolve) => {\n setTimeout(resolve, pollingIntervalMs);\n });\n }\n}\n"]}
@@ -0,0 +1,324 @@
1
+ import { __name } from './chunk-7QVYU63E.js';
2
+
3
+ // src/common/errors.ts
4
+ var UmbraError = class _UmbraError extends Error {
5
+ static {
6
+ __name(this, "UmbraError");
7
+ }
8
+ /**
9
+ * A machine-readable error code for programmatic error handling.
10
+ *
11
+ * @remarks
12
+ * Defaults to `"UMBRA_ERROR"` when no code is supplied in the constructor options.
13
+ * Sub-classes or specific throw sites should supply a more specific code to allow
14
+ * callers to branch on error identity without string-matching `message`.
15
+ *
16
+ * @readonly
17
+ */
18
+ code;
19
+ /**
20
+ * Additional context about the error.
21
+ *
22
+ * @remarks
23
+ * A free-form key-value map of diagnostic data attached to the error at the throw site.
24
+ * Useful for logging and debugging — consumers should not rely on specific keys for
25
+ * control flow; use `code` for programmatic branching instead.
26
+ *
27
+ * Will be `undefined` when no context was provided to the constructor.
28
+ *
29
+ * @readonly
30
+ */
31
+ context;
32
+ /**
33
+ * The original error that caused this error, if any.
34
+ *
35
+ * @remarks
36
+ * When an SDK function wraps a lower-level error (e.g., a failed RPC call or a
37
+ * cryptographic library error), it sets `cause` to the original thrown value so
38
+ * callers can inspect the full error chain.
39
+ *
40
+ * Will be `undefined` when there is no underlying cause.
41
+ *
42
+ * @readonly
43
+ */
44
+ cause;
45
+ /**
46
+ * Creates a new UmbraError.
47
+ *
48
+ * @param message - Human-readable description of what went wrong. Should be
49
+ * actionable and specific enough for a developer to understand the failure
50
+ * without reading source code.
51
+ * @param options - Optional structured metadata attached to the error.
52
+ * @param options.code - Machine-readable error code for programmatic branching.
53
+ * Defaults to `"UMBRA_ERROR"` if omitted.
54
+ * @param options.context - Free-form diagnostic key-value pairs. Omit or set to
55
+ * `undefined` to leave the `context` property unset.
56
+ * @param options.cause - The original error that triggered this one. Enables
57
+ * full error-chain inspection. Omit or set to `undefined` when there is no
58
+ * underlying cause.
59
+ *
60
+ * @defaultValue `options` — `undefined` (all options optional)
61
+ * @defaultValue `options.code` — `"UMBRA_ERROR"`
62
+ */
63
+ constructor(message, options) {
64
+ super(message);
65
+ this.name = "UmbraError";
66
+ this.code = options?.code ?? "UMBRA_ERROR";
67
+ if (options?.context !== void 0) {
68
+ this.context = options.context;
69
+ }
70
+ if (options?.cause !== void 0) {
71
+ this.cause = options.cause;
72
+ }
73
+ Error.captureStackTrace(this, _UmbraError);
74
+ }
75
+ };
76
+ function isUmbraError(error) {
77
+ return error instanceof UmbraError;
78
+ }
79
+ __name(isUmbraError, "isUmbraError");
80
+ var MathematicsAssertionError = class _MathematicsAssertionError extends Error {
81
+ static {
82
+ __name(this, "MathematicsAssertionError");
83
+ }
84
+ /**
85
+ * The actual value that failed the assertion.
86
+ *
87
+ * @remarks
88
+ * The runtime type reflects what was actually passed to the assertion function:
89
+ * - `bigint` for integer assertions (`assertU8`, `assertU256`, etc.)
90
+ * - `Uint8Array` for byte-array assertions (`assertU256LeBytes`, `assertU32LeBytes`, etc.)
91
+ * - Any other type when a non-numeric value was passed unexpectedly
92
+ *
93
+ * @readonly
94
+ */
95
+ value;
96
+ /**
97
+ * The type that was expected.
98
+ *
99
+ * @remarks
100
+ * Contains the branded type name exactly as it appears in the SDK type system,
101
+ * e.g., `"U8"`, `"U256"`, `"U32LeBytes"`. Use this for structured logging or
102
+ * to build user-facing error messages without parsing the `message` string.
103
+ *
104
+ * @readonly
105
+ */
106
+ expectedType;
107
+ /**
108
+ * Description of the constraint that was violated.
109
+ *
110
+ * @remarks
111
+ * Is `undefined` when only a type check failed (e.g., a `string` was passed where a
112
+ * `bigint` was expected). Contains a human-readable inequality or length rule when a
113
+ * value of the correct type was out of the allowed range.
114
+ *
115
+ * @example
116
+ * - `"0 <= value <= 255"` — U8 range violation
117
+ * - `"length === 32"` — U256LeBytes length violation
118
+ * - `"value >= 0"` — negative value passed to an unsigned integer assertion
119
+ *
120
+ * @readonly
121
+ */
122
+ constraint;
123
+ /**
124
+ * Creates a new MathematicsAssertionError.
125
+ *
126
+ * @param message - Human-readable description of the assertion failure. Should name
127
+ * the assertion function, the expected type, and the constraint that was violated.
128
+ * @param options - Structured diagnostic details attached to the error.
129
+ * @param options.value - The actual value that was supplied and failed the assertion.
130
+ * @param options.expectedType - The name of the branded type that was expected
131
+ * (e.g., `"U8"`, `"U256LeBytes"`).
132
+ * @param options.constraint - Optional human-readable constraint description
133
+ * (e.g., `"0 <= value <= 255"`). Omit when the failure is a type mismatch rather
134
+ * than a range violation.
135
+ */
136
+ constructor(message, options) {
137
+ super(message);
138
+ this.name = "MathematicsAssertionError";
139
+ this.value = options.value;
140
+ this.expectedType = options.expectedType;
141
+ this.constraint = options.constraint;
142
+ Error.captureStackTrace(this, _MathematicsAssertionError);
143
+ Object.setPrototypeOf(this, _MathematicsAssertionError.prototype);
144
+ }
145
+ };
146
+ var CryptographyAssertionError = class _CryptographyAssertionError extends Error {
147
+ static {
148
+ __name(this, "CryptographyAssertionError");
149
+ }
150
+ /**
151
+ * The actual value that failed the assertion.
152
+ *
153
+ * @remarks
154
+ * The runtime type reflects what was actually passed to the assertion function:
155
+ * - `bigint` for field element assertions (`assertBn254FieldElement`, etc.)
156
+ * - `Uint8Array` for byte-array assertions (`assertAesKey`, `assertX25519PrivateKey`, etc.)
157
+ * - Any other type when an entirely wrong value type was supplied
158
+ *
159
+ * @readonly
160
+ */
161
+ value;
162
+ /**
163
+ * The type that was expected (e.g., `"Bn254FieldElement"`, `"PoseidonKey"`, `"AesKey"`).
164
+ *
165
+ * @remarks
166
+ * Contains the branded type name exactly as it appears in the SDK type system.
167
+ * Use this property for structured logging without parsing the `message` string.
168
+ *
169
+ * @readonly
170
+ */
171
+ expectedType;
172
+ /**
173
+ * Description of the constraint that was violated.
174
+ *
175
+ * @remarks
176
+ * Is `undefined` for pure type-mismatch failures (e.g., `string` instead of `bigint`).
177
+ * Contains a human-readable constraint description for range and length violations
178
+ * (e.g., `"value < BN254_FIELD_PRIME"`, `"length === 32"`).
179
+ *
180
+ * @readonly
181
+ */
182
+ constraint;
183
+ /**
184
+ * Creates a new CryptographyAssertionError.
185
+ *
186
+ * @param message - Human-readable description of the assertion failure. Should name
187
+ * the assertion function, the expected type, and the constraint that was violated.
188
+ * @param options - Structured diagnostic details attached to the error.
189
+ * @param options.value - The actual value that was supplied and failed the assertion.
190
+ * @param options.expectedType - The name of the branded cryptographic type that was
191
+ * expected (e.g., `"Bn254FieldElement"`, `"AesKey"`).
192
+ * @param options.constraint - Optional human-readable constraint description.
193
+ * Omit when the failure is a type mismatch rather than a range or length violation.
194
+ */
195
+ constructor(message, options) {
196
+ super(message);
197
+ this.name = "CryptographyAssertionError";
198
+ this.value = options.value;
199
+ this.expectedType = options.expectedType;
200
+ this.constraint = options.constraint;
201
+ Error.captureStackTrace(this, _CryptographyAssertionError);
202
+ Object.setPrototypeOf(this, _CryptographyAssertionError.prototype);
203
+ }
204
+ };
205
+ var SolanaAssertionError = class _SolanaAssertionError extends Error {
206
+ static {
207
+ __name(this, "SolanaAssertionError");
208
+ }
209
+ /**
210
+ * The actual value that failed the assertion.
211
+ *
212
+ * @remarks
213
+ * The runtime type reflects what was actually passed to the assertion function:
214
+ * - `string` for Base58-encoded assertions (`assertTransactionSignature`, etc.)
215
+ * - `Uint8Array` for byte-array assertions (`assertSignatureBytes`, etc.)
216
+ * - Any other type when a completely wrong value type was supplied
217
+ *
218
+ * @readonly
219
+ */
220
+ value;
221
+ /**
222
+ * The type that was expected (e.g., `"TransactionSignature"`, `"SignatureBytes"`).
223
+ *
224
+ * @remarks
225
+ * Contains the branded type name exactly as it appears in the SDK type system.
226
+ * Use this for structured logging without parsing the `message` string.
227
+ *
228
+ * @readonly
229
+ */
230
+ expectedType;
231
+ /**
232
+ * Description of the constraint that was violated.
233
+ *
234
+ * @remarks
235
+ * Is `undefined` for pure type-mismatch failures. Contains a human-readable rule
236
+ * for encoding or length violations (e.g., `"valid Base58"`, `"length === 64"`).
237
+ *
238
+ * @readonly
239
+ */
240
+ constraint;
241
+ /**
242
+ * Creates a new SolanaAssertionError.
243
+ *
244
+ * @param message - Human-readable description of the assertion failure. Should name
245
+ * the assertion function, the expected type, and the constraint that was violated.
246
+ * @param options - Structured diagnostic details attached to the error.
247
+ * @param options.value - The actual value that was supplied and failed the assertion.
248
+ * @param options.expectedType - The name of the branded Solana type that was expected
249
+ * (e.g., `"TransactionSignature"`, `"SignatureBytes"`).
250
+ * @param options.constraint - Optional human-readable constraint description.
251
+ * Omit when the failure is a type mismatch rather than an encoding or length violation.
252
+ */
253
+ constructor(message, options) {
254
+ super(message);
255
+ this.name = "SolanaAssertionError";
256
+ this.value = options.value;
257
+ this.expectedType = options.expectedType;
258
+ this.constraint = options.constraint;
259
+ Error.captureStackTrace(this, _SolanaAssertionError);
260
+ Object.setPrototypeOf(this, _SolanaAssertionError.prototype);
261
+ }
262
+ };
263
+ var TemporalAssertionError = class extends Error {
264
+ static {
265
+ __name(this, "TemporalAssertionError");
266
+ }
267
+ /**
268
+ * The actual value that failed the assertion.
269
+ *
270
+ * @remarks
271
+ * Will be a `bigint` for all temporal assertions since the temporal types are
272
+ * BigInt-backed branded types (e.g., `Year`, `Month`, `Day`). May also be any
273
+ * other type when a non-bigint value was supplied unexpectedly.
274
+ *
275
+ * @readonly
276
+ */
277
+ value;
278
+ /**
279
+ * The type that was expected (e.g., `"Year"`, `"Month"`, `"Hour"`).
280
+ *
281
+ * @remarks
282
+ * Contains the branded temporal type name exactly as it appears in the SDK type system.
283
+ * Use this for structured logging without parsing the `message` string.
284
+ *
285
+ * @readonly
286
+ */
287
+ expectedType;
288
+ /**
289
+ * Description of the constraint that was violated.
290
+ *
291
+ * @remarks
292
+ * Contains a human-readable range rule for out-of-range values
293
+ * (e.g., `"1 <= value <= 12"` for a month violation). Is `undefined` only for
294
+ * pure type-mismatch failures (e.g., a `string` passed where a `bigint` was expected),
295
+ * which should not occur in normal usage.
296
+ *
297
+ * @readonly
298
+ */
299
+ constraint;
300
+ /**
301
+ * Creates a new TemporalAssertionError.
302
+ *
303
+ * @param message - Human-readable description of the assertion failure. Should name
304
+ * the assertion function, the expected type, and the violated range constraint.
305
+ * @param details - Structured diagnostic details attached to the error.
306
+ * @param details.value - The actual `bigint` value (or other type) that was supplied
307
+ * and failed the temporal assertion.
308
+ * @param details.expectedType - The name of the branded temporal type that was expected
309
+ * (e.g., `"Year"`, `"Month"`, `"Hour"`).
310
+ * @param details.constraint - Optional human-readable range description
311
+ * (e.g., `"1 <= value <= 12"`). Omit when the failure is a type mismatch.
312
+ */
313
+ constructor(message, details) {
314
+ super(message);
315
+ this.name = "TemporalAssertionError";
316
+ this.value = details.value;
317
+ this.expectedType = details.expectedType;
318
+ this.constraint = details.constraint;
319
+ }
320
+ };
321
+
322
+ export { CryptographyAssertionError, MathematicsAssertionError, SolanaAssertionError, TemporalAssertionError, UmbraError, isUmbraError };
323
+ //# sourceMappingURL=chunk-4TZVXB5G.js.map
324
+ //# sourceMappingURL=chunk-4TZVXB5G.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/common/errors.ts"],"names":[],"mappings":";;;AAqEO,IAAM,UAAA,GAAN,MAAM,WAAA,SAAmB,KAAA,CAAM;AAAA,EArEtC;AAqEsC,IAAA,MAAA,CAAA,IAAA,EAAA,YAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAW3B,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,OAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcS,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoBlB,WAAA,CACE,SACA,OAAA,EAKA;AACA,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,YAAA;AACZ,IAAA,IAAA,CAAK,IAAA,GAAO,SAAS,IAAA,IAAQ,aAAA;AAC7B,IAAA,IAAI,OAAA,EAAS,YAAY,MAAA,EAAW;AAClC,MAAA,IAAA,CAAK,UAAU,OAAA,CAAQ,OAAA;AAAA,IACzB;AACA,IAAA,IAAI,OAAA,EAAS,UAAU,MAAA,EAAW;AAChC,MAAA,IAAA,CAAK,QAAQ,OAAA,CAAQ,KAAA;AAAA,IACvB;AAGA,IAAA,KAAA,CAAM,iBAAA,CAAkB,MAAM,WAAU,CAAA;AAAA,EAC1C;AACF;AAgCO,SAAS,aAAa,KAAA,EAAqC;AAChE,EAAA,OAAO,KAAA,YAAiB,UAAA;AAC1B;AAFgB,MAAA,CAAA,YAAA,EAAA,cAAA,CAAA;AAuET,IAAM,yBAAA,GAAN,MAAM,0BAAA,SAAkC,KAAA,CAAM;AAAA,EA5PrD;AA4PqD,IAAA,MAAA,CAAA,IAAA,EAAA,2BAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYnC,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,YAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAehB,WAAA,CACE,SACA,OAAA,EAKA;AACA,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,2BAAA;AACZ,IAAA,IAAA,CAAK,QAAQ,OAAA,CAAQ,KAAA;AACrB,IAAA,IAAA,CAAK,eAAe,OAAA,CAAQ,YAAA;AAC5B,IAAA,IAAA,CAAK,aAAa,OAAA,CAAQ,UAAA;AAG1B,IAAA,KAAA,CAAM,iBAAA,CAAkB,MAAM,0BAAyB,CAAA;AAGvD,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,0BAAA,CAA0B,SAAS,CAAA;AAAA,EACjE;AACF;AA6DO,IAAM,0BAAA,GAAN,MAAM,2BAAA,SAAmC,KAAA,CAAM;AAAA,EArYtD;AAqYsD,IAAA,MAAA,CAAA,IAAA,EAAA,4BAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYpC,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,YAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAchB,WAAA,CACE,SACA,OAAA,EAKA;AACA,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,4BAAA;AACZ,IAAA,IAAA,CAAK,QAAQ,OAAA,CAAQ,KAAA;AACrB,IAAA,IAAA,CAAK,eAAe,OAAA,CAAQ,YAAA;AAC5B,IAAA,IAAA,CAAK,aAAa,OAAA,CAAQ,UAAA;AAE1B,IAAA,KAAA,CAAM,iBAAA,CAAkB,MAAM,2BAA0B,CAAA;AAExD,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,2BAAA,CAA2B,SAAS,CAAA;AAAA,EAClE;AACF;AA2DO,IAAM,oBAAA,GAAN,MAAM,qBAAA,SAA6B,KAAA,CAAM;AAAA,EAngBhD;AAmgBgD,IAAA,MAAA,CAAA,IAAA,EAAA,sBAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAY9B,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,YAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAchB,WAAA,CACE,SACA,OAAA,EAKA;AACA,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,sBAAA;AACZ,IAAA,IAAA,CAAK,QAAQ,OAAA,CAAQ,KAAA;AACrB,IAAA,IAAA,CAAK,eAAe,OAAA,CAAQ,YAAA;AAC5B,IAAA,IAAA,CAAK,aAAa,OAAA,CAAQ,UAAA;AAE1B,IAAA,KAAA,CAAM,iBAAA,CAAkB,MAAM,qBAAoB,CAAA;AAElD,IAAA,MAAA,CAAO,cAAA,CAAe,IAAA,EAAM,qBAAA,CAAqB,SAAS,CAAA;AAAA,EAC5D;AACF;AAgEO,IAAM,sBAAA,GAAN,cAAqC,KAAA,CAAM;AAAA,EAroBlD;AAqoBkD,IAAA,MAAA,CAAA,IAAA,EAAA,wBAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWhC,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,YAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAehB,WAAA,CACE,SACA,OAAA,EAKA;AACA,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,wBAAA;AACZ,IAAA,IAAA,CAAK,QAAQ,OAAA,CAAQ,KAAA;AACrB,IAAA,IAAA,CAAK,eAAe,OAAA,CAAQ,YAAA;AAC5B,IAAA,IAAA,CAAK,aAAa,OAAA,CAAQ,UAAA;AAAA,EAC5B;AACF","file":"chunk-4TZVXB5G.js","sourcesContent":["/**\n * Error Classes\n *\n * Centralized error hierarchy for the Umbra SDK.\n * Contains the base `UmbraError` and all domain-specific assertion error classes.\n *\n * @remarks\n * The SDK uses a two-level error hierarchy:\n *\n * 1. `UmbraError` — top-level base class for all SDK errors. Consumers can use\n * `instanceof UmbraError` (or the `isUmbraError` type guard) to distinguish SDK errors\n * from third-party or built-in errors in a catch block.\n *\n * 2. Domain assertion errors — thrown by type-assertion functions when a value fails\n * validation. Each domain has its own class to make it easy to catch errors from a\n * specific subsystem:\n * - `MathematicsAssertionError` — thrown by `assertU8`, `assertU256`, etc.\n * - `CryptographyAssertionError` — thrown by `assertBn254FieldElement`, `assertAesKey`, etc.\n * - `SolanaAssertionError` — thrown by Solana-type assertion functions.\n * - `TemporalAssertionError` — thrown by `assertYear`, `assertMonth`, etc.\n *\n * All four assertion error classes share the same three properties:\n * - `value` — the actual value that failed\n * - `expectedType` — the name of the expected branded type\n * - `constraint` — optional human-readable constraint description\n *\n * @packageDocumentation\n * @since 2.0.0\n * @module common/errors\n */\n\n/* =============================================================================\n * BASE ERROR\n *\n * The root error class for all Umbra SDK errors.\n * ============================================================================= */\n\n/**\n * Base error class for all Umbra SDK errors.\n *\n * All errors thrown by the SDK extend this class, allowing consumers\n * to distinguish SDK errors from other errors using `instanceof`.\n *\n * @remarks\n * Prefer using the `isUmbraError` type guard over `instanceof UmbraError` when writing\n * defensive catch handlers — the type guard also works across module boundaries and\n * iframe/realm boundaries where `instanceof` may fail due to different class references.\n *\n * Sub-classes (domain assertion errors) extend this class so callers can catch either\n * all SDK errors at once (`instanceof UmbraError`) or only a specific domain's failures\n * (e.g., `instanceof MathematicsAssertionError`).\n *\n * @example\n * ```typescript\n * try {\n * await umbraClient.register();\n * } catch (error) {\n * if (error instanceof UmbraError) {\n * console.log('SDK error:', error.message);\n * console.log('Error code:', error.code);\n * } else {\n * throw error; // Re-throw non-SDK errors\n * }\n * }\n * ```\n *\n * @see {@link isUmbraError}\n * @public\n */\nexport class UmbraError extends Error {\n /**\n * A machine-readable error code for programmatic error handling.\n *\n * @remarks\n * Defaults to `\"UMBRA_ERROR\"` when no code is supplied in the constructor options.\n * Sub-classes or specific throw sites should supply a more specific code to allow\n * callers to branch on error identity without string-matching `message`.\n *\n * @readonly\n */\n readonly code: string;\n\n /**\n * Additional context about the error.\n *\n * @remarks\n * A free-form key-value map of diagnostic data attached to the error at the throw site.\n * Useful for logging and debugging — consumers should not rely on specific keys for\n * control flow; use `code` for programmatic branching instead.\n *\n * Will be `undefined` when no context was provided to the constructor.\n *\n * @readonly\n */\n readonly context?: Record<string, unknown>;\n\n /**\n * The original error that caused this error, if any.\n *\n * @remarks\n * When an SDK function wraps a lower-level error (e.g., a failed RPC call or a\n * cryptographic library error), it sets `cause` to the original thrown value so\n * callers can inspect the full error chain.\n *\n * Will be `undefined` when there is no underlying cause.\n *\n * @readonly\n */\n override readonly cause?: unknown;\n\n /**\n * Creates a new UmbraError.\n *\n * @param message - Human-readable description of what went wrong. Should be\n * actionable and specific enough for a developer to understand the failure\n * without reading source code.\n * @param options - Optional structured metadata attached to the error.\n * @param options.code - Machine-readable error code for programmatic branching.\n * Defaults to `\"UMBRA_ERROR\"` if omitted.\n * @param options.context - Free-form diagnostic key-value pairs. Omit or set to\n * `undefined` to leave the `context` property unset.\n * @param options.cause - The original error that triggered this one. Enables\n * full error-chain inspection. Omit or set to `undefined` when there is no\n * underlying cause.\n *\n * @defaultValue `options` — `undefined` (all options optional)\n * @defaultValue `options.code` — `\"UMBRA_ERROR\"`\n */\n constructor(\n message: string,\n options?: {\n code?: string;\n context?: Record<string, unknown>;\n cause?: unknown;\n },\n ) {\n super(message);\n this.name = \"UmbraError\";\n this.code = options?.code ?? \"UMBRA_ERROR\";\n if (options?.context !== undefined) {\n this.context = options.context;\n }\n if (options?.cause !== undefined) {\n this.cause = options.cause;\n }\n\n // Maintains proper stack trace for where our error was thrown (only available on V8)\n Error.captureStackTrace(this, UmbraError);\n }\n}\n\n/**\n * Type guard to check if an error is an UmbraError.\n *\n * @remarks\n * Prefer this guard over `error instanceof UmbraError` in generic catch handlers because\n * it is safe to call with any value (including `null`, primitives, and non-Error objects)\n * and narrows the type to `UmbraError` for TypeScript's type system in the true branch.\n *\n * @param error - The value to test. Typically the caught value in a `catch (error)` block,\n * typed as `unknown`.\n * @returns `true` and narrows `error` to `UmbraError` when the value is an instance of\n * `UmbraError` (or any sub-class such as `MathematicsAssertionError`). Returns `false`\n * for all other values.\n *\n * @example\n * ```typescript\n * try {\n * await operation();\n * } catch (error) {\n * if (isUmbraError(error)) {\n * // error is narrowed to UmbraError here\n * console.log('SDK error code:', error.code);\n * console.log('SDK error context:', error.context);\n * }\n * }\n * ```\n *\n * @see {@link UmbraError}\n * @public\n */\nexport function isUmbraError(error: unknown): error is UmbraError {\n return error instanceof UmbraError;\n}\n\n/* =============================================================================\n * MATHEMATICS ASSERTION ERROR\n *\n * Error thrown when mathematical type assertions fail.\n * ============================================================================= */\n\n/**\n * Error thrown when a value fails a mathematical type assertion.\n *\n * This error provides detailed information about why an assertion failed,\n * including the actual value, the expected type, and the constraint that\n * was violated.\n *\n * @remarks\n * All assertion functions in the mathematics module (e.g., `assertU8`, `assertU256`,\n * `assertU32LeBytes`) throw this error type on failure. Catch it specifically to handle\n * mathematical type validation failures differently from cryptographic or Solana errors.\n *\n * The three diagnostic properties together allow automated logging pipelines to produce\n * structured records without parsing the `message` string:\n * - `value` — the actual value that was supplied\n * - `expectedType` — the branded type name (e.g., `\"U8\"`, `\"U256LeBytes\"`)\n * - `constraint` — the violated range or length rule, or `undefined` for type mismatches\n *\n * Note that this class does NOT extend `UmbraError`. It extends `Error` directly to keep\n * the assertion error classes lightweight and independent of the UmbraError hierarchy.\n * Use `isUmbraError` only to detect top-level SDK operational errors; use\n * `instanceof MathematicsAssertionError` for assertion failures.\n *\n * @example\n * ```typescript\n * import { assertU8, MathematicsAssertionError } from \"./mathematics\";\n *\n * try {\n * const value = assertU8(256n); // Will throw\n * } catch (error) {\n * if (error instanceof MathematicsAssertionError) {\n * console.error(`Assertion failed for ${error.expectedType}`);\n * console.error(`Value: ${error.value}`);\n * console.error(`Constraint: ${error.constraint}`);\n * // Output:\n * // Assertion failed for U8\n * // Value: 256\n * // Constraint: 0 <= value <= 255\n * }\n * }\n * ```\n *\n * @example\n * ```typescript\n * // Safe parse pattern — returns null instead of throwing\n * function safeParseU8(value: bigint): U8 | null {\n * try {\n * return assertU8(value);\n * } catch (error) {\n * if (error instanceof MathematicsAssertionError) {\n * console.warn(`Invalid U8 value: ${value}`);\n * return null;\n * }\n * throw error; // Re-throw unexpected errors\n * }\n * }\n * ```\n *\n * @sealed\n * @public\n */\nexport class MathematicsAssertionError extends Error {\n /**\n * The actual value that failed the assertion.\n *\n * @remarks\n * The runtime type reflects what was actually passed to the assertion function:\n * - `bigint` for integer assertions (`assertU8`, `assertU256`, etc.)\n * - `Uint8Array` for byte-array assertions (`assertU256LeBytes`, `assertU32LeBytes`, etc.)\n * - Any other type when a non-numeric value was passed unexpectedly\n *\n * @readonly\n */\n public readonly value: unknown;\n\n /**\n * The type that was expected.\n *\n * @remarks\n * Contains the branded type name exactly as it appears in the SDK type system,\n * e.g., `\"U8\"`, `\"U256\"`, `\"U32LeBytes\"`. Use this for structured logging or\n * to build user-facing error messages without parsing the `message` string.\n *\n * @readonly\n */\n public readonly expectedType: string;\n\n /**\n * Description of the constraint that was violated.\n *\n * @remarks\n * Is `undefined` when only a type check failed (e.g., a `string` was passed where a\n * `bigint` was expected). Contains a human-readable inequality or length rule when a\n * value of the correct type was out of the allowed range.\n *\n * @example\n * - `\"0 <= value <= 255\"` — U8 range violation\n * - `\"length === 32\"` — U256LeBytes length violation\n * - `\"value >= 0\"` — negative value passed to an unsigned integer assertion\n *\n * @readonly\n */\n public readonly constraint: string | undefined;\n\n /**\n * Creates a new MathematicsAssertionError.\n *\n * @param message - Human-readable description of the assertion failure. Should name\n * the assertion function, the expected type, and the constraint that was violated.\n * @param options - Structured diagnostic details attached to the error.\n * @param options.value - The actual value that was supplied and failed the assertion.\n * @param options.expectedType - The name of the branded type that was expected\n * (e.g., `\"U8\"`, `\"U256LeBytes\"`).\n * @param options.constraint - Optional human-readable constraint description\n * (e.g., `\"0 <= value <= 255\"`). Omit when the failure is a type mismatch rather\n * than a range violation.\n */\n constructor(\n message: string,\n options: {\n value: unknown;\n expectedType: string;\n constraint?: string;\n },\n ) {\n super(message);\n this.name = \"MathematicsAssertionError\";\n this.value = options.value;\n this.expectedType = options.expectedType;\n this.constraint = options.constraint;\n\n // Maintains proper stack trace for where our error was thrown (V8 only)\n Error.captureStackTrace(this, MathematicsAssertionError);\n\n // Set the prototype explicitly for proper instanceof checks\n Object.setPrototypeOf(this, MathematicsAssertionError.prototype);\n }\n}\n\n/* =============================================================================\n * CRYPTOGRAPHY ASSERTION ERROR\n *\n * Error thrown when cryptographic type assertions fail.\n * ============================================================================= */\n\n/**\n * Error thrown when a value fails a cryptographic type assertion.\n *\n * This error provides detailed information about why an assertion failed,\n * including the actual value, the expected type, and the constraint that\n * was violated.\n *\n * @remarks\n * Thrown by assertion functions in the cryptography module, such as\n * `assertBn254FieldElement`, `assertAesKey`, `assertX25519PrivateKey`, and similar.\n * Each function validates that a value conforms to a branded cryptographic type,\n * throwing this error with a precise `expectedType` and `constraint` when it does not.\n *\n * Common reasons for failure:\n * - A `bigint` field element exceeds the BN254 or Curve25519 field prime\n * - A byte array has the wrong length (e.g., a 31-byte array passed as an AES-256 key)\n * - A wrong JavaScript type was supplied (e.g., a `number` instead of a `bigint`)\n *\n * @example\n * ```typescript\n * import { assertBn254FieldElement, CryptographyAssertionError } from \"./cryptography\";\n *\n * try {\n * assertBn254FieldElement(invalidValue); // Will throw\n * } catch (error) {\n * if (error instanceof CryptographyAssertionError) {\n * console.error(`Assertion failed for ${error.expectedType}`);\n * console.error(`Value: ${error.value}`);\n * console.error(`Constraint: ${error.constraint}`);\n * }\n * }\n * ```\n *\n * @example\n * ```typescript\n * // Distinguish cryptographic assertion failures from mathematical ones\n * try {\n * const key = assertAesKey(rawBytes);\n * } catch (error) {\n * if (error instanceof CryptographyAssertionError) {\n * console.warn(\"Crypto assertion failed:\", error.expectedType, error.constraint);\n * } else if (error instanceof MathematicsAssertionError) {\n * console.warn(\"Math assertion failed:\", error.expectedType, error.constraint);\n * }\n * }\n * ```\n *\n * @see {@link MathematicsAssertionError}\n * @see {@link SolanaAssertionError}\n * @see {@link TemporalAssertionError}\n * @sealed\n * @public\n */\nexport class CryptographyAssertionError extends Error {\n /**\n * The actual value that failed the assertion.\n *\n * @remarks\n * The runtime type reflects what was actually passed to the assertion function:\n * - `bigint` for field element assertions (`assertBn254FieldElement`, etc.)\n * - `Uint8Array` for byte-array assertions (`assertAesKey`, `assertX25519PrivateKey`, etc.)\n * - Any other type when an entirely wrong value type was supplied\n *\n * @readonly\n */\n public readonly value: unknown;\n\n /**\n * The type that was expected (e.g., `\"Bn254FieldElement\"`, `\"PoseidonKey\"`, `\"AesKey\"`).\n *\n * @remarks\n * Contains the branded type name exactly as it appears in the SDK type system.\n * Use this property for structured logging without parsing the `message` string.\n *\n * @readonly\n */\n public readonly expectedType: string;\n\n /**\n * Description of the constraint that was violated.\n *\n * @remarks\n * Is `undefined` for pure type-mismatch failures (e.g., `string` instead of `bigint`).\n * Contains a human-readable constraint description for range and length violations\n * (e.g., `\"value < BN254_FIELD_PRIME\"`, `\"length === 32\"`).\n *\n * @readonly\n */\n public readonly constraint: string | undefined;\n\n /**\n * Creates a new CryptographyAssertionError.\n *\n * @param message - Human-readable description of the assertion failure. Should name\n * the assertion function, the expected type, and the constraint that was violated.\n * @param options - Structured diagnostic details attached to the error.\n * @param options.value - The actual value that was supplied and failed the assertion.\n * @param options.expectedType - The name of the branded cryptographic type that was\n * expected (e.g., `\"Bn254FieldElement\"`, `\"AesKey\"`).\n * @param options.constraint - Optional human-readable constraint description.\n * Omit when the failure is a type mismatch rather than a range or length violation.\n */\n constructor(\n message: string,\n options: {\n value: unknown;\n expectedType: string;\n constraint?: string;\n },\n ) {\n super(message);\n this.name = \"CryptographyAssertionError\";\n this.value = options.value;\n this.expectedType = options.expectedType;\n this.constraint = options.constraint;\n\n Error.captureStackTrace(this, CryptographyAssertionError);\n\n Object.setPrototypeOf(this, CryptographyAssertionError.prototype);\n }\n}\n\n/* =============================================================================\n * SOLANA ASSERTION ERROR\n *\n * Error thrown when Solana type assertions fail.\n * ============================================================================= */\n\n/**\n * Error thrown when a Solana type assertion fails.\n *\n * This error provides detailed information about why the assertion failed,\n * including the actual value, expected type, and constraint that was violated.\n *\n * @remarks\n * Thrown by assertion functions for Solana-specific branded types, such as\n * `assertTransactionSignature`, `assertSignatureBytes`, and similar validators.\n * These assertions verify that string or byte-array values conform to Solana's\n * encoding and length conventions (e.g., Base58-encoded 64-byte Ed25519 signatures).\n *\n * Common reasons for failure:\n * - A string that fails Base58 decoding or has the wrong decoded length\n * - A `Uint8Array` with the wrong byte length for a signature or public key\n * - A wrong JavaScript type (e.g., `number` instead of `string`)\n *\n * @example\n * ```typescript\n * import { assertTransactionSignature, SolanaAssertionError } from \"./solana\";\n *\n * try {\n * assertTransactionSignature(\"invalid!signature\"); // Will throw\n * } catch (error) {\n * if (error instanceof SolanaAssertionError) {\n * console.error(`Assertion failed for ${error.expectedType}`);\n * console.error(`Value: ${error.value}`);\n * console.error(`Constraint: ${error.constraint}`);\n * }\n * }\n * ```\n *\n * @example\n * ```typescript\n * // Safe parse pattern — returns null on failure\n * function tryParseSignature(raw: unknown): TransactionSignature | null {\n * try {\n * return assertTransactionSignature(raw);\n * } catch (error) {\n * if (error instanceof SolanaAssertionError) return null;\n * throw error;\n * }\n * }\n * ```\n *\n * @see {@link MathematicsAssertionError}\n * @see {@link CryptographyAssertionError}\n * @see {@link TemporalAssertionError}\n * @sealed\n * @public\n */\nexport class SolanaAssertionError extends Error {\n /**\n * The actual value that failed the assertion.\n *\n * @remarks\n * The runtime type reflects what was actually passed to the assertion function:\n * - `string` for Base58-encoded assertions (`assertTransactionSignature`, etc.)\n * - `Uint8Array` for byte-array assertions (`assertSignatureBytes`, etc.)\n * - Any other type when a completely wrong value type was supplied\n *\n * @readonly\n */\n public readonly value: unknown;\n\n /**\n * The type that was expected (e.g., `\"TransactionSignature\"`, `\"SignatureBytes\"`).\n *\n * @remarks\n * Contains the branded type name exactly as it appears in the SDK type system.\n * Use this for structured logging without parsing the `message` string.\n *\n * @readonly\n */\n public readonly expectedType: string;\n\n /**\n * Description of the constraint that was violated.\n *\n * @remarks\n * Is `undefined` for pure type-mismatch failures. Contains a human-readable rule\n * for encoding or length violations (e.g., `\"valid Base58\"`, `\"length === 64\"`).\n *\n * @readonly\n */\n public readonly constraint: string | undefined;\n\n /**\n * Creates a new SolanaAssertionError.\n *\n * @param message - Human-readable description of the assertion failure. Should name\n * the assertion function, the expected type, and the constraint that was violated.\n * @param options - Structured diagnostic details attached to the error.\n * @param options.value - The actual value that was supplied and failed the assertion.\n * @param options.expectedType - The name of the branded Solana type that was expected\n * (e.g., `\"TransactionSignature\"`, `\"SignatureBytes\"`).\n * @param options.constraint - Optional human-readable constraint description.\n * Omit when the failure is a type mismatch rather than an encoding or length violation.\n */\n constructor(\n message: string,\n options: {\n value: unknown;\n expectedType: string;\n constraint?: string;\n },\n ) {\n super(message);\n this.name = \"SolanaAssertionError\";\n this.value = options.value;\n this.expectedType = options.expectedType;\n this.constraint = options.constraint;\n\n Error.captureStackTrace(this, SolanaAssertionError);\n\n Object.setPrototypeOf(this, SolanaAssertionError.prototype);\n }\n}\n\n/* =============================================================================\n * TEMPORAL ASSERTION ERROR\n *\n * Error thrown when temporal type assertions fail.\n * ============================================================================= */\n\n/**\n * Error thrown when a temporal type assertion fails.\n *\n * This error provides detailed information about why an assertion failed,\n * including the actual value, the expected type, and the constraint that\n * was violated.\n *\n * @remarks\n * Thrown by assertion functions for branded temporal types: `assertYear`, `assertMonth`,\n * `assertDay`, `assertHour`, `assertMinute`, and `assertSecond`. These functions validate\n * that a `bigint` value falls within the calendar range appropriate for each component\n * (e.g., months must be in `[1, 12]`, hours in `[0, 23]`).\n *\n * Temporal assertions are used to validate the output of UTC timestamp extraction before\n * the components are used in time-scoped viewing key derivation. In normal operation they\n * should never throw (JavaScript's `Date` always produces in-range values), but callers\n * that construct components manually can encounter these errors.\n *\n * @example\n * ```typescript\n * import { assertMonth, TemporalAssertionError } from \"./temporal\";\n *\n * try {\n * assertMonth(13n); // Will throw — month must be 1–12\n * } catch (error) {\n * if (error instanceof TemporalAssertionError) {\n * console.error(`Assertion failed for ${error.expectedType}`);\n * console.error(`Value: ${error.value}`);\n * console.error(`Constraint: ${error.constraint}`);\n * // Output:\n * // Assertion failed for Month\n * // Value: 13\n * // Constraint: 1 <= value <= 12\n * }\n * }\n * ```\n *\n * @example\n * ```typescript\n * // Safe parse of a user-supplied year value\n * function tryParseYear(raw: bigint): Year | null {\n * try {\n * return assertYear(raw);\n * } catch (error) {\n * if (error instanceof TemporalAssertionError) return null;\n * throw error;\n * }\n * }\n * ```\n *\n * @see {@link MathematicsAssertionError}\n * @see {@link CryptographyAssertionError}\n * @see {@link SolanaAssertionError}\n * @sealed\n * @public\n */\nexport class TemporalAssertionError extends Error {\n /**\n * The actual value that failed the assertion.\n *\n * @remarks\n * Will be a `bigint` for all temporal assertions since the temporal types are\n * BigInt-backed branded types (e.g., `Year`, `Month`, `Day`). May also be any\n * other type when a non-bigint value was supplied unexpectedly.\n *\n * @readonly\n */\n public readonly value: unknown;\n\n /**\n * The type that was expected (e.g., `\"Year\"`, `\"Month\"`, `\"Hour\"`).\n *\n * @remarks\n * Contains the branded temporal type name exactly as it appears in the SDK type system.\n * Use this for structured logging without parsing the `message` string.\n *\n * @readonly\n */\n public readonly expectedType: string;\n\n /**\n * Description of the constraint that was violated.\n *\n * @remarks\n * Contains a human-readable range rule for out-of-range values\n * (e.g., `\"1 <= value <= 12\"` for a month violation). Is `undefined` only for\n * pure type-mismatch failures (e.g., a `string` passed where a `bigint` was expected),\n * which should not occur in normal usage.\n *\n * @readonly\n */\n public readonly constraint: string | undefined;\n\n /**\n * Creates a new TemporalAssertionError.\n *\n * @param message - Human-readable description of the assertion failure. Should name\n * the assertion function, the expected type, and the violated range constraint.\n * @param details - Structured diagnostic details attached to the error.\n * @param details.value - The actual `bigint` value (or other type) that was supplied\n * and failed the temporal assertion.\n * @param details.expectedType - The name of the branded temporal type that was expected\n * (e.g., `\"Year\"`, `\"Month\"`, `\"Hour\"`).\n * @param details.constraint - Optional human-readable range description\n * (e.g., `\"1 <= value <= 12\"`). Omit when the failure is a type mismatch.\n */\n constructor(\n message: string,\n details: {\n value: unknown;\n expectedType: string;\n constraint?: string;\n },\n ) {\n super(message);\n this.name = \"TemporalAssertionError\";\n this.value = details.value;\n this.expectedType = details.expectedType;\n this.constraint = details.constraint;\n }\n}\n"]}