Skip to content

Commit

Permalink
docs: fix readme test docs, and add test comments to makefile (#225)
Browse files Browse the repository at this point in the history
* docs: fix readme test documentation, and add comments describing tests to makefile

Signed-off-by: litt3 <[email protected]>

* Add missed period

Signed-off-by: litt3 <[email protected]>

* Add additional explanation of e2e tests

Signed-off-by: litt3 <[email protected]>

---------

Signed-off-by: litt3 <[email protected]>
  • Loading branch information
litt3 authored Jan 8, 2025
1 parent b8a625f commit 0fb5ae8
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,19 @@ disperse-test-blob:
clean:
rm bin/eigenda-proxy

# Unit tests
test:
go test ./... -parallel 4

# E2E tests, leveraging op-e2e
e2e-test:
INTEGRATION=true go test -timeout 1m ./e2e -parallel 4

# E2E test which fuzzes the proxy client server integration and op client keccak256 with malformed inputs
e2e-fuzz-test:
$(E2EFUZZTEST)

# E2E tests against holesky testnet
holesky-test:
TESTNET=true go test -timeout 50m ./e2e -parallel 4

Expand Down
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,15 +213,18 @@ The `raw commitment` is an RLP-encoded [EigenDA certificate](https://github.com/
Unit tests can be ran via invoking `make test`.

### Integration
End-to-end (E2E) tests can be ran via `make e2e-test`.

### Holesky
End-to-end (E2E) tests can be ran via `make e2e-test`. These tests use the [op-e2e](https://github.com/ethereum-optimism/optimism/tree/develop/op-e2e) framework for asserting correct interaction behaviors with batch submission and state derivation.

A holesky integration test can be ran using `make holesky-test` to assert proper dispersal/retrieval against a public network. Please **note** that EigenDA Holesky network which is subject to rate-limiting and slow confirmation times *(i.e, >10 minutes per blob confirmation)*. Please advise EigenDA's [inabox](https://github.com/Layr-Labs/eigenda/tree/master/inabox#readme) if you'd like to spin-up a local DA network for faster iteration testing.
These tests also assert E2E client <-> server interactions using simple/op clients.

### E2E Fuzz

### Optimism
This E2E test will fuzz the proxy client server integration and op client keccak256 with malformed inputs. This is never meant to be fuzzed with EigenDA. Run with `make e2e-fuzz-test`.

An E2E test exists which spins up a local OP sequencer instance using the [op-e2e](https://github.com/ethereum-optimism/optimism/tree/develop/op-e2e) framework for asserting correct interaction behaviors with batch submission and state derivation. These tests can be ran via `make optimism-test`.
### Holesky

A holesky integration test can be ran using `make holesky-test` to assert proper dispersal/retrieval against a public network. Please **note** that EigenDA Holesky network which is subject to rate-limiting and slow confirmation times *(i.e, >10 minutes per blob confirmation)*. Please advise EigenDA's [inabox](https://github.com/Layr-Labs/eigenda/tree/master/inabox#readme) if you'd like to spin-up a local DA network for faster iteration testing.

## Metrics

Expand Down

0 comments on commit 0fb5ae8

Please sign in to comment.