@privy-io/js-sdk-core 0.28.0 → 0.28.1

package/dist/dts/SiweApi.d.mts

@@ -0,0 +1,75 @@
+import { type PrivyUser, type PrivyAuthenticatedUser } from '@privy-io/public-api';
+import type { ExternalWallet } from './types';
+/**
+ * [Sign-In With Ethereum](https://eips.ethereum.org/EIPS/eip-4361) auth flow.
+ *
+ * Privy's backend is able to issue access tokens using the [Sign-In With Ethereum](https://eips.ethereum.org/EIPS/eip-4361) spec.
+ * This enables developers to use Privy for reading/writing user *without* hosting their own backend to handle authentication. A big win for reducing operational complexity!
+ */
+export default class SiweApi {
+    /**
+     * Unlink a wallet account from a user. Note that you can only unlink a wallet account if the user has at least one other account.
+     *
+     * @returns The user object.
+     */
+    unlinkWallet(
+    /**
+     * The address of the wallet to be unlinked
+     */
+    address: string): Promise<PrivyUser>;
+    /**
+     * Link a new wallet via the [Sign-In With Ethereum](https://eips.ethereum.org/EIPS/eip-4361) spec.
+     *
+     * @returns The user object.
+     */
+    linkWithSiwe(
+    /**
+     * Signature generated against standard [Sign-In With Ethereum](https://eips.ethereum.org/EIPS/eip-4361) message
+     */
+    signature: string, 
+    /**
+     * Optional `ExternalWallet`, only needed if the wallet differs from the one cached during previous call to `generateMessage`
+     */
+    walletOverride?: ExternalWallet, 
+    /**
+     * Optional [Sign-In With Ethereum](https://eips.ethereum.org/EIPS/eip-4361) message, only needed if the message differs from the one in memory that was cached in previous call to `generateMessage`
+     */
+    messageOverride?: string): Promise<PrivyUser>;
+    /**
+     * Authenticate with Privy via the [Sign-In With Ethereum](https://eips.ethereum.org/EIPS/eip-4361) spec.
+     *
+     * @returns Session information.
+     */
+    loginWithSiwe(
+    /**
+     * Signature generated against standard [Sign-In With Ethereum](https://eips.ethereum.org/EIPS/eip-4361) message
+     */
+    signature: string, 
+    /**
+     * Optional `ExternalWallet`, only needed if the wallet differs from the one cached during previous call to `generateMessage`
+     */
+    walletOverride?: ExternalWallet, 
+    /**
+     * Optional [Sign-In With Ethereum](https://eips.ethereum.org/EIPS/eip-4361) message, only needed if the message differs from the one in memory that was cached in previous call to `generateMessage`
+     */
+    messageOverride?: string, 
+    /**
+     * Optional Whether or not to block sign ups (only allow existing users to log in).
+     */
+    mode?: 'login-or-sign-up' | 'no-signup'): Promise<PrivyAuthenticatedUser>;
+    /**
+     * Begin a login or link flow according to the [Sign-In With Ethereum](https://eips.ethereum.org/EIPS/eip-4361) spec.
+     *
+     * @returns [EIP-4361](https://eips.ethereum.org/EIPS/eip-4361) message and nonce used to create it
+     */
+    init(
+    /** Wallet to request a [Sign-In With Ethereum](https://eips.ethereum.org/EIPS/eip-4361) signature from */
+    wallet: ExternalWallet, 
+    /** [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) authority that is requesting the signing */
+    domain: string, 
+    /** [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) URI referring to the resource that is the subject of the signing */
+    uri: string): Promise<{
+        nonce: string;
+        message: string;
+    }>;
+}

package/dist/dts/Token.d.mts

