From 1530d709df57d02fa5db33f63d9e5ea3018f9344 Mon Sep 17 00:00:00 2001 From: Alexander Date: Wed, 20 Dec 2023 14:39:48 +0100 Subject: [PATCH] readme: update coverage information --- evm/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/evm/README.md b/evm/README.md index 1f052f4d..e02ea813 100644 --- a/evm/README.md +++ b/evm/README.md @@ -120,7 +120,7 @@ Compiling the tests takes a significant amount of time but running the tests the ## Coverage -Coverage currently doesn't work. It is unclear if this is an issue with Foundry or Solidity. The repository uses the Soldiity pipeline `--via-ir` to circumvent the *stack too deep* issue. The result is that when Foundry tries to re-compile the contracts without any optimisations it fails. +The repository uses the Soldiity pipeline `--via-ir` to circumvent the *stack too deep* issue. The result is that when Foundry tries to re-compile the contracts without any optimisations it fails. The forge argument `-ir-minimum` has to be used to compile the contracts using the `ir` representation. Note that this changes the mapping of source code to compiled code and some sections can be incorrectled marked as uncovered or covered. @@ -128,8 +128,6 @@ The forge argument `-ir-minimum` has to be used to compile the contracts using t forge coverage --ir-minimum ``` -Currently, this doesn't work. - # Deploying Catalyst This repository contains a helper script for deployment `script/DeployCatalyst.s.sol` which is based on `script/DeployContracts.s.sol` which is the origin for most of the testing configuration. This deploys core swap contracts but not the cross-chain interface. This is instead done by `script/DeployInterfaces.s.sol` which also handles management/deployment of the dependency on [Generalised Incentives](https://github.com/catalystdao/GeneralisedIncentives).