@opensea/cli 0.2.0 → 0.3.0

package/dist/cli.js

@@ -6,16 +6,21 @@ import { Command as Command10 } from "commander";
 // src/client.ts
 var DEFAULT_BASE_URL = "https://api.opensea.io";
 var DEFAULT_GRAPHQL_URL = "https://gql.opensea.io/graphql";
+var DEFAULT_TIMEOUT_MS = 3e4;
 var OpenSeaClient = class {
   apiKey;
   baseUrl;
   graphqlUrl;
   defaultChain;
+  timeoutMs;
+  verbose;
   constructor(config) {
     this.apiKey = config.apiKey;
     this.baseUrl = config.baseUrl ?? DEFAULT_BASE_URL;
     this.graphqlUrl = config.graphqlUrl ?? DEFAULT_GRAPHQL_URL;
     this.defaultChain = config.chain ?? "ethereum";
+    this.timeoutMs = config.timeout ?? DEFAULT_TIMEOUT_MS;
+    this.verbose = config.verbose ?? false;
   }
   async get(path, params) {
     const url = new URL(`${this.baseUrl}${path}`);
@@ -26,35 +31,64 @@ var OpenSeaClient = class {
         }
       }
     }
+    if (this.verbose) {
+      console.error(`[verbose] GET ${url.toString()}`);
+    }
     const response = await fetch(url.toString(), {
       method: "GET",
       headers: {
         Accept: "application/json",
         "x-api-key": this.apiKey
-      }
+      },
+      signal: AbortSignal.timeout(this.timeoutMs)
     });
+    if (this.verbose) {
+      console.error(`[verbose] ${response.status} ${response.statusText}`);
+    }
     if (!response.ok) {
       const body = await response.text();
       throw new OpenSeaAPIError(response.status, body, path);
     }
     return response.json();
   }
