nostr-tools 2.23.3 → 2.23.4

package/lib/types/nip11.d.ts

@@ -1,266 +0,0 @@
-export declare function useFetchImplementation(fetchImplementation: any): void;
-export declare function fetchRelayInformation(url: string): Promise<RelayInformation>;
-/**
- * ## Relay Information Document
-
- * Relays may provide server metadata to clients to inform
- * them of capabilities, administrative contacts, and
- * various server attributes. This is made available as a
- * JSON document over HTTP, on the same URI as the relay's
- * websocket.
-
- * Any field may be omitted, and clients MUST ignore any
- * additional fields they do not understand. Relays MUST
- * accept CORS requests by sending
- * `Access-Control-Allow-Origin`,
- * `Access-Control-Allow-Headers`, and
- * `Access-Control-Allow-Methods` headers.
- * @param name string identifying relay
- * @param description string with detailed information
- * @param pubkey administrative contact pubkey
- * @param contact: administrative alternate contact
- * @param supported_nips a list of NIP numbers supported by
- * the relay
- * @param software identifying relay software URL
- * @param version string version identifier
- */
-export interface BasicRelayInformation {
-    name: string;
-    description: string;
-    pubkey: string;
-    contact: string;
-    supported_nips: number[];
-    software: string;
-    version: string;
-}
-/**
- *  * ## Extra Fields
-
- *  * ### Server Limitations
-
- * These are limitations imposed by the relay on clients.
- * Your client should expect that requests which exceed
- * these practical_ limitations are rejected or fail immediately.
- * @param max_message_length this is the maximum number of
- * bytes for incoming JSON that the relay will attempt to
- * decode and act upon. When you send large subscriptions,
- * you will be limited by this value. It also effectively
- * limits the maximum size of any event. Value is calculated
- * from `[` to `]` and is after UTF-8 serialization (so some
- * unicode characters will cost 2-3 bytes). It is equal to
- * the maximum size of the WebSocket message frame.
- * @param max_subscriptions total number of subscriptions
- * that may be active on a single websocket connection to
- * this relay. It's possible that authenticated clients with
- * a (paid) relationship to the relay may have higher limits.
- * @param max_filters maximum number of filter values in
- * each subscription. Must be one or higher.
- * @param max_limit the relay server will clamp each
- * filter's `limit` value to this number.
- * This means the client won't be able to get more than this
- * number of events from a single subscription filter. This
- * clamping is typically done silently by the relay, but
- * with this number, you can know that there are additional
- * results if you narrowed your filter's time range or other
- * parameters.
- * @param max_subid_length maximum length of subscription id as a
- * string.
- * @param min_prefix for `authors` and `ids` filters which
- * are to match against a hex prefix, you must provide at
- * least this many hex digits in the prefix.
- * @param max_event_tags in any event, this is the maximum
- * number of elements in the `tags` list.
- * @param max_content_length maximum number of characters in
- * the `content` field of any event. This is a count of
- * unicode characters. After serializing into JSON it may be
- * larger (in bytes), and is still subject to the
- * max_message_length`, if defined.
- * @param min_pow_difficulty new events will require at
- * least this difficulty of PoW, based on [NIP-13](13.md),
- * or they will be rejected by this server.
- * @param auth_required this relay requires [NIP-42](42.md)
- * authentication to happen before a new connection may
- * perform any other action. Even if set to False,
- * authentication may be required for specific actions.
- * @param restricted_writes: this relay requires some kind
- * of condition to be fulfilled in order to accept events
- * (not necessarily, but including
- * @param payment_required this relay requires payment
- * before a new connection may perform any action.
- * @param created_at_lower_limit: 'created_at' lower limit
- * @param created_at_upper_limit: 'created_at' upper limit
- */
-export interface Limitations {
-    max_message_length: number;
-    max_subscriptions: number;
-    max_filters: number;
-    max_limit: number;
-    max_subid_length: number;
-    min_prefix: number;
-    max_event_tags: number;
-    max_content_length: number;
-    min_pow_difficulty: number;
-    auth_required: boolean;
-    payment_required: boolean;
-    created_at_lower_limit: number;
-    created_at_upper_limit: number;
-    restricted_writes: boolean;
-}
-export interface RetentionDetails {
-    kinds: (number | number[])[];
-    time?: number | null;
-    count?: number | null;
-}
-type AnyRetentionDetails = RetentionDetails;
-/**
- * ### Event Retention
-
- * There may be a cost associated with storing data forever,
- * so relays may wish to state retention times. The values
- * stated here are defaults for unauthenticated users and
- * visitors. Paid users would likely have other policies.
-
- * Retention times are given in seconds, with `null`
- * indicating infinity. If zero is provided, this means the
- * event will not be stored at all, and preferably an error
- * will be provided when those are received.
- * ```json
-{
-...
-  "retention": [
-    { "kinds": [0, 1, [5, 7], [40, 49]], "time": 3600 },
-    { "kinds": [[40000, 49999]], "time": 100 },
-    { "kinds": [[30000, 39999]], "count": 1000 },
-    { "time": 3600, "count": 10000 }
-  ]
-...
-}
-```
- * @param retention is a list of specifications: each will
- * apply to either all kinds, or a subset of kinds. Ranges
- * may be specified for the kind field as a tuple of
- * inclusive start and end values. Events of indicated kind
- * (or all) are then limited to a `count` and/or time
- * period.
-
- * It is possible to effectively blacklist Nostr-based
- * protocols that rely on a specific `kind` number, by
- * giving a retention time of zero for those `kind` values.
- * While that is unfortunate, it does allow clients to
- * discover servers that will support their protocol quickly
- * via a single HTTP fetch.
-
- * There is no need to specify retention times for
- * _ephemeral events_ as defined in [NIP-16](16.md) since
- * they are not retained.
- */
-export interface Retention {
-    retention: AnyRetentionDetails[];
-}
-/**
- * Some relays may be governed by the arbitrary laws of a
- * nation state. This may limit what content can be stored
- * in cleartext on those relays. All clients are encouraged
- * to use encryption to work around this limitation.
-
- * It is not possible to describe the limitations of each
- * country's laws and policies which themselves are
- * typically vague and constantly shifting.
-
- * Therefore, this field allows the relay operator to
- * indicate which countries' laws might end up being
- * enforced on them, and then indirectly on their users'
- * content.
-
- * Users should be able to avoid relays in countries they
- * don't like, and/or select relays in more favourable
- * zones. Exposing this flexibility is up to the client
- * software.
-
- * @param relay_countries a list of two-level ISO country
- * codes (ISO 3166-1 alpha-2) whose laws and policies may
- * affect this relay. `EU` may be used for European Union
- * countries.
-
- * Remember that a relay may be hosted in a country which is
- * not the country of the legal entities who own the relay,
- * so it's very likely a number of countries are involved.
- */
-export interface ContentLimitations {
-    relay_countries: string[];
-}
-/**
- * ### Community Preferences
-
- * For public text notes at least, a relay may try to foster
- * a local community. This would encourage users to follow
- * the global feed on that relay, in addition to their usual
- * individual follows. To support this goal, relays MAY
- * specify some of the following values.
-
- * @param language_tags  is an ordered list of [IETF
- * language
- * tags](https://en.wikipedia.org/wiki/IETF_language_tag
- * indicating the major languages spoken on the relay.
- * @param tags is a list of limitations on the topics to be
- * discussed. For example `sfw-only` indicates that only
- * "Safe For Work" content is encouraged on this relay. This
- * relies on assumptions of what the "work" "community"
- * feels "safe" talking about. In time, a common set of tags
- * may emerge that allow users to find relays that suit
- * their needs, and client software will be able to parse
- * these tags easily. The `bitcoin-only` tag indicates that
- * any _altcoin_, _"crypto"_ or _blockchain_ comments will
- * be ridiculed without mercy.
- * @param posting_policy is a link to a human-readable page
- * which specifies the community policies for the relay. In
- * cases where `sfw-only` is True, it's important to link to
- * a page which gets into the specifics of your posting
- * policy.
-
- * The `description` field should be used to describe your
- * community goals and values, in brief. The
- * `posting_policy` is for additional detail and legal
- * terms. Use the `tags` field to signify limitations on
- * content, or topics to be discussed, which could be
- * machine processed by appropriate client software.
- */
-export interface CommunityPreferences {
-    language_tags: string[];
-    tags: string[];
-    posting_policy: string;
-}
-export interface Amount {
-    amount: number;
-    unit: 'msat';
-}
-export interface PublicationAmount extends Amount {
-    kinds: number[];
-}
-export interface Subscription extends Amount {
-    period: number;
-}
-export interface Fees {
-    admission: Amount[];
-    subscription: Subscription[];
-    publication: PublicationAmount[];
-}
-/**
- * Relays that require payments may want to expose their fee
- * schedules.
- */
-export interface PayToRelay {
-    payments_url: string;
-    fees: Fees;
-}
-/**
- * A URL pointing to an image to be used as an icon for the
- * relay. Recommended to be squared in shape.
- */
-export interface Icon {
-    icon: string;
-}
-export type RelayInformation = BasicRelayInformation & Partial<Retention> & {
-    limitation?: Partial<Limitations>;
-} & Partial<ContentLimitations> & Partial<CommunityPreferences> & Partial<PayToRelay> & Partial<Icon>;
-export {};

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

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

