Skip to content

Commit 22e0d29

Browse files
committed
docs(docs): Replace <key> with a concrete valid example public key
1 parent 5961bdd commit 22e0d29

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

docs/src/architecture/08_concepts/rbac_id_uri/catalyst-id-uri.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,7 @@ The overall `path` specification is: `<initial role0 key>/<role>/<rotation>#encr
132132
* This does not change, even if the Initial Role 0 key is revoked.
133133
* This allows for an unambiguous identifier for the RBAC keychain.
134134
* It is not necessarily the key being identified.
135+
* An example Role 0 Key is `FftxFnOrj2qmTuB2oZG2v0YEWJfKvQ9Gg8AgNAhDsKE`
135136
* `<role>` - *Optional* This is the Role number being used.
136137
* It is a positive number, starting at 0, and no greater than 65535.
137138
* If it is not defined, then its default value is 0.
@@ -154,44 +155,48 @@ The first implementation will be Catalyst Voices.
154155

155156
## Test Vectors
156157

157-
* `id.catalyst://cardano/<key>`
158+
* `id.catalyst://cardano/FftxFnOrj2qmTuB2oZG2v0YEWJfKvQ9Gg8AgNAhDsKE`
158159
* A Signing key registered on the Cardano Main network.
159160
* Role 0 - Rotation 0.
160161
* `username` - undefined.
161162
* `nonce` - undefined.
162-
* In this example, it is identical to `<key>/0/0` or `<key>/0`.
163-
* `id.catalyst://cardano/<key>/0`
163+
* In this example, it is identical to `FftxFnOrj2qmTuB2oZG2v0YEWJfKvQ9Gg8AgNAhDsKE/0/0` or
164+
`FftxFnOrj2qmTuB2oZG2v0YEWJfKvQ9Gg8AgNAhDsKE/0`.
165+
* `id.catalyst://cardano/FftxFnOrj2qmTuB2oZG2v0YEWJfKvQ9Gg8AgNAhDsKE/0`
164166
* A Signing key registered on the Cardano Main network.
165167
* Role 0 - Rotation 0.
166168
* `username` - undefined.
167169
* `nonce` - undefined.
168-
* In this example, it is identical to `<key>/0/0` or `<key>`.
169-
* `id.catalyst://gary@cardano/<key>/0/0`
170+
* In this example, it is identical to `FftxFnOrj2qmTuB2oZG2v0YEWJfKvQ9Gg8AgNAhDsKE/0/0` or
171+
`FftxFnOrj2qmTuB2oZG2v0YEWJfKvQ9Gg8AgNAhDsKE`.
172+
* `id.catalyst://gary@cardano/FftxFnOrj2qmTuB2oZG2v0YEWJfKvQ9Gg8AgNAhDsKE/0/0`
170173
* A Signing key registered on the Cardano Main network.
171174
* Role 0 - Rotation 0.
172175
* `username` - `gary`.
173176
* `nonce` - undefined.
174-
* In this example, it is identical to `<key>` or `<key>/0`.
175-
* `id.catalyst://faith@preprod@cardano/<key>/7/3`
177+
* In this example, it is identical to `FftxFnOrj2qmTuB2oZG2v0YEWJfKvQ9Gg8AgNAhDsKE` or
178+
`FftxFnOrj2qmTuB2oZG2v0YEWJfKvQ9Gg8AgNAhDsKE/0`.
179+
* `id.catalyst://faith@preprod@cardano/FftxFnOrj2qmTuB2oZG2v0YEWJfKvQ9Gg8AgNAhDsKE/7/3`
176180
* A Signing key registered on the Cardano pre-production network.
177181
* Role 7 - Rotation 3.
178182
* `username` - `faith`
179183
* `nonce` - undefined.
180184
* The Key for Role 7, and its third published rotation
181185
(i.e., the fourth key published, the first is the initial key, plus 3 rotations following it).
182-
* `id.catalyst://faith:173710179@preprod@cardano/<key>/2/0#encrypt`
186+
* `id.catalyst://faith:173710179@preprod@cardano/FftxFnOrj2qmTuB2oZG2v0YEWJfKvQ9Gg8AgNAhDsKE/2/0#encrypt`
183187
* A Public Encryption key registered on the Cardano pre-production network.
184188
* Role 2 - Rotation 0.
185189
* `username` - `faith`
186190
* `nonce` - 173710179.
187191
* The initially published Public Encryption Key for Role 2.
188-
* `kid.catalyst-rbac://:173710179@midnight/<key>/0/1`
192+
* `kid.catalyst-rbac://:173710179@midnight/FftxFnOrj2qmTuB2oZG2v0YEWJfKvQ9Gg8AgNAhDsKE/0/1`
189193
* A Signing key registered on the Midnight Blockchain Main network
190194
* Role 0 - Rotation 1.
191195
* `username` - undefined.
192196
* `nonce` - 173710179.
193-
* In this example, it is NOT the same as the `<key>`, as it identifies the first rotation after `<key>`.
194-
* `kid.catalyst-rbac://midnight/<key>/2/1#encrypt`
197+
* In this example, it is NOT the same as the `FftxFnOrj2qmTuB2oZG2v0YEWJfKvQ9Gg8AgNAhDsKE`,
198+
as it identifies the first rotation after `FftxFnOrj2qmTuB2oZG2v0YEWJfKvQ9Gg8AgNAhDsKE`.
199+
* `kid.catalyst-rbac://midnight/FftxFnOrj2qmTuB2oZG2v0YEWJfKvQ9Gg8AgNAhDsKE/2/1#encrypt`
195200
* A public encryption key registered on the Midnight Blockchain Main network.
196201
* Role 2 - Rotation 1.
197202
* `username` - undefined.

0 commit comments

Comments
 (0)