kubo-rpc-client/dist/src/pubsub/index.d.ts

A client library for the Kubo RPC API

import type { HTTPRPCOptions } from '../index.js';
import type { HTTPRPCClient } from '../lib/core.js';
import type { EventHandler, PeerId, PublicKey } from '@libp2p/interface';
/**
 * On the producing side:
 * - Build messages with the signature, key (from may be enough for certain inlineable public key types), from and seqno fields.
 *
 * On the consuming side:
 * - Enforce the fields to be present, reject otherwise.
 * - Propagate only if the fields are valid and signature can be verified, reject otherwise.
 */
export declare const StrictSign = "StrictSign";
/**
 * On the producing side:
 * - Build messages without the signature, key, from and seqno fields.
 * - The corresponding protobuf key-value pairs are absent from the marshaled message, not just empty.
 *
 * On the consuming side:
 * - Enforce the fields to be absent, reject otherwise.
 * - Propagate only if the fields are absent, reject otherwise.
 * - A message_id function will not be able to use the above fields, and should instead rely on the data field. A commonplace strategy is to calculate a hash.
 */
export declare const StrictNoSign = "StrictNoSign";
export type SignaturePolicy = typeof StrictSign | typeof StrictNoSign;
export interface SignedMessage {
    type: 'signed';
    from: PeerId;
    topic: string;
    data: Uint8Array;
    sequenceNumber: bigint;
    signature: Uint8Array;
    key: PublicKey;
}
export interface UnsignedMessage {
    type: 'unsigned';
    topic: string;
    data: Uint8Array;
}
export type Message = SignedMessage | UnsignedMessage;
export interface PubSubAPI {
    /**
     * Subscribe to a pubsub topic
     *
     * @example
     * ```js
     * const topic = 'fruit-of-the-day'
     * const receiveMsg = (msg) => console.log(msg.data.toString())
     *
     * await ipfs.pubsub.subscribe(topic, receiveMsg)
     * console.log(`subscribed to ${topic}`)
     * ```
     */
    subscribe(topic: string, handler: EventHandler<Message>, options?: PubSubSubscribeOptions): Promise<void>;
    /**
     * Unsubscribes from a pubsub topic
     *
     * @example
     * ```js
     * const topic = 'fruit-of-the-day'
     * const receiveMsg = (msg) => console.log(msg.toString())
     *
     * await ipfs.pubsub.subscribe(topic, receiveMsg)
     * console.log(`subscribed to ${topic}`)
     *
     * await ipfs.pubsub.unsubscribe(topic, receiveMsg)
     * console.log(`unsubscribed from ${topic}`)
     *
     * // Or removing all listeners:
     *
     * const topic = 'fruit-of-the-day'
     * const receiveMsg = (msg) => console.log(msg.toString())
     * await ipfs.pubsub.subscribe(topic, receiveMsg);
     * // Will unsubscribe ALL handlers for the given topic
     * await ipfs.pubsub.unsubscribe(topic);
     * ```
     */
    unsubscribe(topic: string, handler?: EventHandler<Message>, options?: HTTPRPCOptions): Promise<void>;
    /**
     * Publish a data message to a pubsub topic
     *
     * @example
     * ```js
     * const topic = 'fruit-of-the-day'
     * const msg = new TextEncoder().encode('banana')
     *
     * await ipfs.pubsub.publish(topic, msg)
     * // msg was broadcasted
     * console.log(`published to ${topic}`)
     * ```
     */
    publish(topic: string, data: Uint8Array, options?: HTTPRPCOptions): Promise<void>;
    /**
     * Returns the list of subscriptions the peer is subscribed to
     */
    ls(options?: HTTPRPCOptions): Promise<string[]>;
    /**
     * Returns the peers that are subscribed to one topic.
     *
     * @example
     * ```js
     * const topic = 'fruit-of-the-day'
     *
     * const peerIds = await ipfs.pubsub.peers(topic)
     * console.log(peerIds)
     * ```
     */
    peers(topic: string, options?: HTTPRPCOptions): Promise<PeerId[]>;
    setMaxListeners?(max: number): void;
}
export interface PubSubSubscribeOptions extends HTTPRPCOptions {
    /**
     * A callback to receive an error if one occurs during processing
     * subscription messages. Only supported by ipfs-http-client.
     */
    onError?(err: Error): void;
    discover?: boolean;
}
export interface PubsubApiErrorHandlerFn {
    (err: Error, fatal: boolean, msg?: Message): void;
}
export declare function createPubsub(client: HTTPRPCClient): PubSubAPI;
//# sourceMappingURL=index.d.ts.map