Foundry с 0. Часть 28

После того, как мы получили первое представление об инвариант тестах, пора переходить к более реальным примерам. И сейчас мы подготовим новый WETH контракт для этого.

Если не хотите сами искать его, то можете просто скопировать и сохранить к себе в папку обучения следующий контракт:

https://github.com/t4sk/hello-foundry/blob/main/src/WETH.sol

и, при написании тестов для него, не забудьте импортировать:

import {WETH} from "../../src/WETH.sol";

Теперь напишем простой контракт:

contract WETH_Open_Invariant_Tests is Test {
    WETH public weth;

    function setUp() public {
        weth = new WETH();
    }

    receive() external payable {}

    function invariant_totalSupply_is_always_zero() public {
        assertEq(0, weth.totalSupply());
    }
}

Мы уже знаем, что следует писать invariant в названии функции, и что assertEq выполняет проверку общего количества токенов, которое должно быть равно 0.

Foundry будет в случайном порядке вызывать функции из контракта WETH и сравнивать баланс.

Если мы запустим тест, то увидим, что он прошел успешно! Обратите внимание на саму запись в консоли, которая выглядит так:

[PASS] invariant_totalSupply_is_always_zero() (runs: 256, calls: 3840, reverts: 2187)

Т.е. тест был выполнен 256 раз, в которых было вызвано 3840 функций, и получено 2187 откатов. Что за откаты / реверты?

Если посмотреть на контракт WETH, то можно увидеть такие функции, как deposit, transfer, withdraw и другие, в которых есть определенные условия для исполнения. Например, для трансфера у нас на счету должно быть некоторое количество токенов, а их у нас нет. Поэтому произошел реверт. И так 2187 раз.

Сам инвариант тест завершился успешно, так как, не смотря на откаты, totalSupply() у нас оставался равен 0 все это время.

Тем не менее, даже при успешном выполнении теста, он не будет считаться корректным, потому, что получилось достаточно большое количество ревертов и вызывались функции, которые не играют роли.

Мы пойдем дальше и ограничим рамки инвариант теста с помощью дополнительного контракта. Но об этом уже в следующем посте.

#foundry #lesson28