@layr-labs/ecloud-sdk 0.0.1-dev.1 → 0.0.1-dev.3

package/dist/index.d.cts

@@ -292,6 +292,8 @@ interface SDKLogsOptions {
     privateKey?: string;
     /** RPC URL - optional, uses environment default */
     rpcUrl?: string;
+    /** Client ID for API requests - optional */
+    clientId?: string;
 }
 /**
  * Legacy interface for backward compatibility
@@ -303,6 +305,7 @@ interface LogsOptions {
     environment?: string;
     privateKey?: string;
     rpcUrl?: string;
+    clientId?: string;
 }
 /**
  * View app logs
@@ -364,6 +367,7 @@ interface AppModuleConfig {
     privateKey: `0x${string}`;
     rpcUrl: string;
     environment: string;
+    clientId?: string;
 }
 declare function createAppModule(ctx: AppModuleConfig): AppModule;
 
@@ -743,7 +747,7 @@ declare function executeDeploy(prepared: PreparedDeploy, gas: {
  * 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).
  */
-declare function watchDeployment(appId: string, privateKey: string, rpcUrl: string, environment: string, logger?: Logger): Promise<string | undefined>;
+declare function watchDeployment(appId: string, privateKey: string, rpcUrl: string, environment: string, logger?: Logger, clientId?: string): Promise<string | undefined>;
 
 /**
  * Main upgrade function
@@ -845,7 +849,7 @@ declare function executeUpgrade(prepared: PreparedUpgrade, gas: {
  * Call this after executeUpgrade to wait for the upgrade to finish.
  * Can be called separately to allow for intermediate operations.
  */
-declare function watchUpgrade(appId: string, privateKey: string, rpcUrl: string, environment: string, logger?: Logger): Promise<void>;
+declare function watchUpgrade(appId: string, privateKey: string, rpcUrl: string, environment: string, logger?: Logger, clientId?: string): Promise<void>;
 
 /**
  * Environment configuration for different networks
@@ -1082,7 +1086,7 @@ interface PreflightContext {
  * Returns empty string if unable to fetch (API unavailable, app info not ready, etc.).
  * This is used as a convenience default for the upgrade flow.
  */
-declare function getCurrentInstanceType(preflightCtx: PreflightContext, appID: Address, logger: Logger): Promise<string>;
+declare function getCurrentInstanceType(preflightCtx: PreflightContext, appID: Address, logger: Logger, clientId?: string): Promise<string>;
 
 /**
  * UserAPI Client to manage interactions with the coordinator
@@ -1119,7 +1123,8 @@ declare class UserApiClient {
     private readonly config;
     private readonly account?;
     private readonly rpcUrl?;
-    constructor(config: EnvironmentConfig, privateKey?: string | Hex, rpcUrl?: string);
+    private readonly clientId;
+    constructor(config: EnvironmentConfig, privateKey?: string | Hex, rpcUrl?: string, clientId?: string);
     getInfos(appIDs: Address[], addressCount?: number): Promise<AppInfo[]>;
     /**
      * Get available SKUs (instance types) from UserAPI

package/dist/index.d.ts

@@ -292,6 +292,8 @@ interface SDKLogsOptions {
     privateKey?: string;
     /** RPC URL - optional, uses environment default */
     rpcUrl?: string;
+    /** Client ID for API requests - optional */
+    clientId?: string;
 }
 /**
  * Legacy interface for backward compatibility
@@ -303,6 +305,7 @@ interface LogsOptions {
     environment?: string;
     privateKey?: string;
     rpcUrl?: string;
+    clientId?: string;
 }
 /**
  * View app logs
@@ -364,6 +367,7 @@ interface AppModuleConfig {
     privateKey: `0x${string}`;
     rpcUrl: string;
     environment: string;
+    clientId?: string;
 }
 declare function createAppModule(ctx: AppModuleConfig): AppModule;
 
@@ -743,7 +747,7 @@ declare function executeDeploy(prepared: PreparedDeploy, gas: {
  * 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).
  */
