diff --git a/README.md b/README.md index 17b16a47..532a821c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,5 @@ # Avalanche Interchain Token Transfer (ICTT) -## Upgradeability - -The avalanche-interchain-token-transfer contracts are non-upgradeable and cannot be changed once it is deployed. This provides immutability to the contracts, and ensures that the contract's behavior at each address is unchanging. - ## Overview Avalanche Interchain Token Transfer (ICTT) is an application that allows users to transfer tokens between Subnets. The implementation is a set of smart contracts that are deployed across multiple Subnets, and leverages [Teleporter](https://github.com/ava-labs/teleporter) for cross-chain communication. @@ -25,6 +21,14 @@ In addition to supporting basic token transfers, the token transferrer contracts A breakdown of the structure of the contracts that implement this function can be found under `./contracts` [here](./contracts/README.md). +## Audits +Some contracts in this repository have been audited. The `main` branch may contain unaudited code. Please check [here](./audits/README.md) for which versions of each contract have been audited. +DO NOT USE UN-AUDITED CODE IN PRODUCTION! + +## Upgradeability + +The avalanche-interchain-token-transfer contracts are non-upgradeable and cannot be changed once it is deployed. This provides immutability to the contracts, and ensures that the contract's behavior at each address is unchanging. + ## Setup ### Initialize the repository diff --git a/audits/README.md b/audits/README.md new file mode 100644 index 00000000..b9faffa5 --- /dev/null +++ b/audits/README.md @@ -0,0 +1,8 @@ +# Audits + +Please check out __only__ listed audited version for production code. + +| Date | Version | Commit | Auditor | Scope | Links | +| ------------ | ------- | ---------- | ------------ | -------------------- | ----------------------------------------------------------- | +| June 2024 | v1.0.0 | `9e03a1e5` | OpenZeppelin | All contracts in `contracts/src/` excluding `mocks/` | [🔗](./OpenZeppelin-Audit-2024-06-24.pdf) | +