https://github.com/umaprotocol/dev-quickstart

https://github.com/umaprotocol/dev-quickstart

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/umaprotocol/dev-quickstart
• Owner: UMAprotocol
• License: agpl-3.0
• Created: 2022-05-13T18:55:15.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-13T10:29:17.000Z (over 1 year ago)
• Last Synced: 2023-03-24T02:40:32.799Z (over 1 year ago)
• Language: TypeScript
• Size: 436 KB
• Stars: 7
• Watchers: 9
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Developer Quickstart Repo

This repo is intended to have scripts and tests available to allow for testing UMA contracts. The repo uses the `OptimisticDepositBox` and `EventBasedPredictionMarket` contracts as examples.

## Install dependencies

You will need to install the long-term support version of nodejs, currently nodejs v16. You will also need to install yarn.

## Build

```shell

yarn

yarn hardhat compile

```

## Test

```shell

yarn test # Run unit tests

```

## Lint

```shell

yarn lint

yarn lint-fix

```

## Deploying your contracts

Use the command below to deploy a particular contract (along with any dependencies that haven't been deployed on this network). In the deploy script, the `func.tags` determines the contracts to deploy which is specified using the `--tags` arg in the command:

```sh

export MNEMONIC="Your 12-word phrase here"

export CUSTOM_NODE_URL="Your node url here"

yarn hardhat deploy --network goerli --tags OptimisticDepositBox,EventBasedPredictionMarket

```

## Contract verification

To perform an etherscan verification on a particular contract address that you have deployed on a public network:

```sh

export ETHERSCAN_API_KEY="Your etherscan api key here"

export CUSTOM_NODE_URL="Your node url here"

yarn hardhat verify "Your contract address here" --network goerli

```

To perform a verification on all the contracts you have deployed on a particular network:

```sh

export CUSTOM_NODE_URL="Your node url here"

export ETHERSCAN_API_KEY="Your etherscan api key here"

yarn hardhat etherscan-verify --network goerli --license AGPL-3.0 --force-license

```