Interface IShogunCore

Interfaccia per la gestione dei plugin in ShogunCore

interface IShogunCore {
    config: ShogunSDKConfig;
    did?: DID;
    gun: IGunInstance<any>;
    gundb: GunDB;
    metamask?: MetaMask;
    provider?: Provider;
    rx: GunRxJS;
    stealth?: Stealth;
    storage: ShogunStorage;
    webauthn?: Webauthn;
    compute<T, R>(
        sources: (string | Observable<any>)[],
        computeFn: (...values: T[]) => R,
    ): Observable<R>;
    configureLogging(config: LoggingConfig): void;
    emit(eventName: string | symbol, ...args: any[]): boolean;
    get(path: string): Promise<any>;
    getAuthenticationMethod(type: "webauthn" | "password" | "metamask"): any;
    getMainWallet(): null | Wallet;
    getPlugin<T>(name: string): undefined | T;
    getPluginsByCategory(category: PluginCategory): ShogunPlugin[];
    getRecentErrors(count?: number): ShogunError[];
    getRpcUrl(): null | string;
    hasPlugin(name: string): boolean;
    isLoggedIn(): boolean;
    isWebAuthnSupported(): boolean;
    login(username: string, password: string): Promise<AuthResult>;
    loginWithMetaMask(address: string): Promise<AuthResult>;
    loginWithWebAuthn(username: string): Promise<AuthResult>;
    logout(): void;
    match<T>(path: any, matchFn?: (data: any) => boolean): Observable<T[]>;
    observe<T>(path: any): Observable<T>;
    observeUser<T>(path: string): Observable<T>;
    off(eventName: string | symbol, listener: (...args: any[]) => void): any;
    on(eventName: string | symbol, listener: (...args: any[]) => void): any;
    once(eventName: string | symbol, listener: (...args: any[]) => void): any;
    onceObservable<T>(path: any): Observable<T>;
    put(data: Record<string, any>): Promise<any>;
    register(plugin: ShogunPlugin): void;
    removeAllListeners(eventName?: string | symbol): any;
    rxPut<T>(path: any, data: T): Observable<T>;
    rxSet<T>(path: any, data: T): Observable<T>;
    rxUserPut<T>(path: string, data: T): Observable<T>;
    setRpcUrl(rpcUrl: string): boolean;
    signUp(
        username: string,
        password: string,
        passwordConfirmation?: string,
    ): Promise<SignUpResult>;
    signUpWithMetaMask(address: string): Promise<AuthResult>;
    signUpWithWebAuthn(username: string): Promise<AuthResult>;
    unregister(pluginName: string): void;
    userGet(path: string): Promise<any>;
    userPut(data: Record<string, any>): Promise<any>;
}

Hierarchy (View Summary)

Implemented by

Properties

config did? gun gundb metamask? provider? rx stealth? storage webauthn?

Methods

compute configureLogging emit get getAuthenticationMethod getMainWallet? getPlugin getPluginsByCategory getRecentErrors getRpcUrl hasPlugin isLoggedIn isWebAuthnSupported? login loginWithMetaMask? loginWithWebAuthn? logout match observe observeUser off on once onceObservable put register removeAllListeners rxPut rxSet rxUserPut setRpcUrl signUp signUpWithMetaMask? signUpWithWebAuthn? unregister userGet userPut

Properties

config

config: ShogunSDKConfig

Optionaldid

did?: DID

Deprecated

Use getPlugin(CorePlugins.DID) instead

gun

gun: IGunInstance<any>

gundb

gundb: GunDB

Optionalmetamask

metamask?: MetaMask

Deprecated

Use getPlugin(CorePlugins.MetaMask) instead

Optionalprovider

provider?: Provider

rx

rx: GunRxJS

Optionalstealth

stealth?: Stealth

Deprecated

Use getPlugin(CorePlugins.Stealth) instead

storage

storage: ShogunStorage

Optionalwebauthn

webauthn?: Webauthn

Deprecated

Use getPlugin(CorePlugins.WebAuthn) instead

Methods

compute

  • compute<T, R>(
        sources: (string | Observable<any>)[],
        computeFn: (...values: T[]) => R,
    ): Observable<R>

    Type Parameters

    • T
    • R

    Parameters

    • sources: (string | Observable<any>)[]
    • computeFn: (...values: T[]) => R

    Returns Observable<R>

configureLogging

emit

  • emit(eventName: string | symbol, ...args: any[]): boolean

    Parameters

    • eventName: string | symbol
    • ...args: any[]

    Returns boolean

get

  • get(path: string): Promise<any>

    Parameters

    • path: string

    Returns Promise<any>

getAuthenticationMethod

  • getAuthenticationMethod(type: "webauthn" | "password" | "metamask"): any

    Parameters

    • type: "webauthn" | "password" | "metamask"

    Returns any

OptionalgetMainWallet

  • getMainWallet(): null | Wallet

    Returns null | Wallet

    Deprecated

    Use getPlugin(CorePlugins.WalletManager).getMainWallet() instead

