Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Identity 1.5 docs #1693

Merged
merged 3 commits into from
Feb 10, 2025
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
2 changes: 1 addition & 1 deletion config/versionedConfig.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ exports.buildPluginsConfig = [
badges: ['IOTA', 'Shimmer'],
},
{
label: '1.3',
label: '1.5',
badges: ['IOTA', 'Shimmer'],
},
],
Expand Down
6 changes: 3 additions & 3 deletions docs/build/identity.rs/1.4/docs/getting-started/rust.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ tags:

## Requirements

- [Rust](https://www.rust-lang.org/) (>= 1.62)
- [Cargo](https://doc.rust-lang.org/cargo/) (>= 1.62)
- [Rust](https://www.rust-lang.org/) (>= 1.65)
- [Cargo](https://doc.rust-lang.org/cargo/) (>= 1.65)

## Include the Library

Expand All @@ -23,7 +23,7 @@ This version is published to crates.io and is **stable**, following semantic ver

```toml
[dependencies]
identity_iota = { version = "1.2.0" }
identity_iota = { version = "1.4.0" }
```

### Development Release
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ tags:

## Requirements

- [Rust](https://www.rust-lang.org/) (>= 1.62)
- [Cargo](https://doc.rust-lang.org/cargo/) (>= 1.62)
- [Rust](https://www.rust-lang.org/) (>= 1.65)
- [Cargo](https://doc.rust-lang.org/cargo/) (>= 1.65)

## Include the Library

Expand All @@ -23,7 +23,7 @@ This version is published to crates.io and is **stable**, following semantic ver

```toml
[dependencies]
identity_iota = { version = "1.2.0" }
identity_iota = { version = "1.5.0" }
```

### Development Release
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -336,4 +336,4 @@ You may find it useful to see how the WASM bindings are being used in existing a

## [API Reference](../references/wasm/api_ref.md)

## [Examples](https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/README.md)
## [Examples](https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/README.md)
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,14 @@ you will need an output with actual Shimmer or IOTA funds to create a new Alias
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/0_create_did.rs#L52
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/0_create_did.rs#L52
```

</TabItem>
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/0_basic/0_create_did.ts#L40-L51
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/0_basic/0_create_did.ts#L40-L51
```

</TabItem>
Expand All @@ -77,14 +77,14 @@ the DID inside the document.
<TabItem value="rust" label="Rust">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/0_create_did.rs#L59-L71
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/0_create_did.rs#L59-L71
```

</TabItem>
<TabItem value="typescript-node" label="Typescript (Node.js)">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/0_basic/0_create_did.ts#L55C44-L65
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/0_basic/0_create_did.ts#L55C44-L65
```

</TabItem>
Expand All @@ -107,14 +107,14 @@ However, they must be unlocked in order perform a state or governance transition
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/0_create_did.rs#L75
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/0_create_did.rs#L75
```

</TabItem>
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/0_basic/0_create_did.ts#L70
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/0_basic/0_create_did.ts#L70
```

</TabItem>
Expand All @@ -139,14 +139,14 @@ the DID Document is stored on the ledger and can be [resolved](resolve.mdx) usin
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/0_create_did.rs#L78
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/0_create_did.rs#L78
```

</TabItem>
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/0_basic/0_create_did.ts#L74
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/0_basic/0_create_did.ts#L74
```

</TabItem>
Expand All @@ -159,14 +159,14 @@ https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/0_create_did.rs
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/0_create_did.rs
```

</TabItem>
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/0_basic/0_create_did.ts
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/0_basic/0_create_did.ts
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,14 @@ and optionally reclaiming the storage deposit.
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/3_deactivate_did.rs
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/3_deactivate_did.rs
```

</TabItem>
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/0_basic/3_deactivate_did.ts
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/0_basic/3_deactivate_did.ts
```

</TabItem>
Expand Down Expand Up @@ -92,14 +92,14 @@ The following example demonstrates how a governor destroys an IOTA Identity and
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/4_delete_did.rs
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/4_delete_did.rs
```

</TabItem>
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/0_basic/4_delete_did.ts
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/0_basic/4_delete_did.ts
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,14 +167,14 @@ and [credentials](./../../explanations/verifiable-credentials.mdx).
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/1_advanced/5_custom_resolution.rs
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/1_advanced/5_custom_resolution.rs
```

</TabItem>
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/1_advanced/4_custom_resolution.ts
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/1_advanced/4_custom_resolution.ts
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -520,14 +520,14 @@ Publish the updated DID Document inside the Alias Output taking into account the
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/1_update_did.rs
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/1_update_did.rs
```

</TabItem>
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/0_basic/1_update_did.ts
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/0_basic/1_update_did.ts
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -165,14 +165,14 @@ You can learn more
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/1_advanced/6_domain_linkage.rs
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/1_advanced/6_domain_linkage.rs
```

</TabItem>
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/1_advanced/5_domain_linkage.ts
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/1_advanced/5_domain_linkage.ts
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,14 +119,14 @@ This section shows the Rust and TypeScript `Memstore` implementations.
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/lib/jwk_storage.ts
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/lib/jwk_storage.ts
```

</TabItem>
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/identity_storage/src/key_storage/memstore.rs
https://github.com/iotaledger/identity.rs/blob/v1.5.0/identity_storage/src/key_storage/memstore.rs
```

</TabItem>
Expand All @@ -138,14 +138,14 @@ https://github.com/iotaledger/identity.rs/blob/v1.3.0/identity_storage/src/key_s
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/lib/key_id_storage.ts
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/lib/key_id_storage.ts
```

</TabItem>
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/identity_storage/src/key_id_storage/memstore.rs
https://github.com/iotaledger/identity.rs/blob/v1.5.0/identity_storage/src/key_id_storage/memstore.rs
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,14 @@ In this example, the issuer signs a `UniversityDegreeCredential` with Alice's na
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/5_create_vc.rs#L67-L98
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/5_create_vc.rs#L67-L98
```

</TabItem>
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/0_basic/5_create_vc.ts#L51-L74
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/0_basic/5_create_vc.ts#L51-L74
```

</TabItem>
Expand All @@ -104,14 +104,14 @@ https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/5_create_vc.rs#L105-L113
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/5_create_vc.rs#L105-L113
```

</TabItem>
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/0_basic/5_create_vc.ts#L83-L88
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/0_basic/5_create_vc.ts#L83-L88
```

</TabItem>
Expand All @@ -127,14 +127,14 @@ allowing Alice to take control of it and share it with anyone.
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/5_create_vc.rs
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/5_create_vc.rs
```

</TabItem>
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/0_basic/5_create_vc.ts
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/0_basic/5_create_vc.ts
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,14 @@ per the issuer's DID document, one may expect to be able to handle roughly 50k e
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/7_revoke_vc.rs#L167
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/7_revoke_vc.rs#L167
```

</TabItem>
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/0_basic/7_revoke_vc.ts#L156
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/0_basic/7_revoke_vc.ts#L156
```

</TabItem>
Expand Down Expand Up @@ -109,14 +109,14 @@ be valid again, as the _revoked_ state is irreversible.
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/1_advanced/8_status_list_2021.rs#L86-L90
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/1_advanced/8_status_list_2021.rs#L86-L90
```

</TabItem>
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/1_advanced/7_status_list_2021.ts#L72-L76
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/1_advanced/7_status_list_2021.ts#L72-L76
```

</TabItem>
Expand Down Expand Up @@ -144,14 +144,14 @@ status list credential.
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/1_advanced/8_status_list_2021.rs#L173
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/1_advanced/8_status_list_2021.rs#L173
```

</TabItem>
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/1_advanced/7_status_list_2021.ts#L147
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/1_advanced/7_status_list_2021.ts#L147
```

</TabItem>
Expand All @@ -173,14 +173,14 @@ precise control over which credential is revoked.
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/7_revoke_vc.rs#L197-L204
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/7_revoke_vc.rs#L197-L204
```

</TabItem>
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/0_basic/7_revoke_vc.ts#L192C1-L195
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/0_basic/7_revoke_vc.ts#L192C1-L195
```

</TabItem>
Expand All @@ -194,14 +194,14 @@ The following code exemplifies how you can revoke a [Verifiable Credential (VC)]
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/7_revoke_vc.rs
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/7_revoke_vc.rs
```

</TabItem>
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/0_basic/7_revoke_vc.ts
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/0_basic/7_revoke_vc.ts
```

</TabItem>
Expand Down
Loading
Loading