nostr-tools 2.23.2 → 2.23.4

package/lib/types/nip29.d.ts

@@ -1,265 +0,0 @@
-import { AbstractSimplePool } from './abstract-pool.ts';
-import type { Event, EventTemplate } from './core.ts';
-import { RelayInformation } from './nip11.ts';
-/**
- * Represents a NIP29 group.
- */
-export type Group = {
-    relay: string;
-    metadata: GroupMetadata;
-    admins?: GroupAdmin[];
-    members?: GroupMember[];
-    reference: GroupReference;
-};
-/**
- * Represents the metadata for a NIP29 group.
- */
-export type GroupMetadata = {
-    id: string;
-    pubkey: string;
-    name?: string;
-    picture?: string;
-    about?: string;
-    isPublic?: boolean;
-    isOpen?: boolean;
-};
-/**
- * Represents a NIP29 group reference.
- */
-export type GroupReference = {
-    id: string;
-    host: string;
-};
-/**
- * Represents a NIP29 group member.
- */
-export type GroupMember = {
-    pubkey: string;
-    label?: string;
-};
-/**
- * Represents a NIP29 group admin.
- */
-export type GroupAdmin = {
-    pubkey: string;
-    label?: string;
-    permissions: GroupAdminPermission[];
-};
-/**
- * Represents the permissions that a NIP29 group admin can have.
- */
-export declare enum GroupAdminPermission {
-    /** @deprecated use PutUser instead */
-    AddUser = "add-user",
-    EditMetadata = "edit-metadata",
-    DeleteEvent = "delete-event",
-    RemoveUser = "remove-user",
-    /** @deprecated removed from NIP */
-    AddPermission = "add-permission",
-    /** @deprecated removed from NIP */
-    RemovePermission = "remove-permission",
-    /** @deprecated removed from NIP */
-    EditGroupStatus = "edit-group-status",
-    PutUser = "put-user",
-    CreateGroup = "create-group",
-    DeleteGroup = "delete-group",
-    CreateInvite = "create-invite"
-}
-/**
- * Generates a group metadata event template.
- *
- * @param group - The group object.
- * @returns An event template with the generated group metadata that can be signed later.
- */
-export declare function generateGroupMetadataEventTemplate(group: Group): EventTemplate;
-/**
- * Validates a group metadata event.
- *
- * @param event - The event to validate.
- * @returns A boolean indicating whether the event is valid.
- */
-export declare function validateGroupMetadataEvent(event: Event): boolean;
-/**
- * Generates an event template for group admins.
- *
- * @param group - The group object.
- * @param admins - An array of group admins.
- * @returns The generated event template with the group admins that can be signed later.
- */
-export declare function generateGroupAdminsEventTemplate(group: Group, admins: GroupAdmin[]): EventTemplate;
-/**
- * Validates a group admins event.
- *
- * @param event - The event to validate.
- * @returns True if the event is valid, false otherwise.
- */
-export declare function validateGroupAdminsEvent(event: Event): boolean;
-/**
- * Generates an event template for a group with its members.
- *
- * @param group - The group object.
- * @param members - An array of group members.
- * @returns The generated event template with the group members that can be signed later.
- */
-export declare function generateGroupMembersEventTemplate(group: Group, members: GroupMember[]): EventTemplate;
-/**
- * Validates a group members event.
- *
- * @param event - The event to validate.
- * @returns Returns `true` if the event is a valid group members event, `false` otherwise.
- */
-export declare function validateGroupMembersEvent(event: Event): boolean;
-/**
- * Returns the normalized relay URL based on the provided group reference.
- *
- * @param groupReference - The group reference object containing the host.
- * @returns The normalized relay URL.
- */
-export declare function getNormalizedRelayURLByGroupReference(groupReference: GroupReference): string;
-/**
- * Fetches relay information by group reference.
- *
- * @param groupReference The group reference.
- * @returns A promise that resolves to the relay information.
- */
-export declare function fetchRelayInformationByGroupReference(groupReference: GroupReference): Promise<RelayInformation>;
-/**
- * Fetches the group metadata event from the specified pool.
- * If the normalizedRelayURL is not provided, it will be obtained using the groupReference.
- * If the relayInformation is not provided, it will be fetched using the normalizedRelayURL.
- *
- * @param {Object} options - The options object.
- * @param {AbstractSimplePool} options.pool - The pool to fetch the group metadata event from.
- * @param {GroupReference} options.groupReference - The reference to the group.
- * @param {string} [options.normalizedRelayURL] - The normalized URL of the relay.
- * @param {RelayInformation} [options.relayInformation] - The relay information object.
- * @returns {Promise<Event>} The group metadata event that can be parsed later to get the group metadata object.
- * @throws {Error} If the group is not found on the specified relay.
- */
-export declare function fetchGroupMetadataEvent({ pool, groupReference, relayInformation, normalizedRelayURL, }: {
-    pool: AbstractSimplePool;
-    groupReference: GroupReference;
-    normalizedRelayURL?: string;
-    relayInformation?: RelayInformation;
-}): Promise<Event>;
-/**
- * Parses a group metadata event and returns the corresponding GroupMetadata object.
- *
- * @param event - The event to parse.
- * @returns The parsed GroupMetadata object.
- * @throws An error if the group metadata event is invalid.
- */
-export declare function parseGroupMetadataEvent(event: Event): GroupMetadata;
-/**
- * Fetches the group admins event from the specified pool.
- * If the normalizedRelayURL is not provided, it will be obtained from the groupReference.
- * If the relayInformation is not provided, it will be fetched using the normalizedRelayURL.
- *
- * @param {Object} options - The options object.
- * @param {AbstractSimplePool} options.pool - The pool to fetch the group admins event from.
- * @param {GroupReference} options.groupReference - The reference to the group.
- * @param {string} [options.normalizedRelayURL] - The normalized relay URL.
- * @param {RelayInformation} [options.relayInformation] - The relay information.
- * @returns {Promise<Event>} The group admins event that can be parsed later to get the group admins object.
- * @throws {Error} If the group admins event is not found on the specified relay.
- */
-export declare function fetchGroupAdminsEvent({ pool, groupReference, relayInformation, normalizedRelayURL, }: {
-    pool: AbstractSimplePool;
-    groupReference: GroupReference;
-    normalizedRelayURL?: string;
-    relayInformation?: RelayInformation;
-}): Promise<Event>;
-/**
- * Parses a group admins event and returns an array of GroupAdmin objects.
- *
- * @param event - The event to parse.
- * @returns An array of GroupAdmin objects.
- * @throws Throws an error if the group admins event is invalid.
- */
-export declare function parseGroupAdminsEvent(event: Event): GroupAdmin[];
-/**
- * Fetches the group members event from the specified relay.
- * If the normalizedRelayURL is not provided, it will be obtained using the groupReference.
- * If the relayInformation is not provided, it will be fetched using the normalizedRelayURL.
- *
- * @param {Object} options - The options object.
- * @param {AbstractSimplePool} options.pool - The pool object.
- * @param {GroupReference} options.groupReference - The group reference object.
- * @param {string} [options.normalizedRelayURL] - The normalized relay URL.
- * @param {RelayInformation} [options.relayInformation] - The relay information object.
- * @returns {Promise<Event>} The group members event that can be parsed later to get the group members object.
- * @throws {Error} If the group members event is not found.
- */
-export declare function fetchGroupMembersEvent({ pool, groupReference, relayInformation, normalizedRelayURL, }: {
-    pool: AbstractSimplePool;
-    groupReference: GroupReference;
-    normalizedRelayURL?: string;
-    relayInformation?: RelayInformation;
-}): Promise<Event>;
-/**
- * Parses a group members event and returns an array of GroupMember objects.
- * @param event - The event to parse.
- * @returns An array of GroupMember objects.
- * @throws Throws an error if the group members event is invalid.
- */
-export declare function parseGroupMembersEvent(event: Event): GroupMember[];
-/**
- * Fetches and parses the group metadata event, group admins event, and group members event from the specified pool.
- * If the normalized relay URL is not provided, it will be obtained using the group reference.
- * If the relay information is not provided, it will be fetched using the normalized relay URL.
- *
- * @param {Object} options - The options for loading the group.
- * @param {AbstractSimplePool} options.pool - The pool to load the group from.
- * @param {GroupReference} options.groupReference - The reference of the group to load.
- * @param {string} [options.normalizedRelayURL] - The normalized URL of the relay to use.
- * @param {RelayInformation} [options.relayInformation] - The relay information to use.
- * @returns {Promise<Group>} A promise that resolves to the loaded group.
- */
-export declare function loadGroup({ pool, groupReference, normalizedRelayURL, relayInformation, }: {
-    pool: AbstractSimplePool;
-    groupReference: GroupReference;
-    normalizedRelayURL?: string;
-    relayInformation?: RelayInformation;
-}): Promise<Group>;
-/**
- * Loads a group from the specified pool using the provided group code.
- *
- * @param {AbstractSimplePool} pool - The pool to load the group from.
- * @param {string} code - The code representing the group.
- * @returns {Promise<Group>} - A promise that resolves to the loaded group.
- * @throws {Error} - If the group code is invalid.
- */
-export declare function loadGroupFromCode(pool: AbstractSimplePool, code: string): Promise<Group>;
-/**
- * Parses a group code and returns a GroupReference object.
- *
- * @param code The group code to parse.
- * @returns A GroupReference object if the code is valid, otherwise null.
- */
-export declare function parseGroupCode(code: string): null | GroupReference;
-/**
- * Encodes a group reference into a string.
- *
- * @param gr - The group reference to encode.
- * @returns The encoded group reference as a string.
- */
-export declare function encodeGroupReference(gr: GroupReference): string;
-/**
- * Subscribes to relay groups metadata events and calls the provided event handler function
- * when an event is received.
- *
- * @param {Object} options - The options for subscribing to relay groups metadata events.
- * @param {AbstractSimplePool} options.pool - The pool to subscribe to.
- * @param {string} options.relayURL - The URL of the relay.
- * @param {Function} options.onError - The error handler function.
- * @param {Function} options.onEvent - The event handler function.
- * @param {Function} [options.onConnect] - The connect handler function.
- * @returns {Function} - A function to close the subscription
- */
-export declare function subscribeRelayGroupsMetadataEvents({ pool, relayURL, onError, onEvent, onConnect, }: {
-    pool: AbstractSimplePool;
-    relayURL: string;
-    onError: (err: Error) => void;
-    onEvent: (event: Event) => void;
-    onConnect?: () => void;
-}): () => void;

