@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,196 @@
1
+ // Tamper-evident, append-only audit hash-chain for the Oracle exec layer.
2
+ //
3
+ // Adapted from block/buzz `buzz-audit` (Rust + Postgres, multi-tenant) to Oracle's
4
+ // single-process, file-backed model. Fills the gap the custody review found:
5
+ // the armed executor had a rolling daily-spend counter and NO tamper-evident
6
+ // record of what it prepared / signed / broadcast. This is the compliance/trust
7
+ // spine the non-custodial agency product needs, shared by every oracle-<chain>
8
+ // worker that routes through the exec-server.
9
+ //
10
+ // Each entry chains to the previous via SHA-256 over a FIXED field order that
11
+ // includes `prev_hash`, so deleting, editing, or reordering any entry breaks
12
+ // verification of every entry after it. `detail` is folded in via canonical
13
+ // JSON (recursively sorted keys) so the hash is stable across Arch/VPS/Mac.
14
+ //
15
+ // SECURITY: `detail` is persisted verbatim and included in the hash. NEVER write
16
+ // bearer tokens, private keys, passwords, or keystore passphrases into it. Log
17
+ // outcome metadata (chainId, to, value, hash, reason) only.
18
+
19
+ import { createHash } from "node:crypto";
20
+ import { readFileSync, appendFileSync, existsSync, mkdirSync } from "node:fs";
21
+ import { dirname } from "node:path";
22
+ import { configPath, env } from "./oracle-env.mjs";
23
+
24
+ /** 32-byte sentinel (hex) hashed in place of prev_hash for the first entry. */
25
+ export const GENESIS_HASH = "0".repeat(64);
26
+
27
+ /** Actions the exec layer records. Unknown actions are allowed (forward-compat)
28
+ * but this set documents the vocabulary and lets tests assert coverage. */
29
+ export const AUDIT_ACTIONS = Object.freeze({
30
+ PREPARE: "exec.prepare",
31
+ SIGN: "exec.sign",
32
+ BROADCAST: "exec.broadcast",
33
+ POLICY_REJECT: "policy.reject",
34
+ AUTH_GRANT: "auth.grant",
35
+ AUTH_OK: "auth.verify.ok",
36
+ AUTH_FAIL: "auth.verify.fail",
37
+ });
38
+
39
+ function defaultPath() {
40
+ return configPath("audit-log.jsonl", "ORACLE_AUDIT_LOG", "MAD_AUDIT_LOG");
41
+ }
42
+
43
+ /** Deterministic JSON: object keys sorted recursively. Matches buzz-audit's
44
+ * canonical_json so the same detail hashes identically everywhere. */
45
+ export function canonicalJson(value) {
46
+ if (value === null || value === undefined) return "null";
47
+ if (typeof value !== "object") return JSON.stringify(value);
48
+ if (Array.isArray(value)) return "[" + value.map(canonicalJson).join(",") + "]";
49
+ const keys = Object.keys(value).sort();
50
+ return (
51
+ "{" +
52
+ keys.map((k) => JSON.stringify(k) + ":" + canonicalJson(value[k])).join(",") +
53
+ "}"
54
+ );
55
+ }
56
+
57
+ // Fixed field order — changing it invalidates every existing chain. `stream`
58
+ // leads the hash so an entry cannot be lifted out of one stream's chain and
59
+ // re-verified inside another (the tenant-binding property buzz-audit gets from
60
+ // hashing community_id first). Presence tags (\x00 / \x01) distinguish a null
61
+ // field from an empty-string field so they can't collide.
62
+ export function computeHash(entry) {
63
+ const h = createHash("sha256");
64
+ h.update(String(entry.stream), "utf8");
65
+ h.update(String(entry.seq), "utf8");
66
+ h.update(String(entry.ts), "utf8");
67
+ h.update(String(entry.action), "utf8");
68
+ h.update(entry.actor == null ? "\x00" : "\x01" + entry.actor, "utf8");
69
+ h.update(entry.objectId == null ? "\x00" : "\x01" + entry.objectId, "utf8");
70
+ h.update(canonicalJson(entry.detail ?? null), "utf8");
71
+ h.update(entry.prevHash ?? GENESIS_HASH, "utf8");
72
+ return h.digest("hex");
73
+ }
74
+
75
+ function readAll(path) {
76
+ if (!existsSync(path)) return [];
77
+ const raw = readFileSync(path, "utf8");
78
+ const out = [];
79
+ for (const line of raw.split("\n")) {
80
+ const s = line.trim();
81
+ if (!s) continue;
82
+ try {
83
+ out.push(JSON.parse(s));
84
+ } catch {
85
+ // A corrupt/partial trailing line is surfaced by verifyChain, not silently
86
+ // healed. Skip it here so the head lookup uses the last *valid* record.
87
+ }
88
+ }
89
+ return out;
90
+ }
91
+
92
+ // Serialize appends within this process so read-head → append is atomic even
93
+ // under concurrent exec-server requests (mirrors buzz-audit's per-chain lock).
94
+ let appendQueue = Promise.resolve();
95
+
96
+ /**
97
+ * Append one entry to the chain. Returns the full stored record.
98
+ * @param {object} opts
99
+ * @param {string} opts.action one of AUDIT_ACTIONS (or a custom string)
100
+ * @param {string} [opts.actor] signer/owner address or agent id
101
+ * @param {string} [opts.objectId] tx hash, chainId:to, grant id, ...
102
+ * @param {object} [opts.detail] hashed outcome metadata (NO secrets)
103
+ * @param {string} [opts.stream] logical chain label (default "mad-exec")
104
+ * @param {string} [opts.path] override log path (tests)
105
+ */
106
+ export function appendAudit({ action, actor = null, objectId = null, detail = null, stream, path } = {}) {
107
+ if (!action) throw new Error("audit: action required");
108
+ const p = path || defaultPath();
109
+ const strm = stream || env("ORACLE_AUDIT_STREAM", "MAD_AUDIT_STREAM", "oracle-exec");
110
+
111
+ const run = appendQueue.then(() => {
112
+ const existing = readAll(p).filter((e) => e.stream === strm);
113
+ const head = existing.length ? existing[existing.length - 1] : null;
114
+ const seq = head ? head.seq + 1 : 1;
115
+ const prevHash = head ? head.hash : null;
116
+
117
+ const entry = {
118
+ stream: strm,
119
+ seq,
120
+ ts: new Date().toISOString(),
121
+ action: String(action),
122
+ actor: actor == null ? null : String(actor),
123
+ objectId: objectId == null ? null : String(objectId),
124
+ detail: detail ?? null,
125
+ prevHash,
126
+ };
127
+ entry.hash = computeHash(entry);
128
+
129
+ mkdirSync(dirname(p), { recursive: true });
130
+ appendFileSync(p, JSON.stringify(entry) + "\n", { mode: 0o600 });
131
+ return entry;
132
+ });
133
+
134
+ // Keep the queue alive even if one append throws.
135
+ appendQueue = run.catch(() => {});
136
+ return run;
137
+ }
138
+
139
+ /**
140
+ * Best-effort append that NEVER throws into the caller. Use on the live exec
141
+ * path: a broken/unwritable log must not brick a signing operation, and every
142
+ * entry that DID get written stays verifiable. Failures go to stderr.
143
+ */
144
+ export async function recordAudit(opts) {
145
+ try {
146
+ return await appendAudit(opts);
147
+ } catch (e) {
148
+ try {
149
+ process.stderr.write(
150
+ JSON.stringify({ auditError: String(e?.message || e), action: opts?.action }) + "\n"
151
+ );
152
+ } catch {
153
+ /* ignore */
154
+ }
155
+ return null;
156
+ }
157
+ }
158
+
159
+ /**
160
+ * Verify a stream's chain end-to-end.
161
+ * @returns {{ ok: boolean, count: number, reason?: string, seq?: number }}
162
+ */
163
+ export function verifyChain({ stream, path } = {}) {
164
+ const p = path || defaultPath();
165
+ const strm = stream || env("ORACLE_AUDIT_STREAM", "MAD_AUDIT_STREAM", "oracle-exec");
166
+ const rows = readAll(p).filter((e) => e.stream === strm);
167
+ if (rows.length === 0) return { ok: false, count: 0, reason: "empty" };
168
+
169
+ let expectedPrev = null;
170
+ let expectedSeq = 1;
171
+ for (const row of rows) {
172
+ if (row.seq !== expectedSeq) {
173
+ return { ok: false, count: rows.length, reason: "seq-gap", seq: row.seq };
174
+ }
175
+ const wantPrev = expectedSeq === 1 ? null : expectedPrev;
176
+ if ((row.prevHash ?? null) !== (wantPrev ?? null)) {
177
+ return { ok: false, count: rows.length, reason: "prev-hash-mismatch", seq: row.seq };
178
+ }
179
+ const { hash, ...bare } = row;
180
+ if (computeHash(bare) !== hash) {
181
+ return { ok: false, count: rows.length, reason: "hash-mismatch", seq: row.seq };
182
+ }
183
+ expectedPrev = hash;
184
+ expectedSeq += 1;
185
+ }
186
+ return { ok: true, count: rows.length };
187
+ }
188
+
189
+ /** Read up to `limit` entries from `fromSeq` for a stream (newest-truncated). */
190
+ export function getEntries({ stream, fromSeq = 1, limit = 100, path } = {}) {
191
+ const p = path || defaultPath();
192
+ const strm = stream || env("ORACLE_AUDIT_STREAM", "MAD_AUDIT_STREAM", "oracle-exec");
193
+ return readAll(p)
194
+ .filter((e) => e.stream === strm && e.seq >= fromSeq)
195
+ .slice(0, limit);
196
+ }
@@ -0,0 +1,378 @@
1
+ // Chain-agnostic bounded automatic slippage policy.
2
+ // Slippage protects fresh quote -> inclusion movement only. Protocol fee and
3
+ // modeled price impact already live in quoteAmountOut and must not be counted a
4
+ // second time. Every executable swap route hard-stops at 100 bps.
5
+ //
6
+ // AUTHENTICATION: the guard is HMAC-signed with the same attestation secret the
7
+ // route/vault/gmx attestations use. Quotes may attach an unsigned bound when no
8
+ // secret is configured (read/prepare UX). Sign and broadcast ALWAYS require a
9
+ // verified signature (requireSigned / enforceTxPolicy) — an unsigned guard is
10
+ // self-attested and must never authorize a swap.
11
+
12
+ import { createHash, createHmac, timingSafeEqual } from "node:crypto";
13
+ import { resolveAttestationSecret } from "./attestation-secret.mjs";
14
+ import { assertFreshWindow } from "./fresh-window.mjs";
15
+
16
+ export const AUTO_SLIPPAGE_MAX_BPS = 100;
17
+ export const AUTO_SLIPPAGE_DEFAULT_TTL_MS = 20_000;
18
+
19
+ function canonicalJson(value) {
20
+ if (Array.isArray(value)) return `[${value.map(canonicalJson).join(",")}]`;
21
+ if (value && typeof value === "object") {
22
+ return `{${Object.keys(value)
23
+ .sort()
24
+ .map((k) => `${JSON.stringify(k)}:${canonicalJson(value[k])}`)
25
+ .join(",")}}`;
26
+ }
27
+ return JSON.stringify(value ?? null);
28
+ }
29
+
30
+ function slippageSecret(secret, { required = false } = {}) {
31
+ try {
32
+ return resolveAttestationSecret(secret, "ORACLE_ROUTE_ATTESTATION_SECRET", "MAD_ROUTE_ATTESTATION_SECRET");
33
+ } catch (error) {
34
+ if (required) throw error;
35
+ return null;
36
+ }
37
+ }
38
+
39
+ function unsigned(guard) {
40
+ const { signature: _sig, ...rest } = guard;
41
+ return rest;
42
+ }
43
+
44
+ /** Sign a guard so it cannot be forged or re-attached to a different swap. */
45
+ export function signAutoSlippageGuard(guard, { secret } = {}) {
46
+ const key = slippageSecret(secret);
47
+ if (!key) return guard;
48
+ return { ...guard, signature: createHmac("sha256", key).update(canonicalJson(unsigned(guard))).digest("hex") };
49
+ }
50
+
51
+ function calldataDigest(data) {
52
+ const hex = String(data || "").toLowerCase();
53
+ if (!/^0x[0-9a-f]+$/.test(hex) || hex.length < 10 || hex.length % 2 !== 0) {
54
+ throw new Error("auto-slippage calldata must be even-length hex with a selector");
55
+ }
56
+ return createHash("sha256").update(Buffer.from(hex.slice(2), "hex")).digest("hex");
57
+ }
58
+
59
+ export function bindAutoSlippageGuardToCall(guard, { chainId, venue, data, secret } = {}) {
60
+ if (!guard || guard.mode !== "auto") throw new Error("bounded auto-slippage guard required");
61
+ if (Number(guard.chainId) !== Number(chainId)) throw new Error("auto-slippage guard chain mismatch");
62
+ if (String(guard.venue).toLowerCase() !== String(venue || "").toLowerCase()) {
63
+ throw new Error("auto-slippage guard venue mismatch");
64
+ }
65
+ return signAutoSlippageGuard(
66
+ { ...unsigned(guard), calldataHash: calldataDigest(data) },
67
+ { secret },
68
+ );
69
+ }
70
+
71
+ function sameSignature(a, b) {
72
+ const x = Buffer.from(String(a ?? ""), "utf8");
73
+ const y = Buffer.from(String(b ?? ""), "utf8");
74
+ if (x.length !== y.length || x.length === 0) return false;
75
+ return timingSafeEqual(x, y);
76
+ }
77
+
78
+ function finite(value, fallback = 0) {
79
+ const n = Number(value);
80
+ return Number.isFinite(n) ? n : fallback;
81
+ }
82
+
83
+ function integerCap(value) {
84
+ const n = value == null ? AUTO_SLIPPAGE_MAX_BPS : Number(value);
85
+ if (!Number.isInteger(n) || n < 0) {
86
+ throw new Error("auto-slippage cap must be a non-negative integer bps value");
87
+ }
88
+ return Math.min(n, AUTO_SLIPPAGE_MAX_BPS);
89
+ }
90
+
91
+ export function resolveAutoSlippage({
92
+ liquidityUsd,
93
+ priceChange5m = 0,
94
+ quoteAgeMs = 0,
95
+ crossChain = false,
96
+ requestedCapBps,
97
+ } = {}) {
98
+ const liquidity = finite(liquidityUsd, 0);
99
+ const depthPenalty = liquidity > 0
100
+ ? liquidity >= 250_000
101
+ ? 5
102
+ : liquidity >= 100_000
103
+ ? 10
104
+ : liquidity >= 50_000
105
+ ? 20
106
+ : liquidity >= 10_000
107
+ ? 40
108
+ : 70
109
+ : crossChain
110
+ ? 30
111
+ : 10;
112
+ const volatilityPenalty = Math.min(60, Math.abs(finite(priceChange5m, 0)) * 2);
113
+ const agePenalty = Math.min(40, Math.floor(Math.max(0, finite(quoteAgeMs, 0)) / 5_000) * 5);
114
+ const requiredBps = Math.max(25, Math.ceil(20 + depthPenalty + volatilityPenalty + agePenalty));
115
+ const capBps = integerCap(requestedCapBps);
116
+ return {
117
+ mode: "auto",
118
+ requiredBps,
119
+ selectedBps: Math.min(requiredBps, capBps),
120
+ capBps,
121
+ executable: requiredBps <= capBps,
122
+ };
123
+ }
124
+
125
+ export function createAutoSlippageGuard({
126
+ chainId,
127
+ venue,
128
+ quoteAmountOut,
129
+ liquidityUsd,
130
+ priceChange5m = 0,
131
+ quoteAgeMs = 0,
132
+ crossChain = false,
133
+ requestedCapBps,
134
+ quotedAtMs = Date.now(),
135
+ ttlMs = AUTO_SLIPPAGE_DEFAULT_TTL_MS,
136
+ secret,
137
+ } = {}) {
138
+ const quote = BigInt(quoteAmountOut ?? 0);
139
+ if (quote <= 0n) throw new Error("auto-slippage guard requires positive quoteAmountOut");
140
+ const selected = resolveAutoSlippage({
141
+ liquidityUsd,
142
+ priceChange5m,
143
+ quoteAgeMs,
144
+ crossChain,
145
+ requestedCapBps,
146
+ });
147
+ if (!selected.executable) {
148
+ throw new Error(
149
+ `auto-slippage requires ${selected.requiredBps} bps above hard/requested cap ${selected.capBps}; route blocked`
150
+ );
151
+ }
152
+ const quoted = Number(quotedAtMs);
153
+ if (!Number.isFinite(quoted)) {
154
+ throw new Error("auto-slippage: quotedAtMs must be a finite number");
155
+ }
156
+ const ttl = Math.min(30_000, Math.max(1_000, Number(ttlMs) || AUTO_SLIPPAGE_DEFAULT_TTL_MS));
157
+ // BigInt division truncates toward zero, so on small quotes the realised
158
+ // floor can be far looser than the advertised cap: a 90 bps guard on a quote
159
+ // of 3 produced minAmountOut=2, i.e. 3333 bps of actual permitted slippage.
160
+ // Round the floor UP so the executed protection is never weaker than stated,
161
+ // and refuse outright when the quote is too small to express the bound.
162
+ const numerator = quote * BigInt(10_000 - selected.selectedBps);
163
+ let minAmountOut = numerator / 10_000n;
164
+ if (numerator % 10_000n !== 0n) minAmountOut += 1n; // ceil: favour the user
165
+ if (minAmountOut > quote) minAmountOut = quote;
166
+ if (quote > 0n && minAmountOut <= 0n) {
167
+ throw new Error(
168
+ `auto-slippage: quote ${quote} is too small to express a ${selected.selectedBps} bps floor without rounding to zero`
169
+ );
170
+ }
171
+ // Verify the realised bound actually honours the cap rather than trusting the
172
+ // arithmetic above.
173
+ const realisedBps = Number(((quote - minAmountOut) * 10_000n) / (quote === 0n ? 1n : quote));
174
+ if (realisedBps > selected.capBps) {
175
+ throw new Error(
176
+ `auto-slippage: realised floor implies ${realisedBps} bps, above cap ${selected.capBps} — refusing to issue a guard weaker than advertised`
177
+ );
178
+ }
179
+ // Sign on issue so the guard is verifiable later. A secret is mandatory —
180
+ // unsigned guards are self-attested and rejected at assert time.
181
+ return signAutoSlippageGuard(
182
+ {
183
+ mode: "auto",
184
+ chainId: Number(chainId),
185
+ venue: String(venue || "unknown"),
186
+ quoteAmountOut: quote.toString(),
187
+ minAmountOut: minAmountOut.toString(),
188
+ requiredBps: selected.requiredBps,
189
+ selectedBps: selected.selectedBps,
190
+ capBps: selected.capBps,
191
+ quotedAtMs: quoted,
192
+ expiresAtMs: quoted + ttl,
193
+ },
194
+ { secret }
195
+ );
196
+ }
197
+
198
+ /**
199
+ * Best-effort extraction of the output floor a swap call actually encodes.
200
+ *
201
+ * Returns null when the selector is unknown — this binds the common router
202
+ * shapes without pretending to be a universal ABI decoder. A null result means
203
+ * "cannot verify from calldata", not "verified safe": the venue allowlist and
204
+ * the guard's own bounds still apply.
205
+ */
206
+ function encodedMinOut(data) {
207
+ const hex = String(data || "");
208
+ if (!/^0x[0-9a-fA-F]+$/.test(hex) || hex.length < 10 || hex.length % 2 !== 0) return null;
209
+ const selector = hex.slice(0, 10).toLowerCase();
210
+ const words = [];
211
+ for (let i = 10; i + 64 <= hex.length; i += 64) words.push(hex.slice(i, i + 64));
212
+ const word = (i) => (words[i] == null ? null : BigInt("0x" + words[i]));
213
+
214
+ switch (selector) {
215
+ // Uniswap V3 SwapRouter — exactInputSingle with deadline:
216
+ // (tokenIn,tokenOut,fee,recipient,deadline,amountIn,amountOutMinimum,
217
+ // sqrtPriceLimitX96) — all static, so amountOutMinimum is word 6.
218
+ case "0x414bf389":
219
+ return word(6);
220
+ // SwapRouter02 — SAME name, NO deadline member:
221
+ // (tokenIn,tokenOut,fee,recipient,amountIn,amountOutMinimum,
222
+ // sqrtPriceLimitX96) — amountOutMinimum shifts to word 5.
223
+ // Treating this as the 8-member shape reads sqrtPriceLimitX96 instead.
224
+ case "0x04e45aaf":
225
+ return word(5);
226
+ // exactInput((bytes path,address recipient,uint256 deadline,
227
+ // uint256 amountIn,uint256 amountOutMinimum))
228
+ //
229
+ // The struct's FIRST member is dynamic (bytes path), so the struct itself
230
+ // is encoded behind an offset and its members live in a tail:
231
+ // head[0] = offset to the struct
232
+ // tail[0] (word 1) = offset to path
233
+ // tail[1] (word 2) = recipient
234
+ // tail[2] (word 3) = deadline
235
+ // tail[3] (word 4) = amountIn
236
+ // tail[4] (word 5) = amountOutMinimum <-- the real output floor
237
+ //
238
+ // Reading word 4 here checked amountIn, which an attacker simply sets to
239
+ // the guard's expected value while leaving amountOutMinimum at 0. Follow
240
+ // the offset instead of assuming a fixed layout.
241
+ case "0xc04b8d59": {
242
+ const structOffset = word(0);
243
+ if (structOffset == null) return null;
244
+ // Offsets are byte counts from the start of the argument block.
245
+ const base = Number(structOffset) / 32;
246
+ if (!Number.isInteger(base) || base < 0) return null;
247
+ return word(base + 4);
248
+ }
249
+ // SwapRouter02 exactInput((bytes path,address recipient,uint256 amountIn,
250
+ // uint256 amountOutMinimum)) — no deadline, so the floor is tail word 3.
251
+ case "0xb858183f": {
252
+ const structOffset = word(0);
253
+ if (structOffset == null) return null;
254
+ const base = Number(structOffset) / 32;
255
+ if (!Number.isInteger(base) || base < 0) return null;
256
+ return word(base + 3);
257
+ }
258
+ // Aerodrome Slipstream exactInputSingle with tickSpacing and deadline
259
+ case "0xa026383e":
260
+ return word(6);
261
+ // V2 swapExactTokensForTokens(amountIn, amountOutMin, path, to, deadline)
262
+ case "0x38ed1739":
263
+ case "0x5c11d795": // ...SupportingFeeOnTransferTokens
264
+ return word(1);
265
+ // V2 swapExactETHForTokens(amountOutMin, path, to, deadline)
266
+ case "0x7ff36ab5":
267
+ case "0xb6f9de95":
268
+ return word(0);
269
+ // V2 swapExactTokensForETH(amountIn, amountOutMin, path, to, deadline)
270
+ case "0x18cbafe5":
271
+ case "0x791ac947":
272
+ return word(1);
273
+ default:
274
+ return null;
275
+ }
276
+ }
277
+
278
+
279
+ export function assertAutoSlippageGuard(
280
+ guard,
281
+ { nowMs = Date.now(), chainId, venue, secret, tx, requireSigned = false } = {},
282
+ ) {
283
+ if (!guard || guard.mode !== "auto") {
284
+ throw new Error("bounded auto-slippage guard required");
285
+ }
286
+
287
+ // Verify authenticity FIRST when signing/broadcasting. Quotes may attach an
288
+ // unsigned bound for display; the policy gate always passes requireSigned=true.
289
+ const key = slippageSecret(secret, { required: requireSigned });
290
+ if (requireSigned && !key) {
291
+ throw new Error("auto-slippage attestation secret required for signing or broadcast");
292
+ }
293
+ if (key) {
294
+ const expected = createHmac("sha256", key).update(canonicalJson(unsigned(guard))).digest("hex");
295
+ if (!sameSignature(guard.signature, expected)) {
296
+ throw new Error("auto-slippage guard signature mismatch — the guard was not issued by this Oracle");
297
+ }
298
+ } else if (guard.signature) {
299
+ throw new Error("auto-slippage guard carries a signature but no attestation secret is configured");
300
+ }
301
+ const selected = Number(guard.selectedBps);
302
+ const cap = Number(guard.capBps);
303
+ if (!Number.isInteger(selected) || selected < 0 || selected > AUTO_SLIPPAGE_MAX_BPS) {
304
+ throw new Error(`auto-slippage selected tolerance exceeds hard 100 bps cap`);
305
+ }
306
+ if (!Number.isInteger(cap) || cap < 0 || cap > AUTO_SLIPPAGE_MAX_BPS || selected > cap) {
307
+ throw new Error(`auto-slippage cap exceeds hard 100 bps cap`);
308
+ }
309
+ // Fail CLOSED on an unusable clock: Number(NaN) > x is false, so a broken or
310
+ // attacker-influenced clock made an expired quote eternal.
311
+ try {
312
+ assertFreshWindow({ expiresAtMs: guard.expiresAtMs, issuedAtMs: guard.quotedAtMs }, nowMs, "auto-slippage quote");
313
+ } catch (e) {
314
+ throw new Error(`${e.message}; re-quote before signing`);
315
+ }
316
+ if (chainId != null && Number(guard.chainId) !== Number(chainId)) {
317
+ throw new Error("auto-slippage guard chain mismatch");
318
+ }
319
+ if (venue && String(guard.venue).toLowerCase() !== String(venue).toLowerCase()) {
320
+ throw new Error("auto-slippage guard venue mismatch");
321
+ }
322
+ const quote = BigInt(guard.quoteAmountOut ?? 0);
323
+ const minimum = BigInt(guard.minAmountOut ?? 0);
324
+ if (quote <= 0n || minimum <= 0n) {
325
+ throw new Error("auto-slippage guard amounts must be positive");
326
+ }
327
+ const protectedFloor = quote * BigInt(10_000 - selected) / 10_000n;
328
+ if (minimum < protectedFloor) {
329
+ throw new Error("auto-slippage guard is under-protected relative to its fresh quote");
330
+ }
331
+ if (tx?.data && guard.minAmountOut != null) {
332
+ if (guard.calldataHash != null) {
333
+ if (String(guard.calldataHash) !== calldataDigest(tx.data)) {
334
+ throw new Error("auto-slippage guard is not bound to this call: calldata hash mismatch");
335
+ }
336
+ } else {
337
+ const encoded = encodedMinOut(tx.data);
338
+ if (encoded == null) {
339
+ const selector = String(tx.data).slice(0, 10);
340
+ throw new Error(
341
+ `auto-slippage: cannot verify the output floor encoded by selector ${selector}; ` +
342
+ "refusing rather than trusting unbound calldata at an allowlisted venue"
343
+ );
344
+ }
345
+ if (encoded !== BigInt(guard.minAmountOut)) {
346
+ throw new Error(
347
+ `auto-slippage guard is not bound to this call: guard minAmountOut ${guard.minAmountOut} but calldata encodes ${encoded}`
348
+ );
349
+ }
350
+ }
351
+ }
352
+ return true;
353
+ }
354
+
355
+ export function attachAutoSlippage(result, {
356
+ chainId,
357
+ venue,
358
+ amountOut,
359
+ liquidityUsd,
360
+ priceChange5m,
361
+ crossChain,
362
+ requestedCapBps,
363
+ quotedAtMs = Date.now(),
364
+ ttlMs,
365
+ } = {}) {
366
+ const autoSlippage = createAutoSlippageGuard({
367
+ chainId,
368
+ venue,
369
+ quoteAmountOut: amountOut,
370
+ liquidityUsd,
371
+ priceChange5m,
372
+ crossChain,
373
+ requestedCapBps,
374
+ quotedAtMs,
375
+ ttlMs,
376
+ });
377
+ return { ...result, autoSlippage, amountOutMinimum: autoSlippage.minAmountOut };
378
+ }
@@ -0,0 +1,125 @@
1
+ // Oracle capability posture.
2
+ //
3
+ // THE RULE, stated once, in one place:
4
+ //
5
+ // A capability is ARMED when the user has supplied the credential it needs.
6
+ // Nothing executes unless the user asks for that specific action.
7
+ // Autonomous trading is the sole exception: it stays OFF until explicitly
8
+ // enabled, because it is the only mode where Oracle acts without a request.
9
+ //
10
+ // Why this shape:
11
+ //
12
+ // The old model ("everything disarmed until N env flags are set") punished
13
+ // the honest self-hoster. Someone who had already handed Oracle a signing key
14
+ // still could not buy an NFT without hunting down a second, third, and fourth
15
+ // feature flag. That is not security — it is friction that teaches people to
16
+ // set ORACLE_*_ENABLED=1 everywhere, which is strictly worse than a coherent
17
+ // default.
18
+ //
19
+ // Supplying a key IS the authorization decision. What actually protects the
20
+ // user is not a flag; it is that every action is USER-INITIATED and bounded
21
+ // by caps at the moment it runs.
22
+ //
23
+ // The one thing a key does NOT authorize is Oracle acting on its own. An
24
+ // agent that trades while you sleep is a different risk class from an agent
25
+ // that buys the NFT you just named. So AUTONOMOUS trading — and only that —
26
+ // requires a separate, explicit opt-in.
27
+
28
+ export const CAPABILITY_TIERS = Object.freeze({
29
+ READ: "read",
30
+ PREPARE: "prepare",
31
+ EXECUTE: "execute",
32
+ AUTONOMOUS: "autonomous",
33
+ });
34
+
35
+ /** Credential each capability needs before it can be armed. */
36
+ const CREDENTIAL_FOR = Object.freeze({
37
+ "evm:prepare": ["ORACLE_EVM_ADDRESS", "EVM_KEYSTORE_FILE", "ORACLE_SIGNER_ADDRESS"],
38
+ "evm:execute": ["EVM_KEYSTORE_FILE", "ORACLE_KEYSTORE_FILE"],
39
+ "btc:execute": ["BTC_WIF_FILE", "ORACLE_BTC_WIF_FILE"],
40
+ "solana:execute": ["SOLANA_KEYPAIR_FILE", "ORACLE_SOLANA_KEYPAIR_FILE"],
41
+ "nft:buy": [],
42
+ "nft:mint": [],
43
+ "cow:submit": [],
44
+ });
45
+
46
+ function hasAnyEnv(names, env) {
47
+ return names.some((n) => String(env[n] ?? "").trim() !== "");
48
+ }
49
+
50
+ /**
51
+ * Is autonomous (unattended) trading enabled?
52
+ *
53
+ * This is the ONLY capability that a present key does not arm, because it is
54
+ * the only one where Oracle initiates value movement without the user asking
55
+ * for that specific action.
56
+ */
57
+ export function autonomousTradingEnabled(env = process.env) {
58
+ return String(env.ORACLE_AUTONOMOUS_TRADING ?? "").trim() === "1";
59
+ }
60
+
61
+ /**
62
+ * Decide whether a capability may run.
63
+ *
64
+ * @param {string} capability e.g. "nft:buy", "btc:execute"
65
+ * @param {object} opts
66
+ * @param {boolean} opts.userInitiated the user asked for THIS action, now
67
+ * @param {boolean} opts.autonomous Oracle initiated it on its own
68
+ */
69
+ export function capabilityStatus(capability, { env = process.env, userInitiated = false, autonomous = false } = {}) {
70
+ const needed = CREDENTIAL_FOR[capability] ?? [];
71
+ const keyPresent = needed.length === 0 || hasAnyEnv(needed, env);
72
+
73
+ if (autonomous && !autonomousTradingEnabled(env)) {
74
+ return {
75
+ capability,
76
+ armed: keyPresent,
77
+ allowed: false,
78
+ reason:
79
+ "autonomous trading is off — set ORACLE_AUTONOMOUS_TRADING=1 to let Oracle act without an explicit request",
80
+ };
81
+ }
82
+
83
+ if (!keyPresent) {
84
+ return {
85
+ capability,
86
+ armed: false,
87
+ allowed: false,
88
+ reason: `no credential configured for ${capability} — set one of: ${needed.join(", ")}`,
89
+ };
90
+ }
91
+
92
+ if (!userInitiated && !autonomous) {
93
+ return {
94
+ capability,
95
+ armed: true,
96
+ allowed: false,
97
+ reason: "armed, but nothing runs until you ask for this action",
98
+ };
99
+ }
100
+
101
+ return { capability, armed: true, allowed: true, reason: null };
102
+ }
103
+
104
+ /** Throwing form for call sites that should refuse rather than branch. */
105
+ export function assertCapability(capability, opts = {}) {
106
+ const status = capabilityStatus(capability, opts);
107
+ if (!status.allowed) {
108
+ const err = new Error(`oracle: ${capability} not permitted — ${status.reason}`);
109
+ err.status = status;
110
+ throw err;
111
+ }
112
+ return status;
113
+ }
114
+
115
+ /** Human-readable posture for a status surface. */
116
+ export function posture(env = process.env) {
117
+ const caps = Object.keys(CREDENTIAL_FOR);
118
+ const armed = caps.filter((c) => capabilityStatus(c, { env, userInitiated: true }).allowed);
119
+ return {
120
+ model: "key-present = armed; user-initiated = runs; autonomous = opt-in",
121
+ armed,
122
+ autonomousTrading: autonomousTradingEnabled(env) ? "ENABLED" : "off",
123
+ note: "Nothing executes unless you ask for it. Caps and simulation still apply to every action.",
124
+ };
125
+ }