Merge pull request #46 from Polymarket/feat/v1.1

Feat: v1.0.1

.github/workflows/CONTRIBUTING.md

@@ -7,9 +7,9 @@ All contributions are welcome and greatly appreciated! This document serves to o
 1. Fork this repo
 2. Clone your fork
 3. Follow the [installation instructions](./README.md) in the monorepo's top level README.
-4. Open pull requests with the `[WIP]` flag against the `main` branch and include a description of the intended change in the PR description.
+4. Open pull requests with the `WIP` flag against the `main` branch and include a description of the intended change in the PR description.
 
-Before removing the `[WIP]` tag and submitting a PR for review, make sure that:
+Before removing the `WIP` tag and submitting a PR for review, make sure that:
 
 - it passes our linter checks
 - the test suite passes for all packages
@@ -20,10 +20,10 @@ Before removing the `[WIP]` tag and submitting a PR for review, make sure that:
 
 Our main branch, `main`, represents the current development state of the codebase. All pull requests should be opened against `main`.
 
-Name your branch with the format `{fix | feature | refactor }/{ description }`
+Name your branch with the format `{fix | feat | refactor }/{ description }`
 
 - A `fix` addresses a bug or other issue
-- A `feature` adds new functionality/interface surface area
+- A `feat` adds new functionality/interface surface area
 - A `refactor` changes no business logic or interfaces, but improves implementation
 
 ### Additional Details

.github/workflows/Lint.yaml

@@ -22,10 +22,8 @@ jobs:
               run: yarn
             - name: Typechain
               run: yarn typechain
-              working-directory: ./packages/contracts
             - name: Lint Typescript
               run: yarn lint:ts
-              working-directory: ./packages/contracts
     lint-contracts-solidity:
         runs-on: ubuntu-latest
         steps:
@@ -41,23 +39,6 @@ jobs:
               run: yarn
             - name: Lint Solidity
               run: yarn lint:sol
-              working-directory: ./packages/contracts
-    lint-sdk:
-      runs-on: ubuntu-latest
-      steps:
-          - name: Checkout code
-            uses: actions/checkout@v2
-            with:
-                persist-credentials: false
-          - name: Install node
-            uses: actions/setup-node@v1
-            with:
-                node-version: 16
-          - name: Install dependencies
-            run: yarn
-          - name: Lint Typescript
-            run: yarn lint
-            working-directory: ./packages/sdk
 
 env:
     MNEMONIC: "test test test test test test test test test test test test"

.github/workflows/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,4 @@
-<!-- Pull request template for the Adapter -->
+<!-- Pull request template for the UMA CTF Adapter -->
 <!-- Delete any sub-sections not used rather than leaving them empty. -->
 
 ## Overview
@@ -32,7 +32,7 @@
 <!-- Check any boxes that are already complete upon creation of the PR, and update whenever necessary. -->
 <!-- Make sure to check the "Ready for review" box when you are signing off on your changes for merge! -->
 
-- [ ] Prefix PR title with `[WIP]` if necessary (changes not yet made).
+- [ ] Prefix PR title with `WIP` if necessary (changes not yet made).
 - [ ] Add tests to cover changes as needed.
 - [ ] Update documentation/changelog as needed.
 - [ ] Verify all tests run correctly in CI and pass.

.github/workflows/Tests.yaml

@@ -22,18 +22,18 @@ jobs:
               run: yarn
             - name: Typechain
               run: yarn typechain
-              working-directory: ./packages/contracts
+
             - name: Test
               run: yarn test
-              working-directory: ./packages/contracts
+
             - name: Run tests with coverage
               run: yarn coverage
-              working-directory: ./packages/contracts
+
             - name: Upload coverage report
               uses: coverallsapp/github-action@master
               with:
                 github-token: ${{ secrets.GITHUB_TOKEN }}
-                path-to-lcov: ./packages/contracts/coverage/lcov.info
+                path-to-lcov: ./coverage/lcov.info
 
 env:
     MNEMONIC: "test test test test test test test test test test test test"

packages/contracts/.solhint.json → .solhint.json

@@ -10,7 +10,7 @@
         ],
         "compiler-version": [
             "error",
-            "0.8.0"
+            "0.8.10"
         ],
         "const-name-snakecase": "off",
         "constructor-syntax": "error",

README.md

@@ -1,23 +1,20 @@
-# UMA Conditional Tokens Binary Adapter
+# Polymarket UMA CTF Adapter
 
 ![Github Actions](https://github.com/Polymarket/uma-conditional-tokens-adapter/workflows/Tests/badge.svg)
 ![Github Actions](https://github.com/Polymarket/uma-conditional-tokens-adapter/workflows/Lint/badge.svg)
 [![Coverage](https://coveralls.io/repos/github/Polymarket/uma-conditional-tokens-adapter/badge.svg?branch=main)](https://coveralls.io/github/Polymarket/uma-conditional-tokens-adapter?branch=main)
 
 ## Overview
 
-This repository contains code used to resolve [Polymarket](https://polymarket.com/) prediction markets via UMA's [optimistic oracle](https://docs.umaproject.org/oracle/optimistic-oracle-interface).
+This repository contains contracts used to resolve [Polymarket](https://polymarket.com/) prediction markets via UMA's [optimistic oracle](https://docs.umaproject.org/oracle/optimistic-oracle-interface).
 
 ### [Architecture](./docs/Architecture.md)
 ![Contract Architecture](./docs/adapter.png)
 
 
 ### Deployments
 
-| Network          | Address                                                                           |
-| ---------------- | --------------------------------------------------------------------------------- |
-| Polygon          | [0xCB1822859cEF82Cd2Eb4E6276C7916e692995130](https://polygonscan.com/address/0xCB1822859cEF82Cd2Eb4E6276C7916e692995130)|
-| Mumbai           | [0xCB1822859cEF82Cd2Eb4E6276C7916e692995130](https://mumbai.polygonscan.com/address/0xCB1822859cEF82Cd2Eb4E6276C7916e692995130)|
+See [current deployments](./deploys.md)
 
 
 ### Dependencies
@@ -27,13 +24,15 @@ Install dependencies with `yarn install`
 
 ### Compile
 
-Compile the contracts with `yarn compile`
 
+Compile the contracts with `yarn compile`
 
 ### Testing
 
+
 Test the contracts with `yarn test`
 
 ### Coverage
 
+
 Generate coverage reports with `yarn coverage`

packages/contracts/config/env.ts → config/env.ts

@@ -1,7 +1,7 @@
 import { config as dotenvConfig } from "dotenv";
 import { resolve } from "path";
 
-dotenvConfig({ path: resolve(__dirname, "../../../.env") });
+dotenvConfig({ path: resolve(__dirname, "../.env") });
 
 // Ensure that we have all the environment variables we need.
 if (!process.env.MNEMONIC) {