- Total Prize Pool: $100,000 in USDC
- HM awards: $80,700 in USDC
- QA awards: $3,300 in USDC
- Judge awards: $9,500 in USDC
- Validator awards: $6,000 in USDC
- Scout awards: $500 in USDC
- Read our guidelines for more details
- Starts December 6, 2024 20:00 UTC
- Ends January 3, 2025 20:00 UTC
This repository is provided for code audit purposes only and may not include audit remediations or other updates. This code should not be used in any capacity. For the official version, please refer to https://github.com/smartcontractkit.
IMPORTANT NOTES:
- KYC requirement: All participants who are eligible to receive awards will be required to become Certified Contributors (successfully complete KYC). When awards are announced, Code4rena staff will provide award-eligible participants with instructions, which must be successfully completed within 30 days of the award announcement date. This applies to all audit participants including wardens, teams, bot crews, judges, lookouts, and scouts.
- Risk level upgrades/downgrades: Two notes about judging phase risk adjustments:
- High- or Medium-risk submissions downgraded to Low-risk (QA)) will be ineligible for awards.
- Upgrading a Low-risk finding from a QA report to a Medium- or High-risk finding is not supported.
As such, wardens are encouraged to select the appropriate risk level carefully during the submission phase.
- Please note that the findings and audit report will remain private to the sponsor team only.
- Uniswap swapping strategy: we acknowledge that the current swapping strategy is not the most efficient one (e.g. we could improve it with smart order routing). The current option to use fixed path swaps instead of smart order routing / DEX Aggregation was an intentional design choice to limit the swap strategies to a permissionless DEX option with minimal off-chain requirements.
- MEV that results in increased slippage: we acknowledge that there is an inherent risk of the pools being MEV’ed in such a way that the swaps result in higher slippages than anticipated, which could lead to trade reverts. As long as the successful swaps are below our maximum tolerable slippage, MEV pushing to upper bound should not be considered a loss of funds. (e.g. for 0.5% slippage tolerances, it is tolerable to execute at 0.5% instead of 0.2% in the worst case scenario)
- Delays between checkUpkeep and performUpkeep execution: we acknowledge the risk, and will mitigate it by the deadline delay, max deviation and slippage parameters. The contract’s performUpkeep execution assumes that the inputs might be stale. No recomputation of checkUpkeep data in performUpkeep: the performUpkeep function performs some critical checks, such as the check against maxPriceDeviation to protect against swaps that result in significantly lower swap results. However, we chose not to perform less critical validations (e.g. USD value of an asset being swapped within min-max USD swap size bounds) to save on gas costs & reduce complexity.
- Malicious token processing: all tokens will be vetted before onboarding them to the system. Malicious tokens are not a concern. Due to all tokens being reviewed, upgradability / pausability / blocklists / balance modifications / fee token transfers are out of scope.
- Swapping optimization by utilising intermediate L2 routes: for the current iteration, swaps will only occur on one network.
- Gas optimizations for checkUpkeep: the function is executed off-chain, gas optimizations will not have significant improvements
- Maximum swap gas controls: maximum gas thresholds will be controlled via Chainlink Automation’s max gas threshold functionality
- Re-entrancy in the Reserves contract: the withdraw functionality in the Reserves contract will only allow withdrawing to allowlisted providers, and will use the LINK token, so there are no concerns for re-entrancy due to trust assumptions.
- Negative balances for earmarks: In rare circumstances, service providers may have negative balances in the Reserves contract, for scenarios when earmarks need to be retroactively adjusted. We acknowledge the risk of delisting a service provider with negative balances, where we may not resolve the negative LINK balance.
- Swaps might not be executed due to spread between feed prices & Uniswap prices: we acknowledge that some swaps might revert due to the differences between Chainlink Data Feed and Uniswap pool prices. This decision was made by design to execute trades against Chainlink Data Feed prices as the source of truth.
- Exploits of dependencies: malicious exploits on dependent protocols that are outside of the control of the system, e.g., an exploit in a Uniswap V3 liquidity pool contract.
- In-depth validations for swap params: asset swap path & the oracle being a correct Chainlink Data Feed address is validated off-chain
The 4naly3er report can be found here.
Note for C4 wardens: Anything included in this Automated Findings / Publicly Known Issues section is considered a publicly known issue and is ineligible for awards.
Payment Abstraction is a system of onchain smart contracts that aim to reduce payment friction for Chainlink services. The system is designed to (1) accept fees in various tokens across multiple blockchain networks, (2) consolidate fee tokens onto a single blockchain network via Chainlink CCIP, (3) convert fee tokens into LINK via Chainlink Automation, Price Feeds, and existing Automated Market Maker (AMM) Decentralized Exchange (DEX) contracts, and (4) pass converted LINK into a dedicated contract for withdrawal by Chainlink Network service providers.
- Previous audits: none
- Documentation: see the following document
- Website: https://chain.link/
- X/Twitter: https://twitter.com/chainlink
See scope.txt
| File | code |
|---|---|
| src/SwapAutomator.sol | 411 |
| src/FeeAggregator.sol | 258 |
| src/Reserves.sol | 142 |
| src/FeeRouter.sol | 113 |
| src/libraries/EnumerableBytesSet.sol | 76 |
| src/PausableWithAccessControl.sol | 59 |
| src/EmergencyWithdrawer.sol | 55 |
| src/NativeTokenReceiver.sol | 41 |
| src/LinkReceiver.sol | 24 |
| src/libraries/Errors.sol | 15 |
| src/libraries/Roles.sol | 10 |
| src/interfaces/IFeeAggregator.sol | 8 |
| src/interfaces/IPausable.sol | 5 |
| Total | 1217 |
See out_of_scope.txt
| Question | Answer |
|---|---|
| ERC20 used by the protocol | Any, including ERC-677 (LINK). See ERC20 token behaviour table. |
| Test coverage | 100.00% |
| ERC721 used by the protocol | None |
| ERC777 used by the protocol | None |
| ERC1155 used by the protocol | None |
| Chains the protocol will be deployed on | Ethereum,Arbitrum,Avax,Base,BSC,Optimism,Polygon,OtherAny EVM chain, including L2s. The contestants should not consider zkEVM chains and other EVM-like chains (such as TRX). |
| Question | Answer |
|---|---|
| Missing return values | In scope |
| Fee on transfer | Out of scope |
| Balance changes outside of transfers | Out of scope |
| Upgradeability | Out of scope |
| Flash minting | In scope |
| Pausability | Out of scope |
| Approval race protections | In scope |
| Revert on approval to zero address | In scope |
| Revert on zero value approvals | In scope |
| Revert on zero value transfers | In scope |
| Revert on transfer to the zero address | In scope |
| Revert on large approvals and/or transfers | In scope |
| Doesn't revert on failure | In scope |
| Multiple token addresses | Out of scope |
| Low decimals ( < 6) | In scope |
| High decimals ( > 18) | In scope |
| Blocklists | Out of scope |
| Question | Answer |
|---|---|
| Enabling/disabling fees (e.g. Blur disables/enables fees) | Yes |
| Pausability (e.g. Uniswap pool gets paused) | Yes |
| Upgradeability (e.g. Uniswap gets upgraded) | Yes |
- EIP-20: All tokens used within the contracts should implement the ERC20 standard, and expose a working decimals() function. (Accepted tokens will be pre-reviewed)
- EIP-165: All contracts should adhere to ERC-165. supportsInterface functionality should only be added for interfaces where on-chain interactions are expected, as opposed to every interface.
- EIP-677: Contracts which can receive LINK from other contracts (via a token push model) should support receiving LINK via transferAndCall. The contracts should ignore the data.
- SwapAutomator: Swaps are only executed when outputAmountInUSDValue >= inputAmountInUSDValue * (1 - maxDeviation), where the USD value is determined from the Chainlink Data Feeds. Swaps that do not meet this criteria are reverted.
- Reserves: service providers can never withdraw more LINK than they are owed. It should not be possible to withdraw more LINK from the contract than the sum of the service provider linkAmountOwed, with the exception of the emergencyWithdraw functionality.
- Reserves: the total amount owed must equal to the sum of all positive earmark owedLinkAmounts
- Draining of funds
- Indefinite fund locking within contracts with no way to emergency withdraw
- Unauthorized withdrawals
- Invariant breaks (e.g. withdrawing more funds than is owed in the Reserves contract, or withdrawing when non-allowlisted)
- Exploits that can happen between contract interactions (e.g. re-entrancy attacks)
- Realistic system DoS attacks with limited capital (e.g. by depositing tokens, or initiating permissionless withdraws)
- Malicious MEV / pool manipulation that would bypass slippage controls & parameters
- UNPAUSER_ROLE, ASSET_MANAGER_ROLE, DEFAULT_ADMIN_ROLE, WITHDRAWER_ROLE, EARMARK_MANAGER_ROLE, SWAPPER_ROLE - highest trust (multi-sig / contract)
- BRIDGER_ROLE, PAUSER_ROLE, forwarder (s_forwarder) - high trust, but less trust assumptions. If the role goes malicious, the contracts should not break in a highly critical way (with the exception of temporary DoS / pausing)
See more details about the roles in the documentation pdf.
| Role | Description |
|---|---|
| DEFAULT_ADMIN | Owner of the contracts. Manages roles, configurations, and can emergency withdraw assets. |
| EARMARK_MANAGER_ROLE | Manages updating Earmarks and the amounts owed for each Service Provider as well as the allowlisted Service Provider list. |
| PAUSER_ROLE | Pauses the contract when an emergency is detected. |
| UNPAUSER_ROLE | Unpauses the contract when an emergency is resolved. This is separate from the PAUSER_ROLE to decouple the role. |
| BRIDGER_ROLE | Bridges allowlisted assets on the FeeAggregator contracts across chains. |
| SWAPPER_ROLE | Assigned to SwapAutomator contracts, this role allows for pulling allowlisted assets from FeeAggregator contracts to swap. |
| WITHDRAWER_ROLE | Withdraws non-allowlisted assets from the FeeAggregator contracts.. |
| ASSET_ADMIN_ROLE | Manages the list of allowlisted assets on the FeeAggregator contracts. Manages the swap parameters on the SwapAutomator contracts |
The contracts do not present any unique or novel mathematical models. However, the slippage calculation methodology is worthwhile to understand, and is explained below. For each asset:
- Determine the balance within the contract assetBalance
- Convert the balance to the USD value using Data Feed value assetPrice :
availableAssetUsdValue = assetBalance * assetPriceUsd - Retrieve the decimals of the asset assetDecimals , and compute the asset unit:
assetUnit = 10 ** assetDecimals - Retrieve the minSwapSizeUsd parameter for the asset. If
availableAssetUsdValue < minSwapSize * assetUnit, skip the asset for swapping - Cap the token value for swapping to the upper bound maxSwapSizeUsd parameter:
swapAmountIn = min(maxSwapSizeUsd * assetUnit, availableAssetUsdValue) / assetPrice - Using the USD price of LINK linkUSDPrice, convert the input asset value amount to the equivalent amount out in LINK (note: LINK_DECIMALS = 18):
a. When token has < decimals than LINK:
amountOutCLPriceFeedQuote = (swapAmountIn * assetPrice * 10 ** (LINK_DECIMALS - assetDecimals)) / linkUSDPrice; b. When token has >= decimals than LINK:(assetAmount * assetPrice) / linkUSDPrice / 10 ** (assetDecimals - LINK_DECIMALS); - Using the preconfigured Uniswap swap path path and the swapAmountIn, perform a Uniswap V3 trade simulation using quoteExactInput, and retrieve the output amountOutUniswapQuote
- Using the maxSlippage parameter configured for the asset, if
amountOutUniswapQuote < amountOutCLPriceFeedQuote * (1 - maxSlippage), skip the swap - Set
amountOutMinimum = max(amountOutCLPriceFeedQuote, amountOutUniswapQuote) * (1 - maxSlippage). This will be the input to exactInput on the actual swap execution - After the swap with actualAmountOut, and using the maxDeviation parameter
a. amountInConvertedToLINKUsdValue - following same steps as 6) with the amountIn input for exactInput
b. Revert the trade if the following condition is not met:
actualAmountOut >= amountInConvertedToLINKUsdValue * (1 - maxDeviation)
Prerequisites:
- Setup pnpm: https://pnpm.io/installation
- Setup foundry: https://book.getfoundry.sh/getting-started/installation
- For coverage install
lcov(see https://stackoverflow.com/a/77967141)
git clone https://github.com/code-423n4/2024-12-chainlink.git
cd 2024-12-chainlink
cp .env.example .env
# then set MAINNET_RPC_URL to a valid rpc url
pnpm foundry
pnpm install
forge build
pnpm test
# To get coverage run
pnpm test:coverage| File | % Lines | % Statements | % Branches | % Funcs |
|---|---|---|---|---|
| src/EmergencyWithdrawer.sol | 100.00% (22/22) | 100.00% (27/27) | 100.00% (7/7) | 100.00% (6/6) |
| src/FeeAggregator.sol | 100.00% (92/92) | 100.00% (125/125) | 100.00% (18/18) | 100.00% (16/16) |
| src/FeeRouter.sol | 100.00% (42/42) | 100.00% (48/48) | 100.00% (7/7) | 100.00% (8/8) |
| src/LinkReceiver.sol | 100.00% (6/6) | 100.00% (7/7) | 100.00% (2/2) | 100.00% (3/3) |
| src/NativeTokenReceiver.sol | 100.00% (10/10) | 100.00% (10/10) | 100.00% (3/3) | 100.00% (4/4) |
| src/PausableWithAccessControl.sol | 100.00% (14/14) | 100.00% (20/20) | 100.00% (2/2) | 100.00% (9/9) |
| src/Reserves.sol | 100.00% (47/47) | 100.00% (66/66) | 100.00% (12/12) | 100.00% (9/9) |
| src/SwapAutomator.sol | 100.00% (158/158) | 100.00% (221/221) | 100.00% (36/36) | 100.00% (26/26) |
| src/libraries/EnumerableBytesSet.sol | 100.00% (30/30) | 100.00% (39/39) | 100.00% (5/5) | 100.00% (12/12) |
Employees of Chainlink and employees' family members are ineligible to participate in this audit.
Code4rena's rules cannot be overridden by the contents of this README. In case of doubt, please check with C4 staff.