Contracts top level

.github/workflows/release.yml

@@ -35,7 +35,6 @@ jobs:
       - name: Build Contracts
         run: |
           export PATH=$PATH:$HOME/.foundry/bin
-          cd contracts/
           forge build --force --extra-output-files bin
 
       - name: Build changelog
@@ -49,12 +48,12 @@ jobs:
       - name: Create Artifacts
         id: artifacts
         run: |
-          go run utils/contract-deployment/contractDeploymentTools.go constructKeylessTx contracts/out/TeleporterMessenger.sol/TeleporterMessenger.json
+          go run utils/contract-deployment/contractDeploymentTools.go constructKeylessTx out/TeleporterMessenger.sol/TeleporterMessenger.json
           mv UniversalTeleporterDeployerTransaction.txt ${{ env.deployment_tx_fn }}
           mv UniversalTeleporterDeployerAddress.txt ${{ env.deployer_addr_fn }}
           mv UniversalTeleporterMessengerContractAddress.txt ${{ env.contract_addr_fn }}
-          mv contracts/out/TeleporterMessenger.sol/TeleporterMessenger.bin ${{ env.teleporter_messenger_bytecode_fn }}
-          mv contracts/out/TeleporterRegistry.sol/TeleporterRegistry.bin ${{ env.teleporter_registry_bytecode_fn }}
+          mv out/TeleporterMessenger.sol/TeleporterMessenger.bin ${{ env.teleporter_messenger_bytecode_fn }}
+          mv out/TeleporterRegistry.sol/TeleporterRegistry.bin ${{ env.teleporter_registry_bytecode_fn }}
 
       - name: Create release
         uses: softprops/action-gh-release@v2

.github/workflows/slither.yml

@@ -37,10 +37,9 @@ jobs:
       - name: Run Slither
         run: |
           export PATH=$PATH:$HOME/.foundry/bin
-          cd contracts
           slither ./ --fail-none --sarif ./results.sarif
 
       - name: Upload SARIF file
         uses: github/codeql-action/upload-sarif@v3
         with:
-          sarif_file: contracts/results.sarif
+          sarif_file: results.sarif

.github/workflows/test.yml

@@ -24,7 +24,6 @@ jobs:
       - name: Run unit tests
         run: |
           export PATH=$PATH:$HOME/.foundry/bin
-          cd contracts/
           forge test -vvv
 
   go-unit-tests:

.gitmodules

@@ -1,13 +1,14 @@
-[submodule "contracts/lib/forge-std"]
-	path = contracts/lib/forge-std
-	url = https://github.com/foundry-rs/forge-std
 [submodule "lib/forge-std"]
-	branch = v1.3.0
-[submodule "contracts/lib/openzeppelin-contracts"]
-	path = contracts/lib/openzeppelin-contracts
-	url = https://github.com/openzeppelin/openzeppelin-contracts
+	branch = v1
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+	ignore = dirty
 [submodule "lib/openzeppelin-contracts"]
 	branch = v4.8.1
-[submodule "contracts/lib/subnet-evm"]
-	path = contracts/lib/subnet-evm
+	path = lib/openzeppelin-contracts
+	url = https://github.com/openzeppelin/openzeppelin-contracts
+	ignore = dirty
+[submodule "lib/subnet-evm"]
+	branch = v0.6.1
+	path = lib/subnet-evm
 	url = https://github.com/ava-labs/subnet-evm

.solhintignore

@@ -0,0 +1 @@
+lib/

README.md

@@ -126,11 +126,11 @@ The user wallet set in `.env` must have native tokens for each of the Subnets us
 
 ## Upgradeability
 
-The Teleporter contract is non-upgradeable and can not be changed once it is deployed. This provides immutability to the contracts, and ensures that the contract's behavior at each address is unchanging. However, to allow for new features and potential bug fixes, new versions of the Teleporter contract can be deployed to different addresses. The [TeleporterRegistry](./contracts/src/Teleporter/TeleporterRegistry.sol) is used to keep track of the deployed versions of Teleporter, and to provide a standard interface for dApps to interact with the different Teleporter versions.
+The Teleporter contract is non-upgradeable and can not be changed once it is deployed. This provides immutability to the contracts, and ensures that the contract's behavior at each address is unchanging. However, to allow for new features and potential bug fixes, new versions of the Teleporter contract can be deployed to different addresses. The [TeleporterRegistry](./contracts/Teleporter/TeleporterRegistry.sol) is used to keep track of the deployed versions of Teleporter, and to provide a standard interface for dApps to interact with the different Teleporter versions.
 
 `TeleporterRegistry` **is not mandatory** for dApps built on top of Teleporter, but dApp's are recommended to leverage the registry to ensure they use the latest Teleporter version available. Another recommendation standard is to have a single canonical `TeleporterRegistry` for each Subnet chain, and unlike the Teleporter contract, the registry does not need to be deployed to the same address on every chain. This means the registry does not need a Nick's method deployment, and can be at different contract addresses on different chains.
 
-For more information on the registry and how to integrate with Teleporter dApps, see the [Upgradeability doc](./contracts/src/Teleporter/upgrades/README.md).
+For more information on the registry and how to integrate with Teleporter dApps, see the [Upgradeability doc](./contracts/Teleporter/upgrades/README.md).
 
 ## Deploy Teleporter to a Subnet
 
@@ -181,10 +181,8 @@ The auto-generated bindings should be written under the `abi-bindings/` director
 
 ## Docs
 
-- [Teleporter Protocol Overview](./contracts/src/Teleporter/README.md)
-- [Cross Chain Applications](./contracts/src/CrossChainApplications/README.md)
-- [Getting Started](./contracts/src/CrossChainApplications/GETTING_STARTED.md)
-- [Teleporter Upgradeability](./contracts/src/Teleporter/upgrades/README.md)
+- [Teleporter Protocol Overview](./contracts/Teleporter/README.md)
+- [Teleporter Upgradeability](./contracts/Teleporter/upgrades/README.md)
 - [Contract Deployment](./utils/contract-deployment/README.md)
 - [Teleporter CLI](./cmd/teleporter-cli/README.md)
 

abi-bindings/README.md

@@ -1,3 +1,3 @@
 ## ABI Bindings
 
-This directory contains ABI bindings for the Solidity contracts in the `contracts/src/CrossChainApplications` and `contracts/src/Teleporter` directories. The files with the same name as the Solidity source files are automatically generated by the `scripts/abi_bindings.sh` script. Other files in this directory (such as the packing utilities) are manually created and maintained.
+This directory contains Solidity contract ABI bindings. The files with the same name as the Solidity source files are automatically generated by the `scripts/abi_bindings.sh` script. Other files in this directory (such as the packing utilities) are manually created and maintained.