package/lib/types/nip13.d.ts

@@ -1,8 +0,0 @@
-import { type UnsignedEvent, type Event } from './pure.ts';
-/** Get POW difficulty from a Nostr hex ID. */
-export declare function getPow(hex: string): number;
-/**
- * Mine an event with the desired POW. This function mutates the event.
- * Note that this operation is synchronous and should be run in a worker context to avoid blocking the main thread.
- */
-export declare function minePow(unsigned: UnsignedEvent, difficulty: number): Omit<Event, 'sig'>;

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

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

package/lib/types/nip17.d.ts

@@ -1,15 +0,0 @@
-import { NostrEvent } from './pure.ts';
-import * as nip59 from './nip59.ts';
-type Recipient = {
-    publicKey: string;
-    relayUrl?: string;
-};
-type ReplyTo = {
-    eventId: string;
-    relayUrl?: string;
-};
-export declare function wrapEvent(senderPrivateKey: Uint8Array, recipient: Recipient, message: string, conversationTitle?: string, replyTo?: ReplyTo): NostrEvent;
-export declare function wrapManyEvents(senderPrivateKey: Uint8Array, recipients: Recipient[], message: string, conversationTitle?: string, replyTo?: ReplyTo): NostrEvent[];
-export declare const unwrapEvent: typeof nip59.unwrapEvent;
-export declare const unwrapManyEvents: typeof nip59.unwrapManyEvents;
-export {};

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

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

