@klayr-did/klayr-decentralized-identifier
Namespaces
Interfaces
- AddControllersParam
- AddKeysParam
- AddServiceEndpointParam
- AuthorizationFactors
- BaseResolver
- CipherInterface
- CreateParam
- DeactivateParam
- DidDocument
- DidEndpoint
- DidMethod
- DidModuleConfig
- DocumentLoaderResult
- Ed25519KeyPair
- Ed25519Signature2020
- JWEDocument
- KeysCommand
- NonceStoreData
- RemoveControllersParam
- RemoveKeysParam
- RemoveServiceEndpointParam
- Service
- TransactionPayload
- TransactionPayloadWithoutSignature
- VerificationMethod
Type Aliases
AddControllersEventData
Ƭ AddControllersEventData: AddControllersParam
Defined in
packages/klayr-decentralized-identifier/src/types/events/add_controllers_event.ts:3
AddKeysEventData
Ƭ AddKeysEventData: AddKeysParam
Defined in
packages/klayr-decentralized-identifier/src/types/events/add_keys_event.ts:3
AddServiceEndpointEventData
Ƭ AddServiceEndpointEventData: AddServiceEndpointParam
Defined in
packages/klayr-decentralized-identifier/src/types/events/add_service_endpoint_event.ts:3
AuthorizationResult
Ƭ AuthorizationResult: Object
Type declaration
| Name | Type |
|---|---|
did | string |
method | VerificationMethod[] |
relationship | VerificationRelationship[] |
type | "subject" | "controller" |
Defined in
packages/klayr-decentralized-identifier/src/types/cryptography.ts:3
BaseLoader
Ƭ BaseLoader: (url: string) => Promise<Record<string, any>>
Type declaration
▸ (url): Promise<Record<string, any>>
Parameters
| Name | Type |
|---|---|
url | string |
Returns
Promise<Record<string, any>>
Defined in
packages/klayr-decentralized-identifier/src/types/resolver.ts:18
CommandPayload
Ƭ CommandPayload: CreatePayload | PayloadWithSignature
Defined in
packages/klayr-decentralized-identifier/src/types/client.ts:62
CreateEventData
Ƭ CreateEventData: CreateParam
Defined in
packages/klayr-decentralized-identifier/src/types/events/create_event.ts:3
CreateResolverParam
Ƭ CreateResolverParam: Object
Type declaration
| Name | Type |
|---|---|
context? | MethodContext |
ipc? | string |
loader? | BaseLoader | DocumentLoader |
method? | DidMethod |
resolver? | BaseResolver |
ws? | string |
Defined in
packages/klayr-decentralized-identifier/src/types/resolver.ts:20
DIDCommands
Ƭ DIDCommands: "addControllers" | "addKeys" | "addServiceEndpoint" | "create" | "deactivate" | "removeControllers" | "removeKeys" | "removeServiceEndpoint"
Defined in
packages/klayr-decentralized-identifier/src/types/client.ts:43
DIDTransactionParam
Ƭ DIDTransactionParam: AddControllersParam | AddKeysParam | AddServiceEndpointParam | CreateParam | DeactivateParam | RemoveControllersParam | RemoveKeysParam | RemoveServiceEndpointParam
Defined in
packages/klayr-decentralized-identifier/src/types/client.ts:31
DeactivateEventData
Ƭ DeactivateEventData: DeactivateParam
Defined in
packages/klayr-decentralized-identifier/src/types/events/deactivate_event.ts:3
DecodedTransactionJSON
Ƭ DecodedTransactionJSON<T>: Omit<TransactionJSON, "params"> & { params: T }
Type parameters
| Name | Type |
|---|---|
T | Record<string, unknown> |
Defined in
packages/klayr-decentralized-identifier/src/types/client.ts:76
DocumentLoader
Ƭ DocumentLoader: (url: string) => Promise<DocumentLoaderResult>
Type declaration
▸ (url): Promise<DocumentLoaderResult>
Parameters
| Name | Type |
|---|---|
url | string |
Returns
Promise<DocumentLoaderResult>
Defined in
packages/klayr-decentralized-identifier/src/types/resolver.ts:16
DocumentStoreData
Ƭ DocumentStoreData: DidDocument
Defined in
packages/klayr-decentralized-identifier/src/types/stores/document.ts:3
KeyAgreement
Ƭ KeyAgreement: VerificationMethod & { privateKeyMultibase?: string }
Defined in
packages/klayr-decentralized-identifier/src/types/cryptography.ts:19
PayloadWithSignature
Ƭ PayloadWithSignature: AddControllersSignaturePayload | AddKeysSignaturePayload | AddServiceEndpointSignaturePayload | DeactivateSignaturePayload | RemoveControllersSignaturePayload | RemoveKeysSignaturePayload | RemoveServiceEndpointSignaturePayload
Defined in
packages/klayr-decentralized-identifier/src/types/client.ts:53
RemoveControllersEventData
Ƭ RemoveControllersEventData: RemoveControllersParam
Defined in
packages/klayr-decentralized-identifier/src/types/events/remove_controllers_event.ts:3
RemoveKeysEventData
Ƭ RemoveKeysEventData: RemoveKeysParam
Defined in
packages/klayr-decentralized-identifier/src/types/events/remove_keys_event.ts:3
RemoveServiceEndpointEventData
Ƭ RemoveServiceEndpointEventData: RemoveServiceEndpointParam
Defined in
packages/klayr-decentralized-identifier/src/types/events/remove_service_endpoint_event.ts:3
VerificationRelationship
Ƭ VerificationRelationship: "authentication" | "assertionMethod" | "capabilityInvocation" | "keyAgreement"
Defined in
packages/klayr-decentralized-identifier/src/types/cryptography.ts:10
WriteableSchema
Ƭ WriteableSchema: Writeable<Schema>
Defined in
packages/klayr-decentralized-identifier/src/types/client.ts:41
Variables
default
• default: Object
Type declaration
| Name | Type |
|---|---|
client | client |
cryptography | cryptography |
resolver | resolver |
utils | utils |
getAddressDIDFromPublicKey | (chainspace: string, publicKey: Buffer) => string |
getDIDDocument | (did: string, options: CreateResolverParam) => Promise<DidDocument | undefined> |
parseDIDComponent | (did: string) => { chainspace: any ; did: string ; fragment: any = parsedDID.fragment; method: any = parsedDID.method; namespace: string ; path: any = parsedDID.path; query: any = parsedDID.query; scheme: string = 'did'; uniqueId: string ; uri: string } |
Defined in
packages/klayr-decentralized-identifier/src/index.ts:15
Functions
getAddressDIDFromPublicKey
▸ getAddressDIDFromPublicKey(chainspace, publicKey): string
Parameters
| Name | Type |
|---|---|
chainspace | string |
publicKey | Buffer |
Returns
string
Defined in
packages/klayr-decentralized-identifier/src/did.ts:59
getDIDDocument
▸ getDIDDocument(did, options): Promise<DidDocument | undefined>
Parameters
| Name | Type |
|---|---|
did | string |
options | CreateResolverParam |
Returns
Promise<DidDocument | undefined>
Defined in
packages/klayr-decentralized-identifier/src/did.ts:67
parseDIDComponent
▸ parseDIDComponent(did): Object
Parameters
| Name | Type |
|---|---|
did | string |
Returns
Object
| Name | Type |
|---|---|
chainspace | any |
did | string |
fragment | any |
method | any |
namespace | string |
path | any |
query | any |
scheme | string |
uniqueId | string |
uri | string |