package/lib/types/nip30.d.ts

@@ -1,22 +0,0 @@
-/** Regex for a single emoji shortcode. */
-export declare const EMOJI_SHORTCODE_REGEX: RegExp;
-/** Regex to find emoji shortcodes in content. */
-export declare const regex: () => RegExp;
-/** Represents a Nostr custom emoji. */
-export interface CustomEmoji {
-    /** The matched emoji name with colons. */
-    shortcode: `:${string}:`;
-    /** The matched emoji name without colons. */
-    name: string;
-}
-/** Match result for a custom emoji in text content. */
-export interface CustomEmojiMatch extends CustomEmoji {
-    /** Index where the emoji begins in the text content. */
-    start: number;
-    /** Index where the emoji ends in the text content. */
-    end: number;
-}
-/** Find all custom emoji shortcodes. */
-export declare function matchAll(content: string): Iterable<CustomEmojiMatch>;
-/** Replace all emoji shortcodes in the content. */
-export declare function replaceAll(content: string, replacer: (match: CustomEmoji) => string): string;

package/lib/types/nip30.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/types/nip39.d.ts

@@ -1,2 +0,0 @@
-export declare function useFetchImplementation(fetchImplementation: any): void;
-export declare function validateGithub(pubkey: string, username: string, proof: string): Promise<boolean>;

