Class NDKNip46Backend

constructor

• new NDKNip46Backend(ndk: default, signer: NDKSigner, permitCallback: Nip46PermitCallback, relayUrls?: string[]): NDKNip46Backend

• Parameters

  • ndk: default

    The NDK instance to use

  • signer: NDKSigner

    The signer for the private key that wants to be published as

  • permitCallback: Nip46PermitCallback

    Callback executed when permission is requested

  • Optional relayUrls: string[]

  Returns NDKNip46Backend
• new NDKNip46Backend(ndk: default, privateKey: string, permitCallback: Nip46PermitCallback, relayUrls?: string[]): NDKNip46Backend

• Parameters

  • ndk: default

    The NDK instance to use

  • privateKey: string

    The private key of the npub that wants to be published as

  • permitCallback: Nip46PermitCallback

    Callback executed when permission is requested

  • Optional relayUrls: string[]

  Returns NDKNip46Backend

Readonly debug

handlers

Optional localUser

Readonly ndk

relayUrls

rpc

Readonly signer

applyToken

• applyToken(pubkey: string, token: string): Promise<void>

• Overload this method to apply tokens, which can wrap permission sets to be applied to a pubkey.

  Parameters

  • pubkey: string

    public key to apply token to

  • token: string

    token to apply

  Returns Promise<void>

pubkeyAllowed

• pubkeyAllowed(params: Nip46PermitCallbackParams): Promise<boolean>

• This method should be overriden by the user to allow or reject incoming connections.

  Parameters

  • params: Nip46PermitCallbackParams

  Returns Promise<boolean>

setStrategy

• setStrategy(method: string, strategy: IEventHandlingStrategy): void

• Enables the user to set a custom strategy for handling incoming events.

  Parameters

  • method: string

    The method to set the strategy for

  • strategy: IEventHandlingStrategy

    The strategy to set

  Returns void

start

• start(): Promise<void>

• This method starts the backend, which will start listening for incoming requests.

  Returns Promise<void>