@dev.sail.money/sailor 0.0.2

package/packages/sdk/README.md

@@ -0,0 +1,65 @@
+# @sail.money/sdk
+
+> **Pre-1.0 — unstable.** The Sail Protocol trusted core is under an ongoing
+> external audit by [Octane Security](https://octane.security). The API may
+> change between releases while the protocol is in audit. Do not use staging
+> deployments with funds you are not prepared to lose.
+
+TypeScript SDK for Sail Protocol — the on-chain SMA (Separately Managed
+Account) infrastructure. Peer-depends on `viem ^2`.
+
+## Install
+
+```sh
+npm install @sail.money/sdk viem
+```
+
+## Key exports
+
+| Export | What it does |
+|---|---|
+| `SailorClient` | Full client: account, mandate, dispatch, session, fees |
+| `buildDispatchSignature` | Self-detecting EIP-712 Dispatch signer (reads on-chain model; no footguns) |
+| `detectKernelCapabilities` | Reads `DISPATCH_TYPEHASH` on-chain; identifies conjunctive vs selective kernel |
+| `sailKernelDomain` | EIP-712 domain for any SailKernel |
+| `DISPATCH_EIP712_FIELDS` | Typed struct field lists keyed by dispatch model |
+| `LocalKeyring` | Encrypted manager key (geth keystore v3) |
+| `sailDeployments` | Live staging addresses (Base, Base Sepolia, Arbitrum, Unichain) |
+| `SailIntelligence` | Typed client for the Sail Intelligence API |
+
+## Dispatch signing
+
+```ts
+import { buildDispatchSignature, LocalKeyring } from "@sail.money/sdk";
+import { createPublicClient, http } from "viem";
+
+const publicClient = createPublicClient({ chain: base, transport: http(rpcUrl) });
+const manager = await LocalKeyring.load("path/to/manager.json", passphrase);
+
+const { signature, nonce, deadline, dispatchModel } = await buildDispatchSignature({
+  publicClient,
+  kernel: "0x6319d3dfDDe3804ba93D65752b00c52bFb05a1ab", // Base
+  chainId: 8453,
+  account: mySafe,
+  permission: myPermission,
+  call: { target: router, value: 0n, data: swapCalldata },
+  manager,
+});
+// Submit: kernel.dispatch(account, permission, target, value, data, signature, deadline)
+```
+
+`buildDispatchSignature` reads the kernel's on-chain `DISPATCH_TYPEHASH` to
+select the correct struct automatically — you cannot pass the wrong model.
+
+## Full client
+
+```ts
+import { SailorClient } from "@sail.money/sdk";
+
+const client = new SailorClient({ rpcUrl: "https://...", chainId: 8453 });
+// Read-only operations (no signer required):
+const caps = await client.capabilities();
+// State-changing operations require a signer:
+const exec = client.withSigner(walletClient);
+await exec.dispatch.single(safe, permission, call, manager);
+```

package/packages/sdk/dist/abis/MandateFactory.d.ts

@@ -0,0 +1,140 @@
+/**
+ * MandateFactory ABI — the bundled (configure → register) orchestrator.
+ * Mirrors contracts/factory/MandateFactory.sol in SailProtocol.
+ *
+ * Only the functions the SDK calls are included.
+ */
+export declare const MandateFactoryAbi: readonly [{
+    readonly type: "function";
+    readonly name: "attach";
+    readonly stateMutability: "payable";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+    }, {
+        readonly name: "template";
+        readonly type: "address";
+    }, {
+        readonly name: "params";
+        readonly type: "bytes";
+    }, {
+        readonly name: "configureDeadline";
+        readonly type: "uint256";
+    }, {
+        readonly name: "configureSig";
+        readonly type: "bytes";
+    }, {
+        readonly name: "kernelSig";
+        readonly type: "bytes";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly type: "function";
+    readonly name: "attachBatch";
+    readonly stateMutability: "payable";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+    }, {
+        readonly name: "templates";
+        readonly type: "address[]";
+    }, {
+        readonly name: "params";
+        readonly type: "bytes[]";
+    }, {
+        readonly name: "configureDeadlines";
+        readonly type: "uint256[]";
+    }, {
+        readonly name: "configureSigs";
+        readonly type: "bytes[]";
+    }, {
+        readonly name: "kernelDeadline";
+        readonly type: "uint256";
+    }, {
+        readonly name: "kernelBatchSig";
+        readonly type: "bytes";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly type: "function";
+    readonly name: "reconfigure";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+    }, {
+        readonly name: "template";
+        readonly type: "address";
+    }, {
+        readonly name: "params";
+        readonly type: "bytes";
+    }, {
+        readonly name: "deadline";
+        readonly type: "uint256";
+    }, {
+        readonly name: "configureSig";
+        readonly type: "bytes";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly type: "function";
+    readonly name: "replace";
+    readonly stateMutability: "payable";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+    }, {
+        readonly name: "oldTemplate";
+        readonly type: "address";
+    }, {
+        readonly name: "newTemplate";
+        readonly type: "address";
+    }, {
+        readonly name: "newParams";
+        readonly type: "bytes";
+    }, {
+        readonly name: "configureDeadline";
+        readonly type: "uint256";
+    }, {
+        readonly name: "configureSig";
+        readonly type: "bytes";
+    }, {
+        readonly name: "kernelReplaceSig";
+        readonly type: "bytes";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly type: "function";
+    readonly name: "detach";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+    }, {
+        readonly name: "template";
+        readonly type: "address";
+    }, {
+        readonly name: "kernelSig";
+        readonly type: "bytes";
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly type: "function";
+    readonly name: "detachBatch";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+    }, {
+        readonly name: "templates";
+        readonly type: "address[]";
+    }, {
+        readonly name: "kernelDeadline";
+        readonly type: "uint256";
+    }, {
+        readonly name: "kernelBatchSig";
+        readonly type: "bytes";
+    }];
+    readonly outputs: readonly [];
+}];
+//# sourceMappingURL=MandateFactory.d.ts.map

