chore: setup helpers repo

mimic-fi · Sep 15, 2024 · 59a6392 · 59a6392
1 parent 0c82555
commit 59a6392
Show file tree

Hide file tree

Showing 72 changed files with 10,143 additions and 527 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,43 @@
+name: CI
+
+env:
+  CI: true
+
+on:
+  push:
+    branches: "*"
+  pull_request:
+    branches: "*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Install
+        run: yarn
+      - name: Build
+        run: yarn build
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Install
+        run: yarn
+      - name: Lint
+        run: yarn lint
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Install
+        run: yarn
+      - name: Build
+        run: yarn build
+      - name: Test
+        run: yarn test
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,5 @@
+node_modules
+artifacts
+cache
+dist
+*.log
diff --git a/README.md b/README.md
@@ -5,11 +5,11 @@
 <h4 align="center">DeFi automation platform</h4>
 
 <p align="center">
-  <a href="https://badge.fury.io/js/@mimic-fi%2Fv3-helpers">
-    <img src="https://badge.fury.io/js/@mimic-fi%2Fv3-helpers.svg" alt="NPM">
+  <a href="https://badge.fury.io/js/@mimic-fi%2Fhelpers">
+    <img src="https://badge.fury.io/js/@mimic-fi%2Fhelpers.svg" alt="NPM">
   </a>
-  <a href="https://github.com/mimic-fi/v3-core/actions/workflows/ci-helpers.yml">
-    <img src="https://github.com/mimic-fi/v3-core/actions/workflows/ci-helpers.yml/badge.svg" alt="CI Helpers">
+  <a href="https://github.com/mimic-fi/helpers/actions/workflows/ci-helpers.yml">
+    <img src="https://github.com/mimic-fi/helpers/actions/workflows/ci-helpers.yml/badge.svg" alt="CI">
   </a>
   <a href="https://discord.mimic.fi">
     <img alt="Discord" src="https://img.shields.io/discord/989984112397922325">
@@ -30,7 +30,7 @@
 
 ## Content 
 
-This package contains a bunch of Solidity and TypeScript helpers used among all Mimic v3 repositories.
+This package contains a bunch of Solidity and TypeScript helpers used among all Mimic repositories.
 
 ## Setup
 
