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

package/core/research/erc20-blox/ERC20Blox.sol

@@ -1,140 +0,0 @@
-// SPDX-License-Identifier: MPL-2.0
-pragma solidity 0.8.33;
-
-// OpenZeppelin
-import "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
-import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/ERC20BurnableUpgradeable.sol";
-import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-
-// Core
-import "../../security/SecureOwnable.sol";
-import "../../access/RuntimeRBAC.sol";
-import "../../execution/GuardController.sol";
-import "../../base/BaseStateMachine.sol";
-import "../../../utils/SharedValidation.sol";
-import "../../../interfaces/IDefinition.sol";
-import "./lib/definitions/ERC20BloxDefinitions.sol";
-
-/**
- * @title ERC20Blox
- * @dev ERC20 token (IERC20) with SecureOwnable, RuntimeRBAC, and GuardController.
- * Exposes transfer (ERC20), mint (owner-only), and burn (ERC20Burnable).
- * @custom:security-contact security@particlecrypto.com
- */
-contract ERC20Blox is
-    IERC20,
-    ERC20Upgradeable,
-    ERC20BurnableUpgradeable,
-    SecureOwnable,
-    RuntimeRBAC,
-    GuardController
-{
-    using SharedValidation for *;
-
-    /// @custom:oz-upgrades-unsafe-allow constructor
-    constructor() {
-        _disableInitializers();
-    }
-
-    /**
-     * @dev Override to resolve diamond: SecureOwnable, RuntimeRBAC, GuardController all define initialize(5 params).
-     * Call this first, then initializeToken(name, symbol) to set ERC20 metadata.
-     */
-    function initialize(
-        address initialOwner,
-        address broadcaster,
-        address recovery,
-        uint256 timeLockPeriodSec,
-        address eventForwarder
-    ) public virtual override(GuardController, RuntimeRBAC, SecureOwnable) initializer {
-        GuardController.initialize(initialOwner, broadcaster, recovery, timeLockPeriodSec, eventForwarder);
-        RuntimeRBAC.initialize(initialOwner, broadcaster, recovery, timeLockPeriodSec, eventForwarder);
-        SecureOwnable.initialize(initialOwner, broadcaster, recovery, timeLockPeriodSec, eventForwarder);
-
-        // Load ERC20Blox execution selectors (transfer, transferFrom, mint, burn, burnFrom) so controller can execute them
-        IDefinition.RolePermission memory erc20Permissions = ERC20BloxDefinitions.getRolePermissions();
-        _loadDefinitions(
-            ERC20BloxDefinitions.getFunctionSchemas(),
-            erc20Permissions.roleHashes,
-            erc20Permissions.functionPermissions,
-            true
-        );
-
-        // Register ERC20Blox system macro selectors (allowed to target address(this) for time-lock/meta-tx execution)
-        _addMacroSelector(ERC20BloxDefinitions.TRANSFER_SELECTOR);
-        _addMacroSelector(ERC20BloxDefinitions.TRANSFER_FROM_SELECTOR);
-        _addMacroSelector(ERC20BloxDefinitions.MINT_SELECTOR);
-        _addMacroSelector(ERC20BloxDefinitions.BURN_SELECTOR);
-        _addMacroSelector(ERC20BloxDefinitions.BURN_FROM_SELECTOR);
-    }
-
-    /**
-     * @notice Initialize the ERC20 token name and symbol. Call after initialize(5 params).
-     * @param name Token name
-     * @param symbol Token symbol
-     */
-    function initializeToken(string memory name, string memory symbol) public reinitializer(2) {
-        __ERC20_init(name, symbol);
-    }
-
-    /**
-     * @dev Override to resolve ambiguity between BaseStateMachine and SecureOwnable.
-     */
-    function _updateTimeLockPeriod(uint256 newTimeLockPeriodSec) internal virtual override(BaseStateMachine, SecureOwnable) {
-        SecureOwnable._updateTimeLockPeriod(newTimeLockPeriodSec);
-    }
-
-    /**
-     * @notice Transfer tokens to an account (callable only by this contract via GuardController)
-     * @param to Recipient address
-     * @param value Amount to transfer
-     */
-    function transfer(address to, uint256 value) public virtual override(ERC20Upgradeable, IERC20) returns (bool) {
-        SharedValidation.validateInternalCall(address(this));
-        return super.transfer(to, value);
-    }
-
-    /**
-     * @notice Transfer tokens from one account to another (with allowance); callable only by this contract via GuardController
-     * @param from Sender address
-     * @param to Recipient address
-     * @param value Amount to transfer
-     */
-    function transferFrom(address from, address to, uint256 value) public virtual override(ERC20Upgradeable, IERC20) returns (bool) {
-        SharedValidation.validateInternalCall(address(this));
-        return super.transferFrom(from, to, value);
-    }
-
-    /**
-     * @notice Mint tokens to an account (callable only by this contract via GuardController)
-     * @param to Recipient address
-     * @param amount Amount to mint
-     */
-    function mint(address to, uint256 amount) external virtual {
-        SharedValidation.validateInternalCall(address(this));
-        _mint(to, amount);
-    }
-
-    /**
-     * @notice Burn tokens from caller (callable only by this contract via GuardController)
-     * @param value Amount to burn
-     */
-    function burn(uint256 value) public virtual override(ERC20BurnableUpgradeable) {
-        SharedValidation.validateInternalCall(address(this));
-        super.burn(value);
-    }
-
-    /**
-     * @notice Burn tokens from an account (with allowance); callable only by this contract via GuardController
-     * @param account Account to burn from
-     * @param value Amount to burn
-     */
-    function burnFrom(address account, uint256 value) public virtual override(ERC20BurnableUpgradeable) {
-        SharedValidation.validateInternalCall(address(this));
-        super.burnFrom(account, value);
-    }
-
-    function supportsInterface(bytes4 interfaceId) public view virtual override(SecureOwnable, RuntimeRBAC, GuardController) returns (bool) {
-        return interfaceId == type(IERC20).interfaceId || GuardController.supportsInterface(interfaceId);
-    }
-}

