Skip to content

Commit 6552031

Browse files
committed
relax audit warnings
1 parent 044b732 commit 6552031

File tree

4 files changed

+3
-9
lines changed

4 files changed

+3
-9
lines changed

Diff for: SECURITY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ Please use the most recently released version to perform testing and to validate
1818

1919
## Audit Reports
2020

21-
All complete audit reports for `TeleporterMessenger` can be found in the [audits](./audits/) directory.
21+
All complete audit reports for the contracts in this repository can be found in the [audits](./audits/) directory.

Diff for: audits/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Audits
22

3-
Below is the list of most recent audit for contracts in this repo. Please check out __only__ listed audited versions for production code. Code used should be the final commit audited.
3+
Below is the list of most recent audit for each smart contract application in this repository. Please exercise caution when using code newer than the audited commit.
44

55
See `audits/historical` for older audits. These audits may now be obsolete, and legacy code superseded by new versions are __not__ recommended for production deployments.
66

Diff for: contracts/README.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,4 @@ This repository is set up as a [Foundry](https://github.com/foundry-rs/foundry)
1313

1414
## Audits
1515

16-
In general, the contracts in this repository have been audited. Any unaudited contracts will be explicitly marked as such. Note that the `main` branch may contain unaudited code. Please check [here](../audits/README.md) for which versions of each contract have been audited.
17-
18-
> [!CAUTION]
19-
> DO NOT USE UN-AUDITED CODE IN PRODUCTION!
16+
In general, the contracts in this repository have been audited. Any contracts that have not undergone at least one audit will be explicitly marked as such. Please note that audits capture the state of code at a point in time, and the code is subject to change in the meantime. Please check [here](../audits/README.md) for the full list of audits.

Diff for: contracts/teleporter/README.md

-3
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,6 @@ Once sent on chain, ICM messages cannot be re-signed by a new validator set in s
8787

8888
## TeleporterMessenger Contract Deployment
8989

90-
> [!CAUTION]
91-
> DO NOT USE UN-AUDITED CODE IN PRODUCTION!
92-
9390
**Do not deploy the `TeleporterMessenger` contract using `forge create`**. The `TeleporterMessenger` contract must be deployed to the same contract address on every chain. To achieve this, the contract can be deployed using a static transaction that uses Nick's method as documented in [this guide](../..//utils/contract-deployment/README.md). Alternatively, if creating a new L1, the contract can be pre-allocated with the proper address and state in the new chain's [genesis file](https://docs.avax.network/build/subnet/upgrade/customize-a-subnet#setting-the-genesis-allocation).
9491

9592
As an example, to include `TeleporterMessenger` `v1.0.0` in the genesis file, include the following values in the `alloc` settings, as documented at the link above. The `storage` values included below correspond to the two contract values that are initialized as part of the default constructor of `TeleporterMessenger`. These are the `ReentrancyGuard` values set in this [abstract contract](../utilities/ReentrancyGuards.sol). Future versions of `TeleporterMessenger` may require different storage value initializations.

0 commit comments

Comments
 (0)