Skip to main content

Getting Started with Rust

Requirements​

  • Rust (latest)
  • Cargo (latest)
  • for running example: a local network node with the IOTA Notarization package deployed as described here

Include the Library​

To include IOTA Notarization in your project, add it as a dependency in your Cargo.toml:

[dependencies]
notarization = { git = "https://github.com/iotaledger/notarization", tag = "v0.1"}

Examples​

To try out the examples, you should:

  1. Clone the repository:
git clone https://github.com/iotaledger/notarization
  1. Build the repository:
cargo build
  1. Run your first example:
cargo run --example 01_create_locked_notarization

API Reference​

You can find the API reference for the Rust library here.

If you would like to build the documentation, locally you can do so with the following command:

RUSTDOCFLAGS='--cfg docsrs' cargo +nightly doc -p notarization --all-features --no-deps --open