package/lib/types/nip39.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/types/nip40.d.ts

@@ -1,10 +0,0 @@
-import { Event } from './core.ts';
-/** Get the expiration of the event as a `Date` object, if any. */
-declare function getExpiration(event: Event): Date | undefined;
-/** Check if the event has expired. */
-declare function isEventExpired(event: Event): boolean;
-/** Returns a promise that resolves when the event expires. */
-declare function waitForExpire(event: Event): Promise<Event>;
-/** Calls the callback when the event expires. */
-declare function onExpire(event: Event, callback: (event: Event) => void): void;
-export { getExpiration, isEventExpired, waitForExpire, onExpire };

package/lib/types/nip40.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/types/nip42.d.ts

@@ -1,5 +0,0 @@
-import { EventTemplate } from './core.ts';
-/**
- * creates an EventTemplate for an AUTH event to be signed.
- */
-export declare function makeAuthEvent(relayURL: string, challenge: string): EventTemplate;

package/lib/types/nip42.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/types/nip44.d.ts

@@ -1,13 +0,0 @@
-export declare function getConversationKey(privkeyA: Uint8Array, pubkeyB: string): Uint8Array;
-declare function calcPaddedLen(len: number): number;
-export declare function encrypt(plaintext: string, conversationKey: Uint8Array, nonce?: Uint8Array): string;
-export declare function decrypt(payload: string, conversationKey: Uint8Array): string;
-export declare const v2: {
-    utils: {
-        getConversationKey: typeof getConversationKey;
-        calcPaddedLen: typeof calcPaddedLen;
-    };
-    encrypt: typeof encrypt;
-    decrypt: typeof decrypt;
-};
-export {};

