@utexo/rgb-lib-wasm 1.0.6-test

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@utexo/rgb-lib-wasm",
+  "type": "module",
+  "description": "RGB wallet library WASM bindings for browsers",
+  "version": "1.0.6-test",
+  "files": [
+    "rgb_lib_wasm_bindings_bg.wasm",
+    "rgb_lib_wasm_bindings.js",
+    "rgb_lib_wasm_bindings.d.ts"
+  ],
+  "main": "rgb_lib_wasm_bindings.js",
+  "types": "rgb_lib_wasm_bindings.d.ts",
+  "sideEffects": [
+    "./snippets/*"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/UTEXO-Protocol/rgb-lib-wasm.git"
+  }
+}

package/rgb_lib_wasm_bindings.d.ts

@@ -0,0 +1,331 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * An RGB invoice parsed from a string. Exposes structured invoice data to JavaScript.
+ */
+export class WasmInvoice {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Return the parsed invoice data as a JS object.
+     */
+    invoiceData(): any;
+    /**
+     * Return the original invoice string.
+     */
+    invoiceString(): string;
+    /**
+     * Parse an RGB invoice string. Throws if the string is not a valid RGB invoice.
+     */
+    constructor(invoice_string: string);
+}
+
+export class WasmWallet {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Create an encrypted backup of the wallet state. Returns backup bytes as Uint8Array.
+     */
+    backup(password: string): Uint8Array;
+    /**
+     * Check if the wallet needs a backup. Returns true if modified since last backup.
+     */
+    backup_info(): boolean;
+    /**
+     * Blind an UTXO to receive RGB assets. Returns ReceiveData as a JS object.
+     *
+     * `assignment_js` is a JS object like `{ "Fungible": 100 }` or `"NonFungible"` or `"Any"`.
+     * `transport_endpoints_js` is a JS array of endpoint strings.
+     */
+    blind_receive(asset_id: string | null | undefined, assignment_js: any, duration_seconds: number | null | undefined, transport_endpoints_js: any, min_confirmations: number): any;
+    /**
+     * Configure VSS (cloud) backup for this wallet.
+     *
+     * `signing_key_hex` is the 32-byte secret key as a hex string (64 hex chars).
+     *
+     * **Security note:** The signing key crosses the JS/WASM boundary as a string. It will
+     * exist in V8's string pool and cannot be zeroed from Rust. Callers should avoid storing
+     * the key in JS longer than necessary (e.g., don't keep it in a global variable).
+     */
+    configure_vss_backup(server_url: string, store_id: string, signing_key_hex: string): void;
+    /**
+     * Create a new RGB wallet with IndexedDB state restoration.
+     *
+     * Like `new()`, but asynchronously checks IndexedDB for a previously saved
+     * snapshot and restores it, so wallet state survives page refreshes.
+     */
+    static create(wallet_data_json: string): Promise<WasmWallet>;
+    /**
+     * Create UTXOs (begin): prepare a PSBT to create new UTXOs for RGB allocations.
+     * Returns the unsigned PSBT string.
+     */
+    create_utxos_begin(online_js: any, up_to: boolean, num: number | null | undefined, size: number | null | undefined, fee_rate: bigint, skip_sync: boolean): Promise<string>;
+    /**
+     * Create UTXOs (end): broadcast a signed PSBT to create new UTXOs.
+     * Returns the number of created UTXOs.
+     */
+    create_utxos_end(online_js: any, signed_psbt: string, skip_sync: boolean): Promise<number>;
+    /**
+     * Delete failed transfers. Returns true if any were deleted.
+     */
+    delete_transfers(batch_transfer_idx: number | null | undefined, no_asset_only: boolean): boolean;
+    /**
+     * Disable VSS (cloud) backup.
+     */
+    disable_vss_backup(): void;
+    /**
+     * Drain all wallet funds (begin): prepare a PSBT. Returns the unsigned PSBT string.
+     */
+    drain_to_begin(online_js: any, address: string, destroy_assets: boolean, fee_rate: bigint): Promise<string>;
+    /**
+     * Drain all wallet funds (end): broadcast a signed PSBT. Returns the txid string.
+     */
+    drain_to_end(online_js: any, signed_psbt: string): Promise<string>;
+    /**
+     * Fail pending transfers. Returns true if any transfers were failed.
+     */
+    fail_transfers(online_js: any, batch_transfer_idx: number | null | undefined, no_asset_only: boolean, skip_sync: boolean): Promise<boolean>;
+    /**
+     * Finalize a signed PSBT (base64-encoded). Returns the finalized PSBT string.
+     */
+    finalize_psbt(signed_psbt: string): string;
+    /**
+     * Return a new Bitcoin address from the vanilla wallet.
+     */
+    get_address(): string;
+    /**
+     * Return the balance for a specific asset.
+     */
+    get_asset_balance(asset_id: string): any;
+    /**
+     * Return metadata for a specific asset (name, ticker, precision, supply, etc.).
+     */
+    get_asset_metadata(asset_id: string): any;
+    /**
+     * Return the BTC balance. Always skips sync on wasm32.
+     */
+    get_btc_balance(): any;
+    /**
+     * Get fee estimation for a target number of blocks.
+     */
+    get_fee_estimation(online_js: any, blocks: number): Promise<number>;
+    /**
+     * Return the WalletData as a JS object.
+     */
+    get_wallet_data(): any;
+    /**
+     * Go online: connect to an indexer. Returns Online data as a JS object.
+     */
+    go_online(skip_consistency_check: boolean, indexer_url: string): Promise<any>;
+    /**
+     * Inflate an IFA asset (begin): prepare a PSBT. Returns the unsigned PSBT string.
+     *
+     * `inflation_amounts_js` is a JS array of u64 values.
+     */
+    inflate_begin(online_js: any, asset_id: string, inflation_amounts_js: any, fee_rate: bigint, min_confirmations: number): Promise<string>;
+    /**
+     * Inflate an IFA asset (end): broadcast a signed PSBT. Returns an OperationResult JS object.
+     */
+    inflate_end(online_js: any, signed_psbt: string): Promise<any>;
+    /**
+     * Issue a new IFA (Inflatable Fungible Asset).
+     *
+     * `amounts_js` is a JS array of u64 values.
+     * `inflation_amounts_js` is a JS array of u64 values for inflation allowances.
+     */
+    issue_asset_ifa(ticker: string, name: string, precision: number, amounts_js: any, inflation_amounts_js: any, replace_rights_num: number, reject_list_url?: string | null): any;
+    /**
+     * Issue a new NIA (Non-Inflatable Asset).
+     *
+     * `amounts_js` is a JS array of u64 values.
+     */
+    issue_asset_nia(ticker: string, name: string, precision: number, amounts_js: any): any;
+    /**
+     * List known RGB assets. Pass a JS array of schema strings to filter, or empty for all.
+     */
+    list_assets(filter_asset_schemas_js: any): any;
+    /**
+     * List Bitcoin transactions. Always skips sync on wasm32.
+     */
+    list_transactions(): any;
+    /**
+     * List RGB transfers, optionally filtered by asset ID.
+     */
+    list_transfers(asset_id?: string | null): any;
+    /**
+     * List unspent outputs. Always skips sync on wasm32.
+     */
+    list_unspents(settled_only: boolean): any;
+    /**
+     * List vanilla (non-colored) unspent outputs. Returns a JS array of LocalOutput objects.
+     */
+    list_unspents_vanilla(online_js: any, min_confirmations: number, skip_sync: boolean): Promise<any>;
+    /**
+     * Create a new RGB wallet from a JSON-encoded WalletData.
+     */
+    constructor(wallet_data_json: string);
+    /**
+     * Refresh pending transfers. Returns a RefreshResult JS object.
+     *
+     * `filter_js` is a JS array of RefreshFilter objects (or empty array for all).
+     */
+    refresh(online_js: any, asset_id: string | null | undefined, filter_js: any, skip_sync: boolean): Promise<any>;
+    /**
+     * Restore wallet state from an encrypted backup.
+     */
+    restore_backup(backup_bytes: Uint8Array, password: string): void;
+    /**
+     * Send RGB assets (begin): prepare a PSBT. Returns the unsigned PSBT string.
+     *
+     * `recipient_map_js` is a JS object mapping asset IDs to arrays of Recipient objects.
+     */
+    send_begin(online_js: any, recipient_map_js: any, donation: boolean, fee_rate: bigint, min_confirmations: number): Promise<string>;
+    /**
+     * Send BTC (begin): prepare a PSBT. Returns the unsigned PSBT string.
+     */
+    send_btc_begin(online_js: any, address: string, amount: bigint, fee_rate: bigint, skip_sync: boolean): Promise<string>;
+    /**
+     * Send BTC (end): broadcast a signed PSBT. Returns the txid string.
+     */
+    send_btc_end(online_js: any, signed_psbt: string, skip_sync: boolean): Promise<string>;
+    /**
+     * Send RGB assets (end): broadcast a signed PSBT. Returns an OperationResult JS object.
+     */
+    send_end(online_js: any, signed_psbt: string, skip_sync: boolean): Promise<any>;
+    /**
+     * Sign a PSBT (base64-encoded). Returns the signed PSBT string.
+     */
+    sign_psbt(unsigned_psbt: string): string;
+    /**
+     * Sync the wallet with the indexer.
+     */
+    sync(online_js: any): Promise<void>;
+    /**
+     * Upload an encrypted backup to the configured VSS server. Returns the server version.
+     */
+    vss_backup(): Promise<any>;
+    /**
+     * Query VSS backup status. Returns { backup_exists, server_version, backup_required }.
+     */
+    vss_backup_info(): Promise<any>;
+    /**
+     * Download and restore wallet state from VSS server.
+     */
+    vss_restore_backup(): Promise<void>;
+    /**
+     * Create an address to receive RGB assets via witness TX. Returns ReceiveData as a JS object.
+     */
+    witness_receive(asset_id: string | null | undefined, assignment_js: any, duration_seconds: number | null | undefined, transport_endpoints_js: any, min_confirmations: number): any;
+}
+
+/**
+ * Check whether the provided URL points to a valid RGB proxy server.
+ */
+export function check_proxy_url(proxy_url: string): Promise<void>;
+
+export function generate_keys(network: string): any;
+
+export function init(): void;
+
+export function restore_keys(network: string, mnemonic: string): any;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_wasminvoice_free: (a: number, b: number) => void;
+    readonly __wbg_wasmwallet_free: (a: number, b: number) => void;
+    readonly check_proxy_url: (a: number, b: number) => any;
+    readonly generate_keys: (a: number, b: number) => [number, number, number];
+    readonly restore_keys: (a: number, b: number, c: number, d: number) => [number, number, number];
+    readonly wasminvoice_invoiceData: (a: number) => [number, number, number];
+    readonly wasminvoice_invoiceString: (a: number) => [number, number];
+    readonly wasminvoice_new: (a: number, b: number) => [number, number, number];
+    readonly wasmwallet_backup: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly wasmwallet_backup_info: (a: number) => [number, number, number];
+    readonly wasmwallet_blind_receive: (a: number, b: number, c: number, d: any, e: number, f: any, g: number) => [number, number, number];
+    readonly wasmwallet_configure_vss_backup: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number];
+    readonly wasmwallet_create: (a: number, b: number) => any;
+    readonly wasmwallet_create_utxos_begin: (a: number, b: any, c: number, d: number, e: number, f: bigint, g: number) => any;
+    readonly wasmwallet_create_utxos_end: (a: number, b: any, c: number, d: number, e: number) => any;
+    readonly wasmwallet_delete_transfers: (a: number, b: number, c: number) => [number, number, number];
+    readonly wasmwallet_disable_vss_backup: (a: number) => void;
+    readonly wasmwallet_drain_to_begin: (a: number, b: any, c: number, d: number, e: number, f: bigint) => any;
+    readonly wasmwallet_drain_to_end: (a: number, b: any, c: number, d: number) => any;
+    readonly wasmwallet_fail_transfers: (a: number, b: any, c: number, d: number, e: number) => any;
+    readonly wasmwallet_finalize_psbt: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly wasmwallet_get_address: (a: number) => [number, number, number, number];
+    readonly wasmwallet_get_asset_balance: (a: number, b: number, c: number) => [number, number, number];
+    readonly wasmwallet_get_asset_metadata: (a: number, b: number, c: number) => [number, number, number];
+    readonly wasmwallet_get_btc_balance: (a: number) => [number, number, number];
+    readonly wasmwallet_get_fee_estimation: (a: number, b: any, c: number) => any;
+    readonly wasmwallet_get_wallet_data: (a: number) => [number, number, number];
+    readonly wasmwallet_go_online: (a: number, b: number, c: number, d: number) => any;
+    readonly wasmwallet_inflate_begin: (a: number, b: any, c: number, d: number, e: any, f: bigint, g: number) => any;
+    readonly wasmwallet_inflate_end: (a: number, b: any, c: number, d: number) => any;
+    readonly wasmwallet_issue_asset_ifa: (a: number, b: number, c: number, d: number, e: number, f: number, g: any, h: any, i: number, j: number, k: number) => [number, number, number];
+    readonly wasmwallet_issue_asset_nia: (a: number, b: number, c: number, d: number, e: number, f: number, g: any) => [number, number, number];
+    readonly wasmwallet_list_assets: (a: number, b: any) => [number, number, number];
+    readonly wasmwallet_list_transactions: (a: number) => [number, number, number];
+    readonly wasmwallet_list_transfers: (a: number, b: number, c: number) => [number, number, number];
+    readonly wasmwallet_list_unspents: (a: number, b: number) => [number, number, number];
+    readonly wasmwallet_list_unspents_vanilla: (a: number, b: any, c: number, d: number) => any;
+    readonly wasmwallet_new: (a: number, b: number) => [number, number, number];
+    readonly wasmwallet_refresh: (a: number, b: any, c: number, d: number, e: any, f: number) => any;
+    readonly wasmwallet_restore_backup: (a: number, b: number, c: number, d: number, e: number) => [number, number];
+    readonly wasmwallet_send_begin: (a: number, b: any, c: any, d: number, e: bigint, f: number) => any;
+    readonly wasmwallet_send_btc_begin: (a: number, b: any, c: number, d: number, e: bigint, f: bigint, g: number) => any;
+    readonly wasmwallet_send_btc_end: (a: number, b: any, c: number, d: number, e: number) => any;
+    readonly wasmwallet_send_end: (a: number, b: any, c: number, d: number, e: number) => any;
+    readonly wasmwallet_sign_psbt: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly wasmwallet_sync: (a: number, b: any) => any;
+    readonly wasmwallet_vss_backup: (a: number) => any;
+    readonly wasmwallet_vss_backup_info: (a: number) => any;
+    readonly wasmwallet_vss_restore_backup: (a: number) => any;
+    readonly wasmwallet_witness_receive: (a: number, b: number, c: number, d: any, e: number, f: any, g: number) => [number, number, number];
+    readonly init: () => void;
+    readonly rustsecp256k1_v0_10_0_context_create: (a: number) => number;
+    readonly rustsecp256k1_v0_10_0_context_destroy: (a: number) => void;
+    readonly rustsecp256k1_v0_10_0_default_error_callback_fn: (a: number, b: number) => void;
+    readonly rustsecp256k1_v0_10_0_default_illegal_callback_fn: (a: number, b: number) => void;
+    readonly wasm_bindgen__closure__destroy__h14bc25e87da085f6: (a: number, b: number) => void;
+    readonly wasm_bindgen__closure__destroy__h41146c008ce82ed7: (a: number, b: number) => void;
+    readonly wasm_bindgen__closure__destroy__hb25aa0b4bfb6109d: (a: number, b: number) => void;
+    readonly wasm_bindgen__closure__destroy__hd01191ea49d0115c: (a: number, b: number) => void;
+    readonly wasm_bindgen__convert__closures_____invoke__h7cbc9124c26497ca: (a: number, b: number, c: any) => [number, number];
+    readonly wasm_bindgen__convert__closures_____invoke__h7051da1c61586a0d: (a: number, b: number, c: any, d: any) => void;
+    readonly wasm_bindgen__convert__closures_____invoke__h12e4aed491120ac3: (a: number, b: number, c: any) => void;
+    readonly wasm_bindgen__convert__closures_____invoke__hac69e780134632bb: (a: number, b: number, c: any) => void;
+    readonly wasm_bindgen__convert__closures_____invoke__hf5204abb72864ac9: (a: number, b: number) => void;
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_exn_store: (a: number) => void;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;