Class ShogunDID

ShogunDID class for decentralized identity management

Hierarchy

  • EventEmitter
    • ShogunDID

Constructors

constructor

Properties

core DEFAULT_CACHE_DURATION DEFAULT_MAX_RETRIES DEFAULT_RETRY_DELAY DEFAULT_TIMEOUT didCache methodName options registryConfig

Methods

authenticateWithDID authenticateWithEthereum authenticateWithGunDB authenticateWithWebAuthn clearCache createDID createDidDocument createErrorResolution deactivateDID emit extractAuthenticationMethod generateDIDDocument getCurrentUserDID getDocumentFromCache getUserPublicKey getWallet isValidDID off on once parseOrCreateDIDDocument registerDIDOnChain removeAllListeners removeFromCache resolveDID storeDID updateDIDDocument verifyDIDOnChain

Constructors

constructor

  • new ShogunDID(
        shogunCore: IShogunCore,
        registryConfig?: Partial<DIDRegistryConfig>,
        options?: { useSecureRandomPassword?: boolean; [key: string]: any },
    ): ShogunDID

    Initialize ShogunDID manager

    Parameters

    • shogunCore: IShogunCore
    • OptionalregistryConfig: Partial<DIDRegistryConfig>
    • Optionaloptions: { useSecureRandomPassword?: boolean; [key: string]: any }

    Returns ShogunDID

Properties

Private Readonlycore

core: IShogunCore

Private ReadonlyDEFAULT_CACHE_DURATION

DEFAULT_CACHE_DURATION: number = ...

Private ReadonlyDEFAULT_MAX_RETRIES

DEFAULT_MAX_RETRIES: 3

Private ReadonlyDEFAULT_RETRY_DELAY

DEFAULT_RETRY_DELAY: 1000

Private ReadonlyDEFAULT_TIMEOUT

DEFAULT_TIMEOUT: 10000

Private ReadonlydidCache

didCache: Map<string, DIDCacheEntry> = ...

Private ReadonlymethodName

methodName: string = "shogun"

Private Readonlyoptions

options: { useSecureRandomPassword?: boolean; [key: string]: any }

Private ReadonlyregistryConfig

registryConfig: DIDRegistryConfig = ...

Methods

authenticateWithDID

  • authenticateWithDID(did: string, challenge?: string): Promise<AuthResult>

    Authenticate using a DID

    Parameters

    • did: string

      The DID to authenticate

    • Optionalchallenge: string

      Optional challenge for authentication

    Returns Promise<AuthResult>

    Authentication result

PrivateauthenticateWithEthereum

  • authenticateWithEthereum(
        authMethod: { controller: string; id: string; type: string },
        challenge?: string,
    ): Promise<AuthResult>

    Parameters

    • authMethod: { controller: string; id: string; type: string }
    • Optionalchallenge: string

    Returns Promise<AuthResult>

PrivateauthenticateWithGunDB

  • authenticateWithGunDB(username: string, challenge?: string): Promise<any>

    Parameters

    • username: string
    • Optionalchallenge: string

    Returns Promise<any>

PrivateauthenticateWithWebAuthn

  • authenticateWithWebAuthn(
        authMethod: { controller: string; id: string; type: string },
        challenge?: string,
    ): Promise<AuthResult>

    Parameters

    • authMethod: { controller: string; id: string; type: string }
    • Optionalchallenge: string

    Returns Promise<AuthResult>

clearCache

  • clearCache(): void

    Clear DID cache

    Returns void

createDID

PrivatecreateDidDocument

PrivatecreateErrorResolution

deactivateDID

  • deactivateDID(did: string): Promise<boolean>

    Deactivate a DID

    Parameters

    • did: string

      The DID to deactivate

    Returns Promise<boolean>

    Whether the deactivation was successful

emit

  • emit(event: EventType, data?: unknown): boolean

    Emits an event with arguments

    Parameters

    • event: EventType
    • Optionaldata: unknown

    Returns boolean

