Class NDKNostrRpc

Hierarchy

EventEmitter
- NDKNostrRpc

Index

Constructors

constructor

Methods

parseEvent sendRequest sendResponse subscribe

Constructors

constructor

new NDKNostrRpc(ndk: default, signer: NDKSigner, debug: Debugger, relayUrls?: string[]): NDKNostrRpc
Parameters
- ndk: default
- signer: NDKSigner
- debug: Debugger
- Optional relayUrls: string[]
Returns NDKNostrRpc
Overrides EventEmitter.constructor
- Defined in ndk/src/signers/nip46/rpc.ts:36

Methods

parseEvent

parseEvent(event: NDKEvent): Promise<NDKRpcRequest | NDKRpcResponse>
Parameters
- event: NDKEvent
Returns Promise<NDKRpcRequest | NDKRpcResponse>
- Defined in ndk/src/signers/nip46/rpc.ts:76

sendRequest

sendRequest(remotePubkey: string, method: string, params?: string[], kind?: number, cb?: ((res: NDKRpcResponse) => void)): Promise<NDKRpcResponse>
Sends a request.
Parameters
- remotePubkey: string
- method: string
- params: string[] = []
- kind: number = 24133
- Optional cb: ((res: NDKRpcResponse) => void)
  - - (res: NDKRpcResponse): void
    - Parameters
      
      res: NDKRpcResponse
      
      Returns void
Returns Promise<NDKRpcResponse>
- Defined in ndk/src/signers/nip46/rpc.ts:124

sendResponse

sendResponse(id: string, remotePubkey: string, result: string, kind?: NDKKind, error?: string): Promise<void>
Parameters
- id: string
- remotePubkey: string
- result: string
- kind: NDKKind = NDKKind.NostrConnect
- Optional error: string
Returns Promise<void>
- Defined in ndk/src/signers/nip46/rpc.ts:90

subscribe(filter: NDKFilter): Promise<NDKSubscription>
Subscribe to a filter. This function will resolve once the subscription is ready.
Parameters
- filter: NDKFilter
Returns Promise<NDKSubscription>
- Defined in ndk/src/signers/nip46/rpc.ts:47

Class NDKNostrRpc

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

ndk: default

signer: NDKSigner

debug: Debugger

Optional relayUrls: string[]

Returns NDKNostrRpc

Methods

parseEvent

Parameters

event: NDKEvent

Returns Promise<NDKRpcRequest | NDKRpcResponse>

sendRequest

Parameters

remotePubkey: string

method: string

params: string[] = []

kind: number = 24133

Optional cb: ((res: NDKRpcResponse) => void)

Parameters

res: NDKRpcResponse

Returns void

Returns Promise<NDKRpcResponse>

sendResponse

Parameters

id: string

remotePubkey: string

result: string

kind: NDKKind = NDKKind.NostrConnect

Optional error: string

Returns Promise<void>

subscribe

Parameters

filter: NDKFilter

Returns Promise<NDKSubscription>

Settings

Member Visibility

Theme

On This Page

`Optional` relayUrls: string[]

`Optional` cb: ((res: NDKRpcResponse) => void)

`Optional` error: string