@oracle-agent/oracle 0.1.0

package/CONTRIBUTING.md

@@ -0,0 +1,98 @@
+# Contributing to Oracle
+
+Thanks for looking. Oracle is a control plane for money movement, so the review
+bar is about safety and honesty more than style.
+
+## Before you start
+
+Run the suite:
+
+```bash
+npm install
+npm test
+```
+
+391 tests, all green. If they aren't green on a clean checkout, that's a bug —
+please report it.
+
+## The one rule that matters
+
+**The public plane may never reach a private key or a house signer.**
+
+Oracle ships the data plane, the policy plane, and the control plane. It does not
+ship the executor. A PR that imports signer or keystore code into public modules
+will fail `test/custody-boundary.test.mjs`, and the fix is not to edit the
+forbidden list.
+
+If your feature seems to need a key, restructure it: build an unsigned
+transaction or a typed-data intent and hand it back to the caller to sign.
+
+## What we want
+
+- **Real bugs, fixed at the class level.** Reproduce it, point at the line, fix
+  every sibling call path — not just the one that was reported.
+- **New chains and providers.** This is the most useful contribution. See below.
+- **Honest capability tiers.** If a provider can only quote, mark it
+  `quote-only`. Do not mark it `prepare` because a prepare function exists but
+  was never validated against a live route.
+- **Tests that assert invariants**, not snapshots. `assert` that a minimum output
+  is enforced; don't freeze today's provider list into an equality check.
+- **Guards recomputed before signing.** A quote-time check that isn't re-verified
+  at broadcast is decoration.
+
+## What gets rejected
+
+- A signer, private key, or house-custody path in the public tree.
+- A destination allowlist that defaults to permissive, or an empty allowlist read
+  as "allow all."
+- Slippage widened past the 100 bps cap to make a trade go through. Block,
+  requote, or split instead.
+- A claim of execution support with no live prepare/simulate evidence.
+- Secrets in code, tests, fixtures, or docs — including a real wallet address as
+  a default `from` for quotes. Use `src/data/quote-placeholder.mjs`.
+- "It worked when I ran it" with no test.
+
+## Adding a provider
+
+1. Create `src/data/providers/<name>.mjs`.
+2. Export a `health()` plus the ops you actually implement.
+3. Register it in `src/data/catalog.mjs` with truthful `chainIds`, `auth`, `ops`,
+   and `execution` tier.
+4. Add a test with a mocked transport. Do not require a live network for CI.
+5. If it needs a key, the health check must report
+   `{ ok: false, configured: false }` rather than throwing.
+
+## Adding a chain
+
+1. Add an entry to `CHAINS` in `src/chains.mjs` with its `rpcEnv` names.
+2. Verify every router/venue address on-chain (`eth_getCode` must return real
+   bytecode) before adding it to `src/venues.mjs`.
+3. Comment each venue addition with how you verified it and when.
+4. An unverified chain stays fail-closed. That is a safe state, not a gap.
+
+Never allowlist a router you found only in a blog post or a model's answer. The
+destination allowlist is the highest-leverage control in the system.
+
+## Commits and PRs
+
+Conventional prefixes: `fix:`, `feat:`, `refactor:`, `docs:`, `test:`, `chore:`.
+
+In the PR body, state:
+
+- what broke or what's new
+- how you verified it (paste the real command output)
+- whether anything touches the custody boundary
+
+Small, reviewable PRs get merged. A 3000-line PR mixing a refactor with a policy
+change will sit.
+
+## Style
+
+- ES modules, Node 20+, no build step.
+- No new runtime dependency without a reason in the PR description.
+- Comments explain *why*, not *what*. If a line encodes a hard-won fact — a
+  provider's unit quirk, a revert cause — say so, and say how it was learned.
+
+## License
+
+Contributions are accepted under [Apache-2.0](LICENSE).

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Oracle Agent contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,384 @@
+# Oracle
+
+**Prepare-only multichain agent control plane.** Policy-bounded intents; your wallet signs.
+
+Specialist agent profiles, real protocol intents, self-custody by default,
+receipts or it didn't happen.
+
+Built for [Hermes](https://github.com/NousResearch/hermes-agent), the
+open-source agent runtime from [Nous Research](https://nousresearch.com).
+
+Oracle itself makes **no model calls and needs no API key**. It is the tool layer
+an agent drives. Bring whatever model your Hermes is already using.
+
+The **public package is prepare-only**: it never takes a private key and never
+broadcasts. Owner-local signer modules may exist in a private tree for operator
+deployments; they are excluded from the npm artifact and from every public
+entrypoint.
+
+---
+
+## What Oracle is
+
+Most "AI crypto agent" projects give a model a hot wallet and hope. Oracle does
+the opposite: the model *proposes*, the owner *authorizes*, and the policy layer
+decides what may even be asked.
+
+Three properties define it:
+
+1. **Self-custody by default.** The public package never accepts your private
+   key. It builds unsigned transactions and typed-data intents; your wallet
+   signs them.
+2. **Bound grants.** A grant is a signed, scoped, expiring permission: max
+   value, chain, venue, destination allowlist, TTL. Oracle canonicalizes it,
+   renders it for review, and refuses to prepare anything outside it. Runtime
+   enforcement is the wallet's or smart account's job — this package never
+   signs, so it cannot be the thing that stops a transaction.
+3. **Receipts or it didn't happen.** A claim without a transaction hash, a
+   receipt, and a balance delta is not a result.
+
+Default posture is `DISARMED`.
+
+## Why it's different
+
+The differentiators are **policy, custody, and receipts** — not a smarter chat
+loop.
+
+| | Typical agent | Oracle |
+|---|---|---|
+| Custody | house wallet holds keys | user signs, no house custody |
+| Authority | prompt-level "be careful" | signed grant: chain, spend, targets, TTL — enforced by your wallet, not by us |
+| Destinations | whatever the model emits | reviewed per-chain allowlist, fail-closed |
+| Slippage | fixed % | live guard recomputed per leg, hard 100 bps cap |
+| Proof | model says "done" | hash + receipt + balance delta or it failed |
+| Surface | swap only | swaps, bridges, perps, vaults, yield, NFTs, intents |
+
+## Architecture
+
+```
+        you
+         |
+       Task
+         |
+      oracle            <- routes, never authorizes custody
+         |
+  +------+------+------+------+------+------+------+
+  |      |      |      |      |      |      |      |
+ poly   hyper  robin  solana bitcoin stable protocol
+ market liquid hood                         builder
+```
+
+Each lane is a Hermes **profile**: its own system prompt, skills, memory, and
+sessions. The `oracle` lane routes intent to the right specialist. Adding a lane
+is adding a directory.
+
+Three planes, and the boundary between them is mechanically enforced:
+
+- **Data plane** (public) — read/quote across chains and protocols. No keys.
+- **Policy plane** (public) — destination allowlists, slippage guards, route and
+  vault attestations, grant schema. Holds no keys; constrains what a signer may
+  be asked to do.
+- **Exec plane** (owner-local source only) - signing and broadcast modules exist
+  for private operator deployments, but are excluded from every public package
+  entrypoint and from the npm artifact.
+
+`test/custody-boundary.test.mjs` walks the import graph and fails if any public
+module reaches wallet key material or a house signer. The split is a test, not a
+promise.
+
+## Coverage
+
+**11 EVM chains** built in: Ethereum, Optimism, BNB, Polygon, Stable, HyperEVM,
+Abstract, Robinhood Chain, Base, Arbitrum, Avalanche. Plus Solana and Bitcoin L1
+lanes. Solana covers Jupiter quote/prepare, SPL account research, live
+simulation of the prepared swap, and Magic Eden NFT reads with unsigned
+buy/list/mint tickets. Bitcoin covers Esplora fee/UTXO reads, Ordinals/runes
+research, Satflow PSBT intents, and inscription PSBT preparation. Hyperliquid
+adds HyperCore HYPE staking: validator reads plus EIP-712 stake, delegate,
+undelegate, and unstake preparation. User wallets sign.
+
+**Any other EVM chain is config, not code:**
+
+```js
+import { registerCustomChain } from "@oracle-agent/oracle/scanner";
+
+registerCustomChain({
+  key: "mychain",
+  chainId: 7777,
+  name: "My Chain",
+  rpcEnv: ["MYCHAIN_RPC_URL"],
+  nativeCurrency: { symbol: "MYC", decimals: 18 },
+});
+```
+
+That chain immediately has block reads, balances, on-chain token resolution, log
+scanning, and structural risk checks. See
+[`docs/adding-a-chain.md`](docs/adding-a-chain.md).
+
+```bash
+oracle-scan chains                    # coverage matrix
+oracle-scan token base 0x8335...2913  # on-chain identity
+oracle-scan pools base 0x4200...0006  # pools ranked by liquidity
+oracle-scan risk  base 0x8335...2913  # structural checks + sell simulation
+oracle-scan sell  base 0x8335...2913  # round trip: can you actually exit?
+```
+
+**7 of 11 chains ship verified venues** — Ethereum, Optimism, BNB, Polygon, Base,
+Arbitrum, Avalanche — so they have all 10 capabilities including live quotes,
+round-trip sell simulation, and unsigned swap preparation. The remaining four
+(Stable, HyperEVM, Abstract, Robinhood) are at 7 and **fail-closed for routing
+value** until someone verifies a venue: read and research work, moving money does
+not. That is a safe default, not a gap.
+
+Every venue address was verified **functionally, not by codesize** — a re-runnable
+prober (`scripts/verify-v3-venues.mjs`) asks each candidate to price a pair with a
+known answer. This matters: the canonical QuoterV2 address also has bytecode on
+Base, but does not price that chain's pairs. A codesize check would have
+allowlisted the wrong contract.
+
+**30+ providers** in the read/quote catalog:
+
+| Class | Providers |
+|---|---|
+| Chain / explorer | EVM JSON-RPC, Blockscout, Solana RPC, Bitcoin Esplora |
+| Market data | DexScreener, GeckoTerminal, DeFiLlama |
+| DEX / aggregator | Uniswap V3, Aerodrome, Curve, Balancer, LI.FI, ParaSwap, Odos, 0x, 1inch |
+| Intents | CoW Protocol |
+| Perps / lending / yield | GMX v2, Morpho, Pendle |
+| Bridges | Across, Hop, Relay |
+| Venues | Hyperliquid (incl. HyperCore staking), Polymarket |
+| NFT | OpenSea, Satflow, Magic Eden (Solana) |
+
+Every provider and every scanner capability declares an honest tier —
+`read-only`, `quote-only`, `prepare`, or `intent`. **API coverage is not execution
+support**, and the catalog says which is which. A chain with no verified venue is
+fail-closed for routing value: read and research work, moving money does not. That
+is a safe default, not a gap.
+
+## Capability pack
+
+Oracle's default pack is deliberately broad but disarmed:
+
+- **Trader** — best-execution route comparison, quote/prepare, simulation, and
+  receipt checks; no set-and-forget custody.
+- **Builder** — protocol, NFT, gacha, DEX, and launchpad scaffolds with unsigned
+  deploy/admin transactions.
+- **Analyzer** — token, contract, venue, portfolio, market, and risk research with
+  evidence labels.
+- **On-chain scanner** — chain-config scanners for tokens, pools, launches,
+  risk, exits, and smart-wallet boards.
+- **Meme-token sniper** — fast launch/liquidity monitoring across configured
+  chains, guarded by identity checks, sell-sim/reverse-route proof, caps, and
+  unsigned user-wallet tickets.
+- **Per-chain graphs + Telegram cards** — charted scanner alerts, route cards,
+  meme-launch cards, Hyperliquid HIP-3/HIP-4 cards, and Polymarket cards. User
+  API-key actions activate only when self-hosted keys are configured.
+- **NFT mint gas-war limits** — public mint bots enforce chain-bound gas caps,
+  per-unit fee caps, and optional priority-fee caps before returning unsigned
+  mint transactions. Import `validateNftMintGasWar` from the package root or
+  `@oracle-agent/oracle/nft-gas-war`.
+- **Cross-chain RFQ + tokenized assets** — RFQ/intent venues are compared across
+  supported chains where configured, and tokenized Robinhood-style assets can be
+  bought only after exact contract, venue, route, and sellability checks.
+- **Solana** — SPL accounts, Jupiter quotes, unsigned swap transactions, and
+  simulation.
+- **Bitcoin** — L1 reads, Ordinals/runes, Satflow PSBT intents, and inscription
+  PSBT preparation.
+
+Every money-moving path stays prepare/simulate first. Signing and broadcast are
+wallet/grant actions, not model authority. Meme-token sniping defaults to fast
+scan + prepared ticket; blind broadcast requires a separate capped local signer
+loop and explicit opt-in. NFT mint bots must also honor gas-war caps before any
+wallet-signable transaction is returned. RFQ and tokenized-asset routes are
+capability-labeled per chain; unconfigured venues stay unavailable instead of faked.
+
+## Install
+
+The npm package is intentionally unpublished while release hardening is in
+progress. Install from source:
+
+```bash
+git clone https://github.com/demi-hl/oracle.git
+cd oracle
+npm install
+npm test
+```
+
+**→ [SETUP.md](./SETUP.md) covers public data credentials and the separate
+owner-local source lane.** The short version:
+
+- Reads and quotes need **no keys**.
+- The public package exposes no signer, key vault, or broadcast path.
+- User wallets authorize prepared actions outside the public data plane.
+- The source-only operator signer is not a public API and is not shipped to npm.
+
+Run the read-only data plane:
+
+```bash
+npm run start:data
+npm run health
+```
+
+Run the public console (wallet connect, grant editor, receipts):
+
+```bash
+npm run start:public
+# http://127.0.0.1:8799/
+```
+
+## Model providers
+
+Oracle is a library. Drive it with Claude, GPT, Gemini, Grok, a local model, or
+a plain script — the tools are ordinary functions plus an MCP server:
+
+```bash
+npx oracle-data-mcp     # works with any MCP client
+```
+
+It is better under [Hermes](https://claude-code.nousresearch.com/docs), because
+a trading stack is several workloads with opposite needs and **per-profile
+routing** gives each its own model, tools, and key scope: cheap wide context for
+research, a fast model for execution where latency is money, the strongest model
+for risk review, something small for unattended crons. The research profile can
+hold no signing key at all.
+
+Oracle's own pre-release audit ran four model lineages — Grok 4.5, Opus 5,
+Fable 5, GPT-5.6 — and **each found a critical bug the others missed**. One
+model reviewing its own work would have shipped three of them.
+
+
+## Agent profiles
+
+Oracle ships an installable 8-lane mesh for Hermes:
+
+```bash
+oracle-init            # dry run -- shows exactly what it would do
+oracle-init --apply    # create profiles, install SOULs + skills, wire MCP
+```
+
+Lanes: `oracle` (router), `polymarket-agent`, `hyperliquid-agent`,
+`robinhood-agent`, `solana-agent`, `bitcoin-agent`, `stable-agent`,
+`protocol-builder`, plus `_template` for your own. Details in
+[`docs/profiles.md`](docs/profiles.md).
+
+Every lane installs **DISARMED**. No lane requests a broadcast or signing action —
+only read, simulate, and prepare — and a test enforces that so widening custody
+can't pass review quietly. An existing `SOUL.md` is never overwritten without
+`--force`, and `--force` writes a timestamped backup first.
+
+No Oracle account, no Oracle API key, no separate model billing. Oracle inherits
+whichever provider your Hermes already uses (Anthropic, OpenAI, Nous Portal, xAI,
+a local GGUF — anything Hermes supports).
+
+**Why "built for Hermes" and not just "works anywhere":** Oracle's read plane is
+an MCP server, so any MCP client can call it. But the *mesh* — per-lane memory,
+skills, sessions, and separate model choice per specialist — is Hermes profile
+machinery. You can use Oracle from any agent; you get the architecture in the
+diagram above from Hermes.
+
+## Best-execution routing
+
+The highest quote is not the cheapest swap. Oracle ranks on **net received after
+gas and fees**, comparing every available source in parallel:
+
+```bash
+oracle-route swap   base 0x4200...0006 0x8335...2913   # WETH -> USDC
+oracle-route bridge arbitrum base                       # ETH across chains
+```
+
+```
+  source           net out           gross  cost
+* paraswap    1,903.880867    1,903.893053  $0.01
+  cow         1,903.693798    1,903.693798  gasless (solver)
+  lifi        1,894.432632     1,899.20966  $4.78
+```
+
+Sources: **LI.FI, CoW, ParaSwap, 0x, 1inch** for swaps · **LI.FI, Relay, Across**
+for bridges. 0x and 1inch activate when their API key is present; the rest need
+none.
+
+Why net matters:
+
+- **Gas is part of the price.** A route quoting 0.2% more but costing $14 more in
+  gas loses on a $500 swap and wins on a $50k one. The crossover depends on trade
+  size, so any fixed preference is wrong on one side of it.
+- **Intents can beat AMMs.** CoW's solver pays the gas, so a slightly lower gross
+  quote often wins on net — the case naive ranking always gets backwards.
+- **Sources disagree about what they mean.** Some report gas in USD, some in native
+  wei, some not at all. Oracle normalizes, and marks what was measured.
+
+**Unknown cost is never scored as zero.** A source that does not report gas is
+ranked on gross and flagged, because scoring an unknown as free is how the worst
+route wins a comparison. When the top two routes measure cost differently, Oracle
+quotes **no spread at all** rather than a number that compares different things.
+
+Then prepare the winner in one step:
+
+```bash
+oracle-route prepare base <tokenIn> <tokenOut> <yourWallet>
+```
+
+You get back an **unsigned transaction** (LI.FI, ParaSwap, 0x) or **EIP-712 typed
+data** for an off-chain order (CoW). `artifactKind` says which — they need different
+wallet actions, and one is not broadcast at all. Prepare **re-quotes** and reports
+`driftBps` against the comparison, because a minimum computed from a stale quote is
+not a minimum.
+
+Bridges prepare too:
+
+```bash
+oracle-route prepare-bridge arbitrum base <yourWallet>
+```
+
+Bridge artifacts are always a **list** of transactions — some routes need an approval
+and a deposit signed in order, and signing only the first leaves funds approved but
+not bridged. Both chains are reported, and a transaction whose chain does not match
+the origin is refused. Oracle states plainly that **bridging is not atomic**: the
+origin transaction confirming does not mean funds arrived.
+
+Routing never signs. `taker` must be the real wallet; placeholder addresses are
+rejected, since quoting is anonymous but preparing is not. Signing happens in
+the user's wallet or in a separately operated source-only execution lane.
+
+Individual source failures degrade the comparison by one source instead of breaking
+it — verified in practice when Odos sunset their public API mid-development
+(HTTP 410); the router kept ranking and the provider was marked `unavailable`.
+
+## Examples
+
+```bash
+node examples/add-a-chain.mjs          # register an unseen chain, no code
+node examples/research-a-token.mjs     # honest token research on live data
+```
+
+## MCP
+
+Oracle exposes its read plane over the Model Context Protocol, so any MCP client
+(Hermes, Claude Code, others) can use it:
+
+```bash
+oracle-data-mcp
+```
+
+## Security
+
+- Oracle never receives private keys.
+- The router can propose, simulate, explain, and draft. It cannot authorize.
+- Public modules may not import signer or executor code (enforced by test).
+- Destination allowlists are per-chain and fail-closed: an empty allowlist
+  refuses everything rather than allowing everything.
+- Report vulnerabilities per [SECURITY.md](SECURITY.md). Please do not open a
+  public issue for a live exploit.
+
+## What Oracle is not
+
+- Not an autonomous trader. There is no "set and forget."
+- Not custodial. If a design needs your key on our server, that design is wrong.
+- Not a guarantee. Crypto execution carries real risk; read the code you run.
+
+## License
+
+[Apache-2.0](LICENSE).
+
+The code is open source. The **Oracle** name and marks are reserved; please
+don't imply endorsement by an official deployment when shipping a fork.