@human.tech/waap-sdk 2.0.0 → 2.1.0-staging-fb27bb

package/dist/types-DexmJNke.d.mts

@@ -0,0 +1,397 @@
+//#region ../silk-interface-core/dist/esm/messages/index.d.ts
+/**
+ * Method names for request and response messages
+ */
+declare enum SILK_METHOD {
+  eth_requestAccounts = "eth_requestAccounts" // https://eips.ethereum.org/EIPS/eip-1102
+  ,
+  eth_accounts = "eth_accounts",
+  eth_sendTransaction = "eth_sendTransaction",
+  eth_signTransaction = "eth_signTransaction",
+  eth_getBalance = "eth_getBalance",
+  personal_sign = "personal_sign",
+  eth_signTypedData_v4 = "eth_signTypedData_v4",
+  eth_chainId = "eth_chainId",
+  net_version = "net_version",
+  wallet_switchEthereumChain = "wallet_switchEthereumChain",
+  wallet_addEthereumChain = "wallet_addEthereumChain",
+  eth_estimateGas = "eth_estimateGas",
+  eth_blockNumber = "eth_blockNumber",
+  eth_getCode = "eth_getCode",
+  eth_call = "eth_call",
+  eth_getTransactionReceipt = "eth_getTransactionReceipt",
+  eth_getTransactionByHash = "eth_getTransactionByHash",
+  eth_accountsChanged = "eth_accountsChanged",
+  sui_connect = "sui_connect",
+  sui_disconnect = "sui_disconnect",
+  sui_getAccounts = "sui_getAccounts",
+  sui_signPersonalMessage = "sui_signPersonalMessage",
+  sui_signTransaction = "sui_signTransaction",
+  sui_signAndExecuteTransaction = "sui_signAndExecuteTransaction",
+  sui_switchChain = "sui_switchChain",
+  show_modal = "show_modal",
+  hide_modal = "hide_modal",
+  login = "login",
+  auto_conn = "auto_conn",
+  logout = "logout",
+  set_points_referral_code = "set_points_referral_code",
+  set_project = "set_project",
+  silk_requestEmail = "silk_requestEmail",
+  silk_requestSbt = "silk_requestSbt",
+  set_custom_config = "set_custom_config",
+  safe = "safe",
+  set_is_mobile = "set_is_mobile",
+  project_init = "project_init",
+  gastank_get_settings = "gastank_get_settings",
+  gastank_update_settings = "gastank_update_settings",
+  gastank_topup = "gastank_topup",
+  customization_get = "customization_get",
+  customization_update = "customization_update",
+  orcid = "orcid",
+  waap_requestPermissionToken = "waap_requestPermissionToken",
+  waap_getAccountStatus = "waap_getAccountStatus",
+  waap_getPermissionTokenStatus = "waap_getPermissionTokenStatus",
+  waap_clearPermissionToken = "waap_clearPermissionToken",
+  solana_connect = "solana_connect",
+  solana_disconnect = "solana_disconnect",
+  solana_signMessage = "solana_signMessage",
+  solana_signTransaction = "solana_signTransaction",
+  solana_signAllTransactions = "solana_signAllTransactions",
+  solana_signAndSendTransaction = "solana_signAndSendTransaction",
+  set_signing_mode = "set_signing_mode",
+  enter_lite_mode = "enter_lite_mode"
+}
+/** Portable-session protection selected by a current WaaP SDK integration. */
+type WaaPSessionProtection = 'bearer' | 'dpop';
+declare enum JSON_RPC_METHOD {
+  eth_requestAccounts = "eth_requestAccounts",
+  eth_accounts = "eth_accounts",
+  eth_sendTransaction = "eth_sendTransaction",
+  eth_signTransaction = "eth_signTransaction",
+  eth_getBalance = "eth_getBalance",
+  personal_sign = "personal_sign",
+  eth_signTypedData_v4 = "eth_signTypedData_v4",
+  eth_chainId = "eth_chainId",
+  net_version = "net_version",
+  wallet_switchEthereumChain = "wallet_switchEthereumChain",
+  wallet_addEthereumChain = "wallet_addEthereumChain",
+  eth_estimateGas = "eth_estimateGas",
+  eth_blockNumber = "eth_blockNumber",
+  eth_getCode = "eth_getCode",
+  eth_call = "eth_call",
+  eth_getTransactionReceipt = "eth_getTransactionReceipt",
+  eth_getTransactionByHash = "eth_getTransactionByHash"
+}
+/**
+ * Notification names
+ */
+declare enum SILK_NOTIFICATION {
+  ready = "ready",
+  connect = "connect",
+  account_changed = "account_changed",
+  mobile_oauth_success = "mobile_oauth_success",
+  mobile_oauth_error = "mobile_oauth_error",
+  tx_pending = "waap_txPending",
+  tx_2fa_required = "waap_tx2faRequired",
+  tx_signed = "waap_txSigned",
+  tx_confirmed = "waap_txConfirmed",
+  tx_failed = "waap_txFailed",
+  squid_pending = "waap_squid_pending",
+  squid_ready = "waap_squid_ready",
+  squid_failed = "waap_squid_failed",
+  request_cancel = "waap_requestCancel"
+}
+type SilkNotificationData = keyof typeof SILK_NOTIFICATION;
+//#endregion
+//#region ../silk-interface-core/dist/esm/index.d.ts
+type SilkMessage = {
+  target: 'silk';
+};
+type SilkRequest = SilkMessage & {
+  id: string;
+  messageType: 'request';
+  method: keyof typeof SILK_METHOD;
+  params: any[];
+  interactionRequired?: boolean;
+  /**
+   * Transaction behavior options.
+   * `async` enables async transaction mode for eth_sendTransaction.
+   */
+  silkOptions?: {
+    async?: boolean;
+    /** @deprecated Use `async` instead. Kept for v1 SDK backward compatibility. */
+    asyncSigning?: boolean;
+    is2FARequest?: boolean;
+    withPT?: boolean;
+  };
+};
+type AuthenticationMethod = 'email' | 'phone' | 'social' | 'biometrics' | 'wallet';
+type SocialProvider = 'discord' | 'github' | 'google' | 'twitter' | 'bluesky' | 'telegram';
+interface ProjectConfig {
+  name?: string;
+  entryTitle?: string;
+  logo?: string;
+  projectId?: string;
+  termsOfServiceUrl?: string;
+  privacyPolicyUrl?: string;
+  authSuccessUrl?: string;
+  authErrorUrl?: string;
+  emailLogoCid?: string;
+  appId?: string;
+  nativeRedirect?: string;
+  universalRedirect?: string;
+}
+interface StylesConfig {
+  darkMode?: boolean;
+}
+interface CustomConfig {
+  authenticationMethods?: AuthenticationMethod[];
+  allowedSocials?: SocialProvider[];
+  styles?: StylesConfig;
+  showSecured?: boolean;
+}
+type BaseSilkResponse = SilkMessage & {
+  id: string;
+  messageType: 'response';
+  method: string;
+};
+/**
+ * Versioned terminal-operation metadata. This is additive: SDK consumers keep
+ * reading `data` / `error`, while observability-aware consumers can correlate
+ * a terminal wallet result to the original iframe request without parsing
+ * method-specific payloads.
+ */
+interface SilkOperationResult {
+  version: 1;
+  requestId: string;
+  status: 'succeeded' | 'failed' | 'cancelled';
+  phase: 'complete';
+  error?: {
+    code: string;
+    message: string;
+  };
+}
+/** Additive cancellation notification sent from the SDK host to the iframe. */
+interface SilkRequestCancellation {
+  type: typeof SILK_NOTIFICATION.request_cancel;
+  requestId: string;
+  method: string;
+}
+type SilkResponse = BaseSilkResponse & {
+  data?: any;
+  error?: any;
+  operation?: SilkOperationResult;
+} & ({
+  data: any;
+  error?: never;
+} | {
+  data?: never;
+  error: any;
+});
+type CredentialType = 'kyc' | 'phone';
+/**
+ * Parameters for waap_requestPermissionToken RPC method.
+ * Apps use this to request a Permission Token from the user.
+ */
+interface RequestPermissionTokenParams {
+  /** Canonical `evm:<id>`, `sui:<network>`, or `solana:<network>` chain. */
+  chain: `evm:${number}` | `sui:${string}` | `solana:${string}`;
+  /** Optional only on request; the wallet signs an explicit `tap` default. */
+  walletMode?: 'tap' | 'squid';
+  /** Contract addresses that the PT should allow transactions to */
+  allowedAddresses: string[];
+  /** Optional USD spend limit; omit or use null for address-only scope. */
+  requestedAmountUsd?: number | string | null;
+  /** Requested expiry duration in seconds (max 7200 = 2 hours) */
+  requestedExpirySeconds: number;
+}
+/**
+ * Result of waap_requestPermissionToken RPC method.
+ */
+interface RequestPermissionTokenResult {
+  /** Whether the user approved and signed the PT */
+  success: boolean;
+  /** Error message if the request failed */
+  error?: string;
+}
+//#endregion
+//#region src/lib/walletTarget.d.ts
+/** Named wallet deployments understood by the browser SDK. */
+type WaaPEnvironment = 'development' | 'staging' | 'production';
+/**
+ * Select the wallet iframe deployment explicitly. `walletOrigin` is intended
+ * for a local wallet build or a partner-owned preview environment; it must be
+ * an origin, not a URL path.
+ */
+interface WaaPWalletTargetOptions {
+  environment?: WaaPEnvironment;
+  walletOrigin?: string;
+  /** @deprecated Use `environment: 'staging'` instead. */
+  useStaging?: boolean;
+}
+/** Validate and normalize an iframe target origin before it becomes security state. */
+declare function validateWalletOrigin(value: string): string;
+/**
+ * Resolve the one origin used for iframe creation, all postMessage calls, and
+ * incoming message checks. Explicit origins win over named environments, which
+ * win over the legacy staging flag and the existing compiled SDK default.
+ */
+declare function resolveWalletOrigin(options?: WaaPWalletTargetOptions): string;
+//#endregion
+//#region src/lib/provider/types.d.ts
+interface RequestArguments {
+  method: string;
+  params?: unknown[] | object;
+  async?: boolean;
+  withPT?: boolean;
+  /** Abort this wallet request and remove it from the iframe queue. */
+  signal?: AbortSignal;
+  /** SDK-side timeout for this request; not forwarded to the iframe. */
+  timeoutMs?: number;
+}
+interface EthereumProviderInterface {
+  enable(): Promise<unknown>;
+  isConnected(): boolean;
+  request(args: RequestArguments): Promise<unknown>;
+  on(event: string, listener: (...args: any[]) => void): this;
+  removeListener(event: string, listener: (...args: any[]) => void): this;
+}
+type LoginResponse = 'waap' | 'human' | 'injected' | 'walletconnect' | null;
+/** The explicit signing family selected by an initializer. */
+type WaaPAccountMode = 'tap' | 'squid';
+type WaaPConversionState = 'not_required' | 'required' | 'pending' | 'complete' | 'failed' |
+/**
+ * The wallet holds a signing key that does not derive its own address, so it
+ * cannot sign for it. Distinct from `failed`: retrying achieves nothing, the
+ * user's original key is intact, and resolving it needs operator action.
+ */
+'mismatched';
+/**
+ * Public-safe local session information. It never includes authentication
+ * material, key shares, policy tokens, policies, or profile data.
+ */
+interface WaaPAccountStatus {
+  authenticated: boolean;
+  loginMethod: LoginResponse;
+  /** Preferred name for `mode`; retained alongside it for readability. */
+  activeMode: WaaPAccountMode | null;
+  mode: WaaPAccountMode;
+  conversion: WaaPConversionState;
+  tap: null | {
+    t1: {
+      evm: string;
+      sui: string;
+    };
+    t2: {
+      solana: string;
+    };
+  };
+  squid: null | {
+    sqd1: {
+      evm: string;
+    };
+    sqd2: {
+      sui: string;
+      solana: string;
+    };
+  };
+  /** Convenience view of connected public facade accounts. */
+  accounts: {
+    evm?: string;
+    sui?: string;
+    solana?: string;
+  };
+}
+/**
+ * Options form of `login()`. Passed instead of a custom provider, which is
+ * distinguished at runtime by its EIP-1193 `request` method.
+ */
+interface WaaPLoginOptions {
+  /**
+   * Open the login UI even when the wallet could restore an existing session.
+   * Use it for an explicit "switch account" affordance; the default resolves
+   * a valid session without presenting UI.
+   */
+  force?: boolean;
+  customProvider?: EthereumProviderInterface;
+}
+/** Common WaaP lifecycle extension beside chain-standard interfaces. */
+interface WaaPSessionExtension {
+  login(customProvider?: unknown): Promise<LoginResponse>;
+  logout(): Promise<void>;
+  getLoginMethod(): LoginResponse;
+  /** Redacted canonical TAP/Squid snapshot from the wallet iframe. */
+  getAccountStatus(): Promise<WaaPAccountStatus>;
+}
+/** The dapp-visible scope of a wallet-owned Permission Token. */
+interface PermissionTokenQuery {
+  chainId: number | string;
+  sender: string;
+}
+/** Redacted Permission Token metadata; never includes the signed token. */
+interface PermissionTokenStatus {
+  present: boolean;
+  applicable: boolean;
+  chainId?: number | string;
+  sender?: string;
+  allowedAddresses?: string[];
+  amountUsd?: string;
+  expiresAt?: string;
+  reason?: 'missing' | 'expired' | 'chain_mismatch' | 'sender_mismatch';
+}
+interface PermissionTokenClearResult {
+  cleared: boolean;
+}
+interface SilkEthereumProviderInterface extends EthereumProviderInterface {
+  isSilk: boolean;
+  connected: boolean;
+  login(customProviderOrOptions?: any): Promise<LoginResponse>;
+  logout(): Promise<unknown>;
+  getLoginMethod(): LoginResponse;
+  getAccountStatus(): WaaPAccountStatus;
+  session: WaaPSessionExtension;
+  requestEmail(): Promise<unknown>;
+  requestSBT(type: CredentialType): Promise<unknown>;
+  requestPermissionToken(params: RequestPermissionTokenParams): Promise<unknown>;
+  getPermissionTokenStatus(query: PermissionTokenQuery): Promise<PermissionTokenStatus>;
+  clearPermissionToken(query: PermissionTokenQuery): Promise<PermissionTokenClearResult>;
+  toggleDarkMode(): Promise<void>;
+  /** Mount (if deferred) and complete the wallet handshake ahead of use. */
+  preload(): Promise<void>;
+  /** Release SDK message listeners and the shared wallet iframe. */
+  destroy(): void;
+}
+interface InitSilkOptions extends WaaPWalletTargetOptions {
+  referralCode?: string;
+  project?: ProjectConfig;
+  config?: CustomConfig;
+  walletConnectProjectId?: string;
+  /**
+   * Wallet session transport. Defaults to fail-closed DPoP. Select `bearer`
+   * only for an integration that cannot use the iframe's WebCrypto/IndexedDB
+   * DPoP key.
+   */
+  sessionProtection?: WaaPSessionProtection;
+  /**
+   * When true, the wallet iframe is mounted only by `preload()` or the first
+   * wallet operation. The default warms it after the browser becomes idle;
+   * pass `false` to mount eagerly during initialization.
+   */
+  deferIframe?: boolean;
+  /**
+   * When true, eth_sendTransaction resolves with `{ pendingTxId, status:
+   * 'pending' }` immediately after signing. Broadcasting and confirmation
+   * continue in the background with waap lifecycle events; the canonical
+   * transaction hash is available after node acceptance.
+   * Other signing methods (personal_sign, eth_signTypedData_v4, eth_signTransaction)
+   * are unaffected — they always resolve with the signature directly.
+   * Applies to ALL eth_sendTransaction calls for this SDK instance.
+   * Default: false
+   */
+  asyncTxs?: boolean;
+  /** @deprecated Use `asyncTxs` instead. */
+  asyncSigning?: boolean;
+}
+type SilkProvider = SilkEthereumProviderInterface;
+//#endregion
+export { SILK_METHOD as A, RequestPermissionTokenResult as C, SocialProvider as D, SilkResponse as E, WaaPSessionProtection as M, StylesConfig as O, RequestPermissionTokenParams as S, SilkRequestCancellation as T, validateWalletOrigin as _, PermissionTokenQuery as a, CustomConfig as b, SilkEthereumProviderInterface as c, WaaPAccountStatus as d, WaaPLoginOptions as f, resolveWalletOrigin as g, WaaPWalletTargetOptions as h, PermissionTokenClearResult as i, SilkNotificationData as j, JSON_RPC_METHOD as k, SilkProvider as l, WaaPEnvironment as m, InitSilkOptions as n, PermissionTokenStatus as o, WaaPSessionExtension as p, LoginResponse as r, RequestArguments as s, EthereumProviderInterface as t, WaaPAccountMode as u, AuthenticationMethod as v, SilkRequest as w, ProjectConfig as x, CredentialType as y };