nostr-tools 2.23.2 → 2.23.4

package/lib/types/nip58.d.ts

@@ -1,134 +0,0 @@
-import { Event, EventTemplate } from './core.ts';
-/**
- * Represents the structure for defining a badge within the Nostr network.
- * This structure is used to create templates for badge definition events,
- * facilitating the recognition and awarding of badges to users for various achievements.
- */
-export type BadgeDefinition = {
-    /**
-     * A unique identifier for the badge. This is used to distinguish badges
-     * from one another and should be unique across all badge definitions.
-     * Typically, this could be a short, descriptive string.
-     */
-    d: string;
-    /**
-     * An optional short name for the badge. This provides a human-readable
-     * title for the badge, making it easier to recognize and refer to.
-     */
-    name?: string;
-    /**
-     * An optional description for the badge. This field can be used to
-     * provide more detailed information about the badge, such as the criteria
-     * for its awarding or its significance.
-     */
-    description?: string;
-    /**
-     * An optional image URL and dimensions for the badge. The first element
-     * of the tuple is the URL pointing to a high-resolution image representing
-     * the badge, and the second element specifies the image's dimensions in
-     * the format "widthxheight". The recommended dimensions are 1024x1024 pixels.
-     */
-    image?: [string, string];
-    /**
-     * An optional list of thumbnail images for the badge. Each element in the
-     * array is a tuple, where the first element is the URL pointing to a thumbnail
-     * version of the badge image, and the second element specifies the thumbnail's
-     * dimensions in the format "widthxheight". Multiple thumbnails can be provided
-     * to support different display sizes.
-     */
-    thumbs?: Array<[string, string]>;
-};
-/**
- * Represents the structure for awarding a badge to one or more recipients
- * within the Nostr network. This structure is used to create templates for
- * badge award events, which are immutable and signify the recognition of
- * individuals' achievements or contributions.
- */
-export type BadgeAward = {
-    /**
-     * A reference to the Badge Definition event. This is typically composed
-     * of the event ID of the badge definition. It establishes a clear linkage
-     * between the badge being awarded and its original definition, ensuring
-     * that recipients are awarded the correct badge.
-     */
-    a: string;
-    /**
-     * An array of p tags, each containing a pubkey and its associated relays.
-     */
-    p: string[][];
-};
-/**
- * Represents the collection of badges a user chooses to display on their profile.
- * This structure is crucial for applications that allow users to showcase achievements
- * or recognitions in the form of badges, following the specifications of NIP-58.
- */
-export type ProfileBadges = {
-    /**
-     * A unique identifier for the profile badges collection. According to NIP-58,
-     * this should be set to "profile_badges" to differentiate it from other event types.
-     */
-    d: 'profile_badges';
-    /**
-     * A list of badges that the user has elected to display on their profile. Each item
-     * in the array represents a specific badge, including references to both its definition
-     * and the award event.
-     */
-    badges: Array<{
-        /**
-         * The event address of the badge definition. This is a reference to the specific badge
-         * being displayed, linking back to the badge's original definition event. It allows
-         * clients to fetch and display the badge's details, such as its name, description,
-         * and image.
-         */
-        a: string;
-        /**
-         * The event id of the badge award with corresponding relays. This references the event
-         * in which the badge was awarded to the user. It is crucial for verifying the
-         * authenticity of the badge display, ensuring that the user was indeed awarded the
-         * badge they are choosing to display.
-         */
-        e: string[];
-    }>;
-};
-/**
- * Generates an EventTemplate based on the provided BadgeDefinition.
- *
- * @param {BadgeDefinition} badgeDefinition - The BadgeDefinition object.
- * @returns {EventTemplate} - The generated EventTemplate object.
- */
-export declare function generateBadgeDefinitionEventTemplate({ d, description, image, name, thumbs, }: BadgeDefinition): EventTemplate;
-/**
- * Validates a badge definition event.
- *
- * @param event - The event to validate.
- * @returns A boolean indicating whether the event is a valid badge definition event.
- */
-export declare function validateBadgeDefinitionEvent(event: Event): boolean;
-/**
- * Generates an EventTemplate based on the provided BadgeAward.
- *
- * @param {BadgeAward} badgeAward - The BadgeAward object.
- * @returns {EventTemplate} - The generated EventTemplate object.
- */
-export declare function generateBadgeAwardEventTemplate({ a, p }: BadgeAward): EventTemplate;
-/**
- * Validates a badge award event.
- *
- * @param event - The event to validate.
- * @returns A boolean indicating whether the event is a valid badge award event.
- */
-export declare function validateBadgeAwardEvent(event: Event): boolean;
-/**
- * Generates an EventTemplate based on the provided ProfileBadges.
- *
- * @param {ProfileBadges} profileBadges - The ProfileBadges object.
- * @returns {EventTemplate} - The generated EventTemplate object.
- */
-export declare function generateProfileBadgesEventTemplate({ badges }: ProfileBadges): EventTemplate;
-/**
- * Validates a profile badges event.
- *
- * @param event - The event to validate.
- * @returns A boolean indicating whether the event is a valid profile badges event.
- */
-export declare function validateProfileBadgesEvent(event: Event): boolean;

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

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

