From 6f263c3d7bfd413af42bf3a26192c50deb0f971f Mon Sep 17 00:00:00 2001 From: Antonio Salazar Cardozo Date: Wed, 8 Apr 2020 14:34:59 -0400 Subject: [PATCH 1/3] Reflect NPM package in README The README was still referencing the outdated GitHub Package Registry deployment. --- README.adoc | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/README.adoc b/README.adoc index af290d1ac..7ba4f5914 100644 --- a/README.adoc +++ b/README.adoc @@ -31,22 +31,21 @@ https://discord.gg/4R6RGFf[Discord]. == Installation -tBTC contracts are currently published in the GitHub Package Registry. +tBTC contracts are currently published in the NPM Registry as the package +[`@keep-network/tbtc`](https://www.npmjs.com/package/@keep-network/tbtc). +Packages have versions corresponding to their network: -1. Add a file `.npmrc` to the same directory as your project's -`package.json`. -2. Paste the following to configure the GitHub Package Registry for -tBTC: -+ -.... -@keep-network:registry=https://npm.pkg.github.com/keep-network -.... -3. Install the package: -+ -[source,sh] ----- +- `-pre` packages contain prerelease packages for the internal Keep testnet. +- `-rc` packages contain prerelease packages for the Ropsten Ethereum testnet. + +Note that only the latest package in a series is expected to reference +contracts that have a backing set of signers. + +To install the package: + +```sh $ npm install @keep-network/tbtc ----- +``` == Usage From d8654ffb09e1ad165fa4860f9db147ee129c086c Mon Sep 17 00:00:00 2001 From: Antonio Salazar Cardozo Date: Wed, 8 Apr 2020 14:35:29 -0400 Subject: [PATCH 2/3] Reflect the bumped Solidity version in README Be specific about which version of Solidity our contracts expect. --- README.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.adoc b/README.adoc index 7ba4f5914..a33a7af1c 100644 --- a/README.adoc +++ b/README.adoc @@ -49,7 +49,7 @@ $ npm install @keep-network/tbtc == Usage -*NOTE:* tBTC contracts require _solc_ v0.5.10 or higher. You may have to +*NOTE:* tBTC contracts require _solc_ v0.5.17 or higher. You may have to https://www.trufflesuite.com/docs/truffle/reference/configuration#compiler-configuration[configure solc in your `truffle-config.js`]. @@ -58,7 +58,7 @@ them: [source,sol] ---- -pragma solidity ^0.5.0; +pragma solidity ^0.5.17; import "@keep-network/tbtc/contracts/deposit/Deposit.sol"; From f579154e95db0da96090bd489ad765c28fb594a0 Mon Sep 17 00:00:00 2001 From: Antonio Salazar Cardozo Date: Wed, 8 Apr 2020 16:15:56 -0400 Subject: [PATCH 3/3] Exit on utility box after contract migrations There are situations where the utility box script does not seem to finish, leading to a build timeout in Circle; explicitly exiting will hopefully end that once and for all. --- solidity/scripts/circleci-migrate-contracts.sh | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/solidity/scripts/circleci-migrate-contracts.sh b/solidity/scripts/circleci-migrate-contracts.sh index dccd30962..ecebbe775 100755 --- a/solidity/scripts/circleci-migrate-contracts.sh +++ b/solidity/scripts/circleci-migrate-contracts.sh @@ -65,6 +65,10 @@ ssh utilitybox << EOF tenderly push --networks $ETH_NETWORK_ID --tag tbtc \ --tag $GOOGLE_PROJECT_NAME --tag $BUILD_TAG || echo "tendery push failed :(" echo "<<<<<