Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document how to test #154

Merged
merged 3 commits into from
May 13, 2024
Merged

Document how to test #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a43f656
chore: add tmp/ to gitignore
joaothallis May 4, 2024
d908c9b
docs: fix typo
joaothallis May 4, 2024
8a00670
docs: how to test
joaothallis May 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ config.toml
/builds
data/
output.log
tmp/
2 changes: 1 addition & 1 deletion crates/floresta/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
//! handle the peer-to-peer protocol. It is not a full node, it doesn't store the blockchain
//! or validate data, it just sends and receives messages.
//!
//! Floresta also provides a simple watch-only wallet an an electrum server implementation.
//! Floresta also provides a simple watch-only wallet and an electrum server implementation.
Davidson-Souza marked this conversation as resolved.
Show resolved Hide resolved
//! They are meant to be used in `florestad`, a full node implementation that uses all the
//! crates in this project.
//!
Expand Down
14 changes: 14 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,25 @@ cargo run --release -- -c config.toml --network signet run
```

### Running the tests

#### Requirements

```bash
cargo build
```

There's a set of unit tests that you can run with
```bash
cargo test
```

There's also a set of functional tests that you can run with

```bash
pip3 install -r tests/requirements.txt
python tests/run_tests.py
```

### Contributing
Contributions are welcome, feel free to open an issue or a pull request. There's not really a set of guidelines for contributing other than the code compiling and the tests passing. If you want to contribute but don't know where to start, take a look at the issues, there's a few of them marked as `good first issue`.

Expand Down
Loading