@rootzero/contracts 1.0.0 → 1.0.1

package/blocks/Cursors.sol

@@ -562,23 +562,23 @@ library Cursors {
         return createBlock(Keys.Pipe, bytes.concat(bytes32(value), toContextBlock(account, state, steps)));
     }
 
-    /// @notice Encode a RELAY block.
-    /// @param chain Destination chain node ID.
-    /// @param endowment Native value requested for the destination pipe.
-    /// @param steps Nested step block stream.
-    /// @return Encoded RELAY block bytes.
-    function toRelayBlock(uint chain, uint endowment, bytes memory steps) internal pure returns (bytes memory) {
-        return createBlock(Keys.Relay, bytes.concat(bytes32(chain), bytes32(endowment), toBytesBlock(steps)));
-    }
-
-    /// @notice Encode a DISPATCH block.
-    /// @param chain Destination chain node ID.
-    /// @param endowment Native value requested for the destination dispatch.
-    /// @param payload Encoded cross-chain payload.
-    /// @return Encoded DISPATCH block bytes.
-    function toDispatchBlock(uint chain, uint endowment, bytes memory payload) internal pure returns (bytes memory) {
-        return createBlock(Keys.Dispatch, bytes.concat(bytes32(chain), bytes32(endowment), toBytesBlock(payload)));
-    }
+    /// @notice Encode a RELAY block.
+    /// @param chain Destination chain node ID.
+    /// @param resources Chain-adapter-specific resources for the destination pipe.
+    /// @param steps Nested step block stream.
+    /// @return Encoded RELAY block bytes.
+    function toRelayBlock(uint chain, uint resources, bytes memory steps) internal pure returns (bytes memory) {
+        return createBlock(Keys.Relay, bytes.concat(bytes32(chain), bytes32(resources), toBytesBlock(steps)));
+    }
+
+    /// @notice Encode a DISPATCH block.
+    /// @param chain Destination chain node ID.
+    /// @param resources Chain-adapter-specific resources for the destination dispatch.
+    /// @param payload Encoded cross-chain payload.
+    /// @return Encoded DISPATCH block bytes.
+    function toDispatchBlock(uint chain, uint resources, bytes memory payload) internal pure returns (bytes memory) {
+        return createBlock(Keys.Dispatch, bytes.concat(bytes32(chain), bytes32(resources), toBytesBlock(payload)));
+    }
 
     // -------------------------------------------------------------------------
     // Raw calldata loaders
