[Cairo] Support AccessControlDefaultAdminRules

.changeset/sixty-turkeys-pay.md

@@ -0,0 +1,5 @@
+---
+'@openzeppelin/wizard-common': patch
+---
+
+Add AI descriptions for AccessControl in Cairo-alpha

.github/workflows/compile-cairo-alpha-project.yml

@@ -47,15 +47,31 @@ jobs:
           set -e
 
           declare -a all_kinds=("ERC20" "ERC721" "ERC1155" "Account" "Multisig" "Governor" "Vesting" "Custom")
-          declare -a all_royalty_info_options=("disabled" "enabled_default" "enabled_custom")
+          declare -a all_access_options=("disabled" "ownable" "roles" "roles-dar-default" "roles-dar-custom")
+          declare -a all_royalty_options=("disabled" "enabled-default" "enabled-custom")
           for kind in "${all_kinds[@]}"; do
             scarb clean
 
             if [[ "$kind" == "ERC721" || "$kind" == "ERC1155" ]]; then
-              for royalty_info_option in "${all_royalty_info_options[@]}"; do
-                proj_name="'$kind (royalty info: $royalty_info_option)' test project"
+              for access_option in "${all_access_options[@]}"; do
+                for royalty_option in "${all_royalty_options[@]}"; do
+                  proj_name="'$kind, access: $access_option, royalty: $royalty_option' test project"
+                  echo "Generating $proj_name..."
+                  yarn run update_scarb_project --kind=$kind --access=$access_option --royalty=$royalty_option
+
+                  echo "Compiling $proj_name..."
+                  scarb build
+
+                  echo "✅ Compiled $proj_name!"
+                  echo "---------------------------------"
+                done
+              done
+
+            elif [[ "$kind" == "ERC20" || "$kind" == "Custom" ]]; then
+              for access_option in "${all_access_options[@]}"; do
+                proj_name="'$kind, access: $access_option' test project"
                 echo "Generating $proj_name..."
-                yarn run update_scarb_project $kind $royalty_info_option
+                yarn run update_scarb_project --kind=$kind --access=$access_option
 
                 echo "Compiling $proj_name..."
                 scarb build
@@ -68,7 +84,7 @@ jobs:
               proj_name="'$kind' test project"
 
               echo "Generating $proj_name..."
-              yarn run update_scarb_project $kind
+              yarn run update_scarb_project --kind=$kind
 
               echo "Compiling $proj_name..."
               scarb build

packages/common/src/ai/descriptions/cairo.ts

@@ -27,6 +27,14 @@ export const cairoCommonDescriptions = {
     'Provides information for how much royalty is owed and to whom, based on a sale price. Follows ERC-2981 standard.',
 };
 
