@oracle-agent/oracle 0.1.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 (169) hide show
  1. package/CONTRIBUTING.md +98 -0
  2. package/LICENSE +202 -0
  3. package/README.md +384 -0
  4. package/SECURITY.md +89 -0
  5. package/SETUP.md +235 -0
  6. package/artifacts/inscription/oracle-was-here-preview.png +0 -0
  7. package/artifacts/inscription/oracle-was-here.svg +1 -0
  8. package/artifacts/specialist-packs/oracle-full-crypto.json +273 -0
  9. package/bin/desk-server.mjs +438 -0
  10. package/bin/oracle-data-mcp.mjs +603 -0
  11. package/bin/oracle-init.mjs +423 -0
  12. package/bin/oracle-public-server.mjs +36 -0
  13. package/bin/oracle-route.mjs +254 -0
  14. package/bin/oracle-scan.mjs +192 -0
  15. package/docs/adding-a-chain.md +229 -0
  16. package/docs/architecture.md +135 -0
  17. package/docs/profiles.md +132 -0
  18. package/examples/add-a-chain.mjs +65 -0
  19. package/examples/research-a-token.mjs +70 -0
  20. package/package.json +90 -0
  21. package/profiles/_template/SOUL.md +47 -0
  22. package/profiles/_template/profile.json +22 -0
  23. package/profiles/bitcoin-agent/SOUL.md +31 -0
  24. package/profiles/bitcoin-agent/profile.json +32 -0
  25. package/profiles/hyperliquid-agent/SOUL.md +34 -0
  26. package/profiles/hyperliquid-agent/profile.json +37 -0
  27. package/profiles/oracle/SOUL.md +65 -0
  28. package/profiles/oracle/profile.json +35 -0
  29. package/profiles/polymarket-agent/SOUL.md +35 -0
  30. package/profiles/polymarket-agent/profile.json +34 -0
  31. package/profiles/profile.schema.json +90 -0
  32. package/profiles/protocol-builder/SOUL.md +50 -0
  33. package/profiles/protocol-builder/profile.json +37 -0
  34. package/profiles/robinhood-agent/SOUL.md +45 -0
  35. package/profiles/robinhood-agent/profile.json +39 -0
  36. package/profiles/solana-agent/SOUL.md +37 -0
  37. package/profiles/solana-agent/profile.json +37 -0
  38. package/profiles/stable-agent/SOUL.md +43 -0
  39. package/profiles/stable-agent/profile.json +37 -0
  40. package/public/oracle-console/app.js +272 -0
  41. package/public/oracle-console/bitcoin-wallets.js +206 -0
  42. package/public/oracle-console/index.html +91 -0
  43. package/public/oracle-console/styles.css +239 -0
  44. package/public/oracle-splash/index.html +931 -0
  45. package/scripts/build-inscription.py +230 -0
  46. package/scripts/check-test-count.mjs +105 -0
  47. package/scripts/e2e-hl-markets.mjs +21 -0
  48. package/scripts/e2e-hl-perps.mjs +48 -0
  49. package/scripts/e2e-hypercore-staking.mjs +128 -0
  50. package/scripts/e2e-solana-bitcoin.mjs +183 -0
  51. package/scripts/public-api-scan.mjs +23 -0
  52. package/scripts/secret-scan.mjs +181 -0
  53. package/scripts/verify-v3-venues.mjs +192 -0
  54. package/skills/oracle-best-execution/SKILL.md +127 -0
  55. package/skills/oracle-bitcoin/SKILL.md +53 -0
  56. package/skills/oracle-chain-graphs-telegram-cards/SKILL.md +59 -0
  57. package/skills/oracle-circuit-breaker/SKILL.md +51 -0
  58. package/skills/oracle-contract-research/SKILL.md +55 -0
  59. package/skills/oracle-desk/SKILL.md +58 -0
  60. package/skills/oracle-dex-launch/SKILL.md +38 -0
  61. package/skills/oracle-grants/SKILL.md +69 -0
  62. package/skills/oracle-hypercore-staking/SKILL.md +57 -0
  63. package/skills/oracle-hyperliquid/SKILL.md +56 -0
  64. package/skills/oracle-meme-token-sniper/SKILL.md +73 -0
  65. package/skills/oracle-nft-gacha-launch/SKILL.md +48 -0
  66. package/skills/oracle-nft-mint-gas-war/SKILL.md +63 -0
  67. package/skills/oracle-polymarket/SKILL.md +60 -0
  68. package/skills/oracle-protocol-builder/SKILL.md +38 -0
  69. package/skills/oracle-protocol-security/SKILL.md +60 -0
  70. package/skills/oracle-public-product/SKILL.md +44 -0
  71. package/skills/oracle-receipts/SKILL.md +52 -0
  72. package/skills/oracle-rfq-tokenized-assets/SKILL.md +69 -0
  73. package/skills/oracle-smart-wallet-scanner/SKILL.md +49 -0
  74. package/skills/oracle-solana/SKILL.md +65 -0
  75. package/skills/oracle-solana-nft/SKILL.md +54 -0
  76. package/skills/oracle-token-research/SKILL.md +67 -0
  77. package/src/agent-auth.mjs +191 -0
  78. package/src/approval-guard.mjs +282 -0
  79. package/src/attestation-secret.mjs +88 -0
  80. package/src/audit-log.mjs +196 -0
  81. package/src/auto-slippage.mjs +378 -0
  82. package/src/capability-posture.mjs +125 -0
  83. package/src/chains.mjs +62 -0
  84. package/src/data/catalog.mjs +495 -0
  85. package/src/data/desk-data.mjs +623 -0
  86. package/src/data/http.mjs +200 -0
  87. package/src/data/provider-endpoint.mjs +94 -0
  88. package/src/data/providers/aerodrome.mjs +244 -0
  89. package/src/data/providers/balancer.mjs +208 -0
  90. package/src/data/providers/bitcoin-esplora.mjs +230 -0
  91. package/src/data/providers/bitcoin-meta.mjs +378 -0
  92. package/src/data/providers/blockscout.mjs +14 -0
  93. package/src/data/providers/bridges.mjs +241 -0
  94. package/src/data/providers/cowswap.mjs +501 -0
  95. package/src/data/providers/curve.mjs +200 -0
  96. package/src/data/providers/defillama.mjs +88 -0
  97. package/src/data/providers/dexscreener.mjs +43 -0
  98. package/src/data/providers/evm-rpc.mjs +203 -0
  99. package/src/data/providers/geckoterminal.mjs +34 -0
  100. package/src/data/providers/gmx.mjs +495 -0
  101. package/src/data/providers/hl-info.mjs +102 -0
  102. package/src/data/providers/hl-markets.mjs +210 -0
  103. package/src/data/providers/hl-perps.mjs +382 -0
  104. package/src/data/providers/hl-staking.mjs +352 -0
  105. package/src/data/providers/hl-ws.mjs +119 -0
  106. package/src/data/providers/hyperevm-dex.mjs +49 -0
  107. package/src/data/providers/jupiter.mjs +182 -0
  108. package/src/data/providers/lifi.mjs +150 -0
  109. package/src/data/providers/magiceden-sol.mjs +355 -0
  110. package/src/data/providers/morpho.mjs +173 -0
  111. package/src/data/providers/odos.mjs +155 -0
  112. package/src/data/providers/oneinch.mjs +173 -0
  113. package/src/data/providers/opensea-multichain.mjs +136 -0
  114. package/src/data/providers/opensea-nft.mjs +99 -0
  115. package/src/data/providers/paraswap.mjs +117 -0
  116. package/src/data/providers/pendle.mjs +187 -0
  117. package/src/data/providers/poly-public.mjs +96 -0
  118. package/src/data/providers/poly-ws.mjs +103 -0
  119. package/src/data/providers/rh-agent.mjs +59 -0
  120. package/src/data/providers/satflow.mjs +336 -0
  121. package/src/data/providers/solana-rpc.mjs +186 -0
  122. package/src/data/providers/uniswap-v3.mjs +303 -0
  123. package/src/data/providers/zerox.mjs +166 -0
  124. package/src/data/public-api-scan.mjs +61 -0
  125. package/src/data/quote-placeholder.mjs +31 -0
  126. package/src/exact-integer.mjs +72 -0
  127. package/src/exec-policy.mjs +444 -0
  128. package/src/flags.mjs +15 -0
  129. package/src/fresh-window.mjs +76 -0
  130. package/src/gmx-attestation.mjs +175 -0
  131. package/src/index.mjs +50 -0
  132. package/src/nft-gas-war-guard.mjs +139 -0
  133. package/src/onboarding/agent-keys.mjs +157 -0
  134. package/src/onboarding/index.mjs +18 -0
  135. package/src/onboarding/tiers.mjs +139 -0
  136. package/src/oracle-env.mjs +38 -0
  137. package/src/protocol-execution.mjs +84 -0
  138. package/src/public-api/buzz-integration.mjs +256 -0
  139. package/src/public-api/connect-agent.mjs +397 -0
  140. package/src/public-api/grants.mjs +142 -0
  141. package/src/public-api/http.mjs +374 -0
  142. package/src/public-control/aa-adapter.mjs +402 -0
  143. package/src/public-control/build-registry.mjs +227 -0
  144. package/src/public-control/bundler-client.mjs +372 -0
  145. package/src/public-control/grant-indexer.mjs +296 -0
  146. package/src/public-control/policy-render.mjs +69 -0
  147. package/src/public-control/policy-schema.mjs +318 -0
  148. package/src/public-control/runtime-config.mjs +265 -0
  149. package/src/public-control/session-key-model.mjs +374 -0
  150. package/src/public-control/session-orchestrator.mjs +412 -0
  151. package/src/route-attestation.mjs +132 -0
  152. package/src/router/best-execution.mjs +221 -0
  153. package/src/router/index.mjs +185 -0
  154. package/src/router/prepare-bridge.mjs +288 -0
  155. package/src/router/prepare-route.mjs +341 -0
  156. package/src/router/proposal.mjs +311 -0
  157. package/src/router/risk-classifier.mjs +119 -0
  158. package/src/router/route-sources.mjs +292 -0
  159. package/src/scanner/chains.config.mjs +381 -0
  160. package/src/scanner/contract.mjs +270 -0
  161. package/src/scanner/evm-scanner.mjs +394 -0
  162. package/src/scanner/index.mjs +9 -0
  163. package/src/scanner/v2-venue.mjs +335 -0
  164. package/src/scanner/v3-venue.mjs +290 -0
  165. package/src/scopes.mjs +44 -0
  166. package/src/sell-simulation.mjs +167 -0
  167. package/src/token-transfer-guard.mjs +188 -0
  168. package/src/vault-attestation.mjs +145 -0
  169. package/src/venues.mjs +206 -0
