erc721nftlab v2.3.4

ERC721 Marketplace

Description

This repo contains the contracts (along with their tests) to build an ERC721 marketplace on ethereum, wich underlying currency can either be ethereum itself (with eth) or an IERC20 implementation (Openzeppelin's implementation or your custom implementation). Can be imported as a npm package (procedure described below), this wway it provides alla the contracts, ABI for them and typechain generated code for static typing in typescript to build a dApp on top of it with ethers.js

Usage

npm i --save-dev erc721nftlab

It installs the package and everythin needed in order to use ABI's alone with web3 or use typechain and ethers for static typing your dapp.

Install dependencies, compile, build on top of it

npm i
npm run compile

• compile the contracts
• deploy them trough the provided scripts trough an ethereum node (Infura provides some for free)
• build a frontend that handles contract calls (I suggest metamask apis combined with ethers to interact with your contract)
• deploy (if your site is a single page site build for example with angular or react i also suggesto ipfs to deploy it for free)

Tests

All the contracts are tested with hardhat (and compiled with it), the tests are available in the test folder and can be executed with

npm run test

Contributing

For every feature request submit a pull request and if useful and meaningful wil certainly be approved by someone.

Standards

all the code to be integrated has to be formatted with prettier. Fortunately we provide an easy way to do so, just run

npm run prettify

and your code will automatically be formatted, so that everything is uniform. After that commit and make your pull request

Documentation

Documentation for architectural and implementation decisions can be found on the wiki page