@upbond/sdk - v0.0.3
    Preparing search index...

    Interface UpbondWalletConfig

    The embedded-wallet leg of UpbondConfig. Omit it for an auth-only integration. Two shapes share this type: mode: 'redirect' (default) runs the MPC ceremony on the RP page and needs the Web3Auth fields; mode: 'embedded' delegates to a wallet-origin widget and needs only walletOrigin (docs/25-widget.md, docs/24-sdk-design.md D12). Setting environment supplies UPBOND infra defaults for either mode.

    interface UpbondWalletConfig {
        environment?: UpbondEnvironment;
        mode?: "redirect" | "embedded";
        network?: "sapphire_mainnet" | "sapphire_devnet";
        recovery?: Partial<UpbondWalletRecoveryConfig> | null;
        rpId?: string;
        verifier?: string;
        walletOrigin?: string;
        web3authClientId?: string;
    }
    Index
    environment? mode? network? recovery? rpId? verifier? walletOrigin? web3authClientId?
    environment?: UpbondEnvironment

    Wallet-leg environment override. Defaults to the top-level UpbondConfig.environment (itself defaulting to 'production'); set it only to point the wallet leg at a different deployment than the issuer. Explicit fields below override the preset field-by-field.

    mode?: "redirect" | "embedded"

    'embedded' (default): the wallet lives in a wallet-origin iframe/popup and the RP talks EIP-1193 (docs/25-widget.md) — keys, passkeys and ceremonies never enter the RP page; only walletOrigin applies. 'redirect': the RP page itself runs the MPC ceremony via the wallet-core layer. When mode is omitted but any local-MPC field below (web3authClientId/network/verifier/rpId/recovery) is set, the config is treated as 'redirect' (pre-D18 configs keep working unchanged).

    network?: "sapphire_mainnet" | "sapphire_devnet"

    Required unless environment supplies it (redirect mode).

    recovery?: Partial<UpbondWalletRecoveryConfig> | null

    Recovery-service wiring (WO 2026/003995, redirect mode). Omit to inherit the preset's wiring (or none without a preset); pass null to disable recovery even when the preset provides it. An explicit object merges over the preset field-by-field — e.g. recovery: { promptOtp } just adds the OTP UI on top of the preset URLs.

    rpId?: string

    WebAuthn RP ID for the passkey factor; defaults to the page's domain.

    verifier?: string

    Custom verifier trusting the issuer JWKS (verifierId = OIDC sub). Required unless environment supplies it (redirect mode).

    walletOrigin?: string

    Origin serving the widget (embedded mode). Required unless environment supplies it.

    web3authClientId?: string

    Web3Auth dashboard project ID (redirect mode). Defaults to UPBOND's project via environment; set it only to run against your own Web3Auth project. Required when no environment is set.

    Settings
    Member Visibility

    On This Page
    Properties