Skip to content

docs: document deterministic PRISM DID generation - #257

Merged
yshyn-iohk merged 5 commits into
hyperledger-identus:mainfrom
Rahul-2k4:docs-deterministic-prism-did-249
Jun 4, 2026
Merged

docs: document deterministic PRISM DID generation#257
yshyn-iohk merged 5 commits into
hyperledger-identus:mainfrom
Rahul-2k4:docs-deterministic-prism-did-249

Conversation

@Rahul-2k4

Copy link
Copy Markdown
Contributor

Summary

This draft PR adds the deterministic PRISM DID docs requested in #249.

Changes

  • Added documentation/develop/deterministic-did-creation.md
  • Documented mnemonic -> seed -> deterministic DID flow
  • Documented derivation path format: m/29'/29'/did-index'/key-usage'/key-index'
  • Added deterministic test vectors and expected DID outputs
  • Added code snippets for:
    • Cloud Agent API
    • SDK-TS
    • SDK-KMP
    • SDK-Swift
  • Added sidebar entry in documentation/develop/sidebar.ts
  • Linked from documentation/develop/cloud-agent/did-management.md

Validation

  • New page compiles with @mdx-js/mdx (mdx-ok)
  • npm run build in this environment currently fails on an existing upstream submodule MDX file:
    • sdk-ts/docs/decisions/20231110-sdk-package-release.md
    • this is outside the scope of this PR

Closes #249

@Rahul-2k4
Rahul-2k4 marked this pull request as ready for review April 25, 2026 08:11
@Rahul-2k4
Rahul-2k4 requested a review from a team as a code owner April 25, 2026 08:11
Comment thread documentation/develop/deterministic-did-creation.md
Comment thread documentation/develop/deterministic-did-creation.md Outdated

@FabioPinheiro FabioPinheiro left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

You need to have the Signed-off-by: <Name> is not commits for DCO

Signed-off-by: Rahul Tripathi <rahul@Rahuls-Mac-mini.local>
@Rahul-2k4
Rahul-2k4 force-pushed the docs-deterministic-prism-did-249 branch from 7086b82 to 4462511 Compare April 25, 2026 15:40
@Rahul-2k4

Copy link
Copy Markdown
Contributor Author

@FabioPinheiro thanks for the review. I pushed an update with the requested changes.

  • Added an explicit note in the Mnemonic -> DID flow that the master key uses key-usage = 1.
  • Added DCO sign-off to the commit and force-pushed the branch.
  • Removed the Swift snippet for now so we do not document an unverified method name.

@goncalo-frade-iohk could you confirm the intended SDK-Swift API method for deterministic PRISM DID creation? I can add the correct snippet back right away once confirmed.

@Rahul-2k4

Copy link
Copy Markdown
Contributor Author

@FabioPinheiro please do review on this and let me know if this looks good

@Rahul-2k4

Copy link
Copy Markdown
Contributor Author

@yshyn-iohk could you please take a final review on this pr , and do lemme know if any thing can be added .
thank u

yshyn-iohk
yshyn-iohk previously approved these changes May 23, 2026

@yshyn-iohk yshyn-iohk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation is correct, but it won't be implemented across services and SDKs in the Identus Platform because it introduces a partial regression in the current test suites.
At the same time, anyone else can use this deterministic creation in their own solution.

The main aspect is that deterministic DID creation doesn't work with the long-form PRISM DID, as it creates the long-form DID using only the master key (no other keys, services, and verification methods can be added).

@Rahul-2k4

Copy link
Copy Markdown
Contributor Author

Thanks, that makes sense. So the deterministic flow is valid on its own,, but it is not a good fit for Identus Platform right now because long-form PRISM DID creation depends on more than the master key. I appreciate the clarification.

@sonarqubecloud

Copy link
Copy Markdown

1 similar comment
@sonarqubecloud

Copy link
Copy Markdown

@yshyn-iohk

Copy link
Copy Markdown
Contributor

@Rahul-2k4, could you add DCO to your commits?

@Rahul-2k4
Rahul-2k4 force-pushed the docs-deterministic-prism-did-249 branch from 65d14f4 to 81ff078 Compare May 31, 2026 10:25
@Rahul-2k4

Copy link
Copy Markdown
Contributor Author

@yshyn-iohk it's done

@sonarqubecloud

Copy link
Copy Markdown

@yshyn-iohk
yshyn-iohk merged commit b3208db into hyperledger-identus:main Jun 4, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Document deterministic PRISM DID generation

3 participants