@@ -0,0 +1,335 @@
1
+ // Venue-backed capabilities: quote, sellSimulation, prepareUnsignedTx.
2
+ //
3
+ // These are the three capabilities the generic scanner cannot provide, because each
4
+ // one needs a VERIFIED router address for the specific chain. That is not a gap to
5
+ // paper over -- it is the reason the destination allowlist exists.
6
+ //
7
+ // Scope: Uniswap-V2-style routers (getAmountsOut / swapExactTokensForTokens), which
8
+ // covers the large majority of forks across EVM chains. A V3/V4 or custom-quoter
9
+ // venue needs its own adapter; see the notes at the bottom.
10
+ //
11
+ // Custody: prepareUnsignedTx returns an UNSIGNED transaction object. Nothing here
12
+ // holds a key, signs, or broadcasts. The user's wallet does that.
13
+
14
+ import { rpcCall } from "../data/providers/evm-rpc.mjs";
15
+ import { EVIDENCE, RISK } from "./contract.mjs";
16
+
17
+ // --- ABI encode/decode, kept dependency-free ---------------------------------
18
+
19
+ const SEL = {
20
+ // getAmountsOut(uint256,address[])
21
+ getAmountsOut: "d06ca61f",
22
+ // swapExactTokensForTokens(uint256,uint256,address[],address,uint256)
23
+ swapExactTokensForTokens: "38ed1739",
24
+ // swapExactETHForTokens(uint256,address[],address,uint256)
25
+ swapExactETHForTokens: "7ff36ab5",
26
+ };
27
+
28
+ const word = (v) => BigInt(v).toString(16).padStart(64, "0");
29
+ const addrWord = (a) => a.slice(2).toLowerCase().padStart(64, "0");
30
+
31
+ function encodeAmountsOut(amountIn, path) {
32
+ return (
33
+ `0x${SEL.getAmountsOut}` +
34
+ word(amountIn) +
35
+ word(64) + // offset to the array
36
+ word(path.length) +
37
+ path.map(addrWord).join("")
38
+ );
39
+ }
40
+
41
+ /** Decode a `uint256[]` return. */
42
+ function decodeUintArray(hex) {
43
+ if (!hex || hex === "0x") return null;
44
+ const b = hex.slice(2);
45
+ if (b.length < 128) return null;
46
+ const n = Number(BigInt(`0x${b.slice(64, 128)}`));
47
+ if (!Number.isFinite(n) || n < 1 || n > 16) return null;
48
+ const out = [];
49
+ for (let i = 0; i < n; i++) {
50
+ const start = 128 + i * 64;
51
+ if (b.length < start + 64) return null;
52
+ out.push(BigInt(`0x${b.slice(start, start + 64)}`));
53
+ }
54
+ return out;
55
+ }
56
+
57
+ function routerOf(scanner, kind = "router") {
58
+ const v = (scanner?.venues || []).find((x) => x.kind === kind);
59
+ return v?.address ?? null;
60
+ }
61
+
62
+ /**
63
+ * Apply a slippage guard to get minOut.
64
+ *
65
+ * The supplied tolerance is a MAXIMUM, not the value to use, and it is capped hard.
66
+ * A guard that yields under pressure is decoration -- if a route needs more than the
67
+ * cap, the correct answer is to block and requote, not to widen.
68
+ */
69
+ const MAX_SLIPPAGE_BPS = 100;
70
+
71
+ export function applySlippage(amountOut, slippageBps) {
72
+ const bps = Number(slippageBps);
73
+ if (!Number.isFinite(bps) || bps < 0) {
74
+ throw new Error("slippageBps must be a non-negative number");
75
+ }
76
+ if (bps > MAX_SLIPPAGE_BPS) {
77
+ throw new Error(
78
+ `slippageBps ${bps} exceeds the ${MAX_SLIPPAGE_BPS} bps ceiling. ` +
79
+ "Block and requote or split the order -- do not widen the guard to force a fill.",
80
+ );
81
+ }
82
+ return (BigInt(amountOut) * BigInt(10_000 - Math.floor(bps))) / 10_000n;
83
+ }
84
+
85
+ // --- capability implementations ----------------------------------------------
86
+
87
+ /**
88
+ * Build the venue-backed capabilities for a chain that has a verified V2 router.
89
+ *
90
+ * @param {object} cfg
91
+ * @param {number} cfg.chainId
92
+ * @param {string} [cfg.wrappedNative] needed to route native<->token
93
+ */
94
+ export function v2VenueCapabilities(cfg) {
95
+ const { chainId, wrappedNative } = cfg;
96
+
97
+ async function amountsOut(router, amountIn, path, opts) {
98
+ const res = await rpcCall(
99
+ chainId,
100
+ "eth_call",
101
+ [{ to: router, data: encodeAmountsOut(amountIn, path) }, "latest"],
102
+ opts,
103
+ );
104
+ return decodeUintArray(res?.result ?? res);
105
+ }
106
+
107
+ return {
108
+ /**
109
+ * Price an exact-input route. Read-only; touches no state.
110
+ */
111
+ async quote({ tokenIn, tokenOut, amountIn, path }, opts = {}) {
112
+ const router = routerOf(opts.scanner);
113
+ if (!router) {
114
+ return {
115
+ chainId,
116
+ evidence: EVIDENCE.UNAVAILABLE,
117
+ reason:
118
+ "no verified router configured for this chain; quoting stays fail-closed " +
119
+ "rather than guessing a venue address",
120
+ };
121
+ }
122
+ const route = path || [tokenIn, tokenOut];
123
+ if (route.some((a) => !/^0x[0-9a-fA-F]{40}$/.test(a || ""))) {
124
+ throw new Error("quote requires valid 20-byte addresses");
125
+ }
126
+
127
+ const amounts = await amountsOut(router, amountIn, route, opts);
128
+ if (!amounts) {
129
+ return {
130
+ chainId,
131
+ router,
132
+ path: route,
133
+ evidence: EVIDENCE.UNKNOWN,
134
+ reason: "router returned no amounts -- no pool for this path, or the call reverted",
135
+ };
136
+ }
137
+
138
+ return {
139
+ chainId,
140
+ router,
141
+ path: route,
142
+ amountIn: String(amountIn),
143
+ amountOut: amounts[amounts.length - 1].toString(),
144
+ hops: route.length - 1,
145
+ evidence: EVIDENCE.LIVE,
146
+ // The price a quote reports is pre-slippage and pre-gas. Saying so prevents
147
+ // it being read as an expected fill.
148
+ note: "exact-input quote at current reserves; not a guaranteed fill",
149
+ };
150
+ },
151
+
152
+ /**
153
+ * Round-trip check: buy the token, then sell it back.
154
+ *
155
+ * This is the single most valuable check on a low-cap venue. Most losses are not
156
+ * bad entries -- they are tokens that buy cleanly and cannot be sold. A
157
+ * successful BUY quote proves nothing about the sell side.
158
+ *
159
+ * State-free: both legs are eth_call quotes, so nothing is spent to learn this.
160
+ */
161
+ async sellSimulation({ token, amountIn, base }, opts = {}) {
162
+ const router = routerOf(opts.scanner);
163
+ const quoteBase = base || wrappedNative;
164
+ if (!router || !quoteBase) {
165
+ return {
166
+ chainId,
167
+ token,
168
+ verdict: RISK.UNKNOWN,
169
+ evidence: EVIDENCE.UNAVAILABLE,
170
+ reason: router
171
+ ? "no wrappedNative configured for this chain, so no base asset to round-trip against"
172
+ : "no verified router configured for this chain",
173
+ };
174
+ }
175
+
176
+ const buy = await amountsOut(router, amountIn, [quoteBase, token], opts);
177
+ if (!buy) {
178
+ return {
179
+ chainId,
180
+ token,
181
+ verdict: RISK.FAIL,
182
+ evidence: EVIDENCE.LIVE,
183
+ leg: "buy",
184
+ reason: "buy leg returned no amounts -- no route in",
185
+ };
186
+ }
187
+ const bought = buy[buy.length - 1];
188
+ if (bought === 0n) {
189
+ return {
190
+ chainId,
191
+ token,
192
+ verdict: RISK.FAIL,
193
+ evidence: EVIDENCE.LIVE,
194
+ leg: "buy",
195
+ reason: "buy leg quotes zero output",
196
+ };
197
+ }
198
+
199
+ const sell = await amountsOut(router, bought, [token, quoteBase], opts);
200
+ if (!sell) {
201
+ // The honeypot signature: in works, out does not.
202
+ return {
203
+ chainId,
204
+ token,
205
+ verdict: RISK.FAIL,
206
+ evidence: EVIDENCE.LIVE,
207
+ leg: "sell",
208
+ bought: bought.toString(),
209
+ reason:
210
+ "SELL LEG FAILED while the buy leg quoted fine. This is the honeypot " +
211
+ "signature: do not trade.",
212
+ };
213
+ }
214
+
215
+ const returned = sell[sell.length - 1];
216
+ // Retention in bps of the original input. A clean V2 round trip loses roughly
217
+ // 2x the pool fee plus impact, so ~9940 bps on a deep pool at small size.
218
+ const retentionBps = Number((returned * 10_000n) / BigInt(amountIn));
219
+
220
+ // Thresholds are deliberately loose: this separates "taxed or illiquid" from
221
+ // "normal", not "good trade" from "bad trade".
222
+ let verdict = RISK.PASS;
223
+ let reason = "round trip completes with expected fee/impact loss";
224
+ if (retentionBps < 5_000) {
225
+ verdict = RISK.FAIL;
226
+ reason = `round trip returns only ${(retentionBps / 100).toFixed(2)}% -- punitive tax or no real liquidity`;
227
+ } else if (retentionBps < 9_000) {
228
+ verdict = RISK.CAUTION;
229
+ reason = `round trip returns ${(retentionBps / 100).toFixed(2)}% -- transfer tax or thin liquidity at this size`;
230
+ }
231
+
232
+ return {
233
+ chainId,
234
+ token,
235
+ base: quoteBase,
236
+ router,
237
+ verdict,
238
+ reason,
239
+ amountIn: String(amountIn),
240
+ bought: bought.toString(),
241
+ returned: returned.toString(),
242
+ retentionBps,
243
+ evidence: EVIDENCE.LIVE,
244
+ note: "Quote-level round trip. It does not prove transfer hooks absent at execution time.",
245
+ };
246
+ },
247
+
248
+ /**
249
+ * Build an UNSIGNED swap transaction.
250
+ *
251
+ * Returns a plain transaction object for the caller's wallet to sign. There is no
252
+ * signing path in this module by construction.
253
+ */
254
+ async prepareUnsignedTx(
255
+ { tokenIn, tokenOut, amountIn, recipient, slippageBps = 50, deadlineSeconds = 900, path },
256
+ opts = {},
257
+ ) {
258
+ const scanner = opts.scanner;
259
+ const router = routerOf(scanner);
260
+ if (!router) {
261
+ throw new Error(
262
+ `chain ${chainId} has no verified router; preparing a swap stays fail-closed. ` +
263
+ "Add a venue with recorded provenance first (see docs/adding-a-chain.md).",
264
+ );
265
+ }
266
+ if (!/^0x[0-9a-fA-F]{40}$/.test(recipient || "")) {
267
+ throw new Error("prepareUnsignedTx requires a valid recipient address");
268
+ }
269
+
270
+ const route = path || [tokenIn, tokenOut];
271
+ const q = await this.quote({ tokenIn, tokenOut, amountIn, path: route }, opts);
272
+ if (q.evidence !== EVIDENCE.LIVE) {
273
+ throw new Error(
274
+ `cannot prepare without a live quote (${q.evidence}: ${q.reason ?? "no reason given"})`,
275
+ );
276
+ }
277
+
278
+ // Guard computed from the live quote, not from a stale number.
279
+ const minOut = applySlippage(q.amountOut, slippageBps);
280
+ if (minOut <= 0n) throw new Error("computed minOut is zero -- refusing to prepare");
281
+
282
+ const deadline = BigInt(Math.floor(Date.now() / 1000) + Number(deadlineSeconds));
283
+ const isNativeIn =
284
+ wrappedNative && route[0].toLowerCase() === wrappedNative.toLowerCase() && opts.useNative;
285
+
286
+ const data = isNativeIn
287
+ ? `0x${SEL.swapExactETHForTokens}` +
288
+ word(minOut) +
289
+ word(128) +
290
+ addrWord(recipient) +
291
+ word(deadline) +
292
+ word(route.length) +
293
+ route.map(addrWord).join("")
294
+ : `0x${SEL.swapExactTokensForTokens}` +
295
+ word(amountIn) +
296
+ word(minOut) +
297
+ word(160) +
298
+ addrWord(recipient) +
299
+ word(deadline) +
300
+ word(route.length) +
301
+ route.map(addrWord).join("");
302
+
303
+ return {
304
+ unsigned: true,
305
+ signedBy: "user-wallet",
306
+ chainId,
307
+ tx: {
308
+ to: router,
309
+ data,
310
+ value: isNativeIn ? `0x${BigInt(amountIn).toString(16)}` : "0x0",
311
+ },
312
+ guard: {
313
+ quotedOut: q.amountOut,
314
+ minOut: minOut.toString(),
315
+ slippageBps,
316
+ maxSlippageBps: MAX_SLIPPAGE_BPS,
317
+ deadline: deadline.toString(),
318
+ },
319
+ // An ERC-20 input needs an allowance first. Reporting it as a separate step
320
+ // keeps "approved" and "swapped" from being collapsed into one claim.
321
+ requires: isNativeIn
322
+ ? []
323
+ : [{ step: "approve", token: route[0], spender: router, amount: String(amountIn) }],
324
+ note:
325
+ "UNSIGNED. Re-verify the guard against a fresh quote immediately before " +
326
+ "signing -- a quote-time minimum is not a minimum at broadcast time.",
327
+ };
328
+ },
329
+ };
330
+ }
331
+
332
+ // A V3/V4 or custom-quoter venue does NOT fit this adapter: V3 needs a Quoter
333
+ // contract and fee tiers, and some forks require an off-chain signed quote that
334
+ // cannot be forged locally. Write a sibling adapter rather than bending this one --
335
+ // silently mis-encoding a swap is worse than declaring the capability unsupported.
@@ -0,0 +1,290 @@
1
+ // Uniswap V3 venue adapter.
2
+ //
3
+ // The V2 adapter cannot be bent to cover V3: V3 has no getAmountsOut, prices through
4
+ // a separate Quoter contract, and requires an explicit fee tier per hop. Encoding a
5
+ // V3 swap with V2 assumptions produces a transaction that looks plausible and
6
+ // reverts -- or worse, routes through the wrong pool. So this is a sibling adapter,
7
+ // as docs/adding-a-chain.md prescribes.
8
+ //
9
+ // Custody is unchanged: quotes are eth_call, prepare returns an UNSIGNED tx, and
10
+ // nothing in this module can sign or broadcast.
11
+
12
+ import { rpcCall } from "../data/providers/evm-rpc.mjs";
13
+ import { EVIDENCE, RISK } from "./contract.mjs";
14
+
15
+ // Standard V3 fee tiers, cheapest first. 100 (0.01%) exists mainly for stable pairs.
16
+ export const FEE_TIERS = [100, 500, 3000, 10000];
17
+
18
+ const SEL = {
19
+ // QuoterV2.quoteExactInputSingle((address,address,uint256,uint24,uint160))
20
+ quoteExactInputSingle: "c6a5026a",
21
+ // SwapRouter02.exactInputSingle((address,address,uint24,address,uint256,uint256,uint160))
22
+ exactInputSingle: "04e45aaf",
23
+ };
24
+
25
+ const word = (v) => BigInt(v).toString(16).padStart(64, "0");
26
+ const addrWord = (a) => a.slice(2).toLowerCase().padStart(64, "0");
27
+ const ADDRESS_RE = /^0x[0-9a-fA-F]{40}$/;
28
+
29
+ const MAX_SLIPPAGE_BPS = 100;
30
+
31
+ export function applySlippage(amountOut, slippageBps) {
32
+ const bps = Number(slippageBps);
33
+ if (!Number.isFinite(bps) || bps < 0) {
34
+ throw new Error("slippageBps must be a non-negative number");
35
+ }
36
+ if (bps > MAX_SLIPPAGE_BPS) {
37
+ throw new Error(
38
+ `slippageBps ${bps} exceeds the ${MAX_SLIPPAGE_BPS} bps ceiling. ` +
39
+ "Block and requote or split the order -- do not widen the guard to force a fill.",
40
+ );
41
+ }
42
+ return (BigInt(amountOut) * BigInt(10_000 - Math.floor(bps))) / 10_000n;
43
+ }
44
+
45
+ function venueOf(scanner, kind) {
46
+ return (scanner?.venues || []).find((v) => v.kind === kind)?.address ?? null;
47
+ }
48
+
49
+ /**
50
+ * Build V3 capabilities for a chain with a verified quoter + router.
51
+ *
52
+ * @param {object} cfg
53
+ * @param {number} cfg.chainId
54
+ * @param {string} [cfg.wrappedNative]
55
+ */
56
+ export function v3VenueCapabilities(cfg) {
57
+ const { chainId, wrappedNative } = cfg;
58
+
59
+ /** Quote one fee tier. Returns null when that tier has no usable pool. */
60
+ async function quoteTier({ quoter, tokenIn, tokenOut, amountIn, fee }, opts) {
61
+ const data =
62
+ `0x${SEL.quoteExactInputSingle}` +
63
+ addrWord(tokenIn) +
64
+ addrWord(tokenOut) +
65
+ word(amountIn) +
66
+ word(fee) +
67
+ word(0); // sqrtPriceLimitX96 = 0, no limit
68
+
69
+ const r = await rpcCall(chainId, "eth_call", [{ to: quoter, data }, "latest"], opts).catch(
70
+ () => null,
71
+ );
72
+ const raw = r?.result ?? r;
73
+ if (!raw || raw === "0x" || raw.length < 66) return null;
74
+ const out = BigInt(`0x${raw.slice(2, 66)}`);
75
+ return out > 0n ? out : null;
76
+ }
77
+
78
+ /**
79
+ * Try every fee tier and keep the best.
80
+ *
81
+ * Necessary rather than a nicety: liquidity for a given pair concentrates in one
82
+ * tier, and which tier varies by pair and chain. Guessing 0.3% because it is the
83
+ * common default silently misprices stable pairs and exotic pairs alike.
84
+ */
85
+ async function bestQuote({ quoter, tokenIn, tokenOut, amountIn }, opts) {
86
+ const tried = [];
87
+ let best = null;
88
+
89
+ for (const fee of FEE_TIERS) {
90
+ const out = await quoteTier({ quoter, tokenIn, tokenOut, amountIn, fee }, opts);
91
+ tried.push({ fee, amountOut: out ? out.toString() : null });
92
+ if (out && (!best || out > best.amountOut)) best = { fee, amountOut: out };
93
+ }
94
+ return { best, tried };
95
+ }
96
+
97
+ return {
98
+ async quote({ tokenIn, tokenOut, amountIn }, opts = {}) {
99
+ const quoter = venueOf(opts.scanner, "quoter");
100
+ if (!quoter) {
101
+ return {
102
+ chainId,
103
+ evidence: EVIDENCE.UNAVAILABLE,
104
+ reason:
105
+ "no verified quoter configured for this chain; quoting stays fail-closed " +
106
+ "rather than guessing a venue address",
107
+ };
108
+ }
109
+ for (const a of [tokenIn, tokenOut]) {
110
+ if (!ADDRESS_RE.test(a || "")) throw new Error("quote requires valid 20-byte addresses");
111
+ }
112
+
113
+ const { best, tried } = await bestQuote({ quoter, tokenIn, tokenOut, amountIn }, opts);
114
+ if (!best) {
115
+ return {
116
+ chainId,
117
+ quoter,
118
+ tokenIn,
119
+ tokenOut,
120
+ triedFeeTiers: tried,
121
+ evidence: EVIDENCE.UNKNOWN,
122
+ reason: "no fee tier returned a quote -- no V3 pool for this pair, or no liquidity",
123
+ };
124
+ }
125
+
126
+ return {
127
+ chainId,
128
+ venue: "uniswap-v3",
129
+ quoter,
130
+ tokenIn,
131
+ tokenOut,
132
+ amountIn: String(amountIn),
133
+ amountOut: best.amountOut.toString(),
134
+ fee: best.fee,
135
+ triedFeeTiers: tried,
136
+ evidence: EVIDENCE.LIVE,
137
+ note: "exact-input single-hop quote at current tick; not a guaranteed fill",
138
+ };
139
+ },
140
+
141
+ /**
142
+ * Round trip: buy the token with the base asset, then sell it back.
143
+ *
144
+ * Same reasoning as the V2 adapter -- a clean buy quote proves nothing about the
145
+ * exit, and a token you cannot sell is the most expensive kind of mistake.
146
+ */
147
+ async sellSimulation({ token, amountIn, base }, opts = {}) {
148
+ const quoter = venueOf(opts.scanner, "quoter");
149
+ const quoteBase = base || wrappedNative;
150
+ if (!quoter || !quoteBase) {
151
+ return {
152
+ chainId,
153
+ token,
154
+ verdict: RISK.UNKNOWN,
155
+ evidence: EVIDENCE.UNAVAILABLE,
156
+ reason: quoter
157
+ ? "no wrappedNative configured, so there is no base asset to round-trip against"
158
+ : "no verified quoter configured for this chain",
159
+ };
160
+ }
161
+
162
+ const buy = await bestQuote(
163
+ { quoter, tokenIn: quoteBase, tokenOut: token, amountIn },
164
+ opts,
165
+ );
166
+ if (!buy.best) {
167
+ return {
168
+ chainId,
169
+ token,
170
+ verdict: RISK.FAIL,
171
+ evidence: EVIDENCE.LIVE,
172
+ leg: "buy",
173
+ reason: "no V3 pool priced the buy leg on any fee tier",
174
+ };
175
+ }
176
+
177
+ const sell = await bestQuote(
178
+ { quoter, tokenIn: token, tokenOut: quoteBase, amountIn: buy.best.amountOut },
179
+ opts,
180
+ );
181
+ if (!sell.best) {
182
+ return {
183
+ chainId,
184
+ token,
185
+ verdict: RISK.FAIL,
186
+ evidence: EVIDENCE.LIVE,
187
+ leg: "sell",
188
+ bought: buy.best.amountOut.toString(),
189
+ reason:
190
+ "SELL LEG FAILED while the buy leg quoted fine. This is the honeypot " +
191
+ "signature: do not trade.",
192
+ };
193
+ }
194
+
195
+ const returned = sell.best.amountOut;
196
+ const retentionBps = Number((returned * 10_000n) / BigInt(amountIn));
197
+
198
+ let verdict = RISK.PASS;
199
+ let reason = "round trip completes with expected fee/impact loss";
200
+ if (retentionBps < 5_000) {
201
+ verdict = RISK.FAIL;
202
+ reason = `round trip returns only ${(retentionBps / 100).toFixed(2)}% -- punitive tax or no real liquidity`;
203
+ } else if (retentionBps < 9_000) {
204
+ verdict = RISK.CAUTION;
205
+ reason = `round trip returns ${(retentionBps / 100).toFixed(2)}% -- transfer tax or thin liquidity at this size`;
206
+ }
207
+
208
+ return {
209
+ chainId,
210
+ venue: "uniswap-v3",
211
+ token,
212
+ base: quoteBase,
213
+ verdict,
214
+ reason,
215
+ amountIn: String(amountIn),
216
+ bought: buy.best.amountOut.toString(),
217
+ returned: returned.toString(),
218
+ retentionBps,
219
+ buyFee: buy.best.fee,
220
+ sellFee: sell.best.fee,
221
+ evidence: EVIDENCE.LIVE,
222
+ note: "Quote-level round trip. It does not prove transfer hooks absent at execution time.",
223
+ };
224
+ },
225
+
226
+ /**
227
+ * Build an UNSIGNED exactInputSingle swap.
228
+ *
229
+ * The fee tier comes from the live quote rather than a default, so the prepared
230
+ * transaction routes through the same pool that produced the price.
231
+ */
232
+ async prepareUnsignedTx(
233
+ { tokenIn, tokenOut, amountIn, recipient, slippageBps = 50, fee },
234
+ opts = {},
235
+ ) {
236
+ const router = venueOf(opts.scanner, "router");
237
+ if (!router) {
238
+ throw new Error(
239
+ `chain ${chainId} has no verified V3 router; preparing a swap stays fail-closed. ` +
240
+ "Add a venue with recorded provenance first (see docs/adding-a-chain.md).",
241
+ );
242
+ }
243
+ if (!ADDRESS_RE.test(recipient || "")) {
244
+ throw new Error("prepareUnsignedTx requires a valid recipient address");
245
+ }
246
+
247
+ const q = await this.quote({ tokenIn, tokenOut, amountIn }, opts);
248
+ if (q.evidence !== EVIDENCE.LIVE) {
249
+ throw new Error(
250
+ `cannot prepare without a live quote (${q.evidence}: ${q.reason ?? "no reason given"})`,
251
+ );
252
+ }
253
+
254
+ const useFee = fee ?? q.fee;
255
+ const minOut = applySlippage(q.amountOut, slippageBps);
256
+ if (minOut <= 0n) throw new Error("computed minOut is zero -- refusing to prepare");
257
+
258
+ const data =
259
+ `0x${SEL.exactInputSingle}` +
260
+ addrWord(tokenIn) +
261
+ addrWord(tokenOut) +
262
+ word(useFee) +
263
+ addrWord(recipient) +
264
+ word(amountIn) +
265
+ word(minOut) +
266
+ word(0); // sqrtPriceLimitX96
267
+
268
+ return {
269
+ unsigned: true,
270
+ signedBy: "user-wallet",
271
+ chainId,
272
+ venue: "uniswap-v3",
273
+ tx: { to: router, data, value: "0x0" },
274
+ guard: {
275
+ quotedOut: q.amountOut,
276
+ minOut: minOut.toString(),
277
+ slippageBps,
278
+ maxSlippageBps: MAX_SLIPPAGE_BPS,
279
+ fee: useFee,
280
+ },
281
+ requires: [
282
+ { step: "approve", token: tokenIn, spender: router, amount: String(amountIn) },
283
+ ],
284
+ note:
285
+ "UNSIGNED. Re-verify the guard against a fresh quote immediately before " +
286
+ "signing -- a quote-time minimum is not a minimum at broadcast time.",
287
+ };
288
+ },
289
+ };
290
+ }
package/src/scopes.mjs ADDED
@@ -0,0 +1,44 @@
1
+ // Delegation scopes — mirrors the RH agent's Agent Connect model so a user's
2
+ // scoped key can only ever authorize actions on THEIR OWN wallet.
3
+
4
+ export const ALLOWED_SCOPES = new Set([
5
+ "read:markets",
6
+ "read:nfts",
7
+ "read:positions",
8
+ "watch:contracts",
9
+ "prepare:trade",
10
+ "prepare:mint",
11
+ // Build verb. `prepare:build` produces a non-executable proposal describing
12
+ // what would be created. `build:factory` authorizes actually calling an
13
+ // ALLOWLISTED factory — never arbitrary bytecode. See public-control/build-registry.mjs
14
+ "prepare:build",
15
+ "build:factory",
16
+ "agent:shadow",
17
+ "agent:execute",
18
+ ]);
19
+
20
+ export const EXECUTE_SCOPE = "agent:execute";
21
+ /** Authorizes a real factory call. Gated separately from agent:execute so that
22
+ * arming trading never implicitly arms contract creation. */
23
+ export const BUILD_SCOPE = "build:factory";
24
+
25
+ // Safe default: everything EXCEPT live execution and live building.
26
+ export const DEFAULT_SCOPES = [
27
+ "read:markets",
28
+ "read:nfts",
29
+ "read:positions",
30
+ "watch:contracts",
31
+ "prepare:trade",
32
+ "prepare:mint",
33
+ "prepare:build",
34
+ "agent:shadow",
35
+ ];
36
+
37
+ /** Validate + dedupe requested scopes; empty falls back to DEFAULT_SCOPES. */
38
+ export function normalizeScopes(scopes) {
39
+ const requested = Array.isArray(scopes) && scopes.length ? scopes : DEFAULT_SCOPES;
40
+ const normalized = [...new Set(requested.map((s) => String(s).trim()).filter(Boolean))];
41
+ const invalid = normalized.filter((s) => !ALLOWED_SCOPES.has(s));
42
+ if (invalid.length) throw new Error(`Invalid scope: ${invalid.join(", ")}`);
43
+ return normalized;
44
+ }