Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

<p align="center">
<a href="https://iota.stackexchange.com/" style="text-decoration:none;"><img src="https://img.shields.io/badge/StackExchange-9cf.svg?logo=stackexchange" alt="StackExchange"></a>
<a href="https://discord.iota.org/" style="text-decoration:none;"><img src="https://img.shields.io/badge/Discord-9cf.svg?logo=discord" alt="Discord"></a>
<a href="https://discord.gg/iota-builders" style="text-decoration:none;"><img src="https://img.shields.io/badge/Discord-9cf.svg?logo=discord" alt="Discord"></a>
<img src="https://deps.rs/repo/github/iotaledger/notarization/status.svg" alt="Dependencies">
<a href="https://github.com/iotaledger/notarization/blob/develop/LICENSE" style="text-decoration:none;"><img src="https://img.shields.io/github/license/iotaledger/notarization.svg" alt="Apache 2.0 license"></a>
</p>

Expand All @@ -28,26 +29,26 @@ IOTA Notarization is composed of two primary components:

## Documentation and Resources

- [Notarization Documentation Pages](https://docs.iota.org/iota-notarization): Supplementing documentation with context around notarization and simple examples on library usage.
- [Notarization Documentation Pages](https://docs.iota.org/developer/iota-notarization): Supplementing documentation with context around notarization and simple examples on library usage.
- API References:
- [Rust API Reference](https://iotaledger.github.io/notarization/notarization/index.html): Package documentation (cargo docs).
- [Wasm API Reference](https://docs.iota.org/references/iota-notarization/wasm/api_ref): Wasm Package documentation.
<!-- - [Wasm API Reference](https://docs.iota.org/references/iota-notarization/wasm/api_ref): Wasm Package documentation. -->
- Examples:
- [Rust Examples](https://github.com/iotaledger/notarization/tree/develop/examples): Practical code snippets to get you started with the library in Rust.
- [Wasm Examples](https://github.com/iotaledger/notarization/tree/develop/bindings/wasm/notarization_wasm/examples): Practical code snippets to get you started with the library in TypeScript/JavaScript.
- [Rust Examples](https://github.com/iotaledger/notarization/tree/main/examples/README.md): Practical code snippets to get you started with the library in Rust.
- [Wasm Examples](https://github.com/iotaledger/notarization/tree/main/bindings/wasm/notarization_wasm/examples/README.md): Practical code snippets to get you started with the library in TypeScript/JavaScript.

## Bindings

[Foreign Function Interface (FFI)](https://en.wikipedia.org/wiki/Foreign_function_interface) Bindings of this [Rust](https://www.rust-lang.org/) library to other programming languages:

- [Web Assembly](https://github.com/iotaledger/notarization/tree/develop/bindings/wasm/notarization_wasm/) (JavaScript/TypeScript)
- [Web Assembly](https://github.com/iotaledger/notarization/tree/main/bindings/wasm/notarization_wasm) (JavaScript/TypeScript)

## Contributing

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

Please review the [contribution](https://docs.iota.org/iota-notarization/contribute) sections in the [IOTA Docs Portal](https://docs.iota.org/iota-notarization).
Please review the [contribution](https://docs.iota.org/developer/iota-notarization/contribute) sections in the [IOTA Docs Portal](https://docs.iota.org/developer/iota-notarization/).

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 this library or to look for support at is the `#notarization` channel on the [IOTA Discord](https://discord.iota.org). You can also ask questions on our [Stack Exchange](https://iota.stackexchange.com/).
The best place to get involved in discussions about this library or to look for support at is the `#notarization` channel on the [IOTA Discord](https://discord.gg/iota-builders). You can also ask questions on our [Stack Exchange](https://iota.stackexchange.com/).
10 changes: 4 additions & 6 deletions bindings/wasm/notarization_wasm/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
# IOTA Notarization

<!--
## [Notarization Documentation Pages](https://docs.iota.org/iota-notarization)
## [Notarization Documentation Pages](https://docs.iota.org/developer/iota-notarization)

## [Getting started with the IOTA Notarization WASM Library.](https://docs.iota.org/iota-notarization/getting-started/wasm)
## [Getting started with the IOTA Notarization WASM Library.](https://docs.iota.org/developer/iota-notarization/getting-started/wasm)

## [API Reference](https://docs.iota.org/references/iota-notarization/wasm/api_ref)

## [Examples](https://github.com/iotaledger/notarization.rs/blob/wasm-v1.6.0-alpha/bindings/wasm/notarization_wasm/examples/README.md)
## [Examples](https://github.com/iotaledger/notarization/tree/v0.1/bindings/wasm/notarization_wasm/examples)
-->

## Install the Library
Expand Down Expand Up @@ -35,7 +33,7 @@ to [rustup.rs](https://rustup.rs) for the installation.
- [Rust](https://www.rust-lang.org/) (>= 1.65)
- [Cargo](https://doc.rust-lang.org/cargo/) (>= 1.65)
- for running example: a local network node with the IOTA notarization package deployed as being described
[here](https://docs.iota.org/iota-identity/getting-started/local-network-setup) for IOTA Identity
[here](https://docs.iota.org/developer/iota-notarization/getting-started/local-network-setup)

### 1. Install `wasm-bindgen-cli`

Expand Down
19 changes: 12 additions & 7 deletions bindings/wasm/notarization_wasm/examples/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![banner](https://github.com/iotaledger/notarization/raw/HEAD/.github/banner_notarization.svg)
![banner](https://github.com/iotaledger/notarization/raw/HEAD/.github/notarization.svg)

## IOTA Notarization Examples

Expand All @@ -14,7 +14,7 @@ Examples can be run against
- or an existing network, e.g. the IOTA testnet

When setting up the local node, you'll also need to publish a notarization package as described in
[Local Network Setup](https://docs.iota.org/iota-notarization/getting-started/local-network-setup) in the documentation portal.
[Local Network Setup](https://docs.iota.org/developer/iota-notarization/getting-started/local-network-setup) in the documentation portal.
You'll also need to provide an environment variable `IOTA_NOTARIZATION_PKG_ID` set to the package-id of your locally deployed
notarization package, to be able to run the examples against the local node.

Expand Down Expand Up @@ -62,11 +62,16 @@ IOTA_NOTARIZATION_PKG_ID=0x222741bbdff74b42df48a7b4733185e9b24becb8ccfbafe8eac86

The following examples are available:

| Name | Information |
| :-------------------------------------------- | :------------------------------------------------------- |
| [01_create_locked](src/01_create_locked.ts) | Demonstrates how to create a a new locked notarization. |
| [02_create_dynamic](src/02_create_dynamic.ts) | Demonstrates how to create a a new dynamic notarization. |
| [03_update_dynamic](src/03_update_dynamic.ts) | Demonstrates how to update a dynamic notarization. |
| Name | Information |
| :-------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------- |
| [01_create_locked](https://github.com/iotaledger/notarization/tree/main/bindings/wasm/notarization_wasm/examples/src/01_create_locked.ts) | Demonstrates how to create a a new locked notarization. |
| [02_create_dynamic](https://github.com/iotaledger/notarization/tree/main/bindings/wasm/notarization_wasm/examples/src/02_create_dynamic.ts) | Demonstrates how to create a a new dynamic notarization. |
| [03_update_dynamic](https://github.com/iotaledger/notarization/tree/main/bindings/wasm/notarization_wasm/examples/src/03_update_dynamic.ts) | Demonstrates how to update a dynamic notarization. |
| [04_destroy_notarization](https://github.com/iotaledger/notarization/tree/main/bindings/wasm/notarization_wasm/examples/src/04_destroy_notarization.ts) | Demonstrates how to destroy a Notarization. |
| [05_update_state](https://github.com/iotaledger/notarization/tree/main/bindings/wasm/notarization_wasm/examples/src/05_update_state.ts) | Demonstrates how to update the state of a Notarization. |
| [06_update_metadata](https://github.com/iotaledger/notarization/tree/main/bindings/wasm/notarization_wasm/examples/src/06_update_metadata.ts) | Demonstrates how to update the metadata of a Notarization. |
| [07_transfer_notarization](https://github.com/iotaledger/notarization/tree/main/bindings/wasm/notarization_wasm/examples/src/07_transfer_notarization.ts) | Demonstrates how to transfer a dynamic Notarization and transferring a locked Notarization will fail. |
| [08_access_read_only_methods](https://github.com/iotaledger/notarization/tree/main/bindings/wasm/notarization_wasm/examples/src/08_access_read_only_methods.ts) | Demonstrates read-only methods for notarization inspection. |

<!--

Expand Down
16 changes: 8 additions & 8 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ The following basic CRUD (Create, Read, Update, Delete) examples are available:

| Name | Information |
| :------------------------------------------------------------------------ | :-------------------------------------------------------------------------------- |
| [01_create_locked_notarization](./01_create_locked_notarization.rs) | Demonstrates how to create a locked notarization with delete locks. |
| [02_create_dynamic_notarization](./02_create_dynamic_notarization.rs) | Demonstrates how to create dynamic notarizations with and without transfer locks. |
| [03_update_dynamic_notarization](./03_update_dynamic_notarization.rs) | Demonstrates that dynamic notarizations can be updated |
| [04_destroy_notarization](./04_destroy_notarization.rs) | Demonstrates notarization destruction scenarios based on lock types. |
| [05_update_state](./05_update_state.rs) | Demonstrates state updates on dynamic notarizations including binary data. |
| [06_update_metadata](./06_update_metadata.rs) | Demonstrates metadata updates and their behavior vs state updates. |
| [07_transfer_dynamic_notarization](./07_transfer_dynamic_notarization.rs) | Demonstrates transfer scenarios for different notarization types and lock states. |
| [08_access_read_only_methods](./08_access_read_only_methods.rs) | Comprehensive demonstration of all read-only inspection methods. |
| [01_create_locked_notarization](https://github.com/iotaledger/notarization/tree/main/examples/01_create_locked_notarization.rs) | Demonstrates how to create a locked notarization with delete locks. |
| [02_create_dynamic_notarization](https://github.com/iotaledger/notarization/tree/main/examples/02_create_dynamic_notarization.rs) | Demonstrates how to create dynamic notarizations with and without transfer locks. |
| [03_update_dynamic_notarization](https://github.com/iotaledger/notarization/tree/main/examples/03_update_dynamic_notarization.rs) | Demonstrates that dynamic notarizations can be updated |
| [04_destroy_notarization](https://github.com/iotaledger/notarization/tree/main/examples/04_destroy_notarization.rs) | Demonstrates notarization destruction scenarios based on lock types. |
| [05_update_state](https://github.com/iotaledger/notarization/tree/main/examples/05_update_state.rs) | Demonstrates state updates on dynamic notarizations including binary data. |
| [06_update_metadata](https://github.com/iotaledger/notarization/tree/main/examples/06_update_metadata.rs) | Demonstrates metadata updates and their behavior vs state updates. |
| [07_transfer_dynamic_notarization](https://github.com/iotaledger/notarization/tree/main/examples/07_transfer_dynamic_notarization.rs) | Demonstrates transfer scenarios for different notarization types and lock states. |
| [08_access_read_only_methods](https://github.com/iotaledger/notarization/tree/main/examples/08_access_read_only_methods.rs) | Comprehensive demonstration of all read-only inspection methods. |

## Notarization Types

Expand Down