Skip to content
Open
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
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ To include IOTA Identity in your project, add it as a dependency in your `Cargo.

```toml
[dependencies]
identity_iota = { git = "https://github.com/iotaledger/identity.rs", tag = "v1.6.0-beta"}
identity_iota = { git = "https://github.com/iotaledger/identity.rs", tag = "beta"}
```

## Examples

To try out the [examples](https://github.com/iotaledger/identity.rs/tree/v1.6.0-beta/examples), you should:
To try out the [examples](https://github.com/iotaledger/identity.rs/tree/beta/examples), you should:

1. Clone the repository:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ npm install @iota/identity-wasm@beta

## Build the Library

Alternatively, you can build the bindings to work with currently unreleased features. You can find instructions for this in the [`identity.rs` repository](https://github.com/iotaledger/identity.rs/tree/v1.6.0-beta/bindings/wasm/identity_wasm#build).
Alternatively, you can build the bindings to work with currently unreleased features. You can find instructions for this in the [`identity.rs` repository](https://github.com/iotaledger/identity.rs/tree/beta/bindings/wasm/identity_wasm#build).

## Usage in Node.js and Web

Expand All @@ -58,7 +58,7 @@ import { ... } from '@iota/identity/web';


```ts reference
https://github.com/iotaledger/identity.rs/tree/v1.6.0-beta/bindings/wasm/identity_wasm/examples/src/0_basic/0_create_did.ts
https://github.com/iotaledger/identity.rs/tree/beta/bindings/wasm/identity_wasm/examples/src/0_basic/0_create_did.ts
```

</TabItem>
Expand Down Expand Up @@ -101,7 +101,7 @@ export async function createIdentity(): Promise<void> {
</TabItem>
</Tabs>

See [utils](https://github.com/iotaledger/identity.rs/tree/v1.6.0-beta/bindings/wasm/identity_wasm/examples/src/util.ts) for details about the implementations about the helper functions used here.
See [utils](https://github.com/iotaledger/identity.rs/tree/beta/bindings/wasm/identity_wasm/examples/src/util.ts) for details about the implementations about the helper functions used here.

### Expected Output

Expand Down Expand Up @@ -280,4 +280,4 @@ For complete API documentation, see the [WASM API Reference](../references/wasm/

## Examples

You can find more usage examples and tutorials in the [identity examples repository](https://github.com/iotaledger/identity.rs/tree/v1.6.0-beta/bindings/wasm/identity_wasm/examples/README.md).
You can find more usage examples and tutorials in the [identity examples repository](https://github.com/iotaledger/identity.rs/tree/beta/bindings/wasm/identity_wasm/examples/README.md).
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@ you will need an an address with actual IOTA funds to create a new Identity.
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/examples/utils/utils.rs#L103-L111
https://github.com/iotaledger/identity.rs/blob/beta/examples/utils/utils.rs#L103-L111
```

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

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identity_wasm/examples/src/util.ts#L66-L78
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/util.ts#L66-L78
```

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

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/examples/utils/utils.rs#L48-L57
https://github.com/iotaledger/identity.rs/blob/beta/examples/utils/utils.rs#L48-L57
```

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

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identity_wasm/examples/src/util.ts#L33-L41
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/util.ts#L33-L41
```

</TabItem>
Expand Down Expand Up @@ -118,7 +118,7 @@ let identity = identity_client
<TabItem value="typescript-node" label="Typescript (Node.js)">

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identity_wasm/examples/src/0_basic/0_create_did.ts#L24-L27
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/0_basic/0_create_did.ts#L24-L27
```

