OpenSubs

OpenSubs is an NFT marketplace that enables NFT rental through the ERC-4907 standard. By tokenizing the subscriptions of streaming platforms, OpenSubs will allow users to rent their subscriptions from peer to peer.

People without a subscription will be able to rent a subscription to have access to the platform for a given time. People with a subscription who rent it can earn passive income during the time they are not using their subscription. Streaming platforms, like OpenSubs, will receive a commission for each rental between users.

This project is composed of a hardhat local blockchain, and a react application containing a marketplace and two clones of popular digital service platforms.

Requirements

• Docker Compose
• Make (optional)

Project initialization

Metadata storage / Firebase

You will need a storage solution to fetch and push metadata at NFT minting. For this project we used Firebase Storage solution, and you have to reproduce this to make applications run.

You have to set up your own Firebase Storage and fill environment variables (see below). These variables will be loaded in frontend/src/firebaseConfig.ts then the configuration is used to initialize Firebase app in frontend/src/App.tsx.

Your storage should have this structure:

• metadata/
  • fakeflix/
  • spooftify/

The other resources like logos or services content are freely available.

Environment variables

After cloning the repository

• Create ethereum/.env from the template ethereum/.env.default and fill in the values
• Create frontend/.env from the template frontend/.env.default and fill in the values

Start development environment

Run the following command to start Docker containers:

docker compose up

NPM dependencies will be installed automatically.

Access

You should access the React application at the following URL: http://localhost

Useful commands

Compile smart contracts

# With Make
make compile

# Without Make
docker compose exec hardhat npx hardhat compile

Run smart contract unit tests

# With Make
make test

# Without Make
docker compose exec hardhat npx hardhat test --network localhost

Get test coverage

# With Make
make coverage

# Without Make
docker compose exec hardhat npx hardhat coverage --network hardhat

Deploy contracts

On hardhat local blockchain

# With Make
make run

# Without Make
docker compose exec hardhat npx hardhat run ./scripts/deploy-dev.ts --network localhost

On testnet/mainnet

# With Make
make run SCRIPT="./scripts/deploy.ts" NETWORK=<network>

# Without Make
docker compose exec hardhat npx hardhat run ./scripts/deploy.ts --network <network>

Restart react application

A restart is needed after changing values in frontend/.env file:

docker compose restart react

Start hardhat console

# With Make
make console

# Without Make
docker compose exec hardhat npx hardhat console --network localhost