Vanity Name System

Vanity name registering system resistant against frontrunning

Table of Contents

1. About The Project
2. Built With
3. Getting Started
   • Installation
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Vanity name registering system resistant against frontrunning

Built With

This project is built with:

• Solidity
• Truffle and Ganache
• Ethers.js

Getting Started

• This project consists of 3 smart contracts:

  • VanityNameRegistrar - base contract which inherits ERC721 contract. When I read project task, I recognized that every name should be unique and that should be ideal to be represented as NFT. So, in this project, every vanity name is one NFT.

  • VanityNamePrices - contract for calculate prices for vanity names.

  • VanityNameController - controller contract, which should be main connection between some future front-end and this vanity name system.

Installation

1. Clone the repo

   git clone https://github.com/StefanVitor/vanity-name-system

2. npm install

3. If you want to deploy contracts to Rinkeby / Ropsten, it should be add secrets.json file in main directory with format

{
    "mnemonic": "abc def ghi..."
}

4. Deploy contracts on local truffle or Rinkeby / Ropsten network

truffle --network networkName migrate --reset

5. Test contracts on local truffle or Rinkeby / Ropsten network

truffle --network networkName test

Contributing

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT. See LICENSE for more information.

Contact

Stefan Vitorovic - @StefanVitorovic - [email protected]

Project Link: https://github.com/StefanVitor/vanity-name-system