-
Notifications
You must be signed in to change notification settings - Fork 3
chore: add audit & verification status per contract #119
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
melanciani
wants to merge
4
commits into
main
Choose a base branch
from
feature/pro-75-chore-add-tags-per-contract-status-deployed-audited
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
ae5f89c
chore: add audit & verification status templates
melanciani 85bc3a0
chore: refine staking audit template
melanciani 0afb17a
chore: add status column to audit templates
melanciani 91f3c5e
chore: rename status column to deploy status
melanciani File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
20 changes: 20 additions & 0 deletions
20
contracts/confidential-token-wrappers-registry/audits/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # Confidential Token Wrappers Registry — Audit & verification status | ||
|
|
||
| Tracks the security verification status for each released version of the `confidential-token-wrappers-registry` contracts. | ||
|
|
||
| - Package source: [`contracts/confidential-token-wrappers-registry`](../) | ||
| - Deployed addresses: [Ethereum mainnet](../../../docs/addresses/mainnet/ethereum.md), [Sepolia testnet](../../../docs/addresses/testnet/sepolia.md) | ||
| - Top-level index: [`SECURITY.md`](../../../SECURITY.md) | ||
|
|
||
| ## Git tag convention | ||
|
|
||
| Releases are tagged from the repo root as `registry-vX.Y.Z`. These contracts are upgradable (UUPS), so a tag is a candidate source snapshot for a proxy upgrade. | ||
|
|
||
| ## Verification status | ||
|
|
||
| Legend: ✅ completed · 🟡 in progress · — not applicable · TBD to be filled in. | ||
|
|
||
| | Tag | Commit | Pre-deploy audit | Post-deploy audit | Deploy status | | ||
| | ----------------- | ------ | ---------------- | ----------------- | --------------- | | ||
| | `registry-v1.0.0` | [`76dbe8f`](https://github.com/zama-ai/protocol-apps/commit/76dbe8f0bb8d254650b5e6644423c2dbc6fb6117) | - | - | Active | | ||
| | `registry-v1.0.1` | [`373c5f2`](https://github.com/zama-ai/protocol-apps/commit/373c5f29ee6e9b45a379470488a83cb20b324bdf) | ✅ | TBD | Upcoming | | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # Confidential Wrapper — Audit & verification status | ||
|
|
||
| Tracks the security verification status for each released version of the `confidential-wrapper` contracts. | ||
|
|
||
| - Package source: [`contracts/confidential-wrapper`](../) | ||
| - Deployed addresses: [Ethereum mainnet](../../../docs/addresses/mainnet/ethereum.md), [Sepolia testnet](../../../docs/addresses/testnet/sepolia.md) | ||
| - Top-level index: [`SECURITY.md`](../../../SECURITY.md) | ||
|
|
||
| ## Git tag convention | ||
|
|
||
| Releases are tagged from the repo root as `wrapper-vX.Y.Z`. These contracts are upgradable (UUPS), so a tag is a candidate source snapshot for a proxy upgrade. | ||
|
|
||
| ## Verification status | ||
|
|
||
| Legend: ✅ completed · 🟡 in progress · — not applicable · TBD to be filled in. | ||
|
|
||
| | Tag | Commit | Pre-deploy audit | Post-deploy audit | Deploy status | | ||
| | ---------------- | ------ | ---------------- | ----------------- | --------------- | | ||
| | `wrapper-v1.0.0` | [`ac9f9ca`](https://github.com/zama-ai/protocol-apps/commit/ac9f9ca247328ad89dd3084854f71585fdd0c39c) | - | - | Active | | ||
| | `wrapper-v2.0.0` | [`b06eb26`](https://github.com/zama-ai/protocol-apps/commit/b06eb263d64c788a27b6bc1baf46b7547f7ec594) | ✅ | TBD | Upcoming | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # Fees Burner — Audit & verification status | ||
|
|
||
| Tracks the security verification status for each released version of the `feesBurner` contracts (`ProtocolFeesBurner`, `FeesSenderToBurner`). | ||
|
|
||
| - Package source: [`contracts/feesBurner`](../) | ||
| - Deployed addresses: [Ethereum mainnet](../../../docs/addresses/mainnet/ethereum.md), [Gateway mainnet](../../../docs/addresses/mainnet/gateway.md), [Sepolia testnet](../../../docs/addresses/testnet/sepolia.md), [Gateway testnet](../../../docs/addresses/testnet/gateway.md) | ||
| - Top-level index: [`SECURITY.md`](../../../SECURITY.md) | ||
|
|
||
| ## Git tag convention | ||
|
|
||
| Releases are tagged from the repo root as `fees-vX.Y.Z`. Contracts are immutable, so each tag is the source snapshot for a specific on-chain deployment. | ||
|
|
||
| ## Verification status | ||
|
|
||
| Legend: ✅ completed · 🟡 in progress · — not applicable · TBD to be filled in. | ||
|
|
||
| | Tag | Commit | Pre-deploy audit | Post-deploy audit | Deploy status | | ||
| | ------------- | ------ | ---------------- | ----------------- | ------------- | | ||
| | `fees-v1.0.0` | [`b8cbe46`](https://github.com/zama-ai/protocol-apps/commit/b8cbe46dadac9a69deec2a9fe0fa5ea1478a7c0a) | ✅ | - | Active | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # Governance — Audit & verification status | ||
|
|
||
| Tracks the security verification status for each released version of the `governance` contracts. | ||
|
|
||
| - Package source: [`contracts/governance`](../) | ||
| - Deployed addresses: [Ethereum mainnet](../../../docs/addresses/mainnet/ethereum.md), [Gateway mainnet](../../../docs/addresses/mainnet/gateway.md), [BSC](../../../docs/addresses/mainnet/bsc.md), [HyperEVM](../../../docs/addresses/mainnet/hyper_evm.md), [Solana](../../../docs/addresses/mainnet/solana.md), [Sepolia testnet](../../../docs/addresses/testnet/sepolia.md), [Gateway testnet](../../../docs/addresses/testnet/gateway.md) | ||
| - Top-level index: [`SECURITY.md`](../../../SECURITY.md) | ||
|
|
||
| ## Git tag convention | ||
|
|
||
| Releases are tagged from the repo root as `governance-vX.Y.Z`. These contracts are immutable, so each tag is the source snapshot for a specific on-chain deployment. | ||
|
|
||
| ## Verification status | ||
|
|
||
| Legend: ✅ completed · 🟡 in progress · — not applicable · TBD to be filled in. | ||
|
|
||
| | Tag | Commit | Pre-deploy audit | Post-deploy audit | Deploy status | | ||
| | ------------------- | ------ | ---------------- | ----------------- | ------------- | | ||
| | `governance-v1.0.0` | [`14ec881`](https://github.com/zama-ai/protocol-apps/commit/14ec881d6beadae49120354ded440f6f4766412e) | ✅ | ✅ | Active | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # Pauser Set Wrapper — Audit & verification status | ||
|
|
||
| Tracks the security verification status for each released version of the `pauserSetWrapper` contracts. | ||
|
|
||
| - Package source: [`contracts/pauserSetWrapper`](../) | ||
| - Deployed addresses: [Ethereum mainnet](../../../docs/addresses/mainnet/ethereum.md), [Sepolia testnet](../../../docs/addresses/testnet/sepolia.md) | ||
| - Top-level index: [`SECURITY.md`](../../../SECURITY.md) | ||
|
|
||
| ## Git tag convention | ||
|
|
||
| Releases are tagged from the repo root as `pauserSetWrapper-vX.Y.Z`. These contracts are immutable, so each tag is the source snapshot for a specific on-chain deployment. | ||
|
|
||
| ## Verification status | ||
|
|
||
| Legend: ✅ completed · 🟡 in progress · — not applicable · TBD to be filled in. | ||
|
|
||
| | Tag | Commit | Pre-deploy audit | Post-deploy audit | Deploy status | | ||
| | ------------------------- | ------ | ---------------- | ----------------- | ------------- | | ||
| | `pauserSetWrapper-v1.0.0` | [`b934741`](https://github.com/zama-ai/protocol-apps/commit/b934741e2f59ab7793d67ab34203a1ce9c9677c9) | ✅ | - | Active | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # Safe (Admin Module) — Audit & verification status | ||
|
|
||
| Tracks the security verification status for each released version of the `safe` contracts (`AdminModule`). | ||
|
|
||
| - Package source: [`contracts/safe`](../) | ||
| - Deployed addresses: [Gateway mainnet](../../../docs/addresses/mainnet/gateway.md), [Gateway testnet](../../../docs/addresses/testnet/gateway.md) | ||
| - Top-level index: [`SECURITY.md`](../../../SECURITY.md) | ||
|
|
||
| ## Git tag convention | ||
|
|
||
| Releases are tagged from the repo root as `safe-vX.Y.Z`. These contracts are immutable, so each tag is the source snapshot for a specific on-chain deployment. | ||
|
|
||
| ## Verification status | ||
|
|
||
| Legend: ✅ completed · 🟡 in progress · — not applicable · TBD to be filled in. | ||
|
|
||
| | Tag | Commit | Pre-deploy audit | Post-deploy audit | Deploy status | | ||
| | ------------- | ------ | ---------------- | ----------------- | ------------- | | ||
| | `safe-v1.0.0` | [`c414e53`](https://github.com/zama-ai/protocol-apps/commit/c414e538367d97f15dcfecce411873d1411f6269) | ✅ | ✅ | Active | | ||
|
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. more like 1b768b7 |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # Solana OFT — Audit & verification status | ||
|
|
||
| Tracks the security verification status for each released version of the `solanaOFT` program (Solana-side of the ZAMA OFT). | ||
|
|
||
| - Package source: [`contracts/solanaOFT`](../) | ||
| - Deployed addresses: [Solana mainnet](../../../docs/addresses/mainnet/solana.md) | ||
| - Top-level index: [`SECURITY.md`](../../../SECURITY.md) | ||
|
|
||
| ## Git tag convention | ||
|
|
||
| Releases are tagged from the repo root as `solanaOFT-vX.Y.Z`. The program is immutable, so each tag is the source snapshot for a specific on-chain deployment. | ||
|
|
||
| ## Verification status | ||
|
|
||
| Legend: ✅ completed · 🟡 in progress · — not applicable · TBD to be filled in. | ||
|
|
||
| | Tag | Commit | Pre-deploy audit | Post-deploy audit | Deploy status | | ||
| | ------------------ | ------ | ---------------- | ----------------- | ------------- | | ||
| | `solanaOFT-v1.0.0` | [`f771d55`](https://github.com/zama-ai/protocol-apps/commit/f771d550eac70616832fc1b4370d2bb753a3a850) | ✅ | ✅ | Active | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Staking — Audit & verification status | ||
|
|
||
| Tracks the security verification status for each released version of the `staking` contracts. | ||
|
|
||
| - Package source: [`contracts/staking`](../) | ||
| - Deployed addresses: [Ethereum mainnet](../../../docs/addresses/mainnet/ethereum.md), [Sepolia testnet](../../../docs/addresses/testnet/sepolia.md) | ||
| - Top-level index: [`SECURITY.md`](../../../SECURITY.md) | ||
|
|
||
| ## Git tag convention | ||
|
|
||
| Releases are tagged from the repo root as `staking-vX.Y.Z`. These contracts are mixed upgradable and immutable, so each tag is the source snapshot for a proxy upgrade or a specific immutable on-chain deployment. | ||
|
|
||
| ## Verification status | ||
|
|
||
| Legend: ✅ completed · 🟡 in progress · — not applicable · TBD to be filled in. | ||
|
|
||
| | Tag | Commit | Pre-deploy audit | Post-deploy audit | Fuzzing and invariants | Deploy status | | ||
| | ---------------- | ------ | ---------------- | ----------------- | ----------------------- | -------------- | | ||
| | `staking-v0.1.0` | [`b9869f6`](https://github.com/zama-ai/protocol-apps/commit/b9869f6016f88821550e98c414c725464da30cb9) | ✅ | - | - | Skipped | | ||
| | `staking-v1.0.0` | [`b631f17`](https://github.com/zama-ai/protocol-apps/commit/b631f175722f81f80ee05f94e5508261e552b341) | ✅ | ✅ | 🟡 | Active (*) | | ||
| | `staking-v1.0.1-luganodes` | [`5c5e705`](https://github.com/zama-ai/protocol-apps/commit/5c5e705fb79827cd459f014a931c22efd698654c) | ✅ | ✅ | 🟡 | Active (**) | | ||
|
|
||
| Legend: | ||
| - (*) The tag is the currently deployed source for all operators EXCEPT `Luganodes`. | ||
| - (**) The tag is the currently deployed source for the `Luganodes` operator ONLY. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # Token — Audit & verification status | ||
|
|
||
| Tracks the security verification status of the token contracts (`ZamaERC20`, `ZamaOFTAdapter`, `ZamaOFT`) per chain. Each chain deployment has its own audit scope, so the matrix is grouped by chain. | ||
|
|
||
| - Package source: [`contracts/token`](../) | ||
| - Deployed addresses: [Ethereum mainnet](../../../docs/addresses/mainnet/ethereum.md), [Gateway mainnet](../../../docs/addresses/mainnet/gateway.md), [BSC](../../../docs/addresses/mainnet/bsc.md), [HyperEVM](../../../docs/addresses/mainnet/hyper_evm.md), [Sepolia testnet](../../../docs/addresses/testnet/sepolia.md), [Gateway testnet](../../../docs/addresses/testnet/gateway.md) | ||
| - Solana OFT: tracked separately in [`solanaOFT` audits](../../solanaOFT/audits/README.md) | ||
| - Top-level index: [`SECURITY.md`](../../../SECURITY.md) | ||
|
|
||
| ## Git tag convention | ||
|
|
||
| Releases are tagged from the repo root as `token-vX.Y.Z`. These contracts are immutable, so each tag is the source snapshot for a specific on-chain deployment. A single tag covers all EVM chain deployments of that version. | ||
|
|
||
| ## Verification status | ||
|
|
||
| Legend: ✅ completed · 🟡 in progress · — not applicable · TBD to be filled in. | ||
|
|
||
| | Tag | Commit | Pre-deploy audit | | ||
| | -------------- | ------ | ---------------- | | ||
| | `token-v1.0.0` | [`157e6c4`](https://github.com/zama-ai/protocol-apps/commit/157e6c4aaa2283f48aeecc7b900146bc3f62bbe1) | ✅ | | ||
|
|
||
| | Chain | Tag | Post-deploy audit | Deploy status | | ||
| | ---------------- | -------------- | ----------------- | ---------------- | | ||
| | Ethereum | `token-v1.0.0` | ✅ | ✅ | | ||
| | Gateway | `token-v1.0.0` | ✅ | ✅ | | ||
| | BSC | `token-v1.0.0` | ✅ | ✅ | | ||
| | HyperEVM | `token-v1.0.0` | ✅ | ✅ | |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you elaborate how to check those commits are correct?