@bloxchain/contracts 1.0.0-alpha.7 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +8 -9
  3. package/abi/BaseStateMachine.abi.json +773 -822
  4. package/abi/EngineBlox.abi.json +562 -552
  5. package/abi/GuardController.abi.json +1597 -1609
  6. package/abi/GuardControllerDefinitions.abi.json +235 -199
  7. package/abi/IDefinition.abi.json +57 -47
  8. package/abi/RuntimeRBAC.abi.json +841 -842
  9. package/abi/RuntimeRBACDefinitions.abi.json +212 -202
  10. package/abi/SecureOwnable.abi.json +1365 -1349
  11. package/abi/SecureOwnableDefinitions.abi.json +174 -164
  12. package/core/AUDIT.md +45 -0
  13. package/core/access/RuntimeRBAC.sol +130 -61
  14. package/core/access/interface/IRuntimeRBAC.sol +3 -3
  15. package/core/access/lib/definitions/RuntimeRBACDefinitions.sol +7 -3
  16. package/core/base/BaseStateMachine.sol +971 -967
  17. package/core/base/interface/IBaseStateMachine.sol +153 -160
  18. package/core/execution/GuardController.sol +89 -75
  19. package/core/execution/interface/IGuardController.sol +146 -160
  20. package/core/execution/lib/definitions/GuardControllerDefinitions.sol +136 -25
  21. package/core/lib/EngineBlox.sol +577 -327
  22. package/core/lib/interfaces/IDefinition.sol +49 -49
  23. package/core/lib/interfaces/IEventForwarder.sol +4 -2
  24. package/core/lib/utils/SharedValidation.sol +534 -490
  25. package/core/pattern/Account.sol +84 -75
  26. package/core/security/SecureOwnable.sol +446 -390
  27. package/core/security/interface/ISecureOwnable.sol +105 -105
  28. package/core/security/lib/definitions/SecureOwnableDefinitions.sol +49 -17
  29. package/package.json +51 -49
  30. package/standards/behavior/ICopyable.sol +3 -11
  31. package/standards/hooks/IOnActionHook.sol +1 -1
  32. package/abi/AccountBlox.abi.json +0 -3935
  33. package/abi/BareBlox.abi.json +0 -1378
  34. package/abi/RoleBlox.abi.json +0 -2983
  35. package/abi/SecureBlox.abi.json +0 -2753
  36. package/abi/SimpleRWA20.abi.json +0 -4032
  37. package/abi/SimpleRWA20Definitions.abi.json +0 -191
  38. package/abi/SimpleVault.abi.json +0 -3407
  39. package/abi/SimpleVaultDefinitions.abi.json +0 -269
  40. package/core/research/BloxchainWallet.sol +0 -133
  41. package/core/research/FactoryBlox/FactoryBlox.sol +0 -343
  42. package/core/research/FactoryBlox/FactoryBloxDefinitions.sol +0 -143
  43. package/core/research/erc1155-blox/ERC1155Blox.sol +0 -169
  44. package/core/research/erc1155-blox/lib/definitions/ERC1155BloxDefinitions.sol +0 -203
  45. package/core/research/erc20-blox/ERC20Blox.sol +0 -167
  46. package/core/research/erc20-blox/lib/definitions/ERC20BloxDefinitions.sol +0 -185
  47. package/core/research/erc721-blox/ERC721Blox.sol +0 -131
  48. package/core/research/erc721-blox/lib/definitions/ERC721BloxDefinitions.sol +0 -172
  49. package/core/research/lending-blox/.gitkeep +0 -1
  50. package/core/research/p2p-blox/P2PBlox.sol +0 -266
  51. package/core/research/p2p-blox/README.md +0 -85
  52. package/core/research/p2p-blox/lib/definitions/P2PBloxDefinitions.sol +0 -19
