Skip to content

Commit 003c3ab

Browse files
committed
fix(docs): update signed document metadata to use UUIDv7 instead of ULID
1 parent c5605c0 commit 003c3ab

File tree

1 file changed

+11
-11
lines changed
  • docs/src/architecture/08_concepts/signed_document_metadata

1 file changed

+11
-11
lines changed

docs/src/architecture/08_concepts/signed_document_metadata/metadata.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,9 @@ However, `id` uniqueness is only guaranteed on first use.
110110

111111
If the same `id` is used, by unauthorized publishers, the document is invalid.
112112

113-
The `id` is a [ULID].
114-
It will be encoded using [ULID CBOR Encoding].
113+
The `id` is a [UUID].
114+
This identifier will be a [CBOR] Encoded [UUID Byte String].
115+
Only [UUID] V7 is supported and used.
115116

116117
The first time a document is created, it will be assigned by the creator a new `id` which must
117118
be well constructed.
@@ -138,12 +139,13 @@ including all otherwise legitimate publications by the same author being marked
138139
Every document in the system will be versioned.
139140
There can, and probably will, exist multiple versions of the same document.
140141

141-
The `ver` is a [ULID].
142-
It will be encoded using [ULID CBOR Encoding].
142+
The `ver` is a [UUID].
143+
This identifier will be a [CBOR] Encoded [UUID Byte String].
144+
Only [UUID] V7 is supported and used.
143145

144146
The initial `ver` assigned the first time a document is published will be identical to the [`id`](#document-id--id).
145147
Subsequent versions will retain the same [`id`](#document-id--id) and will create a new `ver`,
146-
following best practice for creating a new [ULID].
148+
following best practice for creating a new [UUID] v7.
147149

148150
#### Document Reference : `ref`
149151

@@ -154,13 +156,13 @@ following best practice for creating a new [ULID].
154156
This is a reference to another document.
155157
The purpose of the `ref` will vary depending on the document [`type`](#document-type--type).
156158

157-
The `ref` can be either a single [ULID] or a [CBOR] Array of Two [ULID].
159+
The `ref` can be either a single [UUID] or a [CBOR] Array of Two [UUID].
158160

159-
If the `ref` is a single [ULID], it is a reference to the document of that [`id`](#document-id--id).
161+
If the `ref` is a single [UUID], it is a reference to the document of that [`id`](#document-id--id).
160162
If the `ref` is a [CBOR] array, it has the form `[<id>,<ver>]` where:
161163

162-
* `<id>` = the [ULID] of the referenced documents [`id`](#document-id--id)
163-
* `<ver>` = the [ULID] of the referenced documents [`ver`](#document-version--ver).
164+
* `<id>` = the [UUID] of the referenced documents [`id`](#document-id--id)
165+
* `<ver>` = the [UUID] of the referenced documents [`ver`](#document-version--ver).
164166

165167
#### Template Reference : `template`
166168

@@ -289,8 +291,6 @@ This document is licensed under [CC-BY-4.0](https://creativecommons.org/licenses
289291
[JSON Schema]: https://json-schema.org/draft-07
290292
[Brotli]: https://datatracker.ietf.org/doc/html/rfc7932
291293
[JSON]: https://datatracker.ietf.org/doc/html/rfc7159
292-
[ULID]: https://github.com/ulid/spec
293-
[ULID CBOR Encoding]: https://github.com/input-output-hk/catalyst-voices/blob/main/docs/src/catalyst-standards/cbor_tags/ulid.md
294294
[CBOR]: https://datatracker.ietf.org/doc/html/rfc8610
295295
[UUID]: https://www.rfc-editor.org/rfc/rfc9562.html
296296
[JSON Path]: https://datatracker.ietf.org/doc/html/rfc9535

0 commit comments

Comments
 (0)