UMA Protocol

Documentation 📚

Our docs site is here. It contains tutorials, explainers, and smart contract documentation. If you'd like to view these docs on github instead, check out the documentation folder in the docs repo.

Security and Bug Bounty 🐛

Please see here for details on our bug bounty.

Contributing 🙌

Please see our contributing guidelines.

Developer Information and Tools 👩‍💻

For detailed information on how to initialize and interact with our smart contracts, please see the documentation site.

Install dependencies 👷‍♂️

You'll need to install the long-term support version of nodejs, currently nodejs v14. You will also need to install yarn. Assuming that's done, run

yarn

yarn

If you'd like to completely clear all packages'

node_modules

yarn clean-packages
yarn

Build the code 🧐

Some code in the repository requires a build step to compile it. To run this build step, use the

qbuild

yarn qbuild

The above command does not include dapps because dapps take a long time to build and they have their own scripts to run locally. However, if you'd like to build everything, you can use the build command:

yarn build

To remove any remnants of previous builds, you can run:

yarn clean

Run tests 🦾

To run tests, you'll need to start ganache on port 9545:

yarn ganache-cli -e 1000000000 -p 9545 -l 9000000 -d

Note: if you're interested in what these args do:

• -e

  is the amount of ETH to grant the default accounts.

• -p

  is the port that ganache will listen on.

• -d

  tells ganache to use a standard set of deterministic accounts on each run.

Then, you can run all of the tests across the repo by running:

yarn test

However, running all of the tests across the repository takes a lot of time. To run the tests for just one package, you can run:

yarn workspace  test

Running the linter 🧽

To run the linter in autofix mode (it will attempt to fix any errors it finds), run:

yarn lint-fix

To run the linter in the default mode, where it will print all errors and not modify code, run:

yarn lint

Packages 📦

Because this repo is a monorepo, it conatains many different npm packages. More will be discussed about these packages in the following sections. However, the basic structure is that each pacakge is listed in the

packages/

Adding dependencies 👩‍👦

All runtime/production dependencies should be added to the package that needs them. Development dependencies should also generally be installed in packages unless they are needed by code that exists outside of any package.

For more details on packages and the monorepo, please see the next section.

To add a dependency to a package:

yarn workspace  add 

Note: development dependencies are those that are not required by the code that's published to the npm registry. If you're not sure whether a dependency should be dev or not, just ask! To install a dev dependency in a package:

yarn workspace  add  --dev

Note: all root dependencies should be dev dependencies because the root package is not published to npm, so there is no "production" code. To install a dev dependency at root:

yarn add  --dev

After you've installed a dependency, yarn should automatically update the

yarn.lock

yarn

Depending on another package in the monorepo 🤝

The standard way to pull a JS element from another package is to reference it like this:

const { importedObject } = require("@uma/some-package")

Note: the require will resolve to the

main

package.json

files

package.json

const { importedObject } = require("@uma/some-package/path/to/some/file")

Note: if this file isn't exported by the

files

To install this dependency you're using in

@uma/my-package

yarn lerna add @uma/some-package --scope @uma/my-package

By default, this will symlink the package in

node_modules

package.json

Using yarn and lerna 🧑‍🍳

This repository is a monorepo. That means that it contains many different, but related packages. It uses yarn workspaces and lerna to manage these packages.

Note: lerna and yarn workspaces have some overlapping functionality. This is because

lerna

yarn

yarn

npm

yarn

yarn 

Once you run

yarn

yarn lerna 

To run a yarn command in a particular sub-package, you can run the following from anywhere in the repo:

yarn workspace