{"id":21171790,"url":"https://github.com/ileskov/manager","last_synced_at":"2025-07-09T19:33:09.051Z","repository":{"id":49813373,"uuid":"515588917","full_name":"ILESKOV/Manager","owner":"ILESKOV","description":"The user can buy an ERC-20 token, after sending the tokens to the manager's contract, they will be automatically locked, after that the user will receive NFT.","archived":false,"fork":false,"pushed_at":"2022-11-08T13:38:38.000Z","size":951,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-20T15:02:22.680Z","etag":null,"topics":["erc20","erc721","ipfs","ipfs-blockchain","nft","smart-contracts","solidity","solidity-contracts"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ILESKOV.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-07-19T13:06:53.000Z","updated_at":"2022-11-14T01:20:57.000Z","dependencies_parsed_at":"2023-01-22T21:30:29.749Z","dependency_job_id":null,"html_url":"https://github.com/ILESKOV/Manager","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ILESKOV%2FManager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ILESKOV%2FManager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ILESKOV%2FManager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ILESKOV%2FManager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ILESKOV","download_url":"https://codeload.github.com/ILESKOV/Manager/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225587755,"owners_count":17492633,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["erc20","erc721","ipfs","ipfs-blockchain","nft","smart-contracts","solidity","solidity-contracts"],"created_at":"2024-11-20T16:12:03.731Z","updated_at":"2024-11-20T16:12:04.253Z","avatar_url":"https://github.com/ILESKOV.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🤵 Manager NFT generator 🤵\n\u003e There are 3 contracts: Manager.sol for managing, Token.sol with erc-20 implementation and ERC721.sol with ERC721 standard implementation\n\n## 📁 Table of Contents\n* [General Info](#-general-information)\n* [Technologies Used](#-technologies-used)\n* [Features](#-features)\n* [Requirements For Initial Setup](#-requirements-for-initial-setup)\n* [Setup](#-setup)\n* [Contact](#-contact)\n\n\n\n## 🚩 General Information\n- Each user wishing to participate must purchase 5,000 standard \"TKN\" erc-20 tokens\n- To participate, each user must deposit these tokens into the ManagerContract via the deposit function\n- After that, the tokens will be locked for a minute, after which the user can call the createNFT function and pass the image URI as a parameter\n- NFT will be minted for the user and image metadata will be added after all 10 tokens are minted\n- The owner of the Token contract earns 0.0001 ETH for each \"TKN\" token and can withdraw \"TKN\" from the Manager contract after unlocking the tokens.\n\n\n \n## 💻 Technologies Used\n- ipfs\n- hh coverage\n- slither\n- docgen\n- solhint\n\n## 🌟 Features\n- Users could create custom NFTS\n- Total supply of 10 NFTs\n- The metadata is updated only once after the tokens are minted\n- 100% coverage of tests\n\n## 👀 Requirements For Initial Setup\n- Install [NodeJS](https://nodejs.org/en/), should work with any node version below 16.16.0\n- Install [Hardhat](https://hardhat.org/)\n\n## 📟 Setup\n### 1. 💾 Clone/Download the Repository\n### 2. 📦 Install Dependencies:\n```\n$ cd repository_file\n$ npm install\n```\n### 3. 🔍 .env environment variables required to set up\nCreate .env file inside project folder\n- You can get your ethereum or testnet API key [here](https://infura.io/dashboard/ethereum),[here](https://www.alchemy.com) or any other service that allow you to connect to the nodes\n- You can get your private key from your wallet (Don't share your private key with untrusted parties) \n- You can get your etherscan API -key [here](https://etherscan.io/myapikey).\n- TOKEN_ADDRESS(address of TKN) be available after deploying contracts\n```\nRINKEBY_API = \u003cRinkeby API key\u003e\nMAINNET_API = \u003cEthereum mainnet API key\u003e\nPRIVATE_KEY = \u003cPrivate key of your wallet u want to deploy contracts from\u003e\nETHERSCAN_KEY = \u003cEtherscan API key in order to verify your contracts\u003e\nTOKEN_ADDRESS = \u003cAddress of deployed TKN.sol contract\u003e\nTKN_FEE = \u003cConstructor parameter fee in TKN tokens in order to create custom NFT\u003e\nLOCKED_PERIOD = \u003cConstructor parameter period in seconds indicating how long deposited TKN tokens will be locked\u003e\nDEPOSITORS_LIMIT = \u003cConstructor parameter limit of depositors for the contract\u003e\n\n// All tokens are divided into 4 groups, each has its own percentage level of rarity\n// For example: first group = 4, second = 3, third = 2 and fourth = 1.\n// 4 means 40%, 3 means 30% and so on\n// FIRST_GROUP_ELEMENTS + SECOND_GROUP_ELEMENTS + THIRD_GROUP_ELEMENTS + FOURTH_GROUP_ELEMENTS always must be 10\n\nFIRST_GROUP_ELEMENTS = 4\nSECOND_GROUP_ELEMENTS = 3\nTHIRD_GROUP_ELEMENTS = 2\nFOURTH_GROUP_ELEMENTS = 1\n```\n\n![Example screenshot](./helpers/Screenshot9.png)\n\n### 4. ⚠️ Run Tests\n```\n$ npm run test\n```\n\n```\n$ npm run coverage\n```\n\n### 5. 🚀 Deploy to Rinkeby or Mainnet\n```\n$ npm run deployRinkeby\n``` \n```\n$ npm run deployMainnet \n``` \n\n!!!Important!!! \ninsert current token contract address into your environment variables\n\n### 6. ✏️ Insert current contract addresses into package.json\n![Example screenshot](./helpers/Screenshot7.png)\n\n### 7. 📜 Verify contracts\n```\n$ npm run verifyRinkebyTKN \n```\n\n```\n $ npm run verifyRinkebyManager\n```\nor for mainnet\n```\n$ npm run verifyTKN\n```\n\n```\n $ npm run verifyManager\n```\n\n### NOTE\nIn order to quick update of Metadata on opensea page just click \"Refresh Metadata\" button\n\n\n![Example screenshot](./helpers/Screenshot8.png)\n\n\n## 💬 Contact\nCreated by [@LESKOV](https://www.linkedin.com/in/ivan-leskov-4b5664189/) - feel free to contact me!\n\n\n\n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fileskov%2Fmanager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fileskov%2Fmanager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fileskov%2Fmanager/lists"}