Skip to content

Commit 99f136d

Browse files
committed
chore: update testing instructions
1 parent 7ddf8d1 commit 99f136d

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -56,25 +56,27 @@ $ yarn run start
5656
$ yarn run start:dev
5757
```
5858

59-
### Testing with postgresql dump
59+
### Testing
6060

61-
Download the database instances from the following links and move them to `/e2e_tests/db/`:
61+
End-to-end tests for blockchain verifier types require indexer database access.
6262

63-
- [BTC Testnet Database](https://githubstatic.flare.center/db_btc_testnet) as `db_btc_testnet`
64-
- [BTC2 Testnet Database](https://githubstatic.flare.center/db_btc2_testnet) as `db_btc2_testnet`
65-
- [DOGE Testnet Database](https://githubstatic.flare.center/db_doge_testnet) as `db_doge_testnet`
66-
- [XRP Testnet Database](https://githubstatic.flare.center/db_xrp_testnet) as `db_xrp_testnet`
67-
- [XRP2 Testnet Database](https://githubstatic.flare.center/db_xrp2_testnet) as `db_xrp2_testnet`
68-
69-
or simply run:
63+
To download database snapshots, run:
7064

7165
```bash
7266
yarn test download
7367
```
7468

75-
Currently, all databases are from testnets.
76-
77-
#### Option 1: Running Tests Against a Database Instance
69+
> **Manual download (alternative)**
70+
>
71+
> You can also download the database snapshots manually and move them to `/e2e_tests/db/`:
72+
>
73+
> - [BTC Testnet Database](https://githubstatic.flare.center/db_btc_testnet) as `db_btc_testnet`
74+
> - [BTC2 Testnet Database](https://githubstatic.flare.center/db_btc2_testnet) as `db_btc2_testnet`
75+
> - [DOGE Testnet Database](https://githubstatic.flare.center/db_doge_testnet) as `db_doge_testnet`
76+
> - [XRP Testnet Database](https://githubstatic.flare.center/db_xrp_testnet) as `db_xrp_testnet`
77+
> - [XRP2 Testnet Database](https://githubstatic.flare.center/db_xrp2_testnet) as `db_xrp2_testnet`
78+
>
79+
> Currently, all snapshots are from testnets.
7880
7981
To run all tests across all sources or check code coverage, use the following commands:
8082

@@ -83,14 +85,16 @@ yarn test run
8385
yarn test coverage
8486
```
8587

86-
#### Option 2: Spinning Up a Database from a Dump and Persisting It
88+
#### Manual testing
8789

88-
Depending on your source, create a database instance using the following command:
90+
To test a specific verifier type you can also instantiate only the relevant indexer db. For example, for `btc` verifier type:
8991

9092
```bash
9193
yarn test make_db btc
9294
```
9395

96+
This will create and start a local Postgres database server with the Bitcoin testnet snapshot.
97+
9498
Once the database is up and running, you can start a local server and manually send requests. For this setup, set the
9599
following environment variables to your `.env` file:
96100

0 commit comments

Comments
 (0)