Class PasswordSigner

constructor

• new PasswordSigner(): PasswordSigner

  Returns PasswordSigner

key

Optionalncryptsec

nip04

nip44

OptionalunlockPromise

unlocked

• get unlocked(): boolean

  Returns boolean

getPublicKey

• getPublicKey(): Promise<string>

  Returns Promise<string>

lock

• lock(): void

  Locks the signer by removing the unencrypted key from memory

  Returns void

nip04Decrypt

• nip04Decrypt(pubkey: string, ciphertext: string): Promise<string>

  Parameters

  • pubkey: string
  • ciphertext: string

  Returns Promise<string>

nip04Encrypt

• nip04Encrypt(pubkey: string, plaintext: string): Promise<string>

  Parameters

  • pubkey: string
  • plaintext: string

  Returns Promise<string>

nip44Decrypt

• nip44Decrypt(pubkey: string, ciphertext: string): Promise<string>

  Parameters

  • pubkey: string
  • ciphertext: string

  Returns Promise<string>

nip44Encrypt

• nip44Encrypt(pubkey: string, plaintext: string): Promise<string>

  Parameters

  • pubkey: string
  • plaintext: string

  Returns Promise<string>

setPassword

• setPassword(password: string): Promise<void>

  Sets the ncryptsec from the key and password

  Parameters

  • password: string

  Returns Promise<void>

signEvent

• signEvent(event: Helpers.EventTemplate): Promise<VerifiedEvent>

  Parameters

  • event: Helpers.EventTemplate

  Returns Promise<VerifiedEvent>

testPassword

• testPassword(password: string): Promise<void>

  Tests if the provided password is correct by decrypting the ncryptsec

  Parameters

  • password: string

  Returns Promise<void>

unlock

• unlock(password: string): Promise<void>

  Unlocks the signer by decrypting the ncryptsec using the provided password

  Parameters

  • password: string

  Returns Promise<void>

StaticfromNcryptsec

• fromNcryptsec(ncryptsec: string, password?: string): Promise<PasswordSigner>

  Creates a PasswordSigner from a ncryptsec and unlocks it with the provided password

  Parameters

  • ncryptsec: string
  • Optionalpassword: string

  Returns Promise<PasswordSigner>

StaticfromPrivateKey

• fromPrivateKey(
      privateKey: string | Uint8Array<ArrayBufferLike>,
      password: string,
  ): Promise<PasswordSigner>

  Creates a PasswordSigner from a hex private key or NIP-19 nsec and password

  Parameters

  • privateKey: string | Uint8Array<ArrayBufferLike>
  • password: string

  Returns Promise<PasswordSigner>