From f35953e81d1f7dc24c7df74d57c88c1b7c8d706c Mon Sep 17 00:00:00 2001 From: Antonio Salazar Cardozo Date: Mon, 23 Mar 2020 10:55:23 -0400 Subject: [PATCH 1/5] Move Solidity code to solidity/ subdirectory This used to be in implementation/; for better alignment with other Keep-managed repos, more future-proof layout, and better clarity to boot, it now lives in solidity/. --- .pre-commit-config.yaml | 4 ++-- {implementation => solidity}/.babelrc | 0 {implementation => solidity}/.eslintrc | 0 {implementation => solidity}/.gitignore | 0 {implementation => solidity}/.npmrc | 0 {implementation => solidity}/.prettierrc.yaml | 0 {implementation => solidity}/.soliumignore | 0 {implementation => solidity}/.soliumrc.json | 0 {implementation => solidity}/README.md | 0 {implementation => solidity}/contracts/DepositLog.sol | 0 {implementation => solidity}/contracts/Migrations.sol | 0 {implementation => solidity}/contracts/deposit/Deposit.sol | 0 .../contracts/deposit/DepositFunding.sol | 0 .../contracts/deposit/DepositLiquidation.sol | 0 .../contracts/deposit/DepositRedemption.sol | 0 .../contracts/deposit/DepositStates.sol | 0 .../contracts/deposit/DepositUtils.sol | 0 .../contracts/deposit/OutsourceDepositLogging.sol | 0 .../contracts/deposit/TBTCConstants.sol | 0 .../contracts/external/IMedianizer.sol | 0 .../contracts/interfaces/IBTCETHPriceFeed.sol | 0 .../contracts/interfaces/ITBTCSystem.sol | 0 .../contracts/price-feed/BTCETHPriceFeed.sol | 0 .../contracts/price-feed/MockMedianizer.sol | 0 {implementation => solidity}/contracts/proxy/CloneFactory.sol | 0 .../contracts/proxy/DepositFactory.sol | 0 {implementation => solidity}/contracts/relay/MockRelay.sol | 0 .../contracts/scripts/FundingScript.sol | 0 .../contracts/scripts/RedemptionScript.sol | 0 .../contracts/system/DepositFactoryAuthority.sol | 0 .../contracts/system/FeeRebateToken.sol | 0 .../contracts/system/TBTCDepositToken.sol | 0 {implementation => solidity}/contracts/system/TBTCSystem.sol | 0 .../contracts/system/TBTCSystemAuthority.sol | 0 {implementation => solidity}/contracts/system/TBTCToken.sol | 0 .../contracts/system/VendingMachine.sol | 0 .../contracts/system/VendingMachineAuthority.sol | 0 .../contracts/test/deposit/TBTCSystemStub.sol | 0 .../contracts/test/deposit/TestDeposit.sol | 0 .../contracts/test/deposit/TestDepositUtils.sol | 0 .../contracts/test/deposit/TestTBTCConstants.sol | 0 .../contracts/test/deposit/TestToken.sol | 0 .../contracts/test/factory/CloneFactoryStub.sol | 0 {implementation => solidity}/contracts/test/factory/Dummy.sol | 0 .../contracts/test/keep/ECDSAKeepFactoryStub.sol | 0 .../contracts/test/keep/ECDSAKeepStub.sol | 0 .../contracts/test/keep/ECDSAKeepVendorStub.sol | 0 .../contracts/test/price-feed/MockBTCETHPriceFeed.sol | 0 .../contracts/test/price-feed/MockMedianizer.sol | 0 .../contracts/test/system/TestFeeRebateToken.sol | 0 .../contracts/test/system/TestTBTCDepositToken.sol | 0 {implementation => solidity}/docs/generate-api-docs.js | 0 .../migrations/1_initial_migration.js | 0 {implementation => solidity}/migrations/2_deploy_contracts.js | 0 {implementation => solidity}/migrations/3_initialize.js | 0 {implementation => solidity}/migrations/externals.js | 0 {implementation => solidity}/migrations/prices.json | 0 {implementation => solidity}/package-lock.json | 0 {implementation => solidity}/package.json | 0 .../scripts/circleci-migrate-contracts.sh | 0 .../scripts/circleci-provision-external-contracts.sh | 0 {implementation => solidity}/scripts/get-prices.js | 0 {implementation => solidity}/scripts/update-prices.sh | 0 {implementation => solidity}/tenderly.yaml | 0 {implementation => solidity}/test/BTCETHPriceFeedTest.js | 0 {implementation => solidity}/test/CloneFactoryTest.js | 0 {implementation => solidity}/test/DepositFactoryTest.js | 0 {implementation => solidity}/test/DepositFraudTest.js | 0 {implementation => solidity}/test/DepositFundingTest.js | 0 {implementation => solidity}/test/DepositLiquidationTest.js | 0 {implementation => solidity}/test/DepositRedemptionTest.js | 0 {implementation => solidity}/test/DepositUtilsTest.js | 0 {implementation => solidity}/test/TBTCSystemTest.js | 0 {implementation => solidity}/test/VendingMachineTest.js | 0 {implementation => solidity}/test/helpers/assertBalance.js | 0 {implementation => solidity}/test/helpers/headerchains.json | 0 {implementation => solidity}/test/helpers/snapshot.js | 0 {implementation => solidity}/test/helpers/testDeployer.js | 0 {implementation => solidity}/test/helpers/tx.json | 0 {implementation => solidity}/test/helpers/utils.js | 0 {implementation => solidity}/truffle-config.js | 0 81 files changed, 2 insertions(+), 2 deletions(-) rename {implementation => solidity}/.babelrc (100%) rename {implementation => solidity}/.eslintrc (100%) rename {implementation => solidity}/.gitignore (100%) rename {implementation => solidity}/.npmrc (100%) rename {implementation => solidity}/.prettierrc.yaml (100%) rename {implementation => solidity}/.soliumignore (100%) rename {implementation => solidity}/.soliumrc.json (100%) rename {implementation => solidity}/README.md (100%) rename {implementation => solidity}/contracts/DepositLog.sol (100%) rename {implementation => solidity}/contracts/Migrations.sol (100%) rename {implementation => solidity}/contracts/deposit/Deposit.sol (100%) rename {implementation => solidity}/contracts/deposit/DepositFunding.sol (100%) rename {implementation => solidity}/contracts/deposit/DepositLiquidation.sol (100%) rename {implementation => solidity}/contracts/deposit/DepositRedemption.sol (100%) rename {implementation => solidity}/contracts/deposit/DepositStates.sol (100%) rename {implementation => solidity}/contracts/deposit/DepositUtils.sol (100%) rename {implementation => solidity}/contracts/deposit/OutsourceDepositLogging.sol (100%) rename {implementation => solidity}/contracts/deposit/TBTCConstants.sol (100%) rename {implementation => solidity}/contracts/external/IMedianizer.sol (100%) rename {implementation => solidity}/contracts/interfaces/IBTCETHPriceFeed.sol (100%) rename {implementation => solidity}/contracts/interfaces/ITBTCSystem.sol (100%) rename {implementation => solidity}/contracts/price-feed/BTCETHPriceFeed.sol (100%) rename {implementation => solidity}/contracts/price-feed/MockMedianizer.sol (100%) rename {implementation => solidity}/contracts/proxy/CloneFactory.sol (100%) rename {implementation => solidity}/contracts/proxy/DepositFactory.sol (100%) rename {implementation => solidity}/contracts/relay/MockRelay.sol (100%) rename {implementation => solidity}/contracts/scripts/FundingScript.sol (100%) rename {implementation => solidity}/contracts/scripts/RedemptionScript.sol (100%) rename {implementation => solidity}/contracts/system/DepositFactoryAuthority.sol (100%) rename {implementation => solidity}/contracts/system/FeeRebateToken.sol (100%) rename {implementation => solidity}/contracts/system/TBTCDepositToken.sol (100%) rename {implementation => solidity}/contracts/system/TBTCSystem.sol (100%) rename {implementation => solidity}/contracts/system/TBTCSystemAuthority.sol (100%) rename {implementation => solidity}/contracts/system/TBTCToken.sol (100%) rename {implementation => solidity}/contracts/system/VendingMachine.sol (100%) rename {implementation => solidity}/contracts/system/VendingMachineAuthority.sol (100%) rename {implementation => solidity}/contracts/test/deposit/TBTCSystemStub.sol (100%) rename {implementation => solidity}/contracts/test/deposit/TestDeposit.sol (100%) rename {implementation => solidity}/contracts/test/deposit/TestDepositUtils.sol (100%) rename {implementation => solidity}/contracts/test/deposit/TestTBTCConstants.sol (100%) rename {implementation => solidity}/contracts/test/deposit/TestToken.sol (100%) rename {implementation => solidity}/contracts/test/factory/CloneFactoryStub.sol (100%) rename {implementation => solidity}/contracts/test/factory/Dummy.sol (100%) rename {implementation => solidity}/contracts/test/keep/ECDSAKeepFactoryStub.sol (100%) rename {implementation => solidity}/contracts/test/keep/ECDSAKeepStub.sol (100%) rename {implementation => solidity}/contracts/test/keep/ECDSAKeepVendorStub.sol (100%) rename {implementation => solidity}/contracts/test/price-feed/MockBTCETHPriceFeed.sol (100%) rename {implementation => solidity}/contracts/test/price-feed/MockMedianizer.sol (100%) rename {implementation => solidity}/contracts/test/system/TestFeeRebateToken.sol (100%) rename {implementation => solidity}/contracts/test/system/TestTBTCDepositToken.sol (100%) rename {implementation => solidity}/docs/generate-api-docs.js (100%) rename {implementation => solidity}/migrations/1_initial_migration.js (100%) rename {implementation => solidity}/migrations/2_deploy_contracts.js (100%) rename {implementation => solidity}/migrations/3_initialize.js (100%) rename {implementation => solidity}/migrations/externals.js (100%) rename {implementation => solidity}/migrations/prices.json (100%) rename {implementation => solidity}/package-lock.json (100%) rename {implementation => solidity}/package.json (100%) rename {implementation => solidity}/scripts/circleci-migrate-contracts.sh (100%) rename {implementation => solidity}/scripts/circleci-provision-external-contracts.sh (100%) rename {implementation => solidity}/scripts/get-prices.js (100%) rename {implementation => solidity}/scripts/update-prices.sh (100%) rename {implementation => solidity}/tenderly.yaml (100%) rename {implementation => solidity}/test/BTCETHPriceFeedTest.js (100%) rename {implementation => solidity}/test/CloneFactoryTest.js (100%) rename {implementation => solidity}/test/DepositFactoryTest.js (100%) rename {implementation => solidity}/test/DepositFraudTest.js (100%) rename {implementation => solidity}/test/DepositFundingTest.js (100%) rename {implementation => solidity}/test/DepositLiquidationTest.js (100%) rename {implementation => solidity}/test/DepositRedemptionTest.js (100%) rename {implementation => solidity}/test/DepositUtilsTest.js (100%) rename {implementation => solidity}/test/TBTCSystemTest.js (100%) rename {implementation => solidity}/test/VendingMachineTest.js (100%) rename {implementation => solidity}/test/helpers/assertBalance.js (100%) rename {implementation => solidity}/test/helpers/headerchains.json (100%) rename {implementation => solidity}/test/helpers/snapshot.js (100%) rename {implementation => solidity}/test/helpers/testDeployer.js (100%) rename {implementation => solidity}/test/helpers/tx.json (100%) rename {implementation => solidity}/test/helpers/utils.js (100%) rename {implementation => solidity}/truffle-config.js (100%) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 6f7246c23..2b492bb52 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -6,13 +6,13 @@ hooks: - id: lint-js name: 'lint js' - entry: /usr/bin/env bash -c "cd implementation && npm run lint:js" + entry: /usr/bin/env bash -c "cd solidity && npm run lint:js" files: '\.js$' language: script description: "Checks JS code according to the package's linter configuration" - id: lint-sol name: 'lint solidity' - entry: /usr/bin/env bash -c "cd implementation && npm run lint:sol" + entry: /usr/bin/env bash -c "cd solidity && npm run lint:sol" files: '\.sol$' language: script description: "Checks Solidity code according to the package's linter configuration" diff --git a/implementation/.babelrc b/solidity/.babelrc similarity index 100% rename from implementation/.babelrc rename to solidity/.babelrc diff --git a/implementation/.eslintrc b/solidity/.eslintrc similarity index 100% rename from implementation/.eslintrc rename to solidity/.eslintrc diff --git a/implementation/.gitignore b/solidity/.gitignore similarity index 100% rename from implementation/.gitignore rename to solidity/.gitignore diff --git a/implementation/.npmrc b/solidity/.npmrc similarity index 100% rename from implementation/.npmrc rename to solidity/.npmrc diff --git a/implementation/.prettierrc.yaml b/solidity/.prettierrc.yaml similarity index 100% rename from implementation/.prettierrc.yaml rename to solidity/.prettierrc.yaml diff --git a/implementation/.soliumignore b/solidity/.soliumignore similarity index 100% rename from implementation/.soliumignore rename to solidity/.soliumignore diff --git a/implementation/.soliumrc.json b/solidity/.soliumrc.json similarity index 100% rename from implementation/.soliumrc.json rename to solidity/.soliumrc.json diff --git a/implementation/README.md b/solidity/README.md similarity index 100% rename from implementation/README.md rename to solidity/README.md diff --git a/implementation/contracts/DepositLog.sol b/solidity/contracts/DepositLog.sol similarity index 100% rename from implementation/contracts/DepositLog.sol rename to solidity/contracts/DepositLog.sol diff --git a/implementation/contracts/Migrations.sol b/solidity/contracts/Migrations.sol similarity index 100% rename from implementation/contracts/Migrations.sol rename to solidity/contracts/Migrations.sol diff --git a/implementation/contracts/deposit/Deposit.sol b/solidity/contracts/deposit/Deposit.sol similarity index 100% rename from implementation/contracts/deposit/Deposit.sol rename to solidity/contracts/deposit/Deposit.sol diff --git a/implementation/contracts/deposit/DepositFunding.sol b/solidity/contracts/deposit/DepositFunding.sol similarity index 100% rename from implementation/contracts/deposit/DepositFunding.sol rename to solidity/contracts/deposit/DepositFunding.sol diff --git a/implementation/contracts/deposit/DepositLiquidation.sol b/solidity/contracts/deposit/DepositLiquidation.sol similarity index 100% rename from implementation/contracts/deposit/DepositLiquidation.sol rename to solidity/contracts/deposit/DepositLiquidation.sol diff --git a/implementation/contracts/deposit/DepositRedemption.sol b/solidity/contracts/deposit/DepositRedemption.sol similarity index 100% rename from implementation/contracts/deposit/DepositRedemption.sol rename to solidity/contracts/deposit/DepositRedemption.sol diff --git a/implementation/contracts/deposit/DepositStates.sol b/solidity/contracts/deposit/DepositStates.sol similarity index 100% rename from implementation/contracts/deposit/DepositStates.sol rename to solidity/contracts/deposit/DepositStates.sol diff --git a/implementation/contracts/deposit/DepositUtils.sol b/solidity/contracts/deposit/DepositUtils.sol similarity index 100% rename from implementation/contracts/deposit/DepositUtils.sol rename to solidity/contracts/deposit/DepositUtils.sol diff --git a/implementation/contracts/deposit/OutsourceDepositLogging.sol b/solidity/contracts/deposit/OutsourceDepositLogging.sol similarity index 100% rename from implementation/contracts/deposit/OutsourceDepositLogging.sol rename to solidity/contracts/deposit/OutsourceDepositLogging.sol diff --git a/implementation/contracts/deposit/TBTCConstants.sol b/solidity/contracts/deposit/TBTCConstants.sol similarity index 100% rename from implementation/contracts/deposit/TBTCConstants.sol rename to solidity/contracts/deposit/TBTCConstants.sol diff --git a/implementation/contracts/external/IMedianizer.sol b/solidity/contracts/external/IMedianizer.sol similarity index 100% rename from implementation/contracts/external/IMedianizer.sol rename to solidity/contracts/external/IMedianizer.sol diff --git a/implementation/contracts/interfaces/IBTCETHPriceFeed.sol b/solidity/contracts/interfaces/IBTCETHPriceFeed.sol similarity index 100% rename from implementation/contracts/interfaces/IBTCETHPriceFeed.sol rename to solidity/contracts/interfaces/IBTCETHPriceFeed.sol diff --git a/implementation/contracts/interfaces/ITBTCSystem.sol b/solidity/contracts/interfaces/ITBTCSystem.sol similarity index 100% rename from implementation/contracts/interfaces/ITBTCSystem.sol rename to solidity/contracts/interfaces/ITBTCSystem.sol diff --git a/implementation/contracts/price-feed/BTCETHPriceFeed.sol b/solidity/contracts/price-feed/BTCETHPriceFeed.sol similarity index 100% rename from implementation/contracts/price-feed/BTCETHPriceFeed.sol rename to solidity/contracts/price-feed/BTCETHPriceFeed.sol diff --git a/implementation/contracts/price-feed/MockMedianizer.sol b/solidity/contracts/price-feed/MockMedianizer.sol similarity index 100% rename from implementation/contracts/price-feed/MockMedianizer.sol rename to solidity/contracts/price-feed/MockMedianizer.sol diff --git a/implementation/contracts/proxy/CloneFactory.sol b/solidity/contracts/proxy/CloneFactory.sol similarity index 100% rename from implementation/contracts/proxy/CloneFactory.sol rename to solidity/contracts/proxy/CloneFactory.sol diff --git a/implementation/contracts/proxy/DepositFactory.sol b/solidity/contracts/proxy/DepositFactory.sol similarity index 100% rename from implementation/contracts/proxy/DepositFactory.sol rename to solidity/contracts/proxy/DepositFactory.sol diff --git a/implementation/contracts/relay/MockRelay.sol b/solidity/contracts/relay/MockRelay.sol similarity index 100% rename from implementation/contracts/relay/MockRelay.sol rename to solidity/contracts/relay/MockRelay.sol diff --git a/implementation/contracts/scripts/FundingScript.sol b/solidity/contracts/scripts/FundingScript.sol similarity index 100% rename from implementation/contracts/scripts/FundingScript.sol rename to solidity/contracts/scripts/FundingScript.sol diff --git a/implementation/contracts/scripts/RedemptionScript.sol b/solidity/contracts/scripts/RedemptionScript.sol similarity index 100% rename from implementation/contracts/scripts/RedemptionScript.sol rename to solidity/contracts/scripts/RedemptionScript.sol diff --git a/implementation/contracts/system/DepositFactoryAuthority.sol b/solidity/contracts/system/DepositFactoryAuthority.sol similarity index 100% rename from implementation/contracts/system/DepositFactoryAuthority.sol rename to solidity/contracts/system/DepositFactoryAuthority.sol diff --git a/implementation/contracts/system/FeeRebateToken.sol b/solidity/contracts/system/FeeRebateToken.sol similarity index 100% rename from implementation/contracts/system/FeeRebateToken.sol rename to solidity/contracts/system/FeeRebateToken.sol diff --git a/implementation/contracts/system/TBTCDepositToken.sol b/solidity/contracts/system/TBTCDepositToken.sol similarity index 100% rename from implementation/contracts/system/TBTCDepositToken.sol rename to solidity/contracts/system/TBTCDepositToken.sol diff --git a/implementation/contracts/system/TBTCSystem.sol b/solidity/contracts/system/TBTCSystem.sol similarity index 100% rename from implementation/contracts/system/TBTCSystem.sol rename to solidity/contracts/system/TBTCSystem.sol diff --git a/implementation/contracts/system/TBTCSystemAuthority.sol b/solidity/contracts/system/TBTCSystemAuthority.sol similarity index 100% rename from implementation/contracts/system/TBTCSystemAuthority.sol rename to solidity/contracts/system/TBTCSystemAuthority.sol diff --git a/implementation/contracts/system/TBTCToken.sol b/solidity/contracts/system/TBTCToken.sol similarity index 100% rename from implementation/contracts/system/TBTCToken.sol rename to solidity/contracts/system/TBTCToken.sol diff --git a/implementation/contracts/system/VendingMachine.sol b/solidity/contracts/system/VendingMachine.sol similarity index 100% rename from implementation/contracts/system/VendingMachine.sol rename to solidity/contracts/system/VendingMachine.sol diff --git a/implementation/contracts/system/VendingMachineAuthority.sol b/solidity/contracts/system/VendingMachineAuthority.sol similarity index 100% rename from implementation/contracts/system/VendingMachineAuthority.sol rename to solidity/contracts/system/VendingMachineAuthority.sol diff --git a/implementation/contracts/test/deposit/TBTCSystemStub.sol b/solidity/contracts/test/deposit/TBTCSystemStub.sol similarity index 100% rename from implementation/contracts/test/deposit/TBTCSystemStub.sol rename to solidity/contracts/test/deposit/TBTCSystemStub.sol diff --git a/implementation/contracts/test/deposit/TestDeposit.sol b/solidity/contracts/test/deposit/TestDeposit.sol similarity index 100% rename from implementation/contracts/test/deposit/TestDeposit.sol rename to solidity/contracts/test/deposit/TestDeposit.sol diff --git a/implementation/contracts/test/deposit/TestDepositUtils.sol b/solidity/contracts/test/deposit/TestDepositUtils.sol similarity index 100% rename from implementation/contracts/test/deposit/TestDepositUtils.sol rename to solidity/contracts/test/deposit/TestDepositUtils.sol diff --git a/implementation/contracts/test/deposit/TestTBTCConstants.sol b/solidity/contracts/test/deposit/TestTBTCConstants.sol similarity index 100% rename from implementation/contracts/test/deposit/TestTBTCConstants.sol rename to solidity/contracts/test/deposit/TestTBTCConstants.sol diff --git a/implementation/contracts/test/deposit/TestToken.sol b/solidity/contracts/test/deposit/TestToken.sol similarity index 100% rename from implementation/contracts/test/deposit/TestToken.sol rename to solidity/contracts/test/deposit/TestToken.sol diff --git a/implementation/contracts/test/factory/CloneFactoryStub.sol b/solidity/contracts/test/factory/CloneFactoryStub.sol similarity index 100% rename from implementation/contracts/test/factory/CloneFactoryStub.sol rename to solidity/contracts/test/factory/CloneFactoryStub.sol diff --git a/implementation/contracts/test/factory/Dummy.sol b/solidity/contracts/test/factory/Dummy.sol similarity index 100% rename from implementation/contracts/test/factory/Dummy.sol rename to solidity/contracts/test/factory/Dummy.sol diff --git a/implementation/contracts/test/keep/ECDSAKeepFactoryStub.sol b/solidity/contracts/test/keep/ECDSAKeepFactoryStub.sol similarity index 100% rename from implementation/contracts/test/keep/ECDSAKeepFactoryStub.sol rename to solidity/contracts/test/keep/ECDSAKeepFactoryStub.sol diff --git a/implementation/contracts/test/keep/ECDSAKeepStub.sol b/solidity/contracts/test/keep/ECDSAKeepStub.sol similarity index 100% rename from implementation/contracts/test/keep/ECDSAKeepStub.sol rename to solidity/contracts/test/keep/ECDSAKeepStub.sol diff --git a/implementation/contracts/test/keep/ECDSAKeepVendorStub.sol b/solidity/contracts/test/keep/ECDSAKeepVendorStub.sol similarity index 100% rename from implementation/contracts/test/keep/ECDSAKeepVendorStub.sol rename to solidity/contracts/test/keep/ECDSAKeepVendorStub.sol diff --git a/implementation/contracts/test/price-feed/MockBTCETHPriceFeed.sol b/solidity/contracts/test/price-feed/MockBTCETHPriceFeed.sol similarity index 100% rename from implementation/contracts/test/price-feed/MockBTCETHPriceFeed.sol rename to solidity/contracts/test/price-feed/MockBTCETHPriceFeed.sol diff --git a/implementation/contracts/test/price-feed/MockMedianizer.sol b/solidity/contracts/test/price-feed/MockMedianizer.sol similarity index 100% rename from implementation/contracts/test/price-feed/MockMedianizer.sol rename to solidity/contracts/test/price-feed/MockMedianizer.sol diff --git a/implementation/contracts/test/system/TestFeeRebateToken.sol b/solidity/contracts/test/system/TestFeeRebateToken.sol similarity index 100% rename from implementation/contracts/test/system/TestFeeRebateToken.sol rename to solidity/contracts/test/system/TestFeeRebateToken.sol diff --git a/implementation/contracts/test/system/TestTBTCDepositToken.sol b/solidity/contracts/test/system/TestTBTCDepositToken.sol similarity index 100% rename from implementation/contracts/test/system/TestTBTCDepositToken.sol rename to solidity/contracts/test/system/TestTBTCDepositToken.sol diff --git a/implementation/docs/generate-api-docs.js b/solidity/docs/generate-api-docs.js similarity index 100% rename from implementation/docs/generate-api-docs.js rename to solidity/docs/generate-api-docs.js diff --git a/implementation/migrations/1_initial_migration.js b/solidity/migrations/1_initial_migration.js similarity index 100% rename from implementation/migrations/1_initial_migration.js rename to solidity/migrations/1_initial_migration.js diff --git a/implementation/migrations/2_deploy_contracts.js b/solidity/migrations/2_deploy_contracts.js similarity index 100% rename from implementation/migrations/2_deploy_contracts.js rename to solidity/migrations/2_deploy_contracts.js diff --git a/implementation/migrations/3_initialize.js b/solidity/migrations/3_initialize.js similarity index 100% rename from implementation/migrations/3_initialize.js rename to solidity/migrations/3_initialize.js diff --git a/implementation/migrations/externals.js b/solidity/migrations/externals.js similarity index 100% rename from implementation/migrations/externals.js rename to solidity/migrations/externals.js diff --git a/implementation/migrations/prices.json b/solidity/migrations/prices.json similarity index 100% rename from implementation/migrations/prices.json rename to solidity/migrations/prices.json diff --git a/implementation/package-lock.json b/solidity/package-lock.json similarity index 100% rename from implementation/package-lock.json rename to solidity/package-lock.json diff --git a/implementation/package.json b/solidity/package.json similarity index 100% rename from implementation/package.json rename to solidity/package.json diff --git a/implementation/scripts/circleci-migrate-contracts.sh b/solidity/scripts/circleci-migrate-contracts.sh similarity index 100% rename from implementation/scripts/circleci-migrate-contracts.sh rename to solidity/scripts/circleci-migrate-contracts.sh diff --git a/implementation/scripts/circleci-provision-external-contracts.sh b/solidity/scripts/circleci-provision-external-contracts.sh similarity index 100% rename from implementation/scripts/circleci-provision-external-contracts.sh rename to solidity/scripts/circleci-provision-external-contracts.sh diff --git a/implementation/scripts/get-prices.js b/solidity/scripts/get-prices.js similarity index 100% rename from implementation/scripts/get-prices.js rename to solidity/scripts/get-prices.js diff --git a/implementation/scripts/update-prices.sh b/solidity/scripts/update-prices.sh similarity index 100% rename from implementation/scripts/update-prices.sh rename to solidity/scripts/update-prices.sh diff --git a/implementation/tenderly.yaml b/solidity/tenderly.yaml similarity index 100% rename from implementation/tenderly.yaml rename to solidity/tenderly.yaml diff --git a/implementation/test/BTCETHPriceFeedTest.js b/solidity/test/BTCETHPriceFeedTest.js similarity index 100% rename from implementation/test/BTCETHPriceFeedTest.js rename to solidity/test/BTCETHPriceFeedTest.js diff --git a/implementation/test/CloneFactoryTest.js b/solidity/test/CloneFactoryTest.js similarity index 100% rename from implementation/test/CloneFactoryTest.js rename to solidity/test/CloneFactoryTest.js diff --git a/implementation/test/DepositFactoryTest.js b/solidity/test/DepositFactoryTest.js similarity index 100% rename from implementation/test/DepositFactoryTest.js rename to solidity/test/DepositFactoryTest.js diff --git a/implementation/test/DepositFraudTest.js b/solidity/test/DepositFraudTest.js similarity index 100% rename from implementation/test/DepositFraudTest.js rename to solidity/test/DepositFraudTest.js diff --git a/implementation/test/DepositFundingTest.js b/solidity/test/DepositFundingTest.js similarity index 100% rename from implementation/test/DepositFundingTest.js rename to solidity/test/DepositFundingTest.js diff --git a/implementation/test/DepositLiquidationTest.js b/solidity/test/DepositLiquidationTest.js similarity index 100% rename from implementation/test/DepositLiquidationTest.js rename to solidity/test/DepositLiquidationTest.js diff --git a/implementation/test/DepositRedemptionTest.js b/solidity/test/DepositRedemptionTest.js similarity index 100% rename from implementation/test/DepositRedemptionTest.js rename to solidity/test/DepositRedemptionTest.js diff --git a/implementation/test/DepositUtilsTest.js b/solidity/test/DepositUtilsTest.js similarity index 100% rename from implementation/test/DepositUtilsTest.js rename to solidity/test/DepositUtilsTest.js diff --git a/implementation/test/TBTCSystemTest.js b/solidity/test/TBTCSystemTest.js similarity index 100% rename from implementation/test/TBTCSystemTest.js rename to solidity/test/TBTCSystemTest.js diff --git a/implementation/test/VendingMachineTest.js b/solidity/test/VendingMachineTest.js similarity index 100% rename from implementation/test/VendingMachineTest.js rename to solidity/test/VendingMachineTest.js diff --git a/implementation/test/helpers/assertBalance.js b/solidity/test/helpers/assertBalance.js similarity index 100% rename from implementation/test/helpers/assertBalance.js rename to solidity/test/helpers/assertBalance.js diff --git a/implementation/test/helpers/headerchains.json b/solidity/test/helpers/headerchains.json similarity index 100% rename from implementation/test/helpers/headerchains.json rename to solidity/test/helpers/headerchains.json diff --git a/implementation/test/helpers/snapshot.js b/solidity/test/helpers/snapshot.js similarity index 100% rename from implementation/test/helpers/snapshot.js rename to solidity/test/helpers/snapshot.js diff --git a/implementation/test/helpers/testDeployer.js b/solidity/test/helpers/testDeployer.js similarity index 100% rename from implementation/test/helpers/testDeployer.js rename to solidity/test/helpers/testDeployer.js diff --git a/implementation/test/helpers/tx.json b/solidity/test/helpers/tx.json similarity index 100% rename from implementation/test/helpers/tx.json rename to solidity/test/helpers/tx.json diff --git a/implementation/test/helpers/utils.js b/solidity/test/helpers/utils.js similarity index 100% rename from implementation/test/helpers/utils.js rename to solidity/test/helpers/utils.js diff --git a/implementation/truffle-config.js b/solidity/truffle-config.js similarity index 100% rename from implementation/truffle-config.js rename to solidity/truffle-config.js From 85c3855fde50290ec342dbb1a427b9e60d2501af Mon Sep 17 00:00:00 2001 From: Antonio Salazar Cardozo Date: Mon, 23 Mar 2020 10:58:50 -0400 Subject: [PATCH 2/5] Update documentation references to implementation/ --- README.adoc | 4 ++-- docs/introduction-to-tbtc.md | 4 ++-- solidity/docs/generate-api-docs.js | 18 +++++++++--------- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.adoc b/README.adoc index 8d0ca4cb1..8c6cca96d 100644 --- a/README.adoc +++ b/README.adoc @@ -15,7 +15,7 @@ federated sidechains like https://blockstream.com/liquid/[Liquid], expanding use cases possible via today's Bitcoin network, while bringing superior money to other chains. -This repo contains the Solidity link:implementation/[smart contracts] +This repo contains the Solidity link:solidity/[smart contracts] and link:docs/[specification]. toc::[] @@ -101,7 +101,7 @@ Clone and install dependencies: [source,sh] ---- git clone https://github.com/keep-network/tbtc -cd tbtc/implementation +cd tbtc/solidity npm install ---- diff --git a/docs/introduction-to-tbtc.md b/docs/introduction-to-tbtc.md index 4c9809887..77d3e94bd 100644 --- a/docs/introduction-to-tbtc.md +++ b/docs/introduction-to-tbtc.md @@ -87,8 +87,8 @@ The redemption flow is as follows: The "happy paths" have been covered, but there hasn't been discussion of when *things fall apart*. -To disincentivise signers from stealing bitcoin, deposits are overcollateralised with ETH. The collateral is priced using an on-chain [ETH:BTC price feed](https://github.com/keep-network/tbtc/blob/master/implementation/contracts/price-feed/BTCETHPriceFeed.sol), which is operated by MakerDAO. This collateral also ensures guarantees of signer availability within the protocol. +To disincentivise signers from stealing bitcoin, deposits are overcollateralised with ETH. The collateral is priced using an on-chain [ETH:BTC price feed](https://github.com/keep-network/tbtc/blob/master/solidity/contracts/price-feed/BTCETHPriceFeed.sol), which is operated by MakerDAO. This collateral also ensures guarantees of signer availability within the protocol. --- -*If you have any questions, suggestions, improvements, don't hesitate to reach out via GitHub and/or [chat on Discord](https://discord.gg/4R6RGFf).* \ No newline at end of file +*If you have any questions, suggestions, improvements, don't hesitate to reach out via GitHub and/or [chat on Discord](https://discord.gg/4R6RGFf).* diff --git a/solidity/docs/generate-api-docs.js b/solidity/docs/generate-api-docs.js index 8ff51496b..24fc82714 100644 --- a/solidity/docs/generate-api-docs.js +++ b/solidity/docs/generate-api-docs.js @@ -12,15 +12,15 @@ toc::[] ` let jsonFiles = [ - "../../implementation/build/contracts/TBTCSystem.json", - // "../../implementation/build/contracts/TBTCConstants.json", - "../../implementation/build/contracts/Deposit.json", - "../../implementation/build/contracts/DepositStates.json", - "../../implementation/build/contracts/DepositFunding.json", - "../../implementation/build/contracts/DepositRedemption.json", - "../../implementation/build/contracts/DepositLiquidation.json", - "../../implementation/build/contracts/IBTCETHPriceFeed.json", - "../../implementation/build/contracts/IBondedECDSAKeep.json", + "../../solidity/build/contracts/TBTCSystem.json", + // "../../solidity/build/contracts/TBTCConstants.json", + "../../solidity/build/contracts/Deposit.json", + "../../solidity/build/contracts/DepositStates.json", + "../../solidity/build/contracts/DepositFunding.json", + "../../solidity/build/contracts/DepositRedemption.json", + "../../solidity/build/contracts/DepositLiquidation.json", + "../../solidity/build/contracts/IBTCETHPriceFeed.json", + "../../solidity/build/contracts/IBondedECDSAKeep.json", ] jsonFiles.forEach(file => { From 7d2e8de0a7317a9b67b2a6162c32c336a49552a6 Mon Sep 17 00:00:00 2001 From: Antonio Salazar Cardozo Date: Mon, 23 Mar 2020 10:59:08 -0400 Subject: [PATCH 3/5] Update deploy script references to implementation/ --- solidity/scripts/circleci-migrate-contracts.sh | 10 +++++----- .../scripts/circleci-provision-external-contracts.sh | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/solidity/scripts/circleci-migrate-contracts.sh b/solidity/scripts/circleci-migrate-contracts.sh index 87139f94b..8a6f64300 100755 --- a/solidity/scripts/circleci-migrate-contracts.sh +++ b/solidity/scripts/circleci-migrate-contracts.sh @@ -25,10 +25,10 @@ EOF echo "<<<<<>>>>>FINISH Prep Utility Box For Migration FINISH>>>>>>" # Run migration @@ -52,7 +52,7 @@ ssh utilitybox << EOF echo ">>>>>>FINISH Setting Contract Owner Key FINISH>>>>>>" echo "<<<<<>>>>>FINISH Contract Migration FINISH>>>>>>" @@ -63,8 +63,8 @@ ssh utilitybox << EOF EOF echo "<<<<<>>>>>FINISH Contract Copy>>>>>>" echo "<<<<< Date: Mon, 23 Mar 2020 11:02:37 -0400 Subject: [PATCH 4/5] Update Circle references to implementation/ --- .circleci/config.yml | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 0c6e7a45b..d0bb7045d 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -21,12 +21,12 @@ jobs: - checkout - run: name: Authenticate GitHub Package Registry - working_directory: ~/project/implementation + working_directory: ~/project/solidity command: echo "//npm.pkg.github.com/:_authToken=$GITHUB_TOKEN" >> .npmrc - persist_to_workspace: root: . paths: - - implementation/.npmrc + - solidity/.npmrc compile_contracts: executor: docker-node @@ -38,23 +38,23 @@ jobs: - restore_cache: keys: # When lock file changes, use increasingly general patterns to restore cache. - - v1-client-npm-deps-{{ .Branch }}-{{ checksum "implementation/package-lock.json" }} + - v1-client-npm-deps-{{ .Branch }}-{{ checksum "solidity/package-lock.json" }} - v1-client-npm-deps-{{ .Branch }}- - v1-client-npm-deps- - - run: cd implementation && npm install + - run: cd solidity && npm install - save_cache: - key: v1-client-npm-deps-{{ .Branch }}-{{ checksum "implementation/package-lock.json" }} + key: v1-client-npm-deps-{{ .Branch }}-{{ checksum "solidity/package-lock.json" }} paths: - - implementation/node_modules + - solidity/node_modules - - run: cd implementation && node_modules/.bin/truffle compile + - run: cd solidity && node_modules/.bin/truffle compile # Persist for downstream use. - persist_to_workspace: root: . paths: - - implementation/node_modules - - implementation/build/contracts + - solidity/node_modules + - solidity/build/contracts lint: executor: docker-node @@ -64,7 +64,7 @@ jobs: at: . - run: name: Lint Implementation - working_directory: ~/project/implementation + working_directory: ~/project/solidity command: | set -ex npm run lint @@ -77,12 +77,12 @@ jobs: - run: sudo npm install -g ganache-cli@6.4.2 - run: name: Running testrpc - working_directory: ~/project/implementation + working_directory: ~/project/solidity command: ganache-cli background: true - run: name: Run NPM tests - working_directory: ~/project/implementation + working_directory: ~/project/solidity command: npm run test:quick generate_pngs: docker: @@ -125,7 +125,7 @@ jobs: - run: name: Generate solidity docs command: | - cd implementation/docs + cd solidity/docs mkdir -p output node generate-api-docs.js > output/index.adoc @@ -187,7 +187,7 @@ jobs: at: . - run: name: Remove Installed node_module - working_directory: ~/project/implementation + working_directory: ~/project/solidity command: | rm -rf node_modules - run: @@ -197,7 +197,7 @@ jobs: gcloud auth activate-service-account --key-file ~/gcloud-service-key.json export UNISWAP_CONTRACT_DATA="uniswap-contract-data.txt" export BONDED_ECDSA_KEEP_VENDOR_CONTRACT_DATA="BondedECDSAKeepVendor.json" - implementation/scripts/circleci-provision-external-contracts.sh + solidity/scripts/circleci-provision-external-contracts.sh - run: name: Migrate Contracts command: | @@ -206,7 +206,7 @@ jobs: export BUILD_TAG=$CIRCLE_SHA1 export TRUFFLE_NETWORK=$TRUFFLE_NETWORK mkdir -p /tmp/tbtc/contracts - implementation/scripts/circleci-migrate-contracts.sh + solidity/scripts/circleci-migrate-contracts.sh - persist_to_workspace: root: /tmp/tbtc paths: From 81c80d73a00ddaca77b65e1ba91be6f95e56f91d Mon Sep 17 00:00:00 2001 From: Antonio Salazar Cardozo Date: Tue, 24 Mar 2020 13:17:09 -0400 Subject: [PATCH 5/5] Fix references to keep-tecdsa keep-ecdsa is the name of the game now! --- solidity/scripts/circleci-provision-external-contracts.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/solidity/scripts/circleci-provision-external-contracts.sh b/solidity/scripts/circleci-provision-external-contracts.sh index cda30c022..39d9be63e 100755 --- a/solidity/scripts/circleci-provision-external-contracts.sh +++ b/solidity/scripts/circleci-provision-external-contracts.sh @@ -1,13 +1,13 @@ #!/bin/bash set -ex -# BondedECDSAKeepVendorAddress: Migration from keep-network/keep-tecdsa +# BondedECDSAKeepVendorAddress: Migration from keep-network/keep-ecdsa # BONDED_ECDSA_KEEP_VENDOR_CONTRACT_DATA is set in the CircleCI job config # ETH_NETWORK_ID is set in the CircleCI context for each deployed environment BONDED_ECDSA_KEEP_VENDOR_ADDRESS="" function fetch_bonded_keep_vendor_address() { - gsutil -q cp gs://${CONTRACT_DATA_BUCKET}/keep-tecdsa/${BONDED_ECDSA_KEEP_VENDOR_CONTRACT_DATA} ./ + gsutil -q cp gs://${CONTRACT_DATA_BUCKET}/keep-ecdsa/${BONDED_ECDSA_KEEP_VENDOR_CONTRACT_DATA} ./ BONDED_ECDSA_KEEP_VENDOR_ADDRESS=$(cat ./${BONDED_ECDSA_KEEP_VENDOR_CONTRACT_DATA} | jq ".networks[\"${ETH_NETWORK_ID}\"].address" | tr -d '"') }