@rootzero/contracts 1.18.0 → 1.20.0

package/ports/Post.sol

@@ -10,10 +10,10 @@ import {Actions} from "../utils/Actions.sol";
 
 using Executions for Execution;
 
-/// @title PortPost
+/// @title PostPort
 /// @notice Port that posts peer-supplied TRANSACTION blocks through debit and credit hooks.
 /// Each TRANSACTION block calls `debitAccount` for `from` and `creditAccount` for `to`.
-abstract contract PortPost is PortBase, PostHook, Action {
+abstract contract PostPort is PortBase, PostHook, Action {
     uint private immutable descriptor;
 
     constructor() {

package/ports/Redeem.sol

@@ -16,11 +16,11 @@ abstract contract RedeemBalanceHook {
     function redeemBalance(uint peer, bytes32 asset, uint amount) internal virtual;
 }
 
-/// @title PortRedeemBalance
+/// @title RedeemBalancePort
 /// @notice Port that redeems balance state from a peer host into local assets.
 /// Each BALANCE block in the input calls `redeemBalance(peer, asset, amount)`.
 /// Restricted to trusted peers.
-abstract contract PortRedeemBalance is PortBase, RedeemBalanceHook {
+abstract contract RedeemBalancePort is PortBase, RedeemBalanceHook {
     uint private immutable descriptor;
 
     constructor() {

package/queries/Base.sol

@@ -5,7 +5,6 @@ import { InputEndpointBase } from "../core/Endpoint.sol";
 import { Descriptors } from "../codec/Descriptors.sol";
 import { Specs } from "../codec/Specs.sol";
 import { Nodes } from "../utils/Nodes.sol";
-import { Selectors } from "../utils/Selectors.sol";
 
 /// @title QueryBase
 /// @notice Abstract base for rootzero query contracts.
@@ -39,7 +38,7 @@ abstract contract QueryBase is InputEndpointBase {
         string memory name,
         uint descriptor
     ) internal returns (uint id, uint published) {
-        id = Nodes.toQuery(Selectors.query(name), address(this));
+        id = Nodes.toQuery(name, address(this));
         published = endpoint(id, name, descriptor);
     }
 }

package/utils/Cursors.sol

@@ -36,6 +36,11 @@ struct Cur {
 /// to marks. A zero mark identifies the empty cursor at position zero; `before`
 /// therefore treats it as already reached.
 ///
+/// Cursor navigation assumes packed cursor inputs satisfy `i <= len`.
+/// Constructors and composition helpers establish this invariant, and navigation
+/// helpers preserve it. Manually constructing or modifying packed cursor words
+/// may cause arithmetic panics instead of cursor-specific errors.
+///
 /// The zero word represents an absent cursor.
 library Cursors {
     /// @dev A cursor position exceeds its logical length.
@@ -214,11 +219,12 @@ library Cursors {
     }
 
     /// @notice Advance the current position of the lower cursor.
+    /// @dev Assumes `cur` satisfies the cursor invariant `i <= len`.
     /// @param cur Packed cursor or cursor pair.
     /// @param amount Number of bytes to advance.
     /// @return updated Cursor advanced by `amount`.
     function advance(uint cur, uint amount) internal pure returns (uint updated) {
-        uint i = uint32(validate(cur));
+        uint i = uint32(cur);
         uint len = uint32(cur >> 64);
         if (amount > len - i) revert OutOfBounds();
         updated = cur + amount;
@@ -236,14 +242,15 @@ library Cursors {
 
     /// @notice Create a child cursor over `[start, end)` within the lower cursor.
     /// @dev The child starts at position zero, has no recorded count, and uses the
-    /// supplied tag. Any higher cursor is omitted.
+    /// supplied tag. Any higher cursor is omitted. Assumes `cur` satisfies the
+    /// cursor invariant `i <= len`.
     /// @param cur Parent cursor or cursor pair.
     /// @param start Child start relative to the parent base.
     /// @param end Child exclusive end relative to the parent base.
     /// @param tag Child identity tag.
     /// @return child Packed child cursor.
     function slice(uint cur, uint start, uint end, uint8 tag) internal pure returns (uint child) {
-        (, uint offset, uint len) = decode(validate(cur));
+        (, uint offset, uint len) = decode(cur);
         if (start > end || end > len) revert OutOfBounds();
         child = create(offset + start, end - start, 0, 0, tag);
     }

package/utils/Nodes.sol

@@ -192,40 +192,45 @@ library Nodes {
         return toLocalBase(Host) | uint(uint160(target));
     }
 
-    /// @notice Build a chain-local command ID for the given selector and contract.
-    /// @param selector 4-byte ABI selector of the command entry point.
+    /// @notice Build a chain-local command ID for the given endpoint name and contract.
+    /// @param name Command function name.
     /// @param target Command contract address.
     /// @return node Command node ID embedding both the selector and address.
-    function toCommand(bytes4 selector, address target) internal view returns (uint node) {
+    function toCommand(string memory name, address target) internal view returns (uint node) {
         node = toLocalBase(Command) | uint(uint160(target));
-        node |= uint(uint32(selector)) << 160;
+        node |= uint(uint32(toSelector(name, "(bytes32,bytes,bytes)"))) << 160;
     }
 
-    /// @notice Build a chain-local port ID for the given selector and contract.
-    /// @param selector 4-byte ABI selector of the port entry point.
+    /// @notice Build a chain-local port ID for the given endpoint name and contract.
+    /// @param name Port function name.
     /// @param target Port contract address.
     /// @return node Port node ID embedding both the selector and address.
-    function toPort(bytes4 selector, address target) internal view returns (uint node) {
+    function toPort(string memory name, address target) internal view returns (uint node) {
         node = toLocalBase(Port) | uint(uint160(target));
-        node |= uint(uint32(selector)) << 160;
+        node |= uint(uint32(toSelector(name, "(bytes)"))) << 160;
     }
 
-    /// @notice Build a chain-local query ID for the given selector and contract.
-    /// @param selector 4-byte ABI selector of the query entry point.
+    /// @notice Build a chain-local query ID for the given endpoint name and contract.
+    /// @param name Query function name.
     /// @param target Query contract address.
     /// @return node Query node ID embedding both the selector and address.
-    function toQuery(bytes4 selector, address target) internal view returns (uint node) {
+    function toQuery(string memory name, address target) internal view returns (uint node) {
         node = toLocalBase(Query) | uint(uint160(target));
-        node |= uint(uint32(selector)) << 160;
+        node |= uint(uint32(toSelector(name, "(bytes)"))) << 160;
     }
 
-    /// @notice Build a chain-local guard action ID for the given selector and contract.
-    /// @param selector 4-byte ABI selector of the guard action entry point.
+    /// @notice Build a chain-local guard action ID for the given endpoint name and contract.
+    /// @param name Guard action function name.
     /// @param target Guard action contract address.
     /// @return node Guard action node ID embedding both the selector and address.
-    function toGuard(bytes4 selector, address target) internal view returns (uint node) {
+    function toGuard(string memory name, address target) internal view returns (uint node) {
         node = toLocalBase(Guard) | uint(uint160(target));
-        node |= uint(uint32(selector)) << 160;
+        node |= uint(uint32(toSelector(name, "(bytes)"))) << 160;
+    }
+
+    /// @dev Derive an ABI selector from an endpoint name and argument signature.
+    function toSelector(string memory name, string memory args) private pure returns (bytes4) {
+        return bytes4(keccak256(bytes(string.concat(name, args))));
     }
 
     /// @notice Derive an opaque node ID from a keccak preimage.

package/utils/Selectors.sol

@@ -1,49 +0,0 @@
-// SPDX-License-Identifier: GPL-3.0-only
-pragma solidity ^0.8.33;
-
-/// @title Selectors
-/// @notice Canonical ABI selector derivation for rootzero endpoint types.
-library Selectors {
-    /// @notice Derive the ABI selector for a command entrypoint.
-    /// @param name Command function name.
-    /// @return Selector for `name(bytes32,bytes,bytes)`.
-    function command(string memory name) internal pure returns (bytes4) {
-        return derive(name, "(bytes32,bytes,bytes)");
-    }
-
-    /// @notice Derive the ABI selector for a port entrypoint.
-    /// @param name Port function name.
-    /// @return Selector for `name(bytes)`.
-    function port(string memory name) internal pure returns (bytes4) {
-        return direct(name);
-    }
-
-    /// @notice Derive the ABI selector for a query entrypoint.
-    /// @param name Query function name.
-    /// @return Selector for `name(bytes)`.
-    function query(string memory name) internal pure returns (bytes4) {
-        return direct(name);
-    }
-
-    /// @notice Derive the ABI selector for a guard action entrypoint.
-    /// @param name Guard action function name.
-    /// @return Selector for `name(bytes)`.
-    function guard(string memory name) internal pure returns (bytes4) {
-        return direct(name);
-    }
-
-    /// @dev Derive a direct endpoint selector with a single `bytes` argument.
-    /// @param name Endpoint function name.
-    /// @return Selector for `name(bytes)`.
-    function direct(string memory name) private pure returns (bytes4) {
-        return derive(name, "(bytes)");
-    }
-
-    /// @dev Derive an ABI selector from a function name and argument signature suffix.
-    /// @param name Function name.
-    /// @param args Parenthesized ABI argument signature.
-    /// @return First four bytes of the function signature hash.
-    function derive(string memory name, string memory args) private pure returns (bytes4) {
-        return bytes4(keccak256(bytes(string.concat(name, args))));
-    }
-}