@@ -0,0 +1,31 @@
+export declare class Token {
+    static parse(token: any): Token | null;
+    /**
+     * The raw token in string form.
+     */
+    value: string;
+    private _decoded;
+    constructor(value: string);
+    /**
+     * The subject is the user id to which this token is assigned.
+     */
+    get subject(): string;
+    /**
+     * The date in seconds since Epoch that this token expires.
+     */
+    get expiration(): number;
+    /**
+     * The party that issued the token, which should always be 'privy.io'
+     */
+    get issuer(): string;
+    /**
+     * The token audience, which will be the app ID for the customer app.'
+     */
+    get audience(): string;
+    /**
+     * Whether or not the token is to be considered expired.
+     *
+     * @param {number} seconds A number in seconds to reduce the expiration time by. Defaults to 0
+     */
+    isExpired(seconds?: number): boolean;
+}

package/dist/dts/UserApi.d.mts

@@ -0,0 +1,221 @@
+export default class UserApi {
+    /**
+     * Get the logged in user.
+     */
+    get(): Promise<{
+        user: {
+            id: string;
+            mfa_methods: ({
+                type: "sms";
+                verified_at: number;
+            } | {
+                type: "totp";
+                verified_at: number;
+            } | {
+                type: "passkey";
+                verified_at: number;
+            })[];
+            linked_accounts: ({
+                type: "email";
+                address: string;
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+            } | {
+                type: "phone";
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                phoneNumber: string;
+            } | {
+                type: "wallet";
+                address: string;
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                chain_type: "ethereum";
+                wallet_client: "unknown";
+                chain_id?: string | undefined;
+                wallet_client_type?: string | undefined;
+                connector_type?: string | undefined;
+            } | {
+                type: "smart_wallet";
+                address: string;
+                smart_wallet_type: "safe" | "kernel" | "biconomy" | "light_account";
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+            } | {
+                type: "wallet";
+                address: string;
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                chain_type: "solana";
+                wallet_client: "unknown";
+                wallet_client_type?: string | undefined;
+                connector_type?: string | undefined;
+            } | {
+                type: "farcaster";
+                fid: number;
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                owner_address: string;
+                username?: string | undefined;
+                display_name?: string | undefined;
+                bio?: string | undefined;
+                profile_picture?: string | undefined;
+                profile_picture_url?: string | undefined;
+                homepage_url?: string | undefined;
+                signer_public_key?: string | undefined;
+            } | {
+                type: "passkey";
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                credential_id: string;
+                enrolled_in_mfa: boolean;
+                created_with_browser?: string | undefined;
+                created_with_os?: string | undefined;
+                created_with_device?: string | undefined;
+                authenticator_name?: string | undefined;
+            } | {
+                telegramUserId: string;
+                firstName: string | null | undefined;
+                type: "telegram";
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                telegram_user_id: string;
+                username?: string | null | undefined;
+                first_name?: string | null | undefined;
+                last_name?: string | null | undefined;
+                photo_url?: string | null | undefined;
+            } | {
+                type: "wallet";
+                address: string;
+                chain_id: "eip155:1";
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                chain_type: "ethereum";
+                wallet_client: "privy";
+                wallet_client_type: "privy";
+                connector_type: "embedded";
+                imported: boolean;
+                wallet_index: number;
+                recovery_method: "user-passcode" | "google-drive" | "icloud" | "privy";
+            } | {
+                type: "wallet";
+                address: string;
+                public_key: string;
+                chain_id: "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp";
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                chain_type: "solana";
+                wallet_client_type: "privy";
+                connector_type: "embedded";
+                imported: boolean;
+                recovery_method: "privy";
+            } | {
+                type: "google_oauth";
+                name: string | null;
+                email: string;
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                subject: string;
+            } | {
+                type: "twitter_oauth";
+                name: string | null;
+                username: string | null;
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                profile_picture_url: string | null;
+                subject: string;
+            } | {
+                type: "discord_oauth";
+                email: string | null;
+                username: string | null;
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                subject: string;
+            } | {
+                type: "github_oauth";
+                name: string | null;
+                email: string | null;
+                username: string | null;
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                subject: string;
+            } | {
+                type: "linkedin_oauth";
+                email: string | null;
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                subject: string;
+                name?: string | undefined;
+                vanity_name?: string | undefined;
+            } | {
+                type: "spotify_oauth";
+                name: string | null;
+                email: string | null;
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                subject: string;
+            } | {
+                type: "instagram_oauth";
+                username: string | null;
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                subject: string;
+            } | {
+                type: "tiktok_oauth";
+                name: string | null;
+                username: string | null;
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                subject: string;
+            } | {
+                type: "apple_oauth";
+                email: string | null;
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                subject: string;
+            } | {
+                type: "custom_auth";
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                custom_user_id: string;
+            } | {
+                type: "cross_app";
+                provider_app_id: string;
+                verified_at: number;
+                first_verified_at: number | null;
+                latest_verified_at: number | null;
+                subject: string;
+                embedded_wallets: {
+                    address: string;
+                }[];
+                smart_wallets: {
+                    address: string;
+                }[];
+            })[];
+            created_at: number;
+            has_accepted_terms: boolean;
+            is_guest: boolean;
+            custom_metadata?: Record<string, string> | undefined;
+        } | null;
+    }>;
+}

