From ba8cf301f117650416ad2ab58da4a8383436aed0 Mon Sep 17 00:00:00 2001 From: shafu Date: Mon, 23 Jun 2025 11:49:43 -0400 Subject: [PATCH 1/2] Update README with new contract name and details --- README.md | 76 +++++++++++++++---------------------------------------- 1 file changed, 20 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 38f0232e..975afbb0 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,30 @@ -# Merit Contracts +# Merit Escrow -We have one contract called [Escrow.sol](./src/Escrow.sol) +Escrow contract for secure token distributions with signature-based claims. -| Single Operation | Batch Operation | Description | -| ---------------- | --------------- | ----------------------------------------------- | -| `deposit` | `batchDeposit` | Deposit tokens into escrow | -| `claim` | `batchClaim` | Claim tokens as the recipient | -| `reclaim` | `batchReclaim` | Reclaim tokens as the sender after claim period | +## Core Contract -### Build +[`Escrow.sol`](src/Escrow.sol) - The main escrow contract supporting both repository-managed and direct distributions. -`forge build` +## Building -### Test +```bash +forge build +``` -`forge test` +## Testing -### Deploy +```bash +forge test +``` -##### Sepolia +## Audits -`make deploy-sepolia` +Multiple security audits have been conducted: -##### Base Sepolia - -`make deploy-base-sepolia` - -##### Base - -`make deploy-base` - -### Audits - -All reports are in [audits](./audits/) - -### Create2Crunch Vanity Address Mining - -The project includes a vanity address miner using [create2crunch](https://github.com/0age/create2crunch) to find specific contract addresses that match desired patterns. This is particularly useful for creating contracts at predictable addresses. - -To use create2crunch: - -1. Navigate to the create2crunch directory: - - ```bash - cd create2crunch - ``` - -2. Configure the parameters in `run.sh`: - - - `OWNER`: Contract owner address - - `SIGNER`: Signer address - - `TOKENS`: Array of token addresses - - `FEE_BPS`: Fee basis points - - `BATCH_LIMIT`: Batch size limit - - `FACTORY`: Factory contract address - - `CALLER`: Caller address - -3. Run the mining script: - ```bash - ./run.sh - ``` - -The script will compile the contract, generate the initialization code, and use create2crunch to find salt values that generate contract addresses matching your desired patterns. - -For more detailed information, see the [create2crunch README](./create2crunch/README.md). +- [QAQA Audit #1](audits/01_audit-escrow-qaqa.pdf) +- [Trust Security Audit #1](audits/02_audit-escrow-trust.pdf) +- [QAQA Audit #2](audits/03_audit-escrow-qaqa-2.pdf) +- [Trust Security Audit #2](audits/04_audit-escrow-trust-2.pdf) +- [QAQA Audit #3](audits/05_audit-escrow-qaqa-3.pdf) +- [Trust Security Audit #3](audits/06_audit-escrow-trust-3.pdf) From 8f42bc6c28266c4e1656341a35e433b9de8aed4e Mon Sep 17 00:00:00 2001 From: shafu Date: Mon, 23 Jun 2025 11:53:46 -0400 Subject: [PATCH 2/2] Update README with security audit information --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 975afbb0..3b2c0ac3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ +``` + ███▄ ▄███▓▓█████ ██▀███ ██▓▄▄▄█████▓ ██████▓██ ██▓ ██████ ▄▄▄█████▓▓█████ ███▄ ▄███▓ ██████ +▓██▒▀█▀ ██▒▓█ ▀ ▓██ ▒ ██▒▓██▒▓ ██▒ ▓▒ ▒██ ▒ ▒██ ██▒▒██ ▒ ▓ ██▒ ▓▒▓█ ▀ ▓██▒▀█▀ ██▒▒██ ▒ +▓██ ▓██░▒███ ▓██ ░▄█ ▒▒██▒▒ ▓██░ ▒░ ░ ▓██▄ ▒██ ██░░ ▓██▄ ▒ ▓██░ ▒░▒███ ▓██ ▓██░░ ▓██▄ +▒██ ▒██ ▒▓█ ▄ ▒██▀▀█▄ ░██░░ ▓██▓ ░ ▒ ██▒ ░ ▐██▓░ ▒ ██▒░ ▓██▓ ░ ▒▓█ ▄ ▒██ ▒██ ▒ ██▒ +▒██▒ ░██▒░▒████▒░██▓ ▒██▒░██░ ▒██▒ ░ ▒██████▒▒ ░ ██▒▓░▒██████▒▒ ▒██▒ ░ ░▒████▒▒██▒ ░██▒▒██████▒▒ +░ ▒░ ░ ░░░ ▒░ ░░ ▒▓ ░▒▓░░▓ ▒ ░░ ▒ ▒▓▒ ▒ ░ ██▒▒▒ ▒ ▒▓▒ ▒ ░ ▒ ░░ ░░ ▒░ ░░ ▒░ ░ ░▒ ▒▓▒ ▒ ░ +░ ░ ░ ░ ░ ░ ░▒ ░ ▒░ ▒ ░ ░ ░ ░▒ ░ ░▓██ ░▒░ ░ ░▒ ░ ░ ░ ░ ░ ░░ ░ ░░ ░▒ ░ ░ +░ ░ ░ ░░ ░ ▒ ░ ░ ░ ░ ░ ▒ ▒ ░░ ░ ░ ░ ░ ░ ░ ░ ░ ░ ░ + ░ ░ ░ ░ ░ ░ ░ ░ ░ ░ ░ ░ ░ + ░ ░ +``` + # Merit Escrow Escrow contract for secure token distributions with signature-based claims. @@ -20,11 +33,4 @@ forge test ## Audits -Multiple security audits have been conducted: - -- [QAQA Audit #1](audits/01_audit-escrow-qaqa.pdf) -- [Trust Security Audit #1](audits/02_audit-escrow-trust.pdf) -- [QAQA Audit #2](audits/03_audit-escrow-qaqa-2.pdf) -- [Trust Security Audit #2](audits/04_audit-escrow-trust-2.pdf) -- [QAQA Audit #3](audits/05_audit-escrow-qaqa-3.pdf) -- [Trust Security Audit #3](audits/06_audit-escrow-trust-3.pdf) +Multiple security audits have been conducted. See the [audits directory](audits/) for all audit reports.