Git Product home page Git Product logo

augur's Introduction


Augur is a decentralized oracle and peer to peer protocol for prediction markets. Augur is free, public, open source software, portions of which are licensed under the General Public License (GPL) and portions of which are licensed under the Massachusetts Institute of Technology (MIT) license. Augur is a set of smart contracts written in Solidity that can be deployed to the Ethereum blockchain.

Augur is a protocol, freely available for anyone to use however they please. Augur is accessible through a desktop client app, similar to interacting with an Ethereum or Bitcoin node. Users of the Augur protocol must themselves ensure that the actions they are performing are compliant with the laws in all applicable jurisdictions and must acknowledge that others’ use of the Augur protocol may not be compliant. Users of the Augur protocol do so at their own risk.

For more information about the Augur protocol, check out the FAQ.

Looking for Augur App? Click Below:

Installation

Clone Augur's Monorepo.

  • git clone https://github.com/AugurProject/augur.git

Then, install the packages using Yarn -- installation must be done via yarn and not npm since Augur utilizes the Yarn Workspace funcitonality for monorepo support.

  • yarn

Repository Typescript build commands

NOTE: Run yarn at the base of the repository to install dependencies before running any of the following.

Command Purpose
yarn build Build all everything but the UI once.
yarn build:watch Build everything but the UI continuously.
yarn build:clean Remove JUST typescript build artifacts
yarn clean Remove everything that isn't currently being tracked by git (node_modules, build aretifacts, etc.)

UI development

Run the following command:

  • yarn build:watch

Or alternatively using docker-compose:

  • docker-compose -f support/gitstart/gitstart.yml up

On a different terminal window, you can either run with the variable ETHEREUM_NETWORK set to "kovan", that is one of the testnets of the Ethereum Network, or without this variable, in which case it will search for data in your localhost/127.0.0.1. As of right now, "kovan" is the only testnet supported.

Running on localhost:

  • yarn workspace @augurproject/ui dev

Running on the "kovan" testnet

  • ETHEREUM_NETWORK=kovan yarn workspace @augurproject/ui dev

Running the workspace currently shows quite a few warnings regarding source mappings. We will fix this as soon as possible.

Docker images available

Command Purpose
yarn docker:geth:pop-15 15 second block times, real time, has contracts and canned market data.
yarn docker:geth:pop 5 second block times, fake time, use flash scripts to move time .
yarn docker:geth:pop-normal-time 5 second block times, real time, has contracts and canned market data.
yarn docker:geth 5 second block times, blank image with no contracts uploaded.

Use deploy script from augur-tools to manually deploy the contracts.
yarn tools deploy

See Augur Tools for more information.
yarn docker:gnosis Local Gnosis relayer for local development work.

Gnosis Development

For development/testing, we have a Gnosis relayer deployed on Kovan.

The best way to dev against this is to use the running on the "kovan" testnet flow.

  • ETHEREUM_NETWORK=kovan yarn workspace @augurproject/ui dev

Here are some LOADED Portis ACCOUNTS.

Also, you can find the kovan relayer API below -- usful for getting status checks on safes https://gnosis.kovan.augur.net/api/v2/safes/{CHECKSUM_ADDRESS}/funded/

100% Open Source

All parts of Augur are entirely open source. You can view, edit, and contribute to Augur via the repositories hosted on GitHub!

  • Augur Core - The core implementation of the Augur Project as Smart Contracts written in Solidity for the Ethereum Network.
  • Augur SDK - Typescript library for Node.js and the browser to help communicate with the Augur smart contracts.
  • Augur UI - A reference client UI which uses Augur Node and a connection to the Ethereum Network to interact with the Augur community.

Documentation and Whitepaper

Developer documentation is available on the Augur documentation site. If you find any mistakes or want to add any clarifications, you can submit pull requests for updates to the GitHub repository.

If you're interested in going in-depth with Augur, the Augur whitepaper provides an in-depth look at the game theory behind the Augur protocol.

Report Issues

Augur needs community support to find and fix issues in the protocol, middleware, client libraries, and applications. If you have an issue, or find a bug please create an issue with any information needed to recreate the problem.

If you're a developer wanting to contribute to the Augur community, please check out the open issues and feel free to propose fixes by submitting a pull request to the appropriate repository.

augur's People

Contributors

tinybike avatar bthaile avatar stephensprinkle avatar johndanz avatar epheph avatar nuevoalex avatar phoebemirman avatar joeykrug avatar stephensprinkle-zz avatar petong avatar adrake33 avatar mergify[bot] avatar justinbarry avatar scottzer0 avatar pgebheim avatar sharkcrayon avatar priecint avatar robert-e-davidson3 avatar andrewdamelio avatar renovate-bot avatar smallfx avatar micahzoltu avatar bconfortin avatar niran avatar kevinday avatar jonnyburger avatar brianosaurus avatar paullinator avatar renovate[bot] avatar thinkloop avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.