feat: resolve did:plc by fforbeck · Pull Request #477 · storacha/w3infra

fforbeck · 2025-05-27T18:58:45Z

DID PLC Resolver

Overview

Created a DID resolver helper to support both Web and PLC DID resolution. The resolver uses an optional options object and has dedicated resolution functions for each DID method that can be easily extended.

Main Changes

Refactored createDidResolver to use optional options object
Added separate resolveDIDWeb and resolveDIDPlc functions
Added proper parsing of PLC verification methods using multikey format

Usage

const resolver = createDidResolver({
  principalMapping, // optional mapping of Web DIDs to DID keys
  plcClient        // optional PLC client for PLC DID resolution
})

// Can also be called with no options
const resolver = createDidResolver()

Related: storacha/project-tracking#463

upload-api/did-resolver.js

alanshaw · 2025-06-11T11:28:47Z

@fforbeck do you want to update the dependencies?

fforbeck · 2025-06-12T16:48:17Z

@fforbeck do you want to update the dependencies?

sure thing @alanshaw - but I need this PR merged and released first: storacha/upload-service#273

alanshaw

I left a few suggestions - would be good to get the options jsdoc changes done but everything else non-blocking :)

alanshaw · 2025-06-19T09:26:19Z

upload-api/did-resolver.js

+    const bytes = base58btc.decode(publicKeyMultibase) // assumes 'z'-prefix
+    const [code] = varint.decode(bytes)
+    switch (code) {
+      case 0xed: { // Ed25519


Suggested change

case 0xed: { // Ed25519

case ed25519.Verifier.code: {

alanshaw · 2025-06-19T09:33:57Z

upload-api/did-resolver.js

+
+
+/**
+ * @typedef {Record<`did:web:${string}`, `did:key:${string}`>} PrincipalMapping


Might be better to use DID<'web'> and DID<'key'> types?

alanshaw · 2025-06-19T09:34:04Z

upload-api/did-resolver.js

+ * @param {object} options
+ * @param {PrincipalMapping} options.principalMapping - Mapping of known WebDIDs to their corresponding DIDKeys
+ * @param {import('@storacha/did-plc').PlcClient} options.plcClient - PLC client to use for resolving PLC DIDs
+ * @returns {(did: `did:${string}:${string}`) => Promise<import('@ucanto/interface').Result<`did:key:${string}`[], DIDResolutionError>>}


Might be better to use DID<'web'> and DID<'key'> types?

alanshaw · 2025-06-19T09:34:34Z

upload-api/did-resolver.js

+ * @param {object} options
+ * @param {PrincipalMapping} options.principalMapping - Mapping of known WebDIDs to their corresponding DIDKeys
+ * @param {import('@storacha/did-plc').PlcClient} options.plcClient - PLC client to use for resolving PLC DIDs


Suggested change

* @param {object} options

* @param {PrincipalMapping} options.principalMapping - Mapping of known WebDIDs to their corresponding DIDKeys

* @param {import('@storacha/did-plc').PlcClient} options.plcClient - PLC client to use for resolving PLC DIDs

* @param {object} [options]

* @param {PrincipalMapping} [options.principalMapping] - Mapping of known WebDIDs to their corresponding DIDKeys

* @param {import('@storacha/did-plc').PlcClient} [options.plcClient] - PLC client to use for resolving PLC DIDs

alanshaw · 2025-06-19T09:34:48Z

upload-api/did-resolver.js

+   * @param {`did:${string}:${string}`} did
+   */
+  return async (did) => {
+    if (Schema.did({ method: 'web' }).is(did) && options.principalMapping) {


Suggested change

if (Schema.did({ method: 'web' }).is(did) && options.principalMapping) {

if (Schema.did({ method: 'web' }).is(did) && options?.principalMapping) {

alanshaw · 2025-06-19T09:34:56Z

upload-api/did-resolver.js

+      return resolveDIDWeb(did, options.principalMapping)
+    }
+
+    if (Schema.did({ method: 'plc' }).is(did) && options.plcClient) {


Suggested change

if (Schema.did({ method: 'plc' }).is(did) && options.plcClient) {

if (Schema.did({ method: 'plc' }).is(did) && options?.plcClient) {

alanshaw · 2025-06-19T09:36:34Z

upload-api/did-resolver.js

+      }
+    }
+  } catch (err) {
+    console.error(`unable to parse public key from verification method ${publicKeyMultibase}`, err)


Still just a warning...

Suggested change

console.error(`unable to parse public key from verification method ${publicKeyMultibase}`, err)

console.warn(`unable to parse public key from verification method ${publicKeyMultibase}`, err)

alanshaw · 2025-06-19T09:40:59Z

upload-api/did-resolver.js

+    const [code] = varint.decode(bytes)
+    switch (code) {
+      case 0xed: { // Ed25519
+        return ed25519.Verifier.parse(publicKeyMultibase)


You return null either way (if it's unsupported or invalid), I'm not sure the complexity is worth it here just to log the right message. I'd just parse and change the log message in the catch to unsupported or invalid verification method: ${publicKeyMultibase}.

alanshaw · 2025-06-19T09:44:10Z

@fforbeck do you want to update the dependencies?

sure thing @alanshaw - but I need this PR merged and released first: storacha/upload-service#273

Hmm, I meant the ucanto dependencies that are referenced as file: here.

feat: resolve did:plc

df749ef

seed-deploy bot had a problem deploying to pr477 May 27, 2025 18:58 Failure

seed-deploy bot had a problem deploying to pr477 May 29, 2025 19:18 Failure

fforbeck self-assigned this May 29, 2025

alanshaw requested changes May 30, 2025

View reviewed changes

feat: resolve did key from did:plc

d730c62

fforbeck force-pushed the feat/did-plc branch from e88c91f to d730c62 Compare May 30, 2025 18:31

seed-deploy bot had a problem deploying to pr477 May 30, 2025 18:31 Failure

fforbeck requested a review from alanshaw May 30, 2025 18:31

fforbeck marked this pull request as ready for review June 2, 2025 12:58

fforbeck mentioned this pull request Jun 9, 2025

Research about did:plc method adoption storacha/project-tracking#462

Closed

alanshaw approved these changes Jun 19, 2025

View reviewed changes

fforbeck mentioned this pull request Jun 19, 2025

Research "Privacy On Storacha" and come up with a plan, or a plan to make a plan storacha/project-tracking#407

Closed



		/**
		* @typedef {Record<`did:web:${string}`, `did:key:${string}`>} PrincipalMapping

	if (Schema.did({ method: 'web' }).is(did) && options.principalMapping) {
	if (Schema.did({ method: 'web' }).is(did) && options?.principalMapping) {

	if (Schema.did({ method: 'plc' }).is(did) && options.plcClient) {
	if (Schema.did({ method: 'plc' }).is(did) && options?.plcClient) {

	console.error(`unable to parse public key from verification method ${publicKeyMultibase}`, err)
	console.warn(`unable to parse public key from verification method ${publicKeyMultibase}`, err)

Conversation

fforbeck commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

DID PLC Resolver

Overview

Main Changes

Usage

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alanshaw commented Jun 11, 2025

Uh oh!

fforbeck commented Jun 12, 2025

Uh oh!

alanshaw left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alanshaw commented Jun 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

fforbeck commented May 27, 2025 •

edited

Loading