refactor: update folder structure (#146)

axelarnetwork · Nov 4, 2023 · 722a67b · 722a67b
1 parent 6da1bf4
commit 722a67b
Show file tree

Hide file tree

Showing 21 changed files with 77 additions and 94 deletions.
diff --git a/contracts/address-tracker/AddressTracker.sol → contracts/AddressTracker.sol b/contracts/address-tracker/AddressTracker.sol → contracts/AddressTracker.sol
@@ -5,7 +5,7 @@ pragma solidity ^0.8.0;
 import { Ownable } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/utils/Ownable.sol';
 import { InterchainAddressTracker } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/utils/InterchainAddressTracker.sol';
 
-import { IAddressTracker } from '../interfaces/IAddressTracker.sol';
+import { IAddressTracker } from './interfaces/IAddressTracker.sol';
 
 contract AddressTracker is IAddressTracker, Ownable, InterchainAddressTracker {
     constructor(

diff --git a/.../token-factory/InterchainTokenFactory.sol → contracts/InterchainTokenFactory.sol b/.../token-factory/InterchainTokenFactory.sol → contracts/InterchainTokenFactory.sol
@@ -7,11 +7,11 @@ import { SafeTokenTransfer, SafeTokenTransferFrom, SafeTokenCall } from '@axelar
 import { Multicall } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/utils/Multicall.sol';
 import { Upgradable } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/upgradable/Upgradable.sol';
 
-import { IInterchainTokenService } from '../interfaces/IInterchainTokenService.sol';
-import { IInterchainTokenFactory } from '../interfaces/IInterchainTokenFactory.sol';
-import { ITokenManagerType } from '../interfaces/ITokenManagerType.sol';
-import { ITokenManager } from '../interfaces/ITokenManager.sol';
-import { IInterchainToken } from '../interfaces/IInterchainToken.sol';
+import { IInterchainTokenService } from './interfaces/IInterchainTokenService.sol';
+import { IInterchainTokenFactory } from './interfaces/IInterchainTokenFactory.sol';
+import { ITokenManagerType } from './interfaces/ITokenManagerType.sol';
+import { ITokenManager } from './interfaces/ITokenManager.sol';
+import { IInterchainToken } from './interfaces/IInterchainToken.sol';
 
 contract InterchainTokenFactory is IInterchainTokenFactory, ITokenManagerType, Multicall, Upgradable {
     using AddressBytes for bytes;

diff --git a/...-token-service/InterchainTokenService.sol → contracts/InterchainTokenService.sol b/...-token-service/InterchainTokenService.sol → contracts/InterchainTokenService.sol
@@ -15,15 +15,15 @@ import { Multicall } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/uti
 import { IInterchainAddressTracker } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IInterchainAddressTracker.sol';
 import { Pausable } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/utils/Pausable.sol';
 
-import { IInterchainTokenService } from '../interfaces/IInterchainTokenService.sol';
-import { ITokenManagerDeployer } from '../interfaces/ITokenManagerDeployer.sol';
-import { IInterchainTokenDeployer } from '../interfaces/IInterchainTokenDeployer.sol';
-import { IInterchainTokenExecutable } from '../interfaces/IInterchainTokenExecutable.sol';
-import { IInterchainTokenExpressExecutable } from '../interfaces/IInterchainTokenExpressExecutable.sol';
-import { ITokenManager } from '../interfaces/ITokenManager.sol';
-import { IERC20Named } from '../interfaces/IERC20Named.sol';
-
-import { Operatable } from '../utils/Operatable.sol';
+import { IInterchainTokenService } from './interfaces/IInterchainTokenService.sol';
+import { ITokenManagerDeployer } from './interfaces/ITokenManagerDeployer.sol';
+import { IInterchainTokenDeployer } from './interfaces/IInterchainTokenDeployer.sol';
+import { IInterchainTokenExecutable } from './interfaces/IInterchainTokenExecutable.sol';
+import { IInterchainTokenExpressExecutable } from './interfaces/IInterchainTokenExpressExecutable.sol';
+import { ITokenManager } from './interfaces/ITokenManager.sol';
+import { IERC20Named } from './interfaces/IERC20Named.sol';
+
+import { Operatable } from './utils/Operatable.sol';
 
 /**
  * @title The Interchain Token Service

diff --git a/contracts/token-implementations/ERC20.sol → contracts/interchain-token/ERC20.sol b/contracts/token-implementations/ERC20.sol → contracts/interchain-token/ERC20.sol
diff --git a/...cts/token-implementations/ERC20Permit.sol → contracts/interchain-token/ERC20Permit.sol b/...cts/token-implementations/ERC20Permit.sol → contracts/interchain-token/ERC20Permit.sol
diff --git a/...token-implementations/InterchainToken.sol → ...acts/interchain-token/InterchainToken.sol b/...token-implementations/InterchainToken.sol → ...acts/interchain-token/InterchainToken.sol
@@ -8,8 +8,8 @@ import { IImplementation } from '../interfaces/IImplementation.sol';
 import { IInterchainToken } from '../interfaces/IInterchainToken.sol';
 import { ITokenManager } from '../interfaces/ITokenManager.sol';
 
-import { InterchainTokenBase } from '../interchain-token/InterchainTokenBase.sol';
-import { ERC20Permit } from '../token-implementations/ERC20Permit.sol';
+import { InterchainTokenBase } from './InterchainTokenBase.sol';
+import { ERC20Permit } from './ERC20Permit.sol';
 import { Implementation } from '../utils/Implementation.sol';
 import { Distributable } from '../utils/Distributable.sol';
 

diff --git a/contracts/interchain-token/InterchainTokenBase.sol b/contracts/interchain-token/InterchainTokenBase.sol
@@ -4,7 +4,8 @@ pragma solidity ^0.8.0;
 
 import { IInterchainTokenBase } from '../interfaces/IInterchainTokenBase.sol';
 import { ITokenManager } from '../interfaces/ITokenManager.sol';
-import { ERC20 } from '../token-implementations/ERC20.sol';
+
+import { ERC20 } from './ERC20.sol';
 
 /**
  * @title An example implementation of the IInterchainToken.

diff --git a/contracts/test/HardCodedConstantsTest.sol b/contracts/test/HardCodedConstantsTest.sol
@@ -3,7 +3,7 @@
 // solhint-disable-next-line one-contract-per-file
 pragma solidity ^0.8.0;
 
-import { TokenManagerLiquidityPool } from '../token-manager/implementations/TokenManagerLiquidityPool.sol';
+import { TokenManagerLiquidityPool } from '../token-manager/TokenManagerLiquidityPool.sol';
 import { Distributable } from '../utils/Distributable.sol';
 import { FlowLimit } from '../utils/FlowLimit.sol';
 import { Operatable } from '../utils/Operatable.sol';

diff --git a/contracts/test/InvalidInterchainToken.sol b/contracts/test/InvalidInterchainToken.sol
@@ -8,7 +8,7 @@ import { IERC20MintableBurnable } from '../interfaces/IERC20MintableBurnable.sol
 import { ITokenManager } from '../interfaces/ITokenManager.sol';
 
 import { InterchainTokenBase } from '../interchain-token/InterchainTokenBase.sol';
-import { ERC20Permit } from '../token-implementations/ERC20Permit.sol';
+import { ERC20Permit } from '../interchain-token/ERC20Permit.sol';
 import { Implementation } from '../utils/Implementation.sol';
 import { Distributable } from '../utils/Distributable.sol';
 

diff --git a/...ementations/TokenManagerLiquidityPool.sol → ...ken-manager/TokenManagerLiquidityPool.sol b/...ementations/TokenManagerLiquidityPool.sol → ...ken-manager/TokenManagerLiquidityPool.sol
@@ -6,8 +6,8 @@ import { IERC20 } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interf
 import { SafeTokenTransferFrom } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/libs/SafeTransfer.sol';
 import { ReentrancyGuard } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/utils/ReentrancyGuard.sol';
 
-import { ITokenManagerLiquidityPool } from '../../interfaces/ITokenManagerLiquidityPool.sol';
-import { TokenManager } from '../TokenManager.sol';
+import { ITokenManagerLiquidityPool } from '../interfaces/ITokenManagerLiquidityPool.sol';
+import { TokenManager } from './TokenManager.sol';
 
 /**
  * @title TokenManagerLiquidityPool

diff --git a/...mplementations/TokenManagerLockUnlock.sol → .../token-manager/TokenManagerLockUnlock.sol b/...mplementations/TokenManagerLockUnlock.sol → .../token-manager/TokenManagerLockUnlock.sol
@@ -5,8 +5,8 @@ pragma solidity ^0.8.0;
 import { IERC20 } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IERC20.sol';
 import { SafeTokenTransfer, SafeTokenTransferFrom } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/libs/SafeTransfer.sol';
 
-import { ITokenManagerLockUnlock } from '../../interfaces/ITokenManagerLockUnlock.sol';
-import { TokenManager } from '../TokenManager.sol';
+import { ITokenManagerLockUnlock } from '..//interfaces/ITokenManagerLockUnlock.sol';
+import { TokenManager } from './TokenManager.sol';
 
 /**
  * @title TokenManagerLockUnlock

diff --git a/...ementations/TokenManagerLockUnlockFee.sol → ...ken-manager/TokenManagerLockUnlockFee.sol b/...ementations/TokenManagerLockUnlockFee.sol → ...ken-manager/TokenManagerLockUnlockFee.sol
@@ -6,8 +6,8 @@ import { IERC20 } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interf
 import { SafeTokenTransferFrom, SafeTokenTransfer } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/libs/SafeTransfer.sol';
 import { ReentrancyGuard } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/utils/ReentrancyGuard.sol';
 
-import { ITokenManagerLockUnlock } from '../../interfaces/ITokenManagerLockUnlock.sol';
-import { TokenManager } from '../TokenManager.sol';
+import { ITokenManagerLockUnlock } from '../interfaces/ITokenManagerLockUnlock.sol';
+import { TokenManager } from './TokenManager.sol';
 
 /**
  * @title TokenManagerLockUnlock

diff --git a/.../implementations/TokenManagerMintBurn.sol → ...ts/token-manager/TokenManagerMintBurn.sol b/.../implementations/TokenManagerMintBurn.sol → ...ts/token-manager/TokenManagerMintBurn.sol
@@ -5,9 +5,9 @@ pragma solidity ^0.8.0;
 import { IERC20 } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IERC20.sol';
 import { SafeTokenCall } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/libs/SafeTransfer.sol';
 
-import { TokenManager } from '../TokenManager.sol';
-import { IERC20MintableBurnable } from '../../interfaces/IERC20MintableBurnable.sol';
-import { ITokenManagerMintBurn } from '../../interfaces/ITokenManagerMintBurn.sol';
+import { TokenManager } from './TokenManager.sol';
+import { IERC20MintableBurnable } from '../interfaces/IERC20MintableBurnable.sol';
+import { ITokenManagerMintBurn } from '../interfaces/ITokenManagerMintBurn.sol';
 
 /**
  * @title TokenManagerMintBurn

diff --git a/...lementations/TokenManagerMintBurnFrom.sol → ...oken-manager/TokenManagerMintBurnFrom.sol b/...lementations/TokenManagerMintBurnFrom.sol → ...oken-manager/TokenManagerMintBurnFrom.sol
@@ -5,7 +5,7 @@ pragma solidity ^0.8.0;
 import { IERC20 } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IERC20.sol';
 import { SafeTokenCall } from '@axelar-network/axelar-gmp-sdk-solidity/contracts/libs/SafeTransfer.sol';
 
-import { IERC20BurnableFrom } from '../../interfaces/IERC20BurnableFrom.sol';
+import { IERC20BurnableFrom } from '../interfaces/IERC20BurnableFrom.sol';
 import { TokenManagerMintBurn } from './TokenManagerMintBurn.sol';
 
 /**

diff --git a/test/ERC20.js b/test/ERC20.js
@@ -3,15 +3,13 @@
 const chai = require('chai');
 const { ethers } = require('hardhat');
 const {
-    Contract,
     constants: { MaxUint256, AddressZero },
+    getContractAt,
 } = ethers;
 const { expect } = chai;
 const { getRandomBytes32, expectRevert } = require('./utils');
 const { deployContract } = require('../scripts/deploy');
 
-const InterchainToken = require('../artifacts/contracts/token-implementations/InterchainToken.sol/InterchainToken.json');
-
 describe('ERC20', () => {
     let interchainToken, interchainTokenDeployer;
 
@@ -35,8 +33,7 @@ describe('ERC20', () => {
         const salt = getRandomBytes32();
 
         const tokenAddress = await interchainTokenDeployer.deployedAddress(salt);
-
-        token = new Contract(tokenAddress, InterchainToken.abi, owner);
+        token = await getContractAt('InterchainToken', tokenAddress, owner);
 
         await interchainTokenDeployer
             .deployInterchainToken(salt, owner.address, owner.address, name, symbol, decimals)

diff --git a/test/ERC20Permit.js b/test/ERC20Permit.js
@@ -3,16 +3,14 @@
 const chai = require('chai');
 const { ethers } = require('hardhat');
 const {
-    Contract,
+    getContractAt,
     utils: { splitSignature },
     constants: { MaxUint256 },
 } = ethers;
 const { expect } = chai;
 const { getRandomBytes32, expectRevert, getChainId } = require('./utils');
 const { deployContract } = require('../scripts/deploy');
 
-const InterchainToken = require('../artifacts/contracts/token-implementations/InterchainToken.sol/InterchainToken.json');
-
 describe('ERC20 Permit', () => {
     let interchainToken, interchainTokenDeployer;
 
@@ -39,7 +37,7 @@ describe('ERC20 Permit', () => {
 
         const tokenAddress = await interchainTokenDeployer.deployedAddress(salt);
 
-        token = new Contract(tokenAddress, InterchainToken.abi, owner);
+        token = await getContractAt('InterchainToken', tokenAddress, owner);
 
         await interchainTokenDeployer
             .deployInterchainToken(salt, owner.address, owner.address, name, symbol, decimals)

diff --git a/test/InterchainToken.js b/test/InterchainToken.js
@@ -3,16 +3,13 @@
 const chai = require('chai');
 const { ethers } = require('hardhat');
 const {
-    Contract,
+    getContractAt,
     utils: { keccak256, toUtf8Bytes },
 } = ethers;
 const { expect } = chai;
 const { getRandomBytes32, expectRevert, getGasOptions } = require('./utils');
 const { deployContract } = require('../scripts/deploy');
 
-const InterchainToken = require('../artifacts/contracts/token-implementations/InterchainToken.sol/InterchainToken.json');
-const InterchainTokenProxy = require('../artifacts/contracts/proxies/InterchainTokenProxy.sol/InterchainTokenProxy.json');
-
 describe('InterchainToken', () => {
     let interchainToken, interchainTokenDeployer;
 
@@ -37,8 +34,8 @@ describe('InterchainToken', () => {
 
         const tokenAddress = await interchainTokenDeployer.deployedAddress(salt);
 
-        token = new Contract(tokenAddress, InterchainToken.abi, owner);
-        tokenProxy = new Contract(tokenAddress, InterchainTokenProxy.abi, owner);
+        token = await getContractAt('InterchainToken', tokenAddress, owner);
+        tokenProxy = await getContractAt('InterchainTokenProxy', tokenAddress, owner);
 
         await interchainTokenDeployer
             .deployInterchainToken(salt, owner.address, owner.address, name, symbol, decimals)
@@ -78,7 +75,7 @@ describe('InterchainToken', () => {
     describe('Interchain Token', () => {
         it('revert on setup if not called by the proxy', async () => {
             const implementationAddress = await tokenProxy.implementation();
-            const implementation = new Contract(implementationAddress, InterchainToken.abi, owner);
+            const implementation = await getContractAt('InterchainToken', implementationAddress, owner);
 
             const params = '0x';
             await expectRevert((gasOptions) => implementation.setup(params, gasOptions), token, 'NotProxy');

diff --git a/test/InterchainTokenFactory.js b/test/InterchainTokenFactory.js
@@ -6,14 +6,11 @@ require('dotenv').config();
 const { ethers } = require('hardhat');
 const { defaultAbiCoder, keccak256 } = ethers.utils;
 const {
-    Contract,
+    getContractAt,
     Wallet,
     constants: { AddressZero },
 } = ethers;
 
-const ITokenManager = require('../artifacts/contracts/interfaces/ITokenManager.sol/ITokenManager.json');
-const IInterchainToken = require('../artifacts/contracts/interfaces/IInterchainToken.sol/IInterchainToken.json');
-
 const { deployAll, deployContract } = require('../scripts/deploy');
 const { getRandomBytes32 } = require('./utils');
 
@@ -187,8 +184,8 @@ describe('InterchainTokenFactory', () => {
             tokenId = await tokenFactory.interchainTokenId(wallet.address, salt);
             const tokenAddress = await tokenFactory.interchainTokenAddress(wallet.address, salt);
             const params = defaultAbiCoder.encode(['bytes', 'address'], [operator, tokenAddress]);
-            const tokenManager = new Contract(await service.tokenManagerAddress(tokenId), ITokenManager.abi, wallet);
-            const token = new Contract(tokenAddress, IInterchainToken.abi, wallet);
+            const tokenManager = await getContractAt('TokenManager', await service.tokenManagerAddress(tokenId), wallet);
+            const token = await getContractAt('InterchainToken', tokenAddress, wallet);
 
             await expect(tokenFactory.deployInterchainToken(salt, name, symbol, decimals, mintAmount, distributor, operator))
                 .to.emit(service, 'InterchainTokenDeployed')
@@ -220,8 +217,8 @@ describe('InterchainTokenFactory', () => {
             tokenId = await tokenFactory.interchainTokenId(wallet.address, salt);
             const tokenAddress = await tokenFactory.interchainTokenAddress(wallet.address, salt);
             let params = defaultAbiCoder.encode(['bytes', 'address'], [wallet.address, tokenAddress]);
-            const tokenManager = new Contract(await service.tokenManagerAddress(tokenId), ITokenManager.abi, wallet);
-            const token = new Contract(tokenAddress, IInterchainToken.abi, wallet);
+            const tokenManager = await getContractAt('TokenManager', await service.tokenManagerAddress(tokenId), wallet);
+            const token = await getContractAt('InterchainToken', tokenAddress, wallet);
 
             await expect(tokenFactory.deployInterchainToken(salt, name, symbol, decimals, mintAmount, wallet.address, wallet.address))
                 .to.emit(service, 'InterchainTokenDeployed')
@@ -269,8 +266,8 @@ describe('InterchainTokenFactory', () => {
             tokenId = await tokenFactory.interchainTokenId(wallet.address, salt);
             const tokenAddress = await tokenFactory.interchainTokenAddress(wallet.address, salt);
             let params = defaultAbiCoder.encode(['bytes', 'address'], [wallet.address, tokenAddress]);
-            const tokenManager = new Contract(await service.tokenManagerAddress(tokenId), ITokenManager.abi, wallet);
-            const token = new Contract(tokenAddress, IInterchainToken.abi, wallet);
+            const tokenManager = await getContractAt('TokenManager', await service.tokenManagerAddress(tokenId), wallet);
+            const token = await getContractAt('InterchainToken', tokenAddress, wallet);
 
             await expect(tokenFactory.deployInterchainToken(salt, name, symbol, decimals, mintAmount, wallet.address, wallet.address))
                 .to.emit(service, 'InterchainTokenDeployed')