Update protocol and contract names (#71)

* Update protocol and contract names

* missed tiniest ones

---------

Co-authored-by: Amie Corso <amie.corso@coinbase.com>

Author: ilikesymmetry

.gas-snapshot

@@ -1,8 +1,8 @@
-# Payment Escrow Protocol
+# Commerce Payments Protocol
 
 ## Overview
 
-The Payment Escrow Protocol is a modular smart contract system designed to facilitate secure commerce payment flows onchain. In traditional payment systems, merchants rely on payment processors to handle the complex flow of funds between buyers and sellers. The Payment Escrow Protocol brings these familiar payment patterns onchain through a secure escrow-based system.
+The Commerce Payments Protocol facilitates onchain payments. Specifically designed for authorization and capture patterns, payments are initially collected into an escrow contract to guarantee payment for merchants at a later time. Operators drive token movement through the protocol and can customize their operations with modular smart contracts. No top-level controls exist on the protocol, keeping it permissionless, immutable, inviting of any operators.
 
 The protocol's core functionality revolves around two key concepts:
 
@@ -42,7 +42,7 @@ This model allows commerce platforms to maintain their business logic and paymen
 
 The protocol consists of two main components:
 
-1. **`PaymentEscrow` Contract**: Core contract managing the escrow of funds and payment lifecycle
+1. **`AuthCaptureEscrow` Contract**: Core contract managing the escrow of funds and payment lifecycle
 2. **Token Collectors**: Modular contracts handling different methods of token collection
 
 ### Token Collectors
@@ -67,7 +67,7 @@ This modular collector system allows the protocol to support various token autho
 
 ## Protocol Invariants
 
-The Payment Escrow Protocol maintains several critical invariants that ensure secure payment flows:
+The Commerce Payments Protocol maintains several critical invariants that ensure secure payment flows:
 
 ### Payment Flow Sequencing
 - Authorization can only be performed before the expiration of the payer's pre-approval

README.md

@@ -4,11 +4,11 @@ pragma solidity ^0.8.28;
 import {Script} from "forge-std/Script.sol";
 import {console2} from "forge-std/console2.sol";
 
-import {PaymentEscrow} from "../src/PaymentEscrow.sol";
+import {AuthCaptureEscrow} from "../src/AuthCaptureEscrow.sol";
 import {ERC3009PaymentCollector} from "../src/collectors/ERC3009PaymentCollector.sol";
 
 /**
- * @notice Deploy the PaymentEscrow contract.
+ * @notice Deploy the AuthCaptureEscrow contract.
  *
  * forge script Deploy --account dev --sender $SENDER --rpc-url $BASE_SEPOLIA_RPC --broadcast -vvvv
  * --verify --verifier-url $SEPOLIA_BASESCAN_API --etherscan-api-key $BASESCAN_API_KEY
@@ -24,15 +24,15 @@ contract Deploy is Script {
     function run() public {
         vm.startBroadcast();
 
-        // Deploy PaymentEscrow with known dependencies
-        PaymentEscrow paymentEscrow = new PaymentEscrow();
-        ERC3009PaymentCollector erc3009Collector = new ERC3009PaymentCollector(address(paymentEscrow), MULTICALL3);
+        // Deploy AuthCaptureEscrow with known dependencies
+        AuthCaptureEscrow authCaptureEscrow = new AuthCaptureEscrow();
+        ERC3009PaymentCollector erc3009Collector = new ERC3009PaymentCollector(address(authCaptureEscrow), MULTICALL3);
 
         vm.stopBroadcast();
 
         // Log deployed addresses
         console2.log("Deployed addresses:");
-        console2.log("PaymentEscrow:", address(paymentEscrow));
+        console2.log("AuthCaptureEscrow:", address(authCaptureEscrow));
         console2.log("ERC3009PaymentCollector:", address(erc3009Collector));
 
         // Log known addresses used

script/Deploy.s.sol

@@ -9,14 +9,14 @@ import {LibClone} from "solady/utils/LibClone.sol";
 import {TokenStore} from "./TokenStore.sol";
 import {TokenCollector} from "./collectors/TokenCollector.sol";
 
-/// @title PaymentEscrow
+/// @title AuthCaptureEscrow
 /// @notice Facilitate payments through an escrow.
 /// @dev By escrowing payment, this contract can mimic the 2-step payment pattern of "authorization" and "capture".
 /// @dev Authorization is defined as placing a hold on a payer's funds temporarily.
 /// @dev Capture is defined as distributing payment to the end recipient.
 /// @dev A trusted Operator plays the primary role of moving payments between both parties.
 /// @author Coinbase
-contract PaymentEscrow is ReentrancyGuardTransient {
+contract AuthCaptureEscrow is ReentrancyGuardTransient {
     using SafeERC20 for IERC20;
 
     /// @notice Payment info, contains all information required to authorize and capture a unique payment

src/PaymentEscrow.sol src/AuthCaptureEscrow.solsrc/PaymentEscrow.sol renamed to src/AuthCaptureEscrow.sol

@@ -5,19 +5,19 @@ import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeE
 
 /// @title TokenStore
 /// @notice Holds funds for a single operator's payments
-/// @dev Deployed on demand by PaymentEscrow via CREATE2 clones
+/// @dev Deployed on demand by AuthCaptureEscrow via CREATE2 clones
 /// @author Coinbase
 contract TokenStore {
-    /// @notice PaymentEscrow singleton that created this token store
-    address public immutable paymentEscrow;
+    /// @notice AuthCaptureEscrow singleton that created this token store
+    address public immutable authCaptureEscrow;
 
-    /// @notice Call sender is not PaymentEscrow
-    error OnlyPaymentEscrow();
+    /// @notice Call sender is not AuthCaptureEscrow
+    error OnlyAuthCaptureEscrow();
 
     /// @notice Constructor
-    /// @param paymentEscrow_ PaymentEscrow singleton that created this token store
-    constructor(address paymentEscrow_) {
-        paymentEscrow = paymentEscrow_;
+    /// @param authCaptureEscrow_ AuthCaptureEscrow singleton that created this token store
+    constructor(address authCaptureEscrow_) {
+        authCaptureEscrow = authCaptureEscrow_;
     }
 
     /// @notice Send tokens to a recipient, called by escrow during capture/refund
@@ -26,7 +26,7 @@ contract TokenStore {
     /// @param amount Amount of tokens to receive
     /// @return success True if the transfer was successful
     function sendTokens(address token, address recipient, uint256 amount) external returns (bool) {
-        if (msg.sender != paymentEscrow) revert OnlyPaymentEscrow();
+        if (msg.sender != authCaptureEscrow) revert OnlyAuthCaptureEscrow();
         SafeERC20.safeTransfer(IERC20(token), recipient, amount);
         return true;
     }

src/TokenStore.sol

@@ -5,7 +5,7 @@ import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
 import {IERC3009} from "../interfaces/IERC3009.sol";
-import {PaymentEscrow} from "../PaymentEscrow.sol";
+import {AuthCaptureEscrow} from "../AuthCaptureEscrow.sol";
 import {TokenCollector} from "./TokenCollector.sol";
 import {ERC6492SignatureHandler} from "./ERC6492SignatureHandler.sol";
 
@@ -17,16 +17,16 @@ contract ERC3009PaymentCollector is TokenCollector, ERC6492SignatureHandler {
     TokenCollector.CollectorType public constant override collectorType = TokenCollector.CollectorType.Payment;
 
     /// @notice Constructor
-    /// @param paymentEscrow_ PaymentEscrow singleton that calls to collect tokens
+    /// @param authCaptureEscrow_ AuthCaptureEscrow singleton that calls to collect tokens
     /// @param multicall3_ Public Multicall3 singleton for safe ERC-6492 external calls
-    constructor(address paymentEscrow_, address multicall3_)
-        TokenCollector(paymentEscrow_)
+    constructor(address authCaptureEscrow_, address multicall3_)
+        TokenCollector(authCaptureEscrow_)
         ERC6492SignatureHandler(multicall3_)
     {}
 
     /// @inheritdoc TokenCollector
     function _collectTokens(
-        PaymentEscrow.PaymentInfo calldata paymentInfo,
+        AuthCaptureEscrow.PaymentInfo calldata paymentInfo,
         address tokenStore,
         uint256 amount,
         bytes calldata collectorData

src/collectors/ERC3009PaymentCollector.sol

@@ -5,7 +5,7 @@ import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
 import {TokenCollector} from "./TokenCollector.sol";
-import {PaymentEscrow} from "../PaymentEscrow.sol";
+import {AuthCaptureEscrow} from "../AuthCaptureEscrow.sol";
 
 /// @title OperatorRefundCollector
 /// @notice Collect refunds using ERC-20 allowances from operators
@@ -15,14 +15,14 @@ contract OperatorRefundCollector is TokenCollector {
     TokenCollector.CollectorType public constant override collectorType = TokenCollector.CollectorType.Refund;
 
     /// @notice Constructor
-    /// @param paymentEscrow_ PaymentEscrow singleton that calls to collect tokens
-    constructor(address paymentEscrow_) TokenCollector(paymentEscrow_) {}
+    /// @param authCaptureEscrow_ AuthCaptureEscrow singleton that calls to collect tokens
+    constructor(address authCaptureEscrow_) TokenCollector(authCaptureEscrow_) {}
 
     /// @inheritdoc TokenCollector
     /// @dev Transfers from operator directly to token store, requiring previous ERC-20 allowance set by operator on this token collector
     /// @dev Only operator can initate token collection so authentication is inherited from Escrow
     function _collectTokens(
-        PaymentEscrow.PaymentInfo calldata paymentInfo,
+        AuthCaptureEscrow.PaymentInfo calldata paymentInfo,
         address tokenStore,
         uint256 amount,
         bytes calldata

src/collectors/OperatorRefundCollector.sol

@@ -5,7 +5,7 @@ import {ISignatureTransfer} from "permit2/interfaces/ISignatureTransfer.sol";
 
 import {TokenCollector} from "./TokenCollector.sol";
 import {ERC6492SignatureHandler} from "./ERC6492SignatureHandler.sol";
-import {PaymentEscrow} from "../PaymentEscrow.sol";
+import {AuthCaptureEscrow} from "../AuthCaptureEscrow.sol";
 
 /// @title Permit2PaymentCollector
 /// @notice Collect payments using Permit2 signatures
@@ -18,11 +18,11 @@ contract Permit2PaymentCollector is TokenCollector, ERC6492SignatureHandler {
     ISignatureTransfer public immutable permit2;
 
     /// @notice Constructor
-    /// @param paymentEscrow_ PaymentEscrow singleton that calls to collect tokens
+    /// @param authCaptureEscrow_ AuthCaptureEscrow singleton that calls to collect tokens
     /// @param permit2_ Permit2 singleton
     /// @param multicall3_ Public Multicall3 singleton for safe ERC-6492 external calls
-    constructor(address paymentEscrow_, address permit2_, address multicall3_)
-        TokenCollector(paymentEscrow_)
+    constructor(address authCaptureEscrow_, address permit2_, address multicall3_)
+        TokenCollector(authCaptureEscrow_)
         ERC6492SignatureHandler(multicall3_)
     {
         permit2 = ISignatureTransfer(permit2_);
@@ -31,7 +31,7 @@ contract Permit2PaymentCollector is TokenCollector, ERC6492SignatureHandler {
     /// @inheritdoc TokenCollector
     /// @dev Use Permit2 signature transfer to collect any ERC-20 from payers
     function _collectTokens(
-        PaymentEscrow.PaymentInfo calldata paymentInfo,
+        AuthCaptureEscrow.PaymentInfo calldata paymentInfo,
         address tokenStore,
         uint256 amount,
         bytes calldata collectorData

src/collectors/Permit2PaymentCollector.sol

@@ -5,7 +5,7 @@ import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
 import {TokenCollector} from "./TokenCollector.sol";
-import {PaymentEscrow} from "../PaymentEscrow.sol";
+import {AuthCaptureEscrow} from "../AuthCaptureEscrow.sol";
 
 /// @title PreApprovalPaymentCollector
 /// @notice Collect payments using pre-approval calls and ERC-20 allowances
@@ -30,27 +30,27 @@ contract PreApprovalPaymentCollector is TokenCollector {
     mapping(bytes32 paymentInfoHash => bool approved) public isPreApproved;
 
     /// @notice Constructor
-    /// @param paymentEscrow_ PaymentEscrow singleton that calls to collect tokens
-    constructor(address paymentEscrow_) TokenCollector(paymentEscrow_) {}
+    /// @param authCaptureEscrow_ AuthCaptureEscrow singleton that calls to collect tokens
+    constructor(address authCaptureEscrow_) TokenCollector(authCaptureEscrow_) {}
 
     /// @notice Registers buyer's token approval for a specific payment
     /// @dev Must be called by the buyer specified in the payment info
     /// @param paymentInfo PaymentInfo struct
-    function preApprove(PaymentEscrow.PaymentInfo calldata paymentInfo) external {
+    function preApprove(AuthCaptureEscrow.PaymentInfo calldata paymentInfo) external {
         // Check sender is buyer
-        if (msg.sender != paymentInfo.payer) revert PaymentEscrow.InvalidSender(msg.sender, paymentInfo.payer);
+        if (msg.sender != paymentInfo.payer) revert AuthCaptureEscrow.InvalidSender(msg.sender, paymentInfo.payer);
 
         // Check pre-approval expiry has not passed
         if (block.timestamp >= paymentInfo.preApprovalExpiry) {
-            revert PaymentEscrow.AfterPreApprovalExpiry(uint48(block.timestamp), paymentInfo.preApprovalExpiry);
+            revert AuthCaptureEscrow.AfterPreApprovalExpiry(uint48(block.timestamp), paymentInfo.preApprovalExpiry);
         }
 
         // Check has not already pre-approved
-        bytes32 paymentInfoHash = paymentEscrow.getHash(paymentInfo);
+        bytes32 paymentInfoHash = authCaptureEscrow.getHash(paymentInfo);
         if (isPreApproved[paymentInfoHash]) revert PaymentAlreadyPreApproved(paymentInfoHash);
 
         // Check has not already collected
-        (bool hasCollectedPayment,,) = paymentEscrow.paymentState(paymentInfoHash);
+        (bool hasCollectedPayment,,) = authCaptureEscrow.paymentState(paymentInfoHash);
         if (hasCollectedPayment) revert PaymentAlreadyCollected(paymentInfoHash);
 
         // Set payment as pre-approved
@@ -61,14 +61,14 @@ contract PreApprovalPaymentCollector is TokenCollector {
     /// @inheritdoc TokenCollector
     /// @dev Requires pre-approval for a specific payment and an ERC-20 allowance to this collector
     function _collectTokens(
-        PaymentEscrow.PaymentInfo calldata paymentInfo,
+        AuthCaptureEscrow.PaymentInfo calldata paymentInfo,
         address tokenStore,
         uint256 amount,
         bytes calldata
     ) internal override {
         // Check payment pre-approved
-        bytes32 paymentInfoHash = paymentEscrow.getHash(paymentInfo);
-        // Skip resetting pre-approval to save gas as the `PaymentEscrow` enforces unique, single-lifecycle payments
+        bytes32 paymentInfoHash = authCaptureEscrow.getHash(paymentInfo);
+        // Skip resetting pre-approval to save gas as the `AuthCaptureEscrow` enforces unique, single-lifecycle payments
         if (!isPreApproved[paymentInfoHash]) revert PaymentNotPreApproved(paymentInfoHash);
         // Transfer tokens from payer directly to token store
         SafeERC20.safeTransferFrom(IERC20(paymentInfo.token), paymentInfo.payer, tokenStore, amount);

src/collectors/PreApprovalPaymentCollector.sol

@@ -7,7 +7,7 @@ import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
 import {TokenCollector} from "./TokenCollector.sol";
-import {PaymentEscrow} from "../PaymentEscrow.sol";
+import {AuthCaptureEscrow} from "../AuthCaptureEscrow.sol";
 
 /// @title SpendPermissionPaymentCollector
 /// @notice Collect payments using Spend Permissions
@@ -23,16 +23,16 @@ contract SpendPermissionPaymentCollector is TokenCollector {
     error SpendPermissionApprovalFailed();
 
     /// @notice Constructor
-    /// @param paymentEscrow_ PaymentEscrow singleton that calls to collect tokens
+    /// @param authCaptureEscrow_ AuthCaptureEscrow singleton that calls to collect tokens
     /// @param spendPermissionManager_ SpendPermissionManager singleton
-    constructor(address paymentEscrow_, address spendPermissionManager_) TokenCollector(paymentEscrow_) {
+    constructor(address authCaptureEscrow_, address spendPermissionManager_) TokenCollector(authCaptureEscrow_) {
         spendPermissionManager = SpendPermissionManager(payable(spendPermissionManager_));
     }
 
     /// @inheritdoc TokenCollector
     /// @dev Supports Spend Permission approval signatures and MagicSpend WithdrawRequests (both optional)
     function _collectTokens(
-        PaymentEscrow.PaymentInfo calldata paymentInfo,
+        AuthCaptureEscrow.PaymentInfo calldata paymentInfo,
         address tokenStore,
         uint256 amount,
         bytes calldata collectorData