package/packages/sdk/dist/abis/MandateFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MandateFactory.d.ts","sourceRoot":"","sources":["../../src/abis/MandateFactory.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiFpB,CAAC"}

package/packages/sdk/dist/abis/MandateFactory.js

@@ -0,0 +1,93 @@
+/**
+ * MandateFactory ABI — the bundled (configure → register) orchestrator.
+ * Mirrors contracts/factory/MandateFactory.sol in SailProtocol.
+ *
+ * Only the functions the SDK calls are included.
+ */
+export const MandateFactoryAbi = [
+    {
+        type: "function",
+        name: "attach",
+        stateMutability: "payable",
+        inputs: [
+            { name: "account", type: "address" },
+            { name: "template", type: "address" },
+            { name: "params", type: "bytes" },
+            { name: "configureDeadline", type: "uint256" },
+            { name: "configureSig", type: "bytes" },
+            { name: "kernelSig", type: "bytes" },
+        ],
+        outputs: [],
+    },
+    {
+        type: "function",
+        name: "attachBatch",
+        stateMutability: "payable",
+        inputs: [
+            { name: "account", type: "address" },
+            { name: "templates", type: "address[]" },
+            { name: "params", type: "bytes[]" },
+            { name: "configureDeadlines", type: "uint256[]" },
+            { name: "configureSigs", type: "bytes[]" },
+            { name: "kernelDeadline", type: "uint256" },
+            { name: "kernelBatchSig", type: "bytes" },
+        ],
+        outputs: [],
+    },
+    {
+        type: "function",
+        name: "reconfigure",
+        stateMutability: "nonpayable",
+        inputs: [
+            { name: "account", type: "address" },
+            { name: "template", type: "address" },
+            { name: "params", type: "bytes" },
+            { name: "deadline", type: "uint256" },
+            { name: "configureSig", type: "bytes" },
+        ],
+        outputs: [],
+    },
+    {
+        type: "function",
+        name: "replace",
+        stateMutability: "payable",
+        inputs: [
+            { name: "account", type: "address" },
+            { name: "oldTemplate", type: "address" },
+            { name: "newTemplate", type: "address" },
+            { name: "newParams", type: "bytes" },
+            { name: "configureDeadline", type: "uint256" },
+            { name: "configureSig", type: "bytes" },
+            { name: "kernelReplaceSig", type: "bytes" },
+        ],
+        outputs: [],
+    },
+    {
+        type: "function",
+        name: "detach",
+        stateMutability: "nonpayable",
+        inputs: [
+            { name: "account", type: "address" },
+            { name: "template", type: "address" },
+            { name: "kernelSig", type: "bytes" },
+        ],
+        outputs: [],
+    },
+    {
+        type: "function",
+        name: "detachBatch",
+        stateMutability: "nonpayable",
+        inputs: [
+            { name: "account", type: "address" },
+            { name: "templates", type: "address[]" },
+            { name: "kernelDeadline", type: "uint256" },
+            { name: "kernelBatchSig", type: "bytes" },
+        ],
+        outputs: [],
+    },
+];
+// Note: deployAndAttach and predictCloneAddress were removed — they do not
+// exist on the deployed PermissionFactory contract. Clone template deployment
+// goes through PermissionFactory.attach with a configureSig signed by the
+// permission signer, which handles clone deployment + initialization atomically.
+//# sourceMappingURL=MandateFactory.js.map