package/lib/types/nip18.d.ts

@@ -1,22 +0,0 @@
-import { EventPointer } from './nip19.ts';
-import { Event } from './pure.ts';
-export type RepostEventTemplate = {
-    /**
-     * Pass only non-nip18 tags if you have to.
-     * Nip18 tags ('e' and 'p' tags pointing to the reposted event) will be added automatically.
-     */
-    tags?: string[][];
-    /**
-     * Pass an empty string to NOT include the stringified JSON of the reposted event.
-     * Any other content will be ignored and replaced with the stringified JSON of the reposted event.
-     * @default Stringified JSON of the reposted event
-     */
-    content?: '';
-    created_at: number;
-};
-export declare function finishRepostEvent(t: RepostEventTemplate, reposted: Event, relayUrl: string, privateKey: Uint8Array): Event;
-export declare function getRepostedEventPointer(event: Event): undefined | EventPointer;
-export type GetRepostedEventOptions = {
-    skipVerification?: boolean;
-};
-export declare function getRepostedEvent(event: Event, { skipVerification }?: GetRepostedEventOptions): undefined | Event;

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

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

package/lib/types/nip19.d.ts

@@ -1,81 +0,0 @@
-export type NProfile = `nprofile1${string}`;
-export type NEvent = `nevent1${string}`;
-export type NAddr = `naddr1${string}`;
-export type NSec = `nsec1${string}`;
-export type NPub = `npub1${string}`;
-export type Note = `note1${string}`;
-export type Ncryptsec = `ncryptsec1${string}`;
-export declare const NostrTypeGuard: {
-    isNProfile: (value?: string | null) => value is NProfile;
-    isNEvent: (value?: string | null) => value is NEvent;
-    isNAddr: (value?: string | null) => value is NAddr;
-    isNSec: (value?: string | null) => value is NSec;
-    isNPub: (value?: string | null) => value is NPub;
-    isNote: (value?: string | null) => value is Note;
-    isNcryptsec: (value?: string | null) => value is Ncryptsec;
-};
-export declare const Bech32MaxSize = 5000;
-/**
- * Bech32 regex.
- * @see https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki#bech32
- */
-export declare const BECH32_REGEX: RegExp;
-export type ProfilePointer = {
-    pubkey: string;
-    relays?: string[];
-};
-export type EventPointer = {
-    id: string;
-    relays?: string[];
-    author?: string;
-    kind?: number;
-};
-export type AddressPointer = {
-    identifier: string;
-    pubkey: string;
-    kind: number;
-    relays?: string[];
-};
-export declare function decodeNostrURI(nip19code: string): ReturnType<typeof decode> | {
-    type: 'invalid';
-    data: null;
-};
-export type DecodedNevent = {
-    type: 'nevent';
-    data: EventPointer;
-};
-export type DecodedNprofile = {
-    type: 'nprofile';
-    data: ProfilePointer;
-};
-export type DecodedNaddr = {
-    type: 'naddr';
-    data: AddressPointer;
-};
-export type DecodedNsec = {
-    type: 'nsec';
-    data: Uint8Array;
-};
-export type DecodedNpub = {
-    type: 'npub';
-    data: string;
-};
-export type DecodedNote = {
-    type: 'note';
-    data: string;
-};
-export type DecodedResult = DecodedNevent | DecodedNprofile | DecodedNaddr | DecodedNpub | DecodedNsec | DecodedNote;
-export declare function decode(nip19: NEvent): DecodedNevent;
-export declare function decode(nip19: NProfile): DecodedNprofile;
-export declare function decode(nip19: NAddr): DecodedNaddr;
-export declare function decode(nip19: NSec): DecodedNsec;
-export declare function decode(nip19: NPub): DecodedNpub;
-export declare function decode(nip19: Note): DecodedNote;
-export declare function decode(code: string): DecodedResult;
-export declare function nsecEncode(key: Uint8Array): NSec;
-export declare function npubEncode(hex: string): NPub;
-export declare function noteEncode(hex: string): Note;
-export declare function encodeBytes<Prefix extends string>(prefix: Prefix, bytes: Uint8Array): `${Prefix}1${string}`;
-export declare function nprofileEncode(profile: ProfilePointer): NProfile;
-export declare function neventEncode(event: EventPointer): NEvent;
-export declare function naddrEncode(addr: AddressPointer): NAddr;

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

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

