refactor(repo): merge all NFT contracts into one single package

.github/workflows/taikoon.yml → .github/workflows/nfts.yml

@@ -1,16 +1,16 @@
-name: Taikoon
+name: NFTs
 
 on:
   push:
     branches: [main]
     paths:
-      - "packages/taikoon/**"
+      - "packages/nfts/**"
   pull_request:
     paths:
-      - "packages/taikoon/**"
+      - "packages/nfts/**"
 
 jobs:
-  build-taikoon:
+  build-nfts:
     runs-on: [taiko-runner]
     steps:
       - name: Cancel previous runs
@@ -30,13 +30,13 @@ jobs:
         uses: ./.github/actions/install-pnpm-dependencies
 
       - name: Check formatting
-        working-directory: ./packages/taikoon
+        working-directory: ./packages/nfts
         run: forge fmt --check
 
       - name: Solidity compilation
-        working-directory: ./packages/taikoon
+        working-directory: ./packages/nfts
         run: pnpm compile
 
       - name: Unit Tests
-        working-directory: ./packages/taikoon
+        working-directory: ./packages/nfts
         run: pnpm test

.github/workflows/repo--validate-pr-title.yml

@@ -40,8 +40,7 @@ jobs:
             guardian-prover-health-check-ui
             protocol
             relayer
-            taikoon
-            snaefell-nft
+            nfts
             ui-lib
             taiko-client
             supplementary-contracts

.release-please-manifest.json

@@ -10,7 +10,7 @@
   "packages/protocol": "1.5.0",
   "packages/relayer": "0.12.0",
   "packages/taiko-client": "0.22.0",
-  "packages/taikoon": "1.0.0",
+  "packages/nfts": "1.0.0",
   "packages/supplementary-contracts": "1.0.0",
   "packages/taikoon-ui": "1.0.0"
 }

README.md

@@ -48,7 +48,7 @@ taiko-mono/
 │   ├── <a href="./packages/relayer">relayer</a>: Bridge backend relayer.
 │   ├── <a href="./packages/supplementary-contracts">supplementary-contracts</a>: Supplementary smart contracts that are not part of the Taiko rollup protocol.
 │   ├── <a href="./packages/taiko-client">taiko-client</a>: Taiko client implementation in Go.
-│   ├── <a href="./packages/taikoon">taikoon</a>: Taikoon NFT contracts.
+│   ├── <a href="./packages/nfts">nfts</a>: NFT contracts.
 │   └── <a href="./packages/taikoon-ui">taikoon-ui</a>: Taikoon NFT UI.
 ...
 </pre>

packages/taikoon/README.md → packages/nfts/README.md

@@ -1,4 +1,4 @@
-# Taikoon MFT
+# NFTs
 
 ## Setup
 
@@ -18,7 +18,7 @@ $ pnpm install # installs the workspace's dependencies
 
 ---
 
-## Deploying the Taikoons
+## Deploying the Taikoon NFT
 
 In order to deploy the token, the images for the NFTs must be placed under `data/original/`. The following script will re-size them and upload them to IPFS:
 

packages/taikoon/package.json → packages/nfts/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@taiko/taikoon",
+  "name": "@taiko/nfts",
   "version": "1.0.0",
   "private": true,
   "scripts": {

packages/taikoon/script/sol/Deploy.s.sol → packages/nfts/script/taikoon/Deploy.s.sol

@@ -6,7 +6,7 @@ import { Script, console } from "forge-std/src/Script.sol";
 import { MerkleMintersScript } from "./MerkleMinters.s.sol";
 import { Merkle } from "murky/Merkle.sol";
 import { ERC1967Proxy } from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
-import { TaikoonToken } from "../../contracts/TaikoonToken.sol";
+import { TaikoonToken } from "../../contracts/taikoon/TaikoonToken.sol";
 
 contract DeployScript is Script {
     UtilsScript public utils;

packages/taikoon/script/sol/MerkleMinters.s.sol → packages/nfts/script/taikoon/MerkleMinters.s.sol

@@ -6,8 +6,8 @@ import "forge-std/src/StdJson.sol";
 import { UtilsScript } from "./Utils.s.sol";
 import { Merkle } from "murky/Merkle.sol";
 import "./CsvParser.sol";
-import { MerkleWhitelist } from "../../contracts/MerkleWhitelist.sol";
-import { TaikoonToken } from "../../contracts/TaikoonToken.sol";
+import { MerkleWhitelist } from "../../contracts/taikoon/MerkleWhitelist.sol";
+import { TaikoonToken } from "../../contracts/taikoon/TaikoonToken.sol";
 
 contract MerkleMintersScript is Script {
     using stdJson for string;

packages/taikoon/test/MerkleWhitelist.t.sol → packages/nfts/test/taikoon/MerkleWhitelist.t.sol

@@ -4,8 +4,8 @@ pragma solidity 0.8.24;
 import { Test, console } from "forge-std/src/Test.sol";
 import "forge-std/src/StdJson.sol";
 import { Merkle } from "murky/Merkle.sol";
-import { MerkleWhitelist } from "../contracts/MerkleWhitelist.sol";
 import { ERC1967Proxy } from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
+import { MerkleWhitelist } from "../../contracts/taikoon/MerkleWhitelist.sol";
 
 /// @custom:oz-upgrades-from MerkleWhitelist
 contract MerkleWhitelistForTest is MerkleWhitelist {

packages/taikoon/test/MerkleWhitelistTestWrapper.sol → packages/nfts/test/taikoon/MerkleWhitelistTestWrapper.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.24;
 
-import { MerkleWhitelist } from "../contracts/MerkleWhitelist.sol";
+import { MerkleWhitelist } from "../../contracts/taikoon/MerkleWhitelist.sol";
 
 /// @custom:oz-upgrades-from MerkleWhitelist
 contract MerkleWhitelistTestWrapper is MerkleWhitelist {

packages/taikoon/test/TaikoonToken.t.sol → packages/nfts/test/taikoon/TaikoonToken.t.sol

@@ -3,9 +3,9 @@ pragma solidity 0.8.24;
 
 import { Test } from "forge-std/src/Test.sol";
 
-import { TaikoonToken } from "../contracts/TaikoonToken.sol";
 import { Merkle } from "murky/Merkle.sol";
 import { ERC1967Proxy } from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
+import { TaikoonToken } from "../../contracts/taikoon/TaikoonToken.sol";
 
 contract TaikoonTokenTest is Test {
     TaikoonToken public token;

packages/taikoon/test/Upgradeable.t.sol → packages/nfts/test/taikoon/Upgradeable.t.sol

@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.24;
 
+import "forge-std/src/StdJson.sol";
 import { Test, console } from "forge-std/src/Test.sol";
-import { TaikoonToken } from "../contracts/TaikoonToken.sol";
+import { ERC1967Proxy } from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
 import { Merkle } from "murky/Merkle.sol";
-import { MerkleMintersScript } from "../script/sol/MerkleMinters.s.sol";
-import "forge-std/src/StdJson.sol";
+import { TaikoonToken } from "../../contracts/taikoon/TaikoonToken.sol";
+import { MerkleMintersScript } from "../../script/taikoon/MerkleMinters.s.sol";
 
-import { ERC1967Proxy } from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
 
 contract UpgradeableTest is Test {
     using stdJson for string;