Class DataBase

Index

Constructors

Properties

_rxjs? crypto eventEmitter gun node onAuthCallbacks sea user Errors

Methods

addPeer authenticateNewUser buildLoginResult clearSession createAliasIndex createEpubIndex createNewUser createNewUserWithPair createReverseLookup createUserMetadata createUsernameMapping createUserRegistry emit forgotPassword get getAllConfiguredPeers getAllRegisteredUsers getAppScope getCurrentPeers getCurrentUser getData getGun getPasswordHint getPeerInfo getUser getUserAliasByPub getUserByAlias getUserDataByPub getUserPub getUserPubByEpub initialize isAuthenticated isLoggedIn leave loadSession login loginWithPair logout navigateToPath notifyAuthListeners off on onAuth once performAuthentication put recall reconnectToPeer remove removePeer resetPeers restoreSession runPostAuthOnAuthResult rx saveCredentials saveSession set setPasswordHint setPasswordHintWithSecurity setupComprehensiveUserTracking setUserData signUp subscribeToAuthEvents updateUserLastSeen validatePasswordStrength validateSignupCredentials

Constructors

constructor

new DataBase(gun: IGunInstance, appScope?: string): DataBase
Parameters
- gun: IGunInstance
- appScope: string = "shogun"
Returns DataBase

Properties

`Private` `Optional`_rxjs

_rxjs?: RxJS

crypto

crypto: crypto

`Private` `Readonly`eventEmitter

eventEmitter: EventEmitter

gun

gun: IGunInstance

node

node: IGunChain<any, any, any, any>

`Private` `Readonly`onAuthCallbacks

onAuthCallbacks: AuthCallback[] = []

sea

sea: SEA

user

user: null | IGunUserInstance<any, any, any, any> = null

`Static`Errors

Errors: GunErrors = GunErrors

Methods

addPeer

addPeer(peer: string): void
Adds a new peer to the network
Parameters
- peer: string
  URL of the peer to add
Returns void

`Private`authenticateNewUser

authenticateNewUser(
    username: string,
    password: string,
    pair?: null | ISEAPair,
): Promise<{ error?: string; success: boolean; userPub?: string }>
Authenticates user after creation
Parameters
- username: string
- password: string
- Optionalpair: null | ISEAPair
Returns Promise<{ error?: string; success: boolean; userPub?: string }>

`Private`buildLoginResult

buildLoginResult(username: string, userPub: string): AuthResult
Builds login result object
Parameters
- username: string
- userPub: string
Returns AuthResult

clearSession

clearSession(): void
Clear session

Returns void

`Private`createAliasIndex

createAliasIndex(username: string, userPub: string): Promise<boolean>
Creates alias index following GunDB pattern: ~@alias -> userPub
Parameters
- username: string
- userPub: string
Returns Promise<boolean>

`Private`createEpubIndex

createEpubIndex(epub: string, userPub: string): Promise<boolean>
Creates epub index: epubKeys/epub -> userPub
Parameters
- epub: string
- userPub: string
Returns Promise<boolean>

`Private`createNewUser

createNewUser(
username: string,
password: string,
): Promise<{ error?: string; success: boolean; userPub?: string }>
Creates a new user in Gun
Parameters
- username: string
- password: string
Returns Promise<{ error?: string; success: boolean; userPub?: string }>

`Private`createNewUserWithPair

createNewUserWithPair(
username: string,
pair: ISEAPair,
): Promise<{ error?: string; success: boolean; userPub?: string }>
Creates a new user in Gun with pair-based authentication (for Web3/plugins)
Parameters
- username: string
- pair: ISEAPair
Returns Promise<{ error?: string; success: boolean; userPub?: string }>

`Private`createReverseLookup

createReverseLookup(username: string, userPub: string): Promise<boolean>
Creates reverse lookup: userPub -> alias
Parameters
- username: string
- userPub: string
Returns Promise<boolean>

`Private`createUserMetadata

createUserMetadata(
    username: string,
    userPub: string,
    epub: null | string,
): Promise<boolean>
Creates user metadata in user's own node
Parameters
- username: string
- userPub: string
- epub: null | string
Returns Promise<boolean>

`Private`createUsernameMapping

createUsernameMapping(username: string, userPub: string): Promise<boolean>
Creates username mapping: usernames/alias -> userPub
Parameters
- username: string
- userPub: string
Returns Promise<boolean>

`Private`createUserRegistry

createUserRegistry(
    username: string,
    userPub: string,
    epub: null | string,
): Promise<boolean>
Creates user registry: users/userPub -> user data
Parameters
- username: string
- userPub: string
- epub: null | string
Returns Promise<boolean>