package/dist/dts/chains/arbitrum.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './index';
+export declare const arbitrum: Chain;

package/dist/dts/chains/arbitrumGoerli.d.mts

@@ -0,0 +1,7 @@
+import type { Chain } from './index';
+/**
+ * These have been modified from the original WAGMI chain definition
+ *
+ * @deprecated Use `arbitrumSepolia` instead
+ */
+export declare const arbitrumGoerli: Chain;

package/dist/dts/chains/arbitrumSepolia.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './types';
+export declare const arbitrumSepolia: Chain;

package/dist/dts/chains/avalanche.d.mts

@@ -0,0 +1,5 @@
+import type { Chain } from './index';
+/**
+ * These have been modified from the original WAGMI chain definition
+ */
+export declare const avalanche: Chain;

package/dist/dts/chains/avalancheFuji.d.mts

@@ -0,0 +1,5 @@
+import type { Chain } from './index';
+/**
+ * These have been modified from the original WAGMI chain definition
+ */
+export declare const avalancheFuji: Chain;

package/dist/dts/chains/base.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './index';
+export declare const base: Chain;

package/dist/dts/chains/baseGoerli.d.mts

@@ -0,0 +1,7 @@
+import type { Chain } from './index';
+/**
+ * These have been modified from the original WAGMI chain definition
+ *
+ * @deprecated Use `baseSepolia` instead
+ */
+export declare const baseGoerli: Chain;

package/dist/dts/chains/baseSepolia.d.mts

@@ -0,0 +1,5 @@
+import type { Chain } from './types';
+/**
+ * These have been modified from the original WAGMI chain definition
+ */
+export declare const baseSepolia: Chain;

package/dist/dts/chains/berachainArtio.d.mts

@@ -0,0 +1,5 @@
+import type { Chain } from './types';
+/**
+ * These have been modified from the original WAGMI chain definition
+ */
+export declare const berachainArtio: Chain;

package/dist/dts/chains/celo.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './index';
+export declare const celo: Chain;

package/dist/dts/chains/celoAlfajores.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './index';
+export declare const celoAlfajores: Chain;

package/dist/dts/chains/filecoin.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './index';
+export declare const filecoin: Chain;

package/dist/dts/chains/filecoinCalibration.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './index';
+export declare const filecoinCalibration: Chain;

package/dist/dts/chains/garnetHolesky.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './index';
+export declare const garnetHolesky: Chain;

package/dist/dts/chains/goerli.d.mts

@@ -0,0 +1,5 @@
+import type { Chain } from './index';
+/**
+ * @deprecated Use `sepolia` instead
+ */
+export declare const goerli: Chain;

package/dist/dts/chains/holesky.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './index';
+export declare const holesky: Chain;

package/dist/dts/chains/index.d.mts

