@layr-labs/ecloud-sdk 0.2.1-dev → 0.3.0-dev

package/dist/{index-D5oW73Dx.d.ts → index-C0w92tCs.d.ts}

@@ -1,4 +1,4 @@
-import { PublicClient, Address, Hex } from 'viem';
+import { PublicClient, Address, Hex, WalletClient } from 'viem';
 
 /**
  * Contract interactions
@@ -55,6 +55,245 @@ declare function formatETH(wei: bigint): string;
  * Use this to get cost estimate before prompting user for confirmation.
  */
 declare function estimateTransactionGas(options: EstimateGasOptions): Promise<GasEstimate>;
+/**
+ * Deploy app options
+ */
+interface DeployAppOptions {
+    walletClient: WalletClient;
+    publicClient: PublicClient;
+    environmentConfig: EnvironmentConfig;
+    salt: Uint8Array;
+    release: Release;
+    publicLogs: boolean;
+    imageRef: string;
+    gas?: GasEstimate;
+}
+/**
+ * Options for calculateAppID
+ */
+interface CalculateAppIDOptions {
+    publicClient: PublicClient;
+    environmentConfig: EnvironmentConfig;
+    ownerAddress: Address;
+    salt: Uint8Array;
+}
+/**
+ * Prepared deploy batch ready for gas estimation and execution
+ */
+interface PreparedDeployBatch {
+    /** The app ID that will be deployed */
+    appId: Address;
+    /** The salt used for deployment */
+    salt: Uint8Array;
+    /** Batch executions to be sent */
+    executions: Array<{
+        target: Address;
+        value: bigint;
+        callData: Hex;
+    }>;
+    /** Wallet client for sending transaction */
+    walletClient: WalletClient;
+    /** Public client for reading chain state */
+    publicClient: PublicClient;
+    /** Environment configuration */
+    environmentConfig: EnvironmentConfig;
+}
+/**
+ * Prepared upgrade batch ready for gas estimation and execution
+ */
+interface PreparedUpgradeBatch {
+    /** The app ID being upgraded */
+    appId: Address;
+    /** Batch executions to be sent */
+    executions: Array<{
+        target: Address;
+        value: bigint;
+        callData: Hex;
+    }>;
+    /** Wallet client for sending transaction */
+    walletClient: WalletClient;
+    /** Public client for reading chain state */
+    publicClient: PublicClient;
+    /** Environment configuration */
+    environmentConfig: EnvironmentConfig;
+}
+/**
+ * Calculate app ID from owner address and salt
+ */
+declare function calculateAppID(options: CalculateAppIDOptions): Promise<Address>;
+/**
+ * Options for preparing a deploy batch
+ */
+interface PrepareDeployBatchOptions {
+    walletClient: WalletClient;
+    publicClient: PublicClient;
+    environmentConfig: EnvironmentConfig;
+    salt: Uint8Array;
+    release: Release;
+    publicLogs: boolean;
+    imageRef: string;
+}
+/**
+ * Prepare deploy batch - creates executions without sending transaction
+ *
+ * Use this to get the prepared batch for gas estimation before executing.
+ */
+declare function prepareDeployBatch(options: PrepareDeployBatchOptions, logger?: Logger): Promise<PreparedDeployBatch>;
+/**
+ * Execute a prepared deploy batch
+ */
+declare function executeDeployBatch(data: PreparedDeployData, context: {
+    walletClient: WalletClient;
+    publicClient: PublicClient;
+    environmentConfig: EnvironmentConfig;
+}, gas?: GasEstimate, logger?: Logger): Promise<{
+    appId: Address;
+    txHash: Hex;
+}>;
+/**
+ * Deploy app on-chain (convenience wrapper that prepares and executes)
+ */
+declare function deployApp(options: DeployAppOptions, logger?: Logger): Promise<{
+    appId: Address;
+    txHash: Hex;
+}>;
+/**
+ * Check if wallet account supports EIP-7702 signing
+ *
+ * Local accounts (from privateKeyToAccount) support signAuthorization.
+ * JSON-RPC accounts (browser wallets like MetaMask) do not.
+ */
+declare function supportsEIP7702(walletClient: WalletClient): boolean;
+/**
+ * Options for sequential deployment (non-EIP-7702)
+ */
+interface ExecuteDeploySequentialOptions {
+    walletClient: WalletClient;
+    publicClient: PublicClient;
+    environmentConfig: EnvironmentConfig;
+    /** Prepared deployment data from prepareDeployBatch */
+    data: PreparedDeployData;
+    /** Whether to set public logs permission */
+    publicLogs: boolean;
+    /** Optional callback for progress updates */
+    onProgress?: DeployProgressCallback;
+}
+/**
+ * Execute deployment as sequential transactions (non-EIP-7702 fallback)
+ *
+ * Use this for browser wallets (JSON-RPC accounts) that don't support signAuthorization.
+ * This requires 2-3 wallet signatures instead of 1, but works with all wallet types.
+ *
+ * Steps:
+ * 1. createApp - Creates the app on-chain
+ * 2. acceptAdmin - Accepts admin role for the app
+ * 3. setAppointee (optional) - Sets public logs permission
+ */
+declare function executeDeploySequential(options: ExecuteDeploySequentialOptions, logger?: Logger): Promise<SequentialDeployResult>;
+/**
+ * Result from EIP-5792 batched deployment
+ */
+interface BatchedDeployResult {
+    appId: Address;
+    /** Batch ID from sendCalls (can be used with getCallsStatus) */
+    batchId: string;
+    /** Transaction receipts from the batch */
+    receipts: Array<{
+        transactionHash: Hex;
+    }>;
+}
+/**
+ * Options for EIP-5792 batched deployment
+ */
+interface ExecuteDeployBatchedOptions {
+    walletClient: WalletClient;
+    publicClient: PublicClient;
+    environmentConfig: EnvironmentConfig;
+    /** Prepared deployment data from prepareDeployBatch */
+    data: PreparedDeployData;
+    /** Whether to set public logs permission */
+    publicLogs: boolean;
+    /** Optional callback for progress updates */
+    onProgress?: DeployProgressCallback;
+}
+/**
+ * Check if wallet supports EIP-5792 (sendCalls/wallet_sendCalls)
+ *
+ * This checks the wallet's capabilities to see if it supports atomic batch calls.
+ * MetaMask and other modern wallets are adding support for this standard.
+ */
+declare function supportsEIP5792(walletClient: WalletClient): Promise<boolean>;
+/**
+ * Execute deployment using EIP-5792 sendCalls (batched wallet calls)
+ *
+ * This batches all deployment transactions (createApp, acceptAdmin, setPublicLogs)
+ * into a single wallet interaction. Better UX than sequential transactions.
+ *
+ * Use this for browser wallets that support EIP-5792 but not EIP-7702.
+ *
+ * @returns BatchedDeployResult with appId and batch receipts
+ */
+declare function executeDeployBatched(options: ExecuteDeployBatchedOptions, logger?: Logger): Promise<BatchedDeployResult>;
+/**
+ * Upgrade app options
+ */
+interface UpgradeAppOptions {
+    walletClient: WalletClient;
+    publicClient: PublicClient;
+    environmentConfig: EnvironmentConfig;
+    appID: Address;
+    release: Release;
+    publicLogs: boolean;
+    needsPermissionChange: boolean;
+    imageRef: string;
+    gas?: GasEstimate;
+}
+/**
+ * Options for preparing an upgrade batch
+ */
+interface PrepareUpgradeBatchOptions {
+    walletClient: WalletClient;
+    publicClient: PublicClient;
+    environmentConfig: EnvironmentConfig;
+    appID: Address;
+    release: Release;
+    publicLogs: boolean;
+    needsPermissionChange: boolean;
+    imageRef: string;
+}
+/**
+ * Prepare upgrade batch - creates executions without sending transaction
+ *
+ * Use this to get the prepared batch for gas estimation before executing.
+ */
+declare function prepareUpgradeBatch(options: PrepareUpgradeBatchOptions): Promise<PreparedUpgradeBatch>;
+/**
+ * Execute a prepared upgrade batch
+ */
+declare function executeUpgradeBatch(data: PreparedUpgradeData, context: {
+    walletClient: WalletClient;
+    publicClient: PublicClient;
+    environmentConfig: EnvironmentConfig;
+}, gas?: GasEstimate, logger?: Logger): Promise<Hex>;
+/**
+ * Upgrade app on-chain (convenience wrapper that prepares and executes)
+ */
+declare function upgradeApp(options: UpgradeAppOptions, logger?: Logger): Promise<Hex>;
+/**
+ * Send and wait for transaction with confirmation support
+ */
+interface SendTransactionOptions {
+    walletClient: WalletClient;
+    publicClient: PublicClient;
+    environmentConfig: EnvironmentConfig;
+    to: Address;
+    data: Hex;
+    value?: bigint;
+    pendingMessage: string;
+    txDescription: string;
+    gas?: GasEstimate;
+}
+declare function sendAndWaitForTransaction(options: SendTransactionOptions, logger?: Logger): Promise<Hex>;
 /**
  * Get active app count for a user
  */