getPlugin

  • getPlugin<T>(name: string): undefined | T

    Recupera un plugin registrato per nome

    Type Parameters

    • T

      Tipo del plugin o dell'interfaccia pubblica del plugin

    Parameters

    • name: string

      Nome del plugin

    Returns undefined | T

    Il plugin richiesto o undefined se non trovato

getPluginsByCategory

getRecentErrors

getRpcUrl

  • getRpcUrl(): null | string

    Returns null | string

hasPlugin

  • hasPlugin(name: string): boolean

    Verifica se un plugin è registrato

    Parameters

    • name: string

      Nome del plugin da verificare

    Returns boolean

    true se il plugin è registrato, false altrimenti

isLoggedIn

  • isLoggedIn(): boolean

    Returns boolean

OptionalisWebAuthnSupported

  • isWebAuthnSupported(): boolean

    Returns boolean

    Deprecated

    Use getPlugin(CorePlugins.WebAuthn).isSupported() instead

login

  • login(username: string, password: string): Promise<AuthResult>

    Parameters

    • username: string
    • password: string

    Returns Promise<AuthResult>

OptionalloginWithMetaMask

  • loginWithMetaMask(address: string): Promise<AuthResult>

    Parameters

    • address: string

    Returns Promise<AuthResult>

    Deprecated

    Use getPlugin(CorePlugins.MetaMask).generateCredentials() instead

OptionalloginWithWebAuthn

  • loginWithWebAuthn(username: string): Promise<AuthResult>

    Parameters

    • username: string

    Returns Promise<AuthResult>

    Deprecated

    Use getPlugin(CorePlugins.WebAuthn).generateCredentials() instead

logout

  • logout(): void

    Returns void

match

  • match<T>(path: any, matchFn?: (data: any) => boolean): Observable<T[]>

    Type Parameters

    • T

    Parameters

    • path: any
    • OptionalmatchFn: (data: any) => boolean

    Returns Observable<T[]>

observe

  • observe<T>(path: any): Observable<T>

    Type Parameters

    • T

    Parameters

    • path: any

    Returns Observable<T>

observeUser

  • observeUser<T>(path: string): Observable<T>

    Type Parameters

    • T

    Parameters

    • path: string

    Returns Observable<T>

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): any

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void

    Returns any

on

  • on(eventName: string | symbol, listener: (...args: any[]) => void): any

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void

    Returns any

once

  • once(eventName: string | symbol, listener: (...args: any[]) => void): any

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void

    Returns any

onceObservable

  • onceObservable<T>(path: any): Observable<T>

    Type Parameters

    • T

    Parameters

    • path: any

    Returns Observable<T>

put

  • put(data: Record<string, any>): Promise<any>

    Parameters

    • data: Record<string, any>

    Returns Promise<any>

register

removeAllListeners

  • removeAllListeners(eventName?: string | symbol): any

    Parameters

    • OptionaleventName: string | symbol

    Returns any

rxPut

  • rxPut<T>(path: any, data: T): Observable<T>

    Type Parameters

    • T

    Parameters

    • path: any
    • data: T

    Returns Observable<T>

rxSet

  • rxSet<T>(path: any, data: T): Observable<T>

    Type Parameters

    • T

    Parameters

    • path: any
    • data: T

    Returns Observable<T>

rxUserPut

  • rxUserPut<T>(path: string, data: T): Observable<T>

    Type Parameters

    • T

    Parameters

    • path: string
    • data: T

    Returns Observable<T>

setRpcUrl

  • setRpcUrl(rpcUrl: string): boolean

    Parameters

    • rpcUrl: string

    Returns boolean

signUp

  • signUp(
        username: string,
        password: string,
        passwordConfirmation?: string,
    ): Promise<SignUpResult>

    Parameters

    • username: string
    • password: string
    • OptionalpasswordConfirmation: string

    Returns Promise<SignUpResult>

OptionalsignUpWithMetaMask

  • signUpWithMetaMask(address: string): Promise<AuthResult>

    Parameters

    • address: string

    Returns Promise<AuthResult>

    Deprecated

    Use getPlugin(CorePlugins.MetaMask).generateCredentials() and signUp() instead

OptionalsignUpWithWebAuthn

  • signUpWithWebAuthn(username: string): Promise<AuthResult>

    Parameters

    • username: string

    Returns Promise<AuthResult>

    Deprecated

    Use getPlugin(CorePlugins.WebAuthn).generateCredentials() and signUp() instead

unregister

  • unregister(pluginName: string): void

    Cancella la registrazione di un plugin

    Parameters

    • pluginName: string

      Nome del plugin da cancellare

    Returns void

userGet

  • userGet(path: string): Promise<any>

    Parameters

    • path: string

    Returns Promise<any>

userPut

  • userPut(data: Record<string, any>): Promise<any>

    Parameters

    • data: Record<string, any>

    Returns Promise<any>

Settings

Member Visibility

On This Page

Properties
Methods