-declare function watchDeployment(appId: string, privateKey: string, rpcUrl: string, environment: string, logger?: Logger): Promise<string | undefined>;
+declare function watchDeployment(appId: string, privateKey: string, rpcUrl: string, environment: string, logger?: Logger, clientId?: string): Promise<string | undefined>;
 
 /**
  * Main upgrade function
@@ -845,7 +849,7 @@ declare function executeUpgrade(prepared: PreparedUpgrade, gas: {
  * Call this after executeUpgrade to wait for the upgrade to finish.
  * Can be called separately to allow for intermediate operations.
  */
-declare function watchUpgrade(appId: string, privateKey: string, rpcUrl: string, environment: string, logger?: Logger): Promise<void>;
+declare function watchUpgrade(appId: string, privateKey: string, rpcUrl: string, environment: string, logger?: Logger, clientId?: string): Promise<void>;
 
 /**
  * Environment configuration for different networks
@@ -1082,7 +1086,7 @@ interface PreflightContext {
  * Returns empty string if unable to fetch (API unavailable, app info not ready, etc.).
  * This is used as a convenience default for the upgrade flow.
  */
-declare function getCurrentInstanceType(preflightCtx: PreflightContext, appID: Address, logger: Logger): Promise<string>;
+declare function getCurrentInstanceType(preflightCtx: PreflightContext, appID: Address, logger: Logger, clientId?: string): Promise<string>;
 
 /**
  * UserAPI Client to manage interactions with the coordinator
@@ -1119,7 +1123,8 @@ declare class UserApiClient {
     private readonly config;
     private readonly account?;
     private readonly rpcUrl?;
-    constructor(config: EnvironmentConfig, privateKey?: string | Hex, rpcUrl?: string);
+    private readonly clientId;
+    constructor(config: EnvironmentConfig, privateKey?: string | Hex, rpcUrl?: string, clientId?: string);
     getInfos(appIDs: Address[], addressCount?: number): Promise<AppInfo[]>;
     /**
      * Get available SKUs (instance types) from UserAPI

package/dist/index.js

@@ -805,13 +805,15 @@ async function setupLayeredBuildDirectory(environmentConfig, layeredDockerfileCo
 // src/client/common/registry/digest.ts
 import * as child_process3 from "child_process";
 import { promisify as promisify3 } from "util";
-var exec5 = promisify3(child_process3.exec);
+var execFileAsync = promisify3(child_process3.execFile);
 async function getImageDigestAndName(imageRef) {
   try {
-    const { stdout } = await exec5(`docker manifest inspect ${imageRef}`, {
-      maxBuffer: 10 * 1024 * 1024
+    const { stdout } = await execFileAsync(
+      "docker",
+      ["manifest", "inspect", imageRef],
+      { maxBuffer: 10 * 1024 * 1024 }
       // 10MB buffer
-    });
+    );
     const manifest = JSON.parse(stdout);
     if (manifest.manifests && manifest.manifests.length > 0) {
       return extractDigestFromMultiPlatform(manifest, imageRef);
@@ -846,7 +848,7 @@ function extractDigestFromMultiPlatform(manifest, imageRef) {
 }
 async function extractDigestFromSinglePlatform(manifest, imageRef) {
   try {
-    const { stdout } = await exec5(`docker inspect ${imageRef}`, {
+    const { stdout } = await execFile("docker", ["inspect", imageRef], {
       maxBuffer: 10 * 1024 * 1024
     });
     const inspectData = JSON.parse(stdout);
@@ -2417,14 +2419,19 @@ var MAX_ADDRESS_COUNT = 5;
 var CanViewAppLogsPermission = "0x2fd3f2fe";
 var CanViewSensitiveAppInfoPermission = "0x0e67b22f";
 var CanUpdateAppProfilePermission = "0x036fef61";
+function getDefaultClientId() {
+  const version = true ? "0.0.1-dev.3" : "0.0.0";
+  return `ecloud-sdk/v${version}`;
+}
 var UserApiClient = class {
-  constructor(config, privateKey, rpcUrl) {
+  constructor(config, privateKey, rpcUrl, clientId) {
     this.config = config;
     if (privateKey) {
       const privateKeyHex = addHexPrefix(privateKey);
       this.account = privateKeyToAccount(privateKeyHex);
     }
     this.rpcUrl = rpcUrl;
+    this.clientId = clientId || getDefaultClientId();
   }
   async getInfos(appIDs, addressCount = 1) {
     const count = Math.min(addressCount, MAX_ADDRESS_COUNT);
@@ -2504,7 +2511,7 @@ var UserApiClient = class {
       formData.append("image", fileBuffer, fileName);
     }
     const headers = {
-      "x-client-id": "ecloud-cli/v0.0.1",
+      "x-client-id": this.clientId,
       ...formData.getHeaders()
     };
     if (this.account) {
@@ -2553,7 +2560,7 @@ Please check:
   }
   async makeAuthenticatedRequest(url, permission) {
     const headers = {
-      "x-client-id": "ecloud-cli/v0.0.1"
+      "x-client-id": this.clientId
     };
     if (permission && this.account) {
       const expiry = BigInt(Math.floor(Date.now() / 1e3) + 5 * 60);
@@ -4739,8 +4746,8 @@ var WATCH_POLL_INTERVAL_SECONDS = 5;
 var APP_STATUS_RUNNING = "Running";
 var APP_STATUS_FAILED = "Failed";
 async function watchUntilRunning(options, logger) {
-  const { environmentConfig, appId, privateKey, rpcUrl } = options;
-  const userApiClient = new UserApiClient(environmentConfig, privateKey, rpcUrl);
+  const { environmentConfig, appId, privateKey, rpcUrl, clientId } = options;
+  const userApiClient = new UserApiClient(environmentConfig, privateKey, rpcUrl, clientId);
   let initialStatus;
   let initialIP;
   let hasChanged = false;
@@ -4789,8 +4796,8 @@ async function watchUntilRunning(options, logger) {
 }
 var APP_STATUS_STOPPED = "Stopped";
 async function watchUntilUpgradeComplete(options, logger) {
-  const { environmentConfig, appId, privateKey, rpcUrl } = options;
-  const userApiClient = new UserApiClient(environmentConfig, privateKey, rpcUrl);
+  const { environmentConfig, appId, privateKey, rpcUrl, clientId } = options;
+  const userApiClient = new UserApiClient(environmentConfig, privateKey, rpcUrl, clientId);
   let initialStatus;
   let initialIP;
   let hasChanged = false;
@@ -5438,7 +5445,7 @@ async function executeDeploy(prepared, gas, logger = defaultLogger) {
     imageRef: prepared.imageRef
   };
 }
-async function watchDeployment(appId, privateKey, rpcUrl, environment, logger = defaultLogger) {
+async function watchDeployment(appId, privateKey, rpcUrl, environment, logger = defaultLogger, clientId) {
   const environmentConfig = getEnvironmentConfig(environment);
   logger.info("Waiting for app to start...");
   return watchUntilRunning(
@@ -5446,7 +5453,8 @@ async function watchDeployment(appId, privateKey, rpcUrl, environment, logger =
       privateKey,
       rpcUrl,
       environmentConfig,
-      appId
+      appId,
+      clientId
     },
     logger
   );
@@ -5646,7 +5654,7 @@ async function executeUpgrade(prepared, gas, logger = defaultLogger) {
     txHash
   };
 }
-async function watchUpgrade(appId, privateKey, rpcUrl, environment, logger = defaultLogger) {
+async function watchUpgrade(appId, privateKey, rpcUrl, environment, logger = defaultLogger, clientId) {
   const environmentConfig = getEnvironmentConfig(environment);
   logger.info("Waiting for upgrade to complete...");
   await watchUntilUpgradeComplete(
@@ -5654,7 +5662,8 @@ async function watchUpgrade(appId, privateKey, rpcUrl, environment, logger = def
       privateKey,
       rpcUrl,
       environmentConfig,
-      appId
+      appId,
+      clientId
     },
     logger
   );
@@ -5754,10 +5763,10 @@ function getCategoryDescriptions(catalog, language) {
 import * as fs5 from "fs";
 import * as path5 from "path";
 import * as os2 from "os";
-import { exec as exec6, execFile } from "child_process";
+import { exec as exec4, execFile as execFile3 } from "child_process";
 import { promisify as promisify4 } from "util";
-var execAsync2 = promisify4(exec6);
-var execFileAsync = promisify4(execFile);
+var execAsync2 = promisify4(exec4);
+var execFileAsync2 = promisify4(execFile3);
 async function fetchTemplate(repoURL, ref, targetDir, config, logger) {
   if (!repoURL) {
     throw new Error("repoURL is required");
@@ -5769,10 +5778,14 @@ Cloning repo: ${repoURL} \u2192 ${targetDir}
     await execAsync2(`git clone --no-checkout --progress ${repoURL} ${targetDir}`, {
       maxBuffer: 10 * 1024 * 1024
     });
-    await execFileAsync("git", ["-C", targetDir, "checkout", "--quiet", ref], {
+    await execFileAsync2("git", ["-C", targetDir, "checkout", "--quiet", ref], {
       maxBuffer: 10 * 1024 * 1024
     });
-    await execAsync2(`git -C ${targetDir} submodule update --init --recursive --progress`);
+    await execFileAsync2(
+      "git",
+      ["-C", targetDir, "submodule", "update", "--init", "--recursive", "--progress"],
+      { maxBuffer: 10 * 1024 * 1024 }
+    );
     logger.info(`Clone repo complete: ${repoURL}
 `);
   } catch (error) {
@@ -5813,14 +5826,14 @@ Cloning template: ${repoURL} \u2192 extracting ${subPath}
 }
 async function cloneSparse(repoURL, ref, subPath, tempDir) {
   try {
-    await execFileAsync("git", ["init", tempDir]);
-    await execFileAsync("git", ["-C", tempDir, "remote", "add", "origin", repoURL]);
-    await execFileAsync("git", ["-C", tempDir, "config", "core.sparseCheckout", "true"]);
+    await execFileAsync2("git", ["init", tempDir]);
+    await execFileAsync2("git", ["-C", tempDir, "remote", "add", "origin", repoURL]);
+    await execFileAsync2("git", ["-C", tempDir, "config", "core.sparseCheckout", "true"]);
     const sparseCheckoutPath = path5.join(tempDir, ".git/info/sparse-checkout");
     fs5.writeFileSync(sparseCheckoutPath, `${subPath}
 `);
-    await execFileAsync("git", ["-C", tempDir, "fetch", "origin", ref]);
-    await execFileAsync("git", ["-C", tempDir, "checkout", ref]);
+    await execFileAsync2("git", ["-C", tempDir, "fetch", "origin", ref]);
+    await execFileAsync2("git", ["-C", tempDir, "checkout", ref]);
   } catch (error) {
     throw new Error(`Failed to clone sparse repository: ${error.message}`);
   }
@@ -6214,7 +6227,12 @@ async function logs(options, logger = defaultLogger) {
   }
   const appID = validateAppID(options.appID);
   const formattedApp = formatAppDisplay(environmentConfig.name, appID, "");
-  const userApiClient = new UserApiClient(environmentConfig, options.privateKey, rpcUrl);
+  const userApiClient = new UserApiClient(
+    environmentConfig,
+    options.privateKey,
+    rpcUrl,
+    options.clientId
+  );
   let logsText;
   let logsError = null;
   try {
@@ -6370,7 +6388,8 @@ function createAppModule(ctx) {
           privateKey,
           appID: opts.appID,
           watch: opts.watch,
-          environment: ctx.environment
+          environment: ctx.environment,
+          clientId: ctx.clientId
         },
         logger
       );
@@ -6831,12 +6850,13 @@ function generateNewPrivateKey() {
 }
 
 // src/client/common/utils/instance.ts
-async function getCurrentInstanceType(preflightCtx, appID, logger) {
+async function getCurrentInstanceType(preflightCtx, appID, logger, clientId) {
   try {
     const userApiClient = new UserApiClient(
       preflightCtx.environmentConfig,
       preflightCtx.privateKey,
-      preflightCtx.rpcUrl
+      preflightCtx.rpcUrl,
+      clientId
     );
     const infos = await userApiClient.getInfos([appID], 1);
     if (infos.length === 0) {