From 886106d26c3568b1aefa5962b486e89c061a49ff Mon Sep 17 00:00:00 2001 From: Nicholas Addison Date: Tue, 25 Jan 2022 16:01:21 +1100 Subject: [PATCH] chore: added compile-ts to prepublishOnly script chore: bumped version to 2.4.1 --- README.md | 7 ++++--- package.json | 4 ++-- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7aec5186..a93120fb 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ We publish the contract artifacts to an npm package called [@mstable/protocol](h ### Prerequisites -- Node.js v10.22.0 (you may wish to use [nvm][1]) +- Node.js v14.16.1 (you may wish to use [nvm][1]) - [ganache-cli][2] ### Installing dependencies @@ -74,6 +74,7 @@ Key folders: - `/contracts/z_mocks`: All mocks used throughout the test suite - `/security`: Scripts used to run static analysis tools like Slither and Securify +- `/tasks`: Hardhat tasks that run operational reports and transactions. - `/test`: Unit tests in folders corresponding to contracts/xx - `/test-utils`: Core util files used throughout the test framework - `/machines`: Mock contract machines for creating configurable instances of the contracts @@ -90,10 +91,10 @@ _NB: solidity-coverage runs with solc `optimizer=false` (see [discussion](https: ### CI -Codebase rules are enforced through a passing [CI](https://circleci.com) (visible in `.circleci/config.yml`). These rules are: +Codebase rules are enforced through a passing [GitHub Actions](https://github.com/features/actions) (workflow configs are in `.github/workflows`). These rules are: - Linting of both the contracts (through Solium) and TS files (ESLint) -- Passing test suite +- Passing unit test suite - Maintaining high unit testing coverage ### Code formatting diff --git a/package.json b/package.json index beed5fb6..75d208a8 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@mstable/protocol", - "version": "2.4.0", + "version": "2.4.1", "description": "mStable Contracts", "author": "mStable ", "license": "AGPL-3.0-or-later", @@ -38,7 +38,7 @@ "test:file": "yarn hardhat test", "test:file:long": "LONG_TESTS=true yarn hardhat test", "copy-types": "cp -R types/generated dist/types", - "prepublishOnly": "yarn compile && yarn copy-types" + "prepublishOnly": "yarn compile && yarn compile-ts && yarn copy-types" }, "repository": { "type": "git",