emit

emit(event: string | symbol, data?: any): boolean
Emits an event
Parameters
- event: string | symbol
  Event name
- Optionaldata: any
  Event data
Returns boolean

forgotPassword

forgotPassword(
username: string,
securityAnswers: string[],
): Promise<{ error?: string; hint?: string; success: boolean }>
Recovers password hint using security question answers
Parameters
- username: string
  Username
- securityAnswers: string[]
  Array of answers to security questions
Returns Promise<{ error?: string; hint?: string; success: boolean }>
Promise resolving with the password hint

get

get(path: string): IGunChain<any, any>
Gets a node at the specified path
Parameters
- path: string
  Path to the node
Returns IGunChain<any, any>
Gun node

getAllConfiguredPeers

getAllConfiguredPeers(): string[]
Gets the list of all configured peers (connected and disconnected)

Returns string[]
Array of peer URLs

getAllRegisteredUsers

getAllRegisteredUsers(): Promise<
    {
        epub: null
        | string;
        lastSeen: number;
        registeredAt: number;
        username: string;
        userPub: string;
    }[],
>
Gets all registered users (for admin purposes)

Returns Promise<
    {
        epub: null
        | string;
        lastSeen: number;
        registeredAt: number;
        username: string;
        userPub: string;
    }[],
>
Promise resolving to array of user information

getAppScope

getAppScope(): string
Get app scope

Returns string

getCurrentPeers

getCurrentPeers(): string[]
Gets the list of currently connected peers

Returns string[]
Array of peer URLs

getCurrentUser

getCurrentUser(): null | UserInfo
Gets the current user

Returns null | UserInfo
Current user object or null

getData

getData(path: string): Promise<any>
Gets data at the specified path (one-time read)
Parameters
- path: string
  Path to get the data from
Returns Promise<any>
Promise resolving to the data

getGun

getGun(): IGunInstance
Gets the Gun instance

Returns IGunInstance
Gun instance

getPasswordHint

getPasswordHint(): null | string
Get password hint

Returns null | string

getPeerInfo

getPeerInfo(): { [peer: string]: { connected: boolean; status: string } }
Gets detailed information about all peers

Returns { [peer: string]: { connected: boolean; status: string } }
Object with peer information

getUser

getUser(): IGunUserInstance
Gets the current user instance

Returns IGunUserInstance
User instance

getUserAliasByPub

getUserAliasByPub(userPub: string): Promise<null | string>
Gets user alias by public key
Parameters
- userPub: string
  User's public key
Returns Promise<null | string>
Promise resolving to user alias or null if not found

getUserByAlias

getUserByAlias(
    alias: string,
): Promise<
    | null
    | {
        epub: null
        | string;
        lastSeen: number;
        registeredAt: number;
        username: string;
        userPub: string;
    },
>
Gets user information by alias using the comprehensive tracking system
Parameters
- alias: string
  Username/alias to lookup
Returns Promise<
    | null
    | {
        epub: null
        | string;
        lastSeen: number;
        registeredAt: number;
        username: string;
        userPub: string;
    },
>
Promise resolving to user information or null if not found

getUserDataByPub

getUserDataByPub(
    userPub: string,
): Promise<
    | null
    | {
        epub: null
        | string;
        lastSeen: number;
        registeredAt: number;
        username: string;
        userPub: string;
    },
>
Gets user information by public key
Parameters
- userPub: string
  User's public key
Returns Promise<
    | null
    | {
        epub: null
        | string;
        lastSeen: number;
        registeredAt: number;
        username: string;
        userPub: string;
    },
>
Promise resolving to user information or null if not found

getUserPub

getUserPub(): null | string
Get user public key

Returns null | string

getUserPubByEpub

getUserPubByEpub(epub: string): Promise<null | string>
Gets user public key by encryption public key (epub)
Parameters
- epub: string
  User's encryption public key
Returns Promise<null | string>
Promise resolving to user public key or null if not found

initialize

initialize(appScope?: string): Promise<void>
Initialize the GunInstance asynchronously This method should be called after construction to perform async operations
Parameters
- appScope: string = "shogun"
Returns Promise<void>

isAuthenticated

isAuthenticated(): boolean
Check if user is authenticated

Returns boolean

isLoggedIn

isLoggedIn(): boolean
Checks if a user is currently logged in

Returns boolean
True if logged in

leave

leave(): void
Leave user session

Returns void

loadSession

loadSession(): any
Load session from storage

Returns any

login

