@veilo/sdk-core 0.4.0 → 0.5.0

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 (296) hide show
  1. package/LICENSE +15 -0
  2. package/README.md +286 -1298
  3. package/dist/cjs/accounts/admin.d.ts +84 -0
  4. package/dist/cjs/accounts/admin.js +208 -0
  5. package/dist/cjs/accounts/errors.d.ts +6 -0
  6. package/dist/cjs/accounts/errors.js +98 -0
  7. package/dist/cjs/accounts/index.d.ts +4 -0
  8. package/dist/cjs/accounts/index.js +20 -0
  9. package/dist/cjs/accounts/pdas.d.ts +23 -0
  10. package/dist/cjs/accounts/pdas.js +44 -0
  11. package/dist/cjs/accounts/queries.d.ts +41 -0
  12. package/dist/cjs/accounts/queries.js +95 -0
  13. package/dist/cjs/client.d.ts +2 -407
  14. package/dist/cjs/client.js +6 -938
  15. package/dist/cjs/cloak/client.d.ts +28 -0
  16. package/dist/cjs/cloak/client.js +68 -0
  17. package/dist/cjs/cloak/errors.d.ts +13 -0
  18. package/dist/cjs/cloak/errors.js +25 -0
  19. package/dist/cjs/cloak/helpers.d.ts +6 -0
  20. package/dist/cjs/cloak/helpers.js +35 -0
  21. package/dist/cjs/cloak/index.d.ts +6 -0
  22. package/dist/cjs/cloak/index.js +24 -0
  23. package/dist/cjs/cloak/polling.d.ts +7 -0
  24. package/dist/cjs/cloak/polling.js +66 -0
  25. package/dist/cjs/cloak/transport.d.ts +15 -0
  26. package/dist/cjs/cloak/transport.js +119 -0
  27. package/dist/cjs/cloak/types.d.ts +188 -0
  28. package/dist/cjs/cloak/types.js +5 -0
  29. package/dist/cjs/cloak.d.ts +1 -0
  30. package/dist/cjs/cloak.js +18 -0
  31. package/dist/cjs/compactNote.d.ts +21 -0
  32. package/dist/cjs/compactNote.js +31 -7
  33. package/dist/cjs/index.d.ts +2 -1
  34. package/dist/cjs/index.js +4 -1
  35. package/dist/cjs/notes/encryption.d.ts +41 -0
  36. package/dist/cjs/notes/encryption.js +75 -0
  37. package/dist/cjs/notes/index.d.ts +5 -0
  38. package/dist/cjs/notes/index.js +21 -0
  39. package/dist/cjs/notes/mailbox.d.ts +70 -0
  40. package/dist/cjs/notes/mailbox.js +164 -0
  41. package/dist/cjs/notes/model.d.ts +91 -0
  42. package/dist/cjs/notes/model.js +109 -0
  43. package/dist/cjs/notes/nullifier.d.ts +27 -0
  44. package/dist/cjs/notes/nullifier.js +45 -0
  45. package/dist/cjs/notes/recovery.d.ts +10 -0
  46. package/dist/cjs/notes/recovery.js +31 -0
  47. package/dist/cjs/proof.d.ts +1 -183
  48. package/dist/cjs/proof.js +16 -290
  49. package/dist/cjs/proofs/encoding.d.ts +17 -0
  50. package/dist/cjs/proofs/encoding.js +72 -0
  51. package/dist/cjs/proofs/formatting.d.ts +6 -0
  52. package/dist/cjs/proofs/formatting.js +34 -0
  53. package/dist/cjs/proofs/index.d.ts +5 -0
  54. package/dist/cjs/proofs/index.js +21 -0
  55. package/dist/cjs/proofs/swap.d.ts +87 -0
  56. package/dist/cjs/proofs/swap.js +144 -0
  57. package/dist/cjs/proofs/transaction.d.ts +28 -0
  58. package/dist/cjs/proofs/transaction.js +110 -0
  59. package/dist/cjs/proofs/types.d.ts +70 -0
  60. package/dist/cjs/prover.d.ts +4 -1
  61. package/dist/cjs/prover.js +12 -2
  62. package/dist/cjs/relayer/client.d.ts +61 -0
  63. package/dist/cjs/relayer/client.js +151 -0
  64. package/dist/cjs/relayer/crypto.d.ts +5 -0
  65. package/dist/cjs/relayer/crypto.js +26 -0
  66. package/dist/cjs/relayer/encoding.d.ts +2 -0
  67. package/dist/cjs/relayer/encoding.js +23 -0
  68. package/dist/cjs/relayer/errors.d.ts +7 -0
  69. package/dist/cjs/relayer/errors.js +17 -0
  70. package/dist/cjs/relayer/index.d.ts +3 -0
  71. package/dist/cjs/relayer/index.js +19 -0
  72. package/dist/cjs/relayer/transport.d.ts +17 -0
  73. package/dist/cjs/relayer/transport.js +63 -0
  74. package/dist/{src/relayer.d.ts → cjs/relayer/types.d.ts} +44 -86
  75. package/dist/cjs/relayer/types.js +5 -0
  76. package/dist/cjs/relayer.d.ts +1 -318
  77. package/dist/cjs/relayer.js +15 -254
  78. package/dist/cjs/shield/alt.js +8 -8
  79. package/dist/cjs/shield/errors.js +2 -2
  80. package/dist/cjs/shield/finalize.js +2 -2
  81. package/dist/cjs/shield/ix.d.ts +1 -1
  82. package/dist/cjs/shield/owner.js +9 -8
  83. package/dist/cjs/shield/ports.js +3 -3
  84. package/dist/cjs/shield/preflight.js +3 -3
  85. package/dist/cjs/shield/shield.js +20 -19
  86. package/dist/cjs/shield/types.d.ts +1 -1
  87. package/dist/cjs/transactions/deposit.d.ts +94 -0
  88. package/dist/cjs/transactions/deposit.js +234 -0
  89. package/dist/cjs/transactions/index.d.ts +7 -0
  90. package/dist/cjs/transactions/index.js +26 -0
  91. package/dist/cjs/transactions/swap.d.ts +71 -0
  92. package/dist/cjs/transactions/swap.js +184 -0
  93. package/dist/cjs/transactions/transact.d.ts +34 -0
  94. package/dist/cjs/transactions/transact.js +146 -0
  95. package/dist/cjs/transactions/transfer.d.ts +51 -0
  96. package/dist/cjs/transactions/transfer.js +106 -0
  97. package/dist/cjs/transactions/withdraw.d.ts +52 -0
  98. package/dist/cjs/transactions/withdraw.js +104 -0
  99. package/dist/cjs/utxo.d.ts +1 -235
  100. package/dist/cjs/utxo.js +15 -404
  101. package/dist/esm/accounts/admin.d.ts +84 -0
  102. package/dist/esm/accounts/admin.js +165 -0
  103. package/dist/esm/accounts/errors.d.ts +6 -0
  104. package/dist/esm/accounts/errors.js +95 -0
  105. package/dist/esm/accounts/index.d.ts +4 -0
  106. package/dist/esm/accounts/index.js +4 -0
  107. package/dist/esm/accounts/pdas.d.ts +23 -0
  108. package/dist/esm/accounts/pdas.js +38 -0
  109. package/dist/esm/accounts/queries.d.ts +41 -0
  110. package/dist/esm/accounts/queries.js +88 -0
  111. package/dist/esm/client.d.ts +2 -407
  112. package/dist/esm/client.js +3 -891
  113. package/dist/esm/cloak/client.d.ts +28 -0
  114. package/dist/esm/cloak/client.js +64 -0
  115. package/dist/esm/cloak/errors.d.ts +13 -0
  116. package/dist/esm/cloak/errors.js +21 -0
  117. package/dist/esm/cloak/helpers.d.ts +6 -0
  118. package/dist/esm/cloak/helpers.js +31 -0
  119. package/dist/esm/cloak/index.d.ts +6 -0
  120. package/dist/esm/cloak/index.js +6 -0
  121. package/dist/esm/cloak/polling.d.ts +7 -0
  122. package/dist/esm/cloak/polling.js +63 -0
  123. package/dist/esm/cloak/transport.d.ts +15 -0
  124. package/dist/esm/cloak/transport.js +115 -0
  125. package/dist/esm/cloak/types.d.ts +188 -0
  126. package/dist/esm/cloak/types.js +4 -0
  127. package/dist/esm/cloak.d.ts +1 -0
  128. package/dist/esm/cloak.js +2 -0
  129. package/dist/esm/compactNote.d.ts +21 -0
  130. package/dist/esm/compactNote.js +24 -1
  131. package/dist/esm/index.d.ts +2 -1
  132. package/dist/esm/index.js +3 -1
  133. package/dist/esm/notes/encryption.d.ts +41 -0
  134. package/dist/esm/notes/encryption.js +67 -0
  135. package/dist/esm/notes/index.d.ts +5 -0
  136. package/dist/esm/notes/index.js +5 -0
  137. package/dist/esm/notes/mailbox.d.ts +70 -0
  138. package/dist/esm/notes/mailbox.js +154 -0
  139. package/dist/esm/notes/model.d.ts +91 -0
  140. package/dist/esm/notes/model.js +99 -0
  141. package/dist/esm/notes/nullifier.d.ts +27 -0
  142. package/dist/esm/notes/nullifier.js +40 -0
  143. package/dist/esm/notes/recovery.d.ts +10 -0
  144. package/dist/esm/notes/recovery.js +28 -0
  145. package/dist/esm/proof.d.ts +1 -183
  146. package/dist/esm/proof.js +2 -281
  147. package/dist/esm/proofs/encoding.d.ts +17 -0
  148. package/dist/esm/proofs/encoding.js +68 -0
  149. package/dist/esm/proofs/formatting.d.ts +6 -0
  150. package/dist/esm/proofs/formatting.js +31 -0
  151. package/dist/esm/proofs/index.d.ts +5 -0
  152. package/dist/esm/proofs/index.js +5 -0
  153. package/dist/esm/proofs/swap.d.ts +87 -0
  154. package/dist/esm/proofs/swap.js +138 -0
  155. package/dist/esm/proofs/transaction.d.ts +28 -0
  156. package/dist/esm/proofs/transaction.js +105 -0
  157. package/dist/esm/proofs/types.d.ts +70 -0
  158. package/dist/esm/proofs/types.js +1 -0
  159. package/dist/esm/prover.d.ts +4 -1
  160. package/dist/esm/prover.js +10 -1
  161. package/dist/esm/relayer/client.d.ts +61 -0
  162. package/dist/esm/relayer/client.js +144 -0
  163. package/dist/esm/relayer/crypto.d.ts +5 -0
  164. package/dist/esm/relayer/crypto.js +20 -0
  165. package/dist/esm/relayer/encoding.d.ts +2 -0
  166. package/dist/esm/relayer/encoding.js +19 -0
  167. package/dist/esm/relayer/errors.d.ts +7 -0
  168. package/dist/esm/relayer/errors.js +13 -0
  169. package/dist/esm/relayer/index.d.ts +3 -0
  170. package/dist/esm/relayer/index.js +3 -0
  171. package/dist/esm/relayer/transport.d.ts +17 -0
  172. package/dist/esm/relayer/transport.js +59 -0
  173. package/dist/esm/relayer/types.d.ts +276 -0
  174. package/dist/esm/relayer/types.js +4 -0
  175. package/dist/esm/relayer.d.ts +1 -318
  176. package/dist/esm/relayer.js +2 -249
  177. package/dist/esm/shield/alt.js +1 -1
  178. package/dist/esm/shield/errors.js +1 -1
  179. package/dist/esm/shield/finalize.js +1 -1
  180. package/dist/esm/shield/ix.d.ts +1 -1
  181. package/dist/esm/shield/owner.js +2 -1
  182. package/dist/esm/shield/ports.js +1 -1
  183. package/dist/esm/shield/preflight.js +1 -1
  184. package/dist/esm/shield/shield.js +4 -3
  185. package/dist/esm/shield/types.d.ts +1 -1
  186. package/dist/esm/transactions/deposit.d.ts +94 -0
  187. package/dist/esm/transactions/deposit.js +198 -0
  188. package/dist/esm/transactions/index.d.ts +7 -0
  189. package/dist/esm/transactions/index.js +7 -0
  190. package/dist/esm/transactions/swap.d.ts +71 -0
  191. package/dist/esm/transactions/swap.js +144 -0
  192. package/dist/esm/transactions/transact.d.ts +34 -0
  193. package/dist/esm/transactions/transact.js +110 -0
  194. package/dist/esm/transactions/transfer.d.ts +51 -0
  195. package/dist/esm/transactions/transfer.js +103 -0
  196. package/dist/esm/transactions/withdraw.d.ts +52 -0
  197. package/dist/esm/transactions/withdraw.js +101 -0
  198. package/dist/esm/utxo.d.ts +1 -235
  199. package/dist/esm/utxo.js +2 -382
  200. package/package.json +54 -16
  201. package/SHIELD_INTEGRATION.md +0 -143
  202. package/config.d.ts +0 -2
  203. package/config.js +0 -4
  204. package/dist/src/client.d.ts +0 -407
  205. package/dist/src/client.js +0 -951
  206. package/dist/src/compactNote.d.ts +0 -107
  207. package/dist/src/compactNote.js +0 -167
  208. package/dist/src/config.d.ts +0 -82
  209. package/dist/src/config.js +0 -57
  210. package/dist/src/events.d.ts +0 -77
  211. package/dist/src/events.js +0 -167
  212. package/dist/src/idl/privacy_pool.d.ts +0 -5
  213. package/dist/src/idl/privacy_pool.js +0 -15218
  214. package/dist/src/index.d.ts +0 -16
  215. package/dist/src/index.js +0 -67
  216. package/dist/src/merkle.d.ts +0 -77
  217. package/dist/src/merkle.js +0 -156
  218. package/dist/src/poseidon.d.ts +0 -29
  219. package/dist/src/poseidon.js +0 -100
  220. package/dist/src/program.d.ts +0 -37
  221. package/dist/src/program.js +0 -61
  222. package/dist/src/proof.d.ts +0 -183
  223. package/dist/src/proof.js +0 -292
  224. package/dist/src/prover.d.ts +0 -54
  225. package/dist/src/prover.js +0 -112
  226. package/dist/src/random.d.ts +0 -16
  227. package/dist/src/random.js +0 -28
  228. package/dist/src/relayer.js +0 -257
  229. package/dist/src/retry.d.ts +0 -32
  230. package/dist/src/retry.js +0 -75
  231. package/dist/src/shield/alt.d.ts +0 -87
  232. package/dist/src/shield/alt.js +0 -194
  233. package/dist/src/shield/computeBudget.d.ts +0 -61
  234. package/dist/src/shield/computeBudget.js +0 -64
  235. package/dist/src/shield/errors.d.ts +0 -58
  236. package/dist/src/shield/errors.js +0 -121
  237. package/dist/src/shield/finalize.d.ts +0 -45
  238. package/dist/src/shield/finalize.js +0 -119
  239. package/dist/src/shield/index.d.ts +0 -35
  240. package/dist/src/shield/index.js +0 -68
  241. package/dist/src/shield/ix.d.ts +0 -54
  242. package/dist/src/shield/ix.js +0 -119
  243. package/dist/src/shield/owner.d.ts +0 -36
  244. package/dist/src/shield/owner.js +0 -126
  245. package/dist/src/shield/ports.d.ts +0 -43
  246. package/dist/src/shield/ports.js +0 -153
  247. package/dist/src/shield/preflight.d.ts +0 -30
  248. package/dist/src/shield/preflight.js +0 -154
  249. package/dist/src/shield/shield.d.ts +0 -68
  250. package/dist/src/shield/shield.js +0 -499
  251. package/dist/src/shield/types.d.ts +0 -202
  252. package/dist/src/utxo.d.ts +0 -235
  253. package/dist/src/utxo.js +0 -407
  254. package/dist/tests/compact-note.test.d.ts +0 -1
  255. package/dist/tests/compact-note.test.js +0 -173
  256. package/dist/tests/config.test.d.ts +0 -1
  257. package/dist/tests/config.test.js +0 -102
  258. package/dist/tests/edge-cases.test.d.ts +0 -1
  259. package/dist/tests/edge-cases.test.js +0 -220
  260. package/dist/tests/encryption.test.d.ts +0 -1
  261. package/dist/tests/encryption.test.js +0 -215
  262. package/dist/tests/events.test.d.ts +0 -1
  263. package/dist/tests/events.test.js +0 -78
  264. package/dist/tests/multi-tree.test.d.ts +0 -1
  265. package/dist/tests/multi-tree.test.js +0 -405
  266. package/dist/tests/pda.test.d.ts +0 -1
  267. package/dist/tests/pda.test.js +0 -229
  268. package/dist/tests/poseidon-builder-parity.test.d.ts +0 -1
  269. package/dist/tests/poseidon-builder-parity.test.js +0 -72
  270. package/dist/tests/poseidon.test.d.ts +0 -1
  271. package/dist/tests/poseidon.test.js +0 -142
  272. package/dist/tests/proof.test.d.ts +0 -1
  273. package/dist/tests/proof.test.js +0 -296
  274. package/dist/tests/relayer.test.d.ts +0 -1
  275. package/dist/tests/relayer.test.js +0 -271
  276. package/dist/tests/sdk.integration.test.d.ts +0 -1
  277. package/dist/tests/sdk.integration.test.js +0 -330
  278. package/dist/tests/shield-owner.test.d.ts +0 -1
  279. package/dist/tests/shield-owner.test.js +0 -89
  280. package/dist/tests/shield-preflight.test.d.ts +0 -1
  281. package/dist/tests/shield-preflight.test.js +0 -87
  282. package/dist/tests/shield-realproof.test.d.ts +0 -1
  283. package/dist/tests/shield-realproof.test.js +0 -272
  284. package/dist/tests/shield.test.d.ts +0 -1
  285. package/dist/tests/shield.test.js +0 -403
  286. package/dist/tests/utxo.test.d.ts +0 -1
  287. package/dist/tests/utxo.test.js +0 -140
  288. package/poseidon.d.ts +0 -2
  289. package/poseidon.js +0 -4
  290. package/proof.d.ts +0 -2
  291. package/proof.js +0 -4
  292. package/prover.d.ts +0 -2
  293. package/prover.js +0 -4
  294. package/shield.d.ts +0 -2
  295. package/shield.js +0 -4
  296. /package/dist/{src/shield → cjs/proofs}/types.js +0 -0
