@rootzero/contracts 1.25.0 → 1.27.0

package/guards/Base.sol

@@ -27,6 +27,6 @@ abstract contract GuardBase is GuardianAccess, InputEndpointBase {
         uint input
     ) internal returns (uint id, uint descriptor) {
         id = Nodes.toGuard(name, address(this));
-        descriptor = endpoint(id, name, Specs.Empty, input, Specs.Empty, 0, 0);
+        descriptor = endpoint(id, name, Specs.Empty, input, Specs.Empty, 0);
     }
 }

package/guards/Revoke.sol

@@ -5,7 +5,7 @@ import {AllowanceHook} from "../commands/admin/Allowance.sol";
 import {DenyAssetsHook} from "../commands/admin/DenyAssets.sol";
 import {GuardBase} from "./Base.sol";
 import {Specs} from "../Codec.sol";
-import {Execution, Executions, Lanes} from "../execution/Execution.sol";
+import {Execution, Executions} from "../execution/Execution.sol";
 using Executions for Execution;
 
 /// @title Revoke
@@ -21,10 +21,10 @@ abstract contract Revoke is GuardBase {
 
     /// @notice Revoke every NODE block in `input` as the active guardian.
     function revoke(bytes calldata input) external onlyGuardian {
-        Execution memory exec = openInput(input, descriptor, 0);
+        Execution memory exec = openInput(input, descriptor);
 
         while (exec.more()) {
-            uint node = exec.unpackNode(Lanes.Input);
+            uint node = exec.unpackNode();
             setNode(node, false);
         }
     }
@@ -42,10 +42,10 @@ abstract contract RevokeAllowance is GuardBase, AllowanceHook {
 
     /// @notice Revoke every HOST_ASSET allowance in `input` as the active guardian.
     function revokeAllowance(bytes calldata input) external onlyGuardian {
-        Execution memory exec = openInput(input, descriptor, 0);
+        Execution memory exec = openInput(input, descriptor);
 
         while (exec.more()) {
-            (uint peer, bytes32 asset) = exec.unpackHostAsset(Lanes.Input);
+            (uint peer, bytes32 asset) = exec.unpackHostAsset();
             allowance(peer, asset, 0);
         }
     }
@@ -63,10 +63,10 @@ abstract contract RevokeAsset is GuardBase, DenyAssetsHook {
 
     /// @notice Deny every ASSET block in `input` as the active guardian.
     function revokeAsset(bytes calldata input) external onlyGuardian {
-        Execution memory exec = openInput(input, descriptor, 0);
+        Execution memory exec = openInput(input, descriptor);
 
         while (exec.more()) {
-            bytes32 asset = exec.unpackAsset(Lanes.Input);
+            bytes32 asset = exec.unpackAsset();
             denyAsset(asset);
         }
     }

package/package.json

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

package/ports/Allowance.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.33;
 
 import {PortBase} from "./Base.sol";
 import {Specs} from "../Codec.sol";
-import {Execution, Executions, Lanes} from "../execution/Execution.sol";
+import {Execution, Executions} from "../execution/Execution.sol";
 
 using Executions for Execution;
 
@@ -33,11 +33,11 @@ abstract contract RequestAllowancePort is PortBase, RequestAllowanceHook {
     /// @param data AMOUNT block stream supplied by the trusted peer.
     /// @return Empty response bytes.
     function portRequestAllowance(bytes calldata data) external onlyPeer returns (bytes memory) {
-        Execution memory exec = openInput(data, descriptor, 0);
+        Execution memory exec = openInput(data, descriptor);
         uint peer = caller();
 
         while (exec.more()) {
-            (bytes32 asset, uint amount) = exec.unpackAmount(Lanes.Input);
+            (bytes32 asset, uint amount) = exec.unpackAmount();
             requestAllowance(peer, asset, amount);
         }
 

package/ports/Assets.sol

@@ -5,7 +5,7 @@ import {PortBase} from "./Base.sol";
 import {AllowAssetsHook} from "../commands/admin/AllowAssets.sol";
 import {DenyAssetsHook} from "../commands/admin/DenyAssets.sol";
 import {Specs} from "../Codec.sol";
-import {Execution, Executions, Lanes} from "../execution/Execution.sol";
+import {Execution, Executions} from "../execution/Execution.sol";
 
 using Executions for Execution;
 
@@ -23,10 +23,10 @@ abstract contract AllowAssetsPort is PortBase, AllowAssetsHook {
     /// @param data ASSET block stream supplied by the trusted peer.
     /// @return Empty response bytes.
     function portAllowAssets(bytes calldata data) external onlyPeer returns (bytes memory) {
-        Execution memory exec = openInput(data, descriptor, 0);
+        Execution memory exec = openInput(data, descriptor);
 
         while (exec.more()) {
-            bytes32 asset = exec.unpackAsset(Lanes.Input);
+            bytes32 asset = exec.unpackAsset();
             allowAsset(asset);
         }
 
@@ -48,10 +48,10 @@ abstract contract DenyAssetsPort is PortBase, DenyAssetsHook {
     /// @param data ASSET block stream supplied by the trusted peer.
     /// @return Empty response bytes.
     function portDenyAssets(bytes calldata data) external onlyPeer returns (bytes memory) {
-        Execution memory exec = openInput(data, descriptor, 0);
+        Execution memory exec = openInput(data, descriptor);
 
         while (exec.more()) {
-            bytes32 asset = exec.unpackAsset(Lanes.Input);
+            bytes32 asset = exec.unpackAsset();
             denyAsset(asset);
         }
 
@@ -86,11 +86,11 @@ abstract contract RequestAssetPort is PortBase, RequestAssetHook {
     /// @param data AMOUNT block stream supplied by the trusted peer.
     /// @return Empty response bytes.
     function portRequestAsset(bytes calldata data) external onlyPeer returns (bytes memory) {
-        Execution memory exec = openInput(data, descriptor, 0);
+        Execution memory exec = openInput(data, descriptor);
         uint peer = caller();
 
         while (exec.more()) {
-            (bytes32 asset, uint amount) = exec.unpackAmount(Lanes.Input);
+            (bytes32 asset, uint amount) = exec.unpackAmount();
             requestAsset(peer, asset, amount);
         }
 

package/ports/Base.sol

@@ -41,7 +41,7 @@ abstract contract PortBase is NodeCalls, NodeAccess, InputEndpointBase {
         uint output,
         uint8 flags
     ) internal returns (uint id, uint descriptor) {
-        descriptor = Descriptors.create(Specs.Empty, input, output, 0, flags);
+        descriptor = Descriptors.create(Specs.Empty, input, output, flags);
         return port(name, descriptor);
     }
 

package/ports/Credit.sol

@@ -4,7 +4,7 @@ pragma solidity ^0.8.33;
 import {PortBase} from "./Base.sol";
 import {CreditAccountHook} from "../core/Settlement.sol";
 import {Specs} from "../Codec.sol";
-import {Execution, Executions, Lanes} from "../execution/Execution.sol";
+import {Execution, Executions} from "../execution/Execution.sol";
 
 using Executions for Execution;
 
@@ -22,10 +22,10 @@ abstract contract CreditAccountPort is PortBase, CreditAccountHook {
     /// @param data ACCOUNT_AMOUNT block stream supplied by the trusted peer.
     /// @return Empty response bytes.
     function portCreditAccount(bytes calldata data) external onlyPeer returns (bytes memory) {
-        Execution memory exec = openInput(data, descriptor, 0);
+        Execution memory exec = openInput(data, descriptor);
 
         while (exec.more()) {
-            (bytes32 account, bytes32 asset, uint amount) = exec.unpackAccountAmount(Lanes.Input);
+            (bytes32 account, bytes32 asset, uint amount) = exec.unpackAccountAmount();
             creditAccount(account, asset, amount);
         }
         

package/ports/Debit.sol

@@ -4,7 +4,7 @@ pragma solidity ^0.8.33;
 import {PortBase} from "./Base.sol";
 import {DebitAccountHook} from "../core/Settlement.sol";
 import {Specs} from "../Codec.sol";
-import {Execution, Executions, Lanes} from "../execution/Execution.sol";
+import {Execution, Executions} from "../execution/Execution.sol";
 
 using Executions for Execution;
 
@@ -22,10 +22,10 @@ abstract contract DebitAccountPort is PortBase, DebitAccountHook {
     /// @param data ACCOUNT_AMOUNT block stream supplied by the trusted peer.
     /// @return Empty response bytes.
     function portDebitAccount(bytes calldata data) external onlyPeer returns (bytes memory) {
-        Execution memory exec = openInput(data, descriptor, 0);
+        Execution memory exec = openInput(data, descriptor);
 
         while (exec.more()) {
-            (bytes32 account, bytes32 asset, uint amount) = exec.unpackAccountAmount(Lanes.Input);
+            (bytes32 account, bytes32 asset, uint amount) = exec.unpackAccountAmount();
             debitAccount(account, asset, amount);
         }
         

package/ports/Dispatch.sol

@@ -4,7 +4,7 @@ pragma solidity ^0.8.33;
 import {PortBase} from "./Base.sol";
 import {Flags} from "../codec/Descriptors.sol";
 import {Specs} from "../Codec.sol";
-import {Execution, Executions, Lanes} from "../execution/Execution.sol";
+import {Execution, Executions} from "../execution/Execution.sol";
 
 using Executions for Execution;
 
@@ -36,10 +36,10 @@ abstract contract DispatchPayablePort is PortBase, DispatchPayableHook {
     /// @param data DISPATCH block stream supplied by the trusted peer.
     /// @return Empty response bytes.
     function portDispatchPayable(bytes calldata data) external payable onlyPeer returns (bytes memory) {
-        Execution memory exec = openInput(data, descriptor, 0);
+        Execution memory exec = openInput(data, descriptor);
 
         while (exec.more()) {
-            (uint portal, uint resources, bytes calldata payload) = exec.unpackDispatch(Lanes.Input);
+            (uint portal, uint resources, bytes calldata payload) = exec.unpackDispatch();
             dispatchTo(portal, resources, payload, exec);
         }
         

package/ports/Pipe.sol

@@ -5,7 +5,7 @@ import {PortBase} from "./Base.sol";
 import {Flags} from "../codec/Descriptors.sol";
 import {PipeHook} from "../core/Pipeline.sol";
 import {Specs} from "../Codec.sol";
-import {Execution, Executions, Lanes} from "../execution/Execution.sol";
+import {Execution, Executions} from "../execution/Execution.sol";
 
 using Executions for Execution;
 
@@ -25,11 +25,11 @@ abstract contract PipePayablePort is PortBase, PipeHook {
     /// @param data CONTEXT block stream supplied by the trusted peer.
     /// @return Empty response bytes.
     function portPipePayable(bytes calldata data) external payable onlyPeer returns (bytes memory) {
-        Execution memory exec = openInput(data, descriptor, 0);
+        Execution memory exec = openInput(data, descriptor);
         uint budget = exec.drainBudget();
 
         while (exec.more()) {
-            (bytes32 account, bytes calldata state, bytes calldata input) = exec.unpackContext(Lanes.Input);
+            (bytes32 account, bytes calldata state, bytes calldata input) = exec.unpackContext();
             budget = pipe(account, state, input, budget);
         }
         

package/ports/Post.sol

@@ -4,7 +4,7 @@ pragma solidity ^0.8.33;
 import {PortBase} from "./Base.sol";
 import {PostHook} from "../core/Settlement.sol";
 import {Specs} from "../Codec.sol";
-import {Execution, Executions, Lanes} from "../execution/Execution.sol";
+import {Execution, Executions} from "../execution/Execution.sol";
 import {Action} from "../annotations/Action.sol";
 import {Actions} from "../utils/Actions.sol";
 
@@ -26,10 +26,10 @@ abstract contract PostPort is PortBase, PostHook, Action {
     /// @param data TRANSACTION block stream supplied by the trusted peer.
     /// @return Empty response bytes.
     function portPost(bytes calldata data) external onlyPeer returns (bytes memory) {
-        Execution memory exec = openInput(data, descriptor, 0);
+        Execution memory exec = openInput(data, descriptor);
 
         while (exec.more()) {
-            (bytes32 from, bytes32 to, bytes32 asset, uint amount) = exec.unpackTransaction(Lanes.Input);
+            (bytes32 from, bytes32 to, bytes32 asset, uint amount) = exec.unpackTransaction();
             post(from, to, asset, amount);
         }
 

package/ports/Redeem.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.33;
 
 import {PortBase} from "./Base.sol";
 import {Specs} from "../Codec.sol";
-import {Execution, Executions, Lanes} from "../execution/Execution.sol";
+import {Execution, Executions} from "../execution/Execution.sol";
 
 using Executions for Execution;
 
@@ -31,11 +31,11 @@ abstract contract RedeemBalancePort is PortBase, RedeemBalanceHook {
     /// @param data BALANCE block stream supplied by the trusted peer.
     /// @return Empty response bytes.
     function portRedeemBalance(bytes calldata data) external onlyPeer returns (bytes memory) {
-        Execution memory exec = openInput(data, descriptor, 0);
+        Execution memory exec = openInput(data, descriptor);
         uint peer = caller();
 
         while (exec.more()) {
-            (bytes32 asset, uint amount) = exec.unpackBalance(Lanes.Input);
+            (bytes32 asset, uint amount) = exec.unpackBalance();
             redeemBalance(peer, asset, amount);
         }
         

package/queries/Assets.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.33;
 
 import {Specs} from "../Codec.sol";
-import {Execution, Executions, Lanes} from "../execution/Execution.sol";
+import {Execution, Executions} from "../execution/Execution.sol";
 import {QueryBase} from "./Base.sol";
 
 using Executions for Execution;
@@ -31,10 +31,10 @@ abstract contract AssetStatus is QueryBase, AssetStatusHook {
     /// @param input Block-stream input consisting of `asset { bytes32 asset }` blocks.
     /// @return Block-stream response containing one `status { uint code }` form block per asset block.
     function assetStatus(bytes calldata input) external view returns (bytes memory) {
-        Execution memory exec = openInput(input, descriptor, 0);
+        Execution memory exec = openInput(input, descriptor);
 
         while (exec.more()) {
-            bytes32 asset = exec.unpackAsset(Lanes.Input);
+            bytes32 asset = exec.unpackAsset();
             uint status = assetStatus(asset);
             exec.outputStatus(status);
         }

package/queries/Balances.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.33;
 
 import {Specs} from "../Codec.sol";
-import {Execution, Executions, Lanes} from "../execution/Execution.sol";
+import {Execution, Executions} from "../execution/Execution.sol";
 import {QueryBase} from "./Base.sol";
 
 using Executions for Execution;
@@ -32,10 +32,10 @@ abstract contract GetBalances is QueryBase, GetBalancesHook {
     /// @param input Block-stream input consisting of `accountAsset(account, asset)*`.
     /// @return Block-stream response containing one `accountAmount(account, asset, amount)` block per input block.
     function getBalances(bytes calldata input) external view returns (bytes memory) {
-        Execution memory exec = openInput(input, descriptor, 0);
+        Execution memory exec = openInput(input, descriptor);
 
         while (exec.more()) {
-            (bytes32 account, bytes32 asset) = exec.unpackAccountAsset(Lanes.Input);
+            (bytes32 account, bytes32 asset) = exec.unpackAccountAsset();
             uint amount = getBalance(account, asset);
             exec.outputAccountAmount(account, asset, amount);
         }

package/queries/Base.sol

@@ -24,7 +24,7 @@ abstract contract QueryBase is InputEndpointBase {
         uint input,
         uint output
     ) internal returns (uint id, uint descriptor) {
-        descriptor = Descriptors.create(Specs.Empty, input, output, 0, 0);
+        descriptor = Descriptors.create(Specs.Empty, input, output, 0);
         return query(name, descriptor);
     }
 

package/utils/Accounts.sol

@@ -2,6 +2,7 @@
 pragma solidity ^0.8.33;
 
 import {Layout} from "./Layout.sol";
+import {InvalidAccount} from "./Errors.sol";
 import {Ids} from "./Ids.sol";
 import {ensureAddr, isFamily, toLocalBase, toUnspecifiedBase} from "./Utils.sol";
 
@@ -18,9 +19,6 @@ import {ensureAddr, isFamily, toLocalBase, toUnspecifiedBase} from "./Utils.sol"
 ///
 /// The helpers in this library validate and deconstruct structured account IDs.
 library Accounts {
-    /// @dev Thrown when an account ID does not belong to the EVM family.
-    error InvalidAccount();
-
     /// @dev 24-bit family tag shared by all EVM-backed account types.
     uint24 constant Family = (uint24(Layout.Evm) << 8) | uint24(Layout.Account);
     /// @dev Full 4-byte type prefix for admin accounts (chain-local EVM address).
@@ -36,6 +34,7 @@ library Accounts {
     }
 
     /// @notice Return true if `account` belongs to the EVM account family.
+    /// @dev Classification only; does not require a nonzero embedded address.
     function isEvm(bytes32 account) internal pure returns (bool) {
         return isFamily(uint(account), Family);
     }
@@ -46,20 +45,24 @@ library Accounts {
     }
 
     /// @notice Return true if `account` is an admin account.
+    /// @dev Classification only; does not require a nonzero embedded address.
     function isAdmin(bytes32 account) internal pure returns (bool) {
         return prefix(account) == Admin;
     }
 
     /// @notice Return true if `account` is a user account.
+    /// @dev Classification only; does not require a nonzero embedded address.
     function isUser(bytes32 account) internal pure returns (bool) {
         return prefix(account) == User;
     }
 
-    /// @notice Assert that `value` belongs to the EVM account family and return it unchanged.
+    /// @notice Assert that `value` belongs to the EVM account family, contains
+    /// a nonzero embedded address, and return it unchanged.
     /// @param value Account identifier to validate.
     /// @return account The same `value` if it is an EVM account.
     function evm(bytes32 value) internal pure returns (bytes32 account) {
-        if (!isEvm(value)) revert InvalidAccount();
+        if (!isFamily(uint(value), Family)) revert InvalidAccount();
+        ensureAddr(address(uint160(uint(value) >> 32)));
         return value;
     }
 
@@ -71,19 +74,23 @@ library Accounts {
         return value;
     }
 
-    /// @notice Assert that `value` is an admin account and return it unchanged.
+    /// @notice Assert that `value` is an admin account, contains a nonzero
+    /// embedded address, and return it unchanged.
     /// @param value Account identifier to validate.
     /// @return account The same `value` if it is an admin account.
     function admin(bytes32 value) internal pure returns (bytes32 account) {
-        if (!isAdmin(value)) revert InvalidAccount();
+        if (uint32(uint(value) >> 224) != Admin) revert InvalidAccount();
+        ensureAddr(address(uint160(uint(value) >> 32)));
         return value;
     }
 
-    /// @notice Assert that `value` is a user account and return it unchanged.
+    /// @notice Assert that `value` is a user account, contains a nonzero
+    /// embedded address, and return it unchanged.
     /// @param value Account identifier to validate.
     /// @return account The same `value` if it is a user account.
     function user(bytes32 value) internal pure returns (bytes32 account) {
-        if (!isUser(value)) revert InvalidAccount();
+        if (uint32(uint(value) >> 224) != User) revert InvalidAccount();
+        ensureAddr(address(uint160(uint(value) >> 32)));
         return value;
     }
 
@@ -122,6 +129,6 @@ library Accounts {
     /// @param account EVM-family account ID.
     /// @return Embedded address (bits [191:32] of the ID).
     function addr(bytes32 account) internal pure returns (address) {
-        return ensureAddr(address(uint160(uint(evm(account)) >> 32)));
+        return address(uint160(uint(evm(account)) >> 32));
     }
 }

package/utils/Actions.sol

@@ -18,4 +18,6 @@ library Actions {
     uint32 constant Liquidate = 12;
     uint32 constant Refund = 13;
     uint32 constant Post = 14;
+    uint32 constant Cashout = 15;
+    uint32 constant Cashin = 16;
 }

package/utils/Assets.sol

@@ -2,6 +2,7 @@
 pragma solidity ^0.8.33;
 
 import {Layout} from "./Layout.sol";
+import {BadAmount, InvalidAsset, UnauthorizedAsset, ZeroAmount} from "./Errors.sol";
 import {Ids} from "./Ids.sol";
 import {ensureAddr, isFamily, matchesBase, toLocalBase} from "./Utils.sol";
 
@@ -20,11 +21,6 @@ import {ensureAddr, isFamily, matchesBase, toLocalBase} from "./Utils.sol";
 ///
 /// All asset IDs are chain-local (include `block.chainid` in bits [223:192]).
 library Assets {
-    /// @dev Thrown when an asset ID does not match the expected type or chain.
-    error InvalidAsset();
-    /// @dev Thrown when an asset is not authorized for the requested operation.
-    error UnauthorizedAsset();
-
     /// @dev 24-bit family tag shared by all EVM-backed asset types.
     uint24 constant Family = (uint24(Layout.Evm) << 8) | uint24(Layout.Asset);
     /// @dev Full 4-byte type prefix for the native chain coin/token asset.
@@ -136,11 +132,6 @@ library Assets {
 /// @title Amounts
 /// @notice Validation helpers for token amounts.
 library Amounts {
-    /// @dev Thrown when a required non-zero amount is zero.
-    error ZeroAmount();
-    /// @dev Thrown when an amount falls outside the allowed `[min, max]` range.
-    error BadAmount(uint amount);
-
     /// @notice Assert that `amount` is non-zero and return it unchanged.
     /// @param amount Amount to validate.
     /// @return The same `amount` value if valid.