{"id":20309008,"url":"https://github.com/protokol/nfty-village","last_synced_at":"2026-04-22T03:31:27.937Z","repository":{"id":43337945,"uuid":"415844806","full_name":"protokol/nfty-village","owner":"protokol","description":null,"archived":false,"fork":false,"pushed_at":"2026-04-08T15:45:08.000Z","size":246,"stargazers_count":1,"open_issues_count":12,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2026-04-08T17:30:36.375Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/protokol.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-10-11T08:41:18.000Z","updated_at":"2022-06-24T04:15:01.000Z","dependencies_parsed_at":"2023-09-27T17:06:19.338Z","dependency_job_id":"fc5a5105-980a-44a6-89ed-b06336345b74","html_url":"https://github.com/protokol/nfty-village","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"protokol/solidity-typescript-hardhat-template","purl":"pkg:github/protokol/nfty-village","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protokol%2Fnfty-village","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protokol%2Fnfty-village/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protokol%2Fnfty-village/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protokol%2Fnfty-village/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/protokol","download_url":"https://codeload.github.com/protokol/nfty-village/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protokol%2Fnfty-village/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32119710,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-22T00:31:26.853Z","status":"online","status_checked_at":"2026-04-22T02:00:05.693Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-14T17:25:03.006Z","updated_at":"2026-04-22T03:31:27.922Z","avatar_url":"https://github.com/protokol.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Img](header.png)\n\n# TypeScript Solidity Boilerplate Starter Kit\n\nA BoilerPlate Template Project To Start Solidity Development With Hardhat and Typescript. All you have to do is create a new repository from the template and start coding your smartcontracts. \n\n## Hardhat Configuration\n\n- typescript support enabled\n- typechain plugin installed (typescript type bindings are generated from smart contracts)/check Typechain docs\n- hardhat-deploy plugin enabled (use deployments from `deploy` folder, order and tag them; multi-network)\n- hardhat console enabled - to allow console.log usage within solidity code\n- testing environment configured and operational\n\nCheck the Hardhat documentation for more information. \n\nhttps://hardhat.org/getting-started/\n\n\nWe recommend installing `hh autocomplete` so you can use `hh` shorthand globally.\n\n`npm i -g hardhat-shorthand`\n\nhttps://hardhat.org/guides/shorthand.html\n\n## Usage\n\nRun `npm install` and then:\n\n- `hh compile` - to compile smart contract and generate typechain ts bindings\n- `hh test` - to run tests\n- `hh deploy` - to deploy to local network (see options for more)\n- `hh TABTAB` - to use autocomplete\n- `hh node` - to run a localhost node\n\n\nCheck `package.json` scripts for more options.\nUse `.env.example` file and adapt it to you values and settings.\n\nHave Fun!\n\n## Nfty Village contract development instructions\n\nTo build on top of Nfty Contracts we will have to deploy them. We will do this on \nRinkeby testnet and then we will verify the contract so it will be possible to interact\nwith it on Etherscan.\n\nThe environment file example is name `.env.example`, you can check what variables are\nneeded there or you can just follow this guide in which I will tell you what to setup.\n\n### Installation \n\n```sh\nnpm i -g hardhat-shorthand\nnpm install\nhh compile\n```\n\nTo execute tests \n```sh\nhh test\n```\n\n### General Setup \n\n#### 1. RPC provider\nI recommend you to use [Alchemy API](https://www.alchemy.com/) \n\n```dosini\nRINKEBY_RPC_URL=https://eth-rinkeby.alchemyapi.io/v2/\u003cAPI-KEY\u003e\n```\n\n#### 2. Mnemonic\nYou can export you mnemonic from MetaMask\n\n```dosini\nMNEMONIC=your-mnemonic-passphrase\n```\n\n#### 3. Etherscan API\nSetup [Etherscan API](https://etherscan.io/) key so you will be able to verify your contract, this will enable \nyou to interact with smart contract via Etherscan.\n\n```dosini\nETHERSCAN_API_KEY=\u003cYOUR-KEY\u003e\n```\n\n### Deploying Nfty Pass\n\nTo deploy Nfty Pass we will set default base uri which the contract will have\n\n```dosini\nNFTY_PASS_BASE_URL=www.placeholder.com/\n```\n\n#### Deployment\n\nFirst argument is Contract address that was deployed and the second one is base url\nthat was used in deployment.\n```sh\nhh deploy --tags pass --network rinkeby\n\nhh verify \u003cCONTRACT-ADDRESS\u003e \"www.placeholder.com/\" --network rinkeby\n```\n\nThe ABI json file which is needed by the GUI to interact with smart contract is located\nat `./abi/contracts/NftyPass/NftyPass.json`\n\n### Deploying Nfty Halloween set\nTo deploy Halloween set we will have set NftyPass Contract Address and base url\n\n```dosini\nNFTY_HALLOWEEN_BASE_URL=www.placeholder2.com/\nNFTY_HALLOWEEN_NFTY_PASS_ADDRESS=0xbe715eBA71324CE2277144D09aFe678c881B6615\n```\n\nFirst argument is contract address.\n\nSecond argument is `NFTY_HALLOWEEN_BASE_URL`\n\nThird argument is `NFTY_HALLOWEEN_NFTY_PASS_ADDRESS`\n```sh\nhh deploy --tags halloween --network rinkeby\n\nhh verify \u003cCONTRACT-ADDRESS\u003e \"www.placeholder2.com/\" \"0xbe715eBA71324CE2277144D09aFe678c881B6615\" --network rinkeby\n```\n\nABI json file is located at `./abi/contracts/NftyHalloween/NftyHalloween.json`\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprotokol%2Fnfty-village","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprotokol%2Fnfty-village","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprotokol%2Fnfty-village/lists"}