Class GunInstance

constructor

• new GunInstance(gun: IGunInstance<any>, appScope?: string): GunInstance

  Parameters

  • gun: IGunInstance<any>
  • appScope: string = "shogun"

  Returns GunInstance

crypto

gun

node

user

utils

StaticErrors

addPeer

• addPeer(peer: string): void

  Adds a new peer to the network

  Parameters

  • peer: string

    URL of the peer to add

  Returns void

decrypt

• decrypt(encryptedData: string, key: string): Promise<any>

  Decrypts data with Gun.SEA

  Parameters

  • encryptedData: string

    Encrypted data
  • key: string

    Decryption key

  Returns Promise<any>

  Promise that resolves with the decrypted data

derive

• derive(password: any, extra?: any, options?: DeriveOptions): Promise<any>

  Derive cryptographic keys from password and optional extras Supports multiple key derivation algorithms: P-256, secp256k1 (Bitcoin), secp256k1 (Ethereum)

  Parameters

  • password: any

    Password or seed for key derivation
  • Optionalextra: any

    Additional entropy (string or array of strings)
  • Optionaloptions: DeriveOptions

    Derivation options to specify which key types to generate

  Returns Promise<any>

  Promise resolving to derived keys object

deriveAll

• deriveAll(password: any, extra?: any): Promise<any>

  Derive all supported key types

  Parameters

  • password: any

    Password for key derivation
  • Optionalextra: any

    Additional entropy

  Returns Promise<any>

  Promise resolving to all key types

deriveBitcoin

• deriveBitcoin(password: any, extra?: any): Promise<any>

  Derive Bitcoin secp256k1 keys with P2PKH address

  Parameters

  • password: any

    Password for key derivation
  • Optionalextra: any

    Additional entropy

  Returns Promise<any>

  Promise resolving to Bitcoin keys and address

deriveEthereum

• deriveEthereum(password: any, extra?: any): Promise<any>

  Derive Ethereum secp256k1 keys with Keccak256 address

  Parameters

  • password: any

    Password for key derivation
  • Optionalextra: any

    Additional entropy

  Returns Promise<any>

  Promise resolving to Ethereum keys and address

deriveP256

• deriveP256(password: any, extra?: any): Promise<any>

  Derive P-256 keys (default Gun.SEA behavior)

  Parameters

  • password: any

    Password for key derivation
  • Optionalextra: any

    Additional entropy

  Returns Promise<any>

  Promise resolving to P-256 keys

encrypt

• encrypt(data: any, key: string): Promise<string>

  Encrypts data with Gun.SEA

  Parameters

  • data: any

    Data to encrypt
  • key: string

    Encryption key

  Returns Promise<string>

  Promise that resolves with the encrypted data

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): any

  Gets a node at the specified path

  Parameters

  • path: string

    Path to the node

  Returns any

  Gun node

getAllConfiguredPeers

• getAllConfiguredPeers(): string[]

  Gets the list of all configured peers (connected and disconnected)

  Returns string[]

  Array of peer URLs

getCurrentPeers

• getCurrentPeers(): string[]

  Gets the list of currently connected peers

  Returns string[]

  Array of peer URLs

getCurrentUser

• getCurrentUser(): any

  Gets the current user

  Returns any

  Current user object or null

getGun

• getGun(): IGunInstance<any>

  Gets the Gun instance

  Returns IGunInstance<any>

  Gun instance

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(): any

  Gets the current user instance

  Returns any

  User instance

getUserData

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

  Gets user data from the specified path

  Parameters

  • path: string

    Path to get the data from (supports nested paths like "test/data/marco")

  Returns Promise<any>

  Promise that resolves with the data

hashText

• hashText(text: string): Promise<any>

  Hashes text with Gun.SEA

  Parameters

  • text: string

    Text to hash

  Returns Promise<any>

  Promise that resolves with the hashed text

isLoggedIn

• isLoggedIn(): boolean

  Checks if a user is currently logged in

  Returns boolean

  True if logged in

login

• login(
      username: string,
      password: string,
      callback?: (result: any) => void,
  ): Promise<any>

  Logs in a user using direct Gun authentication

  Parameters

  • username: string

    Username
  • password: string

    Password
  • Optionalcallback: (result: any) => void

    Optional callback for login result

  Returns Promise<any>

  Promise resolving to login result

logout

• logout(): void

  Logs out the current user using direct Gun authentication

  Returns void

onAuth

• onAuth(callback: (user: any) => void): () => void

  Registers an authentication callback

  Parameters

  • callback: (user: any) => void

    Function to call on auth events

  Returns () => void

  Function to unsubscribe the callback

put

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

  Puts data at the specified path

  Parameters

  • path: string

    Path to store data
  • data: any

    Data to store

  Returns Promise<any>

  Promise resolving to operation result

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<any>

  Removes data at the specified path

  Parameters

  • path: string

    Path to remove

  Returns Promise<any>

  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(): Promise<
      { error?: string; success: boolean; userPub?: string },
  >

  Attempts to restore user session from local storage

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

  Promise resolving to session restoration result

rx

• rx(): GunRxJS

  Accesses the RxJS module for reactive programming

  Returns GunRxJS

  GunRxJS instance

saveUserData

• saveUserData(path: string, data: any): Promise<void>

  Saves user data at the specified path

  Parameters

  • path: string

    Path to save the data (supports nested paths like "test/data/marco")
  • data: any

    Data to save

  Returns Promise<void>

  Promise that resolves when the data is saved

set

• set(path: string, data: any): Promise<any>

  Sets data at the specified path

  Parameters

  • path: string

    Path to store data
  • data: any

    Data to store

  Returns Promise<any>

  Promise resolving to operation result

setPasswordHint

• setPasswordHint(
      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

signUp

• signUp(username: string, password: string): Promise<any>

  Signs up a new user using direct Gun authentication

  Parameters

  • username: string

    Username
  • password: string

    Password

  Returns Promise<any>

  Promise resolving to signup result