@cheqd/sdk 5.3.2 → 5.3.3-develop.2
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 +310 -0
- package/build/cjs/index.d.ts +92 -1
- package/build/cjs/index.d.ts.map +1 -1
- package/build/cjs/index.js +75 -2
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/modules/_.d.ts +61 -0
- package/build/cjs/modules/_.d.ts.map +1 -1
- package/build/cjs/modules/_.js +50 -0
- package/build/cjs/modules/_.js.map +1 -1
- package/build/cjs/modules/did.d.ts +278 -0
- package/build/cjs/modules/did.d.ts.map +1 -1
- package/build/cjs/modules/did.js +242 -0
- package/build/cjs/modules/did.js.map +1 -1
- package/build/cjs/modules/feeabstraction.d.ts +297 -2
- package/build/cjs/modules/feeabstraction.d.ts.map +1 -1
- package/build/cjs/modules/feeabstraction.js +235 -4
- package/build/cjs/modules/feeabstraction.js.map +1 -1
- package/build/cjs/modules/feemarket.d.ts +154 -21
- package/build/cjs/modules/feemarket.d.ts.map +1 -1
- package/build/cjs/modules/feemarket.js +133 -22
- package/build/cjs/modules/feemarket.js.map +1 -1
- package/build/cjs/modules/resource.d.ts +143 -0
- package/build/cjs/modules/resource.d.ts.map +1 -1
- package/build/cjs/modules/resource.js +131 -0
- package/build/cjs/modules/resource.js.map +1 -1
- package/build/cjs/querier.d.ts +50 -0
- package/build/cjs/querier.d.ts.map +1 -1
- package/build/cjs/querier.js +50 -0
- package/build/cjs/querier.js.map +1 -1
- package/build/cjs/registry.d.ts +14 -0
- package/build/cjs/registry.d.ts.map +1 -1
- package/build/cjs/registry.js +14 -0
- package/build/cjs/registry.js.map +1 -1
- package/build/cjs/signer.d.ts +172 -1
- package/build/cjs/signer.d.ts.map +1 -1
- package/build/cjs/signer.js +172 -1
- package/build/cjs/signer.js.map +1 -1
- package/build/cjs/types.d.ts +91 -0
- package/build/cjs/types.d.ts.map +1 -1
- package/build/cjs/types.js +17 -0
- package/build/cjs/types.js.map +1 -1
- package/build/cjs/utils.d.ts +191 -3
- package/build/cjs/utils.d.ts.map +1 -1
- package/build/cjs/utils.js +196 -0
- package/build/cjs/utils.js.map +1 -1
- package/build/esm/index.d.ts +92 -1
- package/build/esm/index.d.ts.map +1 -1
- package/build/esm/index.js +74 -1
- package/build/esm/index.js.map +1 -1
- package/build/esm/modules/_.d.ts +42 -0
- package/build/esm/modules/_.d.ts.map +1 -1
- package/build/esm/modules/_.js +32 -0
- package/build/esm/modules/_.js.map +1 -1
- package/build/esm/modules/did.d.ts +274 -0
- package/build/esm/modules/did.d.ts.map +1 -1
- package/build/esm/modules/did.js +242 -0
- package/build/esm/modules/did.js.map +1 -1
- package/build/esm/modules/feeabstraction.d.ts +277 -2
- package/build/esm/modules/feeabstraction.d.ts.map +1 -1
- package/build/esm/modules/feeabstraction.js +221 -2
- package/build/esm/modules/feeabstraction.js.map +1 -1
- package/build/esm/modules/feemarket.d.ts +152 -21
- package/build/esm/modules/feemarket.d.ts.map +1 -1
- package/build/esm/modules/feemarket.js +131 -21
- package/build/esm/modules/feemarket.js.map +1 -1
- package/build/esm/modules/resource.d.ts +142 -0
- package/build/esm/modules/resource.d.ts.map +1 -1
- package/build/esm/modules/resource.js +130 -0
- package/build/esm/modules/resource.js.map +1 -1
- package/build/esm/querier.d.ts +50 -0
- package/build/esm/querier.d.ts.map +1 -1
- package/build/esm/querier.js +50 -0
- package/build/esm/querier.js.map +1 -1
- package/build/esm/registry.d.ts +14 -0
- package/build/esm/registry.d.ts.map +1 -1
- package/build/esm/registry.js +14 -0
- package/build/esm/registry.js.map +1 -1
- package/build/esm/signer.d.ts +122 -0
- package/build/esm/signer.d.ts.map +1 -1
- package/build/esm/signer.js +122 -0
- package/build/esm/signer.js.map +1 -1
- package/build/esm/types.d.ts +92 -0
- package/build/esm/types.d.ts.map +1 -1
- package/build/esm/types.js +17 -0
- package/build/esm/types.js.map +1 -1
- package/build/esm/utils.d.ts +181 -3
- package/build/esm/utils.d.ts.map +1 -1
- package/build/esm/utils.js +172 -0
- package/build/esm/utils.js.map +1 -1
- package/build/types/index.d.ts +92 -1
- package/build/types/index.d.ts.map +1 -1
- package/build/types/modules/_.d.ts +42 -0
- package/build/types/modules/_.d.ts.map +1 -1
- package/build/types/modules/did.d.ts +274 -0
- package/build/types/modules/did.d.ts.map +1 -1
- package/build/types/modules/feeabstraction.d.ts +277 -2
- package/build/types/modules/feeabstraction.d.ts.map +1 -1
- package/build/types/modules/feemarket.d.ts +152 -21
- package/build/types/modules/feemarket.d.ts.map +1 -1
- package/build/types/modules/resource.d.ts +142 -0
- package/build/types/modules/resource.d.ts.map +1 -1
- package/build/types/querier.d.ts +50 -0
- package/build/types/querier.d.ts.map +1 -1
- package/build/types/registry.d.ts +14 -0
- package/build/types/registry.d.ts.map +1 -1
- package/build/types/signer.d.ts +122 -0
- package/build/types/signer.d.ts.map +1 -1
- package/build/types/types.d.ts +92 -0
- package/build/types/types.d.ts.map +1 -1
- package/build/types/utils.d.ts +181 -3
- package/build/types/utils.d.ts.map +1 -1
- package/package.json +4 -4
package/build/cjs/modules/_.d.ts
CHANGED
|
@@ -2,19 +2,80 @@ import { GeneratedType } from '@cosmjs/proto-signing-cjs';
|
|
|
2
2
|
import { CheqdSigningStargateClient } from '../signer';
|
|
3
3
|
import { IModuleMethodMap, QueryExtensionSetup } from '../types';
|
|
4
4
|
import { CheqdQuerier } from '../querier';
|
|
5
|
+
/**
|
|
6
|
+
* Abstract base class for all Cheqd SDK modules.
|
|
7
|
+
* Provides common functionality for module initialization, registry types,
|
|
8
|
+
* and querier extensions. All SDK modules must extend this class.
|
|
9
|
+
*/
|
|
5
10
|
export declare abstract class AbstractCheqdSDKModule {
|
|
11
|
+
/** Signing client instance for transaction operations */
|
|
6
12
|
_signer: CheqdSigningStargateClient;
|
|
13
|
+
/** Map of methods exposed by this module */
|
|
7
14
|
methods: IModuleMethodMap;
|
|
15
|
+
/** Querier instance for blockchain data retrieval */
|
|
8
16
|
querier: CheqdQuerier;
|
|
17
|
+
/** List of method names protected from external access */
|
|
9
18
|
readonly _protectedMethods: string[];
|
|
19
|
+
/** Static registry types for message encoding/decoding */
|
|
10
20
|
static readonly registryTypes: Iterable<[string, GeneratedType]>;
|
|
21
|
+
/** Static querier extension setup function */
|
|
11
22
|
static readonly querierExtensionSetup: QueryExtensionSetup<any>;
|
|
23
|
+
/**
|
|
24
|
+
* Constructs a new AbstractCheqdSDKModule instance.
|
|
25
|
+
*
|
|
26
|
+
* @param signer - Signing client for blockchain transactions
|
|
27
|
+
* @param querier - Querier client for blockchain data retrieval
|
|
28
|
+
* @throws Error if signer or querier is not provided
|
|
29
|
+
*/
|
|
12
30
|
constructor(signer: CheqdSigningStargateClient, querier: CheqdQuerier);
|
|
31
|
+
/**
|
|
32
|
+
* Abstract method to get registry types for message encoding/decoding.
|
|
33
|
+
* Must be implemented by concrete module classes.
|
|
34
|
+
*
|
|
35
|
+
* @returns Iterable of [typeUrl, GeneratedType] pairs for the registry
|
|
36
|
+
*/
|
|
13
37
|
abstract getRegistryTypes(): Iterable<[string, GeneratedType]>;
|
|
14
38
|
}
|
|
39
|
+
/**
|
|
40
|
+
* Type that creates a minimal importable version of a Cheqd SDK module.
|
|
41
|
+
* Removes internal implementation details while preserving public methods and properties.
|
|
42
|
+
* Used for creating clean interfaces for module consumption.
|
|
43
|
+
*/
|
|
15
44
|
export type MinimalImportableCheqdSDKModule<T extends AbstractCheqdSDKModule> = Omit<T, '_signer' | '_protectedMethods' | 'registryTypes' | 'querierExtensionSetup' | 'getRegistryTypes' | 'getQuerierExtensionSetup'>;
|
|
45
|
+
/**
|
|
46
|
+
* Factory function for instantiating Cheqd SDK modules.
|
|
47
|
+
* Creates a new instance of the specified module class with the provided arguments.
|
|
48
|
+
*
|
|
49
|
+
* @template T - Type of the module constructor
|
|
50
|
+
* @param module - Module constructor class
|
|
51
|
+
* @param args - Constructor arguments for the module
|
|
52
|
+
* @returns New instance of the module
|
|
53
|
+
*/
|
|
16
54
|
export declare function instantiateCheqdSDKModule<T extends new (...args: any[]) => T>(module: T, ...args: ConstructorParameters<T>): T;
|
|
55
|
+
/**
|
|
56
|
+
* Extracts registry types from a module for message encoding/decoding.
|
|
57
|
+
* Safely retrieves the registryTypes static property with fallback to empty array.
|
|
58
|
+
*
|
|
59
|
+
* @param module - Module instance or class to extract registry types from
|
|
60
|
+
* @returns Iterable of [typeUrl, GeneratedType] pairs
|
|
61
|
+
*/
|
|
17
62
|
export declare function instantiateCheqdSDKModuleRegistryTypes(module: any): Iterable<[string, GeneratedType]>;
|
|
63
|
+
/**
|
|
64
|
+
* Extracts querier extension setup from a module.
|
|
65
|
+
* Safely retrieves the querierExtensionSetup static property with fallback to empty object.
|
|
66
|
+
*
|
|
67
|
+
* @param module - Module instance or class to extract querier extension setup from
|
|
68
|
+
* @returns Query extension setup function
|
|
69
|
+
*/
|
|
18
70
|
export declare function instantiateCheqdSDKModuleQuerierExtensionSetup(module: any): QueryExtensionSetup<any>;
|
|
71
|
+
/**
|
|
72
|
+
* Applies mixin pattern to combine methods from multiple module constructors.
|
|
73
|
+
* Extracts public methods from module prototypes while respecting protected method lists.
|
|
74
|
+
* This enables composition of functionality from multiple modules into a single interface.
|
|
75
|
+
*
|
|
76
|
+
* @param derivedCtor - Target constructor to apply mixins to
|
|
77
|
+
* @param constructors - Array of constructor functions to extract methods from
|
|
78
|
+
* @returns Map of method names to their implementations
|
|
79
|
+
*/
|
|
19
80
|
export declare function applyMixins(derivedCtor: any, constructors: any[]): IModuleMethodMap;
|
|
20
81
|
//# sourceMappingURL=_.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"_.d.ts","sourceRoot":"","sources":["../../../cjs/src/modules/_.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE1D,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,8BAAsB,sBAAsB;IAC3C,OAAO,EAAE,0BAA0B,CAAC;IACpC,OAAO,EAAE,gBAAgB,CAAM;IAC/B,OAAO,EAAE,YAAY,CAAC;IACtB,QAAQ,CAAC,iBAAiB,EAAE,MAAM,EAAE,CAAmE;IACvG,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAM;IACtE,MAAM,CAAC,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAC,GAAG,CAAC,CAA+B;
|
|
1
|
+
{"version":3,"file":"_.d.ts","sourceRoot":"","sources":["../../../cjs/src/modules/_.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE1D,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C;;;;GAIG;AACH,8BAAsB,sBAAsB;IAC3C,yDAAyD;IACzD,OAAO,EAAE,0BAA0B,CAAC;IACpC,4CAA4C;IAC5C,OAAO,EAAE,gBAAgB,CAAM;IAC/B,qDAAqD;IACrD,OAAO,EAAE,YAAY,CAAC;IACtB,0DAA0D;IAC1D,QAAQ,CAAC,iBAAiB,EAAE,MAAM,EAAE,CAAmE;IACvG,0DAA0D;IAC1D,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAM;IACtE,8CAA8C;IAC9C,MAAM,CAAC,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAC,GAAG,CAAC,CAA+B;IAE9F;;;;;;OAMG;gBACS,MAAM,EAAE,0BAA0B,EAAE,OAAO,EAAE,YAAY;IAWrE;;;;;OAKG;IACH,QAAQ,CAAC,gBAAgB,IAAI,QAAQ,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CAC9D;AAUD;;;;GAIG;AACH,MAAM,MAAM,+BAA+B,CAAC,CAAC,SAAS,sBAAsB,IAAI,IAAI,CACnF,CAAC,EACC,SAAS,GACT,mBAAmB,GACnB,eAAe,GACf,uBAAuB,GACvB,kBAAkB,GAClB,0BAA0B,CAC5B,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,CAAC,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,EAC5E,MAAM,EAAE,CAAC,EACT,GAAG,IAAI,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAC/B,CAAC,CAEH;AAED;;;;;;GAMG;AACH,wBAAgB,sCAAsC,CAAC,MAAM,EAAE,GAAG,GAAG,QAAQ,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAErG;AAED;;;;;;GAMG;AACH,wBAAgB,8CAA8C,CAAC,MAAM,EAAE,GAAG,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAEpG;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,WAAW,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,GAAG,gBAAgB,CAmBnF"}
|
package/build/cjs/modules/_.js
CHANGED
|
@@ -5,13 +5,31 @@ exports.instantiateCheqdSDKModule = instantiateCheqdSDKModule;
|
|
|
5
5
|
exports.instantiateCheqdSDKModuleRegistryTypes = instantiateCheqdSDKModuleRegistryTypes;
|
|
6
6
|
exports.instantiateCheqdSDKModuleQuerierExtensionSetup = instantiateCheqdSDKModuleQuerierExtensionSetup;
|
|
7
7
|
exports.applyMixins = applyMixins;
|
|
8
|
+
/**
|
|
9
|
+
* Abstract base class for all Cheqd SDK modules.
|
|
10
|
+
* Provides common functionality for module initialization, registry types,
|
|
11
|
+
* and querier extensions. All SDK modules must extend this class.
|
|
12
|
+
*/
|
|
8
13
|
class AbstractCheqdSDKModule {
|
|
14
|
+
/** Signing client instance for transaction operations */
|
|
9
15
|
_signer;
|
|
16
|
+
/** Map of methods exposed by this module */
|
|
10
17
|
methods = {};
|
|
18
|
+
/** Querier instance for blockchain data retrieval */
|
|
11
19
|
querier;
|
|
20
|
+
/** List of method names protected from external access */
|
|
12
21
|
_protectedMethods = ['constructor', 'getRegistryTypes', 'getQuerierExtensionSetup'];
|
|
22
|
+
/** Static registry types for message encoding/decoding */
|
|
13
23
|
static registryTypes = [];
|
|
24
|
+
/** Static querier extension setup function */
|
|
14
25
|
static querierExtensionSetup = (base) => ({});
|
|
26
|
+
/**
|
|
27
|
+
* Constructs a new AbstractCheqdSDKModule instance.
|
|
28
|
+
*
|
|
29
|
+
* @param signer - Signing client for blockchain transactions
|
|
30
|
+
* @param querier - Querier client for blockchain data retrieval
|
|
31
|
+
* @throws Error if signer or querier is not provided
|
|
32
|
+
*/
|
|
15
33
|
constructor(signer, querier) {
|
|
16
34
|
if (!signer) {
|
|
17
35
|
throw new Error('signer is required');
|
|
@@ -24,15 +42,47 @@ class AbstractCheqdSDKModule {
|
|
|
24
42
|
}
|
|
25
43
|
}
|
|
26
44
|
exports.AbstractCheqdSDKModule = AbstractCheqdSDKModule;
|
|
45
|
+
/**
|
|
46
|
+
* Factory function for instantiating Cheqd SDK modules.
|
|
47
|
+
* Creates a new instance of the specified module class with the provided arguments.
|
|
48
|
+
*
|
|
49
|
+
* @template T - Type of the module constructor
|
|
50
|
+
* @param module - Module constructor class
|
|
51
|
+
* @param args - Constructor arguments for the module
|
|
52
|
+
* @returns New instance of the module
|
|
53
|
+
*/
|
|
27
54
|
function instantiateCheqdSDKModule(module, ...args) {
|
|
28
55
|
return new module(...args);
|
|
29
56
|
}
|
|
57
|
+
/**
|
|
58
|
+
* Extracts registry types from a module for message encoding/decoding.
|
|
59
|
+
* Safely retrieves the registryTypes static property with fallback to empty array.
|
|
60
|
+
*
|
|
61
|
+
* @param module - Module instance or class to extract registry types from
|
|
62
|
+
* @returns Iterable of [typeUrl, GeneratedType] pairs
|
|
63
|
+
*/
|
|
30
64
|
function instantiateCheqdSDKModuleRegistryTypes(module) {
|
|
31
65
|
return module.registryTypes ?? [];
|
|
32
66
|
}
|
|
67
|
+
/**
|
|
68
|
+
* Extracts querier extension setup from a module.
|
|
69
|
+
* Safely retrieves the querierExtensionSetup static property with fallback to empty object.
|
|
70
|
+
*
|
|
71
|
+
* @param module - Module instance or class to extract querier extension setup from
|
|
72
|
+
* @returns Query extension setup function
|
|
73
|
+
*/
|
|
33
74
|
function instantiateCheqdSDKModuleQuerierExtensionSetup(module) {
|
|
34
75
|
return module.querierExtensionSetup ?? {};
|
|
35
76
|
}
|
|
77
|
+
/**
|
|
78
|
+
* Applies mixin pattern to combine methods from multiple module constructors.
|
|
79
|
+
* Extracts public methods from module prototypes while respecting protected method lists.
|
|
80
|
+
* This enables composition of functionality from multiple modules into a single interface.
|
|
81
|
+
*
|
|
82
|
+
* @param derivedCtor - Target constructor to apply mixins to
|
|
83
|
+
* @param constructors - Array of constructor functions to extract methods from
|
|
84
|
+
* @returns Map of method names to their implementations
|
|
85
|
+
*/
|
|
36
86
|
function applyMixins(derivedCtor, constructors) {
|
|
37
87
|
let methods = {};
|
|
38
88
|
constructors.forEach((baseCtor) => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"_.js","sourceRoot":"","sources":["../../../cjs/src/modules/_.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"_.js","sourceRoot":"","sources":["../../../cjs/src/modules/_.ts"],"names":[],"mappings":";;;AAoFA,8DAKC;AASD,wFAEC;AASD,wGAEC;AAWD,kCAmBC;AAvID;;;;GAIG;AACH,MAAsB,sBAAsB;IAC3C,yDAAyD;IACzD,OAAO,CAA6B;IACpC,4CAA4C;IAC5C,OAAO,GAAqB,EAAE,CAAC;IAC/B,qDAAqD;IACrD,OAAO,CAAe;IACtB,0DAA0D;IACjD,iBAAiB,GAAa,CAAC,aAAa,EAAE,kBAAkB,EAAE,0BAA0B,CAAC,CAAC;IACvG,0DAA0D;IAC1D,MAAM,CAAU,aAAa,GAAsC,EAAE,CAAC;IACtE,8CAA8C;IAC9C,MAAM,CAAU,qBAAqB,GAA6B,CAAC,IAAiB,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IAE9F;;;;;;OAMG;IACH,YAAY,MAAkC,EAAE,OAAqB;QACpE,IAAI,CAAC,MAAM,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,OAAO,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACxB,CAAC;;AA9BF,wDAuCC;AAyBD;;;;;;;;GAQG;AACH,SAAgB,yBAAyB,CACxC,MAAS,EACT,GAAG,IAA8B;IAEjC,OAAO,IAAI,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,sCAAsC,CAAC,MAAW;IACjE,OAAO,MAAM,CAAC,aAAa,IAAI,EAAE,CAAC;AACnC,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,8CAA8C,CAAC,MAAW;IACzE,OAAO,MAAM,CAAC,qBAAqB,IAAI,EAAE,CAAC;AAC3C,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,WAAW,CAAC,WAAgB,EAAE,YAAmB;IAChE,IAAI,OAAO,GAAqB,EAAE,CAAC;IAEnC,YAAY,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QACjC,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC/D,MAAM,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC1C,IACC,OAAO,QAAQ,KAAK,UAAU;gBAC9B,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC;gBAChC,WAAW,EAAE,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC5C,QAAQ,CAAC,SAAS,EAAE,iBAAiB,EAAE,QAAQ,CAAC,IAAI,CAAC;gBAErD,OAAO;YAER,OAAO,GAAG,EAAE,GAAG,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;QAC5C,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC;AAChB,CAAC"}
|
|
@@ -6,107 +6,385 @@ import { MsgCreateDidDoc, MsgCreateDidDocResponse, MsgDeactivateDidDoc, MsgDeact
|
|
|
6
6
|
import { EncodeObject, GeneratedType } from '@cosmjs/proto-signing-cjs';
|
|
7
7
|
import { CheqdQuerier } from '../querier';
|
|
8
8
|
import { DIDDocumentMetadata } from 'did-resolver-cjs';
|
|
9
|
+
/** Default extension key for DID-related query operations */
|
|
9
10
|
export declare const defaultDidExtensionKey: "did";
|
|
11
|
+
/**
|
|
12
|
+
* Standard W3C and DID-related context URIs used in DID documents.
|
|
13
|
+
* These contexts define the semantic meaning of properties in DID documents.
|
|
14
|
+
*/
|
|
10
15
|
export declare const contexts: {
|
|
16
|
+
/** W3C DID Core v1 context */
|
|
11
17
|
readonly W3CDIDv1: "https://www.w3.org/ns/did/v1";
|
|
18
|
+
/** Ed25519 Signature Suite 2020 context */
|
|
12
19
|
readonly W3CSuiteEd255192020: "https://w3id.org/security/suites/ed25519-2020/v1";
|
|
20
|
+
/** Ed25519 Signature Suite 2018 context */
|
|
13
21
|
readonly W3CSuiteEd255192018: "https://w3id.org/security/suites/ed25519-2018/v1";
|
|
22
|
+
/** JSON Web Signature Suite 2020 context */
|
|
14
23
|
readonly W3CSuiteJws2020: "https://w3id.org/security/suites/jws-2020/v1";
|
|
24
|
+
/** Linked Domains context for domain verification */
|
|
15
25
|
readonly LinkedDomainsContext: "https://identity.foundation/.well-known/did-configuration/v1";
|
|
16
26
|
};
|
|
27
|
+
/**
|
|
28
|
+
* Protobuf message type literals for DID operations.
|
|
29
|
+
* Used for consistent message type identification across the module.
|
|
30
|
+
*/
|
|
17
31
|
export declare const protobufLiterals: {
|
|
32
|
+
/** Create DID document message type */
|
|
18
33
|
readonly MsgCreateDidDoc: "MsgCreateDidDoc";
|
|
34
|
+
/** Create DID document response message type */
|
|
19
35
|
readonly MsgCreateDidDocResponse: "MsgCreateDidDocResponse";
|
|
36
|
+
/** Update DID document message type */
|
|
20
37
|
readonly MsgUpdateDidDoc: "MsgUpdateDidDoc";
|
|
38
|
+
/** Update DID document response message type */
|
|
21
39
|
readonly MsgUpdateDidDocResponse: "MsgUpdateDidDocResponse";
|
|
40
|
+
/** Deactivate DID document message type */
|
|
22
41
|
readonly MsgDeactivateDidDoc: "MsgDeactivateDidDoc";
|
|
42
|
+
/** Deactivate DID document response message type */
|
|
23
43
|
readonly MsgDeactivateDidDocResponse: "MsgDeactivateDidDocResponse";
|
|
24
44
|
};
|
|
45
|
+
/** Type URL for MsgCreateDidDoc messages */
|
|
25
46
|
export declare const typeUrlMsgCreateDidDoc: "/cheqd.did.v2.MsgCreateDidDoc";
|
|
47
|
+
/** Type URL for MsgCreateDidDocResponse messages */
|
|
26
48
|
export declare const typeUrlMsgCreateDidDocResponse: "/cheqd.did.v2.MsgCreateDidDocResponse";
|
|
49
|
+
/** Type URL for MsgUpdateDidDoc messages */
|
|
27
50
|
export declare const typeUrlMsgUpdateDidDoc: "/cheqd.did.v2.MsgUpdateDidDoc";
|
|
51
|
+
/** Type URL for MsgUpdateDidDocResponse messages */
|
|
28
52
|
export declare const typeUrlMsgUpdateDidDocResponse: "/cheqd.did.v2.MsgUpdateDidDocResponse";
|
|
53
|
+
/** Type URL for MsgDeactivateDidDoc messages */
|
|
29
54
|
export declare const typeUrlMsgDeactivateDidDoc: "/cheqd.did.v2.MsgDeactivateDidDoc";
|
|
55
|
+
/** Type URL for MsgDeactivateDidDocResponse messages */
|
|
30
56
|
export declare const typeUrlMsgDeactivateDidDocResponse: "/cheqd.did.v2.MsgDeactivateDidDocResponse";
|
|
57
|
+
/**
|
|
58
|
+
* Encode object interface for MsgCreateDidDoc messages.
|
|
59
|
+
* Used for type-safe message encoding in transactions.
|
|
60
|
+
*/
|
|
31
61
|
export interface MsgCreateDidDocEncodeObject extends EncodeObject {
|
|
32
62
|
readonly typeUrl: typeof typeUrlMsgCreateDidDoc;
|
|
33
63
|
readonly value: Partial<MsgCreateDidDoc>;
|
|
34
64
|
}
|
|
65
|
+
/**
|
|
66
|
+
* Type guard function to check if an object is a MsgCreateDidDocEncodeObject.
|
|
67
|
+
*
|
|
68
|
+
* @param obj - EncodeObject to check
|
|
69
|
+
* @returns True if the object is a MsgCreateDidDocEncodeObject
|
|
70
|
+
*/
|
|
35
71
|
export declare function isMsgCreateDidDocEncodeObject(obj: EncodeObject): obj is MsgCreateDidDocEncodeObject;
|
|
72
|
+
/**
|
|
73
|
+
* Type guard function to check if an object is a MsgUpdateDidDocEncodeObject.
|
|
74
|
+
*
|
|
75
|
+
* @param obj - EncodeObject to check
|
|
76
|
+
* @returns True if the object is a MsgUpdateDidDocEncodeObject
|
|
77
|
+
*/
|
|
36
78
|
export declare function isMsgUpdateDidDocEncodeObject(obj: EncodeObject): obj is MsgUpdateDidDocEncodeObject;
|
|
79
|
+
/**
|
|
80
|
+
* Type guard function to check if an object is a MsgDeactivateDidDocEncodeObject.
|
|
81
|
+
*
|
|
82
|
+
* @param obj - EncodeObject to check
|
|
83
|
+
* @returns True if the object is a MsgDeactivateDidDocEncodeObject
|
|
84
|
+
*/
|
|
37
85
|
export declare function isMsgDeactivateDidDocEncodeObject(obj: EncodeObject): obj is MsgDeactivateDidDocEncodeObject;
|
|
86
|
+
/**
|
|
87
|
+
* Encode object interface for MsgCreateDidDocResponse messages.
|
|
88
|
+
* Used for type-safe response message handling.
|
|
89
|
+
*/
|
|
90
|
+
/**
|
|
91
|
+
* Encode object interface for MsgCreateDidDocResponse messages.
|
|
92
|
+
* Used for type-safe response message handling.
|
|
93
|
+
*/
|
|
38
94
|
export interface MsgCreateDidDocResponseEncodeObject extends EncodeObject {
|
|
39
95
|
readonly typeUrl: typeof typeUrlMsgCreateDidDocResponse;
|
|
40
96
|
readonly value: Partial<MsgCreateDidDocResponse>;
|
|
41
97
|
}
|
|
98
|
+
/**
|
|
99
|
+
* Type guard function to check if an object is a MsgCreateDidDocResponseEncodeObject.
|
|
100
|
+
*
|
|
101
|
+
* @param obj - EncodeObject to check
|
|
102
|
+
* @returns True if the object is a MsgCreateDidDocResponseEncodeObject
|
|
103
|
+
*/
|
|
42
104
|
export declare function MsgCreateDidDocResponseEncodeObject(obj: EncodeObject): obj is MsgCreateDidDocResponseEncodeObject;
|
|
105
|
+
/**
|
|
106
|
+
* Encode object interface for MsgUpdateDidDoc messages.
|
|
107
|
+
* Used for type-safe message encoding in update transactions.
|
|
108
|
+
*/
|
|
43
109
|
export interface MsgUpdateDidDocEncodeObject extends EncodeObject {
|
|
44
110
|
readonly typeUrl: typeof typeUrlMsgUpdateDidDoc;
|
|
45
111
|
readonly value: Partial<MsgUpdateDidDoc>;
|
|
46
112
|
}
|
|
113
|
+
/**
|
|
114
|
+
* Type guard function to check if an object is a MsgUpdateDidDocEncodeObject.
|
|
115
|
+
*
|
|
116
|
+
* @param obj - EncodeObject to check
|
|
117
|
+
* @returns True if the object is a MsgUpdateDidDocEncodeObject
|
|
118
|
+
*/
|
|
47
119
|
export declare function MsgUpdateDidDocEncodeObject(obj: EncodeObject): obj is MsgUpdateDidDocEncodeObject;
|
|
120
|
+
/**
|
|
121
|
+
* Encode object interface for MsgUpdateDidDocResponse messages.
|
|
122
|
+
* Used for type-safe response message handling in update operations.
|
|
123
|
+
*/
|
|
48
124
|
export interface MsgUpdateDidDocResponseEncodeObject extends EncodeObject {
|
|
49
125
|
readonly typeUrl: typeof typeUrlMsgUpdateDidDocResponse;
|
|
50
126
|
readonly value: Partial<MsgUpdateDidDocResponse>;
|
|
51
127
|
}
|
|
128
|
+
/**
|
|
129
|
+
* Type guard function to check if an object is a MsgUpdateDidDocResponseEncodeObject.
|
|
130
|
+
*
|
|
131
|
+
* @param obj - EncodeObject to check
|
|
132
|
+
* @returns True if the object is a MsgUpdateDidDocResponseEncodeObject
|
|
133
|
+
*/
|
|
52
134
|
export declare function MsgUpdateDidDocResponseEncodeObject(obj: EncodeObject): obj is MsgUpdateDidDocResponseEncodeObject;
|
|
135
|
+
/**
|
|
136
|
+
* Encode object interface for MsgDeactivateDidDoc messages.
|
|
137
|
+
* Used for type-safe message encoding in deactivation transactions.
|
|
138
|
+
*/
|
|
53
139
|
export interface MsgDeactivateDidDocEncodeObject extends EncodeObject {
|
|
54
140
|
readonly typeUrl: typeof typeUrlMsgDeactivateDidDoc;
|
|
55
141
|
readonly value: Partial<MsgDeactivateDidDoc>;
|
|
56
142
|
}
|
|
143
|
+
/**
|
|
144
|
+
* Type guard function to check if an object is a MsgDeactivateDidDocEncodeObject.
|
|
145
|
+
*
|
|
146
|
+
* @param obj - EncodeObject to check
|
|
147
|
+
* @returns True if the object is a MsgDeactivateDidDocEncodeObject
|
|
148
|
+
*/
|
|
57
149
|
export declare function MsgDeactivateDidDocEncodeObject(obj: EncodeObject): obj is MsgUpdateDidDocEncodeObject;
|
|
150
|
+
/**
|
|
151
|
+
* Encode object interface for MsgDeactivateDidDocResponse messages.
|
|
152
|
+
* Used for type-safe response message handling in deactivation operations.
|
|
153
|
+
*/
|
|
58
154
|
export interface MsgDeactivateDidDocResponseEncodeObject extends EncodeObject {
|
|
59
155
|
readonly typeUrl: typeof typeUrlMsgDeactivateDidDocResponse;
|
|
60
156
|
readonly value: Partial<MsgDeactivateDidDocResponse>;
|
|
61
157
|
}
|
|
158
|
+
/**
|
|
159
|
+
* Type guard function to check if an object is a MsgDeactivateDidDocResponseEncodeObject.
|
|
160
|
+
*
|
|
161
|
+
* @param obj - EncodeObject to check
|
|
162
|
+
* @returns True if the object is a MsgDeactivateDidDocResponseEncodeObject
|
|
163
|
+
*/
|
|
62
164
|
export declare function MsgDeactiveDidDocResponseEncodeObject(obj: EncodeObject): obj is MsgDeactivateDidDocResponseEncodeObject;
|
|
165
|
+
/** Minimal importable version of the DID module for clean external interfaces */
|
|
63
166
|
export type MinimalImportableDIDModule = MinimalImportableCheqdSDKModule<DIDModule>;
|
|
167
|
+
/**
|
|
168
|
+
* DID extension interface for querier functionality.
|
|
169
|
+
* Provides methods for querying DID documents and their versions.
|
|
170
|
+
*/
|
|
64
171
|
export type DidExtension = {
|
|
65
172
|
readonly [defaultDidExtensionKey]: {
|
|
173
|
+
/** Query a DID document by ID */
|
|
66
174
|
readonly didDoc: (id: string) => Promise<DidDocWithMetadata>;
|
|
175
|
+
/** Query a specific version of a DID document */
|
|
67
176
|
readonly didDocVersion: (id: string, versionId: string) => Promise<DidDocWithMetadata>;
|
|
177
|
+
/** Query metadata for all versions of a DID document */
|
|
68
178
|
readonly allDidDocVersionsMetadata: (id: string, paginationKey?: Uint8Array) => Promise<QueryAllDidDocVersionsMetadataResponse>;
|
|
69
179
|
};
|
|
70
180
|
};
|
|
181
|
+
/**
|
|
182
|
+
* Sets up the DID extension for the querier client.
|
|
183
|
+
* Creates and configures the DID-specific query methods.
|
|
184
|
+
*
|
|
185
|
+
* @param base - Base QueryClient to extend
|
|
186
|
+
* @returns Configured DID extension with query methods
|
|
187
|
+
*/
|
|
71
188
|
export declare const setupDidExtension: (base: QueryClient) => DidExtension;
|
|
189
|
+
/**
|
|
190
|
+
* DID Module class providing comprehensive DID document management functionality.
|
|
191
|
+
* Handles creation, updates, deactivation, and querying of DID documents on the Cheqd blockchain.
|
|
192
|
+
*/
|
|
72
193
|
export declare class DIDModule extends AbstractCheqdSDKModule {
|
|
73
194
|
static readonly registryTypes: Iterable<[string, GeneratedType]>;
|
|
195
|
+
/** Base denomination for Cheqd network transactions */
|
|
74
196
|
static readonly baseMinimalDenom: "ncheq";
|
|
197
|
+
/**
|
|
198
|
+
* Standard fee amounts for DID operations.
|
|
199
|
+
* These represent the default costs for different DID document operations.
|
|
200
|
+
*/
|
|
75
201
|
static readonly fees: {
|
|
202
|
+
/** Default fee for creating a new DID document */
|
|
76
203
|
readonly DefaultCreateDidDocFee: {
|
|
77
204
|
readonly amount: "50000000000";
|
|
78
205
|
readonly denom: "ncheq";
|
|
79
206
|
};
|
|
207
|
+
/** Default fee for updating an existing DID document */
|
|
80
208
|
readonly DefaultUpdateDidDocFee: {
|
|
81
209
|
readonly amount: "25000000000";
|
|
82
210
|
readonly denom: "ncheq";
|
|
83
211
|
};
|
|
212
|
+
/** Default fee for deactivating a DID document */
|
|
84
213
|
readonly DefaultDeactivateDidDocFee: {
|
|
85
214
|
readonly amount: "10000000000";
|
|
86
215
|
readonly denom: "ncheq";
|
|
87
216
|
};
|
|
88
217
|
};
|
|
218
|
+
/** Querier extension setup function for DID operations */
|
|
89
219
|
static readonly querierExtensionSetup: QueryExtensionSetup<DidExtension>;
|
|
220
|
+
/** Querier instance with DID extension capabilities */
|
|
90
221
|
querier: CheqdQuerier & DidExtension;
|
|
222
|
+
/**
|
|
223
|
+
* Constructs a new DID module instance.
|
|
224
|
+
*
|
|
225
|
+
* @param signer - Signing client for blockchain transactions
|
|
226
|
+
* @param querier - Querier client with DID extension for data retrieval
|
|
227
|
+
*/
|
|
91
228
|
constructor(signer: CheqdSigningStargateClient, querier: CheqdQuerier & DidExtension);
|
|
229
|
+
/**
|
|
230
|
+
* Gets the registry types for DID message encoding/decoding.
|
|
231
|
+
*
|
|
232
|
+
* @returns Iterable of [typeUrl, GeneratedType] pairs for the registry
|
|
233
|
+
*/
|
|
92
234
|
getRegistryTypes(): Iterable<[string, GeneratedType]>;
|
|
235
|
+
/**
|
|
236
|
+
* Gets the querier extension setup for DID operations.
|
|
237
|
+
*
|
|
238
|
+
* @returns Query extension setup function for DID functionality
|
|
239
|
+
*/
|
|
93
240
|
getQuerierExtensionSetup(): QueryExtensionSetup<DidExtension>;
|
|
241
|
+
/**
|
|
242
|
+
* Creates a new DID document transaction on the blockchain.
|
|
243
|
+
* Validates the DID payload and authentication before submission.
|
|
244
|
+
*
|
|
245
|
+
* @param signInputs - Signing inputs or pre-computed signatures for the transaction
|
|
246
|
+
* @param didPayload - DID document payload to create
|
|
247
|
+
* @param address - Address of the account submitting the transaction
|
|
248
|
+
* @param fee - Transaction fee configuration or 'auto' for automatic calculation
|
|
249
|
+
* @param memo - Optional transaction memo
|
|
250
|
+
* @param versionId - Optional version identifier for the DID document
|
|
251
|
+
* @param context - Optional SDK context for accessing clients
|
|
252
|
+
* @returns Promise resolving to the transaction response
|
|
253
|
+
* @throws Error if DID payload is not spec compliant or authentication is invalid
|
|
254
|
+
*/
|
|
94
255
|
createDidDocTx(signInputs: ISignInputs[] | SignInfo[], didPayload: DIDDocument, address: string, fee?: DidStdFee | 'auto' | number, memo?: string, versionId?: string, context?: IContext): Promise<DeliverTxResponse>;
|
|
256
|
+
/**
|
|
257
|
+
* Updates an existing DID document transaction on the blockchain.
|
|
258
|
+
* Validates the updated DID payload and handles key rotation scenarios.
|
|
259
|
+
*
|
|
260
|
+
* @param signInputs - Signing inputs or pre-computed signatures for the transaction
|
|
261
|
+
* @param didPayload - Updated DID document payload
|
|
262
|
+
* @param address - Address of the account submitting the transaction
|
|
263
|
+
* @param fee - Transaction fee configuration or 'auto' for automatic calculation
|
|
264
|
+
* @param memo - Optional transaction memo
|
|
265
|
+
* @param versionId - Optional version identifier for the updated DID document
|
|
266
|
+
* @param context - Optional SDK context for accessing clients
|
|
267
|
+
* @returns Promise resolving to the transaction response
|
|
268
|
+
* @throws Error if DID payload is not spec compliant or authentication is invalid
|
|
269
|
+
*/
|
|
95
270
|
updateDidDocTx(signInputs: ISignInputs[] | SignInfo[], didPayload: DIDDocument, address: string, fee?: DidStdFee | 'auto' | number, memo?: string, versionId?: string, context?: IContext): Promise<DeliverTxResponse>;
|
|
271
|
+
/**
|
|
272
|
+
* Deactivates an existing DID document transaction on the blockchain.
|
|
273
|
+
* Validates authentication and creates a deactivation transaction.
|
|
274
|
+
*
|
|
275
|
+
* @param signInputs - Signing inputs or pre-computed signatures for the transaction
|
|
276
|
+
* @param didPayload - DID document payload containing the ID to deactivate
|
|
277
|
+
* @param address - Address of the account submitting the transaction
|
|
278
|
+
* @param fee - Transaction fee configuration or 'auto' for automatic calculation
|
|
279
|
+
* @param memo - Optional transaction memo
|
|
280
|
+
* @param versionId - Optional version identifier for the deactivation
|
|
281
|
+
* @param context - Optional SDK context for accessing clients
|
|
282
|
+
* @returns Promise resolving to the transaction response
|
|
283
|
+
* @throws Error if DID payload is not spec compliant or authentication is invalid
|
|
284
|
+
*/
|
|
96
285
|
deactivateDidDocTx(signInputs: ISignInputs[] | SignInfo[], didPayload: DIDDocument, address: string, fee?: DidStdFee | 'auto' | number, memo?: string, versionId?: string, context?: IContext): Promise<DeliverTxResponse>;
|
|
286
|
+
/**
|
|
287
|
+
* Queries a DID document by its identifier.
|
|
288
|
+
* Retrieves the latest version of the DID document with metadata.
|
|
289
|
+
*
|
|
290
|
+
* @param id - DID identifier to query
|
|
291
|
+
* @param context - Optional SDK context for accessing clients
|
|
292
|
+
* @returns Promise resolving to the DID document with metadata
|
|
293
|
+
*/
|
|
97
294
|
queryDidDoc(id: string, context?: IContext): Promise<DIDDocumentWithMetadata>;
|
|
295
|
+
/**
|
|
296
|
+
* Queries a specific version of a DID document by its identifier and version ID.
|
|
297
|
+
*
|
|
298
|
+
* @param id - DID identifier to query
|
|
299
|
+
* @param versionId - Specific version identifier to retrieve
|
|
300
|
+
* @param context - Optional SDK context for accessing clients
|
|
301
|
+
* @returns Promise resolving to the DID document version with metadata
|
|
302
|
+
*/
|
|
98
303
|
queryDidDocVersion(id: string, versionId: string, context?: IContext): Promise<DIDDocumentWithMetadata>;
|
|
304
|
+
/**
|
|
305
|
+
* Queries metadata for all versions of a DID document.
|
|
306
|
+
* Retrieves version history information for a specific DID.
|
|
307
|
+
*
|
|
308
|
+
* @param id - DID identifier to query version metadata for
|
|
309
|
+
* @param context - Optional SDK context for accessing clients
|
|
310
|
+
* @returns Promise resolving to array of version metadata and pagination info
|
|
311
|
+
*/
|
|
99
312
|
queryAllDidDocVersionsMetadata(id: string, context?: IContext): Promise<{
|
|
100
313
|
didDocumentVersionsMetadata: DIDDocumentMetadata[];
|
|
101
314
|
pagination: QueryAllDidDocVersionsMetadataResponse['pagination'];
|
|
102
315
|
}>;
|
|
316
|
+
/**
|
|
317
|
+
* Validates a DID document against the Cheqd specification requirements.
|
|
318
|
+
* Ensures all required fields are present and verification methods are supported.
|
|
319
|
+
*
|
|
320
|
+
* @param didDocument - DID document to validate
|
|
321
|
+
* @returns Promise resolving to validation result with protobuf conversion or error details
|
|
322
|
+
*/
|
|
103
323
|
static validateSpecCompliantPayload(didDocument: DIDDocument): Promise<SpecValidationResult>;
|
|
324
|
+
/**
|
|
325
|
+
* Converts a protobuf DID document to a specification-compliant DID document format.
|
|
326
|
+
* Handles context inclusion, verification method formatting, and service denormalization.
|
|
327
|
+
*
|
|
328
|
+
* @param protobufDidDocument - Protobuf DID document to convert
|
|
329
|
+
* @returns Promise resolving to a spec-compliant DID document
|
|
330
|
+
*/
|
|
104
331
|
static toSpecCompliantPayload(protobufDidDocument: DidDoc): Promise<DIDDocument>;
|
|
332
|
+
/**
|
|
333
|
+
* Converts protobuf metadata to specification-compliant DID document metadata format.
|
|
334
|
+
* Handles date formatting and optional field normalization.
|
|
335
|
+
*
|
|
336
|
+
* @param protobufDidDocument - Protobuf metadata to convert
|
|
337
|
+
* @returns Promise resolving to spec-compliant DID document metadata
|
|
338
|
+
*/
|
|
105
339
|
static toSpecCompliantMetadata(protobufDidDocument: Metadata): Promise<DIDDocumentMetadata>;
|
|
340
|
+
/**
|
|
341
|
+
* Validates that provided signatures match the authentication requirements in a DID document.
|
|
342
|
+
* Checks signature count, authentication presence, and controller authorization.
|
|
343
|
+
*
|
|
344
|
+
* @param didDocument - DID document containing authentication requirements
|
|
345
|
+
* @param signatures - Array of signatures to validate against authentication
|
|
346
|
+
* @param querier - Optional querier for retrieving external controller documents
|
|
347
|
+
* @param externalControllersDidDocuments - Optional pre-loaded external controller documents
|
|
348
|
+
* @returns Promise resolving to validation result with error details if invalid
|
|
349
|
+
*/
|
|
106
350
|
static validateAuthenticationAgainstSignatures(didDocument: DIDDocument, signatures: readonly SignInfo[], querier?: CheqdQuerier & DidExtension, externalControllersDidDocuments?: DIDDocument[]): Promise<AuthenticationValidationResult>;
|
|
351
|
+
/**
|
|
352
|
+
* Validates authentication against signatures for key rotation scenarios.
|
|
353
|
+
* Handles validation during DID document updates where keys may have changed.
|
|
354
|
+
*
|
|
355
|
+
* @param didDocument - Updated DID document to validate
|
|
356
|
+
* @param signatures - Array of signatures to validate
|
|
357
|
+
* @param querier - Querier for retrieving previous DID document and controllers
|
|
358
|
+
* @param previousDidDocument - Optional previous version of the DID document
|
|
359
|
+
* @param externalControllersDidDocuments - Optional pre-loaded external controller documents
|
|
360
|
+
* @returns Promise resolving to validation result with controller documents and previous document
|
|
361
|
+
*/
|
|
107
362
|
static validateAuthenticationAgainstSignaturesKeyRotation(didDocument: DIDDocument, signatures: readonly SignInfo[], querier: CheqdQuerier & DidExtension, previousDidDocument?: DIDDocument, externalControllersDidDocuments?: DIDDocument[]): Promise<AuthenticationValidationResult>;
|
|
363
|
+
/**
|
|
364
|
+
* Generates standard fees for creating a DID document.
|
|
365
|
+
*
|
|
366
|
+
* @param feePayer - Address of the account that will pay the transaction fees
|
|
367
|
+
* @param granter - Optional address of the account granting fee payment permissions
|
|
368
|
+
* @returns Promise resolving to the fee configuration for DID document creation
|
|
369
|
+
*/
|
|
108
370
|
static generateCreateDidDocFees(feePayer: string, granter?: string): Promise<DidStdFee>;
|
|
371
|
+
/**
|
|
372
|
+
* Generates fee configuration for DID document update transactions.
|
|
373
|
+
* Uses default update fees and gas requirements.
|
|
374
|
+
*
|
|
375
|
+
* @param feePayer - Address of the account that will pay the transaction fees
|
|
376
|
+
* @param granter - Optional address of the account granting fee payment permissions
|
|
377
|
+
* @returns Promise resolving to the fee configuration for DID document updates
|
|
378
|
+
*/
|
|
109
379
|
static generateUpdateDidDocFees(feePayer: string, granter?: string): Promise<DidStdFee>;
|
|
380
|
+
/**
|
|
381
|
+
* Generates fee configuration for DID document deactivation transactions.
|
|
382
|
+
* Uses default deactivation fees and gas requirements.
|
|
383
|
+
*
|
|
384
|
+
* @param feePayer - Address of the account that will pay the transaction fees
|
|
385
|
+
* @param granter - Optional address of the account granting fee payment permissions
|
|
386
|
+
* @returns Promise resolving to the fee configuration for DID document deactivation
|
|
387
|
+
*/
|
|
110
388
|
static generateDeactivateDidDocFees(feePayer: string, granter?: string): Promise<DidStdFee>;
|
|
111
389
|
}
|
|
112
390
|
//# sourceMappingURL=did.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"did.d.ts","sourceRoot":"","sources":["../../../cjs/src/modules/did.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6C,iBAAiB,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACjH,OAAO,EAAE,sBAAsB,EAAE,+BAA+B,EAAE,MAAM,KAAK,CAAC;AAC9E,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,EACN,WAAW,EACX,SAAS,EACT,QAAQ,EACR,WAAW,EACX,mBAAmB,EACnB,oBAAoB,EAEpB,uBAAuB,EAEvB,8BAA8B,EAC9B,MAAM,UAAU,CAAC;AAClB,OAAO,EACN,eAAe,EAEf,uBAAuB,EACvB,mBAAmB,EAEnB,2BAA2B,EAC3B,eAAe,EAEf,uBAAuB,
|
|
1
|
+
{"version":3,"file":"did.d.ts","sourceRoot":"","sources":["../../../cjs/src/modules/did.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6C,iBAAiB,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACjH,OAAO,EAAE,sBAAsB,EAAE,+BAA+B,EAAE,MAAM,KAAK,CAAC;AAC9E,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,EACN,WAAW,EACX,SAAS,EACT,QAAQ,EACR,WAAW,EACX,mBAAmB,EACnB,oBAAoB,EAEpB,uBAAuB,EAEvB,8BAA8B,EAC9B,MAAM,UAAU,CAAC;AAClB,OAAO,EACN,eAAe,EAEf,uBAAuB,EACvB,mBAAmB,EAEnB,2BAA2B,EAC3B,eAAe,EAEf,uBAAuB,EAGvB,QAAQ,EAER,sCAAsC,EACtC,kBAAkB,EAClB,MAAM,EACN,QAAQ,EACR,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAIxE,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAGvD,6DAA6D;AAC7D,eAAO,MAAM,sBAAsB,EAAG,KAAc,CAAC;AAErD;;;GAGG;AACH,eAAO,MAAM,QAAQ;IACpB,8BAA8B;;IAE9B,2CAA2C;;IAE3C,2CAA2C;;IAE3C,4CAA4C;;IAE5C,qDAAqD;;CAE5C,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,gBAAgB;IAC5B,uCAAuC;;IAEvC,gDAAgD;;IAEhD,uCAAuC;;IAEvC,gDAAgD;;IAEhD,2CAA2C;;IAE3C,oDAAoD;;CAE3C,CAAC;AACX,4CAA4C;AAC5C,eAAO,MAAM,sBAAsB,iCAAqE,CAAC;AACzG,oDAAoD;AACpD,eAAO,MAAM,8BAA8B,yCACgC,CAAC;AAC5E,4CAA4C;AAC5C,eAAO,MAAM,sBAAsB,iCAAqE,CAAC;AACzG,oDAAoD;AACpD,eAAO,MAAM,8BAA8B,yCACgC,CAAC;AAC5E,gDAAgD;AAChD,eAAO,MAAM,0BAA0B,qCAAyE,CAAC;AACjH,wDAAwD;AACxD,eAAO,MAAM,kCAAkC,6CACgC,CAAC;AAEhF;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,YAAY;IAChE,QAAQ,CAAC,OAAO,EAAE,OAAO,sBAAsB,CAAC;IAChD,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;CACzC;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,GAAG,EAAE,YAAY,GAAG,GAAG,IAAI,2BAA2B,CAEnG;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,GAAG,EAAE,YAAY,GAAG,GAAG,IAAI,2BAA2B,CAEnG;AAED;;;;;GAKG;AACH,wBAAgB,iCAAiC,CAAC,GAAG,EAAE,YAAY,GAAG,GAAG,IAAI,+BAA+B,CAE3G;AAED;;;GAGG;AACH;;;GAGG;AACH,MAAM,WAAW,mCAAoC,SAAQ,YAAY;IACxE,QAAQ,CAAC,OAAO,EAAE,OAAO,8BAA8B,CAAC;IACxD,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,uBAAuB,CAAC,CAAC;CACjD;AAED;;;;;GAKG;AACH,wBAAgB,mCAAmC,CAAC,GAAG,EAAE,YAAY,GAAG,GAAG,IAAI,mCAAmC,CAEjH;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,YAAY;IAChE,QAAQ,CAAC,OAAO,EAAE,OAAO,sBAAsB,CAAC;IAChD,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;CACzC;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,YAAY,GAAG,GAAG,IAAI,2BAA2B,CAEjG;AAED;;;GAGG;AACH,MAAM,WAAW,mCAAoC,SAAQ,YAAY;IACxE,QAAQ,CAAC,OAAO,EAAE,OAAO,8BAA8B,CAAC;IACxD,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,uBAAuB,CAAC,CAAC;CACjD;AAED;;;;;GAKG;AACH,wBAAgB,mCAAmC,CAAC,GAAG,EAAE,YAAY,GAAG,GAAG,IAAI,mCAAmC,CAEjH;AAED;;;GAGG;AACH,MAAM,WAAW,+BAAgC,SAAQ,YAAY;IACpE,QAAQ,CAAC,OAAO,EAAE,OAAO,0BAA0B,CAAC;IACpD,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;CAC7C;AAED;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAAC,GAAG,EAAE,YAAY,GAAG,GAAG,IAAI,2BAA2B,CAErG;AAED;;;GAGG;AACH,MAAM,WAAW,uCAAwC,SAAQ,YAAY;IAC5E,QAAQ,CAAC,OAAO,EAAE,OAAO,kCAAkC,CAAC;IAC5D,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC;CACrD;AAED;;;;;GAKG;AACH,wBAAgB,qCAAqC,CACpD,GAAG,EAAE,YAAY,GACf,GAAG,IAAI,uCAAuC,CAEhD;AAED,iFAAiF;AACjF,MAAM,MAAM,0BAA0B,GAAG,+BAA+B,CAAC,SAAS,CAAC,CAAC;AAEpF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IAC1B,QAAQ,CAAC,CAAC,sBAAsB,CAAC,EAAE;QAClC,iCAAiC;QACjC,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAC7D,iDAAiD;QACjD,QAAQ,CAAC,aAAa,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACvF,wDAAwD;QACxD,QAAQ,CAAC,yBAAyB,EAAE,CACnC,EAAE,EAAE,MAAM,EACV,aAAa,CAAC,EAAE,UAAU,KACtB,OAAO,CAAC,sCAAsC,CAAC,CAAC;KACrD,CAAC;CACF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAAI,MAAM,WAAW,KAAG,YA6BrD,CAAC;AAEF;;;GAGG;AACH,qBAAa,SAAU,SAAQ,sBAAsB;IAEpD,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAO9D;IAEF,uDAAuD;IACvD,MAAM,CAAC,QAAQ,CAAC,gBAAgB,EAAG,OAAO,CAAU;IAEpD;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI;QACnB,kDAAkD;;;;;QAKlD,wDAAwD;;;;;QAKxD,kDAAkD;;;;;MAKxC;IAEX,0DAA0D;IAC1D,MAAM,CAAC,QAAQ,CAAC,qBAAqB,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAqB;IAE7F,uDAAuD;IACvD,OAAO,EAAE,YAAY,GAAG,YAAY,CAAC;IAErC;;;;;OAKG;gBACS,MAAM,EAAE,0BAA0B,EAAE,OAAO,EAAE,YAAY,GAAG,YAAY;IAapF;;;;OAIG;IACI,gBAAgB,IAAI,QAAQ,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAI5D;;;;OAIG;IACI,wBAAwB,IAAI,mBAAmB,CAAC,YAAY,CAAC;IAIpE;;;;;;;;;;;;;OAaG;IACG,cAAc,CACnB,UAAU,EAAE,WAAW,EAAE,GAAG,QAAQ,EAAE,EACtC,UAAU,EAAE,WAAW,EACvB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,EACjC,IAAI,CAAC,EAAE,MAAM,EACb,SAAS,CAAC,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,QAAQ,GAChB,OAAO,CAAC,iBAAiB,CAAC;IAsE7B;;;;;;;;;;;;;OAaG;IACG,cAAc,CACnB,UAAU,EAAE,WAAW,EAAE,GAAG,QAAQ,EAAE,EACtC,UAAU,EAAE,WAAW,EACvB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,EACjC,IAAI,CAAC,EAAE,MAAM,EACb,SAAS,CAAC,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,QAAQ,GAChB,OAAO,CAAC,iBAAiB,CAAC;IAmF7B;;;;;;;;;;;;;OAaG;IACG,kBAAkB,CACvB,UAAU,EAAE,WAAW,EAAE,GAAG,QAAQ,EAAE,EACtC,UAAU,EAAE,WAAW,EACvB,OAAO,EAAE,MAAM,EACf,GAAG,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,EACjC,IAAI,CAAC,EAAE,MAAM,EACb,SAAS,CAAC,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,QAAQ,GAChB,OAAO,CAAC,iBAAiB,CAAC;IAuD7B;;;;;;;OAOG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAWnF;;;;;;;OAOG;IACG,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAW7G;;;;;;;OAOG;IACG,8BAA8B,CACnC,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,QAAQ,GAChB,OAAO,CAAC;QACV,2BAA2B,EAAE,mBAAmB,EAAE,CAAC;QACnD,UAAU,EAAE,sCAAsC,CAAC,YAAY,CAAC,CAAC;KACjE,CAAC;IAaF;;;;;;OAMG;WACU,4BAA4B,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAuDlG;;;;;;OAMG;WACU,sBAAsB,CAAC,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAsFtF;;;;;;OAMG;WACU,uBAAuB,CAAC,mBAAmB,EAAE,QAAQ,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAWjG;;;;;;;;;OASG;WACU,uCAAuC,CACnD,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,SAAS,QAAQ,EAAE,EAC/B,OAAO,CAAC,EAAE,YAAY,GAAG,YAAY,EACrC,+BAA+B,CAAC,EAAE,WAAW,EAAE,GAC7C,OAAO,CAAC,8BAA8B,CAAC;IA+G1C;;;;;;;;;;OAUG;WACU,kDAAkD,CAC9D,WAAW,EAAE,WAAW,EACxB,UAAU,EAAE,SAAS,QAAQ,EAAE,EAC/B,OAAO,EAAE,YAAY,GAAG,YAAY,EACpC,mBAAmB,CAAC,EAAE,WAAW,EACjC,+BAA+B,CAAC,EAAE,WAAW,EAAE,GAC7C,OAAO,CAAC,8BAA8B,CAAC;IA2T1C;;;;;;OAMG;WACU,wBAAwB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAS7F;;;;;;;OAOG;WACU,wBAAwB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAS7F;;;;;;;OAOG;WACU,4BAA4B,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;CAQjG"}
|