Fix forge release script (#479)

nkrishang · web-flow · commit 882f8c80990b · 2023-08-21T19:54:39.000-04:00
* pkg bump

* pkg bump

* updated release script

* Dont use IERC721 from openzeppelin

* pkg bump

* update release process

* pkg bump

* pkg bump
diff --git a/.gitignore b/.gitignore
@@ -19,6 +19,7 @@ contracts/abi/
 contracts/README.md
 artifacts/
 artifacts_forge/
+contract_artifacts/
 
 # files
 *.env
diff --git a/contracts/airdrop/AirdropERC721.sol b/contracts/airdrop/AirdropERC721.sol
@@ -13,7 +13,7 @@ pragma solidity ^0.8.11;
 //    \____/ \__|  \__|\__|\__|       \_______| \_____\____/  \_______|\_______/
 
 //  ==========  External imports    ==========
-import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
+import "../eip/interface/IERC721.sol";
 
 import "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
 import "@openzeppelin/contracts-upgradeable/utils/MulticallUpgradeable.sol";
diff --git a/contracts/airdrop/AirdropERC721Claimable.sol b/contracts/airdrop/AirdropERC721Claimable.sol
@@ -13,7 +13,7 @@ pragma solidity ^0.8.11;
 //    \____/ \__|  \__|\__|\__|       \_______| \_____\____/  \_______|\_______/
 
 //  ==========  External imports    ==========
-import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
+import "../eip/interface/IERC721.sol";
 
 import "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
 import "@openzeppelin/contracts-upgradeable/utils/MulticallUpgradeable.sol";
diff --git a/contracts/extension/Staking721Upgradeable.sol b/contracts/extension/Staking721Upgradeable.sol
@@ -5,7 +5,7 @@ pragma solidity ^0.8.11;
 
 import "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
 import "../openzeppelin-presets/utils/math/SafeMath.sol";
-import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
+import "../eip/interface/IERC721.sol";
 
 import "./interface/IStaking721.sol";
 
diff --git a/contracts/marketplace/direct-listings/DirectListingsLogic.sol b/contracts/marketplace/direct-listings/DirectListingsLogic.sol
@@ -7,7 +7,7 @@ import "./DirectListingsStorage.sol";
 
 // ====== External imports ======
 import "@openzeppelin/contracts/token/ERC1155/IERC1155.sol";
-import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
+import "../../eip/interface/IERC721.sol";
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import "@openzeppelin/contracts/interfaces/IERC2981.sol";
 
diff --git a/contracts/marketplace/english-auctions/EnglishAuctionsLogic.sol b/contracts/marketplace/english-auctions/EnglishAuctionsLogic.sol
@@ -9,7 +9,7 @@ import "./EnglishAuctionsStorage.sol";
 import "@openzeppelin/contracts/utils/Context.sol";
 import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 import "@openzeppelin/contracts/token/ERC1155/IERC1155.sol";
-import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
+import "../../eip/interface/IERC721.sol";
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import "@openzeppelin/contracts/interfaces/IERC2981.sol";
 
diff --git a/contracts/marketplace/offers/OffersLogic.sol b/contracts/marketplace/offers/OffersLogic.sol
@@ -8,7 +8,7 @@ import "./OffersStorage.sol";
 // ====== External imports ======
 import "@openzeppelin/contracts/utils/Context.sol";
 import "@openzeppelin/contracts/utils/introspection/IERC165.sol";
-import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
+import "../../eip/interface/IERC721.sol";
 import "@openzeppelin/contracts/token/ERC1155/IERC1155.sol";
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import "@openzeppelin/contracts/interfaces/IERC2981.sol";
diff --git a/contracts/mock/Mock.sol b/contracts/mock/Mock.sol
@@ -4,7 +4,7 @@ pragma solidity ^0.8.11;
 /// @author thirdweb
 
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
+import "../eip/interface/IERC721.sol";
 import "@openzeppelin/contracts/token/ERC1155/IERC1155.sol";
 
 /*
diff --git a/contracts/package.json b/contracts/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@thirdweb-dev/contracts",
   "description": "Collection of smart contracts deployable via the thirdweb SDK, dashboard and CLI",
-  "version": "3.8.4-1",
+  "version": "3.8.4",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
diff --git a/contracts/staking/NFTStake.sol b/contracts/staking/NFTStake.sol
@@ -13,7 +13,7 @@ pragma solidity ^0.8.11;
 //    \____/ \__|  \__|\__|\__|       \_______| \_____\____/  \_______|\_______/
 
 // Token
-import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
+import "../eip/interface/IERC721.sol";
 import "@openzeppelin/contracts-upgradeable/utils/introspection/ERC165Upgradeable.sol";
 import "@openzeppelin/contracts-upgradeable/token/ERC721/IERC721ReceiverUpgradeable.sol";
 
diff --git a/package.json b/package.json
@@ -46,8 +46,8 @@
     "typescript": "^4.4.4"
   },
   "scripts": {
-    "clean": "forge clean && rm -rf abi/ && rm -rf artifacts_forge/ && rm -rf dist/ && rm -rf typechain/",
-    "compile": "forge build",
+    "clean": "forge clean && rm -rf abi/ && rm -rf artifacts_forge/ && rm -rf contract_artifacts && rm -rf dist/ && rm -rf typechain/",
+    "compile": "forge build && npx ts-node scripts/package-release.ts",
     "lint": "solhint \"contracts/**/*.sol\"",
     "prettier": "prettier --config .prettierrc --write \"{contracts,src}/**/*.{js,json,sol,ts}\"",
     "prettier:list-different": "prettier --config .prettierrc --list-different \"**/*.{js,json,sol,ts}\"",
diff --git a/release.sh b/release.sh
@@ -35,7 +35,7 @@ echo "### Build finished. Copying abis."
 rm -rf contracts/abi
 mkdir -p contracts/abi
 # copy all abis to contracts/abi
-find artifacts_forge ! -iregex ".*([a-zA-Z0-9_]).json" -exec cp {} contracts/abi 2>/dev/null \; 
+find contract_artifacts ! -iregex ".*([a-zA-Z0-9_]).json" -exec cp {} contracts/abi 2>/dev/null \; 
 echo "### Copying README."
 # copy root README to contracts folder
 cp README.md contracts/README.md
diff --git a/scripts/package-release.ts b/scripts/package-release.ts
@@ -0,0 +1,52 @@
+import * as fs from "fs-extra";
+import * as path from "path";
+
+// Define the paths for the directories
+const artifactsForgeDir = path.join(__dirname, "..", "artifacts_forge");
+const contractsDir = path.join(__dirname, "..", "contracts");
+const contractArtifactsDir = path.join(__dirname, "..", "contract_artifacts");
+
+async function getAllSolidityFiles(dir: string): Promise<string[]> {
+  const dirents = await fs.readdir(dir, { withFileTypes: true });
+  const files = await Promise.all(
+    dirents.map(dirent => {
+      const res = path.join(dir, dirent.name);
+      return dirent.isDirectory() ? getAllSolidityFiles(res) : res;
+    }),
+  );
+  // Flatten the array and filter for .sol files
+  return files
+    .flat()
+    .filter(file => file.endsWith(".sol"))
+    .map(file => path.basename(file));
+}
+
+async function main() {
+  // Create the contract_artifacts directory
+  await fs.ensureDir(contractArtifactsDir);
+
+  // Get all directories within artifacts_forge that match *.sol
+  const artifactDirs = await fs.readdir(artifactsForgeDir);
+  const validArtifactDirs = artifactDirs.filter(dir => dir.endsWith(".sol"));
+
+  // Get all .sol filenames within contracts (recursively)
+  const validContractFiles = await getAllSolidityFiles(contractsDir);
+
+  // Check if directory-name matches any Solidity file name from contracts
+  for (const artifactDir of validArtifactDirs) {
+    // Removing the .sol extension from the directory name to match with file names
+    const artifactName = path.basename(artifactDir, ".sol");
+
+    if (validContractFiles.includes(artifactName + ".sol")) {
+      const sourcePath = path.join(artifactsForgeDir, artifactDir);
+      const destinationPath = path.join(contractArtifactsDir, artifactDir);
+      await fs.copy(sourcePath, destinationPath);
+    }
+  }
+
+  console.log("Done copying matching directories.");
+}
+
+main().catch(error => {
+  console.error("An error occurred:", error);
+});
diff --git a/src/test/airdrop/AirdropERC721.t.sol b/src/test/airdrop/AirdropERC721.t.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
-import "contracts/airdrop/AirdropERC721.sol";
+import { AirdropERC721, IAirdropERC721 } from "contracts/airdrop/AirdropERC721.sol";
 
 // Test imports
 import { Wallet } from "../utils/Wallet.sol";
diff --git a/src/test/benchmark/AirdropERC721Benchmark.t.sol b/src/test/benchmark/AirdropERC721Benchmark.t.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
-import "contracts/airdrop/AirdropERC721.sol";
+import { AirdropERC721, IAirdropERC721 } from "contracts/airdrop/AirdropERC721.sol";
 
 // Test imports
 import { Wallet } from "../utils/Wallet.sol";
diff --git a/src/test/sdk/base/BaseUtilTest.sol b/src/test/sdk/base/BaseUtilTest.sol
@@ -11,7 +11,7 @@ import "../../mocks/MockERC1155.sol";
 import "contracts/forwarder/Forwarder.sol";
 import "contracts/lib/TWStrings.sol";
 
-import "contracts/mock/Mock.sol";
+import { Mock } from "contracts/mock/Mock.sol";
 
 abstract contract BaseUtilTest is DSTest, Test {
     string public constant NAME = "NAME";
diff --git a/src/test/sdk/extension/StakingExtension.t.sol b/src/test/sdk/extension/StakingExtension.t.sol
@@ -6,10 +6,10 @@ import "@ds-test/test.sol";
 
 import { Staking721 } from "contracts/extension/Staking721.sol";
 import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
-import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
+import "contracts/eip/interface/IERC721.sol";
 import "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
 
-import "../../mocks/MockERC721.sol";
+import { MockERC721 } from "../../mocks/MockERC721.sol";
 
 contract MyStakingContract is ERC20, Staking721, IERC721Receiver {
     bool condition;
diff --git a/src/test/utils/BaseTest.sol b/src/test/utils/BaseTest.sol
@@ -29,16 +29,16 @@ import { VoteERC20 } from "contracts/vote/VoteERC20.sol";
 import { SignatureDrop } from "contracts/signature-drop/SignatureDrop.sol";
 import { ContractPublisher } from "contracts/ContractPublisher.sol";
 import { IContractPublisher } from "contracts/interfaces/IContractPublisher.sol";
-import "contracts/airdrop/AirdropERC721.sol";
-import "contracts/airdrop/AirdropERC721Claimable.sol";
+import { AirdropERC721 } from "contracts/airdrop/AirdropERC721.sol";
+import { AirdropERC721Claimable } from "contracts/airdrop/AirdropERC721Claimable.sol";
 import { AirdropERC20 } from "contracts/airdrop/AirdropERC20.sol";
 import "contracts/airdrop/AirdropERC20Claimable.sol";
 import "contracts/airdrop/AirdropERC1155.sol";
 import "contracts/airdrop/AirdropERC1155Claimable.sol";
 import { NFTStake } from "contracts/staking/NFTStake.sol";
 import { EditionStake } from "contracts/staking/EditionStake.sol";
 import { TokenStake } from "contracts/staking/TokenStake.sol";
-import "contracts/mock/Mock.sol";
+import { Mock, MockContract } from "contracts/mock/Mock.sol";
 import "contracts/mock/MockContractPublisher.sol";
 
 abstract contract BaseTest is DSTest, Test {

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@thirdweb-dev/contracts",`
`3`	`3`	`"description": "Collection of smart contracts deployable via the thirdweb SDK, dashboard and CLI",`
`4`		`- "version": "3.8.4-1",`
	`4`	`+ "version": "3.8.4",`
`5`	`5`	`"license": "Apache-2.0",`
`6`	`6`	`"repository": {`
`7`	`7`	`"type": "git",`