</TabItem>
Expand All @@ -131,14 +131,14 @@ https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identit
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/examples/0_basic/0_create_did.rs
https://github.com/iotaledger/identity.rs/blob/beta/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.6.0-beta/bindings/wasm/identity_wasm/examples/src/0_basic/0_create_did.ts
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/0_basic/0_create_did.ts
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@ The following example demonstrates deactivating and reactivating an IOTA DID Doc
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/examples/0_basic/3_deactivate_did.rs
https://github.com/iotaledger/identity.rs/blob/beta/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.6.0-beta/bindings/wasm/identity_wasm/examples/src/0_basic/3_deactivate_did.ts
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/0_basic/3_deactivate_did.ts
```

</TabItem>
Expand Down Expand Up @@ -87,14 +87,14 @@ The following example demonstrates how a controller destroys an IOTA DID.
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/examples/0_basic/4_delete_did.rs
https://github.com/iotaledger/identity.rs/blob/beta/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.6.0-beta/bindings/wasm/identity_wasm/examples/src/0_basic/4_delete_did.ts
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/0_basic/4_delete_did.ts
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@ then extracts and validates the DID Document from it.
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/examples/0_basic/2_resolve_did.rs#L27-L33
https://github.com/iotaledger/identity.rs/blob/beta/examples/0_basic/2_resolve_did.rs#L27-L33
```

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

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identity_wasm/examples/src/0_basic/2_resolve_did.ts#L49-L53
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/0_basic/2_resolve_did.ts#L49-L53
```

</TabItem>
Expand All @@ -63,14 +63,14 @@ You can also use the `Client` directly to resolve individual DIDs from its confi
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/examples/0_basic/2_resolve_did.rs#L23-L24
https://github.com/iotaledger/identity.rs/blob/beta/examples/0_basic/2_resolve_did.rs#L23-L24
```

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

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identity_wasm/examples/src/0_basic/2_resolve_did.ts#L34-L35
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/0_basic/2_resolve_did.ts#L34-L35
```

</TabItem>
Expand All @@ -92,14 +92,14 @@ and [credentials](./../../explanations/verifiable-credentials.mdx).
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/examples/1_advanced/5_custom_resolution.rs
https://github.com/iotaledger/identity.rs/blob/beta/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.6.0-beta/bindings/wasm/identity_wasm/examples/src/1_advanced/4_custom_resolution.ts
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/1_advanced/4_custom_resolution.ts
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,14 +81,14 @@ Before you can update anything, you will need to [create an Identity](./create.m
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/examples/0_basic/1_update_did.rs#L25-L30
https://github.com/iotaledger/identity.rs/blob/beta/examples/0_basic/1_update_did.rs#L25-L30
```

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

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identity_wasm/examples/src/0_basic/1_update_did.ts#L18-L30
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/0_basic/1_update_did.ts#L18-L30
```

</TabItem>
Expand Down Expand Up @@ -128,14 +128,14 @@ This creates and publishes an Identity object containing a DID Document with one
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/examples/0_basic/1_update_did.rs#L35-L44
https://github.com/iotaledger/identity.rs/blob/beta/examples/0_basic/1_update_did.rs#L35-L44
```

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

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identity_wasm/examples/src/0_basic/1_update_did.ts#L35-L42
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/0_basic/1_update_did.ts#L35-L42
```

</TabItem>
Expand Down Expand Up @@ -189,14 +189,14 @@ You can attach verification relationships to a verification method by referencin
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/examples/0_basic/1_update_did.rs#L46-L50
https://github.com/iotaledger/identity.rs/blob/beta/examples/0_basic/1_update_did.rs#L46-L50
```

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

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identity_wasm/examples/src/0_basic/1_update_did.ts#L44-L45
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/0_basic/1_update_did.ts#L44-L45
```

</TabItem>
Expand Down Expand Up @@ -254,14 +254,14 @@ You can also add custom properties can to a service by setting `properties`:
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/examples/0_basic/1_update_did.rs#L52-L59
https://github.com/iotaledger/identity.rs/blob/beta/examples/0_basic/1_update_did.rs#L52-L59
```

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

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identity_wasm/examples/src/0_basic/1_update_did.ts#L47-L53
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/0_basic/1_update_did.ts#L47-L53
```

</TabItem>
Expand Down Expand Up @@ -325,14 +325,14 @@ You can also remove verification methods at any time using the following snippet
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/examples/0_basic/1_update_did.rs#L61-L63
https://github.com/iotaledger/identity.rs/blob/beta/examples/0_basic/1_update_did.rs#L61-L63
```

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

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identity_wasm/examples/src/0_basic/1_update_did.ts#L55-L57
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/0_basic/1_update_did.ts#L55-L57
```

</TabItem>
Expand Down Expand Up @@ -382,14 +382,14 @@ This removes the original verification method.
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/examples/0_basic/1_update_did.rs
https://github.com/iotaledger/identity.rs/blob/beta/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.6.0-beta/bindings/wasm/identity_wasm/examples/src/0_basic/1_update_did.ts
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/0_basic/1_update_did.ts
```

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

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/examples/1_advanced/6_domain_linkage.rs
https://github.com/iotaledger/identity.rs/blob/beta/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.6.0-beta/bindings/wasm/identity_wasm/examples/src/1_advanced/5_domain_linkage.ts
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/1_advanced/5_domain_linkage.ts
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,14 +116,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.6.0-beta/bindings/wasm/identity_wasm/lib/jwk_storage.ts
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/lib/jwk_storage.ts
```

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

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/identity_storage/src/key_storage/memstore.rs
https://github.com/iotaledger/identity.rs/blob/beta/identity_storage/src/key_storage/memstore.rs
```

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

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identity_wasm/lib/key_id_storage.ts
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/lib/key_id_storage.ts
```

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

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/identity_storage/src/key_id_storage/memstore.rs
https://github.com/iotaledger/identity.rs/blob/beta/identity_storage/src/key_id_storage/memstore.rs
```

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,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.6.0-beta/examples/0_basic/5_create_vc.rs#L36-L73
https://github.com/iotaledger/identity.rs/blob/beta/examples/0_basic/5_create_vc.rs#L36-L73
```

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

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identity_wasm/examples/src/0_basic/5_create_vc.ts#L22-L69
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/0_basic/5_create_vc.ts#L22-L69
```

</TabItem>
Expand All @@ -103,14 +103,14 @@ https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identit
<TabItem value="rust" label="Rust">

```rust reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/examples/0_basic/5_create_vc.rs#L80-L88
https://github.com/iotaledger/identity.rs/blob/beta/examples/0_basic/5_create_vc.rs#L80-L88
```

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

```ts reference
https://github.com/iotaledger/identity.rs/blob/v1.6.0-beta/bindings/wasm/identity_wasm/examples/src/0_basic/5_create_vc.ts#L78-L83
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/0_basic/5_create_vc.ts#L78-L83
```

</TabItem>
Expand All @@ -126,14 +126,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.6.0-beta/examples/0_basic/5_create_vc.rs
https://github.com/iotaledger/identity.rs/blob/beta/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.6.0-beta/bindings/wasm/identity_wasm/examples/src/0_basic/5_create_vc.ts
https://github.com/iotaledger/identity.rs/blob/beta/bindings/wasm/identity_wasm/examples/src/0_basic/5_create_vc.ts
```

</TabItem>
Expand Down
Loading
Loading