/Adivin-Prediction-Market

Primary LanguageSolidity

Adivin Prediction Market

An EVM based prediction market. Users deposit their wager in an Escrow contract in exchange for an ERC1155 token representation of their bet. Prediction tokens are tradable on any secondary market (ex: opensean). Once the market expires, an Oracle submits the winning result. Users can then cash out their winnings from the Escrow contract. Cashing out a wager results in the user burning their ERC1155 token and receiving their winnings from the Escrow contract.

Set up environment

Assuming you already have Foundry installed on your computer, update it to the latest version:

foundryup

Also, make sure to run yarn to install all the dependencies.

Finally, yarn build to build the project.

How to Deploy

Create a .env file in the root directory. Use .env.example as a template

source .env to load the environment variables

Deploy the contract factory

# load the environment variables
source .env

forge script script/FactoryDeployer.s.sol:FactoryDeployer --rpc-url $MUMBAI_RPC_URL --broadcast --optimizer-runs 2000 -vv --sig "deploy()"

# OR deploy it with a test market and test erc20
forge script script/FactoryDeployer.s.sol:FactoryDeployer --rpc-url $MUMBAI_RPC_URL --broadcast --optimizer-runs 2000 -vv --sig "deployWithTestMarket()"

MUMBAI_RPC_URL can be replaced with MAINNET_RPC_URL if you want to deploy to mainnet.

How to verify source code on polygonscan

Contract source code verification will have to be done manually on Polygonscan.

First, run yarn flatten to flatten the contracts. This will create a flattened directory with the flattened contracts.

Then, go to Polygonscan and verify the contracts. Make sure to select "Single File", "Solidity Compiler" 0.8.17 for the compiler version, and "Optimized".

When prompted for the source, copy and paste the contents of flattened/Factory.flattened.sol into the text box.

Design Spec

Actors

  • Administrator
  • User
  • Oracle

Administrator

Actions

  • Create Market
  • Open Market
  • Pause Market
  • Set Oracle
  • Set Escrow

User

Actions

  • Place Bet
  • Cashout Bet

Oracle

Actions

  • Set Market Result (MarketState == FINISHED)

Contracts

  • Factory: Creates markets
  • PredictionMarket: ERC1155 wrapper representing a prediction
  • Escrow: Holds all wagers

Diagrams

Sequence Diagram

Flow Diagram