@did-btcr2/method 0.63.0 → 0.64.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -0
- package/dist/.tsbuildinfo +1 -1
- package/dist/browser.js +3 -3
- package/dist/browser.mjs +3 -3
- package/dist/cjs/index.js +1080 -847
- package/dist/esm/core/btcr2-update.js +11 -0
- package/dist/esm/core/btcr2-update.js.map +1 -1
- package/dist/esm/core/resolver.js +142 -59
- package/dist/esm/core/resolver.js.map +1 -1
- package/dist/esm/core/updater.js +33 -3
- package/dist/esm/core/updater.js.map +1 -1
- package/dist/esm/did-btcr2.js +53 -20
- package/dist/esm/did-btcr2.js.map +1 -1
- package/dist/esm/utils/appendix.js +39 -2
- package/dist/esm/utils/appendix.js.map +1 -1
- package/dist/esm/utils/error-cause.js +16 -0
- package/dist/esm/utils/error-cause.js.map +1 -0
- package/dist/types/core/btcr2-update.d.ts +15 -8
- package/dist/types/core/btcr2-update.d.ts.map +1 -1
- package/dist/types/core/resolver.d.ts +34 -0
- package/dist/types/core/resolver.d.ts.map +1 -1
- package/dist/types/core/updater.d.ts.map +1 -1
- package/dist/types/did-btcr2.d.ts +24 -3
- package/dist/types/did-btcr2.d.ts.map +1 -1
- package/dist/types/utils/appendix.d.ts +24 -0
- package/dist/types/utils/appendix.d.ts.map +1 -1
- package/dist/types/utils/error-cause.d.ts +16 -0
- package/dist/types/utils/error-cause.d.ts.map +1 -0
- package/package.json +4 -4
- package/src/core/btcr2-update.ts +20 -8
- package/src/core/resolver.ts +174 -74
- package/src/core/updater.ts +41 -3
- package/src/did-btcr2.ts +70 -25
- package/src/utils/appendix.ts +48 -2
- package/src/utils/error-cause.ts +23 -0
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"did-btcr2.js","sourceRoot":"","sources":["../../src/did-btcr2.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,EACpB,WAAW,EACX,WAAW,EACZ,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACL,GAAG,EACH,QAAQ,EACR,YAAY,EACb,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EACL,oCAAoC,EACpC,iCAAiC,EAClC,MAAM,yBAAyB,CAAC;AAYjC;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,UAAU,GAAW,OAAO,CAAC;IAEpC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,CAAC,YAAsC,EAAE,OAA0B;QAC9E,8FAA8F;QAC9F,MAAM,EAAE,MAAM,EAAE,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,SAAS,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QAEnE,IAAG,CAAC,MAAM,EAAE,CAAC;YACX,MAAM,IAAI,WAAW,CACnB,wDAAwD,EACxD,oBAAoB,EAAE,OAAO,CAC9B,CAAC;QACJ,CAAC;QAED,qCAAqC;QACrC,OAAO,UAAU,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,OAAO,CACZ,GAAW,EACX,oBAAuC,EAAE;QAEzC,gCAAgC;QAChC,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAE7C,8BAA8B;QAC9B,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAEpE,0EAA0E;QAC1E,0EAA0E;QAC1E,gDAAgD;QAChD,MAAM,eAAe,GAAG,aAAa,CAAC,GAAG,KAAK,aAAa,CAAC,CAAC;YAC3D,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,aAAa,CAAC;YACvC,CAAC,CAAC,IAAI,CAAC;QAET,oCAAoC;QACpC,OAAO,IAAI,QAAQ,CAAC,aAAa,EAAE,WAAW,EAAE,eAAe,EAAE;YAC/D,SAAS,EAAY,iBAAiB,CAAC,SAAS;YAChD,WAAW,EAAU,iBAAiB,CAAC,WAAW;YAClD,eAAe,EAAM,iBAAiB,CAAC,OAAO,EAAE,eAAe;YAC/D,kBAAkB,EAAG,iBAAiB,CAAC,kBAAkB;YACzD,OAAO,EAAc,iBAAiB,CAAC,OAAO;SAC/C,CAAC,CAAC;IACL,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"did-btcr2.js","sourceRoot":"","sources":["../../src/did-btcr2.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,EACpB,WAAW,EACX,WAAW,EACZ,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACL,GAAG,EACH,QAAQ,EACR,YAAY,EACb,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EACL,oCAAoC,EACpC,iCAAiC,EAClC,MAAM,yBAAyB,CAAC;AAYjC;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,UAAU,GAAW,OAAO,CAAC;IAEpC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,CAAC,YAAsC,EAAE,OAA0B;QAC9E,8FAA8F;QAC9F,MAAM,EAAE,MAAM,EAAE,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,SAAS,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;QAEnE,IAAG,CAAC,MAAM,EAAE,CAAC;YACX,MAAM,IAAI,WAAW,CACnB,wDAAwD,EACxD,oBAAoB,EAAE,OAAO,CAC9B,CAAC;QACJ,CAAC;QAED,qCAAqC;QACrC,OAAO,UAAU,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,OAAO,CACZ,GAAW,EACX,oBAAuC,EAAE;QAEzC,gCAAgC;QAChC,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAE7C,8BAA8B;QAC9B,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAEpE,0EAA0E;QAC1E,0EAA0E;QAC1E,gDAAgD;QAChD,MAAM,eAAe,GAAG,aAAa,CAAC,GAAG,KAAK,aAAa,CAAC,CAAC;YAC3D,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,aAAa,CAAC;YACvC,CAAC,CAAC,IAAI,CAAC;QAET,oCAAoC;QACpC,OAAO,IAAI,QAAQ,CAAC,aAAa,EAAE,WAAW,EAAE,eAAe,EAAE;YAC/D,SAAS,EAAY,iBAAiB,CAAC,SAAS;YAChD,WAAW,EAAU,iBAAiB,CAAC,WAAW;YAClD,eAAe,EAAM,iBAAiB,CAAC,OAAO,EAAE,eAAe;YAC/D,kBAAkB,EAAG,iBAAiB,CAAC,kBAAkB;YACzD,OAAO,EAAc,iBAAiB,CAAC,OAAO;SAC/C,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,MAAM,CAAC,EACZ,cAAc,EACd,OAAO,EACP,eAAe,EACf,oBAAoB,EACpB,QAAQ,GAOT;QACC,uFAAuF;QACvF,sFAAsF;QACtF,iDAAiD;QACjD,IAAG,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,eAAe,GAAG,CAAC,EAAE,CAAC;YAC7D,MAAM,IAAI,WAAW,CACnB,mEAAmE,MAAM,CAAC,eAAe,CAAC,GAAG,EAC7F,kBAAkB,EAAE,EAAE,eAAe,EAAE,CACxC,CAAC;QACJ,CAAC;QAED,uFAAuF;QACvF,uFAAuF;QACvF,yFAAyF;QACzF,yFAAyF;QACzF,kFAAkF;QAClF,mDAAmD;QACnD,MAAM,KAAK,GAAG,QAAQ,CAAC,yBAAyB,CAAC,cAAc,EAAE,oBAAoB,CAAC,CAAC;QACvF,IAAG,KAAK,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,WAAW,CACnB,uEAAuE,EACvE,kBAAkB,EAAE,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,cAAc,CAAC,oBAAoB,EAAE,CACxG,CAAC;QACJ,CAAC;QAED,gFAAgF;QAChF,qDAAqD;QACrD,MAAM,kBAAkB,GAAG,QAAQ,CAAC,yBAAyB,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;QACrF,IAAG,CAAC,kBAAkB,EAAE,CAAC;YACvB,MAAM,IAAI,WAAW,CACnB,4DAA4D,EAC5D,kBAAkB,EAAE,EAAE,oBAAoB,EAAE,CAC7C,CAAC;QACJ,CAAC;QAED,wDAAwD;QACxD,IAAG,kBAAkB,CAAC,IAAI,KAAK,iCAAiC,EAAE,CAAC;YACjE,MAAM,IAAI,WAAW,CACnB,gEAAgE,iCAAiC,GAAG,EACpG,oBAAoB,EAAE,kBAAkB,CACzC,CAAC;QACJ,CAAC;QAED,mDAAmD;QACnD,IAAG,CAAC,kBAAkB,CAAC,kBAAkB,EAAE,UAAU,CAAC,oCAAoC,CAAC,EAAE,CAAC;YAC5F,MAAM,IAAI,WAAW,CACnB,4EAA4E,oCAAoC,GAAG,EACnH,oBAAoB,EAAE,kBAAkB,CACzC,CAAC;QACJ,CAAC;QAED,wFAAwF;QACxF,iFAAiF;QACjF,iFAAiF;QACjF,MAAM,cAAc,GAAG,QAAQ,CAAC,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,EAAE,CAAC,CAAC;QAC5E,MAAM,aAAa,GAAG,cAAc,CAAC,OAAO;aACzC,MAAM,CAAC,CAAC,OAAsB,EAAE,EAAE,CACjC,cAAc,KAAK,SAAS;eACzB,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,EAAE,cAAc,CAAC,EAAE,CAAC,KAAK,cAAc,CAAC;aAC9E,MAAM,CAAC,CAAC,OAAsB,EAA4B,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;aACvE,KAAK,EAAE,CAAC;QAEX,IAAG,CAAC,aAAa,EAAE,CAAC;YAClB,MAAM,IAAI,WAAW,CACnB,+CAA+C,EAC/C,kBAAkB,EAAE,EAAE,cAAc,EAAE,QAAQ,EAAE,CACjD,CAAC;QACJ,CAAC;QAED,uFAAuF;QACvF,sFAAsF;QACtF,OAAO,IAAI,OAAO,CAAC;YACjB,cAAc;YACd,OAAO;YACP,eAAe;YACf,kBAAkB,EAAG,kBAA2C;YAChE,aAAa;SACd,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,UAAU,CAAC,EAChB,cAAc,EACd,eAAe,EACf,oBAAoB,EACpB,QAAQ,GAMT;QACC,OAAO,IAAI,CAAC,MAAM,CAAC;YACjB,cAAc;YACd,OAAO,EAAG,CAAC,EAAE,GAAG,kBAAkB,EAAE,CAAC;YACrC,eAAe;YACf,oBAAoB;YACpB,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,gBAAgB,CAAC,WAA6B,EAAG,QAAiB;QACvE,qEAAqE;QACrE,QAAQ,KAAK,aAAa,CAAC;QAE3B,sCAAsC;QACtC,MAAM,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC5C,IAAI,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC;YACtD,MAAM,IAAI,WAAW,CAAC,yBAAyB,SAAS,CAAC,MAAM,EAAE,EAAE,oBAAoB,EAAE,EAAE,UAAU,EAAE,WAAW,CAAC,EAAE,EAAE,CAAC,CAAC;QAC3H,CAAC;QAED,2FAA2F;QAC3F,0FAA0F;QAC1F,0FAA0F;QAC1F,2FAA2F;QAC3F,MAAM,QAAQ,GAAG,QAAQ,CAAC,cAAc,CAAC,QAAQ,EAAE,WAAW,CAAC,EAAE,CAAC;eAC7D,QAAQ,CAAC,oBAAoB,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;QAErF,oFAAoF;QACpF,gFAAgF;QAChF,yFAAyF;QACzF,mDAAmD;QACnD,MAAM,kBAAkB,GAAG,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC,IAAI,CAC/G,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,EAAE,EAAE,WAAW,CAAC,EAAE,CAAC,KAAK,QAAQ,CAClE,CAAC;QAEF,qDAAqD;QACrD,IAAI,CAAC,CAAC,kBAAkB,IAAI,kBAAkB,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACnE,MAAM,IAAI,QAAQ,CAChB,YAAY,CAAC,aAAa,EAC1B,0FAA0F,CAC3F,CAAC;QACJ,CAAC;QACD,OAAO,kBAA2C,CAAC;IACrD,CAAC"}
|
|
@@ -50,6 +50,42 @@ export class Appendix {
|
|
|
50
50
|
: entry;
|
|
51
51
|
return Appendix.absoluteDidUrl(id, did);
|
|
52
52
|
}
|
|
53
|
+
/**
|
|
54
|
+
* Finds the entry of `document.capabilityInvocation` that identifies `methodId`. A
|
|
55
|
+
* reference entry identifies it when the two DID URLs are equal. An embedded verification
|
|
56
|
+
* method object identifies it when its `id` is equal. Both spellings of a DID URL compare
|
|
57
|
+
* equal, as in {@link relationshipMethodId}. This is the lookup of the specification steps
|
|
58
|
+
* "Check `update.proof`" (the read path) and "Construct BTCR2 Signed Update" (the write
|
|
59
|
+
* path); the caller raises `INVALID_DID_UPDATE` when no entry identifies the method.
|
|
60
|
+
*
|
|
61
|
+
* @param {DidDocument} document The DID document.
|
|
62
|
+
* @param {unknown} methodId The verification method id, absolute or relative. A non-string yields `undefined`.
|
|
63
|
+
* @returns {string | DidVerificationMethod | undefined} The entry, or `undefined` if no entry identifies the id.
|
|
64
|
+
*/
|
|
65
|
+
static capabilityInvocationEntry(document, methodId) {
|
|
66
|
+
const targetId = Appendix.relationshipMethodId(methodId, document.id);
|
|
67
|
+
if (targetId === undefined)
|
|
68
|
+
return undefined;
|
|
69
|
+
return document.capabilityInvocation?.find(entry => Appendix.relationshipMethodId(entry, document.id) === targetId);
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* Returns the verification method that a relationship entry denotes: the object itself
|
|
73
|
+
* when the entry embeds the method, else the member of `document.verificationMethod` whose
|
|
74
|
+
* `id` equals the reference. Both spellings of a DID URL compare equal. The caller raises
|
|
75
|
+
* `INVALID_DID_UPDATE` when a reference names no member.
|
|
76
|
+
*
|
|
77
|
+
* @param {DidDocument} document The DID document.
|
|
78
|
+
* @param {string | DidVerificationMethod} entry The relationship entry: a reference, or an embedded method.
|
|
79
|
+
* @returns {DidVerificationMethod | undefined} The method, or `undefined` if a reference names no member.
|
|
80
|
+
*/
|
|
81
|
+
static verificationMethodOfEntry(document, entry) {
|
|
82
|
+
if (Appendix.isDidVerificationMethod(entry))
|
|
83
|
+
return entry;
|
|
84
|
+
const targetId = Appendix.absoluteDidUrl(entry, document.id);
|
|
85
|
+
if (targetId === undefined)
|
|
86
|
+
return undefined;
|
|
87
|
+
return document.verificationMethod?.find(method => Appendix.absoluteDidUrl(method?.id, document.id) === targetId);
|
|
88
|
+
}
|
|
53
89
|
/**
|
|
54
90
|
* Validates that the given object is a DidVerificationMethod
|
|
55
91
|
* @param {unknown} obj The object to validate
|
|
@@ -183,12 +219,13 @@ export class Appendix {
|
|
|
183
219
|
// 1. Set rootCapability to an empty object.
|
|
184
220
|
const rootCapability = {};
|
|
185
221
|
// 2. Set components to the result of capabilityId.split(":").
|
|
186
|
-
const
|
|
222
|
+
const components = capabilityId.split(':');
|
|
187
223
|
// 3. Validate components:
|
|
188
224
|
// 1. Assert length of components is 4.
|
|
189
|
-
if (
|
|
225
|
+
if (components.length !== 4) {
|
|
190
226
|
throw new DidError(DidErrorCode.InvalidDid, `Invalid capabilityId: ${capabilityId}`);
|
|
191
227
|
}
|
|
228
|
+
const [urn, zcap, root, did] = components;
|
|
192
229
|
// 2. components[0] == urn.
|
|
193
230
|
if (!urn || urn !== 'urn') {
|
|
194
231
|
throw new DidError(DidErrorCode.InvalidDid, `Invalid capabilityId: ${capabilityId}`);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"appendix.js","sourceRoot":"","sources":["../../../src/utils/appendix.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,QAAQ,EACR,YAAY,EACZ,2BAA2B,EAC5B,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAGrD;;;;;GAKG;AACH,MAAM,OAAO,QAAQ;IACnB;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,cAAc,CAAC,KAAc,EAAE,GAAW;QACtD,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,SAAS,CAAC;QAChD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;QACzC,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,MAAM,CAAC,oBAAoB,CAAC,KAAc,EAAE,GAAW;QAC5D,MAAM,EAAE,GAAG,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC/E,CAAC,CAAE,KAA0B,CAAC,EAAE;YAChC,CAAC,CAAC,KAAK,CAAC;QACV,OAAO,QAAQ,CAAC,cAAc,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,uBAAuB,CAAC,GAAY;QAChD,8CAA8C;QAC9C,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI;YAAE,OAAO,KAAK,CAAC;QAElE,oFAAoF;QACpF,IAAI,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,IAAI,YAAY,IAAI,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QAEzE,IAAI,OAAO,GAAG,CAAC,EAAE,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC7C,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC/C,IAAI,OAAO,GAAG,CAAC,UAAU,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,GAAY;QACrC,8CAA8C;QAC9C,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI;YAAE,OAAO,KAAK,CAAC;QAClE,yEAAyE;QACzE,IAAI,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,IAAI,iBAAiB,IAAI,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QAC9E,IAAI,OAAO,GAAG,CAAC,EAAE,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC7C,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC/C,IAAI,OAAO,GAAG,CAAC,eAAe,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,sBAAsB,CAAC,WAAwB;QAC3D,IAAI,CAAC,WAAW;YAAE,MAAM,IAAI,gBAAgB,CAAC,2CAA2C,CAAC,CAAC;QAC1F,MAAM,mBAAmB,GAA4B,EAAE,CAAC;QACxD,wCAAwC;QACxC,mBAAmB,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,kBAAkB,EAAE,MAAM,CAAC,QAAQ,CAAC,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC;QAC5G,gFAAgF;QAChF,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YAChE,mBAAmB,CAAC,IAAI,CACtB,GAAI,WAAW,CAAC,YAAiC,CAA+B;gBAC9E,EAAE,MAAM,CAAC,QAAQ,CAAC,uBAAuB,CAAC,IAAI,EAAE,CACnD,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,OAAO,mBAA8C,CAAC;IACxD,CAAC;IAGD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,oBAAoB,CAAC,UAAkB;QAC5C,OAAO;YACL,UAAU,EAAS,0BAA0B;YAC7C,EAAE,EAAiB,iBAAiB,kBAAkB,CAAC,UAAU,CAAC,EAAE;YACpE,UAAU,EAAS,UAAU;YAC7B,gBAAgB,EAAG,UAAU;SAC9B,CAAC;IACJ,CAAC;IAGD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACI,MAAM,CAAC,iBAAiB,CAAC,YAAoB;QAClD,4CAA4C;QAC5C,MAAM,cAAc,GAAG,EAAoB,CAAC;QAE5C,8DAA8D;QAC9D,MAAM,
|
|
1
|
+
{"version":3,"file":"appendix.js","sourceRoot":"","sources":["../../../src/utils/appendix.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,QAAQ,EACR,YAAY,EACZ,2BAA2B,EAC5B,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAGrD;;;;;GAKG;AACH,MAAM,OAAO,QAAQ;IACnB;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,cAAc,CAAC,KAAc,EAAE,GAAW;QACtD,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,SAAS,CAAC;QAChD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;QACzC,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,MAAM,CAAC,oBAAoB,CAAC,KAAc,EAAE,GAAW;QAC5D,MAAM,EAAE,GAAG,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC/E,CAAC,CAAE,KAA0B,CAAC,EAAE;YAChC,CAAC,CAAC,KAAK,CAAC;QACV,OAAO,QAAQ,CAAC,cAAc,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,yBAAyB,CACrC,QAAqB,EACrB,QAAiB;QAEjB,MAAM,QAAQ,GAAG,QAAQ,CAAC,oBAAoB,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;QACtE,IAAI,QAAQ,KAAK,SAAS;YAAE,OAAO,SAAS,CAAC;QAC7C,OAAO,QAAQ,CAAC,oBAAoB,EAAE,IAAI,CACxC,KAAK,CAAC,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,CAAC,KAAK,QAAQ,CACxE,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,yBAAyB,CACrC,QAAqB,EACrB,KAAqC;QAErC,IAAI,QAAQ,CAAC,uBAAuB,CAAC,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC;QAC1D,MAAM,QAAQ,GAAG,QAAQ,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;QAC7D,IAAI,QAAQ,KAAK,SAAS;YAAE,OAAO,SAAS,CAAC;QAC7C,OAAO,QAAQ,CAAC,kBAAkB,EAAE,IAAI,CACtC,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,EAAE,QAAQ,CAAC,EAAE,CAAC,KAAK,QAAQ,CACxE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,uBAAuB,CAAC,GAAY;QAChD,8CAA8C;QAC9C,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI;YAAE,OAAO,KAAK,CAAC;QAElE,oFAAoF;QACpF,IAAI,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,IAAI,YAAY,IAAI,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QAEzE,IAAI,OAAO,GAAG,CAAC,EAAE,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC7C,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC/C,IAAI,OAAO,GAAG,CAAC,UAAU,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,GAAY;QACrC,8CAA8C;QAC9C,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI;YAAE,OAAO,KAAK,CAAC;QAClE,yEAAyE;QACzE,IAAI,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,IAAI,iBAAiB,IAAI,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QAC9E,IAAI,OAAO,GAAG,CAAC,EAAE,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC7C,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC/C,IAAI,OAAO,GAAG,CAAC,eAAe,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,sBAAsB,CAAC,WAAwB;QAC3D,IAAI,CAAC,WAAW;YAAE,MAAM,IAAI,gBAAgB,CAAC,2CAA2C,CAAC,CAAC;QAC1F,MAAM,mBAAmB,GAA4B,EAAE,CAAC;QACxD,wCAAwC;QACxC,mBAAmB,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,kBAAkB,EAAE,MAAM,CAAC,QAAQ,CAAC,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC;QAC5G,gFAAgF;QAChF,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YAChE,mBAAmB,CAAC,IAAI,CACtB,GAAI,WAAW,CAAC,YAAiC,CAA+B;gBAC9E,EAAE,MAAM,CAAC,QAAQ,CAAC,uBAAuB,CAAC,IAAI,EAAE,CACnD,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,OAAO,mBAA8C,CAAC;IACxD,CAAC;IAGD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,oBAAoB,CAAC,UAAkB;QAC5C,OAAO;YACL,UAAU,EAAS,0BAA0B;YAC7C,EAAE,EAAiB,iBAAiB,kBAAkB,CAAC,UAAU,CAAC,EAAE;YACpE,UAAU,EAAS,UAAU;YAC7B,gBAAgB,EAAG,UAAU;SAC9B,CAAC;IACJ,CAAC;IAGD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACI,MAAM,CAAC,iBAAiB,CAAC,YAAoB;QAClD,4CAA4C;QAC5C,MAAM,cAAc,GAAG,EAAoB,CAAC;QAE5C,8DAA8D;QAC9D,MAAM,UAAU,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE3C,0BAA0B;QAC1B,0CAA0C;QAC1C,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,UAAU,EAAE,yBAAyB,YAAY,EAAE,CAAC,CAAC;QACvF,CAAC;QACD,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,GAAG,UAAU,CAAC;QAE1C,8BAA8B;QAC9B,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,KAAK,EAAE,CAAC;YAC1B,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,UAAU,EAAE,yBAAyB,YAAY,EAAE,CAAC,CAAC;QACvF,CAAC;QAED,+BAA+B;QAC/B,IAAI,CAAC,IAAI,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;YAC7B,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,UAAU,EAAE,yBAAyB,YAAY,EAAE,CAAC,CAAC;QACvF,CAAC;QAED,+BAA+B;QAC/B,IAAI,CAAC,IAAI,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;YAC7B,MAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,UAAU,EAAE,yBAAyB,YAAY,EAAE,CAAC,CAAC;QACvF,CAAC;QAED,wCAAwC;QACxC,MAAM,YAAY,GAAG,GAAG,CAAC;QAEzB,oEAAoE;QACpE,MAAM,UAAU,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAAC;QAEpD,4CAA4C;QAC5C,cAAc,CAAC,EAAE,GAAG,YAAY,CAAC;QAEjC,kDAAkD;QAClD,cAAc,CAAC,UAAU,GAAG,UAAU,CAAC;QAEvC,wDAAwD;QACxD,cAAc,CAAC,gBAAgB,GAAG,UAAU,CAAC;QAE7C,4BAA4B;QAC5B,OAAO,cAAc,CAAC;IACxB,CAAC;CACF"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { DidMethodError } from '@did-btcr2/common';
|
|
2
|
+
/**
|
|
3
|
+
* Describe an inner error for the `data.cause` of a wrapping typed error. The update paths
|
|
4
|
+
* raise `INVALID_DID_UPDATE` for every failure that the specification names; the inner error
|
|
5
|
+
* of the cryptosuite, the multikey, the hash decoder, or the common package rides along here.
|
|
6
|
+
* @param {unknown} error The inner error.
|
|
7
|
+
* @returns {ErrorCause} The type and the message of the inner error.
|
|
8
|
+
*/
|
|
9
|
+
export function errorCause(error) {
|
|
10
|
+
if (error instanceof DidMethodError)
|
|
11
|
+
return { type: error.type, message: error.message };
|
|
12
|
+
if (error instanceof Error)
|
|
13
|
+
return { type: error.name, message: error.message };
|
|
14
|
+
return { type: 'unknown', message: String(error) };
|
|
15
|
+
}
|
|
16
|
+
//# sourceMappingURL=error-cause.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"error-cause.js","sourceRoot":"","sources":["../../../src/utils/error-cause.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAWnD;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,KAAc;IACvC,IAAG,KAAK,YAAY,cAAc;QAAE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;IACxF,IAAG,KAAK,YAAY,KAAK;QAAE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;IAC/E,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;AACrD,CAAC"}
|
|
@@ -19,6 +19,13 @@ export declare const BTCR2_UPDATE_CONTEXT: readonly ["https://w3id.org/json-ld-p
|
|
|
19
19
|
* @returns {boolean} True if the two arrays are equal.
|
|
20
20
|
*/
|
|
21
21
|
export declare function isBtcr2UpdateContext(value: unknown, expected?: readonly string[]): value is string[];
|
|
22
|
+
/**
|
|
23
|
+
* The JSON Patch operation of the Deactivate operation: it adds the `deactivated` property
|
|
24
|
+
* with the value `true`. Deactivate is the Update operation with this predetermined patch, and
|
|
25
|
+
* resolution stops at the deactivation for good. See
|
|
26
|
+
* {@link https://dcdpr.github.io/did-btcr2/operations/deactivate.html | Deactivate}.
|
|
27
|
+
*/
|
|
28
|
+
export declare const DEACTIVATION_PATCH: Readonly<PatchOperation>;
|
|
22
29
|
/**
|
|
23
30
|
* A {@link https://dcdpr.github.io/did-btcr2/terminology.html#btcr2-update | BTCR2 Update} without a data integrity proof.
|
|
24
31
|
* See {@link https://dcdpr.github.io/did-btcr2/data-structures.html#btcr2-unsigned-update | BTCR2 Unsigned Update (data structure)}.
|
|
@@ -63,10 +70,10 @@ export type UnsignedBTCR2Update = {
|
|
|
63
70
|
* ZCAP capability-invocation fields a did:btcr2 update proof carries.
|
|
64
71
|
*/
|
|
65
72
|
export type Btcr2DataIntegrityProof = DataIntegrityProofObject & {
|
|
66
|
-
/** The root capability being invoked
|
|
67
|
-
capability
|
|
68
|
-
/** The action performed under the capability
|
|
69
|
-
capabilityAction
|
|
73
|
+
/** The root capability being invoked: `urn:zcap:root:${encodeURIComponent(did)}`. */
|
|
74
|
+
capability: string;
|
|
75
|
+
/** The action performed under the capability: `"Write"` for a DID document update. */
|
|
76
|
+
capabilityAction: string;
|
|
70
77
|
};
|
|
71
78
|
/**
|
|
72
79
|
* A {@link https://dcdpr.github.io/did-btcr2/terminology.html#btcr2-signed-update | BTCR2 Update} with a data integrity proof.
|
|
@@ -87,9 +94,9 @@ export type BTCR2Update = UnsignedBTCR2Update | SignedBTCR2Update;
|
|
|
87
94
|
export type Btcr2DataIntegrityConfig = DataIntegrityProofOptions & {
|
|
88
95
|
/** The same array as the update `@context`: {@link BTCR2_UPDATE_CONTEXT}. */
|
|
89
96
|
'@context': string[];
|
|
90
|
-
/** The root capability being invoked
|
|
91
|
-
capability
|
|
92
|
-
/** The action performed under the capability
|
|
93
|
-
capabilityAction
|
|
97
|
+
/** The root capability being invoked: `urn:zcap:root:${encodeURIComponent(did)}`. */
|
|
98
|
+
capability: string;
|
|
99
|
+
/** The action performed under the capability: `"Write"` for a DID document update. */
|
|
100
|
+
capabilityAction: string;
|
|
94
101
|
};
|
|
95
102
|
//# sourceMappingURL=btcr2-update.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"btcr2-update.d.ts","sourceRoot":"","sources":["../../../src/core/btcr2-update.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,KAAK,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAElG;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,2JAKtB,CAAC;AAEZ;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,OAAO,EACd,QAAQ,GAAE,SAAS,MAAM,EAAyB,GACjD,KAAK,IAAI,MAAM,EAAE,CAInB;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;OAGG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB;;;;OAIG;IACH,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAE7B;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,wBAAwB,GAAG;IAC/D,
|
|
1
|
+
{"version":3,"file":"btcr2-update.d.ts","sourceRoot":"","sources":["../../../src/core/btcr2-update.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,KAAK,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAElG;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,2JAKtB,CAAC;AAEZ;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,OAAO,EACd,QAAQ,GAAE,SAAS,MAAM,EAAyB,GACjD,KAAK,IAAI,MAAM,EAAE,CAInB;AAED;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,EAAE,QAAQ,CAAC,cAAc,CAItD,CAAC;AAEH;;;;;;;;GAQG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;OAGG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB;;;;OAIG;IACH,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAE7B;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,wBAAwB,GAAG;IAC/D,qFAAqF;IACrF,UAAU,EAAE,MAAM,CAAC;IAEnB,sFAAsF;IACtF,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,mBAAmB,GAAG;IACpD,sFAAsF;IACtF,KAAK,EAAE,uBAAuB,CAAC;CAChC,CAAC;AAEF,qCAAqC;AACrC,MAAM,MAAM,WAAW,GAAG,mBAAmB,GAAG,iBAAiB,CAAC;AAElE;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,GAAG,yBAAyB,GAAG;IACjE,6EAA6E;IAC7E,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB,qFAAqF;IACrF,UAAU,EAAE,MAAM,CAAC;IAEnB,sFAAsF;IACtF,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC"}
|
|
@@ -156,11 +156,45 @@ export declare class Resolver {
|
|
|
156
156
|
* @returns {void} Does not return a value, but throws an error if the update is not a valid duplicate.
|
|
157
157
|
*/
|
|
158
158
|
private static confirmDuplicate;
|
|
159
|
+
/**
|
|
160
|
+
* Decode a hash of a BTCR2 Update (`sourceHash` or `targetHash`). The specification encodes
|
|
161
|
+
* both with base64url without padding.
|
|
162
|
+
* @param {unknown} value The encoded hash.
|
|
163
|
+
* @param {'sourceHash' | 'targetHash'} field The name of the field, for the error.
|
|
164
|
+
* @returns {HashBytes} The decoded bytes.
|
|
165
|
+
* @throws {ResolveError} `INVALID_DID_UPDATE` if the value is not a string or does not decode.
|
|
166
|
+
*/
|
|
167
|
+
private static decodeUpdateHash;
|
|
168
|
+
/**
|
|
169
|
+
* Parse a `created` or `expires` value of an update proof. Data Integrity types both as an
|
|
170
|
+
* XML Schema `dateTimeStamp`: an XML Datetime with a timezone. A value without a timezone
|
|
171
|
+
* names no fixed instant, so two resolvers would read two instants; it is rejected.
|
|
172
|
+
* @param {Btcr2DataIntegrityProof} proof The update proof.
|
|
173
|
+
* @param {'created' | 'expires'} field The field to parse.
|
|
174
|
+
* @returns {number | undefined} The instant in milliseconds since the Unix epoch, or `undefined` when the field is absent.
|
|
175
|
+
* @throws {ResolveError} `INVALID_DID_UPDATE` for a value that is not an XML Datetime with a timezone.
|
|
176
|
+
*/
|
|
177
|
+
private static proofInstant;
|
|
178
|
+
/**
|
|
179
|
+
* Spec "Check `update.proof`": the proof time window against the block that contains the
|
|
180
|
+
* Beacon Signal. `created` must not be after the header time of the block: a controller
|
|
181
|
+
* signs a short time before the block, and on mainnet the header time is about one hour
|
|
182
|
+
* after the `mediantime`. `expires` must not be before the block `mediantime`: it limits a
|
|
183
|
+
* replay, and a single miner cannot change `mediantime`. `expires` must not be before
|
|
184
|
+
* `created`. Each comparison has no tolerance.
|
|
185
|
+
* @param {Btcr2DataIntegrityProof} proof The update proof.
|
|
186
|
+
* @param {BlockMetadata} block The block of the Beacon Signal.
|
|
187
|
+
* @throws {ResolveError} `INVALID_DID_UPDATE` if a value is outside the window.
|
|
188
|
+
*/
|
|
189
|
+
private static checkProofWindow;
|
|
159
190
|
/**
|
|
160
191
|
* Implements subsection {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#apply-update | Apply update}
|
|
161
192
|
* and its step {@link https://dcdpr.github.io/did-btcr2/operations/resolve.html#check-update-proof | Check update.proof}.
|
|
193
|
+
* Every failure that the specification names raises `INVALID_DID_UPDATE`. An error of the
|
|
194
|
+
* cryptosuite, the multikey, the hash decoder, or the patch rides along as `data.cause`.
|
|
162
195
|
* @param {DidDocument} currentDocument The current DID Document to apply the update to.
|
|
163
196
|
* @param {SignedBTCR2Update} update The BTCR2 Signed Update to apply.
|
|
197
|
+
* @param {BlockMetadata} block The block that contains the Beacon Signal that announced the update.
|
|
164
198
|
* @returns {DidDocument} The updated DID Document after applying the update.
|
|
165
199
|
* @throws {ResolveError} `INVALID_DID_UPDATE` if the update is invalid or cannot be applied.
|
|
166
200
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"resolver.d.ts","sourceRoot":"","sources":["../../../src/core/resolver.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"resolver.d.ts","sourceRoot":"","sources":["../../../src/core/resolver.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAEV,iBAAiB,EAElB,MAAM,mBAAmB,CAAC;AAS3B,OAAO,EAAE,WAAW,EAAwB,MAAM,0BAA0B,CAAC;AAG7E,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEzF,OAAO,KAAK,EAAE,aAAa,EAAC,MAAM,iBAAiB,CAAC;AAEpD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGxE;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,IAAI,CAAC;AAElC;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,WAAW,CAAC;IACzB,QAAQ,EAAE;QACR;;;WAGG;QACH,aAAa,EAAE,MAAM,CAAC;QACtB,0GAA0G;QAC1G,SAAS,EAAE,MAAM,CAAC;QAClB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,oDAAoD;QACpD,WAAW,EAAE,OAAO,CAAC;KACtB,CAAA;CACF;AAED,4EAA4E;AAC5E,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE,qBAAqB,CAAC;IACrC,uEAAuE;IACvE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED,4EAA4E;AAC5E,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC;IACnC,yFAAyF;IACzF,QAAQ,CAAC,cAAc,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;CACvD;AAED,2FAA2F;AAC3F,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,IAAI,EAAE,qBAAqB,CAAC;IACrC,0DAA0D;IAC1D,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,oDAAoD;IACpD,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;CAClC;AAED,sFAAsF;AACtF,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAClC,uDAAuD;IACvD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,oDAAoD;IACpD,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;CAClC;AAED,2EAA2E;AAC3E,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;IAC9B,+DAA+D;IAC/D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,oDAAoD;IACpD,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;CAClC;AAED,gFAAgF;AAChF,MAAM,MAAM,QAAQ,GAAG,mBAAmB,GAAG,iBAAiB,GAAG,mBAAmB,GAAG,gBAAgB,GAAG,YAAY,CAAC;AAEvH;;;GAGG;AACH,MAAM,MAAM,aAAa,GACrB;IAAE,MAAM,EAAE,iBAAiB,CAAC;IAAC,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAA;CAAE,GAC7D;IAAE,MAAM,EAAE,UAAU,CAAC;IAAC,MAAM,EAAE,qBAAqB,CAAA;CAAE,CAAC;AAE1D;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,KAAK,CAAC,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC,CAAC;IACnD,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;CACxB;AAyHD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,QAAQ;;IA6DnB;;OAEG;gBAED,aAAa,EAAE,aAAa,EAC5B,WAAW,EAAE,WAAW,EACxB,eAAe,EAAE,WAAW,GAAG,IAAI,EACnC,OAAO,CAAC,EAAE;QACR,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAmCH;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,aAAa,EAAE,aAAa,GAAG,WAAW;IA8B/D;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CACb,aAAa,EAAE,aAAa,EAC5B,eAAe,EAAE,MAAM,GACtB,WAAW;IA4Bd;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,OAAO,GAAE,OAAuB,GAAG,WAAW;IA0BjE;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IA+C/B;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAc/B;;;;;;;;OAQG;IACH,OAAO,CAAC,MAAM,CAAC,YAAY;IAa3B;;;;;;;;;;OAUG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAuB/B;;;;;;;;;;OAUG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IA2J1B;;;;;;OAMG;IACH,OAAO,IAAI,aAAa;IAiRxB;;;;;;;;OAQG;IACH,OAAO,CAAC,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IACtD,OAAO,CAAC,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,GAAG,CAAC,aAAa,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,GAAG,IAAI;IACrF,OAAO,CAAC,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,eAAe,GAAG,IAAI;IAC/D,OAAO,CAAC,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,iBAAiB,GAAG,IAAI;IAC9D,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,GAAG,IAAI;CAuFlD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"updater.d.ts","sourceRoot":"","sources":["../../../src/core/updater.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAGxD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EAA4B,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAE1G,OAAO,EAAe,KAAK,gBAAgB,EAAE,KAAK,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;
|
|
1
|
+
{"version":3,"file":"updater.d.ts","sourceRoot":"","sources":["../../../src/core/updater.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAGxD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EAA4B,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAE1G,OAAO,EAAe,KAAK,gBAAgB,EAAE,KAAK,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAE1G,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAElE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAI5D;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,8DAA8D;IAC9D,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;IACtC,+CAA+C;IAC/C,QAAQ,CAAC,cAAc,EAAE,mBAAmB,CAAC;CAC9C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,yEAAyE;IACzE,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,kDAAkD;IAClD,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;CACvC;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,yFAAyF;IACzF,SAAS,EAAE,MAAM,CAAC;IAClB,6DAA6D;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IAC/B,gGAAgG;IAChG,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IACtC,6CAA6C;IAC7C,QAAQ,CAAC,YAAY,EAAE,iBAAiB,CAAC;IACzC;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB;AAED,qFAAqF;AACrF,MAAM,MAAM,eAAe,GAAG,cAAc,GAAG,WAAW,GAAG,aAAa,CAAC;AAE3E;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,qEAAqE;IACrE,YAAY,EAAE,iBAAiB,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,GACpB;IAAE,MAAM,EAAE,iBAAiB,CAAC;IAAC,KAAK,EAAE,aAAa,CAAC,eAAe,CAAC,CAAA;CAAE,GACpE;IAAE,MAAM,EAAE,UAAU,CAAC;IAAC,MAAM,EAAE,aAAa,CAAA;CAAE,CAAC;AAgBlD;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,cAAc,EAAE,gBAAgB,CAAC;IACjC,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC;IACxB,kBAAkB,EAAE,qBAAqB,CAAC;IAC1C,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,qBAAa,OAAO;;IAQlB;;OAEG;gBACS,MAAM,EAAE,aAAa;IAYjC;;;;;;;;OAQG;IACH,MAAM,CAAC,SAAS,CACd,cAAc,EAAE,gBAAgB,EAChC,OAAO,EAAE,cAAc,EAAE,EACzB,eAAe,EAAE,MAAM,GACtB,mBAAmB;IAgDtB;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,CACT,GAAG,EAAE,MAAM,EACX,cAAc,EAAE,mBAAmB,EACnC,kBAAkB,EAAE,qBAAqB,EACzC,MAAM,EAAE,MAAM,GACb,iBAAiB;IA4FpB;;;;;;;;;;;;;;;OAeG;WACU,QAAQ,CACnB,aAAa,EAAE,aAAa,EAC5B,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,eAAe,CAAC;IAa3B;;;;OAIG;IACH,OAAO,IAAI,YAAY;IAkEvB;;;;;;OAMG;IACH,OAAO,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IACjD,OAAO,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,CAAC,EAAE,YAAY,GAAG,IAAI;IACtD,OAAO,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI;CAkEnC"}
|
|
@@ -88,9 +88,11 @@ export declare class DidBtcr2 implements DidMethod {
|
|
|
88
88
|
* @param {string} params.verificationMethodId The verification method ID to sign with.
|
|
89
89
|
* @param {string} params.beaconId The beacon service ID to broadcast through.
|
|
90
90
|
* @returns {Updater} A sans-I/O state machine for driving the update.
|
|
91
|
-
* @throws {UpdateError}
|
|
92
|
-
*
|
|
93
|
-
*
|
|
91
|
+
* @throws {UpdateError} `INVALID_DID_UPDATE` if `sourceVersionId` is not an integer of at
|
|
92
|
+
* least 1, if no entry of `capabilityInvocation` identifies the verification method, if a
|
|
93
|
+
* reference entry names no member of `verificationMethod`, or if the beacon service is not
|
|
94
|
+
* found. `INVALID_DID_DOCUMENT` if the method is not of type `Multikey` or does not have a
|
|
95
|
+
* `zQ3s` publicKeyMultibase prefix.
|
|
94
96
|
*/
|
|
95
97
|
static update({ sourceDocument, patches, sourceVersionId, verificationMethodId, beaconId, }: {
|
|
96
98
|
sourceDocument: Btcr2DidDocument;
|
|
@@ -99,6 +101,25 @@ export declare class DidBtcr2 implements DidMethod {
|
|
|
99
101
|
verificationMethodId: string;
|
|
100
102
|
beaconId: string;
|
|
101
103
|
}): Updater;
|
|
104
|
+
/**
|
|
105
|
+
* Entry point for section {@link https://dcdpr.github.io/did-btcr2/operations/deactivate.html | 7.4 Deactivate}.
|
|
106
|
+
*
|
|
107
|
+
* Deactivate is the Update operation with the predetermined patch {@link DEACTIVATION_PATCH}:
|
|
108
|
+
* it adds the `deactivated` property with the value `true`. The factory returns the
|
|
109
|
+
* {@link Updater} that {@link DidBtcr2.update} returns for that patch, and the caller drives
|
|
110
|
+
* it in the same way. Resolution stops at the deactivation for good. The factory does not
|
|
111
|
+
* refuse a source document that is deactivated already; the api does (ADR 100).
|
|
112
|
+
*
|
|
113
|
+
* @param params Deactivation parameters: the parameters of {@link DidBtcr2.update} without `patches`.
|
|
114
|
+
* @returns {Updater} A sans-I/O state machine for driving the deactivation.
|
|
115
|
+
* @throws {UpdateError} As {@link DidBtcr2.update}.
|
|
116
|
+
*/
|
|
117
|
+
static deactivate({ sourceDocument, sourceVersionId, verificationMethodId, beaconId, }: {
|
|
118
|
+
sourceDocument: Btcr2DidDocument;
|
|
119
|
+
sourceVersionId: number;
|
|
120
|
+
verificationMethodId: string;
|
|
121
|
+
beaconId: string;
|
|
122
|
+
}): Updater;
|
|
102
123
|
/**
|
|
103
124
|
* Given the W3C DID Document of a `did:btcr2` identifier, return the signing verification method that will be used
|
|
104
125
|
* for signing messages and credentials. If given, the `methodId` parameter is used to select the
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"did-btcr2.d.ts","sourceRoot":"","sources":["../../src/did-btcr2.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,QAAQ,EACR,cAAc,EAAC,MAAM,mBAAmB,CAAC;AAS3C,OAAO,KAAK,EACV,SAAS,EAAC,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"did-btcr2.d.ts","sourceRoot":"","sources":["../../src/did-btcr2.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,QAAQ,EACR,cAAc,EAAC,MAAM,mBAAmB,CAAC;AAS3C,OAAO,KAAK,EACV,SAAS,EAAC,MAAM,YAAY,CAAC;AAS/B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAM5C,OAAO,KAAK,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEvF,MAAM,WAAW,gBAAgB;IAC/B,qDAAqD;IACrD,MAAM,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sBAAsB;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,QAAS,YAAW,SAAS;IACxC;;OAEG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,CAAW;IAEpC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,QAAQ,GAAG,aAAa,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,MAAM;IAezF;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,OAAO,CACZ,GAAG,EAAE,MAAM,EACX,iBAAiB,GAAE,iBAAsB,GACxC,QAAQ;IAwBX;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM,CAAC,MAAM,CAAC,EACZ,cAAc,EACd,OAAO,EACP,eAAe,EACf,oBAAoB,EACpB,QAAQ,GACT,EAAE;QACD,cAAc,EAAE,gBAAgB,CAAC;QACjC,OAAO,EAAE,cAAc,EAAE,CAAC;QAC1B,eAAe,EAAE,MAAM,CAAC;QACxB,oBAAoB,EAAE,MAAM,CAAC;QAC7B,QAAQ,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO;IAgFX;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,UAAU,CAAC,EAChB,cAAc,EACd,eAAe,EACf,oBAAoB,EACpB,QAAQ,GACT,EAAE;QACD,cAAc,EAAE,gBAAgB,CAAC;QACjC,eAAe,EAAE,MAAM,CAAC;QACxB,oBAAoB,EAAE,MAAM,CAAC;QAC7B,QAAQ,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO;IAUX;;;;;;;;;OASG;IACH,MAAM,CAAC,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,EAAG,QAAQ,CAAC,EAAE,MAAM,GAAG,qBAAqB;CAkClG"}
|
|
@@ -39,6 +39,30 @@ export declare class Appendix {
|
|
|
39
39
|
* @returns {string | undefined} The absolute DID URL, or `undefined` if unusable.
|
|
40
40
|
*/
|
|
41
41
|
static relationshipMethodId(entry: unknown, did: string): string | undefined;
|
|
42
|
+
/**
|
|
43
|
+
* Finds the entry of `document.capabilityInvocation` that identifies `methodId`. A
|
|
44
|
+
* reference entry identifies it when the two DID URLs are equal. An embedded verification
|
|
45
|
+
* method object identifies it when its `id` is equal. Both spellings of a DID URL compare
|
|
46
|
+
* equal, as in {@link relationshipMethodId}. This is the lookup of the specification steps
|
|
47
|
+
* "Check `update.proof`" (the read path) and "Construct BTCR2 Signed Update" (the write
|
|
48
|
+
* path); the caller raises `INVALID_DID_UPDATE` when no entry identifies the method.
|
|
49
|
+
*
|
|
50
|
+
* @param {DidDocument} document The DID document.
|
|
51
|
+
* @param {unknown} methodId The verification method id, absolute or relative. A non-string yields `undefined`.
|
|
52
|
+
* @returns {string | DidVerificationMethod | undefined} The entry, or `undefined` if no entry identifies the id.
|
|
53
|
+
*/
|
|
54
|
+
static capabilityInvocationEntry(document: DidDocument, methodId: unknown): string | DidVerificationMethod | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* Returns the verification method that a relationship entry denotes: the object itself
|
|
57
|
+
* when the entry embeds the method, else the member of `document.verificationMethod` whose
|
|
58
|
+
* `id` equals the reference. Both spellings of a DID URL compare equal. The caller raises
|
|
59
|
+
* `INVALID_DID_UPDATE` when a reference names no member.
|
|
60
|
+
*
|
|
61
|
+
* @param {DidDocument} document The DID document.
|
|
62
|
+
* @param {string | DidVerificationMethod} entry The relationship entry: a reference, or an embedded method.
|
|
63
|
+
* @returns {DidVerificationMethod | undefined} The method, or `undefined` if a reference names no member.
|
|
64
|
+
*/
|
|
65
|
+
static verificationMethodOfEntry(document: DidDocument, entry: string | DidVerificationMethod): DidVerificationMethod | undefined;
|
|
42
66
|
/**
|
|
43
67
|
* Validates that the given object is a DidVerificationMethod
|
|
44
68
|
* @param {unknown} obj The object to validate
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"appendix.d.ts","sourceRoot":"","sources":["../../../src/utils/appendix.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,UAAU,EACV,qBAAqB,EAAC,MAAM,YAAY,CAAC;AAO3C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;;;;GAKG;AACH,qBAAa,QAAQ;IACnB;;;;;;;;;;;OAWG;WACW,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAM7E;;;;;;;;;;;;;;;;;OAiBG;WACW,oBAAoB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAOnF;;;;OAIG;WACW,uBAAuB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,qBAAqB;IAcjF;;;;OAIG;WACW,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,UAAU;IAW3D;;;;;OAKG;WACW,sBAAsB,CAAC,WAAW,EAAE,WAAW,GAAG,qBAAqB,EAAE;IAgBvF;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,cAAc;IAU/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;WACW,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,cAAc;
|
|
1
|
+
{"version":3,"file":"appendix.d.ts","sourceRoot":"","sources":["../../../src/utils/appendix.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,UAAU,EACV,qBAAqB,EAAC,MAAM,YAAY,CAAC;AAO3C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;;;;GAKG;AACH,qBAAa,QAAQ;IACnB;;;;;;;;;;;OAWG;WACW,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAM7E;;;;;;;;;;;;;;;;;OAiBG;WACW,oBAAoB,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAOnF;;;;;;;;;;;OAWG;WACW,yBAAyB,CACrC,QAAQ,EAAE,WAAW,EACrB,QAAQ,EAAE,OAAO,GAChB,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAQ7C;;;;;;;;;OASG;WACW,yBAAyB,CACrC,QAAQ,EAAE,WAAW,EACrB,KAAK,EAAE,MAAM,GAAG,qBAAqB,GACpC,qBAAqB,GAAG,SAAS;IASpC;;;;OAIG;WACW,uBAAuB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,qBAAqB;IAcjF;;;;OAIG;WACW,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,UAAU;IAW3D;;;;;OAKG;WACW,sBAAsB,CAAC,WAAW,EAAE,WAAW,GAAG,qBAAqB,EAAE;IAgBvF;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,cAAc;IAU/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;WACW,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,cAAc;CA+CtE"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/** The type and the message of an inner error, carried as `data.cause` by a wrapping error. */
|
|
2
|
+
export interface ErrorCause {
|
|
3
|
+
/** The `type` of a typed error, or the `name` of a plain `Error`. */
|
|
4
|
+
type: string;
|
|
5
|
+
/** The message of the inner error. */
|
|
6
|
+
message: string;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Describe an inner error for the `data.cause` of a wrapping typed error. The update paths
|
|
10
|
+
* raise `INVALID_DID_UPDATE` for every failure that the specification names; the inner error
|
|
11
|
+
* of the cryptosuite, the multikey, the hash decoder, or the common package rides along here.
|
|
12
|
+
* @param {unknown} error The inner error.
|
|
13
|
+
* @returns {ErrorCause} The type and the message of the inner error.
|
|
14
|
+
*/
|
|
15
|
+
export declare function errorCause(error: unknown): ErrorCause;
|
|
16
|
+
//# sourceMappingURL=error-cause.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"error-cause.d.ts","sourceRoot":"","sources":["../../../src/utils/error-cause.ts"],"names":[],"mappings":"AAEA,+FAA+F;AAC/F,MAAM,WAAW,UAAU;IACzB,qEAAqE;IACrE,IAAI,EAAE,MAAM,CAAC;IAEb,sCAAsC;IACtC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,UAAU,CAIrD"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@did-btcr2/method",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.64.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Reference implementation for the did:btcr2 DID method written in TypeScript and JavaScript. did:btcr2 is a censorship resistant DID Method using the Bitcoin blockchain as a Verifiable Data Registry to announce changes to the DID document. This is the core method implementation for the did-btcr2-js monorepo.",
|
|
6
6
|
"main": "./dist/cjs/index.js",
|
|
@@ -70,10 +70,10 @@
|
|
|
70
70
|
"@scure/btc-signer": "^1.8.1",
|
|
71
71
|
"@web5/dids": "^1.2.0",
|
|
72
72
|
"@did-btcr2/bitcoin": "^0.11.0",
|
|
73
|
-
"@did-btcr2/common": "^9.
|
|
74
|
-
"@did-btcr2/cryptosuite": "^10.0.0",
|
|
73
|
+
"@did-btcr2/common": "^9.6.0",
|
|
75
74
|
"@did-btcr2/keypair": "^0.13.1",
|
|
76
|
-
"@did-btcr2/smt": "^0.3.0"
|
|
75
|
+
"@did-btcr2/smt": "^0.3.0",
|
|
76
|
+
"@did-btcr2/cryptosuite": "^10.0.0"
|
|
77
77
|
},
|
|
78
78
|
"devDependencies": {
|
|
79
79
|
"@eslint/js": "^9.39.4",
|
package/src/core/btcr2-update.ts
CHANGED
|
@@ -34,6 +34,18 @@ export function isBtcr2UpdateContext(
|
|
|
34
34
|
&& value.every((url, i) => url === expected[i]);
|
|
35
35
|
}
|
|
36
36
|
|
|
37
|
+
/**
|
|
38
|
+
* The JSON Patch operation of the Deactivate operation: it adds the `deactivated` property
|
|
39
|
+
* with the value `true`. Deactivate is the Update operation with this predetermined patch, and
|
|
40
|
+
* resolution stops at the deactivation for good. See
|
|
41
|
+
* {@link https://dcdpr.github.io/did-btcr2/operations/deactivate.html | Deactivate}.
|
|
42
|
+
*/
|
|
43
|
+
export const DEACTIVATION_PATCH: Readonly<PatchOperation> = Object.freeze({
|
|
44
|
+
op : 'add',
|
|
45
|
+
path : '/deactivated',
|
|
46
|
+
value : true,
|
|
47
|
+
});
|
|
48
|
+
|
|
37
49
|
/**
|
|
38
50
|
* A {@link https://dcdpr.github.io/did-btcr2/terminology.html#btcr2-update | BTCR2 Update} without a data integrity proof.
|
|
39
51
|
* See {@link https://dcdpr.github.io/did-btcr2/data-structures.html#btcr2-unsigned-update | BTCR2 Unsigned Update (data structure)}.
|
|
@@ -83,11 +95,11 @@ export type UnsignedBTCR2Update = {
|
|
|
83
95
|
* ZCAP capability-invocation fields a did:btcr2 update proof carries.
|
|
84
96
|
*/
|
|
85
97
|
export type Btcr2DataIntegrityProof = DataIntegrityProofObject & {
|
|
86
|
-
/** The root capability being invoked
|
|
87
|
-
capability
|
|
98
|
+
/** The root capability being invoked: `urn:zcap:root:${encodeURIComponent(did)}`. */
|
|
99
|
+
capability: string;
|
|
88
100
|
|
|
89
|
-
/** The action performed under the capability
|
|
90
|
-
capabilityAction
|
|
101
|
+
/** The action performed under the capability: `"Write"` for a DID document update. */
|
|
102
|
+
capabilityAction: string;
|
|
91
103
|
};
|
|
92
104
|
|
|
93
105
|
/**
|
|
@@ -112,9 +124,9 @@ export type Btcr2DataIntegrityConfig = DataIntegrityProofOptions & {
|
|
|
112
124
|
/** The same array as the update `@context`: {@link BTCR2_UPDATE_CONTEXT}. */
|
|
113
125
|
'@context': string[];
|
|
114
126
|
|
|
115
|
-
/** The root capability being invoked
|
|
116
|
-
capability
|
|
127
|
+
/** The root capability being invoked: `urn:zcap:root:${encodeURIComponent(did)}`. */
|
|
128
|
+
capability: string;
|
|
117
129
|
|
|
118
|
-
/** The action performed under the capability
|
|
119
|
-
capabilityAction
|
|
130
|
+
/** The action performed under the capability: `"Write"` for a DID document update. */
|
|
131
|
+
capabilityAction: string;
|
|
120
132
|
};
|