https://github.com/tensor-programming/stronghold-client
https://github.com/tensor-programming/stronghold-client
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tensor-programming/stronghold-client
- Owner: tensor-programming
- License: apache-2.0
- Created: 2020-10-13T17:55:32.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-11-13T02:30:25.000Z (about 5 years ago)
- Last Synced: 2024-12-16T19:04:02.151Z (about 1 year ago)
- Language: Rust
- Size: 2.28 MB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# engine
Engine is the collection of low-level crates with which application architects can build higher-level implementations of Strongholds for a variety of purposes. It is platform agnostic, in that it should run anywhere a Rust Compiler will work.
It is composed of 5 primary crates:
- primitives
- crypto
- random
- vault
- snapshot
## WARNING
This library has not yet been audited for security, so use at your own peril. Until a formal third-party security audit has taken place, the IOTA Foundation makes no guarantees to the fitness of this library for any purposes.
## Example
We have an example in the `examples/commandline` folder that you can use as a reference when developing applications with Engine.
## Running tests
You can run all tests by doing the following from the `engine` directory:
```
cargo test --all
```
## Running fuzzers
Engine comes with a two internal fuzzing systems, please see `/vault/fuzz` and `/crypto/fuzz`.
## Supporting the project
If this library has been useful to you and you feel like contributing, please see our contribution guidelines for all the ways in which you can contribute.
## API reference
To generate the API reference and display it in a web browser, do the following:
```
cargo doc --workspace --no-deps --open
```
## Joining the discussion
If you want to get involved in discussions about this technology, or you're looking for support, go to the #stronghold-discussion channel on [Discord](https://discord.iota.org/).