login(
    username: string,
    password: string,
    pair?: null | ISEAPair,
): Promise<AuthResult>
Performs login with username and password
Parameters
- username: string
  Username
- password: string
  Password
- Optionalpair: null | ISEAPair
  SEA pair (optional)
Returns Promise<AuthResult>
Promise resolving to AuthResult object

loginWithPair

loginWithPair(username: string, pair: ISEAPair): Promise<AuthResult>
Performs login with GunDB pair directly
Parameters
- username: string
  Username
- pair: ISEAPair
  SEA pair
Returns Promise<AuthResult>
Promise resolving to AuthResult object

logout

logout(): void
Returns void

`Private`navigateToPath

navigateToPath(node: IGunChain<any>, path: string): IGunChain<any>
Helper method to navigate to a nested path by splitting and chaining .get() calls
Parameters
- node: IGunChain<any>
  Starting Gun node
- path: string
  Path string (e.g., "test/data/marco")
Returns IGunChain<any>
Gun node at the specified path

`Private`notifyAuthListeners

notifyAuthListeners(pub: string): void
Parameters
- pub: string
Returns void

off

off(event: string | symbol, listener: EventListener): void
Removes an event listener
Parameters
- event: string | symbol
  Event name
- listener: EventListener
  Event listener function
Returns void

on

on(event: string | symbol, listener: EventListener): void
Adds an event listener
Parameters
- event: string | symbol
  Event name
- listener: EventListener
  Event listener function
Returns void

onAuth

onAuth(callback: AuthCallback): () => void
Registers an authentication callback
Parameters
- callback: AuthCallback
  Function to call on auth events
Returns () => void
Function to unsubscribe the callback

once

once(event: string | symbol, listener: EventListener): void
Adds a one-time event listener
Parameters
- event: string | symbol
  Event name
- listener: EventListener
  Event listener function
Returns void

`Private`performAuthentication

performAuthentication(
    username: string,
    password: string,
    pair?: null | ISEAPair,
): Promise<{ ack?: any; error?: string; success: boolean }>
Performs authentication with Gun
Parameters
- username: string
- password: string
- Optionalpair: null | ISEAPair
Returns Promise<{ ack?: any; error?: string; success: boolean }>

put

put(path: string, data: any): Promise<GunMessagePut>
Puts data at the specified path
Parameters
- path: string
  Path to store data
- data: any
  Data to store
Returns Promise<GunMessagePut>
Promise resolving to operation result

recall

recall(options?: { sessionStorage?: boolean }): void
Recall user session
Parameters
- Optionaloptions: { sessionStorage?: boolean }
Returns void

reconnectToPeer

reconnectToPeer(peer: string): void
Reconnects to a specific peer
Parameters
- peer: string
  URL of the peer to reconnect
Returns void

remove

remove(path: string): Promise<GunMessagePut>
Removes data at the specified path
Parameters
- path: string
  Path to remove
Returns Promise<GunMessagePut>
Promise resolving to operation result

removePeer

removePeer(peer: string): void
Removes a peer from the network
Parameters
- peer: string
  URL of the peer to remove
Returns void

resetPeers

resetPeers(newPeers?: string[]): void
Clears all peers and optionally adds new ones
Parameters
- OptionalnewPeers: string[]
  Optional array of new peers to add
Returns void

restoreSession

restoreSession(): { error?: string; success: boolean; userPub?: string }
Attempts to restore user session from local storage

Returns { error?: string; success: boolean; userPub?: string }
Promise resolving to session restoration result

`Private`runPostAuthOnAuthResult

runPostAuthOnAuthResult(
    username: string,
    userPub: string,
    authResult: any,
): Promise<SignUpResult>
Parameters
- username: string
- userPub: string
- authResult: any
Returns Promise<SignUpResult>

rx

rx(): RxJS
Accesses the RxJS module for reactive programming

Returns RxJS
GunRxJS instance

`Private`saveCredentials

saveCredentials(
userInfo: { alias: string; pair: ISEAPair; userPub: string },
): void
Parameters
- userInfo: { alias: string; pair: ISEAPair; userPub: string }
Returns void

saveSession

saveSession(session: any): void
Save session to storage
Parameters
- session: any
Returns void

set

set(path: string, data: any): Promise<GunMessagePut>
Sets data at the specified path
Parameters
- path: string
  Path to store data
- data: any
  Data to store
Returns Promise<GunMessagePut>
Promise resolving to operation result

setPasswordHint

setPasswordHint(hint: string): void
Set password hint
Parameters
- hint: string
Returns void

setPasswordHintWithSecurity

