@rootzero/contracts 0.5.1 → 0.6.0

package/commands/admin/Relocate.sol

@@ -1,34 +1,37 @@
 // SPDX-License-Identifier: GPL-3.0-only
 pragma solidity ^0.8.33;
 
-import { CommandBase, CommandContext, State } from "../Base.sol";
+import { CommandContext, CommandPayable, State } from "../Base.sol";
 import { Cursors, Cur, Schemas } from "../../Cursors.sol";
+import { Budget, Values } from "../../utils/Value.sol";
 using Cursors for Cur;
 
-string constant NAME = "relocate";
+string constant NAME = "relocatePayable";
 
-/// @title Relocate
+/// @title RelocatePayable
 /// @notice Admin command that forwards native value (ETH) to one or more destination hosts.
 /// Each FUNDING block in the request specifies a target host node ID and an amount to forward.
 /// Only callable by the admin account.
-abstract contract Relocate is CommandBase {
-    uint internal immutable relocateId = commandId(NAME);
+abstract contract RelocatePayable is CommandPayable {
+    uint internal immutable relocatePayableId = commandId(NAME);
 
     constructor() {
-        emit Command(host, NAME, Schemas.Funding, relocateId, State.Empty, State.Empty);
+        emit Command(host, NAME, Schemas.Funding, relocatePayableId, State.Empty, State.Empty, true);
     }
 
-    function relocate(
+    function relocatePayable(
         CommandContext calldata c
-    ) external payable onlyAdmin(c.account) onlyCommand(relocateId, c.target) returns (bytes memory) {
+    ) external payable onlyAdmin(c.account) onlyCommand(relocatePayableId, c.target) returns (bytes memory) {
         (Cur memory request, , ) = cursor(c.request, 1);
+        Budget memory budget = Values.fromMsg();
 
         while (request.i < request.bound) {
             (uint host, uint amount) = request.unpackFunding();
-            callTo(host, amount, "");
+            callTo(host, Values.use(budget, amount), "");
         }
 
         request.complete();
+        settleValue(c.account, budget);
         return "";
     }
 }
@@ -37,3 +40,4 @@ abstract contract Relocate is CommandBase {
 
 
 
+

package/commands/admin/Unauthorize.sol

@@ -15,12 +15,12 @@ abstract contract Unauthorize is CommandBase {
     uint internal immutable unauthorizeId = commandId(NAME);
 
     constructor() {
-        emit Command(host, NAME, Schemas.Node, unauthorizeId, State.Empty, State.Empty);
+        emit Command(host, NAME, Schemas.Node, unauthorizeId, State.Empty, State.Empty, false);
     }
 
     function unauthorize(
         CommandContext calldata c
-    ) external payable onlyAdmin(c.account) onlyCommand(unauthorizeId, c.target) returns (bytes memory) {
+    ) external onlyAdmin(c.account) onlyCommand(unauthorizeId, c.target) returns (bytes memory) {
         (Cur memory request, , ) = cursor(c.request, 1);
 
         while (request.i < request.bound) {
@@ -36,3 +36,4 @@ abstract contract Unauthorize is CommandBase {
 
 
 
+

package/core/Host.sol

@@ -4,7 +4,7 @@ pragma solidity ^0.8.33;
 import { AccessControl } from "./Access.sol";
 import { Authorize } from "../commands/admin/Authorize.sol";
 import { Unauthorize } from "../commands/admin/Unauthorize.sol";
-import { Relocate } from "../commands/admin/Relocate.sol";
+import { RelocatePayable } from "../commands/admin/Relocate.sol";
 import { HostAnnouncedEvent } from "../events/HostAnnounced.sol";
 import { IHostDiscovery } from "../interfaces/IHostDiscovery.sol";
 import { Ids } from "../utils/Ids.sol";
@@ -25,10 +25,10 @@ abstract contract HostDiscovery is HostAnnouncedEvent, IHostDiscovery {
 
 /// @title Host
 /// @notice Abstract base contract for rootzero host implementations.
-/// Inherits admin command support (authorize, unauthorize, relocate) and
+/// Inherits admin command support (authorize, unauthorize, relocatePayable) and
 /// optionally announces itself to a discovery contract at deployment.
 /// Accepts native ETH payments via the `receive` function.
-abstract contract Host is Authorize, Unauthorize, Relocate {
+abstract contract Host is Authorize, Unauthorize, RelocatePayable {
     /// @param cmdr Commander address; passed to `AccessControl`.
     ///        If `cmdr` is a deployed contract, the host calls `announceHost`
     ///        on it during construction to register with the discovery registry.

package/events/Command.sol

@@ -3,7 +3,8 @@ pragma solidity ^0.8.33;
 
 import { EventEmitter } from "./Emitter.sol";
 
-string constant ABI = "event Command(uint indexed host, string name, string schema, uint cid, uint8 stateIn, uint8 stateOut)";
+string constant ABI =
+    "event Command(uint indexed host, string name, string schema, uint cid, uint8 stateIn, uint8 stateOut, bool acceptsValue)";
 
 /// @notice Emitted once per command during host deployment to publish its schema and state types.
 abstract contract CommandEvent is EventEmitter {
@@ -13,12 +14,18 @@ abstract contract CommandEvent is EventEmitter {
     /// @param cid Command node ID.
     /// @param stateIn State type discriminant for the input state (see `State` library).
     /// @param stateOut State type discriminant for the output state.
-    event Command(uint indexed host, string name, string schema, uint cid, uint8 stateIn, uint8 stateOut);
+    /// @param acceptsValue Whether the command entrypoint accepts nonzero `msg.value`.
+    event Command(
+        uint indexed host,
+        string name,
+        string schema,
+        uint cid,
+        uint8 stateIn,
+        uint8 stateOut,
+        bool acceptsValue
+    );
 
     constructor() {
         emit EventAbi(ABI);
     }
 }
-
-
-

package/events/Peer.sol

@@ -3,7 +3,8 @@ pragma solidity ^0.8.33;
 
 import { EventEmitter } from "./Emitter.sol";
 
-string constant ABI = "event Peer(uint indexed host, string name, string schema, uint pid)";
+string constant ABI =
+    "event Peer(uint indexed host, string name, string schema, uint pid, bool acceptsValue)";
 
 /// @notice Emitted once per peer during host deployment to publish its schema.
 abstract contract PeerEvent is EventEmitter {
@@ -11,7 +12,8 @@ abstract contract PeerEvent is EventEmitter {
     /// @param name Human-readable peer name.
     /// @param schema Schema DSL string describing the peer request shape.
     /// @param pid Peer node ID.
-    event Peer(uint indexed host, string name, string schema, uint pid);
+    /// @param acceptsValue Whether the peer entrypoint accepts nonzero `msg.value`.
+    event Peer(uint indexed host, string name, string schema, uint pid, bool acceptsValue);
 
     constructor() {
         emit EventAbi(ABI);

package/package.json

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

package/peer/AllowAssets.sol

@@ -15,7 +15,7 @@ abstract contract PeerAllowAssets is PeerBase {
     uint internal immutable peerAllowAssetsId = peerId(NAME);
 
     constructor() {
-        emit Peer(host, NAME, Schemas.Asset, peerAllowAssetsId);
+        emit Peer(host, NAME, Schemas.Asset, peerAllowAssetsId, false);
     }
 
     /// @notice Override to permit a single (asset, meta) pair.
@@ -25,7 +25,7 @@ abstract contract PeerAllowAssets is PeerBase {
     function peerAllowAsset(bytes32 asset, bytes32 meta) internal virtual returns (bool);
 
     /// @notice Execute the allow-assets peer call.
-    function peerAllowAssets(bytes calldata request) external payable onlyPeer returns (bytes memory) {
+    function peerAllowAssets(bytes calldata request) external onlyPeer returns (bytes memory) {
         (Cur memory assets, , ) = cursor(request, 1);
 
         while (assets.i < assets.bound) {

package/peer/DenyAssets.sol

@@ -15,7 +15,7 @@ abstract contract PeerDenyAssets is PeerBase {
     uint internal immutable peerDenyAssetsId = peerId(NAME);
 
     constructor() {
-        emit Peer(host, NAME, Schemas.Asset, peerDenyAssetsId);
+        emit Peer(host, NAME, Schemas.Asset, peerDenyAssetsId, false);
     }
 
     /// @notice Override to block a single (asset, meta) pair.
@@ -25,7 +25,7 @@ abstract contract PeerDenyAssets is PeerBase {
     function peerDenyAsset(bytes32 asset, bytes32 meta) internal virtual returns (bool);
 
     /// @notice Execute the deny-assets peer call.
-    function peerDenyAssets(bytes calldata request) external payable onlyPeer returns (bytes memory) {
+    function peerDenyAssets(bytes calldata request) external onlyPeer returns (bytes memory) {
         (Cur memory assets, , ) = cursor(request, 1);
 
         while (assets.i < assets.bound) {

package/peer/Pull.sol

@@ -15,7 +15,7 @@ abstract contract PeerPull is PeerBase {
     uint internal immutable peerPullId = peerId(NAME);
 
     constructor(string memory input) {
-        emit Peer(host, NAME, input, peerPullId);
+        emit Peer(host, NAME, input, peerPullId, false);
     }
 
     /// @notice Override to process a single incoming block from the pull request.
@@ -23,7 +23,7 @@ abstract contract PeerPull is PeerBase {
     function peerPull(Cur memory input) internal virtual;
 
     /// @notice Execute the pull peer call.
-    function peerPull(bytes calldata request) external payable onlyPeer returns (bytes memory) {
+    function peerPull(bytes calldata request) external onlyPeer returns (bytes memory) {
         (Cur memory input, , ) = cursor(request, 1);
 
         while (input.i < input.bound) {

package/peer/Push.sol

@@ -15,7 +15,7 @@ abstract contract PeerPush is PeerBase {
     uint internal immutable peerPushId = peerId(NAME);
 
     constructor(string memory input) {
-        emit Peer(host, NAME, input, peerPushId);
+        emit Peer(host, NAME, input, peerPushId, false);
     }
 
     /// @notice Override to process a single incoming block from the push request.
@@ -23,7 +23,7 @@ abstract contract PeerPush is PeerBase {
     function peerPush(Cur memory input) internal virtual;
 
     /// @notice Execute the push peer call.
-    function peerPush(bytes calldata request) external payable onlyPeer returns (bytes memory) {
+    function peerPush(bytes calldata request) external onlyPeer returns (bytes memory) {
         (Cur memory input, , ) = cursor(request, 1);
 
         while (input.i < input.bound) {

package/peer/Settle.sol

@@ -16,11 +16,11 @@ abstract contract PeerSettle is PeerBase, TransferHook {
     uint internal immutable peerSettleId = peerId(NAME);
 
     constructor() {
-        emit Peer(host, NAME, Schemas.Transaction, peerSettleId);
+        emit Peer(host, NAME, Schemas.Transaction, peerSettleId, false);
     }
 
     /// @notice Execute the peer-settle call.
-    function peerSettle(bytes calldata request) external payable onlyPeer returns (bytes memory) {
+    function peerSettle(bytes calldata request) external onlyPeer returns (bytes memory) {
         (Cur memory state, , ) = cursor(request, 1);
 
         while (state.i < state.bound) {

package/utils/Utils.sol

@@ -116,6 +116,14 @@ function hash32(bytes32 value) pure returns (bytes32 hash) {
     }
 }
 
+/// @notice Build a retry ticket commitment for an account and state payload.
+/// @param account Account identifier associated with the retryable payload.
+/// @param state Serialized state bytes for the retryable payload.
+/// @return ticket Keccak256 hash of `account` and `state`.
+function retryTicket(bytes32 account, bytes calldata state) pure returns (bytes32 ticket) {
+    return keccak256(abi.encode(account, state));
+}
+
 /// @notice Build the chain-local base prefix for a 256-bit ID.
 /// Embeds the current `block.chainid` so IDs are not portable across chains.
 /// @param prefix Four-byte type tag (e.g. `Ids.Host`, `Ids.Command`).

package/utils/Value.sol

@@ -1,18 +1,18 @@
 // SPDX-License-Identifier: GPL-3.0-only
 pragma solidity ^0.8.33;
 
+/// @notice Mutable native-value budget drawn down as sub-calls consume ETH.
+struct Budget {
+    /// @dev Remaining unspent native value in wei.
+    uint remaining;
+}
+
 /// @title Values
 /// @notice Native-value (ETH) budget tracking for commands that accept `msg.value`.
 library Values {
     /// @dev Thrown when a call attempts to spend more native value than remains in the budget.
     error InsufficientValue();
 
-    /// @notice Mutable native-value budget drawn down as sub-calls consume ETH.
-    struct Budget {
-        /// @dev Remaining unspent native value in wei.
-        uint remaining;
-    }
-
     /// @notice Create a budget from the current call's `msg.value`.
     /// @return Budget initialised with the full `msg.value`.
     function fromMsg() internal view returns (Budget memory) {
@@ -29,4 +29,13 @@ library Values {
         budget.remaining -= amount;
         return amount;
     }
+
+    /// @notice Deduct all remaining native value from the budget and return it.
+    /// @param budget Mutable budget to drain.
+    /// @return Remaining native value before the budget was emptied.
+    function drain(Budget memory budget) internal pure returns (uint) {
+        uint amount = budget.remaining;
+        budget.remaining = 0;
+        return amount;
+    }
 }