@@ -590,19 +590,31 @@ library Cursors {
     /// @param cur Cursor whose current position is advanced by `n` bytes.
     /// @param n Number of bytes to advance.
     /// @return value Loaded word.
-    function read(Cur memory cur, uint n) internal pure returns (bytes32 value) {
-        uint abs = cur.offset + cur.i;
-        assembly ("memory-safe") {
-            value := calldataload(abs)
-        }
-        cur.i += n;
-    }
-
-    /// @notice Read the next 16 bytes from the cursor and advance by 16 bytes.
-    /// @dev Performs no bounds, key, length, or cursor checks.
-    /// @param cur Cursor whose current position is advanced by 16 bytes.
-    /// @return value Loaded bytes16 value.
-    function read16(Cur memory cur) internal pure returns (bytes16 value) {
+    function read(Cur memory cur, uint n) internal pure returns (bytes32 value) {
+        uint abs = cur.offset + cur.i;
+        assembly ("memory-safe") {
+            value := calldataload(abs)
+        }
+        cur.i += n;
+    }
+
+    /// @notice Read the next 4 bytes from the cursor and advance by 4 bytes.
+    /// @dev Performs no bounds, key, length, or cursor checks.
+    /// @param cur Cursor whose current position is advanced by 4 bytes.
+    /// @return value Loaded bytes4 value.
+    function read4(Cur memory cur) internal pure returns (bytes4 value) {
+        uint abs = cur.offset + cur.i;
+        assembly ("memory-safe") {
+            value := calldataload(abs)
+        }
+        cur.i += 4;
+    }
+
+    /// @notice Read the next 16 bytes from the cursor and advance by 16 bytes.
+    /// @dev Performs no bounds, key, length, or cursor checks.
+    /// @param cur Cursor whose current position is advanced by 16 bytes.
+    /// @return value Loaded bytes16 value.
+    function read16(Cur memory cur) internal pure returns (bytes16 value) {
         uint abs = cur.offset + cur.i;
         assembly ("memory-safe") {
             value := calldataload(abs)
@@ -614,18 +626,30 @@ library Cursors {
     /// @dev Performs no bounds, key, length, or cursor checks.
     /// @param cur Cursor whose current position is advanced by 32 bytes.
     /// @return value Loaded word.
-    function read32(Cur memory cur) internal pure returns (bytes32 value) {
-        uint abs = cur.offset + cur.i;
-        assembly ("memory-safe") {
-            value := calldataload(abs)
-        }
-        cur.i += 32;
-    }
-
-    /// @notice Read the next two 32-byte words from the cursor and advance by 64 bytes.
-    /// @dev Performs no bounds, key, length, or cursor checks.
-    /// @param cur Cursor whose current position is advanced by 64 bytes.
-    /// @return a First loaded word.
+    function read32(Cur memory cur) internal pure returns (bytes32 value) {
+        uint abs = cur.offset + cur.i;
+        assembly ("memory-safe") {
+            value := calldataload(abs)
+        }
+        cur.i += 32;
+    }
+
+    /// @notice Read the next uint from the cursor and advance by one word.
+    /// @dev Performs no bounds, key, length, or cursor checks.
+    /// @param cur Cursor whose current position is advanced by 32 bytes.
+    /// @return value Loaded uint value.
+    function readUint(Cur memory cur) internal pure returns (uint value) {
+        uint abs = cur.offset + cur.i;
+        assembly ("memory-safe") {
+            value := calldataload(abs)
+        }
+        cur.i += 32;
+    }
+
+    /// @notice Read the next two 32-byte words from the cursor and advance by 64 bytes.
+    /// @dev Performs no bounds, key, length, or cursor checks.
+    /// @param cur Cursor whose current position is advanced by 64 bytes.
+    /// @return a First loaded word.
     /// @return b Second loaded word.
     function read64(Cur memory cur) internal pure returns (bytes32 a, bytes32 b) {
         uint abs = cur.offset + cur.i;
@@ -1110,35 +1134,35 @@ library Cursors {
         cur.exit(end);
     }
 
-    /// @notice Consume a RELAY block and return its destination chain, endowment, and step stream.
-    /// @param cur Cursor; advanced past the block.
-    /// @return chain Destination chain node ID.
-    /// @return endowment Native value requested for the destination pipe.
-    /// @return steps Embedded step block stream.
-    function unpackRelay(
-        Cur memory cur
-    ) internal pure returns (uint chain, uint endowment, bytes calldata steps) {
-        uint end = cur.enter(Keys.Relay, 64 + Sizes.Header, 0);
-        chain = uint(cur.read32());
-        endowment = uint(cur.read32());
-        steps = cur.unpackBytes();
-        cur.exit(end);
-    }
-
-    /// @notice Consume a DISPATCH block and return its destination chain, endowment, and payload.
-    /// @param cur Cursor; advanced past the block.
-    /// @return chain Destination chain node ID.
-    /// @return endowment Native value requested for the destination dispatch.
-    /// @return payload Encoded cross-chain payload.
-    function unpackDispatch(
-        Cur memory cur
-    ) internal pure returns (uint chain, uint endowment, bytes calldata payload) {
-        uint end = cur.enter(Keys.Dispatch, 64 + Sizes.Header, 0);
-        chain = uint(cur.read32());
-        endowment = uint(cur.read32());
-        payload = cur.unpackBytes();
-        cur.exit(end);
-    }
+    /// @notice Consume a RELAY block and return its destination chain, resources, and step stream.
+    /// @param cur Cursor; advanced past the block.
+    /// @return chain Destination chain node ID.
+    /// @return resources Chain-adapter-specific resources for the destination pipe.
+    /// @return steps Embedded step block stream.
+    function unpackRelay(
+        Cur memory cur
+    ) internal pure returns (uint chain, uint resources, bytes calldata steps) {
+        uint end = cur.enter(Keys.Relay, 64 + Sizes.Header, 0);
+        chain = cur.readUint();
+        resources = cur.readUint();
+        steps = cur.unpackBytes();
+        cur.exit(end);
+    }
+
+    /// @notice Consume a DISPATCH block and return its destination chain, resources, and payload.
+    /// @param cur Cursor; advanced past the block.
+    /// @return chain Destination chain node ID.
+    /// @return resources Chain-adapter-specific resources for the destination dispatch.
+    /// @return payload Encoded cross-chain payload.
+    function unpackDispatch(
+        Cur memory cur
+    ) internal pure returns (uint chain, uint resources, bytes calldata payload) {
+        uint end = cur.enter(Keys.Dispatch, 64 + Sizes.Header, 0);
+        chain = cur.readUint();
+        resources = cur.readUint();
+        payload = cur.unpackBytes();
+        cur.exit(end);
+    }
 
     // Type-specific validators
 

package/blocks/Keys.sol

@@ -39,10 +39,10 @@ library Keys {
     bytes4 constant Transaction = bytes4(keccak256("#transaction"));
     /// @dev Sub-command invocation - (uint target, uint value, #bytes as request)
     bytes4 constant Step = bytes4(keccak256("#step"));
-    /// @dev Cross-chain pipe relay - (uint chain, uint endowment, #bytes as steps)
-    bytes4 constant Relay = bytes4(keccak256("#relay"));
-    /// @dev Cross-chain encoded payload dispatch - (uint chain, uint endowment, #bytes as payload)
-    bytes4 constant Dispatch = bytes4(keccak256("#dispatch"));
+    /// @dev Cross-chain pipe relay - (uint chain, uint resources, #bytes as steps)
+    bytes4 constant Relay = bytes4(keccak256("#relay"));
+    /// @dev Cross-chain encoded payload dispatch - (uint chain, uint resources, #bytes as payload)
+    bytes4 constant Dispatch = bytes4(keccak256("#dispatch"));
     /// @dev Raw external call - (uint target, uint value, #bytes as payload)
     bytes4 constant Call = bytes4(keccak256("#call"));
     /// @dev Command context transport - (bytes32 account, #bytes as state, #bytes as request)

package/blocks/Schema.sol

@@ -65,8 +65,8 @@ library Schemas {
     string constant Pipe = "#pipe { uint value, #context { bytes32 account, #bytes as state, #bytes as steps } }";
     string constant Call = "#call { uint target, uint value, #bytes as payload }";
     string constant Step = "#step { uint target, uint value, #bytes as request }";
-    string constant Relay = "#relay { uint chain, uint endowment, #bytes as steps }";
-    string constant Dispatch = "#dispatch { uint chain, uint endowment, #bytes as payload }";
+    string constant Relay = "#relay { uint chain, uint resources, #bytes as steps }";
+    string constant Dispatch = "#dispatch { uint chain, uint resources, #bytes as payload }";
     string constant Bounty = "#bounty { uint amount, bytes32 relayer }";
     string constant Fee = "#fee { uint amount }";
     string constant Auth = "#auth { uint cid, uint deadline, #bytes as proof }";

package/commands/Relay.sol

@@ -8,24 +8,23 @@ import {Budget} from "../utils/Value.sol";
 
 using Cursors for Cur;
 
-abstract contract RelayPayableHook {
-    /// @notice Override to relay `steps` to `chain` with the current account and state.
-    /// @param chain Destination chain node ID.
-    /// @param endowment Native value requested for the destination pipe. The hook
-    /// decides how much source-chain budget must be spent to fund this value on
-    /// the destination chain.
-    /// @param account Command account identifier.
-    /// @param state Current command state block stream.
-    /// @param steps Embedded destination step block stream.
-    /// @param budget Source-chain native-value budget available for transport
-    /// fees and destination endowment funding.
-    function relay(
-        uint chain,
-        uint endowment,
-        bytes32 account,
-        bytes calldata state,
-        bytes calldata steps,
-        Budget memory budget
+abstract contract RelayPayableHook {
+    /// @notice Override to relay `steps` to `chain` with the current account and state.
+    /// @param chain Destination chain node ID.
+    /// @param resources Chain-adapter-specific destination resources. EVM adapters
+    /// may interpret this as packed execution gas and destination value.
+    /// @param account Command account identifier.
+    /// @param state Current command state block stream.
+    /// @param steps Embedded destination step block stream.
+    /// @param budget Source-chain native-value budget available for transport
+    /// fees and destination resource funding.
+    function relay(
+        uint chain,
+        uint resources,
+        bytes32 account,
+        bytes calldata state,
+        bytes calldata steps,
+        Budget memory budget
     ) internal virtual;
 }
 
@@ -47,12 +46,12 @@ abstract contract RelayPayable is CommandBase, Payable, RelayPayableHook {
     /// @param c Command context; `c.request` must contain exactly one RELAY block.
     /// @return output Empty output state.
     function relayPayable(CommandContext calldata c) external payable onlyCommand returns (bytes memory output) {
-        (Cur memory request, ) = Cursors.init(c.request, 0, 1, 1);
-        Budget memory budget = valueBudget();
-
-        (uint chain, uint endowment, bytes calldata steps) = request.unpackRelay();
-        relay(chain, endowment, c.account, c.state, steps, budget);
-        request.complete();
-        return "";
-    }
-}
+        (Cur memory request, ) = Cursors.init(c.request, 0, 1, 1);
+        Budget memory budget = valueBudget();
+
+        (uint chain, uint resources, bytes calldata steps) = request.unpackRelay();
+        relay(chain, resources, c.account, c.state, steps, budget);
+        request.complete();
+        return "";
+    }
+}

package/package.json

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

package/peer/Dispatch.sol

@@ -8,17 +8,16 @@ import { Budget } from "../utils/Value.sol";
 
 using Cursors for Cur;
 
-abstract contract PeerDispatchPayableHook {
-    /// @notice Override to dispatch an already encoded payload to `chain`.
-    /// @param chain Destination chain node ID.
-    /// @param endowment Native value requested for the destination dispatch. The
-    /// hook decides how much source-chain budget must be spent to fund this
-    /// value on the destination chain.
-    /// @param payload Encoded payload ready for the transport layer.
-    /// @param budget Source-chain native-value budget available for transport
-    /// fees and destination endowment funding.
-    function dispatch(uint chain, uint endowment, bytes calldata payload, Budget memory budget) internal virtual;
-}
+abstract contract PeerDispatchPayableHook {
+    /// @notice Override to dispatch an already encoded payload to `chain`.
+    /// @param chain Destination chain node ID.
+    /// @param resources Chain-adapter-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 budget Source-chain native-value budget available for transport
+    /// fees and destination resource funding.
+    function dispatch(uint chain, uint resources, bytes calldata payload, Budget memory budget) internal virtual;
+}
 
 /// @title PeerDispatchPayable
 /// @notice Peer endpoint that forwards DISPATCH blocks to a host-defined dispatch hook.
@@ -37,14 +36,14 @@ abstract contract PeerDispatchPayable is PeerBase, Payable, PeerDispatchPayableH
     /// @return output Empty response bytes.
     function peerDispatchPayable(bytes calldata request) external payable onlyPeer returns (bytes memory output) {
         (Cur memory input, , ) = Cursors.init(request, 0, 1);
-        Budget memory budget = valueBudget();
-
-        while (input.i < input.len) {
-            (uint chain, uint endowment, bytes calldata payload) = input.unpackDispatch();
-            dispatch(chain, endowment, payload, budget);
-        }
-
-        input.complete();
+        Budget memory budget = valueBudget();
+
+        while (input.i < input.len) {
+            (uint chain, uint resources, bytes calldata payload) = input.unpackDispatch();
+            dispatch(chain, resources, payload, budget);
+        }
+
+        input.complete();
         return "";
     }