-  async post(path) {
+  async post(path, body, params) {
     const url = new URL(`${this.baseUrl}${path}`);
+    if (params) {
+      for (const [key, value] of Object.entries(params)) {
+        if (value !== void 0 && value !== null) {
+          url.searchParams.set(key, String(value));
+        }
+      }
+    }
+    const headers = {
+      Accept: "application/json",
+      "x-api-key": this.apiKey
+    };
+    if (body) {
+      headers["Content-Type"] = "application/json";
+    }
+    if (this.verbose) {
+      console.error(`[verbose] POST ${url.toString()}`);
+    }
     const response = await fetch(url.toString(), {
       method: "POST",
-      headers: {
-        Accept: "application/json",
-        "x-api-key": this.apiKey
-      }
+      headers,
+      body: body ? JSON.stringify(body) : void 0,
+      signal: AbortSignal.timeout(this.timeoutMs)
     });
+    if (this.verbose) {
+      console.error(`[verbose] ${response.status} ${response.statusText}`);
+    }
     if (!response.ok) {
-      const body = await response.text();
-      throw new OpenSeaAPIError(response.status, body, path);
+      const text = await response.text();
+      throw new OpenSeaAPIError(response.status, text, path);
     }
     return response.json();
   }
   async graphql(query, variables) {
+    if (this.verbose) {
+      console.error(`[verbose] POST ${this.graphqlUrl}`);
+    }
     const response = await fetch(this.graphqlUrl, {
       method: "POST",
       headers: {
@@ -62,8 +96,12 @@ var OpenSeaClient = class {
         Accept: "application/json",
         "x-api-key": this.apiKey
       },
-      body: JSON.stringify({ query, variables })
+      body: JSON.stringify({ query, variables }),
+      signal: AbortSignal.timeout(this.timeoutMs)
     });
+    if (this.verbose) {
+      console.error(`[verbose] ${response.status} ${response.statusText}`);
+    }
     if (!response.ok) {
       const body = await response.text();
       throw new OpenSeaAPIError(response.status, body, "graphql");
@@ -130,6 +168,7 @@ function formatTable(data) {
   }
   if (data && typeof data === "object") {
     const entries = Object.entries(data);
+    if (entries.length === 0) return "(empty)";
     const maxKeyLength = Math.max(...entries.map(([k]) => k.length));
     return entries.map(([key, value]) => {
       const displayValue = typeof value === "object" && value !== null ? JSON.stringify(value) : String(value ?? "");
@@ -152,6 +191,24 @@ function accountsCommand(getClient2, getFormat2) {
 
 // src/commands/collections.ts
 import { Command as Command2 } from "commander";
+
+// src/parse.ts
+function parseIntOption(value, name) {
+  const parsed = Number.parseInt(value, 10);
+  if (Number.isNaN(parsed)) {
+    throw new Error(`Invalid value for ${name}: "${value}" is not an integer`);
+  }
+  return parsed;
+}
+function parseFloatOption(value, name) {
+  const parsed = Number.parseFloat(value);
+  if (Number.isNaN(parsed)) {
+    throw new Error(`Invalid value for ${name}: "${value}" is not a number`);
+  }
+  return parsed;
+}
+
+// src/commands/collections.ts
 function collectionsCommand(getClient2, getFormat2) {
   const cmd = new Command2("collections").description(
     "Manage and query NFT collections"
@@ -172,7 +229,7 @@ function collectionsCommand(getClient2, getFormat2) {
         order_by: options.orderBy,
         creator_username: options.creator,
         include_hidden: options.includeHidden,
-        limit: Number.parseInt(options.limit, 10),
+        limit: parseIntOption(options.limit, "--limit"),
         next: options.next
       });
       console.log(formatOutput(result, getFormat2()));
@@ -207,10 +264,10 @@ function eventsCommand(getClient2, getFormat2) {
       const client = getClient2();
       const result = await client.get("/api/v2/events", {
         event_type: options.eventType,
-        after: options.after ? Number.parseInt(options.after, 10) : void 0,
-        before: options.before ? Number.parseInt(options.before, 10) : void 0,
+        after: options.after ? parseIntOption(options.after, "--after") : void 0,
+        before: options.before ? parseIntOption(options.before, "--before") : void 0,
         chain: options.chain,
-        limit: Number.parseInt(options.limit, 10),
+        limit: parseIntOption(options.limit, "--limit"),
         next: options.next
       });
       console.log(formatOutput(result, getFormat2()));
@@ -222,7 +279,7 @@ function eventsCommand(getClient2, getFormat2) {
       const result = await client.get(`/api/v2/events/accounts/${address}`, {
         event_type: options.eventType,
         chain: options.chain,
-        limit: Number.parseInt(options.limit, 10),
+        limit: parseIntOption(options.limit, "--limit"),
         next: options.next
       });
       console.log(formatOutput(result, getFormat2()));
@@ -233,7 +290,7 @@ function eventsCommand(getClient2, getFormat2) {
       const client = getClient2();
       const result = await client.get(`/api/v2/events/collection/${slug}`, {
         event_type: options.eventType,
-        limit: Number.parseInt(options.limit, 10),
+        limit: parseIntOption(options.limit, "--limit"),
         next: options.next
       });
       console.log(formatOutput(result, getFormat2()));
@@ -246,7 +303,7 @@ function eventsCommand(getClient2, getFormat2) {
         `/api/v2/events/chain/${chain}/contract/${contract}/nfts/${tokenId}`,
         {
           event_type: options.eventType,
-          limit: Number.parseInt(options.limit, 10),
+          limit: parseIntOption(options.limit, "--limit"),
           next: options.next
         }
       );
@@ -264,7 +321,7 @@ function listingsCommand(getClient2, getFormat2) {
     async (collection, options) => {
       const client = getClient2();
       const result = await client.get(`/api/v2/listings/collection/${collection}/all`, {
-        limit: Number.parseInt(options.limit, 10),
+        limit: parseIntOption(options.limit, "--limit"),
         next: options.next
       });
       console.log(formatOutput(result, getFormat2()));
@@ -274,7 +331,7 @@ function listingsCommand(getClient2, getFormat2) {
     async (collection, options) => {
       const client = getClient2();
       const result = await client.get(`/api/v2/listings/collection/${collection}/best`, {
-        limit: Number.parseInt(options.limit, 10),
+        limit: parseIntOption(options.limit, "--limit"),
         next: options.next
       });
       console.log(formatOutput(result, getFormat2()));
@@ -306,7 +363,7 @@ function nftsCommand(getClient2, getFormat2) {
     const result = await client.get(
       `/api/v2/collection/${slug}/nfts`,
       {
-        limit: Number.parseInt(options.limit, 10),
+        limit: parseIntOption(options.limit, "--limit"),
         next: options.next
       }
     );
@@ -318,7 +375,7 @@ function nftsCommand(getClient2, getFormat2) {
       const result = await client.get(
         `/api/v2/chain/${chain}/contract/${contract}/nfts`,
         {
-          limit: Number.parseInt(options.limit, 10),
+          limit: parseIntOption(options.limit, "--limit"),
           next: options.next
         }
       );
@@ -331,7 +388,7 @@ function nftsCommand(getClient2, getFormat2) {
       const result = await client.get(
         `/api/v2/chain/${chain}/account/${address}/nfts`,
         {
-          limit: Number.parseInt(options.limit, 10),
+          limit: parseIntOption(options.limit, "--limit"),
           next: options.next
         }
       );
@@ -368,7 +425,7 @@ function offersCommand(getClient2, getFormat2) {
     async (collection, options) => {
       const client = getClient2();
       const result = await client.get(`/api/v2/offers/collection/${collection}/all`, {
-        limit: Number.parseInt(options.limit, 10),
+        limit: parseIntOption(options.limit, "--limit"),
         next: options.next
       });
       console.log(formatOutput(result, getFormat2()));
@@ -378,7 +435,7 @@ function offersCommand(getClient2, getFormat2) {
     async (collection, options) => {
       const client = getClient2();
       const result = await client.get(`/api/v2/offers/collection/${collection}`, {
-        limit: Number.parseInt(options.limit, 10),
+        limit: parseIntOption(options.limit, "--limit"),
         next: options.next
       });
       console.log(formatOutput(result, getFormat2()));
@@ -397,7 +454,7 @@ function offersCommand(getClient2, getFormat2) {
       const result = await client.get(`/api/v2/offers/collection/${collection}/traits`, {
         type: options.type,
         value: options.value,
-        limit: Number.parseInt(options.limit, 10),
+        limit: parseIntOption(options.limit, "--limit"),
         next: options.next
       });
       console.log(formatOutput(result, getFormat2()));
@@ -512,7 +569,7 @@ function searchCommand(getClient2, getFormat2) {
       const client = getClient2();
       const result = await client.graphql(SEARCH_COLLECTIONS_QUERY, {
         query,
-        limit: Number.parseInt(options.limit, 10),
+        limit: parseIntOption(options.limit, "--limit"),
         chains: options.chains?.split(",")
       });
       console.log(formatOutput(result.collectionsByQuery, getFormat2()));
@@ -524,7 +581,7 @@ function searchCommand(getClient2, getFormat2) {
       const result = await client.graphql(SEARCH_NFTS_QUERY, {
         query,
         collectionSlug: options.collection,
-        limit: Number.parseInt(options.limit, 10),
+        limit: parseIntOption(options.limit, "--limit"),
         chains: options.chains?.split(",")
       });
       console.log(formatOutput(result.itemsByQuery, getFormat2()));
@@ -535,7 +592,7 @@ function searchCommand(getClient2, getFormat2) {
       const client = getClient2();
       const result = await client.graphql(SEARCH_TOKENS_QUERY, {
         query,
-        limit: Number.parseInt(options.limit, 10),
+        limit: parseIntOption(options.limit, "--limit"),
         chain: options.chain
       });
       console.log(formatOutput(result.currenciesByQuery, getFormat2()));
@@ -545,7 +602,7 @@ function searchCommand(getClient2, getFormat2) {
     const client = getClient2();
     const result = await client.graphql(SEARCH_ACCOUNTS_QUERY, {
       query,
-      limit: Number.parseInt(options.limit, 10)
+      limit: parseIntOption(options.limit, "--limit")
     });
     console.log(formatOutput(result.accountsByQuery, getFormat2()));
   });
@@ -584,7 +641,7 @@ function swapsCommand(getClient2, getFormat2) {
           to_address: options.toAddress,
           quantity: options.quantity,
           address: options.address,
-          slippage: options.slippage ? Number.parseFloat(options.slippage) : void 0,
+          slippage: options.slippage ? parseFloatOption(options.slippage, "--slippage") : void 0,
           recipient: options.recipient
         }
       );
@@ -600,29 +657,31 @@ function tokensCommand(getClient2, getFormat2) {
   const cmd = new Command9("tokens").description(
     "Query trending tokens, top tokens, and token details"
   );
-  cmd.command("trending").description("Get trending tokens based on OpenSea's trending score").option("--chains <chains>", "Comma-separated list of chains to filter by").option("--limit <limit>", "Number of results (max 100)", "20").option("--cursor <cursor>", "Pagination cursor").action(
+  cmd.command("trending").description("Get trending tokens based on OpenSea's trending score").option("--chains <chains>", "Comma-separated list of chains to filter by").option("--limit <limit>", "Number of results (max 100)", "20").option("--next <cursor>", "Pagination cursor").action(
     async (options) => {
       const client = getClient2();
       const result = await client.get(
         "/api/v2/tokens/trending",
         {
           chains: options.chains,
-          limit: Number.parseInt(options.limit, 10),
-          cursor: options.cursor
+          limit: parseIntOption(options.limit, "--limit"),
+          // Tokens API uses "cursor" instead of "next" as the query param
+          cursor: options.next
         }
       );
       console.log(formatOutput(result, getFormat2()));
     }
   );
-  cmd.command("top").description("Get top tokens ranked by 24-hour trading volume").option("--chains <chains>", "Comma-separated list of chains to filter by").option("--limit <limit>", "Number of results (max 100)", "20").option("--cursor <cursor>", "Pagination cursor").action(
+  cmd.command("top").description("Get top tokens ranked by 24-hour trading volume").option("--chains <chains>", "Comma-separated list of chains to filter by").option("--limit <limit>", "Number of results (max 100)", "20").option("--next <cursor>", "Pagination cursor").action(
     async (options) => {
       const client = getClient2();
       const result = await client.get(
         "/api/v2/tokens/top",
         {
           chains: options.chains,
-          limit: Number.parseInt(options.limit, 10),
-          cursor: options.cursor
+          limit: parseIntOption(options.limit, "--limit"),
+          // Tokens API uses "cursor" instead of "next" as the query param
+          cursor: options.next
         }
       );
       console.log(formatOutput(result, getFormat2()));
@@ -650,7 +709,7 @@ var BANNER = `
         |_|
 `;
 var program = new Command10();
-program.name("opensea").description("OpenSea CLI - Query the OpenSea API from the command line").version(process.env.npm_package_version ?? "0.0.0").addHelpText("before", BANNER).option("--api-key <key>", "OpenSea API key (or set OPENSEA_API_KEY env var)").option("--chain <chain>", "Default chain", "ethereum").option("--format <format>", "Output format (json or table)", "json").option("--base-url <url>", "API base URL");
+program.name("opensea").description("OpenSea CLI - Query the OpenSea API from the command line").version(process.env.npm_package_version ?? "0.0.0").addHelpText("before", BANNER).option("--api-key <key>", "OpenSea API key (or set OPENSEA_API_KEY env var)").option("--chain <chain>", "Default chain", "ethereum").option("--format <format>", "Output format (json or table)", "json").option("--base-url <url>", "API base URL").option("--timeout <ms>", "Request timeout in milliseconds", "30000").option("--verbose", "Log request and response info to stderr");
 function getClient() {
   const opts = program.opts();
   const apiKey = opts.apiKey ?? process.env.OPENSEA_API_KEY;
@@ -663,7 +722,9 @@ function getClient() {
   return new OpenSeaClient({
     apiKey,
     chain: opts.chain,
-    baseUrl: opts.baseUrl
+    baseUrl: opts.baseUrl,
+    timeout: parseIntOption(opts.timeout, "--timeout"),
+    verbose: opts.verbose
   });
 }
 function getFormat() {
@@ -698,7 +759,18 @@ async function main() {
       );
       process.exit(1);
     }
-    throw error;
+    const label = error instanceof TypeError ? "Network Error" : error.name;
+    console.error(
+      JSON.stringify(
+        {
+          error: label,
+          message: error.message
+        },
+        null,
+        2
+      )
+    );
+    process.exit(1);
   }
 }
 main();