Add return tokenId (and adjust type) if incremental safeMint (#455)

Author: CoveMB

packages/core/solidity/CHANGELOG.md

@@ -4,6 +4,10 @@
 
 - Fix modifiers order to follow Solidity style guides. ([#450](https://github.com/OpenZeppelin/contracts-wizard/pull/450))
 
+## 0.5.2 (2025-02-21)
+
+- ERC721 to return tokenId on safeMint with incremental id
+
 ## 0.5.1 (2025-02-05)
 
 - **Potentially breaking changes**:

packages/core/solidity/src/erc721.test.ts.md

@@ -184,10 +184,15 @@ Generated by [AVA](https://avajs.dev).
             Ownable(initialOwner)␊
         {}␊
     ␊
-        function safeMint(address to, string memory uri) public onlyOwner {␊
+        function safeMint(address to, string memory uri)␊
+            public␊
+            onlyOwner␊
+            returns (uint256)␊
+        {␊
             uint256 tokenId = _nextTokenId++;␊
             _safeMint(to, tokenId);␊
             _setTokenURI(tokenId, uri);␊
+            return tokenId;␊
         }␊
     ␊
         // The following functions are overrides required by Solidity.␊
@@ -404,9 +409,10 @@ Generated by [AVA](https://avajs.dev).
             Ownable(initialOwner)␊
         {}␊
     ␊
-        function safeMint(address to) public onlyOwner {␊
+        function safeMint(address to) public onlyOwner returns (uint256) {␊
             uint256 tokenId = _nextTokenId++;␊
             _safeMint(to, tokenId);␊
+            return tokenId;␊
         }␊
     }␊
     `

packages/core/solidity/src/erc721.test.ts.snap

@@ -1,4 +1,4 @@
-import { Contract, ContractBuilder } from './contract';
+import { BaseFunction, Contract, ContractBuilder } from './contract';
 import { Access, setAccessControl, requireAccessControl } from './set-access-control';
 import { addPauseFunctions } from './add-pausable';
 import { supportsInterface } from './common-functions';
@@ -185,14 +185,16 @@ function addMintable(c: ContractBuilder, access: Access, incremental = false, ur
   if (uriStorage) {
     c.addFunctionCode('_setTokenURI(tokenId, uri);', fn);
   }
+
+  if (incremental) c.addFunctionCode('return tokenId;', fn);
 }
 
 function addVotes(c: ContractBuilder, name: string, clockMode: ClockMode) {
   const EIP712 = {
     name: 'EIP712',
     path: '@openzeppelin/contracts/utils/cryptography/EIP712.sol',
   };
-  c.addParent(EIP712, [name, "1"]);
+  c.addParent(EIP712, [name, '1']);
 
   const ERC721Votes = {
     name: 'ERC721Votes',
@@ -219,9 +221,7 @@ const functions = defineFunctions({
 
   tokenURI: {
     kind: 'public' as const,
-    args: [
-      { name: 'tokenId', type: 'uint256' },
-    ],
+    args: [{ name: 'tokenId', type: 'uint256' }],
     returns: ['string memory'],
     mutability: 'view' as const,
   },
@@ -242,13 +242,12 @@ const functions = defineFunctions({
   },
 });
 
-function getMintFunction(incremental: boolean, uriStorage: boolean) {
-  const fn = {
+function getMintFunction(incremental: boolean, uriStorage: boolean): BaseFunction {
+  const fn: BaseFunction = {
     name: 'safeMint',
     kind: 'public' as const,
-    args: [
-      { name: 'to', type: 'address' },
-    ],
+    args: [{ name: 'to', type: 'address' }],
+    returns: incremental ? ['uint256'] : undefined,
   };
 
   if (!incremental) {