@rootzero/contracts 1.19.0 → 1.21.0

package/guards/Base.sol

@@ -5,7 +5,6 @@ import {InputEndpointBase} from "../core/Endpoint.sol";
 import {GuardianAccess} from "../core/Access.sol";
 import {Specs} from "../codec/Specs.sol";
 import {Nodes} from "../utils/Nodes.sol";
-import {Selectors} from "../utils/Selectors.sol";
 
 /// @title GuardBase
 /// @notice Abstract base for guardian-only direct host actions.
@@ -27,7 +26,7 @@ abstract contract GuardBase is GuardianAccess, InputEndpointBase {
         string memory name,
         uint input
     ) internal returns (uint id, uint descriptor) {
-        id = Nodes.toGuard(Selectors.guard(name), address(this));
+        id = Nodes.toGuard(name, address(this));
         descriptor = endpoint(id, name, Specs.Empty, input, Specs.Empty, 0, 0);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rootzero/contracts",
-  "version": "1.19.0",
+  "version": "1.21.0",
   "description": "Solidity contracts and protocol building blocks for rootzero hosts and commands.",
   "private": false,
   "license": "GPL-3.0-only",

package/ports/AllowAssets.sol

@@ -15,7 +15,7 @@ abstract contract AllowAssetsPort is PortBase, AllowAssetsHook {
     uint private immutable descriptor;
 
     constructor() {
-        (, descriptor) = port("portAllowAssets", Specs.Asset, Specs.Empty, false);
+        (, descriptor) = port("portAllowAssets", Specs.Asset, Specs.Empty, 0);
     }
 
     /// @notice Execute the allow-assets peer call.

package/ports/Allowance.sol

@@ -16,7 +16,7 @@ abstract contract AllowancePort is PortBase, AllowanceHook {
     uint private immutable descriptor;
 
     constructor() {
-        (, descriptor) = port("portAllowance", Specs.Amount, Specs.Empty, false);
+        (, descriptor) = port("portAllowance", Specs.Amount, Specs.Empty, 0);
     }
 
     /// @notice Execute the allowance port call.

package/ports/Base.sol

@@ -6,7 +6,6 @@ import { NodeAccess } from "../core/Access.sol";
 import { Specs } from "../codec/Specs.sol";
 import { InputEndpointBase } from "../core/Endpoint.sol";
 import { Nodes } from "../utils/Nodes.sol";
-import { Selectors } from "../utils/Selectors.sol";
 import { Descriptors } from "../codec/Descriptors.sol";
 
 /// @title PortBase
@@ -33,16 +32,16 @@ abstract contract PortBase is NodeCalls, NodeAccess, InputEndpointBase {
     /// match the Solidity port function name used by the canonical ABI.
     /// @param input Input block specification.
     /// @param output Output block specification.
-    /// @param funded Whether the port accepts nonzero native value.
+    /// @param flags Packed port behavior flags.
     /// @return id Port node ID.
     /// @return descriptor Packed endpoint lane metadata and flags.
     function port(
         string memory name,
         uint input,
         uint output,
-        bool funded
+        uint8 flags
     ) internal returns (uint id, uint descriptor) {
-        descriptor = Descriptors.create(Specs.Empty, input, output, 0, funded ? Descriptors.Funded : 0);
+        descriptor = Descriptors.create(Specs.Empty, input, output, 0, flags);
         return port(name, descriptor);
     }
 
@@ -56,7 +55,7 @@ abstract contract PortBase is NodeCalls, NodeAccess, InputEndpointBase {
         string memory name,
         uint descriptor
     ) internal returns (uint id, uint published) {
-        id = Nodes.toPort(Selectors.port(name), address(this));
+        id = Nodes.toPort(name, address(this));
         published = endpoint(id, name, descriptor);
     }
 }

package/ports/Credit.sol

@@ -15,7 +15,7 @@ abstract contract CreditAccountPort is PortBase, CreditAccountHook {
     uint private immutable descriptor;
 
     constructor() {
-        (, descriptor) = port("portCreditAccount", Specs.AccountAmount, Specs.Empty, false);
+        (, descriptor) = port("portCreditAccount", Specs.AccountAmount, Specs.Empty, 0);
     }
 
     /// @notice Execute the port-credit call.

package/ports/Debit.sol

@@ -15,7 +15,7 @@ abstract contract DebitAccountPort is PortBase, DebitAccountHook {
     uint private immutable descriptor;
 
     constructor() {
-        (, descriptor) = port("portDebitAccount", Specs.AccountAmount, Specs.Empty, false);
+        (, descriptor) = port("portDebitAccount", Specs.AccountAmount, Specs.Empty, 0);
     }
 
     /// @notice Execute the port-debit call.

package/ports/DenyAssets.sol

@@ -15,7 +15,7 @@ abstract contract DenyAssetsPort is PortBase, DenyAssetsHook {
     uint private immutable descriptor;
 
     constructor() {
-        (, descriptor) = port("portDenyAssets", Specs.Asset, Specs.Empty, false);
+        (, descriptor) = port("portDenyAssets", Specs.Asset, Specs.Empty, 0);
     }
 
     /// @notice Execute the deny-assets peer call.

package/ports/Dispatch.sol

@@ -2,23 +2,35 @@
 pragma solidity ^0.8.33;
 
 import {PortBase} from "./Base.sol";
-import {RelayPayableHook} from "../commands/Relay.sol";
+import {Flags} from "../codec/Descriptors.sol";
 import {Specs} from "../Codec.sol";
 import {Execution, Executions, Lanes} from "../execution/Execution.sol";
 
 using Executions for Execution;
 
+/// @notice Hook implemented by hosts that forward funded dispatch payloads.
+abstract contract DispatchPayableHook {
+    /// @notice Override to dispatch an encoded payload to `portal`.
+    /// @param portal Destination portal identifier, often the destination host ID.
+    /// @param resources Chain-specific destination resources. EVM adapters
+    /// may interpret this as packed execution gas and destination value.
+    /// @param payload Encoded payload ready for the transport layer.
+    /// @param funds Execution used for source value available for transport fees
+    /// and destination resource funding.
+    function dispatchTo(uint portal, uint resources, bytes memory payload, Execution memory funds) internal virtual;
+}
+
 /// @title DispatchPayablePort
-/// @notice Port endpoint that forwards DISPATCH blocks to a host-defined relay hook.
-abstract contract DispatchPayablePort is PortBase, RelayPayableHook {
+/// @notice Port endpoint that forwards DISPATCH blocks to a host-defined dispatch hook.
+abstract contract DispatchPayablePort is PortBase, DispatchPayableHook {
     uint private immutable descriptor;
 
     constructor() {
-        (, descriptor) = port("portDispatchPayable", Specs.Dispatch, Specs.Empty, true);
+        (, descriptor) = port("portDispatchPayable", Specs.Dispatch, Specs.Empty, Flags.Funded);
     }
 
-    /// @notice Forward peer-supplied dispatches to the host-defined relay hook.
-    /// @dev Relay hooks receive the shared top-level source value
+    /// @notice Forward peer-supplied dispatches to the host-defined dispatch hook.
+    /// @dev Dispatch hooks receive the shared top-level source value
     ///      budget. Any `msg.value` not spent by the hook remains on this host.
     /// @param data DISPATCH block stream supplied by the trusted peer.
     /// @return Empty response bytes.
@@ -27,7 +39,7 @@ abstract contract DispatchPayablePort is PortBase, RelayPayableHook {
 
         while (exec.more()) {
             (uint portal, uint resources, bytes calldata payload) = exec.unpackDispatch(Lanes.Input);
-            relayTo(portal, resources, payload, exec);
+            dispatchTo(portal, resources, payload, exec);
         }
         
         return "";

package/ports/Pipe.sol

@@ -2,6 +2,7 @@
 pragma solidity ^0.8.33;
 
 import {PortBase} from "./Base.sol";
+import {Flags} from "../codec/Descriptors.sol";
 import {Pipeline} from "../core/Pipeline.sol";
 import {Specs} from "../Codec.sol";
 import {Execution, Executions, Lanes} from "../execution/Execution.sol";
@@ -16,7 +17,7 @@ abstract contract PipePayablePort is PortBase, Pipeline {
     uint private immutable descriptor;
 
     constructor() {
-        (, descriptor) = port("portPipePayable", Specs.Context, Specs.Empty, true);
+        (, descriptor) = port("portPipePayable", Specs.Context, Specs.Empty, Flags.Funded);
     }
 
     /// @notice Execute peer-supplied contexts through the shared payable pipe.

package/ports/Post.sol

@@ -18,7 +18,7 @@ abstract contract PostPort is PortBase, PostHook, Action {
 
     constructor() {
         uint id;
-        (id, descriptor) = port("portPost", Specs.Transaction, Specs.Empty, false);
+        (id, descriptor) = port("portPost", Specs.Transaction, Specs.Empty, 0);
         action(id, Actions.Post);
     }
 

package/ports/Redeem.sol

@@ -24,7 +24,7 @@ abstract contract RedeemBalancePort is PortBase, RedeemBalanceHook {
     uint private immutable descriptor;
 
     constructor() {
-        (, descriptor) = port("portRedeemBalance", Specs.Balance, Specs.Empty, false);
+        (, descriptor) = port("portRedeemBalance", Specs.Balance, Specs.Empty, 0);
     }
 
     /// @notice Execute the balance redemption port call.

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/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/events/Recovered.sol

@@ -1,17 +0,0 @@
-// SPDX-License-Identifier: GPL-3.0-only
-pragma solidity ^0.8.33;
-
-import {EventEmitter} from "./Emitter.sol";
-
-/// @notice Emitted when a host recovers a previously recorded key.
-abstract contract RecoveredEvent is EventEmitter {
-    string private constant ABI = "event Recovered(uint indexed host, bytes32 key)";
-
-    /// @param host Host node ID that owns the recovered key.
-    /// @param key Recovery lookup key.
-    event Recovered(uint indexed host, bytes32 key);
-
-    constructor() {
-        emit EventAbi(ABI);
-    }
-}

package/events/Undelivered.sol

@@ -1,18 +0,0 @@
-// SPDX-License-Identifier: GPL-3.0-only
-pragma solidity ^0.8.33;
-
-import {EventEmitter} from "./Emitter.sol";
-
-/// @notice Emitted when a host records an undelivered portal message.
-abstract contract UndeliveredEvent is EventEmitter {
-    string private constant ABI = "event Undelivered(uint indexed host, bytes32 key, bytes32 digest)";
-
-    /// @param host Host node ID that owns the undelivered message.
-    /// @param key Delivery lookup key.
-    /// @param digest Digest of the undelivered message.
-    event Undelivered(uint indexed host, bytes32 key, bytes32 digest);
-
-    constructor() {
-        emit EventAbi(ABI);
-    }
-}

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))));
-    }
-}