@dev.sail.money/sailor 0.0.2-31 → 0.1.0-local

package/examples/permissions/BoundedSwap_UniswapV4_Unichain.sol

@@ -1,150 +1,150 @@
-// SPDX-License-Identifier: MIT
-pragma solidity 0.8.26;
-
-// ─────────────────────────────────────────────────────────────────────────────
-// Protocol : Uniswap V4
-// Version  : Universal Router + PoolManager (V4 singleton)
-//            NOTE: V4 is NOT the same as V3. Calldata encoding is completely
-//            different — do NOT adapt a V3 permission for V4.
-// Chain    : Unichain mainnet
-// Target   : Universal Router  0xef740bf23acae26f6492b10de645d6b98dc8eaf3
-//            (verify on Uniscan before use)
-//
-// ENFORCES ON-CHAIN (kernel calls evaluate() on every dispatch; false ⇒ dispatch blocked):
-//   execute(bytes,bytes[],uint256) selector 0x3593564c  /  execute(bytes,bytes[]) selector 0x24856bc3
-//     • target must be UNIVERSAL_ROUTER
-//     • first command byte (masking the allow-failure MSB) must be V4_SWAP (0x10)
-//     • exactly one command (single-swap path — disallow multi-hop command strings)
-//     • V4 action inside must be SWAP_EXACT_IN_SINGLE (0x00)
-//     • tokenIn (from poolKey, derived by zeroForOne) must be FIXED_CURRENCY_IN
-//     • tokenOut must be in ALLOWED_CURRENCIES_OUT
-//     • amountIn ≤ MAX_AMOUNT_IN
-//     • amountOutMinimum ≥ amountIn × MIN_BPS / 10 000  (slippage floor — see caveat below)
-//
-// AGENT-ENFORCED / NOT BOUNDED HERE (off-chain — can change without redeploying this contract):
-//   • real (cross-denomination) slippage — see MIN_BPS caveat in evaluate()
-//   • swap frequency / cadence
-//
-// DOCUMENTED LIMITATIONS (on-chain, but intentionally not constrained):
-//   • hookData is not inspected (hooks can alter swap behavior on-chain; if the
-//     pool uses a hook that significantly changes execution, this permission cannot
-//     constrain it. Deploy against pools with address(0) hooks or audited hooks only.)
-//   • fee tier and tickSpacing within the PoolKey are not constrained here
-//     (add pool-key checks if you want to restrict to a specific pool)
-//   • The ALL_CURRENCY_PAIR constant (FIXED_CURRENCY_IN, allowedCurrenciesOut) does
-//     not constrain which pool is used when multiple pools share the same currency pair
-//
-// VERIFY BEFORE USE:
-//   • Confirm Universal Router address on Unichain (shown above; verify on Uniscan).
-//   • V4_SWAP command byte = 0x10, SWAP_EXACT_IN_SINGLE action = 0x00 — verify
-//     against deployed UniversalRouter and V4Router on Unichain if contract is updated.
-//   • PoolKey struct layout (currency0, currency1, fee, tickSpacing, hooks) must
-//     match the deployed PoolManager on Unichain. If layout changes, update struct.
-//   • hookData is not bounded. Only use with unhookyed pools or audited, bounded hooks.
-//   • Calldata revert = false (kernel treats revert as denial) — malformed inputs
-//     are safely rejected, but verify with actual calldata samples before deployment.
-// ─────────────────────────────────────────────────────────────────────────────
-
-import {IPermission, Context} from "@sail/interfaces/IPermission.sol";
-
-contract BoundedSwap_UniswapV4_Unichain is IPermission {
-    bytes32 private constant DISCRIMINATOR = keccak256("BoundedSwap_UniswapV4_Unichain");
-
-    address public immutable UNIVERSAL_ROUTER;
-    address public immutable FIXED_CURRENCY_IN;
-    mapping(address => bool) public isAllowedCurrencyOut;
-    uint256 public immutable MAX_AMOUNT_IN;
-    uint256 public immutable MIN_BPS;
-
-    // execute(bytes,bytes[],uint256) — with deadline
-    bytes4 private constant SEL_EXECUTE_DEADLINE = 0x3593564c;
-    // execute(bytes,bytes[])          — without deadline
-    bytes4 private constant SEL_EXECUTE           = 0x24856bc3;
-    // Universal Router command byte for V4_SWAP
-    uint8 private constant CMD_V4_SWAP = 0x10;
-    // Bit mask to strip the "allow failure" MSB from a command byte
-    uint8 private constant CMD_MASK = 0x3f;
-    // V4Router action: SWAP_EXACT_IN_SINGLE
-    uint8 private constant ACT_SWAP_EXACT_IN_SINGLE = 0x00;
-
-    // PoolKey layout must match the deployed V4 PoolManager on Unichain
-    struct PoolKey {
-        address currency0;  // Currency — address type in V4
-        address currency1;
-        uint24  fee;
-        int24   tickSpacing;
-        address hooks;      // IHooks — address(0) for unhookyed pools
-    }
-
-    struct ExactInputSingleParams {
-        PoolKey poolKey;
-        bool    zeroForOne;
-        uint128 amountIn;
-        uint128 amountOutMinimum;
-        bytes   hookData;   // not inspected — see limitations header
-    }
-
-    constructor(
-        address universalRouter,
-        address fixedCurrencyIn,
-        address[] memory allowedCurrenciesOut,
-        uint256 maxAmountIn,
-        uint256 minBps
-    ) {
-        require(minBps <= 10_000, "minBps > 10000");
-        UNIVERSAL_ROUTER  = universalRouter;
-        FIXED_CURRENCY_IN = fixedCurrencyIn;
-        MAX_AMOUNT_IN     = maxAmountIn;
-        MIN_BPS           = minBps;
-        for (uint256 i = 0; i < allowedCurrenciesOut.length; i++) {
-            isAllowedCurrencyOut[allowedCurrenciesOut[i]] = true;
-        }
-    }
-
-    function evaluate(bytes calldata txData, Context calldata ctx) external view returns (bool) {
-        if (ctx.target != UNIVERSAL_ROUTER) return false;
-        if (ctx.selector != SEL_EXECUTE_DEADLINE && ctx.selector != SEL_EXECUTE) return false;
-        if (txData.length < 4) return false;
-
-        // Decode the execute call. Both overloads start with (bytes commands, bytes[] inputs).
-        // abi.decode ignores trailing fields, so decoding as (bytes, bytes[]) works for both.
-        (bytes memory commands, bytes[] memory inputs) = abi.decode(txData[4:], (bytes, bytes[]));
-
-        // Enforce: exactly one command, and it must be V4_SWAP
-        if (commands.length != 1)                              return false;
-        if ((uint8(commands[0]) & CMD_MASK) != CMD_V4_SWAP)   return false;
-        if (inputs.length != 1)                                return false;
-
-        // Decode the V4 router call (actions + per-action params)
-        (bytes memory v4Actions, bytes[] memory v4Params) =
-            abi.decode(inputs[0], (bytes, bytes[]));
-
-        // Enforce: exactly one V4 action, and it must be SWAP_EXACT_IN_SINGLE
-        if (v4Actions.length != 1)                                                    return false;
-        if (uint8(v4Actions[0]) != ACT_SWAP_EXACT_IN_SINGLE)                         return false;
-        if (v4Params.length != 1)                                                     return false;
-
-        // Decode ExactInputSingleParams from the action param.
-        // hookData is a dynamic bytes field — revert here means false (fail closed).
-        ExactInputSingleParams memory p = abi.decode(v4Params[0], (ExactInputSingleParams));
-
-        // Derive tokenIn and tokenOut from the PoolKey and zeroForOne flag.
-        // In V4, currency0 < currency1 (sorted by address). zeroForOne = true means
-        // trading currency0 for currency1.
-        address tokenIn  = p.zeroForOne ? p.poolKey.currency0 : p.poolKey.currency1;
-        address tokenOut = p.zeroForOne ? p.poolKey.currency1 : p.poolKey.currency0;
-
-        if (tokenIn != FIXED_CURRENCY_IN)            return false;
-        if (!isAllowedCurrencyOut[tokenOut])         return false;
-        if (p.amountIn > MAX_AMOUNT_IN)              return false;
-        // Slippage floor: amountOutMinimum ≥ amountIn × MIN_BPS / 10 000.
-        // WARNING: compares tokenOut against tokenIn base units. For same-price/same-decimal
-        // pairs this maps to a slippage %. For cross-price pairs it is trivially satisfied —
-        // real slippage is enforced by the agent off-chain, not by this contract.
-        if (p.amountOutMinimum < (uint256(p.amountIn) * MIN_BPS) / 10_000) return false;
-
-        return true;
-    }
-
-    function discriminator() external pure returns (bytes32) { return DISCRIMINATOR; }
-}
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.26;
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Protocol : Uniswap V4
+// Version  : Universal Router + PoolManager (V4 singleton)
+//            NOTE: V4 is NOT the same as V3. Calldata encoding is completely
+//            different — do NOT adapt a V3 permission for V4.
+// Chain    : Unichain mainnet
+// Target   : Universal Router  0xef740bf23acae26f6492b10de645d6b98dc8eaf3
+//            (verify on Uniscan before use)
+//
+// ENFORCES ON-CHAIN (kernel calls evaluate() on every dispatch; false ⇒ dispatch blocked):
+//   execute(bytes,bytes[],uint256) selector 0x3593564c  /  execute(bytes,bytes[]) selector 0x24856bc3
+//     • target must be UNIVERSAL_ROUTER
+//     • first command byte (masking the allow-failure MSB) must be V4_SWAP (0x10)
+//     • exactly one command (single-swap path — disallow multi-hop command strings)
+//     • V4 action inside must be SWAP_EXACT_IN_SINGLE (0x00)
+//     • tokenIn (from poolKey, derived by zeroForOne) must be FIXED_CURRENCY_IN
+//     • tokenOut must be in ALLOWED_CURRENCIES_OUT
+//     • amountIn ≤ MAX_AMOUNT_IN
+//     • amountOutMinimum ≥ amountIn × MIN_BPS / 10 000  (slippage floor — see caveat below)
+//
+// AGENT-ENFORCED / NOT BOUNDED HERE (off-chain — can change without redeploying this contract):
+//   • real (cross-denomination) slippage — see MIN_BPS caveat in evaluate()
+//   • swap frequency / cadence
+//
+// DOCUMENTED LIMITATIONS (on-chain, but intentionally not constrained):
+//   • hookData is not inspected (hooks can alter swap behavior on-chain; if the
+//     pool uses a hook that significantly changes execution, this permission cannot
+//     constrain it. Deploy against pools with address(0) hooks or audited hooks only.)
+//   • fee tier and tickSpacing within the PoolKey are not constrained here
+//     (add pool-key checks if you want to restrict to a specific pool)
+//   • The ALL_CURRENCY_PAIR constant (FIXED_CURRENCY_IN, allowedCurrenciesOut) does
+//     not constrain which pool is used when multiple pools share the same currency pair
+//
+// VERIFY BEFORE USE:
+//   • Confirm Universal Router address on Unichain (shown above; verify on Uniscan).
+//   • V4_SWAP command byte = 0x10, SWAP_EXACT_IN_SINGLE action = 0x00 — verify
+//     against deployed UniversalRouter and V4Router on Unichain if contract is updated.
+//   • PoolKey struct layout (currency0, currency1, fee, tickSpacing, hooks) must
+//     match the deployed PoolManager on Unichain. If layout changes, update struct.
+//   • hookData is not bounded. Only use with unhookyed pools or audited, bounded hooks.
+//   • Calldata revert = false (kernel treats revert as denial) — malformed inputs
+//     are safely rejected, but verify with actual calldata samples before deployment.
+// ─────────────────────────────────────────────────────────────────────────────
+
+import {IPermission, Context} from "@sail/interfaces/IPermission.sol";
+
+contract BoundedSwap_UniswapV4_Unichain is IPermission {
+    bytes32 private constant DISCRIMINATOR = keccak256("BoundedSwap_UniswapV4_Unichain");
+
+    address public immutable UNIVERSAL_ROUTER;
+    address public immutable FIXED_CURRENCY_IN;
+    mapping(address => bool) public isAllowedCurrencyOut;
+    uint256 public immutable MAX_AMOUNT_IN;
+    uint256 public immutable MIN_BPS;
+
+    // execute(bytes,bytes[],uint256) — with deadline
+    bytes4 private constant SEL_EXECUTE_DEADLINE = 0x3593564c;
+    // execute(bytes,bytes[])          — without deadline
+    bytes4 private constant SEL_EXECUTE           = 0x24856bc3;
+    // Universal Router command byte for V4_SWAP
+    uint8 private constant CMD_V4_SWAP = 0x10;
+    // Bit mask to strip the "allow failure" MSB from a command byte
+    uint8 private constant CMD_MASK = 0x3f;
+    // V4Router action: SWAP_EXACT_IN_SINGLE
+    uint8 private constant ACT_SWAP_EXACT_IN_SINGLE = 0x00;
+
+    // PoolKey layout must match the deployed V4 PoolManager on Unichain
+    struct PoolKey {
+        address currency0;  // Currency — address type in V4
+        address currency1;
+        uint24  fee;
+        int24   tickSpacing;
+        address hooks;      // IHooks — address(0) for unhookyed pools
+    }
+
+    struct ExactInputSingleParams {
+        PoolKey poolKey;
+        bool    zeroForOne;
+        uint128 amountIn;
+        uint128 amountOutMinimum;
+        bytes   hookData;   // not inspected — see limitations header
+    }
+
+    constructor(
+        address universalRouter,
+        address fixedCurrencyIn,
+        address[] memory allowedCurrenciesOut,
+        uint256 maxAmountIn,
+        uint256 minBps
+    ) {
+        require(minBps <= 10_000, "minBps > 10000");
+        UNIVERSAL_ROUTER  = universalRouter;
+        FIXED_CURRENCY_IN = fixedCurrencyIn;
+        MAX_AMOUNT_IN     = maxAmountIn;
+        MIN_BPS           = minBps;
+        for (uint256 i = 0; i < allowedCurrenciesOut.length; i++) {
+            isAllowedCurrencyOut[allowedCurrenciesOut[i]] = true;
+        }
+    }
+
+    function evaluate(bytes calldata txData, Context calldata ctx) external view returns (bool) {
+        if (ctx.target != UNIVERSAL_ROUTER) return false;
+        if (ctx.selector != SEL_EXECUTE_DEADLINE && ctx.selector != SEL_EXECUTE) return false;
+        if (txData.length < 4) return false;
+
+        // Decode the execute call. Both overloads start with (bytes commands, bytes[] inputs).
+        // abi.decode ignores trailing fields, so decoding as (bytes, bytes[]) works for both.
+        (bytes memory commands, bytes[] memory inputs) = abi.decode(txData[4:], (bytes, bytes[]));
+
+        // Enforce: exactly one command, and it must be V4_SWAP
+        if (commands.length != 1)                              return false;
+        if ((uint8(commands[0]) & CMD_MASK) != CMD_V4_SWAP)   return false;
+        if (inputs.length != 1)                                return false;
+
+        // Decode the V4 router call (actions + per-action params)
+        (bytes memory v4Actions, bytes[] memory v4Params) =
+            abi.decode(inputs[0], (bytes, bytes[]));
+
+        // Enforce: exactly one V4 action, and it must be SWAP_EXACT_IN_SINGLE
+        if (v4Actions.length != 1)                                                    return false;
+        if (uint8(v4Actions[0]) != ACT_SWAP_EXACT_IN_SINGLE)                         return false;
+        if (v4Params.length != 1)                                                     return false;
+
+        // Decode ExactInputSingleParams from the action param.
+        // hookData is a dynamic bytes field — revert here means false (fail closed).
+        ExactInputSingleParams memory p = abi.decode(v4Params[0], (ExactInputSingleParams));
+
+        // Derive tokenIn and tokenOut from the PoolKey and zeroForOne flag.
+        // In V4, currency0 < currency1 (sorted by address). zeroForOne = true means
+        // trading currency0 for currency1.
+        address tokenIn  = p.zeroForOne ? p.poolKey.currency0 : p.poolKey.currency1;
+        address tokenOut = p.zeroForOne ? p.poolKey.currency1 : p.poolKey.currency0;
+
+        if (tokenIn != FIXED_CURRENCY_IN)            return false;
+        if (!isAllowedCurrencyOut[tokenOut])         return false;
+        if (p.amountIn > MAX_AMOUNT_IN)              return false;
+        // Slippage floor: amountOutMinimum ≥ amountIn × MIN_BPS / 10 000.
+        // WARNING: compares tokenOut against tokenIn base units. For same-price/same-decimal
+        // pairs this maps to a slippage %. For cross-price pairs it is trivially satisfied —
+        // real slippage is enforced by the agent off-chain, not by this contract.
+        if (p.amountOutMinimum < (uint256(p.amountIn) * MIN_BPS) / 10_000) return false;
+
+        return true;
+    }
+
+    function discriminator() external pure returns (bytes32) { return DISCRIMINATOR; }
+}

