@dev.sail.money/sailor 1.3.0-234 → 1.3.0-235

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.
package/README.md CHANGED
@@ -4,12 +4,20 @@
4
4
 
5
5
  [![npm version](https://img.shields.io/npm/v/%40sail.money%2Fsailor)](https://www.npmjs.com/package/@sail.money/sailor)
6
6
  [![license: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
7
- [![Tests](https://github.com/sail-money/Sailor/actions/workflows/tests.yml/badge.svg)](https://github.com/sail-money/Sailor/actions/workflows/tests.yml)
8
- [![node >= 18](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org)
9
7
 
10
8
  ## What you can build
11
9
 
12
- An autonomous or semi-autonomous agent that manages capital inside a **self-custodial Safe**, bounded by **onchain permissions it cannot exceed**. The owner holds the Safe and signs a mandate a set of permission contracts encoding exactly what the agent may do (which venues, which tokens, what size). The agent executes within those bounds; anything outside them is rejected by the SailKernel before it touches funds, and the owner can revoke the agent's dispatch rights instantly without moving assets. The trust model what the contracts enforce versus what stays off-chain — is specified in the [Sail Protocol repo](https://github.com/sail-money/protocol) and the [whitepaper](https://github.com/sail-money/protocol/blob/main/docs/whitepaper/Sail_Protocol_Whitepaper.pdf).
10
+ A trading agent that works a strategy across DEXes. A yield agent that moves capital between lending markets to chase the best rate. A DCA agent that accumulates a position on a schedule. A portfolio rebalancer that holds target allocations through market moves. A vault agent that rotates deposits as conditions change. If a strategy can be expressed as swaps, transfers, lending, deposits, and withdrawals with hard limitsan agent can run it on Sail.
11
+
12
+ Sailor is the toolkit that takes you there, and it does three jobs:
13
+
14
+ 1. **Use the protocol without low-level work.** Sail's shared permission templates (swap, transfer, deposit, withdraw, borrow, and more) are already deployed on every supported chain — and Sailor ships a curated set of skills that equip your agent to configure and use them. You express what the agent may do; nobody writes permission contracts from scratch unless they want to.
15
+ 2. **Design a strategy.** The SDK, CLI, and local dashboard are where you compose the agent's logic and the exact bounds it operates within — which venues, which tokens, what size — then prove those bounds hold with an off-chain simulation before anything is at stake.
16
+ 3. **Automate it, locally.** The agent runs on your machine (or your runner, or your container), with your keys. There is no hosted intermediary: you keep control, and you keep custody.
17
+
18
+ Through all of it, the owner keeps custody. The onchain permissions reject anything outside the mandate before it touches funds, and the owner can revoke the agent's rights instantly without moving assets — a bad strategy can waste its budget, but it cannot exceed it.
19
+
20
+ For the details — what the contracts enforce versus what stays off-chain — see the [Sail Protocol repo](https://github.com/sail-money/protocol) and the [whitepaper](https://github.com/sail-money/protocol/blob/main/docs/whitepaper/Sail_Protocol_Whitepaper.pdf).
13
21
 
14
22
  ## What's in the box
15
23
 
@@ -18,9 +26,9 @@ An autonomous or semi-autonomous agent that manages capital inside a **self-cust
18
26
  | **SDK** (`@sail.money/sailor/sdk`) | `SailorClient`, encrypted keyring, EIP-712 signing, dispatch submission, deployment + chain registries, template encoders |
19
27
  | **CLI** (`sailor`) | Everything from `sailor init` to `sailor run`: keys, SMA deployment, mandate lifecycle, agent loop, doctor, session control |
20
28
  | **Dashboard** (`sailor ui`) | Local web UI for onboarding, balances, mandate health, activity, and owner signing |
21
- | **Scaffolded skills** | Step-by-step procedures under `.agents/skills/` that your AI coding assistant follows to set up and operate the agent |
29
+ | **Skills** | Seventeen curated procedures under `.agents/skills/` that equip the agent across the whole workflow project setup and diagnostics, mandate authoring and template configuration, market data and transactions, unattended automation |
22
30
 
23
- **About the scaffold.** `sailor init` scaffolds your project from `templates/default/`, which ships two things together: the `.agents/skills` your assistant follows, and the **worked example permissions** (`templates/default/examples/` → your project's `examples/`) those skills teach from — protocol-specific bounding patterns (Uniswap, Aave, GMX, ERC-4626, and more) plus an `IPermission` authoring workspace. The examples are shipped teaching material inside every scaffold, not repo furniture.
31
+ **About the scaffold.** `sailor init` scaffolds your project from `templates/default/`, and the agent arrives already equipped: the skills cover setting up (onboarding, project state, the local servers), defining the mandate (one skill per shared template, plus the full custom-permission lifecycle), executing strategy (token resolution and liquidity mapping, live swap quotes, the dispatch model), and running unattended (automation options, notifications, custom dashboards). Alongside the skills ship the **worked example permissions** (`templates/default/examples/` → your project's `examples/`) the mandate skills teach from — protocol-specific bounding patterns (Uniswap, Aave, GMX, ERC-4626, and more) plus an `IPermission` authoring workspace. Shipped teaching material in every scaffold, not repo furniture.
24
32
 
25
33
  ## Installation
26
34
 
@@ -50,7 +58,7 @@ Project files live on your host via the volume mount; prefix `sailor` commands w
50
58
 
51
59
  ## Quickstart
52
60
 
53
- The recommended path is assistant-driven: open the scaffolded folder in Claude Code, Cursor, Codex, or any AI coding assistant and say **"start"** — the scaffold's `AGENTS.md` and skills walk the assistant through everything below. The direct-CLI version of the same journey:
61
+ The recommended path is agent-driven: open the scaffolded folder in Claude Code, Cursor, Codex, or any AI coding agent and say **"start"** — the scaffold's `AGENTS.md` and skills walk the agent through everything below. The direct-CLI version of the same journey:
54
62
 
55
63
  ```bash
56
64
  npx sailor init my-agent && cd my-agent && npm install
@@ -84,9 +92,9 @@ Each probed call prints a verdict — `PASS`, `FAIL`, or `REVERT` — which is t
84
92
 
85
93
  Longer walkthrough, including revocation: [docs/getting-started.md](./docs/getting-started.md).
86
94
 
87
- ## How the assistant is guided (skills)
95
+ ## How the agent is guided (skills)
88
96
 
89
- The scaffold follows the open [Agent Skills](https://agentskills.io) standard: a slim, always-loaded `AGENTS.md` carries the project map and hard invariants, while detailed procedures live in on-demand skills under `.agents/skills/` — onboarding, transactions, mandate authoring, shared-template configuration (one skill per template), automation, and more. Shared templates are registered and configured *through* the skills because the safe order of operations (register → configure → simulate → verify) is encoded there once, instead of re-derived by every assistant. Skills are plain markdown; assistants that don't scan skills follow the routing table in `AGENTS.md` to the same files. See [docs/templates-and-skills.md](./docs/templates-and-skills.md).
97
+ The scaffold follows the open [Agent Skills](https://agentskills.io) standard: a slim, always-loaded `AGENTS.md` carries the project map and hard invariants, while detailed procedures live in on-demand skills under `.agents/skills/` — onboarding, transactions, mandate authoring, shared-template configuration (one skill per template), automation, and more. Shared templates are registered and configured *through* the skills because the safe order of operations (register → configure → simulate → verify) is encoded there once, instead of re-derived by every agent. Skills are plain markdown; agents that don't scan skills follow the routing table in `AGENTS.md` to the same files. See [docs/templates-and-skills.md](./docs/templates-and-skills.md).
90
98
 
91
99
  ## Documentation
92
100
 
@@ -113,7 +121,7 @@ Vulnerability reports: see [SECURITY.md](./SECURITY.md) (off-chain toolkit) —
113
121
 
114
122
  The SDK bundles verified deployments for **11 chains** — mainnets: Ethereum (1), Base (8453), Arbitrum (42161), Optimism (10), Unichain (130), BSC (56), World Chain (480), HyperEVM (999), MegaETH (4326); testnets: Base Sepolia (84532), Ethereum Sepolia (11155111). Every core contract sits at the same address on every chain via CREATE2 (SailKernel: `0x38b508756c976e876EFF05a29E731A4d348BA6ED`), and the seven shared permission templates (swap, swap-no-oracle, borrow, deposit, withdraw, transfer, approve-and-call-batch) are deployed and registered as `knownTemplates` on all of them. Query it yourself: `sailor chains` or `getSailDeployment(chainId)` from the SDK; the canonical record is the protocol repo's [deployments/addresses.md](https://github.com/sail-money/protocol/blob/main/deployments/addresses.md).
115
123
 
116
- These deployments are under an ongoing external **security review** by [Octane](https://octane.security) and are not finaldo not use them with funds you are not prepared to lose.
124
+ The Sail Protocol trusted core and its seven shared permission templates underwent an AI **security review** by [Octane](https://octane.security); the final analysis identified no critical- or high-severity findings, and the reports live in the protocol repo's [docs/security](https://github.com/sail-money/protocol/tree/main/docs/security). That review covers the protocol contracts — not this toolkit. A security review is not a guarantee of correctness; size your exposure accordingly.
117
125
 
118
126
  ## Contributing
119
127
 
package/package.json CHANGED
@@ -1,11 +1,7 @@
1
1
  {
2
2
  "name": "@dev.sail.money/sailor",
3
- "version": "1.3.0-234",
3
+ "version": "1.3.0-235",
4
4
  "description": "Operator toolkit for Sail Protocol",
5
- "repository": {
6
- "type": "git",
7
- "url": "git+https://github.com/sail-money/Sailor.git"
8
- },
9
5
  "bin": {
10
6
  "sailor": "packages/cli/dist/index.cjs"
11
7
  },
@@ -5,7 +5,7 @@
5
5
  * Do not edit manually — run `pnpm build` to regenerate.
6
6
  *
7
7
  * Spec version : 1.2.1
8
- * Generated at : 2026-07-03T09:21:08.693Z
8
+ * Generated at : 2026-07-03T09:27:19.993Z
9
9
  */
10
10
  export declare const SAIL_INTELLIGENCE_BASE_URL = "https://api.sail.money";
11
11
  export declare const SAIL_INTELLIGENCE_DOCS_URL = "https://api.sail.money/docs";
@@ -5,7 +5,7 @@
5
5
  * Do not edit manually — run `pnpm build` to regenerate.
6
6
  *
7
7
  * Spec version : 1.2.1
8
- * Generated at : 2026-07-03T09:21:08.693Z
8
+ * Generated at : 2026-07-03T09:27:19.993Z
9
9
  */
10
10
  export const SAIL_INTELLIGENCE_BASE_URL = "https://api.sail.money";
11
11
  export const SAIL_INTELLIGENCE_DOCS_URL = "https://api.sail.money/docs";