@blockrun/franklin 3.0.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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 the 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 any 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
+
+   Copyright 2025 BlockRun AI
+
+   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,256 @@
+<h1 align="center">Franklin</h1>
+
+<p align="center">
+  <strong>The AI agent with a wallet.</strong>
+</p>
+
+<p align="center">
+  While others chat, Franklin spends — turning your USDC into real work.
+</p>
+
+<p align="center">
+  <a href="https://npmjs.com/package/@blockrun/franklin"><img src="https://img.shields.io/npm/v/@blockrun/franklin.svg?style=flat-square&color=FFD700" alt="npm version"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue?style=flat-square" alt="License: Apache-2.0"></a>
+  <a href="https://x402.org"><img src="https://img.shields.io/badge/x402-Payments-10B981?style=flat-square" alt="x402"></a>
+  <a href="https://franklin.run"><img src="https://img.shields.io/badge/Marketing-franklin.run-06B6D4?style=flat-square" alt="franklin.run"></a>
+  <a href="https://franklin.bet"><img src="https://img.shields.io/badge/Trading-franklin.bet-10B981?style=flat-square" alt="franklin.bet"></a>
+</p>
+
+---
+
+## Franklin runs your money
+
+Franklin is the first AI agent that can actually **spend money** to get work done. Not just write text about it.
+
+```bash
+$ franklin marketing campaign "Launch my AI coding app to indie hackers"
+  Budget cap: $10
+
+  ✓ $0.50  Research competitors via Exa
+  ✓ $1.20  Write 5 blog post drafts (Claude Sonnet 4.6)
+  ✓ $0.48  Generate 3 hero images (DALL-E 3)
+  ✓ $3.50  Generate 15-second launch video (Runway)
+  ✓ $0.80  Generate background music (Suno)
+  ✓ $0.30  Find 20 relevant Reddit discussions
+  ✓ $1.50  Draft Reddit comments (Claude Sonnet 4.6)
+  ✓ $0.10  Post 3 casts to Farcaster
+
+  Total spent: $8.58 · Time: 4m 32s
+  Deliverables: 5 blog posts, 3 hero images, 1 launch video, 1 music
+                track, 20 Reddit drafts, 3 Farcaster casts (live)
+```
+
+**One wallet. Every model. Every paid API. No subscriptions. No accounts.**
+
+---
+
+## Two products, one Franklin
+
+| | | |
+|---|---|---|
+| 🎯 | **[franklin.run](https://franklin.run)** | **Marketing agent** — campaigns, content, outreach, growth |
+| 📈 | **[franklin.bet](https://franklin.bet)** | **Trading agent** — signals, research, risk analysis |
+
+Both paid per action in USDC. Both backed by the same [BlockRun gateway](https://blockrun.ai) and x402 protocol.
+
+---
+
+## Why Franklin is different
+
+| | Claude Code | Hermes | OpenClaw | **Franklin** |
+|---|---|---|---|---|
+| Writes text | ✅ | ✅ | ✅ | ✅ |
+| Reads code | ✅ | ✅ | ✅ | ✅ |
+| Multi-model | ❌ Claude only | ✅ BYOK | ✅ BYOK | ✅ **55+ via one wallet** |
+| **Spends money autonomously** | ❌ | ❌ | ❌ | ✅ |
+| **Wallet-native identity** | ❌ | ❌ | ❌ | ✅ |
+| **Pay per action** | ❌ subscription | ❌ BYOK | ❌ BYOK | ✅ USDC |
+| **Marketing workflows** | ❌ | ❌ | ❌ | ✅ franklin.run |
+| **Trading workflows** | ❌ | ❌ | ❌ | ✅ franklin.bet |
+| No account / phone verification | ❌ | ⚠️ BYOK | ⚠️ BYOK | ✅ |
+
+**Franklin is the first AI agent in the "Autonomous Economic Agent" category** — an agent that receives a goal, decides what to spend on, and executes autonomously within a hard budget cap enforced by the wallet.
+
+---
+
+## Quick Start
+
+```bash
+# Install
+npm install -g @blockrun/franklin
+
+# Create a wallet (Base or Solana)
+franklin setup base
+
+# Fund wallet with USDC (any amount, $5 gets you started)
+# Check address: franklin balance
+
+# Run
+franklin                           # Interactive agent — code, research, anything
+franklin marketing run             # Marketing workflow
+franklin trading signal "BTC"      # Trading workflow
+franklin plugins                   # List installed plugins
+```
+
+**Start free:** use `franklin` with NVIDIA's free models (Nemotron, Qwen3 Coder) — zero wallet funding required to try it out.
+
+---
+
+## How it works
+
+```
+┌─────────────────────────────────────────────────┐
+│  Franklin Agent (you)                            │
+│  Plugin SDK · CLI · Multi-model router           │
+├─────────────────────────────────────────────────┤
+│  BlockRun Gateway                                │
+│  Aggregates 55+ LLMs + Exa + DALL-E + (soon)    │
+│  Runway + Suno + CoinGecko + Dune + Apollo       │
+├─────────────────────────────────────────────────┤
+│  x402 + Wallet Infrastructure                    │
+│  HTTP 402 micropayments · USDC on Base/Solana    │
+└─────────────────────────────────────────────────┘
+```
+
+Every API call is paid atomically from your wallet via the x402 protocol. You fund once; Franklin spends per task. The wallet is your identity — no accounts, no API keys, no KYC.
+
+---
+
+## Features
+
+### Core agent (55+ models)
+
+- **Multi-model routing** — Claude Sonnet/Opus, GPT-5.4, Gemini 2.5 Pro, DeepSeek, Grok 4, Kimi, GLM-5.1, Llama, NVIDIA free tier
+- **Automatic fallback** — if one model fails, Franklin tries the next
+- **Smart tiers** — free / cheap / premium per task, user-configurable
+- **Prompt caching** — 75% input token savings on Anthropic multi-turn (Hermes pattern)
+- **Structured context compression** — Goal / Progress / Decisions / Files / Next Steps template
+- **Session search** — `franklin search "payment loop"` — full-text across past sessions
+- **Rich insights** — `franklin insights` — cost breakdown, daily activity sparklines, projections
+
+### Plugin SDK
+
+Franklin is plugin-first. Core stays workflow-agnostic. Adding a new vertical requires zero core changes.
+
+```typescript
+import type { Plugin, Workflow } from '@blockrun/franklin/plugin-sdk';
+
+const myWorkflow: Workflow = {
+  id: 'my-workflow',
+  name: 'My Workflow',
+  description: '...',
+  steps: [
+    { name: 'search', modelTier: 'none', execute: async (ctx) => ({ ... }) },
+    { name: 'filter', modelTier: 'cheap', execute: async (ctx) => ({ ... }) },
+    { name: 'draft',  modelTier: 'premium', execute: async (ctx) => ({ ... }) },
+  ],
+  // ...
+};
+```
+
+Full plugin guide: [docs/plugin-sdk.md](docs/plugin-sdk.md)
+
+### Built-in tools
+
+Read · Write · Edit · Bash · Glob · Grep · WebFetch · WebSearch · Task · ImageGen · AskUser · SubAgent (delegated child agents with isolated toolsets)
+
+### MCP integration
+
+Auto-discovers installed MCP servers including `blockrun-mcp` (market data, X data, prediction markets) and `unbrowse` (turn any website into an API). Add your own in `~/.blockrun/mcp.json`.
+
+---
+
+## Slash Commands
+
+| Command | Description |
+|---------|-------------|
+| `/model` | Interactive model picker · `/model <name>` to switch |
+| `/compact` | Compress conversation history (structured summary) |
+| `/search <query>` | Search past sessions by keyword |
+| `/insights` | Rich usage analytics — cost, trends, projections |
+| `/ultrathink` | Deep reasoning mode for hard problems |
+| `/plan` · `/execute` | Read-only planning mode → execution mode |
+| `/history` · `/resume <id>` | Session management |
+| `/commit` · `/push` · `/pr` · `/review` | Git workflow helpers |
+| `/cost` | Session cost and savings vs Claude Opus |
+| `/wallet` | Wallet address and USDC balance |
+| `/help` | Full command list |
+
+---
+
+## Migration from RunCode
+
+**Nothing breaks.** If you were using RunCode, your `runcode` command continues to work as an alias for `franklin` for 60 days. Your config at `~/.blockrun/` is unchanged. Your wallet, sessions, and settings all migrate automatically.
+
+The package name is now `@blockrun/franklin`. Update when convenient:
+
+```bash
+npm uninstall -g @blockrun/runcode
+npm install -g @blockrun/franklin
+```
+
+Both commands (`franklin` and `runcode`) work for the next 60 days. After v3.1.0 ships, `runcode` will be removed.
+
+---
+
+## Architecture
+
+```
+src/
+├── agent/              # Core agent loop, multi-model LLM client, compaction
+├── tools/              # 12 built-in tools
+├── plugin-sdk/         # Public plugin contract (Workflow, Channel, Plugin)
+├── plugins/            # Plugin registry + runner (plugin-agnostic)
+├── plugins-bundled/    # Ships with Franklin — social, marketing (more coming)
+├── session/            # Persistent sessions + FTS search
+├── stats/              # Usage tracking + insights engine
+├── ui/                 # Terminal UI (Ink-based)
+├── proxy/              # Payment proxy for Claude Code compatibility
+├── router/             # Smart model tier routing
+├── wallet/             # Wallet management (Base + Solana)
+└── commands/           # CLI subcommands
+```
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/BlockRunAI/runcode.git
+cd runcode
+npm install
+npm run build
+npm test             # Deterministic local tests (no API calls)
+npm run test:e2e     # Live end-to-end tests (hits real models)
+node dist/index.js --help
+```
+
+---
+
+## Contributing
+
+Contributions welcome. Open an issue first to discuss meaningful changes. For plugin ideas, see [docs/plugin-sdk.md](docs/plugin-sdk.md) — the plugin system is how most new features should land.
+
+---
+
+## Links
+
+- **Marketing**: [franklin.run](https://franklin.run)
+- **Trading**: [franklin.bet](https://franklin.bet)
+- **Parent**: [BlockRun](https://blockrun.ai)
+- **npm**: [@blockrun/franklin](https://npmjs.com/package/@blockrun/franklin)
+- **Telegram**: [t.me/blockrunAI](https://t.me/blockrunAI)
+- **x402 protocol**: [x402.org](https://x402.org)
+
+---
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).
+
+---
+
+<p align="center">
+  <strong>Franklin runs your money.</strong><br>
+  <sub>Your wallet, your agent, your results.</sub>
+</p>

package/dist/agent/commands.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Slash command registry for runcode.
+ * Extracted from loop.ts for maintainability.
+ *
+ * Two types of commands:
+ * 1. "Handled" — execute directly, emit events, return { handled: true }
+ * 2. "Rewrite" — transform input into a prompt for the agent, return { handled: false, rewritten }
+ */
+import type { ModelClient } from './llm.js';
+import type { AgentConfig, Dialogue, StreamEvent } from './types.js';
+type EventEmitter = (event: StreamEvent) => void;
+interface CommandContext {
+    history: Dialogue[];
+    config: AgentConfig;
+    client: ModelClient;
+    sessionId: string;
+    onEvent: EventEmitter;
+}
+interface CommandResult {
+    handled: boolean;
+    rewritten?: string;
+}
+/**
+ * Handle a slash command. Returns result indicating what happened.
+ */
+export declare function handleSlashCommand(input: string, ctx: CommandContext): Promise<CommandResult>;
+export {};