setPasswordHintWithSecurity(
    username: string,
    password: string,
    hint: string,
    securityQuestions: string[],
    securityAnswers: string[],
): Promise<{ error?: string; success: boolean }>
Sets up security questions and password hint
Parameters
- username: string
  Username
- password: string
  Current password
- hint: string
  Password hint
- securityQuestions: string[]
  Array of security questions
- securityAnswers: string[]
  Array of answers to security questions
Returns Promise<{ error?: string; success: boolean }>
Promise resolving with the operation result

`Private`setupComprehensiveUserTracking

setupComprehensiveUserTracking(
    username: string,
    userPub: string,
    epub: string,
): Promise<boolean>
Sets up comprehensive user tracking system for agile user lookup Creates multiple indexes for efficient user discovery
Parameters
- username: string
- userPub: string
- epub: string
Returns Promise<boolean>

setUserData

setUserData(data: any): void
Set user data
Parameters
- data: any
Returns void

signUp

signUp(
    username: string,
    password: string,
    pair?: null | ISEAPair,
): Promise<SignUpResult>
Signs up a new user using direct Gun authentication
Parameters
- username: string
  Username
- password: string
  Password
- Optionalpair: null | ISEAPair
  Optional SEA pair for Web3 login
Returns Promise<SignUpResult>
Promise resolving to signup result

`Private`subscribeToAuthEvents

subscribeToAuthEvents(): void
Returns void

updateUserLastSeen

updateUserLastSeen(userPub: string): Promise<void>
Updates user's last seen timestamp
Parameters
- userPub: string
  User's public key
Returns Promise<void>

`Private`validatePasswordStrength

validatePasswordStrength(password: string): { error?: string; valid: boolean }
Validates password strength according to security requirements
Parameters
- password: string
Returns { error?: string; valid: boolean }

`Private`validateSignupCredentials

validateSignupCredentials(
    username: string,
    password: string,
    pair?: null | ISEAPair,
): { error?: string; valid: boolean }
Validates signup credentials with enhanced security
Parameters
- username: string
- password: string
- Optionalpair: null | ISEAPair
Returns { error?: string; valid: boolean }

Class DataBase

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DataBase

Properties

Private Optional_rxjs

crypto

Private ReadonlyeventEmitter

gun

node

Private ReadonlyonAuthCallbacks

sea

user

StaticErrors

Methods

addPeer

Parameters

Returns void

PrivateauthenticateNewUser

Parameters

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

PrivatebuildLoginResult

Parameters

Returns AuthResult

clearSession

Returns void

PrivatecreateAliasIndex

Parameters

Returns Promise<boolean>

PrivatecreateEpubIndex

Parameters

Returns Promise<boolean>

PrivatecreateNewUser

Parameters

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

PrivatecreateNewUserWithPair

Parameters

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

PrivatecreateReverseLookup

Parameters

Returns Promise<boolean>

PrivatecreateUserMetadata

Parameters

Returns Promise<boolean>

PrivatecreateUsernameMapping

Parameters

Returns Promise<boolean>

PrivatecreateUserRegistry

Parameters

Returns Promise<boolean>

emit

Parameters

Returns boolean

forgotPassword

Parameters

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

get

Parameters

Returns IGunChain<any, any>

getAllConfiguredPeers

Returns string[]

getAllRegisteredUsers

Returns Promise< { epub: null | string; lastSeen: number; registeredAt: number; username: string; userPub: string; }[],>

getAppScope

Returns string

getCurrentPeers

Returns string[]

getCurrentUser

Returns null | UserInfo

getData

Parameters

Returns Promise<any>

getGun

Returns IGunInstance

getPasswordHint

`Private` `Optional`_rxjs

`Private` `Readonly`eventEmitter

`Private` `Readonly`onAuthCallbacks

`Static`Errors

`Private`authenticateNewUser

`Private`buildLoginResult

`Private`createAliasIndex

`Private`createEpubIndex

`Private`createNewUser

`Private`createNewUserWithPair

`Private`createReverseLookup

`Private`createUserMetadata

`Private`createUsernameMapping

`Private`createUserRegistry

Returns Promise<
{
epub: null
| string;
lastSeen: number;
registeredAt: number;
username: string;
userPub: string;
}[],
>

Returns Promise<
| null
| {
epub: null
| string;
lastSeen: number;
registeredAt: number;
username: string;
userPub: string;
},
>

Returns Promise<
| null
| {
epub: null
| string;
lastSeen: number;
registeredAt: number;
username: string;
userPub: string;
},
>

`Private`navigateToPath

`Private`notifyAuthListeners

`Private`performAuthentication