From f0c7a17e8911915f898df7d424c56b7bc7537220 Mon Sep 17 00:00:00 2001 From: r4bbit <445106+0x-r4bbit@users.noreply.github.com> Date: Wed, 24 Jul 2024 12:07:15 +0200 Subject: [PATCH] docs: add missing docs for certora-cli --- Readme.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/Readme.md b/Readme.md index c9c052b4..c44bde4f 100644 --- a/Readme.md +++ b/Readme.md @@ -22,12 +22,26 @@ To start a local Ethereum node with the contracts deployed, execute: npm start -You can run Certora's specs with: +This will create a `deployment-localhost.json` file containing the addresses of +the deployed contracts. + + +Running the prover +------------------ + +To run the formal verification rules using certora, first make sure to install +the certora cli + +``` +$ pip install certora-cli +``` + +Once that is done the `certoraRun` command can be used to send CVL specs to the prover. + +You can run Certora's specs with the provided `npm` script: npm run verify -This will create a `deployment-localhost.json` file containing the addresses of -the deployed contracts. Overview --------