@@ -1,257 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.VeiloRelayerClient = exports.VeiloApiError = void 0;
7
- const tweetnacl_1 = __importDefault(require("tweetnacl"));
8
- const DEFAULT_RELAYER_URL = "https://relayer-server.onrender.com";
9
- // =============================================================================
10
- // Structured Error
11
- // =============================================================================
12
- /** Structured error thrown by VeiloRelayerClient on API failures. */
13
- class VeiloApiError extends Error {
14
- constructor(code, message, status, details) {
15
- super(message);
16
- this.name = "VeiloApiError";
17
- this.code = code;
18
- this.status = status;
19
- this.details = details;
20
- }
21
- }
22
- exports.VeiloApiError = VeiloApiError;
23
- const DEFAULT_RETRY = {
24
- maxRetries: 3,
25
- baseDelayMs: 1000,
26
- retryableStatuses: [429, 502, 503, 504],
27
- };
28
- // =============================================================================
29
- // Base64 helpers (no dependency on tweetnacl-util)
30
- // =============================================================================
31
- function toBase64(bytes) {
32
- if (typeof Buffer !== "undefined") {
33
- return Buffer.from(bytes).toString("base64");
34
- }
35
- return btoa(String.fromCharCode(...bytes));
36
- }
37
- function fromBase64(str) {
38
- if (typeof Buffer !== "undefined") {
39
- return new Uint8Array(Buffer.from(str, "base64"));
40
- }
41
- const binary = atob(str);
42
- const bytes = new Uint8Array(binary.length);
43
- for (let i = 0; i < binary.length; i++)
44
- bytes[i] = binary.charCodeAt(i);
45
- return bytes;
46
- }
47
- // =============================================================================
48
- // Encryption
49
- // =============================================================================
50
- /**
51
- * Encrypt a JSON-serializable payload for the relayer using NaCl box.
52
- * Layout: [ephemeralPubKey (32)] [nonce (24)] [ciphertext (...)]
53
- */
54
- function encryptForRelayer(data, relayerPublicKey) {
55
- const ephemeral = tweetnacl_1.default.box.keyPair();
56
- const message = new TextEncoder().encode(JSON.stringify(data));
57
- const nonce = tweetnacl_1.default.randomBytes(tweetnacl_1.default.box.nonceLength);
58
- const ciphertext = tweetnacl_1.default.box(message, nonce, relayerPublicKey, ephemeral.secretKey);
59
- const payload = new Uint8Array(ephemeral.publicKey.length + nonce.length + ciphertext.length);
60
- payload.set(ephemeral.publicKey, 0);
61
- payload.set(nonce, ephemeral.publicKey.length);
62
- payload.set(ciphertext, ephemeral.publicKey.length + nonce.length);
63
- return toBase64(payload);
64
- }
65
- // =============================================================================
66
- // Relayer Client
67
- // =============================================================================
68
- /**
69
- * HTTP client for the Veilo relayer API.
70
- *
71
- * Handles auth, notes, merkle, and encrypted transact endpoints with
72
- * automatic retry on transient failures and NaCl box payload encryption.
73
- *
74
- * @example
75
- * ```ts
76
- * const client = new VeiloRelayerClient({
77
- * apiKey: "your-api-key",
78
- * relayerPublicKey: "<base64 NaCl public key>",
79
- * });
80
- * const root = await client.getMerkleRoot("So111...");
81
- * ```
82
- */
83
- class VeiloRelayerClient {
84
- constructor(config, retry) {
85
- this.baseUrl = (config.relayerUrl?.trim() || DEFAULT_RELAYER_URL).replace(/\/+$/, "");
86
- this.apiKey = config.apiKey;
87
- this.relayerPubKey = fromBase64(config.relayerPublicKey);
88
- this.authToken = config.authToken;
89
- this.retry = { ...DEFAULT_RETRY, ...retry };
90
- }
91
- /** Update the auth token (e.g. after register/restore). */
92
- setAuthToken(token) {
93
- this.authToken = token;
94
- }
95
- // ---------------------------------------------------------------------------
96
- // Internal helpers
97
- // ---------------------------------------------------------------------------
98
- headers(authenticated) {
99
- const h = {
100
- "Content-Type": "application/json",
101
- };
102
- if (this.apiKey)
103
- h["x-api-key"] = this.apiKey;
104
- if (authenticated && this.authToken) {
105
- h["Authorization"] = `Bearer ${this.authToken}`;
106
- }
107
- return h;
108
- }
109
- async request(method, path, opts = {}) {
110
- const url = `${this.baseUrl}/api${path}`;
111
- const { body, authenticated = false, retryable = true } = opts;
112
- const maxAttempts = retryable ? this.retry.maxRetries + 1 : 1;
113
- let lastError;
114
- for (let attempt = 0; attempt < maxAttempts; attempt++) {
115
- if (attempt > 0) {
116
- const delay = this.retry.baseDelayMs * Math.pow(2, attempt - 1) +
117
- Math.random() * 200;
118
- await new Promise((r) => setTimeout(r, delay));
119
- }
120
- let res;
121
- try {
122
- res = await fetch(url, {
123
- method,
124
- headers: this.headers(authenticated),
125
- body: body != null ? JSON.stringify(body) : undefined,
126
- });
127
- }
128
- catch (err) {
129
- lastError = new VeiloApiError("NETWORK_ERROR", err.message || "Network request failed", 0);
130
- continue;
131
- }
132
- const data = await res.json().catch(() => ({}));
133
- if (res.ok && data.success !== false) {
134
- return data;
135
- }
136
- lastError = new VeiloApiError(data.error || "UNKNOWN", data.message || data.error || `Request failed: ${res.status}`, res.status, data);
137
- // Only retry on transient statuses
138
- if (!this.retry.retryableStatuses.includes(res.status)) {
139
- throw lastError;
140
- }
141
- }
142
- throw lastError;
143
- }
144
- encrypt(data) {
145
- return encryptForRelayer({
146
- ...data,
147
- timestamp: Date.now(),
148
- nonce: toBase64(tweetnacl_1.default.randomBytes(32)),
149
- }, this.relayerPubKey);
150
- }
151
- // ---------------------------------------------------------------------------
152
- // Auth
153
- // ---------------------------------------------------------------------------
154
- /** Request a signature challenge for wallet authentication. */
155
- async getChallenge(walletPublicKey) {
156
- return this.request("POST", "/auth/challenge", {
157
- body: { walletPublicKey },
158
- });
159
- }
160
- /** Register a new account with a signed challenge. Returns a JWT auth token. */
161
- async register(data) {
162
- return this.request("POST", "/auth/register", { body: data });
163
- }
164
- /** Restore an existing account using a signed challenge. Returns a JWT auth token. */
165
- async restore(data) {
166
- return this.request("POST", "/auth/restore", { body: data });
167
- }
168
- /** Check whether a username is available for registration. */
169
- async checkUsername(username) {
170
- return this.request("GET", `/auth/checkUsername?username=${encodeURIComponent(username)}`);
171
- }
172
- /** Look up a user's Veilo public key by username or wallet public key. */
173
- async getVeiloPublicKey(params) {
174
- const query = "username" in params && params.username
175
- ? `username=${encodeURIComponent(params.username)}`
176
- : `publicKey=${encodeURIComponent(params.publicKey)}`;
177
- return this.request("GET", `/auth/veiloPublicKey?${query}`);
178
- }
179
- /**
180
- * Provision (or retrieve) the Veilo spend key paired with a Solana address.
181
- * Public and idempotent; the response contains public key material only.
182
- */
183
- async preRegisterKey(solanaAddress) {
184
- return this.request("POST", "/auth/pre-register-key", {
185
- body: { solanaAddress },
186
- });
187
- }
188
- // ---------------------------------------------------------------------------
189
- // Notes
190
- // ---------------------------------------------------------------------------
191
- /** Save an encrypted note to the relayer's database. */
192
- async saveEncryptedNote(data) {
193
- return this.request("POST", "/notes/save", { body: data });
194
- }
195
- /** Query encrypted notes for the authenticated user. Requires auth token. */
196
- async queryEncryptedNotes(params = {}) {
197
- return this.request("POST", "/notes/query", {
198
- body: params,
199
- authenticated: true,
200
- });
201
- }
202
- /** Delete all stored data for the authenticated user. Requires auth token. */
203
- async deleteUserData() {
204
- return this.request("POST", "/notes/delete", { authenticated: true });
205
- }
206
- // ---------------------------------------------------------------------------
207
- // Merkle
208
- // ---------------------------------------------------------------------------
209
- /** Fetch the current Merkle root for a pool, optionally filtered by mint and tree ID. */
210
- async getMerkleRoot(mintAddress, treeId) {
211
- const params = new URLSearchParams();
212
- if (mintAddress)
213
- params.append("mintAddress", mintAddress);
214
- if (treeId !== undefined)
215
- params.append("treeId", treeId.toString());
216
- const qs = params.toString();
217
- return this.request("GET", `/merkle/root${qs ? `?${qs}` : ""}`);
218
- }
219
- /** Fetch the full Merkle tree (all leaves) for a pool. */
220
- async getMerkleTree(mintAddress, treeId) {
221
- const params = new URLSearchParams();
222
- if (mintAddress)
223
- params.append("mintAddress", mintAddress);
224
- if (treeId !== undefined)
225
- params.append("treeId", treeId.toString());
226
- const qs = params.toString();
227
- return this.request("GET", `/merkle/tree${qs ? `?${qs}` : ""}`);
228
- }
229
- // ---------------------------------------------------------------------------
230
- // Transact (encrypted payloads)
231
- // ---------------------------------------------------------------------------
232
- /** Submit an encrypted withdrawal request to the relayer. Not retried on failure. */
233
- async submitWithdraw(data) {
234
- const encryptedPayload = this.encrypt(data);
235
- return this.request("POST", "/transact/withdra", {
236
- body: { encryptedPayload },
237
- retryable: false,
238
- });
239
- }
240
- /** Submit an encrypted private transfer request. Not retried on failure. */
241
- async submitPrivateTransfer(data) {
242
- const encryptedPayload = this.encrypt(data);
243
- return this.request("POST", "/transact/private-transfer", {
244
- body: { encryptedPayload },
245
- retryable: false,
246
- });
247
- }
248
- /** Submit an encrypted private swap request. Not retried on failure. */
249
- async submitPrivateSwap(data) {
250
- const encryptedPayload = this.encrypt(data);
251
- return this.request("POST", "/transact/private-swap", {
252
- body: { encryptedPayload },
253
- retryable: false,
254
- });
255
- }
256
- }
257
- exports.VeiloRelayerClient = VeiloRelayerClient;
@@ -1,32 +0,0 @@
1
- /**
2
- * Configuration for retry behavior on Solana RPC calls.
3
- */
4
- export interface RpcRetryPolicy {
5
- /** Maximum number of retry attempts (default: 3) */
6
- maxRetries: number;
7
- /** Base delay in ms for exponential backoff (default: 1000) */
8
- baseDelayMs: number;
9
- /** Maximum delay cap in ms (default: 10000) */
10
- maxDelayMs: number;
11
- }
12
- export declare const DEFAULT_RPC_RETRY: RpcRetryPolicy;
13
- /**
14
- * Execute an async function with retries on transient RPC failures.
15
- *
16
- * Retries on: BlockhashNotFound, HTTP 429/502/503/504, timeouts, connection resets.
17
- * Does NOT retry on: program errors (6xxx), signature verification failures, or other
18
- * deterministic errors that would fail again.
19
- *
20
- * @param fn The async operation to execute
21
- * @param policy Retry configuration (uses sensible defaults if omitted)
22
- * @returns The result of the async operation
23
- *
24
- * @example
25
- * ```ts
26
- * const txSig = await withRpcRetry(
27
- * () => program.methods.transact(...).accounts({...}).signers([...]).rpc(),
28
- * { maxRetries: 5 },
29
- * );
30
- * ```
31
- */
32
- export declare function withRpcRetry<T>(fn: () => Promise<T>, policy?: Partial<RpcRetryPolicy>): Promise<T>;
package/dist/src/retry.js DELETED
@@ -1,75 +0,0 @@
1
- "use strict";
2
- // -----------------------------------------------------------------------------
3
- // RPC Retry / Resilience
4
- // -----------------------------------------------------------------------------
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.DEFAULT_RPC_RETRY = void 0;
7
- exports.withRpcRetry = withRpcRetry;
8
- exports.DEFAULT_RPC_RETRY = {
9
- maxRetries: 3,
10
- baseDelayMs: 1000,
11
- maxDelayMs: 10000,
12
- };
13
- /** Error messages / patterns that indicate a transient RPC failure worth retrying. */
14
- const RETRYABLE_PATTERNS = [
15
- "blockhash not found",
16
- "block height exceeded",
17
- "blockhash already expired",
18
- "node is behind",
19
- "service unavailable",
20
- "too many requests",
21
- "429",
22
- "502",
23
- "503",
24
- "504",
25
- "timeout",
26
- "timed out",
27
- "econnreset",
28
- "econnrefused",
29
- "socket hang up",
30
- "fetch failed",
31
- ];
32
- function isRetryableError(error) {
33
- const msg = (error instanceof Error ? error.message : String(error)).toLowerCase();
34
- return RETRYABLE_PATTERNS.some((p) => msg.includes(p));
35
- }
36
- /**
37
- * Execute an async function with retries on transient RPC failures.
38
- *
39
- * Retries on: BlockhashNotFound, HTTP 429/502/503/504, timeouts, connection resets.
40
- * Does NOT retry on: program errors (6xxx), signature verification failures, or other
41
- * deterministic errors that would fail again.
42
- *
43
- * @param fn The async operation to execute
44
- * @param policy Retry configuration (uses sensible defaults if omitted)
45
- * @returns The result of the async operation
46
- *
47
- * @example
48
- * ```ts
49
- * const txSig = await withRpcRetry(
50
- * () => program.methods.transact(...).accounts({...}).signers([...]).rpc(),
51
- * { maxRetries: 5 },
52
- * );
53
- * ```
54
- */
55
- async function withRpcRetry(fn, policy) {
56
- const { maxRetries, baseDelayMs, maxDelayMs } = {
57
- ...exports.DEFAULT_RPC_RETRY,
58
- ...policy,
59
- };
60
- let lastError;
61
- for (let attempt = 0; attempt <= maxRetries; attempt++) {
62
- try {
63
- return await fn();
64
- }
65
- catch (error) {
66
- lastError = error;
67
- if (attempt >= maxRetries || !isRetryableError(error)) {
68
- throw error;
69
- }
70
- const delay = Math.min(baseDelayMs * Math.pow(2, attempt) + Math.random() * 200, maxDelayMs);
71
- await new Promise((r) => setTimeout(r, delay));
72
- }
73
- }
74
- throw lastError;
75
- }
@@ -1,87 +0,0 @@
1
- import { AddressLookupTableAccount, Connection, PublicKey } from "@solana/web3.js";
2
- import type { AltSource, ShieldCachePort } from "./types.js";
3
- /**
4
- * Address lookup table handling for the shield path.
5
- *
6
- * The ALT is not an optimisation here — it is load-bearing. A `transact` carries
7
- * 847 bytes of instruction data across 16 accounts, which is ~1500 bytes as a
8
- * legacy transaction and therefore unlandable. Compressing the constant pool
9
- * accounts to 1-byte indices is what brings it to ~1163 and leaves room for
10
- * Phantom's Lighthouse guard instructions.
11
- */
12
- /**
13
- * The shared, team-owned deposit table.
14
- *
15
- * Deliberately shared rather than per-wallet: creating a per-wallet table costs
16
- * the signer an extra signature and unrecoverable rent, which is unacceptable to
17
- * ask of an external wallet shielding once, and impossible to ask of a
18
- * third-party platform's managed wallet.
19
- */
20
- export declare const SHARED_DEPOSIT_ALT: PublicKey;
21
- /** Mints the shared table is provisioned for. */
22
- export declare const SHARED_ALT_MINTS: {
23
- symbol: string;
24
- mint: PublicKey;
25
- }[];
26
- /**
27
- * Load the shared table, and verify it actually covers this shield.
28
- *
29
- * The verification is the important part. Coverage is an *operational* property,
30
- * not a code property: the table is populated by a script, and if a mint or a
31
- * tree is missing, every one of its accounts falls back to a 32-byte static key
32
- * and the transaction silently grows past 1232. Failing here with a list of the
33
- * missing addresses is far better than failing at `signTransaction` with
34
- * "transaction too large" and no indication why.
35
- */
36
- export declare function sharedDepositAlt(address?: PublicKey, opts?: {
37
- cache?: ShieldCachePort;
38
- verifyCoverage?: boolean;
39
- }): AltSource;
40
- /** Use a table the caller already loaded. Skips both the RPC call and the coverage check. */
41
- export declare function explicitAlt(account: AddressLookupTableAccount): AltSource;
42
- type NamedKey = {
43
- label: string;
44
- address: PublicKey;
45
- };
46
- /**
47
- * Accounts that must be in the table for a shield of `mint` into `outputTreeId`
48
- * to fit.
49
- *
50
- * The signer, the two nullifier markers, and the user's token account are
51
- * deliberately excluded: markers are unique per transaction and the others are
52
- * per-user, so none can live in a shared table. They are the static keys the
53
- * size budget accounts for.
54
- */
55
- export declare function requiredAltKeys(params: {
56
- mint: PublicKey;
57
- outputTreeId: number;
58
- programId?: PublicKey;
59
- }): NamedKey[];
60
- /**
61
- * Everything the shared table should contain across every supported mint and
62
- * every tree up to `maxTreeId`.
63
- *
64
- * Exported so this can be asserted in CI. The table currently only covers tree 0
65
- * per mint, which means the size budget quietly loses 32 bytes of headroom the
66
- * day tree 0 fills and `getBestTreeForDeposit` starts returning tree 1. That is
67
- * a scheduled failure, and this function is how it gets caught before a user
68
- * finds it.
69
- */
70
- export declare function expectedDepositAltKeys(params: {
71
- mints?: PublicKey[];
72
- maxTreeId?: number;
73
- programId?: PublicKey;
74
- }): Promise<NamedKey[]>;
75
- /** Diff the on-chain table against {@link expectedDepositAltKeys}. */
76
- export declare function auditDepositAlt(connection: Connection, params?: {
77
- address?: PublicKey;
78
- mints?: PublicKey[];
79
- maxTreeId?: number;
80
- programId?: PublicKey;
81
- }): Promise<{
82
- ok: boolean;
83
- present: number;
84
- missing: NamedKey[];
85
- extra: string[];
86
- }>;
87
- export {};
@@ -1,194 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SHARED_ALT_MINTS = exports.SHARED_DEPOSIT_ALT = void 0;
4
- exports.sharedDepositAlt = sharedDepositAlt;
5
- exports.explicitAlt = explicitAlt;
6
- exports.requiredAltKeys = requiredAltKeys;
7
- exports.expectedDepositAltKeys = expectedDepositAltKeys;
8
- exports.auditDepositAlt = auditDepositAlt;
9
- const web3_js_1 = require("@solana/web3.js");
10
- const spl_token_1 = require("@solana/spl-token");
11
- const client_js_1 = require("../client.js");
12
- const program_js_1 = require("../program.js");
13
- const config_js_1 = require("../config.js");
14
- const errors_js_1 = require("./errors.js");
15
- /**
16
- * Address lookup table handling for the shield path.
17
- *
18
- * The ALT is not an optimisation here — it is load-bearing. A `transact` carries
19
- * 847 bytes of instruction data across 16 accounts, which is ~1500 bytes as a
20
- * legacy transaction and therefore unlandable. Compressing the constant pool
21
- * accounts to 1-byte indices is what brings it to ~1163 and leaves room for
22
- * Phantom's Lighthouse guard instructions.
23
- */
24
- /**
25
- * The shared, team-owned deposit table.
26
- *
27
- * Deliberately shared rather than per-wallet: creating a per-wallet table costs
28
- * the signer an extra signature and unrecoverable rent, which is unacceptable to
29
- * ask of an external wallet shielding once, and impossible to ask of a
30
- * third-party platform's managed wallet.
31
- */
32
- exports.SHARED_DEPOSIT_ALT = new web3_js_1.PublicKey("3x2JxCgAPmv4U4EJonFBntm1q4W3xzpnB6aT1tCvxftk");
33
- /** Mints the shared table is provisioned for. */
34
- exports.SHARED_ALT_MINTS = [
35
- { symbol: "SOL", mint: config_js_1.NATIVE_SOL_MINT },
36
- { symbol: "USDC", mint: new web3_js_1.PublicKey("EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v") },
37
- { symbol: "USDT", mint: new web3_js_1.PublicKey("Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB") },
38
- { symbol: "USD1", mint: new web3_js_1.PublicKey("USD1ttGY1N17NEEHLmELoaybftRBUSErhqYiQzvEmuB") },
39
- { symbol: "JUP", mint: new web3_js_1.PublicKey("JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN") },
40
- { symbol: "ARX", mint: new web3_js_1.PublicKey("ARXwZkNAtzPfdcoqQiduJn8EPv9fKiDfGn2KyggyDrFs") },
41
- ];
42
- const ALT_CACHE_TTL_MS = 10 * 60000;
43
- /**
44
- * Load the shared table, and verify it actually covers this shield.
45
- *
46
- * The verification is the important part. Coverage is an *operational* property,
47
- * not a code property: the table is populated by a script, and if a mint or a
48
- * tree is missing, every one of its accounts falls back to a 32-byte static key
49
- * and the transaction silently grows past 1232. Failing here with a list of the
50
- * missing addresses is far better than failing at `signTransaction` with
51
- * "transaction too large" and no indication why.
52
- */
53
- function sharedDepositAlt(address = exports.SHARED_DEPOSIT_ALT, opts = {}) {
54
- return {
55
- async resolve({ connection, mint, outputTreeId, programId }) {
56
- const key = `alt:${address.toBase58()}`;
57
- let account = await opts.cache?.get(key);
58
- if (!account) {
59
- // "finalized" so every RPC the signer's wallet might simulate against
60
- // has already seen the table. A table read at "processed" can be
61
- // invisible to the wallet's own simulator.
62
- const res = await connection.getAddressLookupTable(address, {
63
- commitment: "finalized",
64
- });
65
- if (!res.value) {
66
- throw new errors_js_1.ShieldError("ALT_NOT_FOUND", `Deposit address lookup table ${address.toBase58()} was not found at ` +
67
- `finalized commitment. Without it a shield cannot fit in 1232 bytes.`, { context: { address: address.toBase58() } });
68
- }
69
- account = res.value;
70
- await opts.cache?.set(key, account, ALT_CACHE_TTL_MS);
71
- }
72
- if (opts.verifyCoverage !== false) {
73
- const missing = missingCoverage(account, {
74
- mint,
75
- outputTreeId,
76
- programId,
77
- });
78
- if (missing.length > 0) {
79
- throw new errors_js_1.ShieldError("ALT_INCOMPLETE", `The deposit lookup table does not cover this shield: ${missing.length} ` +
80
- `required account(s) are absent, so the transaction would exceed 1232 ` +
81
- `bytes. Extend the table before shielding this mint/tree.`, {
82
- context: {
83
- alt: address.toBase58(),
84
- mint: mint.toBase58(),
85
- outputTreeId,
86
- missing: missing.map((m) => `${m.label} (${m.address.toBase58()})`),
87
- },
88
- });
89
- }
90
- }
91
- return account;
92
- },
93
- };
94
- }
95
- /** Use a table the caller already loaded. Skips both the RPC call and the coverage check. */
96
- function explicitAlt(account) {
97
- return { async resolve() { return account; } };
98
- }
99
- /**
100
- * Accounts that must be in the table for a shield of `mint` into `outputTreeId`
101
- * to fit.
102
- *
103
- * The signer, the two nullifier markers, and the user's token account are
104
- * deliberately excluded: markers are unique per transaction and the others are
105
- * per-user, so none can live in a shared table. They are the static keys the
106
- * size budget accounts for.
107
- */
108
- function requiredAltKeys(params) {
109
- const programId = params.programId ?? program_js_1.PRIVACY_POOL_PROGRAM_ID;
110
- const { config, vault, nullifiers } = (0, client_js_1.getPoolPdas)(programId, params.mint);
111
- const keys = [
112
- { label: "programId", address: programId },
113
- { label: "computeBudgetProgram", address: web3_js_1.ComputeBudgetProgram.programId },
114
- { label: "systemProgram", address: web3_js_1.SystemProgram.programId },
115
- { label: "globalConfig", address: (0, client_js_1.getGlobalConfigPda)(programId) },
116
- { label: "config", address: config },
117
- { label: "vault", address: vault },
118
- { label: "nullifiers", address: nullifiers },
119
- { label: "inputTree(0)", address: (0, client_js_1.getNoteTreePda)(programId, params.mint, 0) },
120
- ];
121
- if (params.outputTreeId !== 0) {
122
- keys.push({
123
- label: `outputTree(${params.outputTreeId})`,
124
- address: (0, client_js_1.getNoteTreePda)(programId, params.mint, params.outputTreeId),
125
- });
126
- }
127
- if (!params.mint.equals(config_js_1.NATIVE_SOL_MINT)) {
128
- keys.push({ label: "tokenProgram", address: spl_token_1.TOKEN_PROGRAM_ID }, {
129
- label: "vaultAta",
130
- address: (0, spl_token_1.getAssociatedTokenAddressSync)(params.mint, vault, true),
131
- });
132
- }
133
- return keys;
134
- }
135
- function missingCoverage(account, params) {
136
- const present = new Set(account.state.addresses.map((a) => a.toBase58()));
137
- return requiredAltKeys(params).filter((k) => !present.has(k.address.toBase58()));
138
- }
139
- /**
140
- * Everything the shared table should contain across every supported mint and
141
- * every tree up to `maxTreeId`.
142
- *
143
- * Exported so this can be asserted in CI. The table currently only covers tree 0
144
- * per mint, which means the size budget quietly loses 32 bytes of headroom the
145
- * day tree 0 fills and `getBestTreeForDeposit` starts returning tree 1. That is
146
- * a scheduled failure, and this function is how it gets caught before a user
147
- * finds it.
148
- */
149
- async function expectedDepositAltKeys(params) {
150
- const programId = params.programId ?? program_js_1.PRIVACY_POOL_PROGRAM_ID;
151
- const mints = params.mints ?? exports.SHARED_ALT_MINTS.map((m) => m.mint);
152
- const maxTreeId = params.maxTreeId ?? 4;
153
- const out = [
154
- { label: "programId", address: programId },
155
- { label: "computeBudgetProgram", address: web3_js_1.ComputeBudgetProgram.programId },
156
- { label: "systemProgram", address: web3_js_1.SystemProgram.programId },
157
- { label: "tokenProgram", address: spl_token_1.TOKEN_PROGRAM_ID },
158
- { label: "globalConfig", address: (0, client_js_1.getGlobalConfigPda)(programId) },
159
- ];
160
- for (const mint of mints) {
161
- const label = mint.equals(config_js_1.NATIVE_SOL_MINT) ? "SOL" : mint.toBase58().slice(0, 4);
162
- const { config, vault, nullifiers } = (0, client_js_1.getPoolPdas)(programId, mint);
163
- out.push({ label: `${label}.config`, address: config }, { label: `${label}.vault`, address: vault }, { label: `${label}.nullifiers`, address: nullifiers });
164
- for (let t = 0; t <= maxTreeId; t++) {
165
- out.push({
166
- label: `${label}.tree(${t})`,
167
- address: (0, client_js_1.getNoteTreePda)(programId, mint, t),
168
- });
169
- }
170
- if (!mint.equals(config_js_1.NATIVE_SOL_MINT)) {
171
- out.push({
172
- label: `${label}.vaultAta`,
173
- address: await (0, spl_token_1.getAssociatedTokenAddress)(mint, vault, true),
174
- });
175
- }
176
- }
177
- return out;
178
- }
179
- /** Diff the on-chain table against {@link expectedDepositAltKeys}. */
180
- async function auditDepositAlt(connection, params = {}) {
181
- const address = params.address ?? exports.SHARED_DEPOSIT_ALT;
182
- const res = await connection.getAddressLookupTable(address, {
183
- commitment: "finalized",
184
- });
185
- if (!res.value) {
186
- throw new errors_js_1.ShieldError("ALT_NOT_FOUND", `Deposit ALT ${address.toBase58()} not found`, { context: { address: address.toBase58() } });
187
- }
188
- const present = new Set(res.value.state.addresses.map((a) => a.toBase58()));
189
- const expected = await expectedDepositAltKeys(params);
190
- const expectedSet = new Set(expected.map((e) => e.address.toBase58()));
191
- const missing = expected.filter((e) => !present.has(e.address.toBase58()));
192
- const extra = [...present].filter((p) => !expectedSet.has(p));
193
- return { ok: missing.length === 0, present: present.size, missing, extra };
194
- }