@unlink-xyz/react 0.1.5 → 0.1.6

package/dist/multisig/index.d.ts

@@ -0,0 +1,106 @@
+import { MultisigAccount, IndexedDbStore, MultisigAccountStore, ViewingKeyPair, SessionEvent } from '@unlink-xyz/multisig';
+import { SignerOverride } from '@unlink-xyz/core';
+
+type UseMultisigAccountsResult = {
+    /** All stored multisig accounts. */
+    accounts: MultisigAccount[];
+    /** Whether the initial load is in progress. */
+    loading: boolean;
+    /** Load a single account by groupId. */
+    load: (groupId: string) => Promise<MultisigAccount | null>;
+    /** Delete an account by groupId and refresh the list. */
+    remove: (groupId: string) => Promise<void>;
+    /** Re-fetch the account list from the store. */
+    refresh: () => Promise<void>;
+    /** The underlying store instance (for save() from other hooks). */
+    store: IndexedDbStore;
+};
+/**
+ * Reactive wrapper around `IndexedDbStore` for managing multisig accounts.
+ */
+declare function useMultisigAccounts(): UseMultisigAccountsResult;
+
+type DkgState = "idle" | "creating" | "joining" | "completing" | "complete" | "error";
+type CreateParams = {
+    threshold: number;
+    totalShares: number;
+    gatewayUrl: string;
+    viewingKeyPair?: ViewingKeyPair;
+};
+type JoinParams = {
+    code: string;
+    gatewayUrl: string;
+    viewingKeyPair?: ViewingKeyPair;
+};
+type UseDkgOptions = {
+    /** Provide a store from useMultisigAccounts to share persistence. */
+    store?: MultisigAccountStore;
+};
+type UseDkgResult = {
+    state: DkgState;
+    /** The completed multisig account (available when state === "complete"). */
+    account: MultisigAccount | null;
+    /** The DKG group ID / join code (available after create()). */
+    groupId: string | null;
+    error: Error | null;
+    /** Start a new DKG ceremony as the creator. */
+    create: (params: CreateParams) => Promise<void>;
+    /** Join an existing DKG ceremony. */
+    join: (params: JoinParams) => Promise<void>;
+    /** Reset to idle state. */
+    reset: () => void;
+};
+/**
+ * DKG ceremony state machine.
+ *
+ * Wraps `createMultisig()` / `joinMultisig()` with React state.
+ * On completion, auto-stores the account via the provided store
+ * (or a default `IndexedDbStore` if none is given).
+ */
+declare function useDkg(options?: UseDkgOptions): UseDkgResult;
+
+type UseMultisigSignerParams = {
+    account: MultisigAccount;
+    /** Participant indices that will co-sign. */
+    participants: number[];
+    metadata?: Record<string, string>;
+    onSessionCreated?: (code: string) => void;
+};
+/**
+ * Build a `SignerOverride` from a `MultisigAccount`.
+ *
+ * The returned value can be passed to `useTransfer(overrides)` or
+ * `useWithdraw(overrides)` to sign transactions with the multisig.
+ *
+ * Returns `null` when `params` is `undefined` (no account selected).
+ */
+declare function useMultisigSigner(params: UseMultisigSignerParams | undefined): SignerOverride | null;
+
+type UseSigningListenerParams = {
+    account: MultisigAccount;
+    /** Called before signing. Return false to skip. Defaults to auto-approve. */
+    approve?: (session: SessionEvent) => Promise<boolean> | boolean;
+    /** Polling interval in ms (default 1000). */
+    pollIntervalMs?: number;
+    /** Start listening immediately on mount (default true). */
+    autoStart?: boolean;
+};
+type UseSigningListenerResult = {
+    /** Whether the listener is currently running. */
+    listening: boolean;
+    /** Session events received so far. */
+    events: SessionEvent[];
+    /** Start the listener. */
+    start: () => void;
+    /** Stop the listener. */
+    stop: () => void;
+};
+/**
+ * Lifecycle wrapper around `runSigningListener()`.
+ *
+ * Automatically starts/stops with component mount/unmount
+ * when `autoStart` is true (default).
+ */
+declare function useSigningListener(params: UseSigningListenerParams): UseSigningListenerResult;
+
+export { type DkgState, type UseDkgOptions, useDkg, useMultisigAccounts, useMultisigSigner, useSigningListener };