Use Contracts for Cairo v0.10.0 (#344)

OpenZeppelin · Mar 12, 2024 · d33453b · d33453b
1 parent 47d0276
commit d33453b
Show file tree

Hide file tree

Showing 19 changed files with 159 additions and 102 deletions.
diff --git a/packages/core-cairo/CHANGELOG.md b/packages/core-cairo/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.10.0 (2024-03-12)
+
+- **Breaking changes**:
+  - Use OpenZeppelin Contracts for Cairo v0.10.0. ([#344](https://github.com/OpenZeppelin/contracts-wizard/pull/344))
+  - ERC721: Remove token URI parameter from safe mint functions.
+  - ERC721: Add optional base URI parameter. If not set, this defaults to empty string.
+  - Use string literals for ByteArray initialization instead of short strings.
+
 ## 0.9.2 (2024-02-26)
 
 - Remove code comment for Cairo lang version. ([#337](https://github.com/OpenZeppelin/contracts-wizard/pull/337))

diff --git a/packages/core-cairo/package.json b/packages/core-cairo/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/wizard-cairo",
-  "version": "0.9.2",
+  "version": "0.10.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.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.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.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.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.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.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.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.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.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.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.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.0␊
     ␊
     #[starknet::contract]␊
     mod Foo {␊
@@ -142,7 +142,7 @@ Generated by [AVA](https://avajs.dev).
     ␊
         #[constructor]␊
         fn constructor(ref self: ContractState) {␊
-            self.foo.initializer('param1');␊
+            self.foo.initializer("param1");␊
         }␊
     }␊
     `
@@ -152,7 +152,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.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/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.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.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.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.0␊
     ␊
     #[starknet::contract]␊
     mod MyContract {␊
@@ -90,7 +90,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.0␊
     ␊
     #[starknet::contract]␊
     mod MyContract {␊
@@ -148,7 +148,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.0␊
     ␊
     #[starknet::contract]␊
     mod MyContract {␊
@@ -163,7 +163,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.0␊
     ␊
     #[starknet::contract]␊
     mod MyContract {␊
@@ -204,7 +204,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.0␊
     ␊
     #[starknet::contract]␊
     mod MyContract {␊
@@ -256,7 +256,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.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
diff --git a/packages/core-cairo/src/erc20.test.ts.md b/packages/core-cairo/src/erc20.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.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.0␊
     ␊
     #[starknet::contract]␊
     mod MyToken {␊
@@ -41,7 +41,7 @@ Generated by [AVA](https://avajs.dev).
     ␊
         #[constructor]␊
         fn constructor(ref self: ContractState) {␊
-            self.erc20.initializer('MyToken', 'MTK');␊
+            self.erc20.initializer("MyToken", "MTK");␊
         }␊
     }␊
     `
@@ -51,7 +51,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.0␊
     ␊
     #[starknet::contract]␊
     mod MyToken {␊
@@ -84,7 +84,7 @@ Generated by [AVA](https://avajs.dev).
     ␊
         #[constructor]␊
         fn constructor(ref self: ContractState) {␊
-            self.erc20.initializer('MyToken', 'MTK');␊
+            self.erc20.initializer("MyToken", "MTK");␊
         }␊
     ␊
         #[generate_trait]␊
@@ -104,7 +104,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.0␊
     ␊
     #[starknet::contract]␊
     mod MyToken {␊
@@ -154,7 +154,7 @@ Generated by [AVA](https://avajs.dev).
     ␊
         #[constructor]␊
         fn constructor(ref self: ContractState, owner: ContractAddress) {␊
-            self.erc20.initializer('MyToken', 'MTK');␊
+            self.erc20.initializer("MyToken", "MTK");␊
             self.ownable.initializer(owner);␊
         }␊
     ␊
@@ -237,7 +237,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.0␊
     ␊
     const PAUSER_ROLE: felt252 = selector!("PAUSER_ROLE");␊
     ␊
@@ -299,7 +299,7 @@ Generated by [AVA](https://avajs.dev).
     ␊
         #[constructor]␊
         fn constructor(ref self: ContractState, default_admin: ContractAddress, pauser: ContractAddress) {␊
-            self.erc20.initializer('MyToken', 'MTK');␊
+            self.erc20.initializer("MyToken", "MTK");␊
             self.accesscontrol.initializer();␊
     ␊
             self.accesscontrol._grant_role(DEFAULT_ADMIN_ROLE, default_admin);␊
@@ -385,7 +385,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.0␊
     ␊
     #[starknet::contract]␊
     mod MyToken {␊
@@ -436,7 +436,7 @@ Generated by [AVA](https://avajs.dev).
     ␊
         #[constructor]␊
         fn constructor(ref self: ContractState, owner: ContractAddress) {␊
-            self.erc20.initializer('MyToken', 'MTK');␊
+            self.erc20.initializer("MyToken", "MTK");␊
             self.ownable.initializer(owner);␊
         }␊
     ␊
@@ -526,7 +526,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.0␊
     ␊
     #[starknet::contract]␊
     mod MyToken {␊
@@ -559,7 +559,7 @@ Generated by [AVA](https://avajs.dev).
     ␊
         #[constructor]␊
         fn constructor(ref self: ContractState, recipient: ContractAddress) {␊
-            self.erc20.initializer('MyToken', 'MTK');␊
+            self.erc20.initializer("MyToken", "MTK");␊
     ␊
             self.erc20._mint(recipient, 1000000000000000000000);␊
         }␊
@@ -571,7 +571,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.0␊
     ␊
     #[starknet::contract]␊
     mod MyToken {␊
@@ -603,7 +603,7 @@ Generated by [AVA](https://avajs.dev).
     ␊
         #[constructor]␊
         fn constructor(ref self: ContractState) {␊
-            self.erc20.initializer('MyToken', 'MTK');␊
+            self.erc20.initializer("MyToken", "MTK");␊
         }␊
     }␊
     `
@@ -613,7 +613,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.0␊
     ␊
     #[starknet::contract]␊
     mod MyToken {␊
@@ -657,7 +657,7 @@ Generated by [AVA](https://avajs.dev).
     ␊
         #[constructor]␊
         fn constructor(ref self: ContractState, owner: ContractAddress) {␊
-            self.erc20.initializer('MyToken', 'MTK');␊
+            self.erc20.initializer("MyToken", "MTK");␊
             self.ownable.initializer(owner);␊
         }␊
     ␊
@@ -678,7 +678,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.0␊
     ␊
     const MINTER_ROLE: felt252 = selector!("MINTER_ROLE");␊
     ␊
@@ -734,7 +734,7 @@ Generated by [AVA](https://avajs.dev).
     ␊
         #[constructor]␊
         fn constructor(ref self: ContractState, default_admin: ContractAddress, minter: ContractAddress) {␊
-            self.erc20.initializer('MyToken', 'MTK');␊
+            self.erc20.initializer("MyToken", "MTK");␊
             self.accesscontrol.initializer();␊
     ␊
             self.accesscontrol._grant_role(DEFAULT_ADMIN_ROLE, default_admin);␊
@@ -758,7 +758,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.0␊
     ␊
     #[starknet::contract]␊
     mod MyToken {␊
@@ -818,7 +818,7 @@ Generated by [AVA](https://avajs.dev).
     ␊
         #[constructor]␊
         fn constructor(ref self: ContractState, recipient: ContractAddress, owner: ContractAddress) {␊
-            self.erc20.initializer('MyToken', 'MTK');␊
+            self.erc20.initializer("MyToken", "MTK");␊
             self.ownable.initializer(owner);␊
     ␊
             self.erc20._mint(recipient, 2000000000000000000000);␊
@@ -925,7 +925,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts for Cairo ^0.9.0␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^0.10.0␊
     ␊
     const PAUSER_ROLE: felt252 = selector!("PAUSER_ROLE");␊
     const MINTER_ROLE: felt252 = selector!("MINTER_ROLE");␊
@@ -1006,7 +1006,7 @@ Generated by [AVA](https://avajs.dev).
             minter: ContractAddress,␊
             upgrader: ContractAddress,␊
         ) {␊
-            self.erc20.initializer('MyToken', 'MTK');␊
+            self.erc20.initializer("MyToken", "MTK");␊
             self.accesscontrol.initializer();␊
     ␊
             self.erc20._mint(recipient, 2000000000000000000000);␊

diff --git a/packages/core-cairo/src/erc20.test.ts.snap b/packages/core-cairo/src/erc20.test.ts.snap
diff --git a/packages/core-cairo/src/erc20.ts b/packages/core-cairo/src/erc20.ts
@@ -10,7 +10,7 @@ import { defineComponents } from './utils/define-components';
 import { defaults as commonDefaults } from './common-options';
 import { printContract } from './print';
 import { externalTrait } from './external-trait';
-import { toShortString } from './utils/convert-strings';
+import { toStringLiteral } from './utils/convert-strings';
 
 export const defaults: Required<ERC20Options> = {
   name: 'MyToken',
@@ -57,7 +57,7 @@ export function buildERC20(opts: ERC20Options): Contract {
 
   const allOpts = withDefaults(opts);
 
-  addBase(c, toShortString(allOpts.name, 'name'), toShortString(allOpts.symbol, 'symbol'));
+  addBase(c, toStringLiteral(allOpts.name), toStringLiteral(allOpts.symbol));
   addERC20ImplAndCamelOnlyImpl(c, allOpts.pausable);
 
   if (allOpts.premint) {

diff --git a/packages/core-cairo/src/erc721.test.ts b/packages/core-cairo/src/erc721.test.ts
@@ -31,6 +31,10 @@ function testERC721(title: string, opts: Partial<ERC721Options>) {
 
 testERC721('basic', {});
 
+testERC721('base uri', {
+  baseUri: 'https://gateway.pinata.cloud/ipfs/QmcP9hxrnC1T5ATPmq2saFeAM1ypFX9BnAswCdHB9JCjLA/',
+});
+
 testERC721('burnable', {
   burnable: true,
 });