package/lib/types/nip44.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/types/nip46.d.ts

@@ -1,117 +0,0 @@
-import { EventTemplate, VerifiedEvent } from './core.ts';
-import { AbstractSimplePool } from './abstract-pool.ts';
-import { Signer } from './signer.ts';
-export declare function useFetchImplementation(fetchImplementation: any): void;
-export declare const BUNKER_REGEX: RegExp;
-export type BunkerPointer = {
-    relays: string[];
-    pubkey: string;
-    secret: null | string;
-};
-export declare function toBunkerURL(bunkerPointer: BunkerPointer): string;
-/** This takes either a bunker:// URL or a name@domain.com NIP-05 identifier
-    and returns a BunkerPointer -- or null in case of error */
-export declare function parseBunkerInput(input: string): Promise<BunkerPointer | null>;
-export declare function queryBunkerProfile(nip05: string): Promise<BunkerPointer | null>;
-export type NostrConnectParams = {
-    clientPubkey: string;
-    relays: string[];
-    secret: string;
-    perms?: string[];
-    name?: string;
-    url?: string;
-    image?: string;
-};
-export declare function createNostrConnectURI(params: NostrConnectParams): string;
-export type BunkerSignerParams = {
-    pool?: AbstractSimplePool;
-    onauth?: (url: string) => void;
-};
-export declare class BunkerSigner implements Signer {
-    private params;
-    private pool;
-    private subCloser;
-    private isOpen;
-    private serial;
-    private idPrefix;
-    private listeners;
-    private waitingForAuth;
-    private secretKey;
-    private conversationKey;
-    bp: BunkerPointer;
-    private cachedPubKey;
-    /**
-     * Creates a new instance of the Nip46 class.
-     * @param relays - An array of relay addresses.
-     * @param remotePubkey - An optional remote public key. This is the key you want to sign as.
-     * @param secretKey - An optional key pair.
-     */
-    private constructor();
-    /**
-     * [Factory Method 1] Creates a Signer using bunker information (bunker:// URL or NIP-05).
-     * This method is used when the public key of the bunker is known in advance.
-     */
-    static fromBunker(clientSecretKey: Uint8Array, bp: BunkerPointer, params?: BunkerSignerParams): BunkerSigner;
-    /**
-     * [Factory Method 2] Creates a Signer using a nostrconnect:// URI generated by the client.
-     * In this method, the bunker initiates the connection by scanning the URI.
-     */
-    static fromURI(clientSecretKey: Uint8Array, connectionURI: string, bunkerParams?: BunkerSignerParams, maxWaitOrAbort?: number | AbortSignal): Promise<BunkerSigner>;
-    private setupSubscription;
-    switchRelays(): Promise<boolean>;
-    close(): Promise<void>;
-    sendRequest(method: string, params: string[]): Promise<string>;
-    /**
-     * Calls the "connect" method on the bunker.
-     * The promise will be rejected if the response is not "pong".
-     */
-    ping(): Promise<void>;
-    /**
-     * Calls the "connect" method on the bunker.
-     */
-    connect(): Promise<void>;
-    /**
-     * Calls the "get_public_key" method on the bunker.
-     * (before we would return the public key hardcoded in the bunker parameters, but
-     *  that is not correct as that may be the bunker pubkey and the actual signer
-     *  pubkey may be different.)
-     */
-    getPublicKey(): Promise<string>;
-    /**
-     * Signs an event using the remote private key.
-     * @param event - The event to sign.
-     * @returns A Promise that resolves to the signed event.
-     */
-    signEvent(event: EventTemplate): Promise<VerifiedEvent>;
-    nip04Encrypt(thirdPartyPubkey: string, plaintext: string): Promise<string>;
-    nip04Decrypt(thirdPartyPubkey: string, ciphertext: string): Promise<string>;
-    nip44Encrypt(thirdPartyPubkey: string, plaintext: string): Promise<string>;
-    nip44Decrypt(thirdPartyPubkey: string, ciphertext: string): Promise<string>;
-}
-/**
- * Creates an account with the specified username, domain, and optional email.
- * @param bunkerPubkey - The public key of the bunker to use for the create_account call.
- * @param username - The username for the account.
- * @param domain - The domain for the account.
- * @param email - The optional email for the account.
- * @param localSecretKey - Optionally pass a local secret key that will be used to communicate with the bunker,
-                           this will default to generating a random key.
- * @throws Error if the email is present but invalid.
- * @returns A Promise that resolves to the auth_url that the client should follow to create an account.
- */
-export declare function createAccount(bunker: BunkerProfile, params: BunkerSignerParams, username: string, domain: string, email?: string, localSecretKey?: Uint8Array): Promise<BunkerSigner>;
-/**
- * Fetches info on available providers that announce themselves using NIP-89 events.
- * @returns A promise that resolves to an array of available bunker objects.
- */
-export declare function fetchBunkerProviders(pool: AbstractSimplePool, relays: string[]): Promise<BunkerProfile[]>;
-export type BunkerProfile = {
-    bunkerPointer: BunkerPointer;
-    domain: string;
-    nip05: string;
-    name: string;
-    picture: string;
-    about: string;
-    website: string;
-    local: boolean;
-};

