Migration tool

.github/workflows/workflow.yml

@@ -35,3 +35,6 @@ jobs:
 
       - name: Test
         run: CI=1 yarn test
+
+      - name: Test Migration
+        run: CI=1 yarn test-migration

packages/v2/components/Contracts.ts

@@ -1,7 +1,6 @@
-import { ethers } from 'hardhat';
-import { Contract as OldContract, ContractFactory, Overrides as OldOverrides } from '@ethersproject/contracts';
 import { Signer } from '@ethersproject/abstract-signer';
-
+import { Contract as OldContract, ContractFactory, Overrides as OldOverrides } from '@ethersproject/contracts';
+import { ethers } from 'hardhat';
 import {
     BancorNetwork__factory,
     BancorX__factory,

packages/v2/package.json

@@ -39,7 +39,7 @@
         "hardhat": "2.6.4"
     },
     "devDependencies": {
-        "@bancor/token-governance": "bancorprotocol/token-governance",
+        "@bancor/token-governance": "^0.1.4",
         "@ethersproject/hardware-wallets": "^5.4.0",
         "@nomiclabs/hardhat-ethers": "^2.0.2",
         "@nomiclabs/hardhat-etherscan": "^2.1.6",

packages/v3/.eslintrc

@@ -7,6 +7,12 @@
     },
     "rules": {
         "max-len": ["error", 150, 2],
+        "camelcase": [
+            "error",
+            {
+                "ignoreImports": true
+            }
+        ],
         "indent": [
             "error",
             4,

packages/v3/.gitignore

@@ -23,3 +23,11 @@ scTopics
 contracts/hardhat-dependency-compiler
 
 config.json
+
+migration/data/hardhat
+migration/data/localhost
+migration/data/fork*
+
+migration/test/migration/data/hardhat
+migration/test/migration/data/localhost
+migration/test/migration/data/fork*

packages/v3/README.md

@@ -15,13 +15,12 @@ In order to use some plugins, API keys or custom network with secret config we n
 
 ```json
 {
-    "apiKeys": {
-        "etherscan": ""
+    "keys": {
+        "etherscan": "XYZ"
     },
-
     "networks": {
         "mainnet": {
-            "url": ""
+            "url": "https://eth-mainnet.alchemyapi.io/v2/supersecretkey"
         }
     }
 }

packages/v3/components/ContractBuilder.ts

@@ -0,0 +1,62 @@
+/* eslint-enable camelcase */
+import { Signer } from '@ethersproject/abstract-signer';
+import { ContractFactory } from '@ethersproject/contracts';
+import { ethers } from 'hardhat';
+
+type AsyncReturnType<T extends (...args: any) => any> = T extends (...args: any) => Promise<infer U>
+    ? U
+    : T extends (...args: any) => infer U
+    ? U
+    : any;
+
+export type Contract<F extends ContractFactory> = AsyncReturnType<F['deploy']>;
+
+export interface ContractBuilder<F extends ContractFactory> {
+    metadata: {
+        contractName: string;
+        abi: unknown;
+        bytecode: string;
+    };
+    deploy(...args: Parameters<F['deploy']>): Promise<Contract<F>>;
+    attach(address: string, signer?: Signer): Promise<Contract<F>>;
+}
+
+export type FactoryConstructor<F extends ContractFactory> = {
+    new (signer?: Signer): F;
+    abi: unknown;
+    bytecode: string;
+};
+
+export const deployOrAttach = <F extends ContractFactory>(
+    contractName: string,
+    // @TODO: needs to replace with correctly typed params but it doesn't
+    // work properly for some reason https://github.com/microsoft/TypeScript/issues/31278
+    FactoryConstructor: FactoryConstructor<F>,
+    initialSigner?: Signer
+): ContractBuilder<F> => {
+    return {
+        metadata: {
+            contractName: contractName,
+            abi: FactoryConstructor.abi,
+            bytecode: FactoryConstructor.bytecode
+        },
+        deploy: async (...args: Parameters<F['deploy']>): Promise<Contract<F>> => {
+            const defaultSigner = initialSigner || (await ethers.getSigners())[0];
+
+            return new FactoryConstructor(defaultSigner).deploy(...(args || [])) as Contract<F>;
+        },
+        attach: attachOnly<F>(FactoryConstructor, initialSigner).attach
+    };
+};
+
+export const attachOnly = <F extends ContractFactory>(
+    FactoryConstructor: FactoryConstructor<F>,
+    initialSigner?: Signer
+) => {
+    return {
+        attach: async (address: string, signer?: Signer): Promise<Contract<F>> => {
+            const defaultSigner = initialSigner || (await ethers.getSigners())[0];
+            return new FactoryConstructor(signer || defaultSigner).attach(address) as Contract<F>;
+        }
+    };
+};

packages/v3/components/Contracts.ts

@@ -21,89 +21,48 @@ import {
     TestPoolCollection__factory,
     TestReserveToken__factory,
     TestSafeERC20Ex__factory,
-    TestSystemToken__factory,
-    TestTokenGovernance__factory,
     TestUpgradeable__factory,
     TokenHolder__factory,
     TransparentUpgradeableProxy__factory
 } from '../typechain';
+import { deployOrAttach } from './ContractBuilder';
 
 /* eslint-enable camelcase */
 import { Signer } from '@ethersproject/abstract-signer';
-import { ContractFactory } from '@ethersproject/contracts';
-import { ethers } from 'hardhat';
-
-type AsyncReturnType<T extends (...args: any) => any> = T extends (...args: any) => Promise<infer U>
-    ? U
-    : T extends (...args: any) => infer U
-    ? U
-    : any;
-
-export type Contract<F extends ContractFactory> = AsyncReturnType<F['deploy']>;
-
-export interface ContractBuilder<F extends ContractFactory> {
-    contractName: string;
-    deploy(...args: Parameters<F['deploy']>): Promise<Contract<F>>;
-    attach(address: string, passedSigner?: Signer): Promise<Contract<F>>;
-}
-
-const deployOrAttach = <F extends ContractFactory>(contractName: string, passedSigner?: Signer): ContractBuilder<F> => {
-    return {
-        contractName,
-        deploy: async (...args: Parameters<F['deploy']>): Promise<Contract<F>> => {
-            const defaultSigner = passedSigner || (await ethers.getSigners())[0];
-
-            return (await ethers.getContractFactory(contractName, defaultSigner)).deploy(
-                ...(args || [])
-            ) as Contract<F>;
-        },
-        attach: attachOnly<F>(contractName).attach
-    };
-};
-
-const attachOnly = <F extends ContractFactory>(contractName: string, passedSigner?: Signer) => {
-    return {
-        attach: async (address: string, signer?: Signer): Promise<Contract<F>> => {
-            const defaultSigner = passedSigner || (await ethers.getSigners())[0];
-            return ethers.getContractAt(contractName, address, signer || defaultSigner) as Contract<F>;
-        }
-    };
-};
 
 const getContracts = (signer?: Signer) => ({
     connect: (signer: Signer) => getContracts(signer),
 
-    /* eslint-disable camelcase */
-    BancorNetwork: deployOrAttach<BancorNetwork__factory>('BancorNetwork', signer),
-    BancorVault: deployOrAttach<BancorVault__factory>('BancorVault', signer),
-    ERC20: deployOrAttach<ERC20__factory>('ERC20', signer),
-    PoolCollection: deployOrAttach<PoolCollection__factory>('PoolCollection', signer),
-    NetworkSettings: deployOrAttach<NetworkSettings__factory>('NetworkSettings', signer),
-    NetworkTokenPool: deployOrAttach<NetworkTokenPool__factory>('NetworkTokenPool', signer),
-    PendingWithdrawals: deployOrAttach<PendingWithdrawals__factory>('PendingWithdrawals', signer),
-    PoolToken: deployOrAttach<PoolToken__factory>('PoolToken', signer),
-    PoolTokenFactory: deployOrAttach<PoolTokenFactory__factory>('PoolTokenFactory', signer),
-    ProxyAdmin: deployOrAttach<ProxyAdmin__factory>('ProxyAdmin', signer),
-    TestBancorNetwork: deployOrAttach<TestBancorNetwork__factory>('TestBancorNetwork', signer),
-    TestERC20Token: deployOrAttach<TestERC20Token__factory>('TestERC20Token', signer),
-    TestERC20Burnable: deployOrAttach<TestERC20Burnable__factory>('TestERC20Burnable', signer),
-    TestPoolAverageRate: deployOrAttach<TestPoolAverageRate__factory>('TestPoolAverageRate', signer),
-    TestPoolCollection: deployOrAttach<TestPoolCollection__factory>('TestPoolCollection', signer),
-    TestNetworkTokenPool: deployOrAttach<TestNetworkTokenPool__factory>('TestNetworkTokenPool', signer),
-    TestMathEx: deployOrAttach<TestMathEx__factory>('TestMathEx', signer),
-    TestOwned: deployOrAttach<TestOwned__factory>('TestOwned', signer),
-    TestPendingWithdrawals: deployOrAttach<TestPendingWithdrawals__factory>('TestPendingWithdrawals', signer),
-    TestReserveToken: deployOrAttach<TestReserveToken__factory>('TestReserveToken', signer),
-    TestSafeERC20Ex: deployOrAttach<TestSafeERC20Ex__factory>('TestSafeERC20Ex', signer),
-    TestSystemToken: deployOrAttach<TestSystemToken__factory>('TestSystemToken', signer),
-    TestTokenGovernance: deployOrAttach<TestTokenGovernance__factory>('TestTokenGovernance', signer),
-    TestUpgradeable: deployOrAttach<TestUpgradeable__factory>('TestUpgradeable', signer),
-    TokenHolder: deployOrAttach<TokenHolder__factory>('TokenHolder', signer),
-    TransparentUpgradeableProxy: deployOrAttach<TransparentUpgradeableProxy__factory>(
+    BancorNetwork: deployOrAttach('BancorNetwork', BancorNetwork__factory, signer),
+    BancorVault: deployOrAttach('BancorVault', BancorVault__factory, signer),
+    ERC20: deployOrAttach('ERC20', ERC20__factory, signer),
+    PoolCollection: deployOrAttach('PoolCollection', PoolCollection__factory, signer),
+    NetworkSettings: deployOrAttach('NetworkSettings', NetworkSettings__factory, signer),
+    NetworkTokenPool: deployOrAttach('NetworkTokenPool', NetworkTokenPool__factory, signer),
+    PendingWithdrawals: deployOrAttach('PendingWithdrawals', PendingWithdrawals__factory, signer),
+    PoolToken: deployOrAttach('PoolToken', PoolToken__factory, signer),
+    PoolTokenFactory: deployOrAttach('PoolTokenFactory', PoolTokenFactory__factory, signer),
+    ProxyAdmin: deployOrAttach('ProxyAdmin', ProxyAdmin__factory, signer),
+    TestBancorNetwork: deployOrAttach('TestBancorNetwork', TestBancorNetwork__factory, signer),
+    TestERC20Token: deployOrAttach('TestERC20Token', TestERC20Token__factory, signer),
+    TestERC20Burnable: deployOrAttach('TestERC20Burnable', TestERC20Burnable__factory, signer),
+    TestPoolAverageRate: deployOrAttach('TestPoolAverageRate', TestPoolAverageRate__factory, signer),
+    TestPoolCollection: deployOrAttach('TestPoolCollection', TestPoolCollection__factory, signer),
+    TestNetworkTokenPool: deployOrAttach('TestNetworkTokenPool', TestNetworkTokenPool__factory, signer),
+    TestMathEx: deployOrAttach('TestMathEx', TestMathEx__factory, signer),
+    TestOwned: deployOrAttach('TestOwned', TestOwned__factory, signer),
+    TestPendingWithdrawals: deployOrAttach('TestPendingWithdrawals', TestPendingWithdrawals__factory, signer),
+    TestReserveToken: deployOrAttach('TestReserveToken', TestReserveToken__factory, signer),
+    TestSafeERC20Ex: deployOrAttach('TestSafeERC20Ex', TestSafeERC20Ex__factory, signer),
+    TestUpgradeable: deployOrAttach('TestUpgradeable', TestUpgradeable__factory, signer),
+    TokenHolder: deployOrAttach('TokenHolder', TokenHolder__factory, signer),
+    TransparentUpgradeableProxy: deployOrAttach(
         'TransparentUpgradeableProxy',
+        TransparentUpgradeableProxy__factory,
         signer
     )
-    /* eslint-enable camelcase */
 });
 
+export type ContractsType = ReturnType<typeof getContracts>;
+
 export default getContracts();

packages/v3/components/LegacyContracts.ts

@@ -0,0 +1,26 @@
+/* eslint-disable camelcase */
+import { deployOrAttach } from './ContractBuilder';
+import {
+    TokenGovernance__factory,
+    SmartToken__factory as NetworkToken__factory,
+    SmartToken as NetworkToken,
+    DSToken__factory as GovToken__factory,
+    DSToken as GovToken
+} from '@bancor/token-governance';
+import { Signer } from '@ethersproject/abstract-signer';
+
+export { NetworkToken, GovToken };
+
+/* eslint-enable camelcase */
+
+const getContracts = (signer?: Signer) => ({
+    connect: (signer: Signer) => getContracts(signer),
+
+    TokenGovernance: deployOrAttach('TokenGovernance', TokenGovernance__factory, signer),
+    NetworkToken: deployOrAttach('BNTToken', NetworkToken__factory, signer),
+    GovToken: deployOrAttach('vBNTToken', GovToken__factory, signer)
+});
+
+export type ContractsType = ReturnType<typeof getContracts>;
+
+export default getContracts();

packages/v3/contracts/helpers/TestBancorNetwork.sol

@@ -7,7 +7,7 @@ import { EnumerableSetUpgradeable } from "@openzeppelin/contracts-upgradeable/ut
 import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/SafeERC20.sol";
 
-import { ITokenGovernance } from "@bancor/token-governance/0.7.6/contracts/TokenGovernance.sol";
+import { ITokenGovernance } from "@bancor/token-governance/contracts/ITokenGovernance.sol";
 
 import { Time } from "../utility/Time.sol";
 

packages/v3/contracts/network/BancorNetwork.sol

@@ -9,7 +9,7 @@ import { IERC20Permit } from "@openzeppelin/contracts/drafts/IERC20Permit.sol";
 import { ReentrancyGuardUpgradeable } from "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
 import { EnumerableSetUpgradeable } from "@openzeppelin/contracts-upgradeable/utils/EnumerableSetUpgradeable.sol";
 
-import { ITokenGovernance } from "@bancor/token-governance/0.7.6/contracts/TokenGovernance.sol";
+import { ITokenGovernance } from "@bancor/token-governance/contracts/ITokenGovernance.sol";
 
 import { ITokenHolder } from "../utility/interfaces/ITokenHolder.sol";
 import { Upgradeable } from "../utility/Upgradeable.sol";

packages/v3/contracts/network/interfaces/IBancorNetwork.sol

@@ -3,7 +3,7 @@ pragma solidity 0.7.6;
 
 import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
-import { ITokenGovernance } from "@bancor/token-governance/0.7.6/contracts/TokenGovernance.sol";
+import { ITokenGovernance } from "@bancor/token-governance/contracts/ITokenGovernance.sol";
 
 import { IUpgradeable } from "../../utility/interfaces/IUpgradeable.sol";
 import { ITokenHolder } from "../../utility/interfaces/ITokenHolder.sol";

packages/v3/contracts/pools/NetworkTokenPool.sol

@@ -7,7 +7,7 @@ import { Math } from "@openzeppelin/contracts/math/Math.sol";
 import { SafeMath } from "@openzeppelin/contracts/math/SafeMath.sol";
 import { ReentrancyGuardUpgradeable } from "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
 
-import { ITokenGovernance } from "@bancor/token-governance/0.7.6/contracts/TokenGovernance.sol";
+import { ITokenGovernance } from "@bancor/token-governance/contracts/ITokenGovernance.sol";
 
 import { IReserveToken } from "../token/interfaces/IReserveToken.sol";
 

packages/v3/contracts/pools/interfaces/INetworkTokenPool.sol

@@ -4,7 +4,7 @@ pragma abicoder v2;
 
 import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
-import { ITokenGovernance } from "@bancor/token-governance/0.7.6/contracts/TokenGovernance.sol";
+import { ITokenGovernance } from "@bancor/token-governance/contracts/ITokenGovernance.sol";
 
 import { IPoolToken } from "./IPoolToken.sol";
 import { IPoolCollection } from "./IPoolCollection.sol";

packages/v3/contracts/token/interfaces/IReserveToken.sol

@@ -5,7 +5,7 @@ pragma solidity 0.7.6;
  * @dev This contract is used to represent reserve tokens, which are tokens that can either be regular ERC20 tokens or
  * native ETH (represented by the NATIVE_TOKEN_ADDRESS address)
  *
- * Please note that this interface is intentionally doesn't inherit from IERC20, so that it'd be possible to effectively
+ * Please note that this interface intentionally doesn't inherit from IERC20, so that it'd be possible to effectively
  * override its balanceOf() function in the ReserveToken library
  */
 interface IReserveToken {