@@ -96,6 +335,44 @@ declare function getAppLatestReleaseBlockNumbers(publicClient: PublicClient, env
  * Get block timestamps for multiple block numbers
  */
 declare function getBlockTimestamps(publicClient: PublicClient, blockNumbers: number[]): Promise<Map<number, number>>;
+/**
+ * Suspend options
+ */
+interface SuspendOptions {
+    walletClient: WalletClient;
+    publicClient: PublicClient;
+    environmentConfig: EnvironmentConfig;
+    account: Address;
+    apps: Address[];
+}
+/**
+ * Suspend apps for an account
+ */
+declare function suspend(options: SuspendOptions, logger?: Logger): Promise<Hex | false>;
+/**
+ * Options for checking delegation status
+ */
+interface IsDelegatedOptions {
+    publicClient: PublicClient;
+    environmentConfig: EnvironmentConfig;
+    address: Address;
+}
+/**
+ * Check if account is delegated to the ERC-7702 delegator
+ */
+declare function isDelegated(options: IsDelegatedOptions): Promise<boolean>;
+/**
+ * Undelegate options
+ */
+interface UndelegateOptions {
+    walletClient: WalletClient;
+    publicClient: PublicClient;
+    environmentConfig: EnvironmentConfig;
+}
+/**
+ * Undelegate account (removes EIP-7702 delegation)
+ */
+declare function undelegate(options: UndelegateOptions, logger?: Logger): Promise<Hex>;
 
 /**
  * Core types for ECloud SDK
@@ -342,6 +619,10 @@ interface Logger {
     warn(message: string, ...args: any[]): void;
     error(message: string, ...args: any[]): void;
 }
+/**
+ * No-op logger for browser usage when logging is not needed
+ */
+declare const noopLogger: Logger;
 /**
  * Profile information for an app
  */
@@ -379,6 +660,12 @@ interface SubscriptionLineItem {
     currency: string;
     subtotal: number;
 }
+interface CreateSubscriptionOptions {
+    /** URL to redirect to after successful checkout */
+    successUrl?: string;
+    /** URL to redirect to if checkout is canceled */
+    cancelUrl?: string;
+}
 interface CreateSubscriptionResponse {
     checkoutUrl: string;
 }
@@ -421,6 +708,10 @@ interface ProductSubscriptionResponse {
 }
 interface SubscriptionOpts {
     productId?: ProductID;
+    /** URL to redirect to after successful checkout */
+    successUrl?: string;
+    /** URL to redirect to if checkout is canceled */
+    cancelUrl?: string;
 }
 interface BillingEnvironmentConfig {
     billingApiServerURL: string;
@@ -428,5 +719,25 @@ interface BillingEnvironmentConfig {
 interface BillingEnvironmentConfig {
     billingApiServerURL: string;
 }
+/**
+ * Progress callback for sequential deployment
+ * Called after each step completes
+ */
+type DeployProgressCallback = (step: DeployStep, txHash?: Hex) => void;
+/**
+ * Steps in sequential deployment flow
+ */
+type DeployStep = "createApp" | "acceptAdmin" | "setPublicLogs" | "complete";
+/**
+ * Result from sequential deployment
+ */
+interface SequentialDeployResult {
+    appId: AppId;
+    txHashes: {
+        createApp: Hex;
+        acceptAdmin: Hex;
+        setPublicLogs?: Hex;
+    };
+}
 
-export { getBlockTimestamps as $, type AppId as A, type BillingEnvironmentConfig as B, type AppProfile as C, type DeployAppOpts as D, type EstimateGasOptions as E, type AppProfileResponse as F, type GasEstimate as G, type ProductID as H, type ImageDigestResult as I, type ChainID as J, type SubscriptionLineItem as K, type LifecycleOpts as L, type CreateSubscriptionResponse as M, type CheckoutCreatedResponse as N, type AlreadyActiveResponse as O, type PrepareDeployOpts as P, type PaymentIssueResponse as Q, type Release as R, type SubscriptionStatus as S, type SubscribeResponse as T, type UpgradeAppOpts as U, type CancelSuccessResponse as V, type NoActiveSubscriptionResponse as W, type CancelResponse as X, type ProductSubscriptionResponse as Y, type SubscriptionOpts as Z, getAppLatestReleaseBlockNumbers as _, getAppsByCreator as a, getAppsByDeveloper as b, getActiveAppCount as c, getMaxActiveAppsPerUser as d, estimateTransactionGas as e, formatETH as f, getAllAppsByDeveloper as g, type AppConfig as h, type PrepareUpgradeOpts as i, type PrepareDeployFromVerifiableBuildOpts as j, type PrepareUpgradeFromVerifiableBuildOpts as k, type logVisibility as l, type GasOpts as m, type ExecuteDeployResult as n, type ExecuteUpgradeResult as o, type PreparedDeployData as p, type PreparedUpgradeData as q, type PreparedDeploy as r, type PreparedUpgrade as s, type AppRecord as t, type DeployOptions as u, type DeployResult as v, type EnvironmentConfig as w, type ParsedEnvironment as x, type DockerImageConfig as y, type Logger as z };
+export { type PreparedDeploy as $, type AppId as A, type SuspendOptions as B, type CalculateAppIDOptions as C, type DeployAppOptions as D, type EstimateGasOptions as E, type UndelegateOptions as F, type GasEstimate as G, type ExecuteDeploySequentialOptions as H, type IsDelegatedOptions as I, type ExecuteDeployBatchedOptions as J, type BatchedDeployResult as K, noopLogger as L, type logVisibility as M, type DeployAppOpts as N, type UpgradeAppOpts as O, type PrepareDeployBatchOptions as P, type PrepareDeployOpts as Q, type PrepareUpgradeOpts as R, type SendTransactionOptions as S, type PrepareDeployFromVerifiableBuildOpts as T, type UpgradeAppOptions as U, type PrepareUpgradeFromVerifiableBuildOpts as V, type GasOpts as W, type ExecuteDeployResult as X, type ExecuteUpgradeResult as Y, type PreparedDeployData as Z, type PreparedUpgradeData as _, getAppsByCreator as a, type PreparedUpgrade as a0, type LifecycleOpts as a1, type AppRecord as a2, type DeployOptions as a3, type DeployResult as a4, type BillingEnvironmentConfig as a5, type EnvironmentConfig as a6, type Release as a7, type ParsedEnvironment as a8, type ImageDigestResult as a9, type DockerImageConfig as aa, type Logger as ab, type AppProfile as ac, type AppProfileResponse as ad, type ProductID as ae, type ChainID as af, type SubscriptionStatus as ag, type SubscriptionLineItem as ah, type CreateSubscriptionOptions as ai, type CreateSubscriptionResponse as aj, type CheckoutCreatedResponse as ak, type AlreadyActiveResponse as al, type PaymentIssueResponse as am, type SubscribeResponse as an, type CancelSuccessResponse as ao, type NoActiveSubscriptionResponse as ap, type CancelResponse as aq, type ProductSubscriptionResponse as ar, type SubscriptionOpts as as, type DeployProgressCallback as at, type DeployStep as au, type SequentialDeployResult as av, getAppLatestReleaseBlockNumbers as aw, getBlockTimestamps as ax, getAppsByDeveloper as b, getActiveAppCount as c, getMaxActiveAppsPerUser as d, estimateTransactionGas as e, formatETH as f, getAllAppsByDeveloper as g, executeDeployBatch as h, deployApp as i, calculateAppID as j, executeDeploySequential as k, executeDeployBatched as l, supportsEIP5792 as m, prepareUpgradeBatch as n, executeUpgradeBatch as o, prepareDeployBatch as p, sendAndWaitForTransaction as q, isDelegated as r, supportsEIP7702 as s, suspend as t, upgradeApp as u, undelegate as v, type AppConfig as w, type PrepareUpgradeBatchOptions as x, type PreparedDeployBatch as y, type PreparedUpgradeBatch as z };