WIP: intent-based settlement Settler

CHANGELOG.md

@@ -21,6 +21,10 @@ Master list of UniV3 forks:
 
 ---
 
+* Create new Settler version for intent-based settlement -- the taker only signs
+ the slippage, not the actions
+ * This is now `tokenId` 4
+
 ## 2024-08-26
 
 ### Breaking changes

README.md

@@ -13,12 +13,13 @@ ERC721-compatible NFT. To find the address of the most recent `Settler`
 deployment, call `function ownerOf(uint256 tokenId) external view returns (address)`
 with the `tokenId` set to the number of the feature that you wish to query. For
 taker-submitted flows, the feature number is probably 2 unless something major
-changed and nobody updated this document. Likewise, for gasless/metatransaction
-flows, the feature number is probably 3. A reverting response indicates that
-`Settler` is paused and you should not interact. Do not hardcode any `Settler`
-address in your integration. _**ALWAYS**_ query the deployer/registry for the
-address of the most recent `Settler` contract before building or signing a
-transaction, metatransaction, or order.
+changed and nobody updated this document. For gasless/metatransaction flows, the
+feature number is probably 3. For intents, the feature number is probably 4. A
+reverting response indicates that `Settler` is paused and you should not
+interact. Do not hardcode any `Settler` address in your
+integration. _**ALWAYS**_ query the deployer/registry for the address of the
+most recent `Settler` contract before building or signing a transaction,
+metatransaction, or order.
 
 ### 0x API dwell time
 
