@rootzero/contracts 0.9.9 → 1.0.0

package/utils/Layout.sol

@@ -6,19 +6,24 @@ pragma solidity ^0.8.33;
 /// layout of 256-bit IDs used throughout the rootzero protocol.
 ///
 /// IDs are structured as:
-///   `[uint16 width][uint16 chainId-prefix][uint32 prefix][... payload ...]`
-/// where the top bytes carry nested type tags drawn from the constants below.
+///   `[uint32 type][uint32 chainid][192-bit payload]`
+/// where `type` is `[uint8 vm][uint8 width][uint8 category][uint8 subtype]`.
 library Layout {
     // -------------------------------------------------------------------------
-    // Data-width tags (uint16, top 2 bytes of the ID type field)
+    // VM and data-width tags (top 2 bytes of the ID type field)
     // -------------------------------------------------------------------------
 
-    /// @dev 32-byte opaque value; no EVM address embedded.
-    uint16 constant Opaque32 = 0x2000;
+    /// @dev EVM-compatible value; payloads are built around 20-byte addresses.
+    uint8 constant Evm = 0x01;
+    /// @dev 32-byte ID; no paired metadata word is required.
+    uint8 constant Width32 = 0x20;
+    /// @dev 64-byte ID; a paired metadata word completes the identity.
+    uint8 constant Width64 = 0x40;
+
     /// @dev 32-byte EVM-compatible value; lower 20 bytes hold an address.
-    uint16 constant Evm32 = 0x2001;
+    uint16 constant Evm32 = (uint16(Evm) << 8) | uint16(Width32);
     /// @dev 64-byte EVM-compatible value; used when a paired metadata word completes the identity.
-    uint16 constant Evm64 = 0x4001;
+    uint16 constant Evm64 = (uint16(Evm) << 8) | uint16(Width64);
 
     // -------------------------------------------------------------------------
     // Category tags (uint8, third byte of the ID type field)
@@ -41,30 +46,29 @@ library Layout {
     uint8 constant Guardian = 0x02;
     /// @dev User account — chain-agnostic, backed by an EVM address.
     uint8 constant User = 0x03;
-    /// @dev Keccak account — opaque 28-byte keccak commitment.
-    uint8 constant Keccak = 0x04;
-
     // -------------------------------------------------------------------------
     // Node subtype tags (uint8, fourth byte of the ID type field)
     // -------------------------------------------------------------------------
 
+    /// @dev Node is a chain/domain identifier.
+    uint8 constant Chain = 0x01;
     /// @dev Node is a host contract.
-    uint8 constant Host = 0x01;
+    uint8 constant Host = 0x02;
     /// @dev Node is a command contract.
-    uint8 constant Command = 0x02;
+    uint8 constant Command = 0x03;
     /// @dev Node is a peer contract.
-    uint8 constant Peer = 0x03;
+    uint8 constant Peer = 0x04;
     /// @dev Node is a query contract.
-    uint8 constant Query = 0x04;
+    uint8 constant Query = 0x05;
     /// @dev Node is a guardian-only direct action.
-    uint8 constant Guard = 0x05;
+    uint8 constant Guard = 0x06;
 
     // -------------------------------------------------------------------------
     // Asset subtype tags (uint8, fourth byte of the ID type field)
     // -------------------------------------------------------------------------
 
-    /// @dev Native chain value asset (ETH / native token).
-    uint8 constant Value = 0x01;
+    /// @dev Native chain coin/token asset.
+    uint8 constant Native = 0x01;
     /// @dev ERC-20 fungible token; lower 20 bytes of the ID hold the contract address.
     uint8 constant Erc20 = 0x02;
     /// @dev ERC-721 non-fungible token; lower 20 bytes of the ID hold the collection address.

package/utils/Utils.sol

@@ -4,9 +4,9 @@ pragma solidity ^0.8.33;
 // Basis-points denominator: 10_000 BPS == 100.00%.
 uint16 constant MAX_BPS = 10_000;
 
-// Thrown by max* helpers when a value exceeds the target integer width.
+/// @dev Thrown by max* helpers when a value exceeds the target integer width.
 error ValueOverflow();
-// Thrown by `divisible` when `n` is not evenly divisible by `divisor`.
+/// @dev Thrown by `divisible` when `n` is not evenly divisible by `divisor`.
 error NotDivisible();
 
 /// @notice Assert that `value` fits in uint8 and return it unchanged.