@@ -39,10 +39,10 @@ From your command line:
 
 ```bash
 # Clone this repository
-$ git clone https://github.com/mimic-fi/v3-core
+$ git clone https://github.com/mimic-fi/helpers
 
 # Go into the repository's package
-$ cd v3-core/packages/helpers
+$ cd helpers
 
 # Install dependencies
 $ yarn

diff --git a/contracts/mocks/FeedMock.sol b/contracts/mocks/FeedMock.sol
diff --git a/hardhat.config.ts b/hardhat.config.ts
@@ -3,7 +3,7 @@ import '@nomiclabs/hardhat-waffle'
 
 export default {
   solidity: {
-    version: '0.8.17',
+    version: '0.8.20',
     settings: {
       optimizer: {
         enabled: true,

diff --git a/index.ts b/index.ts
@@ -1,10 +1,12 @@
-export * from './src/addresses'
+export * from './src/arrays'
 export * from './src/asserts'
 export * from './src/blocks'
 export * from './src/constants'
 export * from './src/contracts'
 export * from './src/mocks'
 export * from './src/numbers'
+export * from './src/random'
 export * from './src/signers'
-export * from './src/tests'
 export * from './src/time'
+export * from './src/types'
+export * from './src/validators'
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
-  "name": "@mimic-fi/v3-helpers",
-  "version": "0.1.12",
+  "name": "@mimic-fi/helpers",
+  "version": "1.0.0-rc.0",
   "license": "GPL-3.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,29 +15,29 @@
     "build": "yarn compile && rm -rf dist && tsc",
     "compile": "hardhat compile",
     "lint": "yarn lint:solidity && yarn lint:typescript",
-    "lint:solidity": "solhint 'contracts/**/*.sol' --config ../../node_modules/solhint-config-mimic/index.js",
+    "lint:solidity": "solhint 'contracts/**/*.sol' --config ./node_modules/solhint-config-mimic/index.js",
     "lint:typescript": "eslint . --ext .ts",
     "test": "hardhat test",
     "prepare": "yarn build"
   },
   "dependencies": {
     "@nomiclabs/hardhat-ethers": "^2.2.3",
     "@nomiclabs/hardhat-waffle": "2.0.3",
-    "@types/chai": "^4.3.5",
-    "@types/mocha": "^10.0.1",
-    "@types/sinon-chai": "^3.2.3",
-    "chai": "^4.3.7",
+    "@openzeppelin/contracts": "5.0.2",
     "decimal.js": "~10.4.3",
     "ethers": "~5.6.0",
-    "hardhat": "^2.14.1",
-    "mocha": "^6.2.3"
+    "hardhat": "^2.14.1"
   },
   "devDependencies": {
+    "@types/chai": "^4.3.5",
+    "@types/mocha": "^10.0.1",
+    "chai": "^4.3.7",
     "eslint-config-mimic": "^0.0.2",
     "ethereum-waffle": "^3.4.4",
     "solhint-config-mimic": "^0.0.3",
+    "mocha": "^6.2.3",
     "ts-node": "^10.9.1",
-    "typescript": "~4.3.4"
+    "typescript": "^5.6.2"
   },
   "eslintConfig": {
     "extends": "eslint-config-mimic",

diff --git a/src/addresses/chainlink/arbitrum.ts b/src/addresses/chainlink/arbitrum.ts
diff --git a/src/addresses/chainlink/avalanche.ts b/src/addresses/chainlink/avalanche.ts
diff --git a/src/addresses/chainlink/base.ts b/src/addresses/chainlink/base.ts
diff --git a/src/addresses/chainlink/bsc.ts b/src/addresses/chainlink/bsc.ts
diff --git a/src/addresses/chainlink/denominations.ts b/src/addresses/chainlink/denominations.ts
diff --git a/src/addresses/chainlink/fantom.ts b/src/addresses/chainlink/fantom.ts
diff --git a/src/addresses/chainlink/gnosis.ts b/src/addresses/chainlink/gnosis.ts
diff --git a/src/addresses/chainlink/goerli.ts b/src/addresses/chainlink/goerli.ts
diff --git a/src/addresses/chainlink/index.ts b/src/addresses/chainlink/index.ts
diff --git a/src/addresses/chainlink/mainnet.ts b/src/addresses/chainlink/mainnet.ts
diff --git a/src/addresses/chainlink/mumbai.ts b/src/addresses/chainlink/mumbai.ts
diff --git a/src/addresses/chainlink/optimism.ts b/src/addresses/chainlink/optimism.ts
diff --git a/src/addresses/chainlink/polygon.ts b/src/addresses/chainlink/polygon.ts
diff --git a/src/addresses/hop/arbitrum.ts b/src/addresses/hop/arbitrum.ts
diff --git a/src/addresses/hop/base.ts b/src/addresses/hop/base.ts
diff --git a/src/addresses/hop/gnosis.ts b/src/addresses/hop/gnosis.ts
diff --git a/src/addresses/hop/goerli.ts b/src/addresses/hop/goerli.ts
diff --git a/src/addresses/hop/index.ts b/src/addresses/hop/index.ts
diff --git a/src/addresses/hop/mainnet.ts b/src/addresses/hop/mainnet.ts
diff --git a/src/addresses/hop/mumbai.ts b/src/addresses/hop/mumbai.ts
diff --git a/src/addresses/hop/optimism.ts b/src/addresses/hop/optimism.ts
diff --git a/src/addresses/hop/polygon.ts b/src/addresses/hop/polygon.ts
diff --git a/src/addresses/index.ts b/src/addresses/index.ts
diff --git a/src/addresses/protocols/arbitrum.ts b/src/addresses/protocols/arbitrum.ts
diff --git a/src/addresses/protocols/aurora.ts b/src/addresses/protocols/aurora.ts
diff --git a/src/addresses/protocols/avalanche.ts b/src/addresses/protocols/avalanche.ts
diff --git a/src/addresses/protocols/base.ts b/src/addresses/protocols/base.ts
diff --git a/src/addresses/protocols/bsc.ts b/src/addresses/protocols/bsc.ts
diff --git a/src/addresses/protocols/fantom.ts b/src/addresses/protocols/fantom.ts
diff --git a/src/addresses/protocols/gnosis.ts b/src/addresses/protocols/gnosis.ts