From bc431f5e3f1dea82ee3e3ff2f7e3629f081e4355 Mon Sep 17 00:00:00 2001 From: Raf Solari Date: Wed, 31 Dec 2025 16:28:38 -0500 Subject: [PATCH] Update README with Permitter system documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Replace generic Foundry template documentation with comprehensive guide for the Permitter KYC validation hook system, including architecture diagram, contract interfaces, usage examples, and security considerations. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Haiku 4.5 --- README.md | 250 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 128 insertions(+), 122 deletions(-) diff --git a/README.md b/README.md index ed5d5da..544ea7f 100644 --- a/README.md +++ b/README.md @@ -1,159 +1,165 @@ -# ScopeLift Foundry Template +# Permitter -An opinionated template for [Foundry](https://github.com/foundry-rs/foundry) projects. - -_**Please read the full README before using this template.**_ - -- [Usage](#usage) -- [Overview](#overview) - - [`foundry.toml`](#foundrytoml) - - [CI](#ci) - - [Test Structure](#test-structure) -- [Configuration](#configuration) - - [Coverage](#coverage) - - [Slither](#slither) - - [GitHub Code Scanning](#github-code-scanning) - -## Usage - -To use this template, use one of the below approaches: - -1. Run `forge init --template ScopeLift/foundry-template` in an empty directory. -2. Click [here](https://github.com/ScopeLift/foundry-template/generate) to generate a new repository from this template. -3. Click the "Use this template" button from this repo's [home page](https://github.com/ScopeLift/foundry-template). - -It's also recommend to install [scopelint](https://github.com/ScopeLift/scopelint), which is used in CI. -You can run this locally with `scopelint fmt` and `scopelint check`. -Note that these are supersets of `forge fmt` and `forge fmt --check`, so you do not need to run those forge commands when using scopelint. +A smart contract system for enforcing KYC-based permissions and caps on Uniswap CCA (Continuous Combinatorial Auction) token sales. Uses EIP-712 signed permits issued by an off-chain server after KYC verification, validated on-chain during each bid. ## Overview -This template is designed to be a simple but powerful configuration for Foundry projects, that aims to help you follow Solidity and Foundry [best practices](https://book.getfoundry.sh/tutorials/best-practices) -Writing secure contracts is hard, so it ships with strict defaults that you can loosen as needed. - -### `foundry.toml` - -The `foundry.toml` config file comes with: - -- A `fmt` configuration. -- `default`, `lite`, and `ci` profiles. - -Both of these can of course be modified. -The `default` and `ci` profiles use the same solc build settings, which are intended to be the production settings, but the `ci` profile is configured to run deeper fuzz and invariant tests. -The `lite` profile turns the optimizer off, which is useful for speeding up compilation times during development. - -It's recommended to keep the solidity configuration of the `default` and `ci` profiles in sync, to avoid accidentally deploying contracts with suboptimal configuration settings when running `forge script`. -This means you can change the solc settings in the `default` profile and the `lite` profile, but never for the `ci` profile. - -Note that the `foundry.toml` file is formatted using [Taplo](https://taplo.tamasfe.dev/) via `scopelint fmt`. - -### CI +Permitter acts as a validation hook for Uniswap CCA auctions, ensuring: +- Only KYC-verified users can participate +- Per-bidder token caps are enforced +- Total ETH raise caps are enforced +- Permits can be rotated if signing keys are compromised -Robust CI is also included, with a GitHub Actions workflow that does the following: +## Architecture -- Runs tests with the `ci` profile. -- Verifies contracts are within the [size limit](https://eips.ethereum.org/EIPS/eip-170) of 24576 bytes. -- Runs `forge coverage` and verifies a minimum coverage threshold is met. -- Runs `slither`, integrated with GitHub's [code scanning](https://docs.github.com/en/code-security/code-scanning). See the [Configuration](#configuration) section to learn more. - -The CI also runs [scopelint](https://github.com/ScopeLift/scopelint) to verify formatting and best practices: - -- Checks that Solidity and TOML files have been formatted. - - Solidity checks use the `foundry.toml` config. - - Currently the TOML formatting cannot be customized. -- Validates test names follow a convention of `test(Fork)?(Fuzz)?_(Revert(If_|When_){1})?\w{1,}`. [^naming-convention] -- Validates constants and immutables are in `ALL_CAPS`. -- Validates internal functions in `src/` start with a leading underscore. -- Validates function names and visibility in forge scripts to 1 public `run` method per script. [^script-abi] - -Note that the foundry-toolchain GitHub Action will cache RPC responses in CI by default, and it will also update the cache when you update your fork tests. +``` +Bidder (Wallet) + │ + ├─── Complete KYC ──────────► Sumsub KYC + │ │ + │ │ Webhook: KYC approved + │ ▼ + ├─── Request permit ────────► Tally Server + │ │ + │◄── EIP-712 signature ────────────┘ + │ + └─── Submit bid with signature ───► Uniswap CCA ──► Permitter + │ + Validation passes/fails +``` -### Test Structure +## Contracts -The test structure is configured to follow recommended [best practices](https://book.getfoundry.sh/tutorials/best-practices). -It's strongly recommended to read that document, as it covers a range of aspects. -Consequently, the test structure is as follows: +### PermitterFactory -- The core protocol deploy script is `script/Deploy.sol`. - This deploys the contracts and saves their addresses to storage variables. -- The tests inherit from this deploy script and execute `Deploy.run()` in their `setUp` method. - This has the effect of running all tests against your deploy script, giving confidence that your deploy script is correct. -- Each test contract serves as `describe` block to unit test a function, e.g. `contract Increment` to test the `increment` function. +Deploys isolated Permitter instances for each auction using CREATE2 for deterministic addresses. -## Configuration +```solidity +function createPermitter( + address trustedSigner, + uint256 maxTotalEth, + uint256 maxTokensPerBidder, + address owner, + bytes32 salt +) external returns (address permitter); +``` -After creating a new repository from this template, make sure to set any desired [branch protections](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches) on your repo. +### Permitter -### Coverage +Implements bid validation using EIP-712 signed permits. -The [`ci.yml`](.github/workflows/ci.yml) has `coverage` configured by default, and contains comments explaining how to modify the configuration. -It uses: -The [lcov] CLI tool to filter out the `test/` and `script/` folders from the coverage report. +**Permit Structure:** +```solidity +struct Permit { + address bidder; // Address authorized to bid + uint256 maxBidAmount; // Maximum tokens this bidder can purchase (cumulative) + uint256 expiry; // Timestamp when permit expires +} +``` -- The [romeovs/lcov-reporter-action](https://github.com/romeovs/lcov-reporter-action) action to post a detailed coverage report to the PR. Subsequent commits on the same branch will automatically delete stale coverage comments and post new ones. -- The [zgosalvez/github-actions-report-lcov](https://github.com/zgosalvez/github-actions-report-lcov) action to fail coverage if a minimum coverage threshold is not met. +**Key Functions:** +- `validateBid()` - Called by CCA to validate bids +- `updateMaxTotalEth()` - Update total ETH cap (owner only) +- `updateMaxTokensPerBidder()` - Update per-bidder cap (owner only) +- `updateTrustedSigner()` - Rotate signing key (owner only) +- `pause()` / `unpause()` - Emergency controls (owner only) -Be aware of foundry's current coverage limitations: +## Usage -- You cannot filter files/folders from `forge` directly, so `lcov` is used to do this. -- `forge coverage` always runs with the optimizer off and without via-ir, so if you need either of these to compile you will not be able to run coverage. +### Deploying a Permitter + +```solidity +PermitterFactory factory = PermitterFactory(FACTORY_ADDRESS); +address permitter = factory.createPermitter( + signerAddress, // Trusted signer (backend) + 100 ether, // Max total ETH + 1000 * 10**18, // Max tokens per bidder + ownerAddress, // Contract owner + keccak256("my-auction") // Salt for deterministic address +); +``` -Remember not to optimize for coverage, but to optimize for [well thought-out tests](https://book.getfoundry.sh/tutorials/best-practices?highlight=coverage#best-practices-1). +### Issuing Permits (Off-chain) + +```typescript +const domain = { + name: 'Permitter', + version: '1', + chainId: 1, + verifyingContract: permitterAddress +}; + +const types = { + Permit: [ + { name: 'bidder', type: 'address' }, + { name: 'maxBidAmount', type: 'uint256' }, + { name: 'expiry', type: 'uint256' } + ] +}; + +const permit = { + bidder: userAddress, + maxBidAmount: parseEther('1000'), + expiry: Math.floor(Date.now() / 1000) + 86400 // 24 hours +}; + +const signature = await signer._signTypedData(domain, types, permit); +``` -### Slither +### Placing a Bid -In [`ci.yml`](.github/workflows/ci.yml), you'll notice Slither is configured as follows: +```typescript +const permitData = ethers.utils.defaultAbiCoder.encode( + ['tuple(address,uint256,uint256)', 'bytes'], + [[permit.bidder, permit.maxBidAmount, permit.expiry], signature] +); -```yml -slither-args: --filter-paths "./lib|./test" --exclude naming-convention,solc-version +await ccaContract.placeBid(bidAmount, permitData); ``` -This means Slither is not run on the `lib` or `test` folders, and the [`naming-convention`](https://github.com/crytic/slither/wiki/Detector-Documentation#conformance-to-solidity-naming-conventions) and [solc-version](https://github.com/crytic/slither/wiki/Detector-Documentation#incorrect-versions-of-solidity) checks are disabled. +## Development -This `slither-args` field is where you can change the Slither configuration for your project, and the defaults above can of course be changed. +Built with [Foundry](https://github.com/foundry-rs/foundry). -Notice that Slither will run against `script/` by default. -Carefully written and tested scripts are key to ensuring complex deployment and scripting pipelines execute as planned, but you are free to disable Slither checks on the scripts folder if it feels like overkill for your use case. +### Build -For more information on configuration Slither, see [the documentation](https://github.com/crytic/slither/wiki/Usage). For more information on configuring the slither action, see the [slither-action](https://github.com/crytic/slither-action) repo. +```bash +forge build +``` -### GitHub Code Scanning +### Test -As mentioned, the Slither CI step is integrated with GitHub's [code scanning](https://docs.github.com/en/code-security/code-scanning) feature. -This means when your jobs execute, you'll see two related checks: +```bash +forge test +``` -1. `CI / slither-analyze` -2. `Code scanning results / Slither` +### Format -The first check is the actual Slither analysis. -You'll notice in the [`ci.yml`](.github/workflows/ci.yml) file that this check has a configuration of `fail-on: none`. -This means this step will _never_ fail CI, no matter how many findings there are or what their severity is. -Instead, this check outputs the findings to a SARIF file[^sarif] to be used in the next check. +```bash +forge fmt +``` -The second check is the GitHub code scanning check. -The `slither-analyze` job uploads the SARIF report to GitHub, which is then analyzed by GitHub's code scanning feature in this step. -This is the check that will fail CI if there are Slither findings. +## Security -By default when you create a repository, only alerts with the severity level of `Error` will cause a pull request check failure, and checks will succeed with alerts of lower severities. -However, you can [configure](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#defining-the-severities-causing-pull-request-check-failure) which level of slither results cause PR check failures. +### Trust Model +- **Trusted Signer**: Issues permits only to KYC-approved users +- **Owner**: Can pause, update caps, rotate signer (cannot bypass signature verification) +- **Cryptographic Enforcement**: EIP-712 signatures prevent forgery -It's recommended to conservatively set the failure level to `Any` to start, and to reduce the failure level if you are unable to sufficiently tune Slither or find it to be too noisy. +### Replay Protection +- Domain separator includes `chainId` (prevents cross-chain replay) +- Domain separator includes `verifyingContract` (prevents cross-auction replay) -Findings are shown directly on the PR, as well as in your repo's "Security" tab, under the "Code scanning" section. -Alerts that are dismissed are remembered by GitHub, and will not be shown again on future PRs. +### Key Rotation +If the signing key is compromised: +1. Owner calls `updateTrustedSigner(newAddress)` +2. All old signatures become invalid immediately +3. Users must request new permits -Note that code scanning integration [only works](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository) for public repos, or private repos with GitHub Enterprise Cloud and a license for GitHub Advanced Security. -If you have a private repo and don't want to purchase a license, the best option is probably to: +## Disclaimer -- Remove the `Upload SARIF file` step from CI. -- Change the `Run Slither` step to `fail-on` whichever level you like, and remove the `sarif` output. -- Use [triage mode](https://github.com/crytic/slither/wiki/Usage#triage-mode) locally and commit the resulting `slither.db.json` file, and make sure CI has access to that file. +**This code has not been audited.** Use at your own risk. A comprehensive security audit is recommended before any production deployment. -[^naming-convention]: - A rigorous test naming convention is important for ensuring that tests are easy to understand and maintain, while also making filtering much easier. - For example, one benefit is filtering out all reverting tests when generating gas reports. +## License -[^script-abi]: Limiting scripts to a single public method makes it easier to understand a script's purpose, and facilitates composability of simple, atomic scripts. -[^sarif]: - [SARIF](https://sarifweb.azurewebsites.net/) (Static Analysis Results Interchange Format) is an industry standard for static analysis results. - You can read learn more about SARIF [here](https://github.com/microsoft/sarif-tutorials) and read about GitHub's SARIF support [here](https://docs.github.com/en/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning). +MIT