package/lib/types/nip59.d.ts

@@ -1,12 +0,0 @@
-import { UnsignedEvent, NostrEvent } from './core.ts';
-type Rumor = UnsignedEvent & {
-    id: string;
-};
-export declare function createRumor(event: Partial<UnsignedEvent>, privateKey: Uint8Array): Rumor;
-export declare function createSeal(rumor: Rumor, privateKey: Uint8Array, recipientPublicKey: string): NostrEvent;
-export declare function createWrap(seal: NostrEvent, recipientPublicKey: string): NostrEvent;
-export declare function wrapEvent(event: Partial<UnsignedEvent>, senderPrivateKey: Uint8Array, recipientPublicKey: string): NostrEvent;
-export declare function wrapManyEvents(event: Partial<UnsignedEvent>, senderPrivateKey: Uint8Array, recipientsPublicKeys: string[]): NostrEvent[];
-export declare function unwrapEvent(wrap: NostrEvent, recipientPrivateKey: Uint8Array): Rumor;
-export declare function unwrapManyEvents(wrappedEvents: NostrEvent[], recipientPrivateKey: Uint8Array): Rumor[];
-export {};

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

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

package/lib/types/nip75.d.ts

@@ -1,61 +0,0 @@
-import { Event, EventTemplate } from './core.ts';
-/**
- * Represents a fundraising goal in the Nostr network as defined by NIP-75.
- * This type is used to structure the information needed to create a goal event (`kind:9041`).
- */
-export type Goal = {
-    /**
-     * A human-readable description of the fundraising goal.
-     * This content should provide clear information about the purpose of the fundraising.
-     */
-    content: string;
-    /**
-     * The target amount for the fundraising goal in milisats.
-     * This defines the financial target that the fundraiser aims to reach.
-     */
-    amount: string;
-    /**
-     * A list of relays where the zaps towards this goal will be sent to and tallied from.
-     * Each relay is represented by its WebSocket URL.
-     */
-    relays: string[];
-    /**
-     * An optional timestamp (in seconds, UNIX epoch) indicating when the fundraising goal is considered closed.
-     * Zaps published after this timestamp should not count towards the goal progress.
-     * If not provided, the goal remains open indefinitely or until manually closed.
-     */
-    closedAt?: number;
-    /**
-     * An optional URL to an image related to the goal.
-     * This can be used to visually represent the goal on client interfaces.
-     */
-    image?: string;
-    /**
-     * An optional brief description or summary of the goal.
-     * This can provide a quick overview of the goal, separate from the detailed `content`.
-     */
-    summary?: string;
-    /**
-     * An optional URL related to the goal, providing additional information or actions through an 'r' tag.
-     * This is a single URL, as per NIP-75 specifications for linking additional resources.
-     */
-    r?: string;
-    /**
-     * An optional parameterized replaceable event linked to the goal, specified through an 'a' tag.
-     * This is a single event id, aligning with NIP-75's allowance for linking to specific events.
-     */
-    a?: string;
-    /**
-     * Optional tags specifying multiple beneficiary pubkeys or additional criteria for zapping,
-     * allowing contributions to be directed towards multiple recipients or according to specific conditions.
-     */
-    zapTags?: string[][];
-};
-/**
- * Generates an EventTemplate for a fundraising goal based on the provided ZapGoal object.
- * This function is tailored to fit the structure of EventTemplate as defined in the library.
- * @param zapGoal The ZapGoal object containing the details of the fundraising goal.
- * @returns An EventTemplate object structured for creating a Nostr event.
- */
-export declare function generateGoalEventTemplate({ amount, content, relays, a, closedAt, image, r, summary, zapTags, }: Goal): EventTemplate;
-export declare function validateZapGoalEvent(event: Event): boolean;

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

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

