EREBRUS

We are trying to implement a Utility NFT where subscription, royalty for the creator, and rental facilities are available, the NFT will be disclosed on the closing date, and the wallet address will be whitelisted prior to that. Utility non-fungible tokens (NFTs) are digital assets that represent a right or access to a service or product. They are similar to traditional NFTs in that they are unique and cannot be exchanged for other tokens on a one-to-one basis, but they differ in that they have a specific use beyond being a collectible or piece of artwork.

Erebrus deployed to: 0x24631D9a109e4671107044F50D231C5C583759c8 https://mumbai.polygonscan.com/address/0x24631D9a109e4671107044F50D231C5C583759c8#code

Getting Started

Requirements

git
- You'll know you did it right if you can run git --version and you see a response like git version x.x.x
Nodejs
- You'll know you've installed nodejs right if you can run:
  - node --version and get an output like: vx.x.x
Yarn instead of npm
- You'll know you've installed yarn right if you can run:
  - yarn --version and get an output like: x.x.x
  - You might need to install it with npm or corepack

Quickstart

git clone https://github.com/soumalya340/erebrus-contracts
cd erebrus-contracts
yarn
yarn hardhat

Usage

Deploy:

npx hardhat run scripts/deploy.js

Testing

npx hardhat test

Test Coverage

npx hardhat coverage

Estimate gas

You can estimate how much gas things cost by running:

npx hardhat test

And you'll see and output file called gas-report.txt

Local Deployment

If you'd like to run your own local hardhat network, you can run:

npx hardhat node

And then in a different terminal

npx hardhat run scripts/deploy.js --network localhost

And you should see transactions happen in your terminal that is running npx hardhat node

Important localhost note

If you use metamask with a local network, everytime you shut down your node, you'll need to reset your account. Settings -> Advanced -> Reset account. Don't do this with a metamask you have real funds in. And maybe don't do this if you're a little confused by this.

Deployment to a testnet or mainnet

Setup environment variables

You'll want to set your GOERLI_RPC_URL and PRIVATE_KEY as environment variables. You can add them to a .env file, similar to what you see in .env.example.

PRIVATE_KEY: The private key of your account (like from metamask). NOTE: FOR DEVELOPMENT, PLEASE USE A KEY THAT DOESN'T HAVE ANY REAL FUNDS ASSOCIATED WITH IT.
- You can learn how to export it here.
GOERLI_RPC_URL: This is url of the goerli testnet node you're working with. You can get setup with one for free from Alchemy

Get testnet ETH

Head over to faucets.chain.link and get some tesnet ETH. You should see the ETH show up in your metamask.

Deploy

=======
npx hardhat run scripts/deploy.js --network maticmum
>>>>>>> (goerli update)

Verify on etherscan

If you deploy to a testnet or mainnet, you can verify it if you get an API Key from Etherscan and set it as an environment variable named ETHERSCAN_API_KEY. You can pop it into your .env file as seen in the .env.example.

However, you can manual verify with:

npx hardhat verify --constructor-args arguments.js DEPLOYED_CONTRACT_ADDRESS

Linting

To check linting / code formatting:

yarn lint

or, to fix:

yarn lint:fix

soumalya340/erebrus-contracts