Skip to content

Commit

Permalink
dev: readme (#1125)
Browse files Browse the repository at this point in the history
details about testing in Readme
  • Loading branch information
greged93 authored May 28, 2024
1 parent 1cdc7f4 commit a7e9dde
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 6 deletions.
4 changes: 2 additions & 2 deletions .trunk/trunk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ lint:
- [email protected]
- git-diff-check
- [email protected]
- markdownlint@0.40.0
- markdownlint@0.41.0
- [email protected]
- [email protected]
- [email protected]
Expand All @@ -30,7 +30,7 @@ lint:
- [email protected]
- [email protected]
- [email protected]
- [email protected].2
- [email protected].4
- [email protected]
- [email protected]
ignore:
Expand Down
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,13 +102,15 @@ TL;DR:
- [Rust](https://www.rust-lang.org/tools/install)
- [Docker](https://docs.docker.com/engine/install)
- [Python](https://www.python.org/)
- [Deno](https://docs.deno.com/runtime/manual/)
- Make

## Installation

### Setup the project

To set up the repository (pulling git submodule and building Cairo dependencies), run:
To set up the repository (pulling git submodule and building Cairo dependencies),
run:

```console
make setup
Expand Down Expand Up @@ -234,6 +236,22 @@ You can take a look at `rpc-call-examples` directory. Please note the following:

## Testing

### Rust tests

In order to execute the Rust tests, follow the below instructions:

- Run `make setup` in order to setup the project.
- Run `make test` which will create a Genesis test file for Kakarot
and launch tests.
- If you which to only run a specific test, be sure to first at least
run `make katana-genesis` once, then run `make test-target TARGET=test_you_want_to_run`.

### Apibara indexer tests

In order to run the Typescript unit tests, you will need to have [Deno](https://docs.deno.com/runtime/manual/)
installed. Then you can run `KAKAROT_ADDRESS=ADDRESS_YOU_WANT_TO_USE_FOR_KAKAROT
deno test --allow-env`.

### Hive

The [Hive](https://github.com/ethereum/hive/tree/master) end-to-end test suite
Expand Down Expand Up @@ -469,5 +487,3 @@ Thanks goes to these wonderful people
This project follows the
[all-contributors](https://github.com/all-contributors/all-contributors)
specification. Contributions of any kind welcome!


0 comments on commit a7e9dde

Please sign in to comment.