package/packages/sdk/dist/abis/MandateFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MandateFactory.js","sourceRoot":"","sources":["../../src/abis/MandateFactory.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,QAAQ;QACd,eAAe,EAAE,SAAS;QAC1B,MAAM,EAAE;YACN,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;YACpC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;YACrC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE;YACjC,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,SAAS,EAAE;YAC9C,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,OAAO,EAAE;YACvC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE;SACrC;QACD,OAAO,EAAE,EAAE;KACZ;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,aAAa;QACnB,eAAe,EAAE,SAAS;QAC1B,MAAM,EAAE;YACN,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;YACpC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE;YACxC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;YACnC,EAAE,IAAI,EAAE,oBAAoB,EAAE,IAAI,EAAE,WAAW,EAAE;YACjD,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,SAAS,EAAE;YAC1C,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,SAAS,EAAE;YAC3C,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,OAAO,EAAE;SAC1C;QACD,OAAO,EAAE,EAAE;KACZ;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,aAAa;QACnB,eAAe,EAAE,YAAY;QAC7B,MAAM,EAAE;YACN,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;YACpC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;YACrC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE;YACjC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;YACrC,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,OAAO,EAAE;SACxC;QACD,OAAO,EAAE,EAAE;KACZ;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,SAAS;QACf,eAAe,EAAE,SAAS;QAC1B,MAAM,EAAE;YACN,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;YACpC,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,EAAE;YACxC,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,EAAE;YACxC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE;YACpC,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,SAAS,EAAE;YAC9C,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,OAAO,EAAE;YACvC,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,OAAO,EAAE;SAC5C;QACD,OAAO,EAAE,EAAE;KACZ;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,QAAQ;QACd,eAAe,EAAE,YAAY;QAC7B,MAAM,EAAE;YACN,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;YACpC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;YACrC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE;SACrC;QACD,OAAO,EAAE,EAAE;KACZ;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,aAAa;QACnB,eAAe,EAAE,YAAY;QAC7B,MAAM,EAAE;YACN,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;YACpC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE;YACxC,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,SAAS,EAAE;YAC3C,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,OAAO,EAAE;SAC1C;QACD,OAAO,EAAE,EAAE;KACZ;CACO,CAAC;AACX,2EAA2E;AAC3E,8EAA8E;AAC9E,0EAA0E;AAC1E,iFAAiF"}

package/packages/sdk/dist/abis/SailGovernance.d.ts

@@ -0,0 +1,57 @@
+/**
+ * SailGovernance ABI — only the views needed to estimate the permission
+ * registration fee. The deployed Base/Base-Sepolia governance uses the legacy
+ * fee model: baseFee + byteLength * complexityRate, capped at
+ * MAX_PERMISSION_FEE_WEI. Newer governance may expose a flat
+ * permissionRegistrationFee() instead; estimatePermissionFee falls back to it.
+ */
+export declare const SailGovernanceAbi: readonly [{
+    readonly type: "function";
+    readonly name: "baseFee";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "complexityRate";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "MAX_PERMISSION_FEE_WEI";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "permissionRegistrationFee";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "maxPermissionsPerAccount";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "uint256";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "isPaused";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "bool";
+    }];
+}];
+//# sourceMappingURL=SailGovernance.d.ts.map

package/packages/sdk/dist/abis/SailGovernance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SailGovernance.d.ts","sourceRoot":"","sources":["../../src/abis/SailGovernance.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA2CpB,CAAC"}

package/packages/sdk/dist/abis/SailGovernance.js

@@ -0,0 +1,52 @@
+/**
+ * SailGovernance ABI — only the views needed to estimate the permission
+ * registration fee. The deployed Base/Base-Sepolia governance uses the legacy
+ * fee model: baseFee + byteLength * complexityRate, capped at
+ * MAX_PERMISSION_FEE_WEI. Newer governance may expose a flat
+ * permissionRegistrationFee() instead; estimatePermissionFee falls back to it.
+ */
+export const SailGovernanceAbi = [
+    {
+        type: "function",
+        name: "baseFee",
+        stateMutability: "view",
+        inputs: [],
+        outputs: [{ type: "uint256" }],
+    },
+    {
+        type: "function",
+        name: "complexityRate",
+        stateMutability: "view",
+        inputs: [],
+        outputs: [{ type: "uint256" }],
+    },
+    {
+        type: "function",
+        name: "MAX_PERMISSION_FEE_WEI",
+        stateMutability: "view",
+        inputs: [],
+        outputs: [{ type: "uint256" }],
+    },
+    {
+        type: "function",
+        name: "permissionRegistrationFee",
+        stateMutability: "view",
+        inputs: [],
+        outputs: [{ type: "uint256" }],
+    },
+    {
+        type: "function",
+        name: "maxPermissionsPerAccount",
+        stateMutability: "view",
+        inputs: [],
+        outputs: [{ type: "uint256" }],
+    },
+    {
+        type: "function",
+        name: "isPaused",
+        stateMutability: "view",
+        inputs: [],
+        outputs: [{ type: "bool" }],
+    },
+];
+//# sourceMappingURL=SailGovernance.js.map

package/packages/sdk/dist/abis/SailGovernance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SailGovernance.js","sourceRoot":"","sources":["../../src/abis/SailGovernance.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,SAAS;QACf,eAAe,EAAE,MAAM;QACvB,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;KAC/B;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,gBAAgB;QACtB,eAAe,EAAE,MAAM;QACvB,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;KAC/B;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,wBAAwB;QAC9B,eAAe,EAAE,MAAM;QACvB,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;KAC/B;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,2BAA2B;QACjC,eAAe,EAAE,MAAM;QACvB,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;KAC/B;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,0BAA0B;QAChC,eAAe,EAAE,MAAM;QACvB,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;KAC/B;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,UAAU;QAChB,eAAe,EAAE,MAAM;QACvB,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;KAC5B;CACO,CAAC"}