package/lib/types/nip77.d.ts

@@ -1,102 +0,0 @@
-import { Filter } from './filter.ts';
-import { AbstractRelay } from './relay.ts';
-declare class WrappedBuffer {
-    _raw: Uint8Array;
-    length: number;
-    constructor(buffer?: Uint8Array | number);
-    unwrap(): Uint8Array;
-    get capacity(): number;
-    extend(buf: Uint8Array | WrappedBuffer): void;
-    shift(): number;
-    shiftN(n?: number): Uint8Array;
-}
-export declare class NegentropyStorageVector {
-    items: {
-        timestamp: number;
-        id: Uint8Array;
-    }[];
-    sealed: boolean;
-    constructor();
-    insert(timestamp: number, id: string): void;
-    seal(): void;
-    unseal(): void;
-    size(): number;
-    getItem(i: number): {
-        timestamp: number;
-        id: Uint8Array;
-    };
-    iterate(begin: number, end: number, cb: (item: {
-        timestamp: number;
-        id: Uint8Array;
-    }, i: number) => boolean): void;
-    findLowerBound(begin: number, end: number, bound: {
-        timestamp: number;
-        id: Uint8Array;
-    }): number;
-    fingerprint(begin: number, end: number): Uint8Array;
-    _checkSealed(): void;
-    _checkBounds(begin: number, end: number): void;
-    _binarySearch(arr: {
-        timestamp: number;
-        id: Uint8Array;
-    }[], first: number, last: number, cmp: (a: {
-        timestamp: number;
-        id: Uint8Array;
-    }) => boolean): number;
-}
-export declare class Negentropy {
-    storage: NegentropyStorageVector;
-    frameSizeLimit: number;
-    lastTimestampIn: number;
-    lastTimestampOut: number;
-    constructor(storage: NegentropyStorageVector, frameSizeLimit?: number);
-    _bound(timestamp: number, id?: Uint8Array): {
-        timestamp: number;
-        id: Uint8Array;
-    };
-    initiate(): string;
-    reconcile(queryMsg: string, onhave?: (id: string) => void, onneed?: (id: string) => void): string | null;
-    splitRange(lower: number, upper: number, upperBound: {
-        timestamp: number;
-        id: Uint8Array;
-    }, o: WrappedBuffer): void;
-    exceededFrameSizeLimit(n: number): boolean;
-    decodeTimestampIn(encoded: WrappedBuffer): number;
-    decodeBound(encoded: WrappedBuffer): {
-        timestamp: number;
-        id: Uint8Array;
-    };
-    encodeTimestampOut(timestamp: number): WrappedBuffer;
-    encodeBound(key: {
-        timestamp: number;
-        id: Uint8Array;
-    }): WrappedBuffer;
-    getMinimalBound(prev: {
-        timestamp: number;
-        id: Uint8Array;
-    }, curr: {
-        timestamp: number;
-        id: Uint8Array;
-    }): {
-        timestamp: number;
-        id: Uint8Array;
-    };
-}
-export declare class NegentropySync {
-    relay: AbstractRelay;
-    storage: NegentropyStorageVector;
-    private neg;
-    private filter;
-    private subscription;
-    private onhave?;
-    private onneed?;
-    constructor(relay: AbstractRelay, storage: NegentropyStorageVector, filter: Filter, params?: {
-        label?: string;
-        onhave?: (id: string) => void;
-        onneed?: (id: string) => void;
-        onclose?: (errReason?: string) => void;
-    });
-    start(): Promise<void>;
-    close(): void;
-}
-export {};

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

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