package/core/research/erc20-blox/lib/definitions/ERC20BloxDefinitions.sol

@@ -1,185 +0,0 @@
-// SPDX-License-Identifier: MPL-2.0
-pragma solidity 0.8.33;
-
-import "../../../../lib/EngineBlox.sol";
-import "../../../../../interfaces/IDefinition.sol";
-
-/**
- * @title ERC20BloxDefinitions
- * @dev Definition library for ERC20Blox execution selectors (transfer, transferFrom, mint, burn, burnFrom).
- * Registers function schemas and role permissions so the GuardController can execute these functions
- * via time-lock and meta-transaction workflows. Handler permissions (executeWithTimeLock, etc.) are
- * defined in GuardControllerDefinitions.
- * @custom:security-contact security@particlecrypto.com
- */
-library ERC20BloxDefinitions {
-
-    // System macro selectors (allowed to target address(this) for GuardController execution)
-    bytes4 public constant TRANSFER_SELECTOR = bytes4(keccak256("transfer(address,uint256)"));
-    bytes4 public constant TRANSFER_FROM_SELECTOR = bytes4(keccak256("transferFrom(address,address,uint256)"));
-    bytes4 public constant MINT_SELECTOR = bytes4(keccak256("mint(address,uint256)"));
-    bytes4 public constant BURN_SELECTOR = bytes4(keccak256("burn(uint256)"));
-    bytes4 public constant BURN_FROM_SELECTOR = bytes4(keccak256("burnFrom(address,uint256)"));
-
-    bytes32 public constant ERC20_OPERATION = keccak256("ERC20_OPERATION");
-
-    /**
-     * @dev Returns function schemas for ERC20Blox execution selectors (used by controller).
-     */
-    function getFunctionSchemas() public pure returns (EngineBlox.FunctionSchema[] memory) {
-        EngineBlox.FunctionSchema[] memory schemas = new EngineBlox.FunctionSchema[](5);
-
-        EngineBlox.TxAction[] memory timeDelayRequestActions = new EngineBlox.TxAction[](1);
-        timeDelayRequestActions[0] = EngineBlox.TxAction.EXECUTE_TIME_DELAY_REQUEST;
-        EngineBlox.TxAction[] memory timeDelayApproveActions = new EngineBlox.TxAction[](1);
-        timeDelayApproveActions[0] = EngineBlox.TxAction.EXECUTE_TIME_DELAY_APPROVE;
-        EngineBlox.TxAction[] memory timeDelayCancelActions = new EngineBlox.TxAction[](1);
-        timeDelayCancelActions[0] = EngineBlox.TxAction.EXECUTE_TIME_DELAY_CANCEL;
-        EngineBlox.TxAction[] memory metaTxRequestApproveActions = new EngineBlox.TxAction[](2);
-        metaTxRequestApproveActions[0] = EngineBlox.TxAction.SIGN_META_REQUEST_AND_APPROVE;
-        metaTxRequestApproveActions[1] = EngineBlox.TxAction.EXECUTE_META_REQUEST_AND_APPROVE;
-        EngineBlox.TxAction[] memory metaTxApproveActions = new EngineBlox.TxAction[](2);
-        metaTxApproveActions[0] = EngineBlox.TxAction.SIGN_META_APPROVE;
-        metaTxApproveActions[1] = EngineBlox.TxAction.EXECUTE_META_APPROVE;
-        EngineBlox.TxAction[] memory metaTxCancelActions = new EngineBlox.TxAction[](2);
-        metaTxCancelActions[0] = EngineBlox.TxAction.SIGN_META_CANCEL;
-        metaTxCancelActions[1] = EngineBlox.TxAction.EXECUTE_META_CANCEL;
-
-        uint16 actionsBitmap = EngineBlox.createBitmapFromActions(timeDelayRequestActions)
-            | EngineBlox.createBitmapFromActions(timeDelayApproveActions)
-            | EngineBlox.createBitmapFromActions(timeDelayCancelActions)
-            | EngineBlox.createBitmapFromActions(metaTxRequestApproveActions)
-            | EngineBlox.createBitmapFromActions(metaTxApproveActions)
-            | EngineBlox.createBitmapFromActions(metaTxCancelActions);
-
-        bytes4[] memory transferHandlers = new bytes4[](1);
-        transferHandlers[0] = TRANSFER_SELECTOR;
-        bytes4[] memory transferFromHandlers = new bytes4[](1);
-        transferFromHandlers[0] = TRANSFER_FROM_SELECTOR;
-        bytes4[] memory mintHandlers = new bytes4[](1);
-        mintHandlers[0] = MINT_SELECTOR;
-        bytes4[] memory burnHandlers = new bytes4[](1);
-        burnHandlers[0] = BURN_SELECTOR;
-        bytes4[] memory burnFromHandlers = new bytes4[](1);
-        burnFromHandlers[0] = BURN_FROM_SELECTOR;
-
-        schemas[0] = EngineBlox.FunctionSchema({
-            functionSignature: "transfer(address,uint256)",
-            functionSelector: TRANSFER_SELECTOR,
-            operationType: ERC20_OPERATION,
-            operationName: "ERC20_TRANSFER",
-            supportedActionsBitmap: actionsBitmap,
-            isProtected: true,
-            handlerForSelectors: transferHandlers
-        });
-        schemas[1] = EngineBlox.FunctionSchema({
-            functionSignature: "transferFrom(address,address,uint256)",
-            functionSelector: TRANSFER_FROM_SELECTOR,
-            operationType: ERC20_OPERATION,
-            operationName: "ERC20_TRANSFER_FROM",
-            supportedActionsBitmap: actionsBitmap,
-            isProtected: true,
-            handlerForSelectors: transferFromHandlers
-        });
-        schemas[2] = EngineBlox.FunctionSchema({
-            functionSignature: "mint(address,uint256)",
-            functionSelector: MINT_SELECTOR,
-            operationType: ERC20_OPERATION,
-            operationName: "ERC20_MINT",
-            supportedActionsBitmap: actionsBitmap,
-            isProtected: true,
-            handlerForSelectors: mintHandlers
-        });
-        schemas[3] = EngineBlox.FunctionSchema({
-            functionSignature: "burn(uint256)",
-            functionSelector: BURN_SELECTOR,
-            operationType: ERC20_OPERATION,
-            operationName: "ERC20_BURN",
-            supportedActionsBitmap: actionsBitmap,
-            isProtected: true,
-            handlerForSelectors: burnHandlers
-        });
-        schemas[4] = EngineBlox.FunctionSchema({
-            functionSignature: "burnFrom(address,uint256)",
-            functionSelector: BURN_FROM_SELECTOR,
-            operationType: ERC20_OPERATION,
-            operationName: "ERC20_BURN_FROM",
-            supportedActionsBitmap: actionsBitmap,
-            isProtected: true,
-            handlerForSelectors: burnFromHandlers
-        });
-
-        return schemas;
-    }
-
-    /**
-     * @dev Returns role permissions for ERC20Blox execution selectors (OWNER and BROADCASTER).
-     */
-    function getRolePermissions() public pure returns (IDefinition.RolePermission memory) {
-        bytes32[] memory roleHashes = new bytes32[](10);
-        EngineBlox.FunctionPermission[] memory functionPermissions = new EngineBlox.FunctionPermission[](10);
-
-        EngineBlox.TxAction[] memory ownerTimeLockRequest = new EngineBlox.TxAction[](1);
-        ownerTimeLockRequest[0] = EngineBlox.TxAction.EXECUTE_TIME_DELAY_REQUEST;
-        EngineBlox.TxAction[] memory ownerTimeLockApprove = new EngineBlox.TxAction[](1);
-        ownerTimeLockApprove[0] = EngineBlox.TxAction.EXECUTE_TIME_DELAY_APPROVE;
-        EngineBlox.TxAction[] memory ownerTimeLockCancel = new EngineBlox.TxAction[](1);
-        ownerTimeLockCancel[0] = EngineBlox.TxAction.EXECUTE_TIME_DELAY_CANCEL;
-        EngineBlox.TxAction[] memory ownerMetaSign = new EngineBlox.TxAction[](1);
-        ownerMetaSign[0] = EngineBlox.TxAction.SIGN_META_REQUEST_AND_APPROVE;
-        EngineBlox.TxAction[] memory ownerMetaApprove = new EngineBlox.TxAction[](1);
-        ownerMetaApprove[0] = EngineBlox.TxAction.SIGN_META_APPROVE;
-        EngineBlox.TxAction[] memory ownerMetaCancel = new EngineBlox.TxAction[](1);
-        ownerMetaCancel[0] = EngineBlox.TxAction.SIGN_META_CANCEL;
-        EngineBlox.TxAction[] memory broadcasterMetaExec = new EngineBlox.TxAction[](1);
-        broadcasterMetaExec[0] = EngineBlox.TxAction.EXECUTE_META_REQUEST_AND_APPROVE;
-        EngineBlox.TxAction[] memory broadcasterMetaApprove = new EngineBlox.TxAction[](1);
-        broadcasterMetaApprove[0] = EngineBlox.TxAction.EXECUTE_META_APPROVE;
-        EngineBlox.TxAction[] memory broadcasterMetaCancel = new EngineBlox.TxAction[](1);
-        broadcasterMetaCancel[0] = EngineBlox.TxAction.EXECUTE_META_CANCEL;
-
-        uint16 ownerBitmap = EngineBlox.createBitmapFromActions(ownerTimeLockRequest)
-            | EngineBlox.createBitmapFromActions(ownerTimeLockApprove)
-            | EngineBlox.createBitmapFromActions(ownerTimeLockCancel)
-            | EngineBlox.createBitmapFromActions(ownerMetaSign)
-            | EngineBlox.createBitmapFromActions(ownerMetaApprove)
-            | EngineBlox.createBitmapFromActions(ownerMetaCancel);
-        uint16 broadcasterBitmap = EngineBlox.createBitmapFromActions(broadcasterMetaExec)
-            | EngineBlox.createBitmapFromActions(broadcasterMetaApprove)
-            | EngineBlox.createBitmapFromActions(broadcasterMetaCancel);
-
-        bytes4[5] memory selectors = [TRANSFER_SELECTOR, TRANSFER_FROM_SELECTOR, MINT_SELECTOR, BURN_SELECTOR, BURN_FROM_SELECTOR];
-        for (uint256 i = 0; i < 5; i++) {
-            bytes4[] memory selfRef = new bytes4[](1);
-            selfRef[0] = selectors[i];
-            roleHashes[i] = EngineBlox.OWNER_ROLE;
-            functionPermissions[i] = EngineBlox.FunctionPermission({
-                functionSelector: selectors[i],
-                grantedActionsBitmap: ownerBitmap,
-                handlerForSelectors: selfRef
-            });
-        }
-        for (uint256 i = 0; i < 5; i++) {
-            bytes4[] memory selfRef = new bytes4[](1);
-            selfRef[0] = selectors[i];
-            roleHashes[5 + i] = EngineBlox.BROADCASTER_ROLE;
-            functionPermissions[5 + i] = EngineBlox.FunctionPermission({
-                functionSelector: selectors[i],
-                grantedActionsBitmap: broadcasterBitmap,
-                handlerForSelectors: selfRef
-            });
-        }
-
-        return IDefinition.RolePermission({
-            roleHashes: roleHashes,
-            functionPermissions: functionPermissions
-        });
-    }
-
-    /**
-     * @dev ERC165: report support for IDefinition when this library is used at an address
-     */
-    function supportsInterface(bytes4 interfaceId) external pure returns (bool) {
-        return interfaceId == type(IDefinition).interfaceId;
-    }
-}

