@layr-labs/ecloud-sdk 0.2.0 → 0.2.2-dev

package/dist/browser.d.cts

@@ -0,0 +1,239 @@
+import { A as AppId } from './index-DeQzn_yM.cjs';
+export { al as AlreadyActiveResponse, w as AppConfig, ac as AppProfile, ad as AppProfileResponse, a2 as AppRecord, K as BatchedDeployResult, a5 as BillingEnvironmentConfig, C as CalculateAppIDOptions, aq as CancelResponse, ao as CancelSuccessResponse, af as ChainID, ak as CheckoutCreatedResponse, ai as CreateSubscriptionOptions, aj as CreateSubscriptionResponse, D as DeployAppOptions, N as DeployAppOpts, a3 as DeployOptions, at as DeployProgressCallback, a4 as DeployResult, au as DeployStep, aa as DockerImageConfig, a6 as EnvironmentConfig, E as EstimateGasOptions, J as ExecuteDeployBatchedOptions, X as ExecuteDeployResult, H as ExecuteDeploySequentialOptions, Y as ExecuteUpgradeResult, G as GasEstimate, W as GasOpts, a9 as ImageDigestResult, I as IsDelegatedOptions, a1 as LifecycleOpts, ab as Logger, ap as NoActiveSubscriptionResponse, a8 as ParsedEnvironment, am as PaymentIssueResponse, P as PrepareDeployBatchOptions, T as PrepareDeployFromVerifiableBuildOpts, Q as PrepareDeployOpts, x as PrepareUpgradeBatchOptions, V as PrepareUpgradeFromVerifiableBuildOpts, R as PrepareUpgradeOpts, $ as PreparedDeploy, y as PreparedDeployBatch, Z as PreparedDeployData, a0 as PreparedUpgrade, z as PreparedUpgradeBatch, _ as PreparedUpgradeData, ae as ProductID, ar as ProductSubscriptionResponse, a7 as Release, S as SendTransactionOptions, av as SequentialDeployResult, an as SubscribeResponse, ah as SubscriptionLineItem, as as SubscriptionOpts, ag as SubscriptionStatus, B as SuspendOptions, F as UndelegateOptions, U as UpgradeAppOptions, O as UpgradeAppOpts, j as calculateAppID, i as deployApp, e as estimateTransactionGas, h as executeDeployBatch, l as executeDeployBatched, k as executeDeploySequential, o as executeUpgradeBatch, f as formatETH, c as getActiveAppCount, g as getAllAppsByDeveloper, a as getAppsByCreator, b as getAppsByDeveloper, d as getMaxActiveAppsPerUser, r as isDelegated, M as logVisibility, L as noopLogger, p as prepareDeployBatch, n as prepareUpgradeBatch, q as sendAndWaitForTransaction, m as supportsEIP5792, s as supportsEIP7702, t as suspend, v as undelegate, u as upgradeApp } from './index-DeQzn_yM.cjs';
+import { C as ComputeApiConfig, S as SessionInfo, a as SessionError, b as SiweMessageParams } from './helpers-CEvhJz7f.cjs';
+export { F as AppInfo, J as AppInfoResponse, I as AppMetrics, H as AppProfileInfo, K as BillingApiClient, z as CreateAppParams, P as EstimateBatchGasOptions, Q as ExecuteBatchOptions, R as Execution, G as GeneratedKey, L as LogVisibility, a3 as LoginRequest, a2 as LoginResult, A as LogsParams, Z as SiweMessageResult, U as UserApiClient, E as UserApiClientOptions, a5 as addHexPrefix, j as assertValidImageReference, n as assertValidPrivateKey, O as checkERC7702Delegation, T as createSiweMessage, M as estimateBatchGas, N as executeBatch, k as extractAppNameFromImage, D as generateNewPrivateKey, W as generateNonce, d as getAvailableEnvironments, c as getBillingEnvironmentConfig, e as getBuildType, a4 as getChainFromID, a0 as getComputeApiSession, g as getEnvironmentConfig, i as isEnvironmentAvailable, f as isMainnet, a1 as isSessionValid, X as isSiweMessageExpired, Y as isSiweMessageNotYetValid, B as isSubscriptionActive, _ as loginToComputeApi, $ as logoutFromComputeApi, V as parseSiweMessage, t as sanitizeString, u as sanitizeURL, w as sanitizeXURL, a6 as stripHexPrefix, r as validateAppID, v as validateAppName, x as validateCreateAppParams, q as validateDescription, h as validateImageReference, l as validateInstanceTypeSKU, s as validateLogVisibility, y as validateLogsParams, m as validatePrivateKeyFormat, o as validateURL, p as validateXURL } from './helpers-CEvhJz7f.cjs';
+import { WalletClient, Address, Hex } from 'viem';
+import { Buffer as Buffer$1 } from 'buffer';
+
+/**
+ * Build API Client to manage verifiable builds and provenance
+ *
+ * This is a standalone HTTP client that talks to the (compute) UserAPI host.
+ */
+
+declare class BuildApiClient {
+    private readonly baseUrl;
+    private readonly walletClient?;
+    private readonly clientId?;
+    constructor(options: {
+        baseUrl: string;
+        walletClient?: WalletClient;
+        clientId?: string;
+    });
+    /**
+     * Get the address of the connected wallet
+     */
+    get address(): Address;
+    submitBuild(payload: {
+        repo_url: string;
+        git_ref: string;
+        dockerfile_path: string;
+        caddyfile_path?: string;
+        build_context_path: string;
+        dependencies: string[];
+    }): Promise<{
+        build_id: string;
+    }>;
+    getBuild(buildId: string): Promise<any>;
+    getBuildByDigest(digest: string): Promise<any>;
+    verify(identifier: string): Promise<any>;
+    getLogs(buildId: string): Promise<string>;
+    listBuilds(params: {
+        billing_address: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<any[]>;
+    private publicJsonRequest;
+    private authenticatedJsonRequest;
+    private authenticatedTextRequest;
+}
+
+/**
+ * Browser-safe app action encoders
+ *
+ * These functions encode calldata for app lifecycle operations.
+ * They only depend on viem and are safe to use in browser environments.
+ */
+
+/**
+ * Encode start app call data for gas estimation or transaction
+ */
+declare function encodeStartAppData(appId: AppId): `0x${string}`;
+/**
+ * Encode stop app call data for gas estimation or transaction
+ */
+declare function encodeStopAppData(appId: AppId): `0x${string}`;
+/**
+ * Encode terminate app call data for gas estimation or transaction
+ */
+declare function encodeTerminateAppData(appId: AppId): `0x${string}`;
+
+/**
+ * React Hook for Compute API Session Management
+ *
+ * This hook provides a convenient way to manage compute API sessions in React applications.
+ * It handles session state, auto-refresh, and provides login/logout methods.
+ *
+ * IMPORTANT: This hook requires React 18+ as a peer dependency.
+ * Make sure your application has React installed.
+ */
+
+interface UseComputeSessionConfig extends ComputeApiConfig {
+    /**
+     * Interval in milliseconds to check session validity
+     * Set to 0 to disable auto-refresh
+     * @default 60000 (1 minute)
+     */
+    refreshInterval?: number;
+    /**
+     * Whether to automatically check session on mount
+     * @default true
+     */
+    checkOnMount?: boolean;
+    /**
+     * Callback when session expires or becomes invalid
+     */
+    onSessionExpired?: () => void;
+    /**
+     * Callback when session is successfully refreshed/validated
+     */
+    onSessionRefreshed?: (session: SessionInfo) => void;
+    /**
+     * Callback when an error occurs
+     */
+    onError?: (error: SessionError) => void;
+}
+interface UseComputeSessionReturn {
+    /** Current session information */
+    session: SessionInfo | null;
+    /** Whether the session is currently being loaded/checked */
+    isLoading: boolean;
+    /** Any error that occurred during session operations */
+    error: SessionError | null;
+    /** Whether the user is authenticated */
+    isAuthenticated: boolean;
+    /**
+     * Login to compute API with SIWE
+     *
+     * @param params - SIWE message parameters (address, chainId required)
+     * @param signMessage - Function to sign the message (from wagmi's useSignMessage)
+     * @returns Login result
+     */
+    login: (params: Omit<SiweMessageParams, "domain" | "uri"> & {
+        domain?: string;
+        uri?: string;
+    }, signMessage: (args: {
+        message: string;
+    }) => Promise<Hex>) => Promise<SessionInfo>;
+    /**
+     * Logout from compute API
+     */
+    logout: () => Promise<void>;
+    /**
+     * Manually refresh/check session status
+     */
+    refresh: () => Promise<SessionInfo>;
+    /**
+     * Clear any error state
+     */
+    clearError: () => void;
+}
+/**
+ * React hook for managing compute API sessions with SIWE authentication
+ *
+ * @param config - Configuration options including baseUrl and refresh settings
+ * @returns Session state and methods for login/logout/refresh
+ *
+ * @example
+ * ```tsx
+ * import { useComputeSession } from "@layr-labs/ecloud-sdk/browser";
+ * import { useSignMessage, useAccount } from "wagmi";
+ *
+ * function MyComponent() {
+ *   const { address, chainId } = useAccount();
+ *   const { signMessageAsync } = useSignMessage();
+ *
+ *   const {
+ *     session,
+ *     isLoading,
+ *     isAuthenticated,
+ *     login,
+ *     logout,
+ *     error,
+ *   } = useComputeSession({
+ *     baseUrl: "https://api.eigencloud.xyz",
+ *     onSessionExpired: () => console.log("Session expired!"),
+ *   });
+ *
+ *   const handleLogin = async () => {
+ *     if (!address || !chainId) return;
+ *     await login(
+ *       { address, chainId },
+ *       signMessageAsync
+ *     );
+ *   };
+ *
+ *   if (isLoading) return <div>Loading...</div>;
+ *
+ *   return (
+ *     <div>
+ *       {isAuthenticated ? (
+ *         <>
+ *           <p>Logged in as {session?.address}</p>
+ *           <button onClick={logout}>Logout</button>
+ *         </>
+ *       ) : (
+ *         <button onClick={handleLogin}>Login</button>
+ *       )}
+ *       {error && <p>Error: {error.message}</p>}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useComputeSession(config: UseComputeSessionConfig): UseComputeSessionReturn;
+
+/**
+ * KMS encryption utilities
+ * Implements RSA-OAEP-256 + AES-256-GCM encryption using JWE format
+ */
+
+/**
+ * Get app protected headers for encryption
+ */
+declare function getAppProtectedHeaders(appID: string): Record<string, string>;
+/**
+ * Encrypt data using RSA-OAEP-256 for key encryption and AES-256-GCM for data encryption
+ * Uses jose library which properly implements JWE with RSA-OAEP-256
+ */
+declare function encryptRSAOAEPAndAES256GCM(encryptionKeyPEM: string | Buffer$1, plaintext: Buffer$1, protectedHeaders?: Record<string, string> | null): Promise<string>;
+
+/**
+ * KMS key loading utilities
+ */
+type BuildType = "dev" | "prod";
+/**
+ * Get KMS keys for environment
+ */
+declare function getKMSKeysForEnvironment(environment: string, build?: BuildType): {
+    encryptionKey: Buffer;
+    signingKey: Buffer;
+};
+
+/**
+ * Browser-safe SDK entry point
+ *
+ * This module exports only code that can run in browser environments.
+ * It excludes Node.js-only dependencies like:
+ * - dockerode (Docker API)
+ * - @napi-rs/keyring (OS keychain)
+ * - fs operations (file system)
+ * - @inquirer/prompts (CLI prompts)
+ *
+ * Use this entry point in React/Next.js/browser applications:
+ * import { ... } from "@layr-labs/ecloud-sdk/browser"
+ */
+
+type Environment = "sepolia" | "sepolia-dev" | "mainnet-alpha";
+
+export { AppId, BuildApiClient, ComputeApiConfig, type Environment, SessionError, SessionInfo, SiweMessageParams, type UseComputeSessionConfig, type UseComputeSessionReturn, encodeStartAppData, encodeStopAppData, encodeTerminateAppData, encryptRSAOAEPAndAES256GCM, getAppProtectedHeaders, getKMSKeysForEnvironment, useComputeSession };

package/dist/browser.d.ts

@@ -0,0 +1,239 @@
+import { A as AppId } from './index-DeQzn_yM.js';
+export { al as AlreadyActiveResponse, w as AppConfig, ac as AppProfile, ad as AppProfileResponse, a2 as AppRecord, K as BatchedDeployResult, a5 as BillingEnvironmentConfig, C as CalculateAppIDOptions, aq as CancelResponse, ao as CancelSuccessResponse, af as ChainID, ak as CheckoutCreatedResponse, ai as CreateSubscriptionOptions, aj as CreateSubscriptionResponse, D as DeployAppOptions, N as DeployAppOpts, a3 as DeployOptions, at as DeployProgressCallback, a4 as DeployResult, au as DeployStep, aa as DockerImageConfig, a6 as EnvironmentConfig, E as EstimateGasOptions, J as ExecuteDeployBatchedOptions, X as ExecuteDeployResult, H as ExecuteDeploySequentialOptions, Y as ExecuteUpgradeResult, G as GasEstimate, W as GasOpts, a9 as ImageDigestResult, I as IsDelegatedOptions, a1 as LifecycleOpts, ab as Logger, ap as NoActiveSubscriptionResponse, a8 as ParsedEnvironment, am as PaymentIssueResponse, P as PrepareDeployBatchOptions, T as PrepareDeployFromVerifiableBuildOpts, Q as PrepareDeployOpts, x as PrepareUpgradeBatchOptions, V as PrepareUpgradeFromVerifiableBuildOpts, R as PrepareUpgradeOpts, $ as PreparedDeploy, y as PreparedDeployBatch, Z as PreparedDeployData, a0 as PreparedUpgrade, z as PreparedUpgradeBatch, _ as PreparedUpgradeData, ae as ProductID, ar as ProductSubscriptionResponse, a7 as Release, S as SendTransactionOptions, av as SequentialDeployResult, an as SubscribeResponse, ah as SubscriptionLineItem, as as SubscriptionOpts, ag as SubscriptionStatus, B as SuspendOptions, F as UndelegateOptions, U as UpgradeAppOptions, O as UpgradeAppOpts, j as calculateAppID, i as deployApp, e as estimateTransactionGas, h as executeDeployBatch, l as executeDeployBatched, k as executeDeploySequential, o as executeUpgradeBatch, f as formatETH, c as getActiveAppCount, g as getAllAppsByDeveloper, a as getAppsByCreator, b as getAppsByDeveloper, d as getMaxActiveAppsPerUser, r as isDelegated, M as logVisibility, L as noopLogger, p as prepareDeployBatch, n as prepareUpgradeBatch, q as sendAndWaitForTransaction, m as supportsEIP5792, s as supportsEIP7702, t as suspend, v as undelegate, u as upgradeApp } from './index-DeQzn_yM.js';
+import { C as ComputeApiConfig, S as SessionInfo, a as SessionError, b as SiweMessageParams } from './helpers-CQuBwQnu.js';
+export { F as AppInfo, J as AppInfoResponse, I as AppMetrics, H as AppProfileInfo, K as BillingApiClient, z as CreateAppParams, P as EstimateBatchGasOptions, Q as ExecuteBatchOptions, R as Execution, G as GeneratedKey, L as LogVisibility, a3 as LoginRequest, a2 as LoginResult, A as LogsParams, Z as SiweMessageResult, U as UserApiClient, E as UserApiClientOptions, a5 as addHexPrefix, j as assertValidImageReference, n as assertValidPrivateKey, O as checkERC7702Delegation, T as createSiweMessage, M as estimateBatchGas, N as executeBatch, k as extractAppNameFromImage, D as generateNewPrivateKey, W as generateNonce, d as getAvailableEnvironments, c as getBillingEnvironmentConfig, e as getBuildType, a4 as getChainFromID, a0 as getComputeApiSession, g as getEnvironmentConfig, i as isEnvironmentAvailable, f as isMainnet, a1 as isSessionValid, X as isSiweMessageExpired, Y as isSiweMessageNotYetValid, B as isSubscriptionActive, _ as loginToComputeApi, $ as logoutFromComputeApi, V as parseSiweMessage, t as sanitizeString, u as sanitizeURL, w as sanitizeXURL, a6 as stripHexPrefix, r as validateAppID, v as validateAppName, x as validateCreateAppParams, q as validateDescription, h as validateImageReference, l as validateInstanceTypeSKU, s as validateLogVisibility, y as validateLogsParams, m as validatePrivateKeyFormat, o as validateURL, p as validateXURL } from './helpers-CQuBwQnu.js';
+import { WalletClient, Address, Hex } from 'viem';
+import { Buffer as Buffer$1 } from 'buffer';
+
+/**
+ * Build API Client to manage verifiable builds and provenance
+ *
+ * This is a standalone HTTP client that talks to the (compute) UserAPI host.
+ */
+
+declare class BuildApiClient {
+    private readonly baseUrl;
+    private readonly walletClient?;
+    private readonly clientId?;
+    constructor(options: {
+        baseUrl: string;
+        walletClient?: WalletClient;
+        clientId?: string;
+    });
+    /**
+     * Get the address of the connected wallet
+     */
+    get address(): Address;
+    submitBuild(payload: {
+        repo_url: string;
+        git_ref: string;
+        dockerfile_path: string;
+        caddyfile_path?: string;
+        build_context_path: string;
+        dependencies: string[];
+    }): Promise<{
+        build_id: string;
+    }>;
+    getBuild(buildId: string): Promise<any>;
+    getBuildByDigest(digest: string): Promise<any>;
+    verify(identifier: string): Promise<any>;
+    getLogs(buildId: string): Promise<string>;
+    listBuilds(params: {
+        billing_address: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<any[]>;
+    private publicJsonRequest;
+    private authenticatedJsonRequest;
+    private authenticatedTextRequest;
+}
+
+/**
+ * Browser-safe app action encoders
+ *
+ * These functions encode calldata for app lifecycle operations.
+ * They only depend on viem and are safe to use in browser environments.
+ */
+
+/**
+ * Encode start app call data for gas estimation or transaction
+ */
+declare function encodeStartAppData(appId: AppId): `0x${string}`;
+/**
+ * Encode stop app call data for gas estimation or transaction
+ */
+declare function encodeStopAppData(appId: AppId): `0x${string}`;
+/**
+ * Encode terminate app call data for gas estimation or transaction
+ */
+declare function encodeTerminateAppData(appId: AppId): `0x${string}`;
+
+/**
+ * React Hook for Compute API Session Management
+ *
+ * This hook provides a convenient way to manage compute API sessions in React applications.
+ * It handles session state, auto-refresh, and provides login/logout methods.
+ *
+ * IMPORTANT: This hook requires React 18+ as a peer dependency.
+ * Make sure your application has React installed.
+ */
+
+interface UseComputeSessionConfig extends ComputeApiConfig {
+    /**
+     * Interval in milliseconds to check session validity
+     * Set to 0 to disable auto-refresh
+     * @default 60000 (1 minute)
+     */
+    refreshInterval?: number;
+    /**
+     * Whether to automatically check session on mount
+     * @default true
+     */
+    checkOnMount?: boolean;
+    /**
+     * Callback when session expires or becomes invalid
+     */
+    onSessionExpired?: () => void;
+    /**
+     * Callback when session is successfully refreshed/validated
+     */
+    onSessionRefreshed?: (session: SessionInfo) => void;
+    /**
+     * Callback when an error occurs
+     */
+    onError?: (error: SessionError) => void;
+}
+interface UseComputeSessionReturn {
+    /** Current session information */
+    session: SessionInfo | null;
+    /** Whether the session is currently being loaded/checked */
+    isLoading: boolean;
+    /** Any error that occurred during session operations */
+    error: SessionError | null;
+    /** Whether the user is authenticated */
+    isAuthenticated: boolean;
+    /**
+     * Login to compute API with SIWE
+     *
+     * @param params - SIWE message parameters (address, chainId required)
+     * @param signMessage - Function to sign the message (from wagmi's useSignMessage)
+     * @returns Login result
+     */
+    login: (params: Omit<SiweMessageParams, "domain" | "uri"> & {
+        domain?: string;
+        uri?: string;
+    }, signMessage: (args: {
+        message: string;
+    }) => Promise<Hex>) => Promise<SessionInfo>;
+    /**
+     * Logout from compute API
+     */
+    logout: () => Promise<void>;
+    /**
+     * Manually refresh/check session status
+     */
+    refresh: () => Promise<SessionInfo>;
+    /**
+     * Clear any error state
+     */
+    clearError: () => void;
+}
+/**
+ * React hook for managing compute API sessions with SIWE authentication
+ *
+ * @param config - Configuration options including baseUrl and refresh settings
+ * @returns Session state and methods for login/logout/refresh
+ *
+ * @example
+ * ```tsx
+ * import { useComputeSession } from "@layr-labs/ecloud-sdk/browser";
+ * import { useSignMessage, useAccount } from "wagmi";
+ *
+ * function MyComponent() {
+ *   const { address, chainId } = useAccount();
+ *   const { signMessageAsync } = useSignMessage();
+ *
+ *   const {
+ *     session,
+ *     isLoading,
+ *     isAuthenticated,
+ *     login,
+ *     logout,
+ *     error,
+ *   } = useComputeSession({
+ *     baseUrl: "https://api.eigencloud.xyz",
+ *     onSessionExpired: () => console.log("Session expired!"),
+ *   });
+ *
+ *   const handleLogin = async () => {
+ *     if (!address || !chainId) return;
+ *     await login(
+ *       { address, chainId },
+ *       signMessageAsync
+ *     );
+ *   };
+ *
+ *   if (isLoading) return <div>Loading...</div>;
+ *
+ *   return (
+ *     <div>
+ *       {isAuthenticated ? (
+ *         <>
+ *           <p>Logged in as {session?.address}</p>
+ *           <button onClick={logout}>Logout</button>
+ *         </>
+ *       ) : (
+ *         <button onClick={handleLogin}>Login</button>
+ *       )}
+ *       {error && <p>Error: {error.message}</p>}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useComputeSession(config: UseComputeSessionConfig): UseComputeSessionReturn;
+
+/**
+ * KMS encryption utilities
+ * Implements RSA-OAEP-256 + AES-256-GCM encryption using JWE format
+ */
+
+/**
+ * Get app protected headers for encryption
+ */
+declare function getAppProtectedHeaders(appID: string): Record<string, string>;
+/**
+ * Encrypt data using RSA-OAEP-256 for key encryption and AES-256-GCM for data encryption
+ * Uses jose library which properly implements JWE with RSA-OAEP-256
+ */
+declare function encryptRSAOAEPAndAES256GCM(encryptionKeyPEM: string | Buffer$1, plaintext: Buffer$1, protectedHeaders?: Record<string, string> | null): Promise<string>;
+
+/**
+ * KMS key loading utilities
+ */
+type BuildType = "dev" | "prod";
+/**
+ * Get KMS keys for environment
+ */
+declare function getKMSKeysForEnvironment(environment: string, build?: BuildType): {
+    encryptionKey: Buffer;
+    signingKey: Buffer;
+};
+
+/**
+ * Browser-safe SDK entry point
+ *
+ * This module exports only code that can run in browser environments.
+ * It excludes Node.js-only dependencies like:
+ * - dockerode (Docker API)
+ * - @napi-rs/keyring (OS keychain)
+ * - fs operations (file system)
+ * - @inquirer/prompts (CLI prompts)
+ *
+ * Use this entry point in React/Next.js/browser applications:
+ * import { ... } from "@layr-labs/ecloud-sdk/browser"
+ */
+
+type Environment = "sepolia" | "sepolia-dev" | "mainnet-alpha";
+
+export { AppId, BuildApiClient, ComputeApiConfig, type Environment, SessionError, SessionInfo, SiweMessageParams, type UseComputeSessionConfig, type UseComputeSessionReturn, encodeStartAppData, encodeStopAppData, encodeTerminateAppData, encryptRSAOAEPAndAES256GCM, getAppProtectedHeaders, getKMSKeysForEnvironment, useComputeSession };