@intentfi/agent-sdk 0.1.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 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 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 2026 IntentFi
+
+   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,194 @@
+# @intentfi/agent-sdk
+
+> Execute complex DeFi strategies in one sentence.
+
+IntentFi turns natural-language intent into fully orchestrated on-chain transactions — route planning, multi-step sequencing, cross-chain bridging, token approvals, and error recovery, handled for you. Say what you want; IntentFi figures out how.
+
+This package provides the TypeScript SDK and CLI for agent integration via REST or MCP (Model Context Protocol).
+
+## Why IntentFi
+
+- **One sentence, multiple protocols.** Combine swaps, bridges, lending, and yield positions into a single intent. `swap ETH to USDC, then lend all on Aave` is one API call — IntentFi plans the route and sequences every step.
+- **No routing logic required.** You don't choose DEXs, bridge providers, or gas parameters. IntentFi selects optimal routes across supported protocols and chains.
+- **Stateless for your agent.** Create a workflow, poll its state, follow `nextAction.type`, act. No local state to manage, no complex retry logic.
+- **Built-in safety.** Dry-run mode, manifest verification before signing, max-value guards, and idempotent retries — test safely, execute confidently.
+
+## Installation
+
+```bash
+npm install @intentfi/agent-sdk
+```
+
+For the CLI globally:
+
+```bash
+npm install -g @intentfi/agent-sdk
+```
+
+## Common Agent Scenarios
+
+These are real workflows you can run through IntentFi today:
+
+| Scenario | Intent | What IntentFi handles for you |
+|----------|--------|-------------------------------|
+| Portfolio rebalance | `swap 50% ETH to USDC on Arbitrum, then lend all on Aave` | Route selection, swap execution, Aave approval + supply, step sequencing |
+| Yield farming setup | `lend 1000 USDC on Aave Arbitrum, borrow 0.5 WETH, then swap to PT-WEETH on Pendle` | Three-protocol orchestration across Aave + Pendle in one workflow |
+| Cross-chain move | `bridge all USDC from Base to Arbitrum, then lend on Aave` | Bridge route selection, wait for bridge confirmation, auto-proceed to lending |
+| Token consolidation | `sweep all tokens into USDC on Arbitrum` | Identifies all token balances on chain, plans optimal swap routes, converts to your target |
+| Leveraged position | `loop 1 WETH on Aave Arbitrum: 3 loops, target 70% LTV` | Recursive supply-borrow cycles with automatic LTV management |
+
+## Quick Start
+
+### As a Library
+
+```typescript
+import { IntentFiClient } from "@intentfi/agent-sdk";
+
+const client = new IntentFiClient({
+  baseUrl: "https://agentic.intentfi.io",
+  apiKey: process.env.INTENTFI_API_KEY,
+  transport: "rest", // or "mcp"
+});
+
+// Create a workflow from a natural-language intent
+const workflow = await client.createWorkflow({
+  intent: "swap 0.01 ETH to USDC on Base",
+  chainId: 8453,
+});
+
+// Monitor workflow progress
+const status = await client.getWorkflow({
+  workflowId: workflow.workflowId,
+  waitMs: 120000,
+});
+```
+
+### As a CLI
+
+```bash
+# Set signer key from a secure source (recommended before auth/execute)
+read -s INTENTFI_PRIVATE_KEY && export INTENTFI_PRIVATE_KEY
+
+# Authenticate (one-time SIWE flow; reads INTENTFI_PRIVATE_KEY)
+intentfi auth siwe --chain-id 8453
+
+# Create and run a workflow
+intentfi run "swap 0.01 ETH to USDC on Base" --chain-id 8453
+
+# Watch workflow progress
+intentfi watch <workflowId>
+
+# Execute (prepare + sign + submit transactions; reads INTENTFI_PRIVATE_KEY)
+intentfi execute <workflowId> --dry-run false
+```
+
+## Authentication
+
+Agents authenticate by signing a SIWE (Sign-In with Ethereum) message with their wallet to mint an API key.
+
+1. `POST /agent/v1/auth/siwe/challenge` — request a nonce.
+2. Sign the returned message with your wallet.
+3. `POST /agent/v1/auth/siwe/mint-key` — exchange signature for an API key. **Scopes are required** — provide at least one from: `workflow:create`, `workflow:read`, `batch:prepare`, `batch:submit`, `limits:read`.
+4. **Store the key persistently** (env var, secrets manager, config file). It is long-lived and reusable — you only need to authenticate once.
+5. Send `x-api-key: <key>` on all subsequent requests.
+
+`Authorization: Bearer ifak_...` is also accepted.
+
+## SDK Methods
+
+**Authentication:**
+- `requestSiweChallenge({ address, walletType, chainId })`
+- `mintApiKeyWithSiwe({ message, signature, walletType, scopes, label, expiresAtMs })`
+
+**REST Workflow:**
+- `createWorkflow({ intent, operationId, chainId })`
+- `getWorkflow({ workflowId, waitMs })`
+- `prepareActive({ workflowId, requestId, waitMs })`
+- `getActiveSubmissionContext({ workflowId })`
+- `submitActiveTransactions({ workflowId, requestId, manifestHash, transactions, waitMs })`
+- `submitActiveSendCalls({ workflowId, requestId, bundleId, manifestHash, walletType, waitMs })`
+
+**MCP:**
+- `mcpInitialize()`
+- `mcpToolCall(name, args, { stream? })`
+
+## CLI Commands
+
+```bash
+intentfi auth siwe                    # Authenticate and mint API key
+intentfi run "<intent>"               # Create and start a workflow
+intentfi watch <workflowId>           # Watch workflow progress
+intentfi execute <workflowId>         # Full execution (prepare + sign + submit)
+```
+
+**Global options:**
+- `--base-url <url>` — API URL (default: `https://agentic.intentfi.io`)
+- `--api-key <key>` — API key (or set `INTENTFI_API_KEY`)
+- `--transport rest|mcp` — Transport mode (default: `rest`)
+
+**Execute options:**
+- `--dry-run true|false` — Dry run mode (default: `true`)
+- `--max-value-wei <wei>` — Max transaction value guard
+- `--wait-receipts` — Wait for on-chain receipts
+- `--private-key <key>` — Optional local override for debugging; prefer `INTENTFI_PRIVATE_KEY`
+
+For production agents, load signer secrets from your environment or secrets manager and avoid passing private keys as CLI arguments.
+
+## Supported Intents
+
+Agents send a plain natural-language string. There are no structured fields to fill out — just say what you want.
+
+| Category | Intents | Example |
+|----------|---------|---------|
+| Trading | **Swap** | `swap 0.5 ETH for USDC on Arbitrum` |
+| Trading | **Bridge** | `bridge 100 USDC from Arbitrum to Base` |
+| Lending | **Lend / Supply** | `lend 1000 USDC on Aave Arbitrum` |
+| Lending | **Borrow** | `borrow 500 USDC on Aave Arbitrum at variable rate` |
+| Lending | **Repay** | `repay all WETH debt on Aave Base` |
+| Advanced | **Loop / Leverage** | `loop 1 WETH on Aave Arbitrum: 3 loops, target 70% LTV` |
+| Advanced | **Pendle Yield** | `swap 0.5 WETH for PT-WEETH on Pendle Arbitrum` |
+| Utility | **Sweep** | `sweep all tokens into USDC on Arbitrum` |
+| Compose | **Multi-Step** | `swap ETH to USDC on Arbitrum, then lend all on Aave` |
+
+Amounts accept: absolute (`100`), percentage (`50%`, `all`), or dollar value (`$100 worth`).
+
+## Supported Chains
+
+| Chain | Chain ID |
+|-------|----------|
+| Ethereum | 1 |
+| Optimism | 10 |
+| BNB Chain | 56 |
+| Polygon | 137 |
+| Base | 8453 |
+| Arbitrum | 42161 |
+| Berachain | 80094 |
+
+## Agent Integration Paths
+
+| Transport | Endpoint | Best For |
+|-----------|----------|----------|
+| REST API | `https://agentic.intentfi.io/agent/v1` | Direct HTTP integration |
+| MCP | `https://agentic.intentfi.io/mcp` | LLM tool-use (Model Context Protocol) |
+| SDK / CLI | `@intentfi/agent-sdk` | TypeScript agents and terminal workflows |
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `INTENTFI_API_KEY` | API key for authenticated requests |
+| `INTENTFI_BASE_URL` | Gateway base URL |
+| `INTENTFI_TRANSPORT` | Transport mode (`rest` or `mcp`) |
+| `INTENTFI_PRIVATE_KEY` | Preferred signer key source for CLI `auth siwe` and non-dry-run `execute` |
+
+## Links
+
+- Web app: [https://intentfi.io](https://intentfi.io)
+- Support and feedback: [https://intentfi.io](https://intentfi.io) (Feedback button)
+- [Full Agent Reference](https://intentfi.io/llms-full.txt)
+- [OpenAPI Spec](https://intentfi.io/agent/v1/openapi.json)
+- [Agent Discovery](https://intentfi.io/.well-known/agent.json)
+
+## License
+
+Apache-2.0

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}