@rootzero/contracts 1.3.0 → 1.4.0

package/CHANGELOG.md

@@ -3,6 +3,19 @@
 Until the protocol reaches integration-stable status, minor versions may include
 breaking API changes. Breaking changes are called out explicitly.
 
+## 1.4.0
+
+### Breaking Changes
+
+- Replaced the `Chain` discovery event with `Commander(uint indexed host, uint chain, bytes32 native, bytes32 admin)`.
+- Removed the `Transfer` flow event; account flows should be represented with `Spent` and `Received`.
+- Renamed the indexed `Labeled` event parameter from `id` to `entity` in the published ABI string.
+
+### Added
+
+- Added `Route(uint indexed host, uint chain, uint context)` for generic cross-chain route discovery.
+- Added `Actions.Refund` for unused payable command value returned through settlement hooks.
+
 ## 1.3.0
 
 ### Breaking Changes

package/Events.sol

@@ -8,7 +8,7 @@ import { AdminEvent } from "./events/Admin.sol";
 import { AssetStatusEvent } from "./events/Asset.sol";
 import { Actions } from "./utils/Actions.sol";
 import { BalanceEvent } from "./events/Balance.sol";
-import { ChainEvent } from "./events/Chain.sol";
+import { CommanderEvent } from "./events/Commander.sol";
 import { CommandEvent } from "./events/Command.sol";
 import { PositionEvent } from "./events/Position.sol";
 import { ReceivedEvent } from "./events/Received.sol";
@@ -22,8 +22,8 @@ import { NodeEvent } from "./events/Node.sol";
 import { PeerEvent } from "./events/Peer.sol";
 import { QueryEvent } from "./events/Query.sol";
 import { RootedEvent } from "./events/Rooted.sol";
+import { RouteEvent } from "./events/Route.sol";
 import { SpentEvent } from "./events/Spent.sol";
-import { TransferEvent } from "./events/Transfer.sol";
 import { UnlockedEvent } from "./events/Unlocked.sol";
 
 

package/events/Commander.sol

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: GPL-3.0-only
+pragma solidity ^0.8.33;
+
+import {EventEmitter} from "./Emitter.sol";
+
+/// @notice Emitted when a commander is announced for a chain/domain.
+abstract contract CommanderEvent is EventEmitter {
+    string private constant ABI = "event Commander(uint indexed host, uint chain, bytes32 native, bytes32 admin)";
+
+    /// @param host Commander host node ID for the chain.
+    /// @param chain Chain/domain node ID.
+    /// @param native Native asset ID for the chain.
+    /// @param admin Admin account for the commander host on the chain.
+    event Commander(uint indexed host, uint chain, bytes32 native, bytes32 admin);
+
+    constructor() {
+        emit EventAbi(ABI);
+    }
+}

package/events/Labeled.sol

@@ -3,17 +3,17 @@ pragma solidity ^0.8.33;
 
 import {EventEmitter} from "./Emitter.sol";
 
-/// @notice Emitted to attach a human-readable namespaced label to a node ID.
+/// @notice Emitted to attach a human-readable namespaced label to an entity.
 /// @dev Labels are claims by the emitting contract. Any contract may emit a
-/// label for any ID, so off-chain indexers must decide which emitters are
-/// trusted for each labeled ID or namespace.
+/// label for any entity, so off-chain indexers must decide which emitters are
+/// trusted for each labeled entity or namespace.
 abstract contract LabeledEvent is EventEmitter {
-    string private constant ABI = "event Labeled(uint indexed id, bytes32 namespace, string name)";
+    string private constant ABI = "event Labeled(uint indexed entity, bytes32 namespace, string name)";
 
-    /// @param id Node or capability ID being labeled.
+    /// @param entity Entity being labeled.
     /// @param namespace Label namespace.
     /// @param name Human-readable name within the namespace.
-    event Labeled(uint indexed id, bytes32 namespace, string name);
+    event Labeled(uint indexed entity, bytes32 namespace, string name);
 
     constructor() {
         emit EventAbi(ABI);

package/events/Route.sol

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: GPL-3.0-only
+pragma solidity ^0.8.33;
+
+import {EventEmitter} from "./Emitter.sol";
+
+/// @notice Emitted when a host announces a route to another chain/domain.
+abstract contract RouteEvent is EventEmitter {
+    string private constant ABI = "event Route(uint indexed host, uint chain, uint context)";
+
+    /// @param host Host node ID that owns the route.
+    /// @param chain Destination chain/domain node ID.
+    /// @param context Route context identifier.
+    event Route(uint indexed host, uint chain, uint context);
+
+    constructor() {
+        emit EventAbi(ABI);
+    }
+}

package/package.json

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

package/utils/Actions.sol

@@ -15,4 +15,5 @@ library Actions {
     uint32 constant Borrow = 10;
     uint32 constant Repay = 11;
     uint32 constant Liquidate = 12;
+    uint32 constant Refund = 13;
 }

package/events/Chain.sol

@@ -1,19 +0,0 @@
-// SPDX-License-Identifier: GPL-3.0-only
-pragma solidity ^0.8.33;
-
-import {EventEmitter} from "./Emitter.sol";
-
-/// @notice Emitted when a chain/domain node is announced.
-abstract contract ChainEvent is EventEmitter {
-    string private constant ABI = "event Chain(uint indexed chain, bytes32 native, uint commander, bytes32 admin)";
-
-    /// @param chain Chain node ID.
-    /// @param native Native asset ID for the chain.
-    /// @param commander Commander host node ID for the chain.
-    /// @param admin Admin account for the commander host on the chain.
-    event Chain(uint indexed chain, bytes32 native, uint commander, bytes32 admin);
-
-    constructor() {
-        emit EventAbi(ABI);
-    }
-}

package/events/Transfer.sol

@@ -1,22 +0,0 @@
-// SPDX-License-Identifier: GPL-3.0-only
-pragma solidity ^0.8.33;
-
-import { EventEmitter } from "./Emitter.sol";
-
-/// @notice Emitted when an asset moves from one account to another.
-abstract contract TransferEvent is EventEmitter {
-    string private constant ABI = "event Transfer(bytes32 indexed account, bytes32 to, bytes32 asset, bytes32 meta, uint amount, uint32 action, uint context)";
-
-    /// @param account Source account identifier.
-    /// @param to Destination account identifier.
-    /// @param asset Asset identifier.
-    /// @param meta Asset metadata slot.
-    /// @param amount Amount transferred.
-    /// @param action Primary operation hint from `Actions`.
-    /// @param context Reserved context value for future use.
-    event Transfer(bytes32 indexed account, bytes32 to, bytes32 asset, bytes32 meta, uint amount, uint32 action, uint context);
-
-    constructor() {
-        emit EventAbi(ABI);
-    }
-}