package/examples/permissions/BoundedTransfer_ERC20_Ethereum.sol

@@ -1,73 +1,73 @@
-// SPDX-License-Identifier: MIT
-pragma solidity 0.8.26;
-
-// ─────────────────────────────────────────────────────────────────────────────
-// Protocol : ERC-20
-// Version  : Standard ERC-20 (version-agnostic)
-// Chain    : Ethereum mainnet (works on any EVM — the most general example)
-//
-// ENFORCES ON-CHAIN (kernel calls evaluate() on every dispatch; false ⇒ dispatch blocked):
-//   transfer(address to,uint256 amount)  selector 0xa9059cbb
-//     • target must be in ALLOWED_TOKENS
-//     • recipient (to) must be in ALLOWED_RECIPIENTS
-//     • amount ≤ MAX_AMOUNT_PER_TRANSFER
-//
-// AGENT-ENFORCED / NOT BOUNDED HERE (off-chain — can change without redeploying this contract):
-//   • transfer frequency / timing
-//   • choice of token within ALLOWED_TOKENS
-//   • choice of recipient within ALLOWED_RECIPIENTS
-//
-// VERIFY BEFORE USE:
-//   • Selector 0xa9059cbb = transfer(address,uint256) — universally standard.
-//   • ALLOWED_TOKENS prevents the agent from transferring tokens not in the set.
-//     If a protocol uses non-standard transfer methods (e.g. transferFrom or
-//     proprietary hooks), add separate selector entries.
-//   • MAX_AMOUNT_PER_TRANSFER is denominated in the token's base units.
-//     Different tokens have different decimals (USDC = 6, WETH = 18).
-//     Set one permission per token if amounts differ across tokens.
-// ─────────────────────────────────────────────────────────────────────────────
-
-import {IPermission, Context} from "@sail/interfaces/IPermission.sol";
-
-contract BoundedTransfer_ERC20_Ethereum is IPermission {
-    bytes32 private constant DISCRIMINATOR = keccak256("BoundedTransfer_ERC20_Ethereum");
-
-    mapping(address => bool) public isAllowedToken;
-    mapping(address => bool) public isAllowedRecipient;
-    uint256 public immutable MAX_AMOUNT_PER_TRANSFER;
-
-    // transfer(address,uint256)
-    bytes4 private constant SEL_TRANSFER = 0xa9059cbb;
-
-    /// @param allowedTokens        ERC-20 contracts the agent may transfer from
-    /// @param allowedRecipients    Addresses the agent may send to
-    /// @param maxAmountPerTransfer Per-call amount cap (in token base units)
-    constructor(
-        address[] memory allowedTokens,
-        address[] memory allowedRecipients,
-        uint256 maxAmountPerTransfer
-    ) {
-        MAX_AMOUNT_PER_TRANSFER = maxAmountPerTransfer;
-        for (uint256 i = 0; i < allowedTokens.length; i++) {
-            isAllowedToken[allowedTokens[i]] = true;
-        }
-        for (uint256 i = 0; i < allowedRecipients.length; i++) {
-            isAllowedRecipient[allowedRecipients[i]] = true;
-        }
-    }
-
-    function evaluate(bytes calldata txData, Context calldata ctx) external view returns (bool) {
-        if (!isAllowedToken[ctx.target])      return false;
-        if (ctx.selector != SEL_TRANSFER)     return false;
-        if (txData.length < 4 + 2 * 32)      return false;
-
-        (address to, uint256 amount) = abi.decode(txData[4:], (address, uint256));
-
-        if (!isAllowedRecipient[to])                return false;
-        if (amount > MAX_AMOUNT_PER_TRANSFER)       return false;
-
-        return true;
-    }
-
-    function discriminator() external pure returns (bytes32) { return DISCRIMINATOR; }
-}
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.26;
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Protocol : ERC-20
+// Version  : Standard ERC-20 (version-agnostic)
+// Chain    : Ethereum mainnet (works on any EVM — the most general example)
+//
+// ENFORCES ON-CHAIN (kernel calls evaluate() on every dispatch; false ⇒ dispatch blocked):
+//   transfer(address to,uint256 amount)  selector 0xa9059cbb
+//     • target must be in ALLOWED_TOKENS
+//     • recipient (to) must be in ALLOWED_RECIPIENTS
+//     • amount ≤ MAX_AMOUNT_PER_TRANSFER
+//
+// AGENT-ENFORCED / NOT BOUNDED HERE (off-chain — can change without redeploying this contract):
+//   • transfer frequency / timing
+//   • choice of token within ALLOWED_TOKENS
+//   • choice of recipient within ALLOWED_RECIPIENTS
+//
+// VERIFY BEFORE USE:
+//   • Selector 0xa9059cbb = transfer(address,uint256) — universally standard.
+//   • ALLOWED_TOKENS prevents the agent from transferring tokens not in the set.
+//     If a protocol uses non-standard transfer methods (e.g. transferFrom or
+//     proprietary hooks), add separate selector entries.
+//   • MAX_AMOUNT_PER_TRANSFER is denominated in the token's base units.
+//     Different tokens have different decimals (USDC = 6, WETH = 18).
+//     Set one permission per token if amounts differ across tokens.
+// ─────────────────────────────────────────────────────────────────────────────
+
+import {IPermission, Context} from "@sail/interfaces/IPermission.sol";
+
+contract BoundedTransfer_ERC20_Ethereum is IPermission {
+    bytes32 private constant DISCRIMINATOR = keccak256("BoundedTransfer_ERC20_Ethereum");
+
+    mapping(address => bool) public isAllowedToken;
+    mapping(address => bool) public isAllowedRecipient;
+    uint256 public immutable MAX_AMOUNT_PER_TRANSFER;
+
+    // transfer(address,uint256)
+    bytes4 private constant SEL_TRANSFER = 0xa9059cbb;
+
+    /// @param allowedTokens        ERC-20 contracts the agent may transfer from
+    /// @param allowedRecipients    Addresses the agent may send to
+    /// @param maxAmountPerTransfer Per-call amount cap (in token base units)
+    constructor(
+        address[] memory allowedTokens,
+        address[] memory allowedRecipients,
+        uint256 maxAmountPerTransfer
+    ) {
+        MAX_AMOUNT_PER_TRANSFER = maxAmountPerTransfer;
+        for (uint256 i = 0; i < allowedTokens.length; i++) {
+            isAllowedToken[allowedTokens[i]] = true;
+        }
+        for (uint256 i = 0; i < allowedRecipients.length; i++) {
+            isAllowedRecipient[allowedRecipients[i]] = true;
+        }
+    }
+
+    function evaluate(bytes calldata txData, Context calldata ctx) external view returns (bool) {
+        if (!isAllowedToken[ctx.target])      return false;
+        if (ctx.selector != SEL_TRANSFER)     return false;
+        if (txData.length < 4 + 2 * 32)      return false;
+
+        (address to, uint256 amount) = abi.decode(txData[4:], (address, uint256));
+
+        if (!isAllowedRecipient[to])                return false;
+        if (amount > MAX_AMOUNT_PER_TRANSFER)       return false;
+
+        return true;
+    }
+
+    function discriminator() external pure returns (bytes32) { return DISCRIMINATOR; }
+}