+export const cairoAlphaAccessDescriptions = {
+  accessType:
+    'The type of access control to provision. Ownable is a simple mechanism with a single account authorized for all privileged actions. Roles is a flexible mechanism with a separate role for each privileged action. A role can have many authorized accounts. Roles (Default Admin Rules) provides additional enforced security measures on top of standard Roles mechanism for managing the most privileged role: default admin.',
+  darInitialDelay: 'The initial delay for the default admin role (in case Roles (Default Admin Rules) is used).',
+  darDefaultDelayIncrease:
+    'The default delay increase for the default admin role (in case Roles (Default Admin Rules) is used).',
+};
+
 export const cairoRoyaltyInfoDescriptions = {
   enabled: 'Whether to enable royalty feature for the contract',
   defaultRoyaltyFraction:

packages/core/cairo_alpha/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Add AccessControlDefaultAdminRules. ([#698](https://github.com/OpenZeppelin/contracts-wizard/pull/698))
+
 - **Breaking changes**:
   - Use OpenZeppelin Contracts for Cairo v3.0.0-alpha.3. ([#688](https://github.com/OpenZeppelin/contracts-wizard/pull/688))
   - Use OpenZeppelin Contracts for Cairo v3.0.0-alpha.2. ([#663](https://github.com/OpenZeppelin/contracts-wizard/pull/663))

packages/core/cairo_alpha/src/common-options.ts

@@ -1,5 +1,6 @@
 import type { Argument } from './contract';
 import type { Access } from './set-access-control';
+import { AccessControl } from './set-access-control';
 import type { Info } from './set-info';
 import { defaults as infoDefaults } from './set-info';
 import type { Upgradeable } from './set-upgradeable';
@@ -11,7 +12,7 @@ export const defaults: Required<CommonOptions> = {
 
 export const contractDefaults: Required<CommonContractOptions> = {
   ...defaults,
-  access: false,
+  access: AccessControl.None(),
 } as const;
 
 export interface CommonOptions {

packages/core/cairo_alpha/src/custom.test.ts

@@ -4,6 +4,7 @@ import { custom } from '.';
 import type { CustomOptions } from './custom';
 import { buildCustom } from './custom';
 import { printContract } from './print';
+import { AccessControl, darDefaultOpts, darCustomOpts } from './set-access-control';
 
 function testCustom(title: string, opts: Partial<CustomOptions>) {
   test(title, t => {
@@ -48,20 +49,28 @@ testCustom('upgradeable', {
 
 testCustom('access control disabled', {
   upgradeable: false,
-  access: false,
+  access: AccessControl.None(),
 });
 
 testCustom('access control ownable', {
-  access: 'ownable',
+  access: AccessControl.Ownable(),
 });
 
 testCustom('access control roles', {
-  access: 'roles',
+  access: AccessControl.Roles(),
+});
+
+testCustom('access control roles default admin rules (default opts)', {
+  access: AccessControl.RolesDefaultAdminRules(darDefaultOpts),
+});
+
+testCustom('access control roles default admin rules (custom opts)', {
+  access: AccessControl.RolesDefaultAdminRules(darCustomOpts),
 });
 
 testCustom('pausable with access control disabled', {
   // API should override access to true since it is required for pausable
-  access: false,
+  access: AccessControl.None(),
   pausable: true,
   upgradeable: false,
 });
@@ -70,7 +79,7 @@ testAPIEquivalence('custom API default');
 
 testAPIEquivalence('custom API full upgradeable', {
   name: 'CustomContract',
-  access: 'roles',
+  access: AccessControl.Roles(),
   pausable: true,
   upgradeable: true,
 });

packages/core/cairo_alpha/src/custom.test.ts.md

@@ -380,6 +380,169 @@ Generated by [AVA](https://avajs.dev).
     }␊
     `
 
+## access control roles default admin rules (default opts)
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    // Compatible with OpenZeppelin Contracts for Cairo 3.0.0-alpha.3␊
+    ␊
+    const UPGRADER_ROLE: felt252 = selector!("UPGRADER_ROLE");␊
+    ␊
+    #[starknet::contract]␊
+    mod MyContract {␊
+        use openzeppelin::access::accesscontrol::extensions::{␊
+        	AccessControlDefaultAdminRulesComponent,␊
+        	DefaultConfig as AccessControlDefaultAdminRulesDefaultConfig␊
+        };␊
+        use openzeppelin::interfaces::upgrades::IUpgradeable;␊
+        use openzeppelin::introspection::src5::SRC5Component;␊
+        use openzeppelin::upgrades::UpgradeableComponent;␊
+        use starknet::{ClassHash, ContractAddress};␊
+        use super::UPGRADER_ROLE;␊
+    ␊
+        const INITIAL_DELAY: u64 = 86400; // 1 day␊
+    ␊
+        component!(path: AccessControlDefaultAdminRulesComponent, storage: accesscontrol_dar, event: AccessControlDefaultAdminRulesEvent);␊
+        component!(path: SRC5Component, storage: src5, event: SRC5Event);␊
+        component!(path: UpgradeableComponent, storage: upgradeable, event: UpgradeableEvent);␊
+    ␊
+        // External␊
+        #[abi(embed_v0)]␊
+        impl AccessControlMixinImpl = AccessControlDefaultAdminRulesComponent::AccessControlMixinImpl<ContractState>;␊
+    ␊
+        // Internal␊
+        impl AccessControlDefaultAdminRulesInternalImpl = AccessControlDefaultAdminRulesComponent::InternalImpl<ContractState>;␊
+        impl UpgradeableInternalImpl = UpgradeableComponent::InternalImpl<ContractState>;␊
+    ␊
+        #[storage]␊
+        struct Storage {␊
+            #[substorage(v0)]␊
+            accesscontrol_dar: AccessControlDefaultAdminRulesComponent::Storage,␊
+            #[substorage(v0)]␊
+            src5: SRC5Component::Storage,␊
+            #[substorage(v0)]␊
+            upgradeable: UpgradeableComponent::Storage,␊
+        }␊
+    ␊
+        #[event]␊
+        #[derive(Drop, starknet::Event)]␊
+        enum Event {␊
+            #[flat]␊
+            AccessControlDefaultAdminRulesEvent: AccessControlDefaultAdminRulesComponent::Event,␊
+            #[flat]␊
+            SRC5Event: SRC5Component::Event,␊
+            #[flat]␊
+            UpgradeableEvent: UpgradeableComponent::Event,␊
+        }␊
+    ␊
+        #[constructor]␊
+        fn constructor(␊
+            ref self: ContractState,␊
+            initial_default_admin: ContractAddress,␊
+            upgrader: ContractAddress,␊
+        ) {␊
+            self.accesscontrol_dar.initializer(INITIAL_DELAY, initial_default_admin);␊
+    ␊
+            self.accesscontrol_dar._grant_role(UPGRADER_ROLE, upgrader);␊
+        }␊
+    ␊
+        //␊
+        // Upgradeable␊
+        //␊
+        ␊
+        #[abi(embed_v0)]␊
+        impl UpgradeableImpl of IUpgradeable<ContractState> {␊
+            fn upgrade(ref self: ContractState, new_class_hash: ClassHash) {␊
+                self.accesscontrol_dar.assert_only_role(UPGRADER_ROLE);␊
+                self.upgradeable.upgrade(new_class_hash);␊
+            }␊
+        }␊
+    }␊
+    `
+
+## access control roles default admin rules (custom opts)
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    // Compatible with OpenZeppelin Contracts for Cairo 3.0.0-alpha.3␊
+    ␊
+    const UPGRADER_ROLE: felt252 = selector!("UPGRADER_ROLE");␊
+    ␊
+    #[starknet::contract]␊
+    mod MyContract {␊
+        use openzeppelin::access::accesscontrol::extensions::AccessControlDefaultAdminRulesComponent;␊
+        use openzeppelin::interfaces::upgrades::IUpgradeable;␊
+        use openzeppelin::introspection::src5::SRC5Component;␊
+        use openzeppelin::upgrades::UpgradeableComponent;␊
+        use starknet::{ClassHash, ContractAddress};␊
+        use super::UPGRADER_ROLE;␊
+    ␊
+        const INITIAL_DELAY: u64 = 172800; // 2 days␊
+    ␊
+        component!(path: AccessControlDefaultAdminRulesComponent, storage: accesscontrol_dar, event: AccessControlDefaultAdminRulesEvent);␊
+        component!(path: SRC5Component, storage: src5, event: SRC5Event);␊
+        component!(path: UpgradeableComponent, storage: upgradeable, event: UpgradeableEvent);␊
+    ␊
+        // External␊
+        #[abi(embed_v0)]␊
+        impl AccessControlMixinImpl = AccessControlDefaultAdminRulesComponent::AccessControlMixinImpl<ContractState>;␊
+    ␊
+        // Internal␊
+        impl AccessControlDefaultAdminRulesInternalImpl = AccessControlDefaultAdminRulesComponent::InternalImpl<ContractState>;␊
+        impl UpgradeableInternalImpl = UpgradeableComponent::InternalImpl<ContractState>;␊
+    ␊
+        #[storage]␊
+        struct Storage {␊
+            #[substorage(v0)]␊
+            accesscontrol_dar: AccessControlDefaultAdminRulesComponent::Storage,␊
+            #[substorage(v0)]␊
+            src5: SRC5Component::Storage,␊
+            #[substorage(v0)]␊
+            upgradeable: UpgradeableComponent::Storage,␊
+        }␊
+    ␊
+        #[event]␊
+        #[derive(Drop, starknet::Event)]␊
+        enum Event {␊
+            #[flat]␊
+            AccessControlDefaultAdminRulesEvent: AccessControlDefaultAdminRulesComponent::Event,␊
+            #[flat]␊
+            SRC5Event: SRC5Component::Event,␊
+            #[flat]␊
+            UpgradeableEvent: UpgradeableComponent::Event,␊
+        }␊
+    ␊
+        #[constructor]␊
+        fn constructor(␊
+            ref self: ContractState,␊
+            initial_default_admin: ContractAddress,␊
+            upgrader: ContractAddress,␊
+        ) {␊
+            self.accesscontrol_dar.initializer(INITIAL_DELAY, initial_default_admin);␊
+    ␊
+            self.accesscontrol_dar._grant_role(UPGRADER_ROLE, upgrader);␊
+        }␊
+    ␊
+        impl AccessControlDefaultAdminRulesImmutableConfig of AccessControlDefaultAdminRulesComponent::ImmutableConfig {␊
+            const DEFAULT_ADMIN_DELAY_INCREASE_WAIT: u64 = 604800; // 1 week␊
+        }␊
+    ␊
+        //␊
+        // Upgradeable␊
+        //␊
+        ␊
+        #[abi(embed_v0)]␊
+        impl UpgradeableImpl of IUpgradeable<ContractState> {␊
+            fn upgrade(ref self: ContractState, new_class_hash: ClassHash) {␊
+                self.accesscontrol_dar.assert_only_role(UPGRADER_ROLE);␊
+                self.upgradeable.upgrade(new_class_hash);␊
+            }␊
+        }␊
+    }␊
+    `
+
 ## pausable with access control disabled
 
 > Snapshot 1