package/interfaces/IOnActionHook.sol

@@ -1,79 +0,0 @@
-// SPDX-License-Identifier: MPL-2.0
-pragma solidity 0.8.33;
-
-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 Implementations can choose which functions to support; unneeded ones can revert.
- */
-interface IOnActionHook {
-    /**
-     * @dev Called after a transaction request is created
-     * @param txRecord The created transaction record
-     * @param caller The address that initiated the request
-     */
-    function onRequest(
-        EngineBlox.TxRecord memory txRecord,
-        address caller
-    ) external;
-
-    /**
-     * @dev Called after a pending transaction is approved (time-lock flow)
-     * @param txRecord The updated transaction record
-     * @param caller The address that approved the transaction
-     */
-    function onApprove(
-        EngineBlox.TxRecord memory txRecord,
-        address caller
-    ) external;
-
-    /**
-     * @dev Called after a pending transaction is cancelled
-     * @param txRecord The updated transaction record
-     * @param caller The address that cancelled the transaction
-     */
-    function onCancel(
-        EngineBlox.TxRecord memory txRecord,
-        address caller
-    ) external;
-
-    /**
-     * @dev Called after a transaction is approved via meta-transaction
-     * @param txRecord The updated transaction record
-     * @param metaTx The meta-transaction used for approval
-     * @param caller The address executing the meta-transaction
-     */
-    function onMetaApprove(
-        EngineBlox.TxRecord memory txRecord,
-        EngineBlox.MetaTransaction memory metaTx,
-        address caller
-    ) external;
-
-    /**
-     * @dev Called after a transaction is cancelled via meta-transaction
-     * @param txRecord The updated transaction record
-     * @param metaTx The meta-transaction used for cancellation
-     * @param caller The address executing the meta-transaction
-     */
-    function onMetaCancel(
-        EngineBlox.TxRecord memory txRecord,
-        EngineBlox.MetaTransaction memory metaTx,
-        address caller
-    ) external;
-
-    /**
-     * @dev Called after a transaction is requested and approved in one step via meta-transaction
-     * @param txRecord The created + approved transaction record
-     * @param metaTx The meta-transaction used for the operation
-     * @param caller The address executing the meta-transaction
-     */
-    function onRequestAndApprove(
-        EngineBlox.TxRecord memory txRecord,
-        EngineBlox.MetaTransaction memory metaTx,
-        address caller
-    ) external;
-}