package/lib/types/nip21.d.ts

@@ -1,34 +0,0 @@
-import { AddressPointer, EventPointer, ProfilePointer } from './nip19.ts';
-/** Nostr URI regex, eg `nostr:npub1...` */
-export declare const NOSTR_URI_REGEX: RegExp;
-/** Test whether the value is a Nostr URI. */
-export declare function test(value: unknown): value is `nostr:${string}`;
-/** Parsed Nostr URI data. */
-export interface NostrURI {
-    /** Full URI including the `nostr:` protocol. */
-    uri: `nostr:${string}`;
-    /** The bech32-encoded data (eg `npub1...`). */
-    value: string;
-    /** Decoded bech32 string, according to NIP-19. */
-    decoded: {
-        type: 'nevent';
-        data: EventPointer;
-    } | {
-        type: 'nprofile';
-        data: ProfilePointer;
-    } | {
-        type: 'naddr';
-        data: AddressPointer;
-    } | {
-        type: 'npub';
-        data: string;
-    } | {
-        type: 'nsec';
-        data: Uint8Array;
-    } | {
-        type: 'note';
-        data: string;
-    };
-}
-/** Parse and decode a Nostr URI. */
-export declare function parse(uri: string): NostrURI;

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

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

package/lib/types/nip25.d.ts

