Skip to content
This repository has been archived by the owner on Dec 3, 2024. It is now read-only.

Commit

Permalink
Merge branch 'main' into upgradeable-poc-merge
Browse files Browse the repository at this point in the history
  • Loading branch information
minghinmatthewlam authored Jul 18, 2024
2 parents 80cb00e + 3a11ef5 commit 41693c1
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
Expand Down
8 changes: 8 additions & 0 deletions audits/README.md
Original file line number Diff line number Diff line change
@@ -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) |

0 comments on commit 41693c1

Please sign in to comment.