Class SerialPortSigner

constructor

• new SerialPortSigner(): SerialPortSigner

  Returns SerialPortSigner

nip04

Optionalpubkey

verifyEvent

StaticMETHOD_LOG

StaticMETHOD_PING

StaticMETHOD_PUBLIC_KEY

StaticMETHOD_RESTORE

StaticMETHOD_SHARED_SECRET

StaticMETHOD_SIGN_MESSAGE

StaticPUBLIC_METHODS

StaticSUPPORTED

isConnected

• get isConnected(): boolean

  Returns boolean

callMethodOnDevice

• callMethodOnDevice(
      method: string,
      params: string[],
      opts?: DeviceOpts,
  ): Promise<string>

  Parameters

  • method: string
  • params: string[]
  • opts: DeviceOpts = {}

  Returns Promise<string>

connectToDevice

• connectToDevice(__namedParameters: DeviceOpts): Promise<void>

  Parameters

  • __namedParameters: DeviceOpts

  Returns Promise<void>

getPublicKey

• getPublicKey(): Promise<string>

  Returns the public key on the device

  Returns Promise<string>

nip04Decrypt

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

  Parameters

  • pubkey: string
  • data: string

  Returns Promise<string>

nip04Encrypt

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

  Parameters

  • pubkey: string
  • text: string

  Returns Promise<string>

ping

• ping(): void

  Pings to device to see if the connection is open

  Returns void

restore

• restore(secretKey: Uint8Array): Promise<void>

  Sets the secret key used on the device

  Parameters

  • secretKey: Uint8Array

  Returns Promise<void>

sendCommand

• sendCommand(method: string, params?: string[]): Promise<void>

  Parameters

  • method: string
  • params: string[] = []

  Returns Promise<void>

signEvent

• signEvent(
      draft: Helpers.EventTemplate & { pubkey?: string },
  ): Promise<VerifiedEvent>

  Requires the device to sign an event

  Parameters

  • draft: Helpers.EventTemplate & { pubkey?: string }

  Returns Promise<VerifiedEvent>