Interface NostrConnectorPluginInterface

Interface for the Bitcoin wallet plugin

interface NostrConnectorPluginInterface {
    cleanup(): void;
    connectBitcoinWallet(
        type?: "nostr" | "alby" | "manual",
    ): Promise<ConnectionResult>;
    generateCredentials(address: string): Promise<NostrConnectorCredentials>;
    generatePassword(signature: string): Promise<string>;
    isAvailable(): boolean;
    login(address: string): Promise<AuthResult>;
    signUp(address: string): Promise<AuthResult>;
    verifySignature(
        message: string,
        signature: string,
        address: string,
    ): Promise<boolean>;
}

Implemented by

Methods

cleanup connectBitcoinWallet generateCredentials generatePassword isAvailable login signUp verifySignature

Methods

cleanup

  • cleanup(): void

    Release resources and clean up event listeners

    Returns void

connectBitcoinWallet

  • connectBitcoinWallet(
        type?: "nostr" | "alby" | "manual",
    ): Promise<ConnectionResult>

    Connect to a Bitcoin wallet

    Parameters

    • Optionaltype: "nostr" | "alby" | "manual"

      Type of wallet to connect to

    Returns Promise<ConnectionResult>

    Promise with the connection result

generateCredentials

generatePassword

  • generatePassword(signature: string): Promise<string>

    Generate a password based on a signature

    Parameters

    • signature: string

      Signature

    Returns Promise<string>

    Promise with the generated password

isAvailable

  • isAvailable(): boolean

    Check if any Bitcoin wallet is available in the browser

    Returns boolean

    true if a wallet is available, false otherwise

login

  • login(address: string): Promise<AuthResult>

    Login with Bitcoin wallet

    Parameters

    • address: string

      Bitcoin address

    Returns Promise<AuthResult>

    Promise with the operation result

signUp

  • signUp(address: string): Promise<AuthResult>

    Signup with Bitcoin wallet

    Parameters

    • address: string

      Bitcoin address

    Returns Promise<AuthResult>

    Promise with the operation result

verifySignature

  • verifySignature(
        message: string,
        signature: string,
        address: string,
    ): Promise<boolean>

    Verify a signature

    Parameters

    • message: string

      Signed message

    • signature: string

      Signature to verify

    • address: string

      The Bitcoin address that supposedly created the signature

    Returns Promise<boolean>

    Promise that resolves to true if the signature is valid

Settings

Member Visibility

On This Page

Methods