Skip to content

iotaledger/notarization

banner

StackExchange Discord Dependencies Apache 2.0 license

IntroductionWhere To StartToolkit ComponentsDocumentation & ResourcesBindingsContributing


IOTA Notarization Toolkit

Introduction

This repository contains the IOTA Notarization Toolkit, a set of IOTA ledger tools for verifiable on-chain data workflows.

The toolkit includes:

  • Single Notarization Use this for individual locked or dynamic notarizations of arbitrary data, documents, hashes, or latest-state records.
  • Audit Trails Use this for structured record histories with sequential entries, role-based access control, locking, and tagging.

Each toolkit component is available as:

  • Move Package for the on-chain contracts
  • Rust Package for typed client access and transaction builders
  • TypeScript/JS Package using wasm bindings for the above-mentioned Rust package

Where To Start

I want a single notarized record

Use Single Notarization when your main need is proving the existence, integrity, or latest state of one notarized object on-chain.

I want an audit trail

Use Audit Trails when you need a structured record history with permissions, capabilities, tagging, and write or delete controls.

I want the on-chain contracts

I want to build an application

Toolkit Components

Component Best for Move Package Rust Package Wasm Package
Single Notarization Individual locked or dynamic notarizations for documents, hashes, and state notarization-move notarization-rs notarization_wasm
Audit Trails Shared sequential records with roles, capabilities, tagging, and locking audit-trail-move audit-trail-rs audit_trail_wasm

Which one should I use?

Need Best fit
Locked proof object for arbitrary data Single Notarization
Dynamic latest-state notarization flow Single Notarization
Shared sequential records with roles, capabilities, and record tag policy Audit Trails
Team or system audit log with governance and operational controls Audit Trails

Documentation And Resources

Single Notarization

Audit Trails

Shared

Bindings

Foreign Function Interface (FFI) bindings available in this repository:

Contributing

We would love to have you help us with the development of the IOTA Notarization Toolkit. Each and every contribution is greatly valued.

Please review the contribution sections in the IOTA Docs Portal.

To contribute directly to the repository, simply fork the project, push your changes to your fork and create a pull request to get them included.

The best place to get involved in discussions about these libraries or to look for support at is the #notarization channel on the IOTA Discord. You can also ask questions on our Stack Exchange.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors