Skip to content

Commit bacc27c

Browse files
authored
Add Identity 1.5 docs (#1693)
1 parent 8a0026c commit bacc27c

33 files changed

+64
-64
lines changed

config/versionedConfig.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ exports.buildPluginsConfig = [
4949
badges: ['IOTA', 'Shimmer'],
5050
},
5151
{
52-
label: '1.3',
52+
label: '1.5',
5353
badges: ['IOTA', 'Shimmer'],
5454
},
5555
],

docs/build/identity.rs/1.4/docs/getting-started/rust.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ tags:
1010

1111
## Requirements
1212

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

1616
## Include the Library
1717

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

2424
```toml
2525
[dependencies]
26-
identity_iota = { version = "1.2.0" }
26+
identity_iota = { version = "1.4.0" }
2727
```
2828

2929
### Development Release

docs/build/identity.rs/1.3/docs/getting-started/rust.mdx docs/build/identity.rs/1.5/docs/getting-started/rust.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ tags:
1010

1111
## Requirements
1212

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

1616
## Include the Library
1717

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

2424
```toml
2525
[dependencies]
26-
identity_iota = { version = "1.2.0" }
26+
identity_iota = { version = "1.5.0" }
2727
```
2828

2929
### Development Release

docs/build/identity.rs/1.3/docs/getting-started/wasm.mdx docs/build/identity.rs/1.5/docs/getting-started/wasm.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -336,4 +336,4 @@ You may find it useful to see how the WASM bindings are being used in existing a
336336

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

339-
## [Examples](https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/README.md)
339+
## [Examples](https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/README.md)

docs/build/identity.rs/1.3/docs/how-tos/decentralized-identifiers/create.mdx docs/build/identity.rs/1.5/docs/how-tos/decentralized-identifiers/create.mdx

+10-10
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@ you will need an output with actual Shimmer or IOTA funds to create a new Alias
4545
<TabItem value="rust" label="Rust">
4646

4747
```rust reference
48-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/0_create_did.rs#L52
48+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/0_create_did.rs#L52
4949
```
5050

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

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

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

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

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

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

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

109109
```rust reference
110-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/0_create_did.rs#L75
110+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/0_create_did.rs#L75
111111
```
112112

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

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

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

141141
```rust reference
142-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/0_create_did.rs#L78
142+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/0_create_did.rs#L78
143143
```
144144

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

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

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

161161
```rust reference
162-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/0_create_did.rs
162+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/0_create_did.rs
163163
```
164164

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

168168
```ts reference
169-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/0_basic/0_create_did.ts
169+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/0_basic/0_create_did.ts
170170
```
171171

172172
</TabItem>

docs/build/identity.rs/1.3/docs/how-tos/decentralized-identifiers/delete.mdx docs/build/identity.rs/1.5/docs/how-tos/decentralized-identifiers/delete.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,14 @@ and optionally reclaiming the storage deposit.
4646
<TabItem value="rust" label="Rust">
4747

4848
```rust reference
49-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/3_deactivate_did.rs
49+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/3_deactivate_did.rs
5050
```
5151

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

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

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

9494
```rust reference
95-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/4_delete_did.rs
95+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/4_delete_did.rs
9696
```
9797

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

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

105105
</TabItem>

docs/build/identity.rs/1.3/docs/how-tos/decentralized-identifiers/resolve.mdx docs/build/identity.rs/1.5/docs/how-tos/decentralized-identifiers/resolve.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -167,14 +167,14 @@ and [credentials](./../../explanations/verifiable-credentials.mdx).
167167
<TabItem value="rust" label="Rust">
168168

169169
```rust reference
170-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/1_advanced/5_custom_resolution.rs
170+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/1_advanced/5_custom_resolution.rs
171171
```
172172

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

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

180180
</TabItem>

docs/build/identity.rs/1.3/docs/how-tos/decentralized-identifiers/update.mdx docs/build/identity.rs/1.5/docs/how-tos/decentralized-identifiers/update.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -520,14 +520,14 @@ Publish the updated DID Document inside the Alias Output taking into account the
520520
<TabItem value="rust" label="Rust">
521521
522522
```rust reference
523-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/1_update_did.rs
523+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/1_update_did.rs
524524
```
525525
526526
</TabItem>
527527
<TabItem value="typescript-node" label="Typescript (Node.js)">
528528
529529
```ts reference
530-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/examples/src/0_basic/1_update_did.ts
530+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/examples/src/0_basic/1_update_did.ts
531531
```
532532
533533
</TabItem>

docs/build/identity.rs/1.3/docs/how-tos/domain-linkage/create-and-verify.mdx docs/build/identity.rs/1.5/docs/how-tos/domain-linkage/create-and-verify.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -165,14 +165,14 @@ You can learn more
165165
<TabItem value="rust" label="Rust">
166166

167167
```rust reference
168-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/1_advanced/6_domain_linkage.rs
168+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/1_advanced/6_domain_linkage.rs
169169
```
170170

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

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

178178
</TabItem>

docs/build/identity.rs/1.3/docs/how-tos/key-storage.mdx docs/build/identity.rs/1.5/docs/how-tos/key-storage.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -119,14 +119,14 @@ This section shows the Rust and TypeScript `Memstore` implementations.
119119
<TabItem value="typescript-node" label="Typescript (Node.js)">
120120

121121
```ts reference
122-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/lib/jwk_storage.ts
122+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/lib/jwk_storage.ts
123123
```
124124

125125
</TabItem>
126126
<TabItem value="rust" label="Rust">
127127

128128
```rust reference
129-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/identity_storage/src/key_storage/memstore.rs
129+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/identity_storage/src/key_storage/memstore.rs
130130
```
131131

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

140140
```ts reference
141-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/bindings/wasm/lib/key_id_storage.ts
141+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/bindings/wasm/lib/key_id_storage.ts
142142
```
143143

144144
</TabItem>
145145
<TabItem value="rust" label="Rust">
146146

147147
```rust reference
148-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/identity_storage/src/key_id_storage/memstore.rs
148+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/identity_storage/src/key_id_storage/memstore.rs
149149
```
150150

151151
</TabItem>

docs/build/identity.rs/1.3/docs/how-tos/verifiable-credentials/create.mdx docs/build/identity.rs/1.5/docs/how-tos/verifiable-credentials/create.mdx

+6-6
Original file line numberDiff line numberDiff line change
@@ -83,14 +83,14 @@ In this example, the issuer signs a `UniversityDegreeCredential` with Alice's na
8383
<TabItem value="rust" label="Rust">
8484

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

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

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

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

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

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

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

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

129129
```rust reference
130-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/5_create_vc.rs
130+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/5_create_vc.rs
131131
```
132132

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

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

140140
</TabItem>

docs/build/identity.rs/1.3/docs/how-tos/verifiable-credentials/revocation.mdx docs/build/identity.rs/1.5/docs/how-tos/verifiable-credentials/revocation.mdx

+10-10
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,14 @@ per the issuer's DID document, one may expect to be able to handle roughly 50k e
4848
<TabItem value="rust" label="Rust">
4949

5050
```rust reference
51-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/7_revoke_vc.rs#L167
51+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/7_revoke_vc.rs#L167
5252
```
5353

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

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

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

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

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

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

122122
</TabItem>
@@ -144,14 +144,14 @@ status list credential.
144144
<TabItem value="rust" label="Rust">
145145

146146
```rust reference
147-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/1_advanced/8_status_list_2021.rs#L173
147+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/1_advanced/8_status_list_2021.rs#L173
148148
```
149149

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

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

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

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

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

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

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

196196
```rust reference
197-
https://github.com/iotaledger/identity.rs/blob/v1.3.0/examples/0_basic/7_revoke_vc.rs
197+
https://github.com/iotaledger/identity.rs/blob/v1.5.0/examples/0_basic/7_revoke_vc.rs
198198
```
199199

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

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

207207
</TabItem>

0 commit comments

Comments
 (0)