@bloxchain/contracts 1.0.0-alpha.2 → 1.0.0-alpha.21

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@bloxchain/contracts",
-  "version": "1.0.0-alpha.2",
+  "version": "1.0.0-alpha.21",
   "description": "Library engine for building enterprise grade decentralized permissioned applications",
   "files": [
     "core",
-    "utils",
-    "interfaces",
     "abi",
+    "standards",
+    "components",
     "README.md"
   ],
   "scripts": {
@@ -40,8 +40,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@openzeppelin/contracts": "^5.4.0",
-    "@openzeppelin/contracts-upgradeable": "^5.4.0"
+    "@openzeppelin/contracts": "^5.6.1",
+    "@openzeppelin/contracts-upgradeable": "^5.6.1"
   },
   "engines": {
     "node": ">=18.0.0"

package/standards/README.md

@@ -0,0 +1,12 @@
+# Bloxchain Standards
+
+Protocol-level **interfaces** that define optional behaviors and extension points for Blox contracts. These live outside `core/` so the engine stays minimal and stable.
+
+## Structure
+
+- **behavior/** – Optional behavior interfaces (e.g. cloneable blox). Implementations live in `components/` or `examples/`.
+- **hooks/** – Hook and trigger interfaces used by the system to call into external contracts (e.g. post-action hooks).
+
+## Usage
+
+Contracts in `core/`, `components/`, and `examples/` may depend on these interfaces. New standards should be proposed and reviewed before addition.

package/standards/behavior/ICopyable.sol

@@ -0,0 +1,34 @@
+// SPDX-License-Identifier: MPL-2.0
+pragma solidity 0.8.35;
+
+/**
+ * @title ICopyable
+ * @dev Interface for blox contracts that support generic cloning with custom init data.
+ *
+ * Bloxes implementing this interface can be cloned by factory patterns (e.g. CopyBlox,
+ * FactoryBlox) and initialized in one call with owner/broadcaster/recovery/timelock/
+ * eventForwarder plus arbitrary init data, or have clone-specific data set
+ *
+ * Use cases:
+ * - Clone and init in one step: factory calls initializeWithData(..., initData).
+ * - Clone with standard init then set clone data: factory calls initializeWithData(...)
+ */
+interface ICopyable {
+    /**
+     * @dev Full initialization with standard blox params and custom init data.
+     * @param initialOwner The initial owner address
+     * @param broadcaster The broadcaster address
+     * @param recovery The recovery address
+     * @param timeLockPeriodSec The timelock period in seconds
+     * @param eventForwarder The event forwarder address (optional, use address(0) to skip)
+     * @param initData Custom initialization data (e.g. ABI-encoded config) for this clone
+     */
+    function initializeWithData(
+        address initialOwner,
+        address broadcaster,
+        address recovery,
+        uint256 timeLockPeriodSec,
+        address eventForwarder,
+        bytes calldata initData
+    ) external;
+}

package/standards/hooks/IOnActionHook.sol

@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: MPL-2.0
+pragma solidity 0.8.35;
+
+import "../../core/lib/EngineBlox.sol";
+
+/**
+ * @title IOnActionHook
+ * @dev Minimal interface for external hook contracts attached to state machine actions.
+ *
+ * @notice This interface is intentionally small to keep overall contract size low.
+ * @notice The state machine calls this single hook after any transaction operation that
+ *         produces a TxRecord, providing a centralized post-action entry point.
+ */
+interface IOnActionHook {
+    /**
+     * @dev Called after any transaction operation that produces a TxRecord.
+     *      This includes request, approve, cancel and meta-tx flows.
+     * @param txRecord The transaction record produced by the operation
+     */
+    function onAction(EngineBlox.TxRecord memory txRecord) external;
+}