Class SerialPortSigner

A signer that works with nostr-signing-device

Implements

Nip07Interface

Constructors

constructor

new SerialPortSigner(): SerialPortSigner
Returns SerialPortSigner
- Defined in packages/signers/src/signers/serial-port-signer.ts:44

Properties

`Protected`lastCommand

lastCommand: null | Deferred<string> = null

`Protected`log

log: Debugger = ...

nip04

nip04: {
    decrypt: (
        pubkey: string,
        ciphertext: string,
    ) => string | Promise<string>;
    encrypt: (pubkey: string, plaintext: string) => string | Promise<string>;
}

`Optional`pubkey

pubkey?: string

verifyEvent

verifyEvent: (event: Event) => event is VerifiedEvent = verifyEvent

`Protected`writer

writer: null | WritableStreamDefaultWriter<string> = null

`Static`METHOD_LOG

METHOD_LOG: string = "/log"

`Static`METHOD_PING

METHOD_PING: string = "/ping"

`Static`METHOD_PUBLIC_KEY

METHOD_PUBLIC_KEY: string = "/public-key"

`Static`METHOD_RESTORE

METHOD_RESTORE: string = "/restore"

`Static`METHOD_SHARED_SECRET

METHOD_SHARED_SECRET: string = "/shared-secret"

`Static`METHOD_SIGN_MESSAGE

METHOD_SIGN_MESSAGE: string = "/sign-message"

`Static`PUBLIC_METHODS

PUBLIC_METHODS: string[] = ...

`Static`SUPPORTED

SUPPORTED: boolean = ...

Accessors

isConnected

get isConnected(): boolean
Returns boolean
- Defined in packages/signers/src/signers/serial-port-signer.ts:34

Methods

callMethodOnDevice

callMethodOnDevice(
    method: string,
    params: string[],
    opts?: DeviceOpts,
): Promise<string>
Parameters
- method: string
- params: string[]
- opts: DeviceOpts = {}
Returns Promise<string>
- Defined in packages/signers/src/signers/serial-port-signer.ts:52

connectToDevice

connectToDevice(__namedParameters: DeviceOpts): Promise<void>
Parameters
- __namedParameters: DeviceOpts
Returns Promise<void>
- Defined in packages/signers/src/signers/serial-port-signer.ts:72

getPublicKey

getPublicKey(): Promise<string>
Returns the public key on the device

Returns Promise<string>
Implementation of Nip07Interface.getPublicKey
- Defined in packages/signers/src/signers/serial-port-signer.ts:228

nip04Decrypt

nip04Decrypt(pubkey: string, data: string): Promise<string>
Parameters
- pubkey: string
- data: string
Returns Promise<string>
- Defined in packages/signers/src/signers/serial-port-signer.ts:211

nip04Encrypt

nip04Encrypt(pubkey: string, text: string): Promise<string>
Parameters
- pubkey: string
- text: string
Returns Promise<string>
- Defined in packages/signers/src/signers/serial-port-signer.ts:198

`Protected`parseResponse

parseResponse(value: string): { data: string; method: string }
Parameters
- value: string
Returns { data: string; method: string }
- Defined in packages/signers/src/signers/serial-port-signer.ts:190

ping

ping(): void
Pings to device to see if the connection is open

Returns void
- Defined in packages/signers/src/signers/serial-port-signer.ts:253

`Protected`readFromSerialPort

readFromSerialPort(
reader: ReadableStreamDefaultReader<string>,
): (separator?: string) => Promise<{ done: boolean; value: string }>
Parameters
- reader: ReadableStreamDefaultReader<string>
Returns (separator?: string) => Promise<{ done: boolean; value: string }>
- Defined in packages/signers/src/signers/serial-port-signer.ts:158

restore

restore(secretKey: Uint8Array): Promise<void>
Sets the secret key used on the device
Parameters
- secretKey: Uint8Array
Returns Promise<void>
- Defined in packages/signers/src/signers/serial-port-signer.ts:235

sendCommand

sendCommand(method: string, params?: string[]): Promise<void>
Parameters
- method: string
- params: string[] = []
Returns Promise<void>
- Defined in packages/signers/src/signers/serial-port-signer.ts:151

signEvent

signEvent(draft: EventTemplate & { pubkey?: string }): Promise<VerifiedEvent>
Requires the device to sign an event
Parameters
- draft: EventTemplate & { pubkey?: string }
Returns Promise<VerifiedEvent>
Implementation of Nip07Interface.signEvent
- Defined in packages/signers/src/signers/serial-port-signer.ts:240

Class SerialPortSigner

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns SerialPortSigner

Properties

ProtectedlastCommand

Protectedlog

nip04

Optionalpubkey

verifyEvent

Protectedwriter

StaticMETHOD_LOG

StaticMETHOD_PING

StaticMETHOD_PUBLIC_KEY

StaticMETHOD_RESTORE

StaticMETHOD_SHARED_SECRET

StaticMETHOD_SIGN_MESSAGE

StaticPUBLIC_METHODS

StaticSUPPORTED

Accessors

isConnected

Returns boolean

Methods

callMethodOnDevice

Parameters

Returns Promise<string>

connectToDevice

Parameters

Returns Promise<void>

getPublicKey

Returns Promise<string>

nip04Decrypt

Parameters

Returns Promise<string>

nip04Encrypt

Parameters

Returns Promise<string>

ProtectedparseResponse

Parameters

Returns { data: string; method: string }

ping

Returns void

ProtectedreadFromSerialPort

Parameters

Returns (separator?: string) => Promise<{ done: boolean; value: string }>

restore

Parameters

Returns Promise<void>

sendCommand

Parameters

Returns Promise<void>

signEvent

Parameters

Returns Promise<VerifiedEvent>

Settings

On This Page

`Protected`lastCommand

`Protected`log

`Optional`pubkey

`Protected`writer

`Static`METHOD_LOG

`Static`METHOD_PING

`Static`METHOD_PUBLIC_KEY

`Static`METHOD_RESTORE

`Static`METHOD_SHARED_SECRET

`Static`METHOD_SIGN_MESSAGE

`Static`PUBLIC_METHODS

`Static`SUPPORTED

`Protected`parseResponse

`Protected`readFromSerialPort