Bump cairo to v0.18.0 (#399)

Co-authored-by: Eric Lau <[email protected]> Co-authored-by: Eric Nordelo <[email protected]>
OpenZeppelin · Oct 22, 2024 · f8fb22f · f8fb22f
1 parent cafb999
commit f8fb22f
Show file tree

Hide file tree

Showing 25 changed files with 829 additions and 410 deletions.
diff --git a/packages/core-cairo/CHANGELOG.md b/packages/core-cairo/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.17.0 (2024-10-22)
+
+- Add ERC721 votes. ([#399](https://github.com/OpenZeppelin/contracts-wizard/pull/399))
+
+- **Breaking changes**:
+  - Use OpenZeppelin Contracts for Cairo v0.18.0. ([#399](https://github.com/OpenZeppelin/contracts-wizard/pull/399))
+  - Use `VotesComponent` for ERC20 votes.
+
 ## 0.16.0 (2024-09-26)
 
 - Add ERC721Enumerable. ([#391](https://github.com/OpenZeppelin/contracts-wizard/pull/391))

diff --git a/packages/core-cairo/package.json b/packages/core-cairo/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/wizard-cairo",
-  "version": "0.16.0",
+  "version": "0.17.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/account.test.ts.md b/packages/core-cairo/src/account.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.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -70,7 +70,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -114,7 +114,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -175,7 +175,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -219,7 +219,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -284,7 +284,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -332,7 +332,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -399,7 +399,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -466,7 +466,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -535,7 +535,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -604,7 +604,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -675,7 +675,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -746,7 +746,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -808,7 +808,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -853,7 +853,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -915,7 +915,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -960,7 +960,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -1026,7 +1026,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -1075,7 +1075,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -1143,7 +1143,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -1211,7 +1211,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -1281,7 +1281,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -1351,7 +1351,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊
@@ -1423,7 +1423,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.0␊
     ␊
     #[starknet::contract(account)]␊
     mod MyAccount {␊

diff --git a/packages/core-cairo/src/account.test.ts.snap b/packages/core-cairo/src/account.test.ts.snap
diff --git a/packages/core-cairo/src/common-components.ts b/packages/core-cairo/src/common-components.ts
@@ -1,6 +1,9 @@
-import type { ContractBuilder } from "./contract";
+import type { BaseImplementedTrait, ContractBuilder } from './contract';
 import { defineComponents } from "./utils/define-components";
 
+export const tokenTypes = ['ERC20', 'ERC721'] as const;
+export type Token = typeof tokenTypes[number];
+
 const components = defineComponents( {
   SRC5Component: {
     path: 'openzeppelin::introspection::src5',
@@ -14,6 +17,41 @@ const components = defineComponents( {
     },
     impls: [],
   },
+
+  VotesComponent: {
+    path: 'openzeppelin::governance::votes',
+    substorage: {
+      name: 'votes',
+      type: 'VotesComponent::Storage',
+    },
+    event: {
+      name: 'VotesEvent',
+      type: 'VotesComponent::Event',
+    },
+    impls: [],
+    internalImpl: {
+      name: 'VotesInternalImpl',
+      value: 'VotesComponent::InternalImpl<ContractState>',
+    },
+  },
+
+  NoncesComponent: {
+    path: 'openzeppelin::utils::cryptography::nonces',
+    substorage: {
+      name: 'nonces',
+      type: 'NoncesComponent::Storage',
+    },
+    event: {
+      name: 'NoncesEvent',
+      type: 'NoncesComponent::Event',
+    },
+    impls: [
+      {
+        name: 'NoncesImpl',
+        value: 'NoncesComponent::NoncesImpl<ContractState>',
+      },
+    ],
+  },
 })
 
 export function addSRC5Component(c: ContractBuilder) {
@@ -26,4 +64,40 @@ export function addSRC5Component(c: ContractBuilder) {
     });
     c.addInterfaceFlag('ISRC5');
   }
-}
+}
+
+export function addVotesComponent(c: ContractBuilder, name: string, version: string) {
+  c.addStandaloneImport('openzeppelin::utils::cryptography::snip12::SNIP12Metadata');
+  c.addComponent(components.NoncesComponent, [], false);
+  c.addComponent(components.VotesComponent, [], false);
+  c.addImplToComponent(components.VotesComponent, {
+    name: 'VotesImpl',
+    value: `VotesComponent::VotesImpl<ContractState>`,
+  });
+
+  const SNIP12Metadata: BaseImplementedTrait = {
+    name: 'SNIP12MetadataImpl',
+    of: 'SNIP12Metadata',
+    tags: [],
+    priority: 0,
+  };
+  c.addImplementedTrait(SNIP12Metadata);
+
+  c.addFunction(SNIP12Metadata, {
+    name: 'name',
+    args: [],
+    returns: 'felt252',
+    code: [
+      `'${name}'`,
+    ],
+  });
+
+  c.addFunction(SNIP12Metadata, {
+    name: 'version',
+    args: [],
+    returns: 'felt252',
+    code: [
+      `'${version}'`,
+    ],
+  });
+}
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.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.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.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.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.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.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.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.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.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.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.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.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.17.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.18.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