Skip to content

Commit 6ec8bc8

Browse files
committed
shore(local_testnet): Update README
1 parent 11992eb commit 6ec8bc8

File tree

1 file changed

+4
-27
lines changed

1 file changed

+4
-27
lines changed

contrib/README.md

Lines changed: 4 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Including how to build and deploy the required containers, and how to use hot-re
55

66
### Note
77

8-
The current implementation leverages local-network for the common services and uses its testing configuration. We're specifically using an older [commit](https://github.com/edgeandnode/local-network/commit/ae72f1b8d57f18e7055a7fa29b873fe5bb8d9879) due to permissions issues with more recent versions, which fail when cloning the repository because of private git dependencies.
8+
The current implementation leverages local-network for the common services and uses its testing configuration.
99

1010
## Available Commands
1111

@@ -15,7 +15,7 @@ We provide the following Make/Just commands to streamline your development workf
1515
- `make reload` - Rebuild Rust binaries and restart services after code changes
1616
- `make logs` - Watch log output from all services
1717
- `make down` - Stop all services
18-
- `make test-local` - Run integration tests against local services(Work in progress)
18+
- `make rav_tests` - Run integration tests against local services
1919

2020
## Initial Setup
2121

@@ -33,7 +33,7 @@ This will:
3333
- Clone the local-network repo if needed
3434
- Start core infrastructure services
3535
- Deploy contracts and required services
36-
- Set up and start the indexer services
36+
- Set up and start the indexer and tap-agent services
3737

3838
## Development Workflow
3939

@@ -80,7 +80,7 @@ This will show a live stream of logs from all services, which is useful for debu
8080
To run integration tests against your local environment:
8181

8282
```bash
83-
make test-local
83+
make rav_tests
8484
```
8585

8686
This is currently a work in progress, and additional testing strategies are still being defined and implemented.
@@ -94,26 +94,3 @@ make down
9494
```
9595

9696
This will stop and remove all the containers defined in the docker-compose file.
97-
98-
## Testing Improvements
99-
100-
The current testing setup has some limitations that could be addressed in the future:
101-
102-
### Current Limitations
103-
104-
- Bash script for testing (`run-test-local.sh`) are not optimal
105-
- Limited test coverage of complex edge cases
106-
- Manual verification required for some functionality
107-
108-
## Complete End-to-End Environment
109-
110-
Note that the current test environment is a simplified version intended to emulate real-world operation. For a complete end-to-end testing environment, additional services are required but not currently deployed:
111-
112-
- `tap-escrow-manager` - Manages escrow accounts for payment channels
113-
- `subgraph-deploy` - Handles deployment of subgraphs for testing
114-
115-
These services are commented out in the setup script for simplicity but would be needed in a full production environment or complete integration testing setup.
116-
117-
### Note
118-
119-
It would be worth to keep updating local-network dependency and try to conciliate future permissions errors

0 commit comments

Comments
 (0)