@@ -0,0 +1,34 @@
+export type { Unit, Chain, RpcConfig } from './types';
+export declare const chainDefs: {
+    readonly mainnet: import("./types").Chain;
+    readonly goerli: import("./types").Chain;
+    readonly sepolia: import("./types").Chain;
+    readonly arbitrum: import("./types").Chain;
+    readonly arbitrumGoerli: import("./types").Chain;
+    readonly arbitrumSepolia: import("./types").Chain;
+    readonly optimism: import("./types").Chain;
+    readonly optimismGoerli: import("./types").Chain;
+    readonly optimismSepolia: import("./types").Chain;
+    readonly polygon: import("./types").Chain;
+    readonly polygonMumbai: import("./types").Chain;
+    readonly celo: import("./types").Chain;
+    readonly celoAlfajores: import("./types").Chain;
+    readonly filecoin: import("./types").Chain;
+    readonly filecoinCalibration: import("./types").Chain;
+    readonly base: import("./types").Chain;
+    readonly baseGoerli: import("./types").Chain;
+    readonly baseSepolia: import("./types").Chain;
+    readonly linea: import("./types").Chain;
+    readonly lineaTestnet: import("./types").Chain;
+    readonly avalanche: import("./types").Chain;
+    readonly avalancheFuji: import("./types").Chain;
+    readonly holesky: import("./types").Chain;
+    readonly redstone: import("./types").Chain;
+    readonly garnetHolesky: import("./types").Chain;
+    readonly redstoneHolesky: import("./types").Chain;
+    readonly zora: import("./types").Chain;
+    readonly zoraSepolia: import("./types").Chain;
+    readonly zoraTestnet: import("./types").Chain;
+};
+export declare const DEFAULT_SUPPORTED_CHAINS: readonly [import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain, import("./types").Chain];
+export declare const DEFAULT_SUPPORTED_CHAIN_IDS: Set<number>;

package/dist/dts/chains/linea.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './index';
+export declare const linea: Chain;

package/dist/dts/chains/lineaTestnet.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './index';
+export declare const lineaTestnet: Chain;

package/dist/dts/chains/mainnet.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './types';
+export declare const mainnet: Chain;

package/dist/dts/chains/optimism.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './index';
+export declare const optimism: Chain;

package/dist/dts/chains/optimismGoerli.d.mts

@@ -0,0 +1,5 @@
+import type { Chain } from './index';
+/**
+ * @deprecated Use `optimismSepolia` instead
+ */
+export declare const optimismGoerli: Chain;

package/dist/dts/chains/optimismSepolia.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './types';
+export declare const optimismSepolia: Chain;

package/dist/dts/chains/polygon.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './index';
+export declare const polygon: Chain;

package/dist/dts/chains/polygonAmoy.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './index';
+export declare const polygonAmoy: Chain;

package/dist/dts/chains/polygonMumbai.d.mts

@@ -0,0 +1,5 @@
+import type { Chain } from './index';
+/**
+ * @deprecated Use `polygonAmoy` instead
+ */
+export declare const polygonMumbai: Chain;

package/dist/dts/chains/redstone.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './index';
+export declare const redstone: Chain;

package/dist/dts/chains/redstoneHolesky.d.mts

@@ -0,0 +1,5 @@
+import type { Chain } from './index';
+/**
+ * @deprecated Use garnetHolesky instead.
+ */
+export declare const redstoneHolesky: Chain;

package/dist/dts/chains/sepolia.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './index';
+export declare const sepolia: Chain;

package/dist/dts/chains/types.d.mts

@@ -0,0 +1,59 @@
+/**
+ * These types are fully compatible with WAGMI chain types, in case
+ * we need interop in the future.
+ */
+type RpcUrls = {
+    http: readonly string[];
+    webSocket?: readonly string[];
+};
+type NativeCurrency = {
+    name: string;
+    /** 2-6 characters long */
+    symbol: string;
+    decimals: number;
+};
+type BlockExplorer = {
+    name: string;
+    url: string;
+};
+export type Unit = 'ether' | 'gwei' | 'wei' | number;
+/** A subset of WAGMI's chain type
+ * https://github.com/wagmi-dev/references/blob/6aea7ee9c65cfac24f33173ab3c98176b8366f05/packages/chains/src/types.ts#L8
+ */
+export type Chain = {
+    /** Id in number form */
+    id: number;
+    /** Human readable name */
+    name: string;
+    /** Internal network name */
+    network?: string;
+    /** Currency used by chain */
+    nativeCurrency: NativeCurrency;
+    /** Collection of block explorers */
+    blockExplorers?: {
+        [key: string]: BlockExplorer;
+        default: BlockExplorer;
+    };
+    /** Collection of RPC endpoints */
+    rpcUrls: {
+        [key: string]: RpcUrls;
+        default: RpcUrls;
+    };
+    /** Flag for test networks */
+    testnet?: boolean;
+};
+/**
+ * RPC overrides to support custom RPC URLs. Do not provide an RPC URL
+ * that can serve multiple networks. You should only provide RPC URLs that
+ * are specific to the network you'd like to override.
+ */
+export type RpcConfig = {
+    /**
+     * Mapping of chainId to RPC URL. Overrides Privy default RPC URLs that are shared across projects. Set your own RPC URLs
+     * to avoid rate limits or other throughput bottlenecks.
+     */
+    rpcUrls: {
+        [key: number]: string;
+    };
+};
+export {};

