Update ver. 0.4 to the specification #108
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Stephen Curran <swcurran@gmail.com>
|
An update to the specification as per #106. Note that the names of the items in the DID Log Entry object remain long form -- To be discussed at the 2024.09.26 did:tdw meeting -- agenda here. Feedback ahead of the meeting welcome -- anything unexpected in this? |
swcurran
requested review from
brianorwhatever,
martipos,
andrewwhitehead and
PatStLouis
martipos
reviewed
Sep 25, 2024
Signed-off-by: martipos <176692840+martipos@users.noreply.github.com> Signed-off-by: martipos <176692840+martipos@users.noreply.github.com>
Signed-off-by: Stephen Curran <swcurran@gmail.com>
|
I've now updated the examples, per the implementation from the Python version. In theory, this is now complete. |
martipos
reviewed
Sep 27, 2024
There was a problem hiding this comment.
Wording changes
- Removed my previous change that the Integrity Proof is a JSON Object, based on yesterdays discussion outcome (it will remain an array/set)
- replaced 'item'/'s' with 'property'/'ies' as we agreed to change the DID log entry data format from array to JSON object
Signed-off-by: martipos 176692840+martipos@users.noreply.github.com
spec/specification.md
Outdated
|
|
||
| `[ versionId, versionTime, parameters, DIDDoc State, Data Integrity Proof ]` | ||
| `{ "versionId": "", "versionTime": "", "parameters": {}, "state": {}, "proof" : {} }` |
There was a problem hiding this comment.
Suggested change
| `{ "versionId": "", "versionTime": "", "parameters": {}, "state": {}, "proof" : {} }` | |
| `{ "versionId": "", "versionTime": "", "parameters": {}, "state": {}, "proof" : [] }` |
spec/specification.md
Outdated
| specification. | ||
| 4. The JSON object `state` contains the [[ref: DIDDoc]] for this version of the | ||
| DID. | ||
| 5. The JSON object `proof` is a [[ref: Data Integrity]] proof calculated across |
There was a problem hiding this comment.
Suggested change
| 5. The JSON object `proof` is a [[ref: Data Integrity]] proof calculated across | |
| 5. The JSON array `proof` is a [[ref: Data Integrity]] proof calculated across |
spec/specification.md
Outdated
|
|
||
| If the [[ref: DID Controller]] has opted to use [[ref: witnesses]] for the | ||
| DID, the required approvals from the DID's [[ref: witnesses]] **MUST** be | ||
| collected and added to the [[ref: Data Integrity]] proof item. See the [DID |
There was a problem hiding this comment.
Suggested change
| collected and added to the [[ref: Data Integrity]] proof item. See the [DID | |
| collected and added to the [[ref: Data Integrity]] proof property. See the [DID |
spec/specification.md
Outdated
| 3. Determine the hash algorithm used by the [[ref: DID Controller]] from the [[ref: multihash]] `scid` value. | ||
| - The hash algorithm **MUST** be one listed in the | ||
| [parameters](#didtdw-did-method-parameters) defined by the version of the | ||
| `did:tdw` specification being used by the [[ref: DID Controller]] based on the | ||
| `method` [[ref: parameters]] item. | ||
| 4. Remove the [[ref: data integrity]] proof item from the first [[ref: DID log entry]]. | ||
| 4. Remove the [[ref: data integrity]] proof item from the [[ref: DID log entry]]. |
There was a problem hiding this comment.
Suggested change
| 4. Remove the [[ref: data integrity]] proof item from the [[ref: DID log entry]]. | |
| 4. Remove the [[ref: data integrity]] proof property from the [[ref: DID log entry]]. |
spec/specification.md
Outdated
| @@ -766,7 +763,7 @@ Resolver **MUST** execute the following process: | |||
| #### Authorized Keys | |||
|
|
|||
| Each entry in the [[ref: DID Log]] **MUST** include a [[ref: Data Integrity]] | |||
| proof signed by a key **authorized** to control (create, update, deactivate) the | |||
| `proof` item signed by a key **authorized** to control (create, update, deactivate) the | |||
There was a problem hiding this comment.
Suggested change
| `proof` item signed by a key **authorized** to control (create, update, deactivate) the | |
| `proof` property signed by a key **authorized** to control (create, update, deactivate) the |
spec/specification.md
Outdated
| 3. Determine the hash algorithm used by the [[ref: DID Controller]] from the [[ref: multihash]] `scid` value. | ||
| - The hash algorithm **MUST** be one listed in the | ||
| [parameters](#didtdw-did-method-parameters) defined by the version of the | ||
| `did:tdw` specification being used by the [[ref: DID Controller]] based on the | ||
| `method` [[ref: parameters]] item. | ||
| 4. Remove the [[ref: data integrity]] proof item from the first [[ref: DID log entry]]. | ||
| 4. Remove the [[ref: data integrity]] proof item from the [[ref: DID log entry]]. |
There was a problem hiding this comment.
Suggested change
| 4. Remove the [[ref: data integrity]] proof item from the [[ref: DID log entry]]. | |
| 4. Remove the [[ref: data integrity]] proof property from the [[ref: DID log entry]]. |
spec/specification.md
Outdated
| 3. Determine the hash algorithm used by the [[ref: DID Controller]] from the [[ref: multihash]] `scid` value. | ||
| - The hash algorithm **MUST** be one listed in the | ||
| [parameters](#didtdw-did-method-parameters) defined by the version of the | ||
| `did:tdw` specification being used by the [[ref: DID Controller]] based on the | ||
| `method` [[ref: parameters]] item. | ||
| 4. Remove the [[ref: data integrity]] proof item from the first [[ref: DID log entry]]. | ||
| 4. Remove the [[ref: data integrity]] proof item from the [[ref: DID log entry]]. | ||
| 5. Replace the `versionId` item's value with the literal `"{SCID}"`. |
There was a problem hiding this comment.
Suggested change
| 5. Replace the `versionId` item's value with the literal `"{SCID}"`. | |
| 5. Replace the `versionId` property value with the literal `"{SCID}"`. |
spec/specification.md
Outdated
| @@ -727,28 +724,28 @@ produce an [[ref: entry hash]]. As this is a first entry in a [[ref: DID Log]], | |||
| `entryHash` (first item) is the [[ref: SCID]] of the DID. | |||
There was a problem hiding this comment.
Suggested change
| `entryHash` (first item) is the [[ref: SCID]] of the DID. | |
| `entryHash` (first property) is the [[ref: SCID]] of the DID. |
spec/specification.md
Outdated
| remove from it the version number and dash prefix, leaving the log entry | ||
| `entryHash`. | ||
| `entryHash` value. | ||
| 2. Determine the hash algorithm used by the [[ref: DID Controller]] from the [[ref: multihash]] `entryHash` value. | ||
| - The hash algorithm **MUST** be one listed in the | ||
| [parameters](#didtdw-did-method-parameters) defined by the version of the | ||
| `did:tdw` specification being used by the [[ref: DID Controller]] based on the | ||
| `method` [[ref: parameters]] item set in the current or most recent prior [[ref: log entry]]. |
There was a problem hiding this comment.
Suggested change
| `method` [[ref: parameters]] item set in the current or most recent prior [[ref: log entry]]. | |
| `method` [[ref: parameters]] property set in the current or most recent prior [[ref: log entry]]. |
spec/specification.md
Outdated
| to that generated by the [[ref: DID Controller]], with the [[ref: DIDDoc]] as the signed object, | ||
| the entry log's `versionId` as the challenge, but signed by the [[ref: witnesses]] key. | ||
| witness]] sends a [[ref: Data Integrity]] proof across the [[ref: DID log entry]] to the [[ref: DID Controller]], similar | ||
| to that generated by the [[ref: DID Controller]], but signed by the [[ref: witness]]'s key. | ||
| - When a weighted threshold of proofs are received, the DID Controller | ||
| inserts the [[ref: witnesses]]'s proofs into the array of proofs that are the last item in |
There was a problem hiding this comment.
Suggested change
| inserts the [[ref: witnesses]]'s proofs into the array of proofs that are the last item in | |
| inserts the [[ref: witnesses]]'s proofs into the array of proofs that are the last property in |
There was a problem hiding this comment.
Fixed — adjusted slightly.
Signed-off-by: Stephen Curran <swcurran@gmail.com>
Signed-off-by: Stephen Curran <swcurran@gmail.com>
|
Applied all the changes noted by @martipos and then removed the remaining instances of “item” used in the specification and related files. I had thought that was the right term in JSON. I’ve been using it for a while in many places, so I have now retrained myself! :-) |
Signed-off-by: Stephen Curran <swcurran@gmail.com>
|
Added to the specification that the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Stephen Curran swcurran@gmail.com