package/lib/types/nip94.d.ts

@@ -1,87 +0,0 @@
-import { Event, EventTemplate } from './core.ts';
-/**
- * Type definition for File Metadata as specified in NIP-94.
- * This type is used to represent the metadata associated with a file sharing event (kind: 1063).
- */
-export type FileMetadataObject = {
-    /**
-     * A description or caption for the file content.
-     */
-    content: string;
-    /**
-     * The URL to download the file.
-     */
-    url: string;
-    /**
-     * The MIME type of the file, in lowercase.
-     */
-    m: string;
-    /**
-     * The SHA-256 hex-encoded string of the file.
-     */
-    x: string;
-    /**
-     * The SHA-256 hex-encoded string of the original file, before any transformations done by the upload server.
-     */
-    ox: string;
-    /**
-     * Optional: The size of the file in bytes.
-     */
-    size?: string;
-    /**
-     * Optional: The dimensions of the file in pixels, in the format "<width>x<height>".
-     */
-    dim?: string;
-    /**
-     * Optional: The URI to the magnet file.
-     */
-    magnet?: string;
-    /**
-     * Optional: The torrent infohash.
-     */
-    i?: string;
-    /**
-     * Optional: The blurhash string to show while the file is being loaded by the client.
-     */
-    blurhash?: string;
-    /**
-     * Optional: The URL of the thumbnail image with the same aspect ratio as the original file.
-     */
-    thumb?: string;
-    /**
-     * Optional: The URL of a preview image with the same dimensions as the original file.
-     */
-    image?: string;
-    /**
-     * Optional: A text excerpt or summary of the file's content.
-     */
-    summary?: string;
-    /**
-     * Optional: A description for accessibility, providing context or a brief description of the file.
-     */
-    alt?: string;
-    /**
-     * Optional: fallback URLs in case url fails.
-     */
-    fallback?: string[];
-};
-/**
- * Generates an event template based on a file metadata object.
- *
- * @param fileMetadata - The file metadata object.
- * @returns The event template.
- */
-export declare function generateEventTemplate(fileMetadata: FileMetadataObject): EventTemplate;
-/**
- * Validates an event to ensure it is a valid file metadata event.
- * @param event - The event to validate.
- * @returns True if the event is valid, false otherwise.
- */
-export declare function validateEvent(event: Event): boolean;
-/**
- * Parses an event and returns a file metadata object.
- * @param event - The event to parse.
- * @returns The file metadata object.
- * @throws Error if the event is invalid.
- */
-export declare function parseEvent(event: Event): FileMetadataObject;

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

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

package/lib/types/nip98.d.ts

