@layr-labs/ecloud-sdk 1.0.0-devep8 → 1.0.0

package/dist/compute-BJ_sqrKn.d.ts

@@ -0,0 +1,465 @@
+import { WalletClient, PublicClient, Address, Hex } from 'viem';
+import { a4 as PreparedDeploy, L as GasEstimate, F as EnvironmentConfig, U as Logger, w as DeployResult, a7 as PreparedUpgrade, A as AppId, t as DeployAppOpts, an as UpgradeAppOpts, a0 as PrepareDeployOpts, $ as PrepareDeployFromVerifiableBuildOpts, I as ExecuteDeployResult, a3 as PrepareUpgradeOpts, a2 as PrepareUpgradeFromVerifiableBuildOpts, K as ExecuteUpgradeResult, g as AppProfile, h as AppProfileResponse, R as LifecycleOpts, e as AppConfig } from './index-BVnxNfqb.js';
+import { L as LogVisibility, R as ResourceUsageMonitoring } from './validation-D3yIUF-Z.js';
+
+/**
+ * Main deploy function
+ *
+ * This is the main entry point for deploying applications to ecloud TEE.
+ * It orchestrates all the steps: build, push, encrypt, and deploy on-chain.
+ *
+ * NOTE: This SDK function is non-interactive. All required parameters must be
+ * provided explicitly. Use the CLI for interactive parameter collection.
+ */
+
+/**
+ * Required deploy options for SDK (non-interactive)
+ *
+ * Accepts viem's WalletClient and PublicClient for transaction signing.
+ * The caller is responsible for creating these clients (e.g., from a private key).
+ */
+interface SDKDeployOptions {
+    /** Wallet client for signing transactions */
+    walletClient: WalletClient;
+    /** Public client for reading blockchain state */
+    publicClient: PublicClient;
+    /** Environment name (e.g., 'sepolia', 'mainnet-alpha') - defaults to 'sepolia' */
+    environment?: string;
+    /** Path to Dockerfile (if building from Dockerfile) - either this or imageRef is required */
+    dockerfilePath?: string;
+    /** Image reference (registry/path:tag) - either this or dockerfilePath is required */
+    imageRef?: string;
+    /** Path to .env file - optional */
+    envFilePath?: string;
+    /** App name - required */
+    appName: string;
+    /** Instance type SKU - required */
+    instanceType: string;
+    /** Log visibility setting - required */
+    logVisibility: LogVisibility;
+    /** Resource usage monitoring setting - optional, defaults to 'enable' */
+    resourceUsageMonitoring?: ResourceUsageMonitoring;
+    /** Billing mode: developer (default) or app (isolated billing) */
+    billTo?: "developer" | "app";
+    /** Skip quota check */
+    skipQuotaCheck?: boolean;
+    /** Optional salt for deterministic app address prediction (32 bytes) */
+    salt?: Uint8Array | Buffer;
+    /** Optional gas params from estimation (use result from prepareDeploy) */
+    gas?: GasEstimate;
+    /** Skip telemetry (used when called from CLI) - optional */
+    skipTelemetry?: boolean;
+}
+/**
+ * Result from prepareDeploy - includes prepared batch and gas estimate
+ */
+interface PrepareDeployResult {
+    /** Prepared deployment state */
+    prepared: PreparedDeploy;
+    /** Gas estimate for the batch transaction */
+    gasEstimate: GasEstimate;
+}
+/** Options for executing a prepared deployment */
+interface ExecuteDeployOptions {
+    prepared: PreparedDeploy;
+    context: {
+        walletClient: WalletClient;
+        publicClient: PublicClient;
+        environmentConfig: EnvironmentConfig;
+    };
+    gas?: GasEstimate;
+    logger?: Logger;
+    skipTelemetry?: boolean;
+}
+/**
+ * Options for verifiable build deployment
+ *
+ * Similar to SDKDeployOptions but uses a pre-built image with known digest
+ * instead of building from Dockerfile.
+ */
+interface VerifiableBuildOptions {
+    /** Wallet client for signing transactions */
+    walletClient: WalletClient;
+    /** Public client for reading blockchain state */
+    publicClient: PublicClient;
+    /** Environment name (e.g., 'sepolia', 'mainnet-alpha') - defaults to 'sepolia' */
+    environment?: string;
+    /** Image reference (registry/path:tag) - required */
+    imageRef: string;
+    /** Image digest (sha256:...) - required */
+    imageDigest: string;
+    /** Path to .env file - optional */
+    envFilePath?: string;
+    /** App name - required */
+    appName: string;
+    /** Instance type SKU - required */
+    instanceType: string;
+    /** Log visibility setting - required */
+    logVisibility: LogVisibility;
+    /** Resource usage monitoring setting - optional, defaults to 'enable' */
+    resourceUsageMonitoring?: ResourceUsageMonitoring;
+    /** Billing mode: developer (default) or app (isolated billing) */
+    billTo?: "developer" | "app";
+    /** Skip quota check */
+    skipQuotaCheck?: boolean;
+    /** Skip telemetry (used when called from CLI) - optional */
+    skipTelemetry?: boolean;
+}
+/**
+ * Prepare a deployment from a pre-built image (already layered) without using Docker locally.
+ *
+ * This is intended for verifiable builds where the build service outputs:
+ * - imageRef (tagged image URL)
+ * - imageDigest (sha256:... digest)
+ *
+ * Flow is the same as prepareDeploy, except:
+ * - Skips ensureDockerIsRunning()
+ * - Skips prepareRelease() image layering and digest extraction
+ * - Uses provided imageDigest + derived registry name to construct the Release struct
+ */
+declare function prepareDeployFromVerifiableBuild(options: VerifiableBuildOptions, logger?: Logger): Promise<PrepareDeployResult>;
+/**
+ * Prepare deployment - does all work up to the transaction
+ *
+ * This allows CLI to:
+ * 1. Call prepareDeploy to build image, prepare release, get gas estimate
+ * 2. Prompt user to confirm the cost
+ * 3. Call executeDeploy with confirmed gas params
+ */
+declare function prepareDeploy(options: Omit<SDKDeployOptions, "gas"> & {
+    skipTelemetry?: boolean;
+}, logger?: Logger): Promise<PrepareDeployResult>;
+/**
+ * Execute a prepared deployment
+ *
+ * Call this after prepareDeploy and user confirmation.
+ * Note: This only submits the on-chain transaction. Call watchDeployment separately
+ * to wait for the app to be running.
+ */
+declare function executeDeploy(options: ExecuteDeployOptions): Promise<DeployResult>;
+/**
+ * Watch a deployment until the app is running
+ *
+ * Call this after executeDeploy to wait for the app to be provisioned.
+ * Can be called separately to allow for intermediate operations (e.g., profile upload).
+ */
+interface WatchDeploymentOptions {
+    timeoutSeconds?: number;
+}
+declare function watchDeployment(appId: string, walletClient: WalletClient, publicClient: PublicClient, environmentConfig: EnvironmentConfig, logger?: Logger, skipTelemetry?: boolean, opts?: WatchDeploymentOptions): Promise<string | undefined>;
+
+/**
+ * Main upgrade function
+ *
+ * This is the main entry point for upgrading existing applications on ecloud TEE.
+ * It orchestrates all the steps: build, push, encrypt, and upgrade on-chain.
+ *
+ * NOTE: This SDK function is non-interactive. All required parameters must be
+ * provided explicitly. Use the CLI for interactive parameter collection.
+ */
+
+/**
+ * Required upgrade options for SDK (non-interactive)
+ */
+interface SDKUpgradeOptions {
+    /** App ID to upgrade - required */
+    appId: string | Address;
+    /** Wallet client for signing transactions */
+    walletClient: WalletClient;
+    /** Public client for reading blockchain state */
+    publicClient: PublicClient;
+    /** Environment name (e.g., 'sepolia', 'mainnet-alpha') - defaults to 'sepolia' */
+    environment?: string;
+    /** Path to Dockerfile (if building from Dockerfile) - either this or imageRef is required */
+    dockerfilePath?: string;
+    /** Image reference (registry/path:tag) - either this or dockerfilePath is required */
+    imageRef?: string;
+    /** Path to .env file - optional */
+    envFilePath?: string;
+    /** Instance type SKU - required */
+    instanceType: string;
+    /** Log visibility setting - required */
+    logVisibility: LogVisibility;
+    /** Resource usage monitoring setting - optional, defaults to 'enable' */
+    resourceUsageMonitoring?: ResourceUsageMonitoring;
+    /** Optional gas params from estimation (use result from prepareUpgrade) */
+    gas?: GasEstimate;
+    /** Skip telemetry (used when called from CLI) - optional */
+    skipTelemetry?: boolean;
+}
+interface UpgradeResult {
+    /** App ID (contract address) */
+    appId: AppId;
+    /** Final image reference */
+    imageRef: string;
+    /** Transaction hash */
+    txHash: Hex;
+}
+/**
+ * Result from prepareUpgrade - includes prepared batch and gas estimate
+ */
+interface PrepareUpgradeResult {
+    /** Prepared upgrade state */
+    prepared: PreparedUpgrade;
+    /** Gas estimate for the batch transaction */
+    gasEstimate: GasEstimate;
+}
+/** Options for executing a prepared upgrade */
+interface ExecuteUpgradeOptions {
+    prepared: PreparedUpgrade;
+    context: {
+        walletClient: WalletClient;
+        publicClient: PublicClient;
+        environmentConfig: EnvironmentConfig;
+    };
+    gas?: GasEstimate;
+    logger?: Logger;
+    skipTelemetry?: boolean;
+}
+/**
+ * Prepare an upgrade from a pre-built image (already layered) without using Docker locally.
+ *
+ * Intended for verifiable builds: build service provides imageRef + imageDigest (sha256:...).
+ * This skips:
+ * - ensureDockerIsRunning()
+ * - prepareRelease() layering/digest extraction
+ */
+declare function prepareUpgradeFromVerifiableBuild(options: Omit<SDKUpgradeOptions, "gas" | "dockerfilePath" | "imageRef"> & {
+    imageRef: string;
+    imageDigest: string;
+    skipTelemetry?: boolean;
+}, logger?: Logger): Promise<PrepareUpgradeResult>;
+/**
+ * Prepare upgrade - does all work up to the transaction
+ *
+ * This allows CLI to:
+ * 1. Call prepareUpgrade to build image, prepare release, get gas estimate
+ * 2. Prompt user to confirm the cost
+ * 3. Call executeUpgrade with confirmed gas params
+ */
+declare function prepareUpgrade(options: Omit<SDKUpgradeOptions, "gas"> & {
+    skipTelemetry?: boolean;
+}, logger?: Logger): Promise<PrepareUpgradeResult>;
+/**
+ * Execute a prepared upgrade
+ *
+ * Call this after prepareUpgrade and user confirmation.
+ * Note: This only submits the on-chain transaction. Call watchUpgrade separately
+ * to wait for the upgrade to complete.
+ */
+declare function executeUpgrade(options: ExecuteUpgradeOptions): Promise<UpgradeResult>;
+/**
+ * Watch an upgrade until it completes
+ *
+ * Call this after executeUpgrade to wait for the upgrade to finish.
+ * Can be called separately to allow for intermediate operations.
+ */
+interface WatchUpgradeOptions {
+    timeoutSeconds?: number;
+}
+declare function watchUpgrade(appId: string, walletClient: WalletClient, publicClient: PublicClient, environmentConfig: EnvironmentConfig, logger?: Logger, skipTelemetry?: boolean, opts?: WatchUpgradeOptions): Promise<void>;
+
+/**
+ * Create command
+ *
+ * Creates a new app project from a template
+ *
+ * NOTE: This SDK function is non-interactive. All required parameters must be
+ * provided explicitly. Use the CLI for interactive parameter collection.
+ */
+
+/**
+ * Required create app options for SDK (non-interactive)
+ */
+interface SDKCreateAppOpts {
+    /** Project name - required */
+    name: string;
+    /** Programming language - required (typescript, golang, rust, python) */
+    language: string;
+    /** Template name/category (e.g., "minimal") or custom template URL - optional, defaults to first available */
+    template?: string;
+    /** Template version/ref - optional */
+    templateVersion?: string;
+    /** Verbose output - optional */
+    verbose?: boolean;
+    /** Skip telemetry (used when called from CLI) - optional */
+    skipTelemetry?: boolean;
+}
+/**
+ * Legacy interface for backward compatibility
+ * @deprecated Use SDKCreateAppOpts instead
+ */
+interface CreateAppOpts {
+    name?: string;
+    language?: string;
+    template?: string;
+    templateVersion?: string;
+    verbose?: boolean;
+    skipTelemetry?: boolean;
+}
+declare const PRIMARY_LANGUAGES: string[];
+/**
+ * Get available template categories for a language
+ */
+declare function getAvailableTemplates(language: string): Promise<Array<{
+    name: string;
+    description: string;
+}>>;
+/**
+ * Create a new app project from template
+ *
+ * This function is non-interactive and requires all parameters to be provided explicitly.
+ *
+ * @param options - Required options including name and language
+ * @param logger - Optional logger instance
+ * @throws Error if required parameters are missing or invalid
+ */
+declare function createApp(options: SDKCreateAppOpts | CreateAppOpts, logger?: Logger): Promise<void>;
+
+/**
+ * Logs command
+ *
+ * View app logs with optional watch mode
+ *
+ * NOTE: This SDK function is non-interactive. All required parameters must be
+ * provided explicitly. Use the CLI for interactive parameter collection.
+ */
+
+/**
+ * Required logs options for SDK (non-interactive)
+ */
+interface LogsOptions {
+    /** App ID (address) or app name - required */
+    appID: string | Address;
+    /** Watch logs continuously - optional */
+    watch?: boolean;
+    /** Client ID for API requests - optional */
+    clientId?: string;
+}
+/**
+ * View app logs
+ *
+ * This function is non-interactive and requires appID to be provided explicitly.
+ *
+ * @param options - Required options including appID
+ * @param walletClient - Viem WalletClient for signing requests
+ * @param publicClient - Viem PublicClient for chain queries
+ * @param environmentConfig - Environment configuration
+ * @param logger - Optional logger instance
+ * @param skipTelemetry - Skip telemetry (for CLI usage)
+ * @throws Error if appID is missing or invalid
+ */
+declare function logs(options: LogsOptions, walletClient: WalletClient, publicClient: PublicClient, environmentConfig: EnvironmentConfig, logger?: Logger, skipTelemetry?: boolean): Promise<void>;
+
+/**
+ * Main App namespace entry point
+ */
+
+/**
+ * Encode start app call data for gas estimation
+ */
+declare function encodeStartAppData(appId: AppId): Hex;
+/**
+ * Encode stop app call data for gas estimation
+ */
+declare function encodeStopAppData(appId: AppId): Hex;
+/**
+ * Encode terminate app call data for gas estimation
+ */
+declare function encodeTerminateAppData(appId: AppId): Hex;
+interface AppModule {
+    create: (opts: CreateAppOpts) => Promise<void>;
+    deploy: (opts: DeployAppOpts) => Promise<{
+        appId: AppId;
+        tx: Hex;
+        appName: string;
+        imageRef: string;
+        ipAddress?: string;
+    }>;
+    upgrade: (appId: AppId, opts: UpgradeAppOpts) => Promise<{
+        tx: Hex;
+        appId: AppId;
+        imageRef: string;
+    }>;
+    prepareDeploy: (opts: PrepareDeployOpts) => Promise<{
+        prepared: PreparedDeploy;
+        gasEstimate: GasEstimate;
+    }>;
+    prepareDeployFromVerifiableBuild: (opts: PrepareDeployFromVerifiableBuildOpts) => Promise<{
+        prepared: PreparedDeploy;
+        gasEstimate: GasEstimate;
+    }>;
+    executeDeploy: (prepared: PreparedDeploy, gas?: GasEstimate) => Promise<ExecuteDeployResult>;
+    watchDeployment: (appId: AppId, opts?: WatchDeploymentOptions) => Promise<string | undefined>;
+    prepareUpgrade: (appId: AppId, opts: PrepareUpgradeOpts) => Promise<{
+        prepared: PreparedUpgrade;
+        gasEstimate: GasEstimate;
+    }>;
+    prepareUpgradeFromVerifiableBuild: (appId: AppId, opts: PrepareUpgradeFromVerifiableBuildOpts) => Promise<{
+        prepared: PreparedUpgrade;
+        gasEstimate: GasEstimate;
+    }>;
+    executeUpgrade: (prepared: PreparedUpgrade, gas?: GasEstimate) => Promise<ExecuteUpgradeResult>;
+    watchUpgrade: (appId: AppId, opts?: WatchUpgradeOptions) => Promise<void>;
+    setProfile: (appId: AppId, profile: AppProfile) => Promise<AppProfileResponse>;
+    logs: (opts: LogsOptions) => Promise<void>;
+    start: (appId: AppId, opts?: LifecycleOpts) => Promise<{
+        tx: Hex | false;
+    }>;
+    stop: (appId: AppId, opts?: LifecycleOpts) => Promise<{
+        tx: Hex | false;
+    }>;
+    terminate: (appId: AppId, opts?: LifecycleOpts) => Promise<{
+        tx: Hex | false;
+    }>;
+    getBillingType: (appId: AppId) => Promise<number>;
+    getAppsByBillingAccount: (account: Address, offset: bigint, limit: bigint) => Promise<{
+        apps: Address[];
+        appConfigs: AppConfig[];
+    }>;
+    isDelegated: () => Promise<boolean>;
+    undelegate: () => Promise<{
+        tx: Hex | false;
+    }>;
+}
+interface AppModuleConfig {
+    verbose?: boolean;
+    walletClient: WalletClient;
+    publicClient: PublicClient;
+    environment: string;
+    clientId?: string;
+    skipTelemetry?: boolean;
+    /**
+     * Optional logger override. Defaults to a stdout/stderr logger that respects
+     * `verbose`. Callers producing machine-readable output pass a logger that
+     * keeps progress off stdout.
+     */
+    logger?: Logger;
+}
+declare function createAppModule(ctx: AppModuleConfig): AppModule;
+
+/**
+ * Main Compute namespace entry point
+ */
+
+interface ComputeModule {
+    app: AppModule;
+}
+interface ComputeModuleConfig {
+    verbose?: boolean;
+    walletClient: WalletClient;
+    publicClient: PublicClient;
+    environment: string;
+    clientId?: string;
+    skipTelemetry?: boolean;
+    /**
+     * Optional logger override. When provided, the module routes all progress
+     * output through it instead of the default stdout/stderr logger. Callers
+     * emitting machine-readable output (e.g. `--json`) pass a logger that writes
+     * to stderr so stdout stays pure.
+     */
+    logger?: Logger;
+}
+declare function createComputeModule(config: ComputeModuleConfig): ComputeModule;
+
+export { type AppModule as A, type ComputeModule as C, type LogsOptions as L, PRIMARY_LANGUAGES as P, type SDKCreateAppOpts as S, type WatchDeploymentOptions as W, type ComputeModuleConfig as a, type CreateAppOpts as b, type PrepareDeployResult as c, type PrepareUpgradeResult as d, type SDKDeployOptions as e, type SDKUpgradeOptions as f, type WatchUpgradeOptions as g, createApp as h, createComputeModule as i, encodeStartAppData as j, encodeStopAppData as k, encodeTerminateAppData as l, executeDeploy as m, executeUpgrade as n, getAvailableTemplates as o, logs as p, prepareDeploy as q, prepareDeployFromVerifiableBuild as r, prepareUpgrade as s, prepareUpgradeFromVerifiableBuild as t, watchUpgrade as u, type AppModuleConfig as v, watchDeployment as w, createAppModule as x };