@@ -1,15 +0,0 @@
-import { Event } from './pure.ts';
-import type { EventPointer } from './nip19.ts';
-export type ReactionEventTemplate = {
-    /**
-     * Pass only non-nip25 tags if you have to. Nip25 tags ('e' and 'p' tags from reacted event) will be added automatically.
-     */
-    tags?: string[][];
-    /**
-     * @default '+'
-     */
-    content?: string;
-    created_at: number;
-};
-export declare function finishReactionEvent(t: ReactionEventTemplate, reacted: Event, privateKey: Uint8Array): Event;
-export declare function getReactedEventPointer(event: Event): undefined | EventPointer;

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

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

package/lib/types/nip27.d.ts

@@ -1,32 +0,0 @@
-import { NostrEvent } from './core.ts';
-import { AddressPointer, EventPointer, ProfilePointer } from './nip19.ts';
-export type Block = {
-    type: 'text';
-    text: string;
-} | {
-    type: 'reference';
-    pointer: ProfilePointer | AddressPointer | EventPointer;
-} | {
-    type: 'url';
-    url: string;
-} | {
-    type: 'relay';
-    url: string;
-} | {
-    type: 'image';
-    url: string;
-} | {
-    type: 'video';
-    url: string;
-} | {
-    type: 'audio';
-    url: string;
-} | {
-    type: 'emoji';
-    shortcode: string;
-    url: string;
-} | {
-    type: 'hashtag';
-    value: string;
-};
-export declare function parse(content: string | NostrEvent): Iterable<Block>;

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

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

package/lib/types/nip28.d.ts

@@ -1,46 +0,0 @@
-import { Event } from './pure.ts';
-export interface ChannelMetadata {
-    name: string;
-    about: string;
-    picture: string;
-}
-export interface ChannelCreateEventTemplate {
-    content: string | ChannelMetadata;
-    created_at: number;
-    tags?: string[][];
-}
-export interface ChannelMetadataEventTemplate {
-    channel_create_event_id: string;
-    content: string | ChannelMetadata;
-    created_at: number;
-    tags?: string[][];
-}
-export interface ChannelMessageEventTemplate {
-    channel_create_event_id: string;
-    reply_to_channel_message_event_id?: string;
-    relay_url: string;
-    content: string;
-    created_at: number;
-    tags?: string[][];
-}
-export interface ChannelHideMessageEventTemplate {
-    channel_message_event_id: string;
-    content: string | {
-        reason: string;
-    };
-    created_at: number;
-    tags?: string[][];
-}
-export interface ChannelMuteUserEventTemplate {
-    content: string | {
-        reason: string;
-    };
-    created_at: number;
-    pubkey_to_mute: string;
-    tags?: string[][];
-}
-export declare const channelCreateEvent: (t: ChannelCreateEventTemplate, privateKey: Uint8Array) => Event | undefined;
-export declare const channelMetadataEvent: (t: ChannelMetadataEventTemplate, privateKey: Uint8Array) => Event | undefined;
-export declare const channelMessageEvent: (t: ChannelMessageEventTemplate, privateKey: Uint8Array) => Event;
-export declare const channelHideMessageEvent: (t: ChannelHideMessageEventTemplate, privateKey: Uint8Array) => Event | undefined;
-export declare const channelMuteUserEvent: (t: ChannelMuteUserEventTemplate, privateKey: Uint8Array) => Event | undefined;

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

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