Getting Started

The developer quickstart repo has been created to enable more efficient development, testing, and contract deployment when working with UMA contracts. The below tutorial walks through setting up your environment to work with the repo and integrating your contracts with the UMA ecosystem.
Install dependencies
To install dependencies, you will need to install the long-term support version of nodejs, currently nodejs v14 or v16 and yarn. You can then install dependencies by running yarn with no arguments:
1
yarn
Copied!
Compiling your contracts
For testing, the repo is configured to deploy core components of the UMA ecosystem. The OptimisticDepositBox contract has been added as an example for testing. For reference, here is the full list of UMA contracts.
To add new or existing contracts for testing, add files to the contracts folder and confirm your contracts imports are accurate.
Compile your contracts using the below command:
1
yarn hardhat compile
Copied!
When working on changes to your contracts, this command will also recompile contracts so that changes will be implemented.
Testing your contracts
The UmaEcosystem fixture deploys UMA ecosystem contracts and the OptimisticDepositBox fixture deploys an OptimisticDepositBox and USDC contract which is whitelisted with the IdentifierWhitelist to be used as collateral. Before creating your own tests, confirm that all UMA contracts you plan to work with are included in the UmaEcosystem fixture.
Tests can be composed to validate expected functionality and running through the lifecycle of a contract without needing to consider aspects such as the liveness period for proposals or gas. To create tests, add scripts to the test folder and run the command:
1
yarn test
Copied!
Below are example unit tests for the OptimisticDepositBox deposit method:
1
import { SignerWithAddress, expect, Contract, ethers } from "./utils";
2
import { umaEcosystemFixture } from "./fixtures/UmaEcosystem.Fixture";
3
import { optimisticDepositBoxFixture } from "./fixtures/OptimisticDepositBox.Fixture";
4
import { amountToSeedWallets, amountToDeposit } from "./constants";
5
​
6
let optimisticDepositBox: Contract, usdc: Contract, collateralWhitelist: Contract;
7
let deployer: SignerWithAddress, depositor: SignerWithAddress;
8
​
9
describe("Optimistic Deposit Box Deposit functions", function () {
10
  beforeEach(async function () {
11
    [deployer, depositor] = await ethers.getSigners();
12
    ({ collateralWhitelist } = await umaEcosystemFixture());
13
    ({ optimisticDepositBox, usdc } = await optimisticDepositBoxFixture());
14
​
15
    // mint some fresh tokens for the depositor.
16
    await usdc.connect(deployer).mint(depositor.address, amountToSeedWallets);
17
    
18
    // Approve the OptimisticDepositBox to spend tokens
19
    await usdc.connect(depositor).approve(optimisticDepositBox.address, amountToSeedWallets);
20
  });
21
  it("Depositing ERC20 tokens correctly pulls tokens and changes contract state", async function () {
22
    // Confirms usdc is whitelisted collateral.
23
    expect(await collateralWhitelist.connect(deployer).isOnWhitelist(usdc.address)).to.equal(true);
24
​
25
    expect(await optimisticDepositBox.totalOptimisticDepositBoxCollateral()).to.equal(0);
26
​
27
    // Deposits ERC20 tokens into the Optimistic Deposit Box contract
28
    await expect(optimisticDepositBox.connect(depositor).deposit(amountToDeposit))
29
      .to.emit(optimisticDepositBox, "Deposit")
30
      .withArgs(depositor.address, amountToDeposit);
31
​
32
    // The collateral should have transferred from depositor to contract.
33
    expect(await usdc.balanceOf(depositor.address)).to.equal(amountToSeedWallets.sub(amountToDeposit));
34
    expect(await usdc.balanceOf(optimisticDepositBox.address)).to.equal(amountToDeposit);
35
​
36
    // getCollateral for user should equal deposit amount.
37
    expect(await optimisticDepositBox.getCollateral(depositor.address)).to.equal(amountToDeposit);
38
    expect(await optimisticDepositBox.totalOptimisticDepositBoxCollateral()).to.equal(amountToDeposit);
39
  });
40
  it("Deposits a denominated collateral amount of 0", async function () {
41
    // collateral deposit amount should be above 0
42
    await expect(optimisticDepositBox.connect(depositor).deposit("0")).to.be.revertedWith("Invalid collateral amount");
43
  });
44
});
Copied!
Deploying your contracts
If you wish to deploy your contract to a testnet for further testing, the hardhat deploy command can be used. The OptimisticDepositBox deploy command for Kovan is shown as an example below:
1
NODE_URL_42=https://kovan.infura.com/xxx yarn hardhat deploy --tags OptimisticDepositBox --network kovan
Copied!
After deploying your contract, your contract can be verified on Etherscan using the following command:
1
ETHERSCAN_API_KEY=XXX yarn hardhat etherscan-verify --network kovan --license AGPL-3.0 --force-license --solc-input
Copied!
You have now compiled your contracts, tested functionality within the UMA ecosystem, and deployed to a testnet. For any questions or feedback you may have, you can find us in the UMA Discord.
UMA Protocol
Next - Developers
Solidity Examples
Last modified 1mo ago
Copy link
Contents