feat: Replace hardhat-deploy with ignition, upgrade dependencies and update documentation (#126)

* chore: Update deps

* feat: Implement BasicERC20Module

* feat: Implement BasicERC721Module

* feat: Implement BasicERC1155Module

* feat: Use parameters file for config

* feat: Use parameters file for config

* feat: Use parameters file for config

* chore: Update test BasicERC20

* chore: Add from owner to tests

* chore: Update test BasicERC721

* chore: Update test BasicERC1155

* chore: Format

* chore: Remove hardhat deploy

* chore: Remove named accounts

* chore: Update solidity version

* chore: Rename paramters json

* chore: Update license

* docs: Update docs to match latest changes

* chore: Bump deps and add contributors

* chore: Re-organise erc20 imports

* chore: Migrate to eslint 9.x

Author: KovacZan

.eslintrc.json

@@ -10,8 +10,8 @@
 		{
 			"files": "*.sol",
 			"options": {
-				"parser": "solidity-parse",
-				"printWidth": 80,
+				"parser": "slang",
+				"printWidth": 120,
 				"tabWidth": 4,
 				"useTabs": true,
 				"singleQuote": false,

.prettierrc.json

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Protokol
+Copyright (c) 2025 Protokol
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -7,13 +7,13 @@ All you have to do is create a new repository from the template and start coding
 
 ## Hardhat Configuration
 
--   [Typechain](https://github.com/dethcrypto/TypeChain) plugin enabled (typescript type bindings for smart contracts)
--   [hardhat-deploy](https://github.com/wighawag/hardhat-deploy) plugin enabled
--   Testing environment configured and operational, with test coverage
--   Prettier and eslint configured for project files and solidity smart contract
--   [Solhint](https://github.com/protofire/solhint) configured for enforcing best practices
--   Github actions workflows prepared for CI/CD
--   Prepared Smart Contract Examples, Tests, Deployments and Tasks for Common ERC Standards (ERC20, ERC721, ERC1155)
+- [Typechain](https://github.com/dethcrypto/TypeChain) plugin enabled (typescript type bindings for smart contracts)
+- [Ignition](https://hardhat.org/ignition/docs/getting-started) for contract deployment
+- Testing environment configured and operational, with test coverage
+- Prettier and eslint configured for project files and solidity smart contract
+- [Solhint](https://github.com/protofire/solhint) configured for enforcing best practices
+- Github actions workflows prepared for CI/CD
+- Prepared Smart Contract Examples, Tests, Deployments and Tasks for Common ERC Standards (ERC20, ERC721, ERC1155)
 
 Check the Hardhat documentation for more information.
 
@@ -27,30 +27,44 @@ https://hardhat.org/getting-started/
 │   ├── BasicERC1155.sol
 │   ├── BasicERC20.sol
 │   └── BasicERC721.sol
-├── deploy
-│   ├── Deploy_BasicERC1155.ts
-│   ├── Deploy_BasicERC20.ts
-│   └── Deploy_BasicERC721.ts
-├── deployments
-├── hardhat.config.ts
+├── ignition
+│   ├── deployments
+│   ├── modules
+│   │   ├── BasicERC1155Module.ts
+│   │   ├── BasicERC20Module.ts
+│   │   └── BasicERC721Module.ts
+│   └── parameters
+│       └── custom.json
 ├── tasks
 │   ├── erc1155
+│   │   ├── base-uri.ts
+│   │   ├── contract-uri.ts
+│   │   └── mint.ts
 │   ├── erc20
+│   │   └── mint.ts
 │   ├── erc721
+│   │   ├── base-uri.ts
+│   │   ├── contract-uri.ts
+│   │   └── mint.ts
 │   └── utils
-└── test
-    ├── BasicERC1155.ts
-    ├── BasicERC20.ts
-    └── BasicERC721.ts
+│       ├── accounts.ts
+│       ├── balance.ts
+│       ├── block-number.ts
+│       └── send-eth.ts
+├── test
+│   ├── BasicERC1155.ts
+│   ├── BasicERC20.ts
+│   └── BasicERC721.ts
+└── hardhat.config.ts
 ```
 
 ## Supported Networks
 
--   Hardhat Network (localhost)
--   Ethereum Mainnet
--   Ethereum Sepolia Testnet
--   Polygon Mainnet
--   Polygon Mumbai Testnet
+- Hardhat Network (localhost)
+- Ethereum Mainnet
+- Ethereum Sepolia Testnet
+- Polygon Mainnet
+- Polygon Mumbai Testnet
 
 Feel free to add more networks in `hardhat.config.ts` file.
 
@@ -66,12 +80,12 @@ https://hardhat.org/guides/shorthand.html
 
 ### Common Shorthand Commands
 
--   `hh compile` - to compile smart contract and generate typechain ts bindings
--   `hh test` - to run tests
--   `hh deploy` - to deploy to local network (see options for more)
--   `hh node` - to run a localhost node
--   `hh help` - to see all available commands
--   `hh TABTAB` - to use autocomplete
+- `hh compile` - to compile smart contract and generate typechain ts bindings
+- `hh test` - to run tests
+- `hh igntion` - to deploy smart contracts
+- `hh node` - to run a localhost node
+- `hh help` - to see all available commands
+- `hh TABTAB` - to use autocomplete
 
 ## Usage
 
@@ -101,23 +115,37 @@ Make sure you include either `MNEMONIC` or `PRIVATE_KEY` in your `.env` file.
 
 > This is an example flow to deploy an ERC721 token to a public network and interact with it.
 
-#### 1. Deploy BasicERC721 Contract
+#### 1.1 Deploy BasicERC721 Contract
 
 ```shell
-hh deploy --network sepolia --tags BasicERC721
+hh ignition deploy ignition/modules/BasicERC721Module.ts --network sepolia
 ```
 
-#### 2. Verify Contract
+**Verify contract**
 
 ```shell
-hh --network sepolia etherscan-verify
+hh ignition verify chain-11155111
 ```
 
-#### 3. Interact With Contract - Mint
+#### 1.2 Deploy and Verify
+
+```shell
+hh ignition deploy ignition/modules/BasicERC721Module.ts --network sepolia --verify
+```
+
+#### 1.3 Deploy and Verify with Custom Parameters
+
+Look at `ignition/parameters/custom.json` to see how to adjust contract parameters
+
+```shell
+hh ignition deploy ignition/modules/BasicERC721Module.ts --network sepolia --verify --parameters ignition/parameters/custom.json
+```
+
+#### 2. Interact With Contract - Mint
 
 ```shell
 hh erc721-mint \
- --contract 0x77337983A7D1699FaF51a5f43b9907fB7B614097 \
+ --contract 0x1FEB5675Be6F256c4680BE447D6C353E02e04fb9 \
  --recipient 0x73faDd7E476a9Bc2dA6D1512A528366A3E50c3cF \
  --network sepolia
 ```

README.md

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.28;
 
 import { Strings } from "@openzeppelin/contracts/utils/Strings.sol";
 import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
@@ -12,13 +12,7 @@ import { ERC1155Supply } from "@openzeppelin/contracts/token/ERC1155/extensions/
  * This file was generated with Openzeppelin Wizard and later modified.
  * GO TO: https://wizard.openzeppelin.com/#erc1155
  */
-contract BasicERC1155 is
-	ERC1155,
-	Ownable,
-	ERC1155Pausable,
-	ERC1155Burnable,
-	ERC1155Supply
-{
+contract BasicERC1155 is ERC1155, Ownable, ERC1155Pausable, ERC1155Burnable, ERC1155Supply {
 	using Strings for uint256;
 
 	string public name;
@@ -54,19 +48,11 @@ contract BasicERC1155 is
 		_unpause();
 	}
 
-	function mint(
-		address account,
-		uint256 id,
-		uint256 amount
-	) external onlyOwner {
+	function mint(address account, uint256 id, uint256 amount) external onlyOwner {
 		_mint(account, id, amount, "");
 	}
 
-	function mintBatch(
-		address to,
-		uint256[] memory ids,
-		uint256[] memory amounts
-	) external onlyOwner {
+	function mintBatch(address to, uint256[] memory ids, uint256[] memory amounts) external onlyOwner {
 		_mintBatch(to, ids, amounts, "");
 	}
 
@@ -79,12 +65,7 @@ contract BasicERC1155 is
 	 * This is useful for metadata published on ipfs where files have .json suffix
 	 */
 	function uri(uint256 id) public view override returns (string memory) {
-		return
-			bytes(super.uri(id)).length > 0
-				? string(
-					abi.encodePacked(super.uri(id), id.toString(), ".json")
-				)
-				: "";
+		return bytes(super.uri(id)).length > 0 ? string(abi.encodePacked(super.uri(id), id.toString(), ".json")) : "";
 	}
 
 	function _update(

contracts/BasicERC1155.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.28;
 
 import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
 import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
@@ -29,11 +29,7 @@ contract BasicERC20 is ERC20, ERC20Burnable, ERC20Pausable, Ownable {
 		_mint(to, amount);
 	}
 
-	function _update(
-		address from,
-		address to,
-		uint256 value
-	) internal override(ERC20, ERC20Pausable) {
+	function _update(address from, address to, uint256 value) internal override(ERC20, ERC20Pausable) {
 		super._update(from, to, value);
 	}
 }

contracts/BasicERC20.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.28;
 
 import { Strings } from "@openzeppelin/contracts/utils/Strings.sol";
 import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
@@ -12,13 +12,7 @@ import { ERC721Burnable } from "@openzeppelin/contracts/token/ERC721/extensions/
  * This file was generated with Openzeppelin Wizard and later modified.
  * GO TO: https://wizard.openzeppelin.com/#erc721
  */
-contract BasicERC721 is
-	ERC721,
-	ERC721Enumerable,
-	ERC721Pausable,
-	Ownable,
-	ERC721Burnable
-{
+contract BasicERC721 is ERC721, ERC721Enumerable, ERC721Pausable, Ownable, ERC721Burnable {
 	using Strings for uint256;
 
 	uint256 private _nextTokenId;
@@ -71,42 +65,25 @@ contract BasicERC721 is
 	 * @dev Returns base uri and adds .json suffix
 	 * This is useful for metadata published on ipfs where files have .json suffix
 	 */
-	function tokenURI(
-		uint256 tokenId
-	) public view override returns (string memory) {
-		if (ownerOf(tokenId) == address(0))
-			revert ERC721NonexistentToken(tokenId);
-
-		return
-			bytes(_baseURI()).length > 0
-				? string(
-					abi.encodePacked(_baseURI(), tokenId.toString(), ".json")
-				)
-				: "";
+	function tokenURI(uint256 tokenId) public view override returns (string memory) {
+		if (ownerOf(tokenId) == address(0)) revert ERC721NonexistentToken(tokenId);
+
+		return bytes(_baseURI()).length > 0 ? string(abi.encodePacked(_baseURI(), tokenId.toString(), ".json")) : "";
 	}
 
 	function _update(
 		address to,
 		uint256 tokenId,
 		address auth
-	)
-		internal
-		override(ERC721, ERC721Enumerable, ERC721Pausable)
-		returns (address)
-	{
+	) internal override(ERC721, ERC721Enumerable, ERC721Pausable) returns (address) {
 		return super._update(to, tokenId, auth);
 	}
 
-	function _increaseBalance(
-		address account,
-		uint128 value
-	) internal override(ERC721, ERC721Enumerable) {
+	function _increaseBalance(address account, uint128 value) internal override(ERC721, ERC721Enumerable) {
 		super._increaseBalance(account, value);
 	}
 
-	function supportsInterface(
-		bytes4 interfaceId
-	) public view override(ERC721, ERC721Enumerable) returns (bool) {
+	function supportsInterface(bytes4 interfaceId) public view override(ERC721, ERC721Enumerable) returns (bool) {
 		return super.supportsInterface(interfaceId);
 	}
 }