PrivateextractAuthenticationMethod

  • extractAuthenticationMethod(
        document: DIDDocument,
    ): null | { controller: string; id: string; type: string }

    Parameters

    Returns null | { controller: string; id: string; type: string }

generateDIDDocument

getCurrentUserDID

  • getCurrentUserDID(): Promise<null | string>

    Get the current user's DID

    Returns Promise<null | string>

    The user's DID or null if not found

PrivategetDocumentFromCache

  • getDocumentFromCache(cache: DIDCacheEntry): null | DIDDocument

    Helper to get document from cache entry (compatibility)

    Parameters

    • cache: DIDCacheEntry

    Returns null | DIDDocument

PrivategetUserPublicKey

  • getUserPublicKey(): null | string

    Helper to get public key of current user

    Returns null | string

PrivategetWallet

  • getWallet(): null | Wallet

    Returns null | Wallet

isValidDID

  • isValidDID(did: string): boolean

    Validate if a string is a properly formatted DID

    Parameters

    • did: string

      The DID to validate

    Returns boolean

    Whether the DID is valid

off

  • off(event: EventType, listener: (data: unknown) => void): void

    Removes an event listener

    Parameters

    • event: EventType
    • listener: (data: unknown) => void

    Returns void

on

  • on(event: EventType, listener: (data: unknown) => void): void

    Registers an event listener

    Parameters

    • event: EventType
    • listener: (data: unknown) => void

    Returns void

once

  • once(event: EventType, listener: (data: unknown) => void): void

    Registers a one-time event listener

    Parameters

    • event: EventType
    • listener: (data: unknown) => void

    Returns void

PrivateparseOrCreateDIDDocument

  • parseOrCreateDIDDocument(did: string, data: any): DIDDocument

    Parameters

    • did: string
    • data: any

    Returns DIDDocument

registerDIDOnChain

  • registerDIDOnChain(
        did: string,
        signer?: Signer,
    ): Promise<{ error?: string; success: boolean; txHash?: string }>

    Register DID on blockchain with retry logic

    Parameters

    • did: string
    • Optionalsigner: Signer

    Returns Promise<{ error?: string; success: boolean; txHash?: string }>

removeAllListeners

  • removeAllListeners(event?: EventType): void

    Removes all listeners for an event or all events

    Parameters

    • Optionalevent: EventType

    Returns void

removeFromCache

  • removeFromCache(did: string): void

    Remove specific DID from cache

    Parameters

    • did: string

    Returns void

resolveDID

  • resolveDID(
        did: string,
        options?: DIDResolutionOptions,
    ): Promise<DIDResolutionResult>

    Resolve a DID with caching

    Parameters

    • did: string
    • options: DIDResolutionOptions = {}

    Returns Promise<DIDResolutionResult>

PrivatestoreDID

  • storeDID(did: string, options: DIDCreateOptions): Promise<void>

    Store DID document

    Parameters

    • did: string

      DID identifier

    • options: DIDCreateOptions

      DID creation options or document

    Returns Promise<void>

    Promise that resolves when DID is stored

updateDIDDocument

  • updateDIDDocument(did: string, updates: Partial<DIDDocument>): Promise<boolean>

    Update DID Document

    Parameters

    • did: string

      DID to update

    • updates: Partial<DIDDocument>

      Partial DID Document to merge with existing document

    Returns Promise<boolean>

    True if the document was updated successfully

verifyDIDOnChain

  • verifyDIDOnChain(
        did: string,
    ): Promise<{ controller?: string; error?: string; isRegistered: boolean }>

    Verifica se un DID è registrato sulla blockchain

    Parameters

    • did: string

      Il DID da verificare

    Returns Promise<{ controller?: string; error?: string; isRegistered: boolean }>

    Promise con il risultato della verifica

Settings

Member Visibility

On This Page

Constructors
Properties
Methods