package/dist/dts/chains/zora.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './types';
+export declare const zora: Chain;

package/dist/dts/chains/zoraSepolia.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './types';
+export declare const zoraSepolia: Chain;

package/dist/dts/chains/zoraTestnet.d.mts

@@ -0,0 +1,2 @@
+import type { Chain } from './types';
+export declare const zoraTestnet: Chain;

package/dist/dts/crypto/types.d.mts

@@ -0,0 +1 @@
+export {};

package/dist/dts/embedded/EmbeddedSolanaWalletProvider.d.mts

@@ -0,0 +1,11 @@
+type RequestArguments = {
+    method: 'signMessage';
+    params: any;
+};
+export declare class EmbeddedSolanaWalletProvider {
+    _publicKey: string;
+    request(request: RequestArguments): Promise<{
+        signature: string;
+    }>;
+}
+export {};

package/dist/dts/embedded/EmbeddedWalletProvider.d.mts

@@ -0,0 +1,47 @@
+import EventEmitter from 'eventemitter3';
+import { type ProviderRpcError } from './errors';
+type ProviderConnectInfo = {
+    chainId: string;
+};
+type OnConnectEventHandler = (connectInfo: ProviderConnectInfo) => void;
+type OnDisconnectEventHandler = (error: ProviderRpcError) => void;
+type OnChainChangedEventHandler = (chainId: string | number) => void;
+type OnAccountsChangedEventHandler = (accounts: string[]) => void;
+type ProviderMessage = {
+    type: string;
+    data: unknown;
+};
+type OnMessageEventHandler = (message: ProviderMessage) => void;
+type EIP1193OnEventHandler = OnConnectEventHandler | OnDisconnectEventHandler | OnChainChangedEventHandler | OnAccountsChangedEventHandler | OnMessageEventHandler;
+interface EIP1193Provider {
+    request: (request: {
+        method: string;
+        params?: Array<unknown> | undefined;
+    }) => Promise<unknown>;
+    on: (eventName: string, listener: EIP1193OnEventHandler) => unknown;
+    removeListener: (eventName: string | symbol, listener: (...args: unknown[]) => void) => unknown;
+}
+type RequestArguments = {
+    method: string;
+    params?: Array<any> | undefined;
+};
+export declare class EmbeddedWalletProvider extends EventEmitter implements EIP1193Provider {
+    request(request: RequestArguments): Promise<any>;
+    /**
+     * Backfills a transaction that may not specify a `chainId` with the provider's `this._chianId`
+     */
+    private ensureChainId;
+    /**
+     * If a chainId is provided that differs from the current `this._chainId`,
+     * the new chain and StaticJsonRpcProvider will be set
+     */
+    private internalSwitchEthereumChain;
+    private handlePopulateTransaction;
+    private handleSendTransaction;
+    private handleEstimateGas;
+    private handleSwitchEthereumChain;
+    private handleIFrameRpc;
+    private handleJsonRpc;
+    toJSON(): string;
+}
+export {};

package/dist/dts/embedded/EmbeddedWalletProxy.d.mts

@@ -0,0 +1 @@
+export declare const DEFAULT_WALLET_PROXY_TIMEOUT_MS = 15000;