diff --git a/index.html b/index.html index 2d8934c..918bfd9 100644 --- a/index.html +++ b/index.html @@ -398,14 +398,16 @@

The did:orb Format

-          did-orb-format        = "did:orb:" cas-discovery-scheme [":" min-graph-cid]
-                                  ":" did-suffix [":" long-form-suffix-data]
-          cas-discovery-scheme  = dht-scheme / webcas-scheme / local-scheme
+          did-orb-format        = "did:orb:" (orb-canonical-did / orb-scheme-did / unpublished-did)
+          orb-canonical-did     = min-graph-cid ":" did-suffix
+          orb-scheme-did        = (dht-scheme / webcas-scheme) ":" orb-canonical-did
+          unpublished-did       = "interim:" (web-interim-scheme / local-interim-scheme)
           dht-scheme            = ( "ipfs" )
           webcas-scheme         = "webcas:" reg-name
-          local-scheme          = "local"
+          web-interim-scheme    = reg-name ":" did-suffix
+          local-interim-scheme  = "local" ":" did-suffix [":" long-form-suffix-data]
           reg-name              = 1*idchar                ; more constrained than [RFC3986]
-          min-graph-cid         = 1*idchar
+          min-graph-cid         = 10*idchar               ; a short 3rd segment is reserved for schemes.
           did-suffix            = 1*idchar
           long-form-suffix-data = 1*idchar                ; only applicable in the local-scheme
         
@@ -415,6 +417,10 @@

The did:orb Format

[[SIDETREE]] provides additional explanation for the did-suffix and long-form-suffix-data elements.

+
+          did:orb:bafkreiatkubvbkdidscmqynkyls3iqawdqvthi7e6mbky2amuw3inxsi3y:EiDyOQbbZAa3aiRzeCkV7LOx3SERjjH93EXoIM3UoN4oWg
+        
+
           did:orb:webcas:example.com:bafkreiatkubvbkdidscmqynkyls3iqawdqvthi7e6mbky2amuw3inxsi3y:EiDyOQbbZAa3aiRzeCkV7LOx3SERjjH93EXoIM3UoN4oWg
         
@@ -424,7 +430,11 @@

The did:orb Format

- TODO: discussion about not including a CAS discovery scheme and the possibility of a DHT profile for Orb. + TODO: discussion about the possibility of a DHT profile for Orb. +

+ +

+ TODO: use an appropriate length to differentiate CID from scheme.

@@ -510,15 +520,15 @@

Propagation Delay and Canonical IDs

This situation typically occurs when there is a need to immediately use a freshly created DID suffix that hasn't yet been propagated.
-            did:orb:local:EiA329wd6Aj36YRmp7NGkeB5ADnVt8ARdMZMPzfXsjwTJA
+            did:orb:interim:local:EiA329wd6Aj36YRmp7NGkeB5ADnVt8ARdMZMPzfXsjwTJA
           
-            did:orb:local:EiA329wd6Aj36YRmp7NGkeB5ADnVt8ARdMZMPzfXsjwTJA:ey...
+            did:orb:interim:local:EiA329wd6Aj36YRmp7NGkeB5ADnVt8ARdMZMPzfXsjwTJA:ey...
           
-            did:orb:webcas:example.com:EiA329wd6Aj36YRmp7NGkeB5ADnVt8ARdMZMPzfXsjwTJA
+            did:orb:interim:example.com:EiA329wd6Aj36YRmp7NGkeB5ADnVt8ARdMZMPzfXsjwTJA
           
When an Orb Server has propagation information for a resolved DID, the server includes the min-graph-cid segment within the canonicalId @@ -530,6 +540,17 @@

Propagation Delay and Canonical IDs

Once the CID is available, resolution responses contain the updated canonicalId property. +
+

CAS Discovery and Equivalent IDs

+ + Orb DIDs support hints to enable a resolver to discover a CAS that is hosting the min-graph-cid in the DID string. + A hint can be added to an Orb DID string by adding a scheme prefix to the CID. + Please see did:orb format for more information about discovery schemes and examples. + These DIDs are treated as equivalent to the canonical DID. + + An Orb resolution response MAY contain an equivalentId property that is populated with orb-scheme-did format DIDs. +
+

Discovery