@@ -1,390 +1,446 @@
1
- // SPDX-License-Identifier: MPL-2.0
2
- pragma solidity 0.8.33;
3
-
4
- // Contracts imports
5
- import "../base/BaseStateMachine.sol";
6
- import "./lib/definitions/SecureOwnableDefinitions.sol";
7
- import "../lib/interfaces/IDefinition.sol";
8
- import "../lib/utils/SharedValidation.sol";
9
- import "./interface/ISecureOwnable.sol";
10
-
11
- /**
12
- * @title SecureOwnable
13
- * @dev Security-focused contract extending BaseStateMachine with ownership management
14
- *
15
- * SecureOwnable provides security-specific functionality built on top of the base state machine:
16
- * - Multi-role security model with Owner, Broadcaster, and Recovery roles
17
- * - Secure ownership transfer with time-locked operations
18
- * - Broadcaster and recovery address management
19
- * - Time-lock period configuration
20
- *
21
- * The contract implements four primary secure operation types:
22
- * 1. OWNERSHIP_TRANSFER - For securely transferring contract ownership
23
- * 2. BROADCASTER_UPDATE - For changing the broadcaster address
24
- * 3. RECOVERY_UPDATE - For updating the recovery address
25
- * 4. TIMELOCK_UPDATE - For modifying the time lock period
26
- *
27
- * Each operation follows a request -> approval workflow with appropriate time locks
28
- * and authorization checks. Operations can be cancelled within specific time windows.
29
- *
30
- * At most one ownership-transfer or broadcaster-update request may be pending at a time:
31
- * a pending request of either type blocks new requests until it is approved or cancelled.
32
- *
33
- * This contract focuses purely on security logic while leveraging the BaseStateMachine
34
- * for transaction management, meta-transactions, and state machine operations.
35
- */
36
- abstract contract SecureOwnable is BaseStateMachine, ISecureOwnable {
37
- using SharedValidation for *;
38
-
39
- /// @dev True while any pending ownership transfer or broadcaster update request exists; blocks new requests until handled.
40
- bool private _hasOpenRequest;
41
-
42
- /**
43
- * @notice Initializer to initialize SecureOwnable state
44
- * @param initialOwner The initial owner address
45
- * @param broadcaster The broadcaster address
46
- * @param recovery The recovery address
47
- * @param timeLockPeriodSec The timelock period in seconds
48
- * @param eventForwarder The event forwarder address
49
- */
50
- function initialize(
51
- address initialOwner,
52
- address broadcaster,
53
- address recovery,
54
- uint256 timeLockPeriodSec,
55
- address eventForwarder
56
- ) public virtual onlyInitializing {
57
- // Initialize base state machine (only if not already initialized)
58
- if (!_secureState.initialized) {
59
- _initializeBaseStateMachine(initialOwner, broadcaster, recovery, timeLockPeriodSec, eventForwarder);
60
- }
61
-
62
- // Load SecureOwnable-specific definitions
63
- IDefinition.RolePermission memory secureOwnablePermissions = SecureOwnableDefinitions.getRolePermissions();
64
- _loadDefinitions(
65
- SecureOwnableDefinitions.getFunctionSchemas(),
66
- secureOwnablePermissions.roleHashes,
67
- secureOwnablePermissions.functionPermissions,
68
- true // Allow protected schemas for factory settings
69
- );
70
- }
71
-
72
- // ============ INTERFACE SUPPORT ============
73
-
74
- /**
75
- * @dev See {IERC165-supportsInterface}.
76
- * @notice Adds ISecureOwnable interface ID for component detection
77
- */
78
- function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
79
- return interfaceId == type(ISecureOwnable).interfaceId || super.supportsInterface(interfaceId);
80
- }
81
-
82
- // Ownership Management
83
- /**
84
- * @dev Requests a transfer of ownership
85
- * @return txId The transaction ID (use getTransaction(txId) for full record)
86
- */
87
- function transferOwnershipRequest() public returns (uint256 txId) {
88
- SharedValidation.validateRecovery(getRecovery());
89
- _requireNoPendingRequest();
90
-
91
- EngineBlox.TxRecord memory txRecord = _requestTransaction(
92
- msg.sender,
93
- address(this),
94
- 0, // value
95
- 0, // no gas limit
96
- SecureOwnableDefinitions.OWNERSHIP_TRANSFER,
97
- SecureOwnableDefinitions.TRANSFER_OWNERSHIP_SELECTOR,
98
- abi.encode(getRecovery())
99
- );
100
-
101
- _hasOpenRequest = true;
102
- _logComponentEvent(abi.encode(owner(), getRecovery()));
103
- return txRecord.txId;
104
- }
105
-
106
- /**
107
- * @dev Approves a pending ownership transfer transaction after the release time
108
- * @param txId The transaction ID
109
- * @return The transaction ID
110
- */
111
- function transferOwnershipDelayedApproval(uint256 txId) public returns (uint256) {
112
- SharedValidation.validateOwnerOrRecovery(owner(), getRecovery());
113
- return _completeApprove(_approveTransaction(txId));
114
- }
115
-
116
- /**
117
- * @dev Approves a pending ownership transfer transaction using a meta-transaction
118
- * @param metaTx The meta-transaction
119
- * @return The transaction ID
120
- */
121
- function transferOwnershipApprovalWithMetaTx(EngineBlox.MetaTransaction memory metaTx) public returns (uint256) {
122
- _validateBroadcasterAndOwnerSigner(metaTx);
123
- return _completeApprove(_approveTransactionWithMetaTx(metaTx));
124
- }
125
-
126
- /**
127
- * @dev Cancels a pending ownership transfer transaction
128
- * @param txId The transaction ID
129
- * @return The transaction ID
130
- */
131
- function transferOwnershipCancellation(uint256 txId) public returns (uint256) {
132
- SharedValidation.validateRecovery(getRecovery());
133
- return _completeCancel(_cancelTransaction(txId));
134
- }
135
-
136
- /**
137
- * @dev Cancels a pending ownership transfer transaction using a meta-transaction
138
- * @param metaTx The meta-transaction
139
- * @return The transaction ID
140
- */
141
- function transferOwnershipCancellationWithMetaTx(EngineBlox.MetaTransaction memory metaTx) public returns (uint256) {
142
- _validateBroadcasterAndOwnerSigner(metaTx);
143
- return _completeCancel(_cancelTransactionWithMetaTx(metaTx));
144
- }
145
-
146
- // Broadcaster Management
147
- /**
148
- * @dev Requests an update to the broadcaster at a specific location (index).
149
- * @param newBroadcaster The new broadcaster address (zero address to revoke at location)
150
- * @param location The index in the broadcaster role's authorized wallets set
151
- * @return txId The transaction ID for the pending request (use getTransaction(txId) for full record)
152
- */
153
- function updateBroadcasterRequest(address newBroadcaster, uint256 location) public returns (uint256 txId) {
154
- SharedValidation.validateOwner(owner());
155
- _requireNoPendingRequest();
156
-
157
- // Get the current broadcaster at the specified location. zero address if no broadcaster at location.
158
- address currentBroadcaster = location < _getSecureState().roles[EngineBlox.BROADCASTER_ROLE].walletCount
159
- ? _getAuthorizedWalletAt(EngineBlox.BROADCASTER_ROLE, location)
160
- : address(0);
161
-
162
- EngineBlox.TxRecord memory txRecord = _requestTransaction(
163
- msg.sender,
164
- address(this),
165
- 0, // value
166
- 0, // gas limit
167
- SecureOwnableDefinitions.BROADCASTER_UPDATE,
168
- SecureOwnableDefinitions.UPDATE_BROADCASTER_SELECTOR,
169
- abi.encode(newBroadcaster, location)
170
- );
171
-
172
- _hasOpenRequest = true;
173
- _logComponentEvent(abi.encode(currentBroadcaster, newBroadcaster));
174
- return txRecord.txId;
175
- }
176
-
177
- /**
178
- * @dev Approves a pending broadcaster update transaction after the release time
179
- * @param txId The transaction ID
180
- * @return The transaction ID
181
- */
182
- function updateBroadcasterDelayedApproval(uint256 txId) public returns (uint256) {
183
- SharedValidation.validateOwner(owner());
184
- return _completeApprove(_approveTransaction(txId));
185
- }
186
-
187
- /**
188
- * @dev Approves a pending broadcaster update transaction using a meta-transaction
189
- * @param metaTx The meta-transaction
190
- * @return The transaction ID
191
- */
192
- function updateBroadcasterApprovalWithMetaTx(EngineBlox.MetaTransaction memory metaTx) public returns (uint256) {
193
- _validateBroadcasterAndOwnerSigner(metaTx);
194
- return _completeApprove(_approveTransactionWithMetaTx(metaTx));
195
- }
196
-
197
- /**
198
- * @dev Cancels a pending broadcaster update transaction
199
- * @param txId The transaction ID
200
- * @return The transaction ID
201
- */
202
- function updateBroadcasterCancellation(uint256 txId) public returns (uint256) {
203
- SharedValidation.validateOwner(owner());
204
- return _completeCancel(_cancelTransaction(txId));
205
- }
206
-
207
- /**
208
- * @dev Cancels a pending broadcaster update transaction using a meta-transaction
209
- * @param metaTx The meta-transaction
210
- * @return The transaction ID
211
- */
212
- function updateBroadcasterCancellationWithMetaTx(EngineBlox.MetaTransaction memory metaTx) public returns (uint256) {
213
- _validateBroadcasterAndOwnerSigner(metaTx);
214
- return _completeCancel(_cancelTransactionWithMetaTx(metaTx));
215
- }
216
-
217
- // Recovery Management
218
-
219
- /**
220
- * @dev Requests and approves a recovery address update using a meta-transaction
221
- * @param metaTx The meta-transaction
222
- * @return The transaction ID
223
- */
224
- function updateRecoveryRequestAndApprove(
225
- EngineBlox.MetaTransaction memory metaTx
226
- ) public returns (uint256) {
227
- _validateBroadcasterAndOwnerSigner(metaTx);
228
- EngineBlox.TxRecord memory txRecord = _requestAndApproveTransaction(metaTx);
229
- return txRecord.txId;
230
- }
231
-
232
- // TimeLock Management
233
-
234
- /**
235
- * @dev Requests and approves a time lock period update using a meta-transaction
236
- * @param metaTx The meta-transaction
237
- * @return The transaction ID
238
- */
239
- function updateTimeLockRequestAndApprove(
240
- EngineBlox.MetaTransaction memory metaTx
241
- ) public returns (uint256) {
242
- _validateBroadcasterAndOwnerSigner(metaTx);
243
- EngineBlox.TxRecord memory txRecord = _requestAndApproveTransaction(metaTx);
244
- return txRecord.txId;
245
- }
246
-
247
- // Execution Functions
248
- /**
249
- * @dev External function that can only be called by the contract itself to execute ownership transfer
250
- * @param newOwner The new owner address
251
- */
252
- function executeTransferOwnership(address newOwner) external {
253
- _validateExecuteBySelf();
254
- _transferOwnership(newOwner);
255
- }
256
-
257
- /**
258
- * @dev External function that can only be called by the contract itself to execute broadcaster update
259
- * @param newBroadcaster The new broadcaster address (zero address to revoke at location)
260
- * @param location The index in the broadcaster role's authorized wallets set
261
- */
262
- function executeBroadcasterUpdate(address newBroadcaster, uint256 location) external {
263
- _validateExecuteBySelf();
264
- _updateBroadcaster(newBroadcaster, location);
265
- }
266
-
267
- /**
268
- * @dev External function that can only be called by the contract itself to execute recovery update
269
- * @param newRecoveryAddress The new recovery address
270
- */
271
- function executeRecoveryUpdate(address newRecoveryAddress) external {
272
- _validateExecuteBySelf();
273
- _updateRecoveryAddress(newRecoveryAddress);
274
- }
275
-
276
- /**
277
- * @dev External function that can only be called by the contract itself to execute timelock update
278
- * @param newTimeLockPeriodSec The new timelock period in seconds
279
- */
280
- function executeTimeLockUpdate(uint256 newTimeLockPeriodSec) external {
281
- _validateExecuteBySelf();
282
- _updateTimeLockPeriod(newTimeLockPeriodSec);
283
- }
284
-
285
- // ============ INTERNAL FUNCTIONS ============
286
-
287
- /**
288
- * @dev Reverts if an ownership-transfer or broadcaster-update request is already pending.
289
- */
290
- function _requireNoPendingRequest() internal view {
291
- if (_hasOpenRequest) revert SharedValidation.PendingSecureRequest();
292
- }
293
-
294
- /**
295
- * @dev Validates that the caller is the broadcaster and that the meta-tx signer is the owner.
296
- * @param metaTx The meta-transaction to validate
297
- */
298
- function _validateBroadcasterAndOwnerSigner(EngineBlox.MetaTransaction memory metaTx) internal view {
299
- _validateBroadcaster(msg.sender);
300
- SharedValidation.validateOwnerIsSigner(metaTx.params.signer, owner());
301
- }
302
-
303
- /**
304
- * @dev Completes ownership/broadcaster flow after approval: resets flag and returns txId.
305
- * @param updatedRecord The updated transaction record from approval
306
- * @return txId The transaction ID
307
- */
308
- function _completeApprove(EngineBlox.TxRecord memory updatedRecord) internal returns (uint256 txId) {
309
- _hasOpenRequest = false;
310
- return updatedRecord.txId;
311
- }
312
-
313
- /**
314
- * @dev Completes ownership/broadcaster flow after cancellation: resets flag, logs txId, returns txId.
315
- * @param updatedRecord The updated transaction record from cancellation
316
- * @return txId The transaction ID
317
- */
318
- function _completeCancel(EngineBlox.TxRecord memory updatedRecord) internal returns (uint256 txId) {
319
- _hasOpenRequest = false;
320
- _logComponentEvent(abi.encode(updatedRecord.txId));
321
- return updatedRecord.txId;
322
- }
323
-
324
- /**
325
- * @dev Transfers ownership of the contract
326
- * @param newOwner The new owner of the contract
327
- */
328
- function _transferOwnership(address newOwner) internal virtual {
329
- address oldOwner = owner();
330
- _updateAssignedWallet(EngineBlox.OWNER_ROLE, newOwner, oldOwner);
331
- _logComponentEvent(abi.encode(oldOwner, newOwner));
332
- }
333
-
334
- /**
335
- * @dev Updates the broadcaster role at a specific index (location)
336
- * @param newBroadcaster The new broadcaster address (zero address to revoke)
337
- * @param location The index in the broadcaster role's authorized wallets set
338
- *
339
- * Logic:
340
- * - If a broadcaster exists at `location` and `newBroadcaster` is non-zero,
341
- * update that slot from old to new (role remains full).
342
- * - If no broadcaster exists at `location` and `newBroadcaster` is non-zero,
343
- * assign `newBroadcaster` to the broadcaster role (respecting maxWallets).
344
- * - If `newBroadcaster` is the zero address and a broadcaster exists at `location`,
345
- * revoke that broadcaster from the role.
346
- */
347
- function _updateBroadcaster(address newBroadcaster, uint256 location) internal virtual {
348
- EngineBlox.Role storage role = _getSecureState().roles[EngineBlox.BROADCASTER_ROLE];
349
-
350
- address oldBroadcaster;
351
- uint256 length = role.walletCount;
352
-
353
- if (location < length) {
354
- oldBroadcaster = _getAuthorizedWalletAt(EngineBlox.BROADCASTER_ROLE, location);
355
- } else {
356
- oldBroadcaster = address(0);
357
- }
358
-
359
- // Case 1: Revoke existing broadcaster at location
360
- if (newBroadcaster == address(0)) {
361
- if (oldBroadcaster != address(0)) {
362
- _revokeWallet(EngineBlox.BROADCASTER_ROLE, oldBroadcaster);
363
- _logComponentEvent(abi.encode(oldBroadcaster, address(0)));
364
- }
365
- return;
366
- }
367
-
368
- // Case 2: Update existing broadcaster at location
369
- if (oldBroadcaster != address(0)) {
370
- _updateAssignedWallet(EngineBlox.BROADCASTER_ROLE, newBroadcaster, oldBroadcaster);
371
- _logComponentEvent(abi.encode(oldBroadcaster, newBroadcaster));
372
- return;
373
- }
374
-
375
- // Case 3: No broadcaster at location, assign a new one (will respect maxWallets)
376
- _assignWallet(EngineBlox.BROADCASTER_ROLE, newBroadcaster);
377
- _logComponentEvent(abi.encode(address(0), newBroadcaster));
378
- }
379
-
380
- /**
381
- * @dev Updates the recovery address
382
- * @param newRecoveryAddress The new recovery address
383
- */
384
- function _updateRecoveryAddress(address newRecoveryAddress) internal virtual {
385
- address oldRecovery = getRecovery();
386
- _updateAssignedWallet(EngineBlox.RECOVERY_ROLE, newRecoveryAddress, oldRecovery);
387
- _logComponentEvent(abi.encode(oldRecovery, newRecoveryAddress));
388
- }
389
-
390
- }
1
+ // SPDX-License-Identifier: MPL-2.0
2
+ pragma solidity 0.8.35;
3
+
4
+ // Contracts imports
5
+ import "../base/BaseStateMachine.sol";
6
+ import "./lib/definitions/SecureOwnableDefinitions.sol";
7
+ import "../lib/interfaces/IDefinition.sol";
8
+ import "../lib/utils/SharedValidation.sol";
9
+ import "./interface/ISecureOwnable.sol";
10
+
11
+ /**
12
+ * @title SecureOwnable
13
+ * @dev Security-focused contract extending BaseStateMachine with ownership management
14
+ *
15
+ * SecureOwnable provides security-specific functionality built on top of the base state machine:
16
+ * - Multi-role security model with Owner, Broadcaster, and Recovery roles
17
+ * - Secure ownership transfer with time-locked operations
18
+ * - Broadcaster and recovery address management
19
+ * - Time-lock period configuration
20
+ *
21
+ * The contract implements four primary secure operation types:
22
+ * 1. OWNERSHIP_TRANSFER - For securely transferring contract ownership
23
+ * 2. BROADCASTER_UPDATE - For changing the broadcaster address
24
+ * 3. RECOVERY_UPDATE - For updating the recovery address
25
+ * 4. TIMELOCK_UPDATE - For modifying the time lock period
26
+ *
27
+ * Each operation follows a request -> approval workflow with appropriate time locks
28
+ * and authorization checks. Operations can be cancelled within specific time windows.
29
+ *
30
+ * Pending secure requests use separate flags for ownership transfer and broadcaster update.
31
+ * A new ownership-transfer request is allowed if no ownership transfer is already pending
32
+ * (a broadcaster update may still be pending). A new broadcaster-update request is allowed only
33
+ * when neither type has a pending request.
34
+ *
35
+ * **Ownership transfer vs recovery (threat model):**
36
+ * - `transferOwnershipRequest` snapshots `getRecovery()` into the pending tx `executionParams`. On execution,
37
+ * `executeTransferOwnership` receives that snapshotted address as the new owner. Rotating recovery after
38
+ * the request does **not** rewrite the pending payload; the beneficiary remains the recovery address
39
+ * at request time.
40
+ * - `transferOwnershipDelayedApproval` authorizes the **current** owner or **current** recovery (`getRecovery()`
41
+ * at approval time). It does **not** require the approver to match the snapshotted beneficiary. Integrators
42
+ * must treat approval as consent to execute the **stored** transfer, not “transfer to whoever is recovery now.”
43
+ * - `transferOwnershipCancellation` allows only the **current** recovery to cancel. If owner and broadcaster
44
+ * rotate recovery via `updateRecoveryRequestAndApprove` while a transfer is pending, the **previous**
45
+ * recovery loses cancel rights immediately; the pending tx still targets the old address until approved,
46
+ * cancelled by the new recovery, or superseded operationally.
47
+ * - Recovery and timelock updates use a request-and-approve meta-tx path without an additional timelock and
48
+ * are **not** blocked when an ownership transfer is pending (unlike broadcaster update requests). This is
49
+ * intentional: fast recovery rotation when owner and broadcaster still cooperate; operators who need a
50
+ * strict “recovery cannot change during pending ownership transfer” invariant must enforce it off-chain or
51
+ * extend this contract.
52
+ *
53
+ * This contract focuses purely on security logic while leveraging the BaseStateMachine
54
+ * for transaction management, meta-transactions, and state machine operations.
55
+ */
56
+ abstract contract SecureOwnable is BaseStateMachine, ISecureOwnable {
57
+ using SharedValidation for *;
58
+
59
+ /// @dev Lane flags for **delayed** ownership-transfer and broadcaster-update requests only (`transferOwnershipRequest`,
60
+ /// `updateBroadcasterRequest`). Recovery and timelock updates use `_requestAndApproveTransaction` and do **not**
61
+ /// read or write these booleans. Each flag is set only after a successful `_requestTransaction` in that same tx;
62
+ /// clearing happens only in `_completeApprove` / `_completeCancel` in the **same** transaction as a successful
63
+ /// `_approveTransaction` / `_cancelTransaction`, so a revert unwinds engine state and flag writes together.
64
+ /// @dev Upgrading from legacy `_hasOpenRequest` / `_pendingBits` requires no pending requests.
65
+ bool private _hasOpenOwnershipRequest;
66
+ bool private _hasOpenBroadcasterRequest;
67
+
68
+ /**
69
+ * @notice Initializer to initialize SecureOwnable state
70
+ * @param initialOwner The initial owner address
71
+ * @param broadcaster The broadcaster address
72
+ * @param recovery The recovery address
73
+ * @param timeLockPeriodSec The timelock period in seconds
74
+ * @param eventForwarder The event forwarder address
75
+ */
76
+ function initialize(
77
+ address initialOwner,
78
+ address broadcaster,
79
+ address recovery,
80
+ uint256 timeLockPeriodSec,
81
+ address eventForwarder
82
+ ) public virtual onlyInitializing {
83
+ _initializeBaseStateMachine(initialOwner, broadcaster, recovery, timeLockPeriodSec, eventForwarder);
84
+
85
+ // Load SecureOwnable-specific definitions
86
+ IDefinition.RolePermission memory secureOwnablePermissions = SecureOwnableDefinitions.getRolePermissions();
87
+ _loadDefinitions(
88
+ SecureOwnableDefinitions.getFunctionSchemas(),
89
+ secureOwnablePermissions.roleHashes,
90
+ secureOwnablePermissions.functionPermissions,
91
+ true // Enforce all function schemas are protected
92
+ );
93
+ }
94
+
95
+ // ============ INTERFACE SUPPORT ============
96
+
97
+ /**
98
+ * @dev See {IERC165-supportsInterface}.
99
+ * @notice Adds ISecureOwnable interface ID for component detection
100
+ */
101
+ function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
102
+ return interfaceId == type(ISecureOwnable).interfaceId || super.supportsInterface(interfaceId);
103
+ }
104
+
105
+ // Ownership Management
106
+ /**
107
+ * @dev Requests a time-delayed transfer of the OWNER role to the **recovery address at request time**.
108
+ * @notice Encodes `getRecovery()` into `executionParams`; that address becomes the new owner on successful
109
+ * execution. Changing recovery later does not update this pending record.
110
+ * @return txId The transaction ID (use getTransaction(txId) for full record)
111
+ */
112
+ function transferOwnershipRequest() public returns (uint256 txId) {
113
+ SharedValidation.validateRecovery(getRecovery());
114
+ _requireNoPendingRequest(SecureOwnableDefinitions.OWNERSHIP_TRANSFER);
115
+
116
+ EngineBlox.TxRecord memory txRecord = _requestTransaction(
117
+ msg.sender,
118
+ address(this),
119
+ 0, // value
120
+ 0, // no gas limit
121
+ SecureOwnableDefinitions.OWNERSHIP_TRANSFER,
122
+ SecureOwnableDefinitions.TRANSFER_OWNERSHIP_SELECTOR,
123
+ abi.encode(getRecovery())
124
+ );
125
+
126
+ _hasOpenOwnershipRequest = true;
127
+ _logAddressPairEvent(owner(), getRecovery());
128
+ return txRecord.txId;
129
+ }
130
+
131
+ /**
132
+ * @dev Approves a pending ownership transfer after `releaseTime` (timelock on the direct path).
133
+ * @notice Callable by **current** owner or **current** recovery. Execution still transfers ownership to
134
+ * the address snapshotted at request time, which may differ from `getRecovery()` at approval time.
135
+ * @param txId The transaction ID
136
+ * @return The transaction ID
137
+ */
138
+ function transferOwnershipDelayedApproval(uint256 txId) public returns (uint256) {
139
+ SharedValidation.validateOwnerOrRecovery(owner(), getRecovery());
140
+ return _completeApprove(_approveTransaction(txId));
141
+ }
142
+
143
+ /**
144
+ * @dev Approves a pending ownership transfer transaction using a meta-transaction
145
+ * @param metaTx The meta-transaction
146
+ * @return The transaction ID
147
+ */
148
+ function transferOwnershipApprovalWithMetaTx(EngineBlox.MetaTransaction memory metaTx) public returns (uint256) {
149
+ _validateBroadcasterAndOwnerSigner(metaTx);
150
+ return _completeApprove(_approveTransactionWithMetaTx(metaTx));
151
+ }
152
+
153
+ /**
154
+ * @dev Cancels a pending ownership transfer transaction.
155
+ * @notice Only the **current** `getRecovery()` may cancel. After a recovery rotation, the prior recovery
156
+ * address can no longer cancel.
157
+ * @param txId The transaction ID
158
+ * @return The transaction ID
159
+ */
160
+ function transferOwnershipCancellation(uint256 txId) public returns (uint256) {
161
+ SharedValidation.validateRecovery(getRecovery());
162
+ return _completeCancel(_cancelTransaction(txId));
163
+ }
164
+
165
+ /**
166
+ * @dev Cancels a pending ownership transfer transaction using a meta-transaction
167
+ * @param metaTx The meta-transaction
168
+ * @return The transaction ID
169
+ */
170
+ function transferOwnershipCancellationWithMetaTx(EngineBlox.MetaTransaction memory metaTx) public returns (uint256) {
171
+ _validateBroadcasterAndOwnerSigner(metaTx);
172
+ return _completeCancel(_cancelTransactionWithMetaTx(metaTx));
173
+ }
174
+
175
+ // Broadcaster Management
176
+ /**
177
+ * @dev Requests a broadcaster role change identified by addresses.
178
+ * @notice Requires no pending broadcaster-update and no pending ownership-transfer request.
179
+ * @param newBroadcaster New broadcaster (`address(0)` to revoke `currentBroadcaster`)
180
+ * @param currentBroadcaster Existing broadcaster to replace or revoke; `address(0)` to add `newBroadcaster`
181
+ * @return txId The transaction ID for the pending request (use getTransaction(txId) for full record)
182
+ */
183
+ function updateBroadcasterRequest(address newBroadcaster, address currentBroadcaster) public returns (uint256 txId) {
184
+ SharedValidation.validateOwner(owner());
185
+ _requireNoPendingRequest(SecureOwnableDefinitions.BROADCASTER_UPDATE);
186
+ _requireNoPendingRequest(SecureOwnableDefinitions.OWNERSHIP_TRANSFER);
187
+
188
+ _validateBroadcasterUpdatePair(newBroadcaster, currentBroadcaster);
189
+
190
+ EngineBlox.TxRecord memory txRecord = _requestTransaction(
191
+ msg.sender,
192
+ address(this),
193
+ 0, // value
194
+ 0, // gas limit
195
+ SecureOwnableDefinitions.BROADCASTER_UPDATE,
196
+ SecureOwnableDefinitions.UPDATE_BROADCASTER_SELECTOR,
197
+ abi.encode(newBroadcaster, currentBroadcaster)
198
+ );
199
+
200
+ _hasOpenBroadcasterRequest = true;
201
+ _logAddressPairEvent(currentBroadcaster, newBroadcaster);
202
+ return txRecord.txId;
203
+ }
204
+
205
+ /**
206
+ * @dev Approves a pending broadcaster update transaction after the release time
207
+ * @param txId The transaction ID
208
+ * @return The transaction ID
209
+ */
210
+ function updateBroadcasterDelayedApproval(uint256 txId) public returns (uint256) {
211
+ SharedValidation.validateOwner(owner());
212
+ return _completeApprove(_approveTransaction(txId));
213
+ }
214
+
215
+ /**
216
+ * @dev Approves a pending broadcaster update transaction using a meta-transaction
217
+ * @param metaTx The meta-transaction
218
+ * @return The transaction ID
219
+ */
220
+ function updateBroadcasterApprovalWithMetaTx(EngineBlox.MetaTransaction memory metaTx) public returns (uint256) {
221
+ _validateBroadcasterAndOwnerSigner(metaTx);
222
+ return _completeApprove(_approveTransactionWithMetaTx(metaTx));
223
+ }
224
+
225
+ /**
226
+ * @dev Cancels a pending broadcaster update transaction
227
+ * @param txId The transaction ID
228
+ * @return The transaction ID
229
+ */
230
+ function updateBroadcasterCancellation(uint256 txId) public returns (uint256) {
231
+ SharedValidation.validateOwner(owner());
232
+ return _completeCancel(_cancelTransaction(txId));
233
+ }
234
+
235
+ /**
236
+ * @dev Cancels a pending broadcaster update transaction using a meta-transaction
237
+ * @param metaTx The meta-transaction
238
+ * @return The transaction ID
239
+ */
240
+ function updateBroadcasterCancellationWithMetaTx(EngineBlox.MetaTransaction memory metaTx) public returns (uint256) {
241
+ _validateBroadcasterAndOwnerSigner(metaTx);
242
+ return _completeCancel(_cancelTransactionWithMetaTx(metaTx));
243
+ }
244
+
245
+ // Recovery Management
246
+
247
+ /**
248
+ * @dev Requests and approves a recovery address update using a meta-transaction (owner signs, broadcaster submits).
249
+ * @notice Does **not** revert when an ownership transfer is pending. A pending transfer continues to target
250
+ * the recovery address snapshotted at its request until executed or cancelled by **current** recovery.
251
+ * @param metaTx The meta-transaction
252
+ * @return The transaction ID
253
+ */
254
+ function updateRecoveryRequestAndApprove(
255
+ EngineBlox.MetaTransaction memory metaTx
256
+ ) public returns (uint256) {
257
+ _validateBroadcasterAndOwnerSigner(metaTx);
258
+ EngineBlox.TxRecord memory txRecord = _requestAndApproveTransaction(metaTx);
259
+ return txRecord.txId;
260
+ }
261
+
262
+ // TimeLock Management
263
+
264
+ /**
265
+ * @dev Requests and approves a time lock period update using a meta-transaction
266
+ * @param metaTx The meta-transaction
267
+ * @return The transaction ID
268
+ */
269
+ function updateTimeLockRequestAndApprove(
270
+ EngineBlox.MetaTransaction memory metaTx
271
+ ) public returns (uint256) {
272
+ _validateBroadcasterAndOwnerSigner(metaTx);
273
+ EngineBlox.TxRecord memory txRecord = _requestAndApproveTransaction(metaTx);
274
+ return txRecord.txId;
275
+ }
276
+
277
+ // Execution Functions
278
+ /**
279
+ * @dev External function that can only be called by the contract itself to execute ownership transfer.
280
+ * @param newOwner The new owner; for the OWNERSHIP_TRANSFER flow this is the recovery address encoded at
281
+ * request time (see `transferOwnershipRequest`), not necessarily `getRecovery()` at execution time.
282
+ */
283
+ function executeTransferOwnership(address newOwner) external {
284
+ _validateExecuteBySelf();
285
+ _transferOwnership(newOwner);
286
+ }
287
+
288
+ /**
289
+ * @dev External function that can only be called by the contract itself to execute broadcaster update
290
+ * @param newBroadcaster New broadcaster (`address(0)` to revoke `currentBroadcaster`)
291
+ * @param currentBroadcaster Existing broadcaster to replace or revoke; `address(0)` to add `newBroadcaster`
292
+ */
293
+ function executeBroadcasterUpdate(address newBroadcaster, address currentBroadcaster) external {
294
+ _validateExecuteBySelf();
295
+ _updateBroadcaster(newBroadcaster, currentBroadcaster);
296
+ }
297
+
298
+ /**
299
+ * @dev External function that can only be called by the contract itself to execute recovery update
300
+ * @param newRecoveryAddress The new recovery address
301
+ */
302
+ function executeRecoveryUpdate(address newRecoveryAddress) external {
303
+ _validateExecuteBySelf();
304
+ _updateRecoveryAddress(newRecoveryAddress);
305
+ }
306
+
307
+ /**
308
+ * @dev External function that can only be called by the contract itself to execute timelock update
309
+ * @param newTimeLockPeriodSec The new timelock period in seconds
310
+ */
311
+ function executeTimeLockUpdate(uint256 newTimeLockPeriodSec) external {
312
+ _validateExecuteBySelf();
313
+ _updateTimeLockPeriod(newTimeLockPeriodSec);
314
+ }
315
+
316
+ // ============ INTERNAL FUNCTIONS ============
317
+
318
+
319
+ /**
320
+ * @dev Validates that the caller is the broadcaster and that the meta-tx signer is the owner.
321
+ * @param metaTx The meta-transaction to validate
322
+ */
323
+ function _validateBroadcasterAndOwnerSigner(EngineBlox.MetaTransaction memory metaTx) internal view {
324
+ _validateBroadcaster(msg.sender);
325
+ SharedValidation.validateOwnerIsSigner(metaTx.params.signer, owner());
326
+ }
327
+
328
+ /**
329
+ * @dev Completes ownership/broadcaster flow after approval: clears the matching pending flag and returns txId.
330
+ * @param updatedRecord The updated transaction record from approval
331
+ * @return txId The transaction ID
332
+ */
333
+ function _completeApprove(EngineBlox.TxRecord memory updatedRecord) internal returns (uint256 txId) {
334
+ _clearPendingFlagForOperation(updatedRecord.params.operationType);
335
+ return updatedRecord.txId;
336
+ }
337
+
338
+ /**
339
+ * @dev Completes ownership/broadcaster flow after cancellation: clears the matching pending flag and returns txId.
340
+ * @param updatedRecord The updated transaction record from cancellation
341
+ * @return txId The transaction ID
342
+ */
343
+ function _completeCancel(EngineBlox.TxRecord memory updatedRecord) internal returns (uint256 txId) {
344
+ _clearPendingFlagForOperation(updatedRecord.params.operationType);
345
+ return updatedRecord.txId;
346
+ }
347
+
348
+ /**
349
+ * @dev Reverts if the pending flag for `requestOperationType` is already set (one lane per call).
350
+ * `OWNERSHIP_TRANSFER` checks only `_hasOpenOwnershipRequest` (a broadcaster update may still be pending).
351
+ * `BROADCASTER_UPDATE` checks only `_hasOpenBroadcasterRequest`. Callers that need both lanes idle
352
+ * (e.g. `updateBroadcasterRequest`) invoke this once per operation type.
353
+ * @param requestOperationType Lane to validate (`OWNERSHIP_TRANSFER` or `BROADCASTER_UPDATE`).
354
+ */
355
+ function _requireNoPendingRequest(bytes32 requestOperationType) internal view {
356
+ if (requestOperationType == SecureOwnableDefinitions.OWNERSHIP_TRANSFER) {
357
+ if (_hasOpenOwnershipRequest) revert SharedValidation.PendingSecureRequest();
358
+ } else if (requestOperationType == SecureOwnableDefinitions.BROADCASTER_UPDATE) {
359
+ if (_hasOpenBroadcasterRequest) revert SharedValidation.PendingSecureRequest();
360
+ } else {
361
+ revert();
362
+ }
363
+ }
364
+
365
+ /**
366
+ * @dev Clears the pending flag for a completed or cancelled secure op (approve/cancel paths).
367
+ * @param operationType The tx record's `operationType` (`OWNERSHIP_TRANSFER` or `BROADCASTER_UPDATE`).
368
+ */
369
+ function _clearPendingFlagForOperation(bytes32 operationType) private {
370
+ if (operationType == SecureOwnableDefinitions.OWNERSHIP_TRANSFER) {
371
+ _hasOpenOwnershipRequest = false;
372
+ } else if (operationType == SecureOwnableDefinitions.BROADCASTER_UPDATE) {
373
+ _hasOpenBroadcasterRequest = false;
374
+ } else {
375
+ revert();
376
+ }
377
+ }
378
+
379
+ /**
380
+ * @dev Transfers ownership of the contract
381
+ * @param newOwner The new owner of the contract
382
+ */
383
+ function _transferOwnership(address newOwner) internal virtual {
384
+ address oldOwner = owner();
385
+ _updateWallet(EngineBlox.OWNER_ROLE, newOwner, oldOwner);
386
+ _logAddressPairEvent(oldOwner, newOwner);
387
+ }
388
+
389
+ /**
390
+ * @dev Validates broadcaster update pair at request time.
391
+ * @param newBroadcaster New broadcaster (`address(0)` to revoke)
392
+ * @param currentBroadcaster Existing broadcaster; `address(0)` to add `newBroadcaster`
393
+ */
394
+ function _validateBroadcasterUpdatePair(address newBroadcaster, address currentBroadcaster) internal view {
395
+ if (newBroadcaster == address(0) && currentBroadcaster == address(0)) {
396
+ revert SharedValidation.InvalidOperation(address(0));
397
+ }
398
+ bytes32 role = EngineBlox.BROADCASTER_ROLE;
399
+ if (currentBroadcaster != address(0)) {
400
+ if (!hasRole(role, currentBroadcaster)) revert SharedValidation.ItemNotFound(currentBroadcaster);
401
+ }
402
+ if (newBroadcaster != address(0)) {
403
+ if (hasRole(role, newBroadcaster)) revert SharedValidation.ItemAlreadyExists(newBroadcaster);
404
+ }
405
+ }
406
+
407
+ /**
408
+ * @dev Updates the broadcaster role by address pair (revoke, replace, or add).
409
+ * @param newBroadcaster New broadcaster (`address(0)` to revoke `currentBroadcaster`)
410
+ * @param currentBroadcaster Existing broadcaster; `address(0)` to add `newBroadcaster`
411
+ */
412
+ function _updateBroadcaster(address newBroadcaster, address currentBroadcaster) internal virtual {
413
+ bytes32 role = EngineBlox.BROADCASTER_ROLE;
414
+ if (newBroadcaster == address(0)) {
415
+ _revokeWallet(role, currentBroadcaster);
416
+ _logAddressPairEvent(currentBroadcaster, address(0));
417
+ return;
418
+ }
419
+ if (currentBroadcaster == address(0)) {
420
+ _assignWallet(role, newBroadcaster);
421
+ _logAddressPairEvent(address(0), newBroadcaster);
422
+ return;
423
+ }
424
+ _updateWallet(role, newBroadcaster, currentBroadcaster);
425
+ _logAddressPairEvent(currentBroadcaster, newBroadcaster);
426
+ }
427
+
428
+ /**
429
+ * @dev Updates the recovery address
430
+ * @param newRecoveryAddress The new recovery address
431
+ */
432
+ function _updateRecoveryAddress(address newRecoveryAddress) internal virtual {
433
+ address oldRecovery = getRecovery();
434
+ _updateWallet(EngineBlox.RECOVERY_ROLE, newRecoveryAddress, oldRecovery);
435
+ _logAddressPairEvent(oldRecovery, newRecoveryAddress);
436
+ }
437
+
438
+ /**
439
+ * @dev Emits ComponentEvent with ABI-encoded (address, address) payload. Reused to reduce contract size.
440
+ * @param a First address
441
+ * @param b Second address
442
+ */
443
+ function _logAddressPairEvent(address a, address b) internal {
444
+ _logComponentEvent(abi.encode(a, b));
445
+ }
446
+ }