@@ -153,6 +154,7 @@ import { createPublicClient, http, parseAbi } from 'viem';
  const tokenDescriptions = {
  2: "taker submitted",
  3: "metatransaction",
+ 4: "intents",
  };
 
  const deployerAbi = parseAbi([
@@ -211,6 +213,7 @@ const {ethers} = require("ethers");
  const tokenDescriptions = {
  2: "taker submitted",
  3: "metatransaction",
+ 4: "intents",
  };
 
  const deployerAbi = [
@@ -300,8 +303,12 @@ async fn main() -> Result<()> {
  let provider = ProviderBuilder::new().on_http(env::var("RPC_URL")?.parse()?);
  let block_id = BlockId::number(provider.get_block_number().await?);
 
- let token_ids = vec![2, 3];
- let token_descriptions = HashMap::from([(2, "taker submitted"), (3, "metatransaction")]);
+ let token_ids = vec![2, 3, 4];
+ let token_descriptions = HashMap::from([
+ (2, "taker submitted"),
+ (3, "metatransaction"),
+ (4, "intents")
+ ]);
 
  for token_id in token_ids.iter() {
  {
@@ -384,6 +391,7 @@ deployer_address = "0x00000000000004533Fe15556B1E086BB1A72cEae"
 token_descriptions = {
  2: "taker submitted",
  3: "metatransaction",
+ 4: "intents",
 }
 
 deployer_abi = [
@@ -461,6 +469,7 @@ declare -r deployer='0x00000000000004533Fe15556B1E086BB1A72cEae'
 declare -A token_descriptions
 token_descriptions[2]='taker submitted'
 token_descriptions[3]='metatransaction'
+token_descriptions[4]='intents'
 declare -r -A token_descriptions
 
 declare -r -a function_signatures=('prev(uint128)(address)' 'ownerOf(uint256)(address)' 'next(uint128)(address)')
@@ -1250,10 +1259,10 @@ from this document.
 ![Click on "Connect to Web3"](img/pause6.png?raw=true)
 
 9. Enter the "feature" number in the text box. This is probably 2 for
- taker-submitted for 3 for gasless/metatransaction, unless something major has
- changed and nobody bothered to update this document.
+ taker-submitted, 3 for gasless/metatransaction, or 4 for intents, unless
+ something major has changed and nobody bothered to update this document.
 
-![Enter the "feature" number (2 or 3) in the text box](img/pause7.png?raw=true)
+![Enter the "feature" number (2, 3, or 4) in the text box](img/pause7.png?raw=true)
 
 10. Click "Write" and confirm the transaction in your wallet. You have _really_ ruined everybody's day :+1:
 

src/Settler.sol

@@ -18,10 +18,9 @@ abstract contract Settler is Permit2PaymentTakerSubmitted, SettlerBase {
  using UnsafeMath for uint256;
  using CalldataDecoder for bytes[];
 
- // When/if you change this, you must make corresponding changes to
- // `sh/deploy_new_chain.sh` and 'sh/common_deploy_settler.sh' to set
- // `constructor_args`.
- constructor(bytes20 gitCommit) SettlerBase(gitCommit, 2) {}
+ function _tokenId() internal pure override returns (uint256) {
+ return 2;
+ }
 
  function _hasMetaTxn() internal pure override returns (bool) {
  return false;

src/SettlerAbstract.sol

@@ -9,13 +9,20 @@ abstract contract SettlerAbstract is Permit2PaymentAbstract {
  "SlippageAndActions(address recipient,address buyToken,uint256 minAmountOut,bytes[] actions)";
  bytes32 internal constant SLIPPAGE_AND_ACTIONS_TYPEHASH =
  0x615e8d716cef7295e75dd3f1f10d679914ad6d7759e8e9459f0109ef75241701;
+ // Permit2 Witness for intents
+ string internal constant SLIPPAGE_TYPE = "Slippage(address recipient,address buyToken,uint256 minAmountOut)";
+ bytes32 internal constant SLIPPAGE_TYPEHASH = 0xdc83993a2ffc65b01b71ed08790b6e39c5c55d76937b62a3b5085b02071f1259;
+
  uint256 internal constant BASIS = 10_000;
 
  constructor() {
  assert(SLIPPAGE_AND_ACTIONS_TYPEHASH == keccak256(bytes(SLIPPAGE_AND_ACTIONS_TYPE)));
+ assert(SLIPPAGE_TYPEHASH == keccak256(bytes(SLIPPAGE_TYPE)));
  }
 
  function _hasMetaTxn() internal pure virtual returns (bool);
 
+ function _tokenId() internal pure virtual returns (uint256);
+
  function _dispatch(uint256 i, bytes4 action, bytes calldata data) internal virtual returns (bool);
 }

src/SettlerBase.sol

@@ -57,10 +57,13 @@ abstract contract SettlerBase is Basic, RfqOrderSettlement, UniswapV3Fork, Unisw
 
  event GitCommit(bytes20 indexed);
 
- constructor(bytes20 gitCommit, uint256 tokenId) {
+ // When/if you change this, you must make corresponding changes to
+ // `sh/deploy_new_chain.sh` and 'sh/common_deploy_settler.sh' to set
+ // `constructor_args`.
+ constructor(bytes20 gitCommit) {
  if (block.chainid != 31337) {
  emit GitCommit(gitCommit);
- assert(IERC721Owner(0x00000000000004533Fe15556B1E086BB1A72cEae).ownerOf(tokenId) == address(this));
+ assert(IERC721Owner(0x00000000000004533Fe15556B1E086BB1A72cEae).ownerOf(_tokenId()) == address(this));
  } else {
  assert(gitCommit == bytes20(0));
  }

src/SettlerIntent.sol

@@ -0,0 +1,72 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.25;
+
+import {SettlerAbstract} from "./SettlerAbstract.sol";
+import {SettlerBase} from "./SettlerBase.sol";
+import {SettlerMetaTxn} from "./SettlerMetaTxn.sol";
+
+import {Permit2PaymentAbstract} from "./core/Permit2PaymentAbstract.sol";
+import {Permit2PaymentIntent, Permit2PaymentMetaTxn, Permit2Payment} from "./core/Permit2Payment.sol";
+
+import {ISignatureTransfer} from "permit2/src/interfaces/ISignatureTransfer.sol";
+
+abstract contract SettlerIntent is Permit2PaymentIntent, SettlerMetaTxn {
+ function _tokenId() internal pure virtual override(SettlerAbstract, SettlerMetaTxn) returns (uint256) {
+ return 4;
+ }
+
+ function _msgSender()
+ internal
+ view
+ virtual
+ // Solidity inheritance is so stupid
+ override(Permit2PaymentMetaTxn, SettlerMetaTxn)
+ returns (address)
+ {
+ return super._msgSender();
+ }
+
+ function _witnessTypeSuffix()
+ internal
+ pure
+ virtual
+ // Solidity inheritance is so stupid
+ override(Permit2PaymentMetaTxn, Permit2PaymentIntent)
+ returns (string memory)
+ {
+ return super._witnessTypeSuffix();
+ }
+
+ function _hashSlippage(AllowedSlippage calldata slippage) internal pure returns (bytes32 result) {
+ // This function does not check for or clean any dirty bits that might
+ // exist in `slippage`. We assume that `slippage` will be used elsewhere
+ // in this context and that if there are dirty bits it will result in a
+ // revert later.
+ assembly ("memory-safe") {
+ let ptr := mload(0x40)
+ mstore(ptr, SLIPPAGE_TYPEHASH)
+ calldatacopy(add(ptr, 0x20), slippage, 0x60)
+ result := keccak256(ptr, 0x80)
+ }
+ }
+
+ function _executeMetaTxn(
+ AllowedSlippage calldata slippage,
+ bytes[] calldata actions,
+ bytes32, /* zid & affiliate */
+ address msgSender,
+ bytes calldata sig
+ ) public virtual metaTx(msgSender, _hashSlippage(slippage)) returns (bool) {
+ return _executeMetaTxn(slippage, actions, sig);
+ }
+
+ function _permitToSellAmount(ISignatureTransfer.PermitTransferFrom memory permit)
+ internal
+ view
+ virtual
+ override(Permit2Payment, Permit2PaymentAbstract)
+ returns (uint256 sellAmount)
+ {
+ sellAmount = permit.permitted.amount;
+ }
+}

src/SettlerMetaTxn.sol

@@ -16,10 +16,9 @@ abstract contract SettlerMetaTxn is Permit2PaymentMetaTxn, SettlerBase {
  using UnsafeMath for uint256;
  using CalldataDecoder for bytes[];
 
- // When/if you change this, you must make corresponding changes to
- // `sh/deploy_new_chain.sh` and 'sh/common_deploy_settler.sh' to set
- // `constructor_args`.
- constructor(bytes20 gitCommit) SettlerBase(gitCommit, 3) {}
+ function _tokenId() internal pure virtual override returns (uint256) {
+ return 3;
+ }
 
  function _hasMetaTxn() internal pure override returns (bool) {
  return true;
@@ -122,13 +121,10 @@ abstract contract SettlerMetaTxn is Permit2PaymentMetaTxn, SettlerBase {
  return true;
  }
 
- function executeMetaTxn(
- AllowedSlippage calldata slippage,
- bytes[] calldata actions,
- bytes32, /* zid & affiliate */
- address msgSender,
- bytes calldata sig
- ) public metaTx(msgSender, _hashActionsAndSlippage(actions, slippage)) returns (bool) {
+ function _executeMetaTxn(AllowedSlippage calldata slippage, bytes[] calldata actions, bytes calldata sig)
+ internal
+ returns (bool)
+ {
  require(actions.length != 0);
  {
  (bytes4 action, bytes calldata data) = actions.decodeCall(0);
@@ -151,4 +147,14 @@ abstract contract SettlerMetaTxn is Permit2PaymentMetaTxn, SettlerBase {
  _checkSlippageAndTransfer(slippage);
  return true;
  }
+
+ function executeMetaTxn(
+ AllowedSlippage calldata slippage,
+ bytes[] calldata actions,
+ bytes32, /* zid & affiliate */
+ address msgSender,
+ bytes calldata sig
+ ) public virtual metaTx(msgSender, _hashActionsAndSlippage(actions, slippage)) returns (bool) {
+ return _executeMetaTxn(slippage, actions, sig);
+ }
 }

src/chains/Arbitrum.sol

@@ -4,6 +4,7 @@ pragma solidity ^0.8.25;
 import {SettlerBase} from "../SettlerBase.sol";
 import {Settler} from "../Settler.sol";
 import {SettlerMetaTxn} from "../SettlerMetaTxn.sol";
+import {SettlerIntent} from "../SettlerIntent.sol";
 
 import {IERC20} from "forge-std/interfaces/IERC20.sol";
 import {MaverickV2, IMaverickV2Pool} from "../core/MaverickV2.sol";
@@ -39,6 +40,7 @@ import {dackieSwapV3ArbitrumFactory, dackieSwapV3ForkId} from "../core/univ3fork
 import {SettlerAbstract} from "../SettlerAbstract.sol";
 import {AbstractContext} from "../Context.sol";
 import {Permit2PaymentAbstract} from "../core/Permit2PaymentAbstract.sol";
+import {Permit2PaymentMetaTxn, Permit2Payment} from "../core/Permit2Payment.sol";
 
 abstract contract ArbitrumMixin is FreeMemory, SettlerBase, MaverickV2, CurveTricrypto, DodoV2 {
  constructor() {
@@ -124,9 +126,15 @@ abstract contract ArbitrumMixin is FreeMemory, SettlerBase, MaverickV2, CurveTri
 
 /// @custom:security-contact [email protected]
 contract ArbitrumSettler is Settler, ArbitrumMixin {
- constructor(bytes20 gitCommit) Settler(gitCommit) {}
+ constructor(bytes20 gitCommit) SettlerBase(gitCommit) {}
 
- function _dispatchVIP(bytes4 action, bytes calldata data) internal override DANGEROUS_freeMemory returns (bool) {
+ function _dispatchVIP(bytes4 action, bytes calldata data)
+ internal
+ virtual
+ override
+ DANGEROUS_freeMemory
+ returns (bool)
+ {
  if (super._dispatchVIP(action, data)) {
  return true;
  } else if (action == ISettlerActions.MAVERICKV2_VIP.selector) {
@@ -168,6 +176,7 @@ contract ArbitrumSettler is Settler, ArbitrumMixin {
 
  function _dispatch(uint256 i, bytes4 action, bytes calldata data)
  internal
+ virtual
  override(SettlerAbstract, SettlerBase, ArbitrumMixin)
  returns (bool)
  {
@@ -181,10 +190,11 @@ contract ArbitrumSettler is Settler, ArbitrumMixin {
 
 /// @custom:security-contact [email protected]
 contract ArbitrumSettlerMetaTxn is SettlerMetaTxn, ArbitrumMixin {
- constructor(bytes20 gitCommit) SettlerMetaTxn(gitCommit) {}
+ constructor(bytes20 gitCommit) SettlerBase(gitCommit) {}
 
  function _dispatchVIP(bytes4 action, bytes calldata data, bytes calldata sig)
  internal
+ virtual
  override
  DANGEROUS_freeMemory
  returns (bool)
@@ -219,13 +229,62 @@ contract ArbitrumSettlerMetaTxn is SettlerMetaTxn, ArbitrumMixin {
  // Solidity inheritance is stupid
  function _dispatch(uint256 i, bytes4 action, bytes calldata data)
  internal
+ virtual
  override(SettlerAbstract, SettlerBase, ArbitrumMixin)
  returns (bool)
  {
  return super._dispatch(i, action, data);
  }
 
- function _msgSender() internal view override(SettlerMetaTxn, AbstractContext) returns (address) {
+ function _msgSender() internal view virtual override(SettlerMetaTxn, AbstractContext) returns (address) {
+ return super._msgSender();
+ }
+}
+
+/// @custom:security-contact [email protected]
+contract ArbitrumSettlerIntent is SettlerIntent, ArbitrumSettlerMetaTxn {
+ constructor(bytes20 gitCommit) ArbitrumSettlerMetaTxn(gitCommit) {}
+
+ // Solidity inheritance is stupid
+ function _dispatch(uint256 i, bytes4 action, bytes calldata data)
+ internal
+ override(ArbitrumSettlerMetaTxn, SettlerBase, SettlerAbstract)
+ returns (bool)
+ {
+ return super._dispatch(i, action, data);
+ }
+
+ function _msgSender() internal view override(SettlerIntent, ArbitrumSettlerMetaTxn) returns (address) {
  return super._msgSender();
  }
+
+ function _witnessTypeSuffix()
+ internal
+ pure
+ override(SettlerIntent, Permit2PaymentMetaTxn)
+ returns (string memory)
+ {
+ return super._witnessTypeSuffix();
+ }
+
+ function _tokenId() internal pure override(SettlerIntent, SettlerMetaTxn, SettlerAbstract) returns (uint256) {
+ return super._tokenId();
+ }
+
+ function _dispatchVIP(bytes4 action, bytes calldata data, bytes calldata sig)
+ internal
+ override(ArbitrumSettlerMetaTxn, SettlerMetaTxn)
+ returns (bool)
+ {
+ return super._dispatchVIP(action, data, sig);
+ }
+
+ function _permitToSellAmount(ISignatureTransfer.PermitTransferFrom memory permit)
+ internal
+ view
+ override(SettlerIntent, Permit2Payment, Permit2PaymentAbstract)
+ returns (uint256)
+ {
+ return super._permitToSellAmount(permit);
+ }
 }