Interface ShogunSDKConfig

Shogun SDK configuration

interface ShogunSDKConfig {
    did?: DIDConfig;
    gundb?: GunDBOptions;
    logging?: LoggingConfig;
    metamask?: { enabled?: boolean };
    plugins?: { autoRegister?: ShogunPlugin[] };
    providerUrl?: string;
    stealth?: { enabled?: boolean };
    timeouts?: { login?: number; operation?: number; signup?: number };
    walletManager?: { balanceCacheTTL?: number; enabled?: boolean };
    webauthn?: WebauthnConfig;
}

Properties

did? gundb? logging? metamask? plugins? providerUrl? stealth? timeouts? walletManager? webauthn?

Properties

Optionaldid

did?: DIDConfig

DID configuration

Optionalgundb

gundb?: GunDBOptions

GunDB configuration

Optionallogging

logging?: LoggingConfig

Logging configuration

Optionalmetamask

metamask?: { enabled?: boolean }

MetaMask configuration

Type declaration

  • Optionalenabled?: boolean

    Enable MetaMask

Optionalplugins

plugins?: { autoRegister?: ShogunPlugin[] }

Plugin configuration

Type declaration

  • OptionalautoRegister?: ShogunPlugin[]

    List of plugins to automatically register on initialization

OptionalproviderUrl

providerUrl?: string

Ethereum provider URL

Optionalstealth

stealth?: { enabled?: boolean }

Enable stealth functionalities

Type declaration

  • Optionalenabled?: boolean

    Enable stealth functionalities

Optionaltimeouts

timeouts?: { login?: number; operation?: number; signup?: number }

Timeout configuration in milliseconds

Type declaration

  • Optionallogin?: number

    Login timeout in milliseconds (default: 15000)

  • Optionaloperation?: number

    General operation timeout in milliseconds (default: 30000)

  • Optionalsignup?: number

    Signup timeout in milliseconds (default: 20000)

OptionalwalletManager

walletManager?: { balanceCacheTTL?: number; enabled?: boolean }

Wallet configuration

Type declaration

  • OptionalbalanceCacheTTL?: number

    Balance cache TTL in milliseconds (default: 30000)

  • Optionalenabled?: boolean

    Enable wallet functionalities

Optionalwebauthn

webauthn?: WebauthnConfig

WebAuthn configuration

Settings

Member Visibility

On This Page

Properties