feat: add posthog telemetry to all CLI commands and top-level SDK methods (#37)

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
Co-authored-by: Madhur Shrimal <[email protected]>

Author: 3 people

.github/workflows/release-dev.yml

@@ -61,6 +61,7 @@ jobs:
         env:
           BUILD_TYPE: dev
           PACKAGE_VERSION: ${{ env.PACKAGE_VERSION }}
+          POSTHOG_API_KEY_BUILD_TIME: ${{ secrets.POSTHOG_API_KEY }}
         run: |
           pnpm run build
 
@@ -69,6 +70,7 @@ jobs:
         env:
           BUILD_TYPE: dev
           PACKAGE_VERSION: ${{ env.PACKAGE_VERSION }}
+          POSTHOG_API_KEY_BUILD_TIME: ${{ secrets.POSTHOG_API_KEY }}
         run: |
           pnpm run build
 

.github/workflows/release-prod.yml

@@ -101,6 +101,7 @@ jobs:
         env:
           BUILD_TYPE: prod
           PACKAGE_VERSION: ${{ env.PACKAGE_VERSION }}
+          POSTHOG_API_KEY_BUILD_TIME: ${{ secrets.POSTHOG_API_KEY }}
         run: |
           pnpm run build
 
@@ -109,6 +110,7 @@ jobs:
         env:
           BUILD_TYPE: prod
           PACKAGE_VERSION: ${{ env.PACKAGE_VERSION }}
+          POSTHOG_API_KEY_BUILD_TIME: ${{ secrets.POSTHOG_API_KEY }}
         run: |
           pnpm run build
 

eslint.config.js

@@ -2,10 +2,18 @@ import tseslint from "@typescript-eslint/eslint-plugin";
 import tsparser from "@typescript-eslint/parser";
 
 export default [
+  {
+    ignores: ["**/dist/**"],
+  },
   {
     files: ["**/*.ts"],
     languageOptions: { parser: tsparser },
     plugins: { "@typescript-eslint": tseslint },
-    rules: { "@typescript-eslint/no-unused-vars": ["error"] },
+    rules: {
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        { argsIgnorePattern: "^_", varsIgnorePattern: "^_" },
+      ],
+    },
   },
 ];

packages/cli/src/client.ts

@@ -30,6 +30,7 @@ export async function createComputeClient(flags: CommonFlags) {
     rpcUrl,
     environment,
     clientId: getClientId(),
+    skipTelemetry: true, // CLI already has telemetry, skip SDK telemetry
   });
 }
 
@@ -42,5 +43,6 @@ export async function createBillingClient(flags: { "private-key"?: string; verbo
   return createBillingModule({
     verbose: flags.verbose ?? false,
     privateKey: privateKey as Hex,
+    skipTelemetry: true, // CLI already has telemetry, skip SDK telemetry
   });
 }

packages/cli/src/commands/auth/generate.ts

@@ -8,6 +8,7 @@ import { Command, Flags } from "@oclif/core";
 import { confirm } from "@inquirer/prompts";
 import { generateNewPrivateKey, storePrivateKey, keyExists } from "@layr-labs/ecloud-sdk";
 import { showPrivateKey, displayWarning } from "../../utils/security";
+import { withTelemetry } from "../../telemetry";
 
 export default class AuthGenerate extends Command {
   static description = "Generate a new private key";
@@ -27,14 +28,15 @@ export default class AuthGenerate extends Command {
   };
 
   async run(): Promise<void> {
-    const { flags } = await this.parse(AuthGenerate);
+    return withTelemetry(this, async () => {
+      const { flags } = await this.parse(AuthGenerate);
 
-    // Generate new key
-    this.log("Generating new private key...\n");
-    const { privateKey, address } = generateNewPrivateKey();
+      // Generate new key
+      this.log("Generating new private key...\n");
+      const { privateKey, address } = generateNewPrivateKey();
 
-    // Display key securely
-    const content = `
+      // Display key securely
+      const content = `
 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 A new private key was generated for you.
 
@@ -53,61 +55,62 @@ Private key: ${privateKey}
 Press 'q' to exit and continue...
 `;
 
-    const displayed = await showPrivateKey(content);
-
-    if (!displayed) {
-      this.log("Key generation cancelled.");
-      return;
-    }
-
-    // Ask about storing
-    let shouldStore = flags.store;
-
-    if (!shouldStore && displayed) {
-      shouldStore = await confirm({
-        message: "Store this key in your OS keyring?",
-        default: true,
-      });
-    }
-
-    if (shouldStore) {
-      // Check if key already exists
-      const exists = await keyExists();
-
-      if (exists) {
-        displayWarning([
-          `WARNING: A private key for ecloud already exists!`,
-          "If you continue, the existing key will be PERMANENTLY REPLACED.",
-          "This cannot be undone!",
-          "",
-          "The previous key will be lost forever if you haven't backed it up.",
-        ]);
-
-        const confirmReplace = await confirm({
-          message: `Replace existing key for ecloud?`,
-          default: false,
+      const displayed = await showPrivateKey(content);
+
+      if (!displayed) {
+        this.log("Key generation cancelled.");
+        return;
+      }
+
+      // Ask about storing
+      let shouldStore = flags.store;
+
+      if (!shouldStore && displayed) {
+        shouldStore = await confirm({
+          message: "Store this key in your OS keyring?",
+          default: true,
         });
+      }
 
-        if (!confirmReplace) {
-          this.log(
-            "\nKey not stored. If you did not save your new key when it was displayed, it is now lost and cannot be recovered.",
-          );
-          return;
+      if (shouldStore) {
+        // Check if key already exists
+        const exists = await keyExists();
+
+        if (exists) {
+          displayWarning([
+            `WARNING: A private key for ecloud already exists!`,
+            "If you continue, the existing key will be PERMANENTLY REPLACED.",
+            "This cannot be undone!",
+            "",
+            "The previous key will be lost forever if you haven't backed it up.",
+          ]);
+
+          const confirmReplace = await confirm({
+            message: `Replace existing key for ecloud?`,
+            default: false,
+          });
+
+          if (!confirmReplace) {
+            this.log(
+              "\nKey not stored. If you did not save your new key when it was displayed, it is now lost and cannot be recovered.",
+            );
+            return;
+          }
         }
-      }
 
-      // Store the key
-      try {
-        await storePrivateKey(privateKey);
-        this.log(`\n✓ Private key stored in OS keyring`);
-        this.log(`✓ Address: ${address}`);
-        this.log("\nYou can now use ecloud commands without --private-key flag.");
-      } catch (err: any) {
-        this.error(`Failed to store key: ${err.message}`);
+        // Store the key
+        try {
+          await storePrivateKey(privateKey);
+          this.log(`\n✓ Private key stored in OS keyring`);
+          this.log(`✓ Address: ${address}`);
+          this.log("\nYou can now use ecloud commands without --private-key flag.");
+        } catch (err: any) {
+          this.error(`Failed to store key: ${err.message}`);
+        }
+      } else {
+        this.log("\nKey not stored in keyring.");
+        this.log("Remember to save the key shown above in a secure location.");
       }
-    } else {
-      this.log("\nKey not stored in keyring.");
-      this.log("Remember to save the key shown above in a secure location.");
-    }
+    });
   }
 }