package/lib/types/nip47.d.ts

@@ -1,9 +0,0 @@
-import { type VerifiedEvent } from './pure.ts';
-interface NWCConnection {
-    pubkey: string;
-    relay: string;
-    secret: string;
-}
-export declare function parseConnectionString(connectionString: string): NWCConnection;
-export declare function makeNwcRequestEvent(pubkey: string, secretKey: Uint8Array, invoice: string): Promise<VerifiedEvent>;
-export {};

package/lib/types/nip47.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/types/nip49.d.ts

@@ -1,3 +0,0 @@
-import { Ncryptsec } from './nip19.ts';
-export declare function encrypt(sec: Uint8Array, password: string, logn?: number, ksb?: 0x00 | 0x01 | 0x02): Ncryptsec;
-export declare function decrypt(ncryptsec: string, password: string): Uint8Array;

package/lib/types/nip49.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/types/nip54.d.ts

@@ -1 +0,0 @@
-export declare function normalizeIdentifier(name: string): string;

package/lib/types/nip54.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/types/nip55.d.ts

@@ -1,30 +0,0 @@
-type BaseParams = {
-    callbackUrl?: string;
-    returnType?: 'signature' | 'event';
-    compressionType?: 'none' | 'gzip';
-};
-type PermissionsParams = BaseParams & {
-    permissions?: {
-        type: string;
-        kind?: number;
-    }[];
-};
-type EventUriParams = BaseParams & {
-    eventJson: Record<string, unknown>;
-    id?: string;
-    currentUser?: string;
-};
-type EncryptDecryptParams = BaseParams & {
-    pubKey: string;
-    content: string;
-    id?: string;
-    currentUser?: string;
-};
-export declare function getPublicKeyUri({ permissions, ...params }: PermissionsParams): string;
-export declare function signEventUri({ eventJson, ...params }: EventUriParams): string;
-export declare function encryptNip04Uri(params: EncryptDecryptParams): string;
-export declare function decryptNip04Uri(params: EncryptDecryptParams): string;
-export declare function encryptNip44Uri(params: EncryptDecryptParams): string;
-export declare function decryptNip44Uri(params: EncryptDecryptParams): string;
-export declare function decryptZapEventUri({ eventJson, ...params }: EventUriParams): string;
-export {};

package/lib/types/nip55.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/types/nip57.d.ts

@@ -1,25 +0,0 @@
-import { NostrEvent, type Event, type EventTemplate } from './pure.ts';
-export declare function useFetchImplementation(fetchImplementation: any): void;
-export declare function getZapEndpoint(metadata: Event): Promise<null | string>;
-type ProfileZap = {
-    pubkey: string;
-    amount: number;
-    comment?: string;
-    relays: string[];
-};
-type EventZap = {
-    event: NostrEvent;
-    amount: number;
-    comment?: string;
-    relays: string[];
-};
-export declare function makeZapRequest(params: ProfileZap | EventZap): EventTemplate;
-export declare function validateZapRequest(zapRequestString: string): string | null;
-export declare function makeZapReceipt({ zapRequest, preimage, bolt11, paidAt, }: {
-    zapRequest: string;
-    preimage?: string;
-    bolt11: string;
-    paidAt: Date;
-}): EventTemplate;
-export declare function getSatoshisAmountFromBolt11(bolt11: string): number;
-export {};

package/lib/types/nip57.test.d.ts

@@ -1 +0,0 @@
-export {};