@@ -1,74 +0,0 @@
-import { Event, EventTemplate } from './pure.ts';
-/**
- * Generate token for NIP-98 flow.
- *
- * @example
- * const sign = window.nostr.signEvent
- * await nip98.getToken('https://example.com/login', 'post', (e) => sign(e), true)
- */
-export declare function getToken(loginUrl: string, httpMethod: string, sign: (e: EventTemplate) => Promise<Event> | Event, includeAuthorizationScheme?: boolean, payload?: Record<string, any>): Promise<string>;
-/**
- * Validate token for NIP-98 flow.
- *
- * @example
- * await nip98.validateToken('Nostr base64token', 'https://example.com/login', 'post')
- */
-export declare function validateToken(token: string, url: string, method: string): Promise<boolean>;
-/**
- * Unpacks an event from a token.
- *
- * @param token - The token to unpack.
- * @returns A promise that resolves to the unpacked event.
- * @throws {Error} If the token is missing, invalid, or cannot be parsed.
- */
-export declare function unpackEventFromToken(token: string): Promise<Event>;
-/**
- * Validates the timestamp of an event.
- * @param event - The event object to validate.
- * @returns A boolean indicating whether the event timestamp is within the last 60 seconds.
- */
-export declare function validateEventTimestamp(event: Event): boolean;
-/**
- * Validates the kind of an event.
- * @param event The event to validate.
- * @returns A boolean indicating whether the event kind is valid.
- */
-export declare function validateEventKind(event: Event): boolean;
-/**
- * Validates if the given URL matches the URL tag of the event.
- * @param event - The event object.
- * @param url - The URL to validate.
- * @returns A boolean indicating whether the URL is valid or not.
- */
-export declare function validateEventUrlTag(event: Event, url: string): boolean;
-/**
- * Validates if the given event has a method tag that matches the specified method.
- * @param event - The event to validate.
- * @param method - The method to match against the method tag.
- * @returns A boolean indicating whether the event has a matching method tag.
- */
-export declare function validateEventMethodTag(event: Event, method: string): boolean;
-/**
- * Calculates the hash of a payload.
- * @param payload - The payload to be hashed.
- * @returns The hash value as a string.
- */
-export declare function hashPayload(payload: any): string;
-/**
- * Validates the event payload tag against the provided payload.
- * @param event The event object.
- * @param payload The payload to validate.
- * @returns A boolean indicating whether the payload tag is valid.
- */
-export declare function validateEventPayloadTag(event: Event, payload: any): boolean;
-/**
- * Validates a Nostr event for the NIP-98 flow.
- *
- * @param event - The Nostr event to validate.
- * @param url - The URL associated with the event.
- * @param method - The HTTP method associated with the event.
- * @param body - The request body associated with the event (optional).
- * @returns A promise that resolves to a boolean indicating whether the event is valid.
- * @throws An error if the event is invalid.
- */
-export declare function validateEvent(event: Event, url: string, method: string, body?: any): Promise<boolean>;

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

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

package/lib/types/nip99.d.ts

@@ -1,92 +0,0 @@
-import { Event, EventTemplate } from './core.ts';
-/**
- * Represents the details of a price.
- * @example { amount: '100', currency: 'USD', frequency: 'month' }
- * @example { amount: '100', currency: 'EUR' }
- */
-export type PriceDetails = {
-    /**
-     * The amount of the price.
-     */
-    amount: string;
-    /**
-     * The currency of the price in 3-letter ISO 4217 format.
-     * @example 'USD'
-     */
-    currency: string;
-    /**
-     * The optional frequency of payment.
-     * Can be one of: 'hour', 'day', 'week', 'month', 'year', or a custom string.
-     */
-    frequency?: string;
-};
-/**
- * Represents a classified listing object.
- */
-export type ClassifiedListingObject = {
-    /**
-     * Whether the listing is a draft or not.
-     */
-    isDraft: boolean;
-    /**
-     * A title of the listing.
-     */
-    title: string;
-    /**
-     * A short summary or tagline.
-     */
-    summary: string;
-    /**
-     * A description in Markdown format.
-     */
-    content: string;
-    /**
-     * Timestamp in unix seconds of when the listing was published.
-     */
-    publishedAt: string;
-    /**
-     * Location of the listing.
-     * @example 'NYC'
-     */
-    location: string;
-    /**
-     * Price details.
-     */
-    price: PriceDetails;
-    /**
-     * Images of the listing with optional dimensions.
-     */
-    images: Array<{
-        url: string;
-        dimensions?: string;
-    }>;
-    /**
-     * Tags/Hashtags (i.e. categories, keywords, etc.)
-     */
-    hashtags: string[];
-    /**
-     * Other standard tags.
-     * @example "g", a geohash for more precise location
-     */
-    additionalTags: Record<string, string | string[]>;
-};
-/**
- * Validates an event to ensure it is a valid classified listing event.
- * @param event - The event to validate.
- * @returns True if the event is valid, false otherwise.
- */
-export declare function validateEvent(event: Event): boolean;
-/**
- * Parses an event and returns a classified listing object.
- * @param event - The event to parse.
- * @returns The classified listing object.
- * @throws Error if the event is invalid.
- */
-export declare function parseEvent(event: Event): ClassifiedListingObject;
-/**
- * Generates an event template based on a classified listing object.
- *
- * @param listing - The classified listing object.
- * @returns The event template.
- */
-export declare function generateEventTemplate(listing: ClassifiedListingObject): EventTemplate;

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

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

