Skip to main content

Namespace: did

Namespaces​

Interfaces​

Type Aliases​

AddControllersEventData​

Ƭ AddControllersEventData: AddControllersParam

Defined in​

packages/klayr-decentralized-identifier/dist/types/events/add_controllers_event.d.ts:2

AddKeysEventData​

Ƭ AddKeysEventData: AddKeysParam

Defined in​

packages/klayr-decentralized-identifier/dist/types/events/add_keys_event.d.ts:2

AddServiceEndpointEventData​

Ƭ AddServiceEndpointEventData: AddServiceEndpointParam

Defined in​

packages/klayr-decentralized-identifier/dist/types/events/add_service_endpoint_event.d.ts:2

AuthorizationResult​

Ƭ AuthorizationResult: Object

Type declaration​

NameType
didstring
methodVerificationMethod[]
relationshipVerificationRelationship[]
type"subject" | "controller"

Defined in​

packages/klayr-decentralized-identifier/dist/types/cryptography.d.ts:3

BaseLoader​

Ƭ BaseLoader: (url: string) => Promise<Record<string, any>>

Type declaration​

▸ (url): Promise<Record<string, any>>

Parameters​
NameType
urlstring
Returns​

Promise<Record<string, any>>

Defined in​

packages/klayr-decentralized-identifier/dist/types/resolver.d.ts:17

CommandPayload​

Ƭ CommandPayload: CreatePayload | PayloadWithSignature

Defined in​

packages/klayr-decentralized-identifier/dist/types/client.d.ts:27

CreateEventData​

Ƭ CreateEventData: CreateParam

Defined in​

packages/klayr-decentralized-identifier/dist/types/events/create_event.d.ts:2

CreateResolverParam​

Ƭ CreateResolverParam: Object

Type declaration​

NameType
context?MethodContext
ipc?string
loader?BaseLoader | DocumentLoader
method?DidMethod
resolver?BaseResolver
ws?string

Defined in​

packages/klayr-decentralized-identifier/dist/types/resolver.d.ts:18

DIDCommands​

Ƭ DIDCommands: "addControllers" | "addKeys" | "addServiceEndpoint" | "create" | "deactivate" | "removeControllers" | "removeKeys" | "removeServiceEndpoint"

Defined in​

packages/klayr-decentralized-identifier/dist/types/client.d.ts:25

DIDTransactionParam​

Ƭ DIDTransactionParam: AddControllersParam | AddKeysParam | AddServiceEndpointParam | CreateParam | DeactivateParam | RemoveControllersParam | RemoveKeysParam | RemoveServiceEndpointParam

Defined in​

packages/klayr-decentralized-identifier/dist/types/client.d.ts:23

DeactivateEventData​

Ƭ DeactivateEventData: DeactivateParam

Defined in​

packages/klayr-decentralized-identifier/dist/types/events/deactivate_event.d.ts:2

DecodedTransactionJSON​

Ƭ DecodedTransactionJSON<T>: Omit<TransactionJSON, "params"> & { params: T }

Type parameters​

NameType
TRecord<string, unknown>

Defined in​

packages/klayr-decentralized-identifier/dist/types/client.d.ts:38

DocumentLoader​

Ƭ DocumentLoader: (url: string) => Promise<DocumentLoaderResult>

Type declaration​

▸ (url): Promise<DocumentLoaderResult>

Parameters​
NameType
urlstring
Returns​

Promise<DocumentLoaderResult>

Defined in​

packages/klayr-decentralized-identifier/dist/types/resolver.d.ts:16

DocumentStoreData​

Ƭ DocumentStoreData: DidDocument

Defined in​

packages/klayr-decentralized-identifier/dist/types/stores/document.d.ts:2

KeyAgreement​

Ƭ KeyAgreement: VerificationMethod & { privateKeyMultibase?: string }

Defined in​

packages/klayr-decentralized-identifier/dist/types/cryptography.d.ts:16

PayloadWithSignature​

Ƭ PayloadWithSignature: AddControllersSignaturePayload | AddKeysSignaturePayload | AddServiceEndpointSignaturePayload | DeactivateSignaturePayload | RemoveControllersSignaturePayload | RemoveKeysSignaturePayload | RemoveServiceEndpointSignaturePayload

Defined in​

packages/klayr-decentralized-identifier/dist/types/client.d.ts:26

RemoveControllersEventData​

Ƭ RemoveControllersEventData: RemoveControllersParam

Defined in​

packages/klayr-decentralized-identifier/dist/types/events/remove_controllers_event.d.ts:2

RemoveKeysEventData​

Ƭ RemoveKeysEventData: RemoveKeysParam

Defined in​

packages/klayr-decentralized-identifier/dist/types/events/remove_keys_event.d.ts:2

RemoveServiceEndpointEventData​

Ƭ RemoveServiceEndpointEventData: RemoveServiceEndpointParam

Defined in​

packages/klayr-decentralized-identifier/dist/types/events/remove_service_endpoint_event.d.ts:2

VerificationRelationship​

Ƭ VerificationRelationship: "authentication" | "assertionMethod" | "capabilityInvocation" | "keyAgreement"

Defined in​

packages/klayr-decentralized-identifier/dist/types/cryptography.d.ts:9

WriteableSchema​

Ƭ WriteableSchema: Writeable<Schema>

Defined in​

packages/klayr-decentralized-identifier/dist/types/client.d.ts:24

Variables​

default​

• Const default: Object

Type declaration​

NameType
clienttypeof client
cryptographytypeof cryptography
resolvertypeof resolver
utilstypeof utils
getAddressDIDFromPublicKey(chainspace: string, publicKey: Buffer) => string
getDIDDocument(did: string, options: CreateResolverParam) => Promise<undefined | DidDocument>
parseDIDComponent(did: string) => { chainspace: any ; did: string ; fragment: any ; method: any ; namespace: string ; path: any ; query: any ; scheme: string ; uniqueId: string ; uri: string }

Defined in​

packages/klayr-decentralized-identifier/dist/index.d.ts:12

Functions​

getAddressDIDFromPublicKey​

▸ getAddressDIDFromPublicKey(chainspace, publicKey): string

Parameters​

NameType
chainspacestring
publicKeyBuffer

Returns​

string

Defined in​

packages/klayr-decentralized-identifier/dist/did.d.ts:16

getDIDDocument​

▸ getDIDDocument(did, options): Promise<DidDocument | undefined>

Parameters​

NameType
didstring
optionsCreateResolverParam

Returns​

Promise<DidDocument | undefined>

Defined in​

packages/klayr-decentralized-identifier/dist/did.d.ts:17

parseDIDComponent​

▸ parseDIDComponent(did): Object

Parameters​

NameType
didstring

Returns​

Object

NameType
chainspaceany
didstring
fragmentany
methodany
namespacestring
pathany
queryany
schemestring
uniqueIdstring
uristring

Defined in​

packages/klayr-decentralized-identifier/dist/did.d.ts:4