@hashiverse/hashiverse-client-wasm 0.0.0 → 1.0.5-rc4

package/README.md

@@ -0,0 +1,32 @@
+# @hashiverse/hashiverse-client-wasm
+
+Browser/WASM client for Hashiverse — your open-source decentralized X/Twitter replacement. This package provides the Rust/WASM backend for the associated `hashiverse-client-web` repo.
+
+[![test-hashiverse-client-wasm](https://github.com/hashiverse/hashiverse/actions/workflows/test-hashiverse-client-wasm.yml/badge.svg)](https://github.com/hashiverse/hashiverse/actions/workflows/test-hashiverse-client-wasm.yml)
+
+## Install
+
+```
+npm install @hashiverse/hashiverse-client-wasm
+```
+
+## Usage (bundler — Vite, rsbuild, webpack)
+
+```js
+import { wasm_init, HashiverseClientWasm } from "@hashiverse/hashiverse-client-wasm";
+
+wasm_init(true);
+// see hashiverse-client-web for a full integration example
+```
+
+A future `@hashiverse/hashiverse-client-nodejs` package will provide a native-Node binding via NAPI-RS (parallel to the PyPI wheel). Use this WASM build only in browser/bundler contexts.
+
+---
+
+## Developing this package
+
+The rest of this document describes how to build and test `hashiverse-client-wasm` itself. End-user usage is covered above.
+
+- Build for development with `wasm-pack build --dev`
+- Build for release with `wasm-pack build --release`
+- Run tests with `wasm-pack test --chrome --headless --lib`

package/hashiverse_client_wasm.d.ts

@@ -0,0 +1,137 @@
+/* tslint:disable */
+/* eslint-disable */
+export interface Bio {
+    client_id: string;
+    nickname: string;
+    status: string;
+    selfie: string;
+    avatar: string;
+}
+
+export interface PeerInfoV1 {
+    peer_id_hex: string;
+    address: string;
+    version: string;
+    timestamp_millis: number;
+    pow_initial: number;
+    pow_current_day: number;
+    pow_current_month: number;
+}
+
+export interface Post {
+    post_id: string;
+    time_millis: number;
+    client_id: string;
+    bucket_location: string;
+    post: string;
+    encoded_post_header_hex: string;
+    healed: boolean;
+}
+
+export interface PowJobStatusV1 {
+    label: string;
+    pow_min: number;
+    best_pow_so_far: number;
+}
+
+export interface SingleTimelineGetMoreV1Response {
+    posts: Post[];
+    oldest_processed_time_millis: number | undefined;
+}
+
+export interface TrendingHashtag {
+    hashtag: string;
+    count: number;
+}
+
+export interface TrendingHashtagsFetchResponse {
+    trending_hashtags: TrendingHashtag[];
+}
+
+export interface UrlPreview {
+    url: string;
+    title: string;
+    description: string;
+    image_url: string;
+}
+
+
+/**
+ * Provides a simplified dispatch interface for [HashiverseClient] to the browser.
+ */
+export class HashiverseClientWasm {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    client_storage_reset(): Promise<void>;
+    static create_from_keyphrase(key_phrase: string): Promise<HashiverseClientWasm>;
+    static create_from_stored_key(client_id_hex: string): Promise<HashiverseClientWasm>;
+    delete_all_stored_keys_v1(): Promise<void>;
+    delete_stored_key_v1(key_public: string): Promise<void>;
+    ensure_meta_post_in_current_bucket_v1(): Promise<void>;
+    fetch_trending_hashtags_v1(limit: number): Promise<TrendingHashtagsFetchResponse>;
+    fetch_url_preview_v1(url: string): Promise<UrlPreview>;
+    get_active_pow_jobs_v1(): Promise<PowJobStatusV1[]>;
+    get_all_bios(): Promise<Bio[]>;
+    get_all_known_peers_v1(): Promise<PeerInfoV1[]>;
+    get_bio(id: string): Promise<Bio>;
+    get_client_id(): string;
+    get_content_thresholds_v1(): Promise<any>;
+    get_followed_client_ids_v1(): Promise<string[]>;
+    get_followed_hashtags_v1(): Promise<string[]>;
+    get_peer_stats_v1(peer_id_hex: string): Promise<any>;
+    /**
+     * Gets all the feedbacks for a specific post
+     *
+     * The resulting vector has 256 entries - one per feedback_type that have been mapped to the statistical number of clicks a feedback button has received.
+     */
+    get_post_feedbacks_v1(bucket_location: string, post_id: string): Promise<Uint32Array>;
+    /**
+     * Gets a specific post
+     */
+    get_post_v1(bucket_location: string, post_id: string): Promise<Post>;
+    get_skip_warnings_for_followed_v1(): Promise<boolean>;
+    list_stored_key_ids_v1(): Promise<string[]>;
+    logged_in(): boolean;
+    multiple_timeline_get_more_followed_hashtags(): Promise<SingleTimelineGetMoreV1Response>;
+    multiple_timeline_get_more_followed_users(): Promise<SingleTimelineGetMoreV1Response>;
+    multiple_timeline_reset(): Promise<void>;
+    post_v1(post: string): Promise<Post>;
+    set_bio(nickname: string, status: string, selfie: string, avatar: string): Promise<void>;
+    set_content_thresholds_v1(thresholds: any): Promise<void>;
+    set_followed_client_id_v1(client_id: string, is_followed: boolean): Promise<void>;
+    set_followed_client_ids_v1(client_ids: any): Promise<void>;
+    set_followed_hashtag_v1(hashtag: string, is_followed: boolean): Promise<void>;
+    set_followed_hashtags_v1(hashtags: any): Promise<void>;
+    set_skip_warnings_for_followed_v1(value: boolean): Promise<void>;
+    single_timeline_get_more_hashtag_v1(hashtag: string): Promise<SingleTimelineGetMoreV1Response>;
+    single_timeline_get_more_me_mentioned_v1(): Promise<SingleTimelineGetMoreV1Response>;
+    single_timeline_get_more_me_v1(): Promise<SingleTimelineGetMoreV1Response>;
+    single_timeline_get_more_reply_to_post_v1(post_id: string): Promise<SingleTimelineGetMoreV1Response>;
+    single_timeline_get_more_sequel_v1(post_id: string): Promise<SingleTimelineGetMoreV1Response>;
+    single_timeline_get_more_user_mentioned_v1(client_id_hex: string): Promise<SingleTimelineGetMoreV1Response>;
+    single_timeline_get_more_user_v1(client_id_hex: string): Promise<SingleTimelineGetMoreV1Response>;
+    single_timeline_reset(): Promise<void>;
+    submit_feedback_v1(bucket_location: string, post_id: string, feedback_type: number): Promise<void>;
+    submit_meta_post_v1(): Promise<void>;
+}
+
+/**
+ * Initialize the parallel PoW worker pool. Call from TypeScript, passing an
+ * array of ready `Worker` handles that each run `HashiversePowWorker.ts`.
+ */
+export function init_pow_workers(workers_js: any): void;
+
+/**
+ * Sync PoW batch computation for sub-workers. Each sub-worker calls this function
+ * with a portion of the total iteration budget.
+ *
+ * Returns a colon-separated string: `salt_hex:pow_u8:hash_hex`
+ */
+export function pow_compute_batch(iteration_limit: number, pow_min: number, data_hash_hex: string): string;
+
+/**
+ * Initialise logging and panic hook. Must be called manually before using the WASM module.
+ * Pass `verbose = true` for the main worker (logs confirmation), `false` for PoW sub-workers (silent).
+ */
+export function wasm_init(verbose: boolean): void;

package/hashiverse_client_wasm.js

@@ -0,0 +1,9 @@
+/* @ts-self-types="./hashiverse_client_wasm.d.ts" */
+import * as wasm from "./hashiverse_client_wasm_bg.wasm";
+import { __wbg_set_wasm } from "./hashiverse_client_wasm_bg.js";
+
+__wbg_set_wasm(wasm);
+wasm.__wbindgen_start();
+export {
+    HashiverseClientWasm, init_pow_workers, pow_compute_batch, wasm_init
+} from "./hashiverse_client_wasm_bg.js";