Cairo: Use Contracts for Cairo v0.12.0, add ERC20Votes (#355)

OpenZeppelin · May 1, 2024 · 83829d1 · 83829d1
1 parent 7817c21
commit 83829d1
Show file tree

Hide file tree

Showing 23 changed files with 1,376 additions and 581 deletions.
diff --git a/packages/core-cairo/CHANGELOG.md b/packages/core-cairo/CHANGELOG.md
@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.12.0 (2024-05-01)
+
+- Add `votes` option to ERC20. ([#355](https://github.com/OpenZeppelin/contracts-wizard/pull/355))
+- Require `appName` and `appVersion` when `votes` is enabled.
+- Sort implemented traits.
+- **Breaking changes**:
+  - Use OpenZeppelin Contracts for Cairo v0.12.0.
+  - Use Hooks with ERC20.
+
 ## 0.11.0 (2024-04-17)
 
 - **Breaking changes**:

diff --git a/packages/core-cairo/package.json b/packages/core-cairo/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/wizard-cairo",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "A boilerplate generator to get started with OpenZeppelin Contracts for Cairo",
   "license": "MIT",
   "repository": "github:OpenZeppelin/contracts-wizard",

diff --git a/packages/core-cairo/src/contract.test.ts.md b/packages/core-cairo/src/contract.test.ts.md
@@ -9,7 +9,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.11.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.12.0␊
     ␊
     #[starknet::contract]␊
     mod Foo {␊
@@ -24,7 +24,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.11.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.12.0␊
     ␊
     #[starknet::contract]␊
     mod Foo {␊
@@ -44,7 +44,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.11.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.12.0␊
     ␊
     #[starknet::contract]␊
     mod Foo {␊
@@ -64,7 +64,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.11.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.12.0␊
     ␊
     #[starknet::contract]␊
     mod Foo {␊
@@ -89,7 +89,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.11.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.12.0␊
     ␊
     #[starknet::contract]␊
     mod Foo {␊
@@ -114,7 +114,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.11.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.12.0␊
     ␊
     #[starknet::contract]␊
     mod Foo {␊
@@ -152,7 +152,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.11.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.12.0␊
     ␊
     #[starknet::contract]␊
     mod Foo {␊

diff --git a/packages/core-cairo/src/contract.test.ts.snap b/packages/core-cairo/src/contract.test.ts.snap
diff --git a/packages/core-cairo/src/contract.ts b/packages/core-cairo/src/contract.ts
@@ -48,6 +48,11 @@ export interface BaseImplementedTrait {
   of: string;
   tags: string[];
   perItemTag?: string;
+  /**
+   * Priority for which trait to print first.
+   * Lower numbers are higher priority, undefined is lowest priority.
+   */
+  priority?: number;
 }
 
 export interface ImplementedTrait extends BaseImplementedTrait {
@@ -165,6 +170,7 @@ export class ContractBuilder implements Contract {
         of: baseTrait.of,
         tags: [ ...baseTrait.tags ],
         functions: [],
+        priority: baseTrait.priority,
       };
       this.implementedTraitsMap.set(key, t);
       return t;

diff --git a/packages/core-cairo/src/custom.test.ts.md b/packages/core-cairo/src/custom.test.ts.md
@@ -9,7 +9,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.11.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.12.0␊
     ␊
     #[starknet::contract]␊
     mod MyContract {␊
@@ -24,7 +24,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.11.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.12.0␊
     ␊
     #[starknet::contract]␊
     mod MyContract {␊
@@ -80,7 +80,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.11.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.12.0␊
     ␊
     #[starknet::contract]␊
     mod MyContract {␊
@@ -129,6 +129,14 @@ Generated by [AVA](https://avajs.dev).
         fn constructor(ref self: ContractState, owner: ContractAddress) {␊
             self.ownable.initializer(owner);␊
         }␊
+    ␊
+        #[abi(embed_v0)]␊
+        impl UpgradeableImpl of IUpgradeable<ContractState> {␊
+            fn upgrade(ref self: ContractState, new_class_hash: ClassHash) {␊
+                self.ownable.assert_only_owner();␊
+                self.upgradeable._upgrade(new_class_hash);␊
+            }␊
+        }␊
     ␊
         #[generate_trait]␊
         #[abi(per_item)]␊
@@ -145,14 +153,6 @@ Generated by [AVA](https://avajs.dev).
                 self.pausable._unpause();␊
             }␊
         }␊
-    ␊
-        #[abi(embed_v0)]␊
-        impl UpgradeableImpl of IUpgradeable<ContractState> {␊
-            fn upgrade(ref self: ContractState, new_class_hash: ClassHash) {␊
-                self.ownable.assert_only_owner();␊
-                self.upgradeable._upgrade(new_class_hash);␊
-            }␊
-        }␊
     }␊
     `
 
@@ -161,7 +161,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.11.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.12.0␊
     ␊
     #[starknet::contract]␊
     mod MyContract {␊
@@ -217,7 +217,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.11.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.12.0␊
     ␊
     #[starknet::contract]␊
     mod MyContract {␊
@@ -232,7 +232,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.11.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.12.0␊
     ␊
     #[starknet::contract]␊
     mod MyContract {␊
@@ -288,7 +288,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.11.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.12.0␊
     ␊
     const UPGRADER_ROLE: felt252 = selector!("UPGRADER_ROLE");␊
     ␊
@@ -361,7 +361,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.11.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.12.0␊
     ␊
     #[starknet::contract]␊
     mod MyContract {␊

diff --git a/packages/core-cairo/src/custom.test.ts.snap b/packages/core-cairo/src/custom.test.ts.snap