[Cairo] with_components macro (#703)

Author: immrsd

.changeset/mean-shoes-cheer.md

@@ -0,0 +1,5 @@
+---
+'@openzeppelin/wizard-common': patch
+---
+
+Add macros descriptions for Cairo

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

@@ -47,50 +47,52 @@ jobs:
           set -e
 
           declare -a all_kinds=("ERC20" "ERC721" "ERC1155" "Account" "Multisig" "Governor" "Vesting" "Custom")
+          declare -a all_macros_options=("none" "with_components")
           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 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"
+          for macros_option in "${all_macros_options[@]}"; do
+            for kind in "${all_kinds[@]}"; do
+              if [[ "$kind" == "ERC721" || "$kind" == "ERC1155" ]]; then
+                for access_option in "${all_access_options[@]}"; do
+                  for royalty_option in "${all_royalty_options[@]}"; do
+                    proj_name="'$kind, macros: $macros_option, access: $access_option, royalty: $royalty_option' test project"
+                    echo "Generating $proj_name..."
+                    yarn run update_scarb_project --kind=$kind --macros=$macros_option --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=$kind --access=$access_option --royalty=$royalty_option
+                  yarn run update_scarb_project --kind=$kind --access=$access_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"
+              else
+                proj_name="'$kind' test project"
+
                 echo "Generating $proj_name..."
-                yarn run update_scarb_project --kind=$kind --access=$access_option
+                yarn run update_scarb_project --kind=$kind
 
                 echo "Compiling $proj_name..."
                 scarb build
 
                 echo "✅ Compiled $proj_name!"
                 echo "---------------------------------"
-              done
-
-            else
-              proj_name="'$kind' test project"
-
-              echo "Generating $proj_name..."
-              yarn run update_scarb_project --kind=$kind
-
-              echo "Compiling $proj_name..."
-              scarb build
-
-              echo "✅ Compiled $proj_name!"
-              echo "---------------------------------"
-            fi
+              fi
+            done
 
           done

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

@@ -27,6 +27,11 @@ 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 cairoMacrosDescriptions = {
+  macros: 'The macros to use for the contract.',
+  withComponents: 'Whether to use the "with_components" macro for simplified contract structure.',
+};
+
 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.',

packages/core/cairo_alpha/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+- Add support for `with_components` macro. ([#703](https://github.com/OpenZeppelin/contracts-wizard/pull/703))
 - Add AccessControlDefaultAdminRules. ([#698](https://github.com/OpenZeppelin/contracts-wizard/pull/698))
 
 - **Breaking changes**:

packages/core/cairo_alpha/ava.config.js

@@ -4,6 +4,7 @@ module.exports = {
   watchmode: {
     ignoreChanges: ['contracts', 'artifacts', 'cache'],
   },
+  snapshotDir: '.',
   timeout: '10m',
   workerThreads: false,
 };

packages/core/cairo_alpha/src/account.test.ts.snap

@@ -21,6 +21,7 @@ export const defaults: Required<AccountOptions> = {
   outsideExecution: true,
   upgradeable: commonDefaults.upgradeable,
   info: commonDefaults.info,
+  macros: commonDefaults.macros,
 } as const;
 
 export function printAccount(opts: AccountOptions = defaults): string {
@@ -49,17 +50,16 @@ function withDefaults(opts: AccountOptions): Required<AccountOptions> {
 
 export function buildAccount(opts: AccountOptions): Contract {
   const isAccount = true;
-  const c = new ContractBuilder(opts.name, isAccount);
-
   const allOpts = withDefaults(opts);
+  const c = new ContractBuilder(allOpts.name, allOpts.macros, isAccount);
 
   switch (allOpts.type) {
     case 'stark':
       c.addConstructorArgument({ name: 'public_key', type: 'felt252' });
       c.addComponent(components.AccountComponent, [{ lit: 'public_key' }], true);
       break;
     case 'eth':
-      c.addUseClause('openzeppelin::interfaces::accounts', 'EthPublicKey');
+      c.addUseClause('openzeppelin_interfaces::accounts', 'EthPublicKey');
       c.addConstructorArgument({ name: 'public_key', type: 'EthPublicKey' });
       c.addComponent(components.EthAccountComponent, [{ lit: 'public_key' }], true);
       break;
@@ -98,10 +98,12 @@ function addSRC6(c: ContractBuilder, accountType: Account) {
 
   c.addImplToComponent(componentType, {
     name: 'SRC6Impl',
+    embed: true,
     value: `${baseComponent}::SRC6Impl<ContractState>`,
   });
   c.addImplToComponent(componentType, {
     name: 'SRC6CamelOnlyImpl',
+    embed: true,
     value: `${baseComponent}::SRC6CamelOnlyImpl<ContractState>`,
   });
 
@@ -113,6 +115,7 @@ function addDeclarer(c: ContractBuilder, accountType: Account) {
 
   c.addImplToComponent(componentType, {
     name: 'DeclarerImpl',
+    embed: true,
     value: `${baseComponent}::DeclarerImpl<ContractState>`,
   });
 }
@@ -122,6 +125,7 @@ function addDeployer(c: ContractBuilder, accountType: Account) {
 
   c.addImplToComponent(componentType, {
     name: 'DeployableImpl',
+    embed: true,
     value: `${baseComponent}::DeployableImpl<ContractState>`,
   });
 }
@@ -131,16 +135,17 @@ function addPublicKey(c: ContractBuilder, accountType: Account) {
 
   c.addImplToComponent(componentType, {
     name: 'PublicKeyImpl',
+    embed: true,
     value: `${baseComponent}::PublicKeyImpl<ContractState>`,
   });
   c.addImplToComponent(componentType, {
     name: 'PublicKeyCamelImpl',
+    embed: true,
     value: `${baseComponent}::PublicKeyCamelImpl<ContractState>`,
   });
 }
 
 function addOutsideExecution(c: ContractBuilder) {
-  c.addUseClause('openzeppelin::account::extensions', 'SRC9Component');
   c.addComponent(components.SRC9Component, [], true);
 }
 
@@ -151,6 +156,7 @@ function addAccountMixin(c: ContractBuilder, accountType: Account) {
   c.addImplToComponent(componentType, {
     name: `${accountMixinImpl}`,
     value: `${baseComponent}::${accountMixinImpl}<ContractState>`,
+    embed: true,
   });
 
   c.addInterfaceFlag('ISRC5');
@@ -167,7 +173,7 @@ function getBaseCompAndCompType(accountType: Account): [string, typeof component
 
 const components = defineComponents({
   AccountComponent: {
-    path: 'openzeppelin::account',
+    path: 'openzeppelin_account',
     substorage: {
       name: 'account',
       type: 'AccountComponent::Storage',
@@ -185,7 +191,7 @@ const components = defineComponents({
     ],
   },
   EthAccountComponent: {
-    path: 'openzeppelin::account::eth_account',
+    path: 'openzeppelin_account::eth_account',
     substorage: {
       name: 'eth_account',
       type: 'EthAccountComponent::Storage',
@@ -203,7 +209,7 @@ const components = defineComponents({
     ],
   },
   SRC9Component: {
-    path: 'openzeppelin::account::extensions',
+    path: 'openzeppelin_account::extensions',
     substorage: {
       name: 'src9',
       type: 'SRC9Component::Storage',
@@ -215,6 +221,7 @@ const components = defineComponents({
     impls: [
       {
         name: 'OutsideExecutionV2Impl',
+        embed: true,
         value: 'SRC9Component::OutsideExecutionV2Impl<ContractState>',
       },
       {

packages/core/cairo_alpha/src/account.ts

@@ -17,7 +17,7 @@ export function addPausable(c: ContractBuilder, access: Access) {
 
 const components = defineComponents({
   PausableComponent: {
-    path: 'openzeppelin::security::pausable',
+    path: 'openzeppelin_security::pausable',
     substorage: {
       name: 'pausable',
       type: 'PausableComponent::Storage',
@@ -29,6 +29,7 @@ const components = defineComponents({
     impls: [
       {
         name: 'PausableImpl',
+        embed: true,
         value: 'PausableComponent::PausableImpl<ContractState>',
       },
       {

packages/core/cairo_alpha/src/add-pausable.ts

@@ -6,7 +6,7 @@ export type Token = (typeof tokenTypes)[number];
 
 const components = defineComponents({
   SRC5Component: {
-    path: 'openzeppelin::introspection::src5',
+    path: 'openzeppelin_introspection::src5',
     substorage: {
       name: 'src5',
       type: 'SRC5Component::Storage',
@@ -19,7 +19,7 @@ const components = defineComponents({
   },
 
   VotesComponent: {
-    path: 'openzeppelin::governance::votes',
+    path: 'openzeppelin_governance::votes',
     substorage: {
       name: 'votes',
       type: 'VotesComponent::Storage',
@@ -38,7 +38,7 @@ const components = defineComponents({
   },
 
   NoncesComponent: {
-    path: 'openzeppelin::utils::cryptography::nonces',
+    path: 'openzeppelin_utils::cryptography::nonces',
     substorage: {
       name: 'nonces',
       type: 'NoncesComponent::Storage',
@@ -50,6 +50,7 @@ const components = defineComponents({
     impls: [
       {
         name: 'NoncesImpl',
+        embed: true,
         value: 'NoncesComponent::NoncesImpl<ContractState>',
       },
     ],
@@ -62,6 +63,7 @@ export function addSRC5Component(c: ContractBuilder, section?: string) {
   if (!c.interfaceFlags.has('ISRC5')) {
     c.addImplToComponent(components.SRC5Component, {
       name: 'SRC5Impl',
+      embed: true,
       value: 'SRC5Component::SRC5Impl<ContractState>',
       section,
     });
@@ -75,13 +77,14 @@ export function addVotesComponent(c: ContractBuilder, name: string, version: str
   c.addComponent(components.VotesComponent, [], false);
   c.addImplToComponent(components.VotesComponent, {
     name: 'VotesImpl',
+    embed: true,
     value: `VotesComponent::VotesImpl<ContractState>`,
   });
-  c.addUseClause('openzeppelin::utils::contract_clock', 'ERC6372TimestampClock');
+  c.addUseClause('openzeppelin_utils::contract_clock', 'ERC6372TimestampClock');
 }
 
 export function addSNIP12Metadata(c: ContractBuilder, name: string, version: string, section?: string) {
-  c.addUseClause('openzeppelin::utils::cryptography::snip12', 'SNIP12Metadata');
+  c.addUseClause('openzeppelin_utils::cryptography::snip12', 'SNIP12Metadata');
 
   const SNIP12Metadata: BaseImplementedTrait = {
     name: 'SNIP12MetadataImpl',

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

@@ -4,10 +4,13 @@ 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';
+import type { MacrosOptions } from './set-macros';
+import { defaults as macrosDefaults } from './set-macros';
 
 export const defaults: Required<CommonOptions> = {
   upgradeable: true,
   info: infoDefaults,
+  macros: macrosDefaults,
 } as const;
 
 export const contractDefaults: Required<CommonContractOptions> = {
@@ -18,6 +21,7 @@ export const contractDefaults: Required<CommonContractOptions> = {
 export interface CommonOptions {
   upgradeable?: Upgradeable;
   info?: Info;
+  macros?: MacrosOptions;
 }
 
 export interface CommonContractOptions extends CommonOptions {
@@ -28,6 +32,7 @@ export function withCommonDefaults(opts: CommonOptions): Required<CommonOptions>
   return {
     upgradeable: opts.upgradeable ?? defaults.upgradeable,
     info: opts.info ?? defaults.info,
+    macros: opts.macros ?? defaults.macros,
   };
 }