# saito-rust

A high-performance implementation of Saito in Rust.

This project will serve as the reference implementation for other code-bases. It will also be a flexible implementation which can be easily extended to support various testnet implementations which we envision For example, we may use different epoch times or different sources of randomness for the Golden Ticket "Lottery Game" instead of sha256 difficult hashes(e.g. PoS or even 3rd party sources like BTC block hashes).

## Contributing

We're happy for any contribution.  
Please have a look at our [contributing guidelines](CONTRIBUTING.md) before you start.

## Documentation

- https://saitotech.github.io/saito-rust/saito_rust/index.html
- [Architecture doc](ARCHITECTURE.md)

### Deps

- (If on OSX: `xcode-select --install`)
- [Install Rust](https://www.rust-lang.org/tools/install)

### Run the node

```
RUST_LOG=debug cargo run
```

Possible log levels are Error, Warn, Info, Debug, Trace.

### Tests

```
scripts/test.sh
```

or

```
cargo test
```

### Code formatting

```
cargo fmt
```

Format code according to the [Rust style Guide](https://github.com/rust-dev-tools/fmt-rfcs/blob/master/guide/guide.md).

### Code linting

```
cargo clippy
```

[Clippy](https://github.com/rust-lang/rust-clippy) is a collection of lints to catch common mistakes and improve your Rust code.

### Benchmarks

```
cargo bench
```

### Github Actions

GH Actions are located here: [.github/workflows](.github/workflows)

- cargo docs  
  Is creating and deploying the docs to GH pages

- [rustfmt](https://github.com/rust-lang/rustfmt#checking-style-on-a-ci-server) (**required**)  
  Is checking if the code is formatted according to rust style guidelines

- cargo build & test  
  Tries to build the code and run all tests

- [Convco](https://convco.github.io/check/) commit format check (**required**)  
  Check all commits or range for errors against [the convention](CONTRIBUTING.md#commit-format)

- [Clippy](https://github.com/rust-lang/rust-clippy) code linting  
  A collection of lints to catch common mistakes and improve your Rust code

### VSCode

Extensions:

- https://github.com/rust-lang/vscode-rust

## Create release

```
cargo build --release
```

## Further steps

Publish certain rust functionalities (as bin) as a npm package

- https://blog.woubuc.be/post/publishing-rust-binary-on-npm
- https://github.com/EverlastingBugstopper/binary-install

## TODO
Casual list of suggestions on improvements:

[] routing hops currently contain two publickeys and one signature. we can remove "from" because it is contextually available (from the sender of the first transaction, and then the *to* field. We should also be able to reduce the signatures by switching to a different/commutive signature. This would magnificently remove the size of our transactions and shrink blocksize as well.