package/lib/types/nipb7.d.ts

@@ -1,23 +0,0 @@
-import { Signer } from './signer.ts';
-export type BlobDescriptor = {
-    url: string;
-    sha256: string;
-    size: number;
-    type: string;
-    uploaded: number;
-};
-export declare class BlossomClient {
-    private mediaserver;
-    private signer;
-    constructor(mediaserver: string, signer: Signer);
-    private httpCall;
-    private authorizationHeader;
-    private isValid32ByteHex;
-    check(hash: string): Promise<void>;
-    uploadBlob(file: File | Blob, contentType?: string): Promise<BlobDescriptor>;
-    uploadFile(file: File): Promise<BlobDescriptor>;
-    download(hash: string): Promise<ArrayBuffer>;
-    downloadAsBlob(hash: string): Promise<Blob>;
-    list(): Promise<BlobDescriptor[]>;
-    delete(hash: string): Promise<void>;
-}

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

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

package/lib/types/pool.d.ts

@@ -1,6 +0,0 @@
-import { AbstractSimplePool, type AbstractPoolConstructorOptions } from './abstract-pool.ts';
-export declare function useWebSocketImplementation(websocketImplementation: any): void;
-export declare class SimplePool extends AbstractSimplePool {
-    constructor(options?: Pick<AbstractPoolConstructorOptions, 'enablePing' | 'enableReconnect'>);
-}
-export * from './abstract-pool.ts';

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

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

package/lib/types/pure.d.ts

@@ -1,8 +0,0 @@
-import { Event, EventTemplate, UnsignedEvent, VerifiedEvent } from './core.ts';
-export declare function serializeEvent(evt: UnsignedEvent): string;
-export declare function getEventHash(event: UnsignedEvent): string;
-export declare const generateSecretKey: () => Uint8Array;
-export declare const getPublicKey: (secretKey: Uint8Array) => string;
-export declare const finalizeEvent: (t: EventTemplate, secretKey: Uint8Array) => VerifiedEvent;
-export declare const verifyEvent: (event: Event) => event is VerifiedEvent;
-export * from './core.ts';

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

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

package/lib/types/references.d.ts

@@ -1,10 +0,0 @@
-import { type AddressPointer, type ProfilePointer, type EventPointer } from './nip19.ts';
-import type { Event } from './core.ts';
-type Reference = {
-    text: string;
-    profile?: ProfilePointer;
-    event?: EventPointer;
-    address?: AddressPointer;
-};
-export declare function parseReferences(evt: Event): Reference[];
-export {};

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

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

package/lib/types/relay.d.ts

@@ -1,11 +0,0 @@
-import { AbstractRelay, type AbstractRelayConstructorOptions } from './abstract-relay.ts';
-export declare function useWebSocketImplementation(websocketImplementation: any): void;
-export declare class Relay extends AbstractRelay {
-    constructor(url: string, options?: Pick<AbstractRelayConstructorOptions, 'enablePing' | 'enableReconnect'>);
-    static connect(url: string, options?: Pick<AbstractRelayConstructorOptions, 'enablePing' | 'enableReconnect'>): Promise<Relay>;
-}
-export type RelayRecord = Record<string, {
-    read: boolean;
-    write: boolean;
-}>;
-export * from './abstract-relay.ts';

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

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