@xyz17711/ip-blocklist 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -25,10 +25,13 @@ npm install @xyz17711/ip-blocklist
25
25
  ```typescript
26
26
  import { Client } from "@xyz17711/ip-blocklist";
27
27
 
28
- const client = new Client("https://api.17711.xyz/registry/ip-blocklist");
28
+ const client = new Client(); // talks to https://api.17711.xyz/registry/ip-blocklist by default
29
29
  // see the Methods table above for every available call and its request/response type
30
30
  ```
31
31
 
32
+ Pass another base URL (self-hosted instance, test server) as the first argument:
33
+ `new Client("https://my-host.example/registry/ip-blocklist")`.
34
+
32
35
  ## Paying past the free quota
33
36
 
34
37
  Every gated tool allows a small number of free calls per day; beyond that it returns a 402
@@ -38,7 +41,7 @@ network, and payee address attached:
38
41
  ```typescript
39
42
  import { Client, PaymentRequiredError } from "@xyz17711/ip-blocklist";
40
43
 
41
- const client = new Client("https://api.17711.xyz/registry/ip-blocklist");
44
+ const client = new Client();
42
45
  try {
43
46
  await client.checkIp(/* ... */);
44
47
  } catch (e) {
@@ -54,7 +57,7 @@ own environment/secrets manager, never a literal string in source code:
54
57
  ```typescript
55
58
  import { Client } from "@xyz17711/ip-blocklist";
56
59
 
57
- const client = new Client("https://api.17711.xyz/registry/ip-blocklist", {
60
+ const client = new Client({
58
61
  x402PrivateKey: process.env.X402_PRIVATE_KEY,
59
62
  x402ExpectedNetwork: "eip155:8453", // Base mainnet; use eip155:84532 for Base Sepolia testnet
60
63
  x402MaxPaymentUsdc: 0.01, // refuse any single call above this
@@ -73,7 +76,7 @@ with that same key in this process.
73
76
  import { Client } from "@xyz17711/ip-blocklist";
74
77
  import { IpBlocklistToolkit } from "@xyz17711/ip-blocklist/langchain";
75
78
 
76
- const client = new Client("https://api.17711.xyz/registry/ip-blocklist", { /* ...wallet options... */ });
79
+ const client = new Client({ /* ...wallet options... */ });
77
80
  const tools = new IpBlocklistToolkit(client).getTools();
78
81
  ```
79
82
 
package/dist/index.d.ts CHANGED
@@ -15,8 +15,17 @@ export interface CheckIpResponse {
15
15
  /** Every source that contains this IP, not just the first one found -- an IP flagged by several sources is a stronger signal than one flagged by a single list. */
16
16
  matches: BlocklistMatch[];
17
17
  }
18
+ /** Production base URL of this service; pass another to self-host or test. */
19
+ export declare const DEFAULT_BASE_URL = "https://api.17711.xyz/registry/ip-blocklist";
18
20
  /** Typed client for ip-blocklist, e.g. `client.checkIp(...)`. */
19
21
  export declare class Client extends BaseClient {
22
+ /**
23
+ * `new Client()` talks to the production service. Pass a base URL to target another
24
+ * instance, and/or wallet options (`new Client({ x402PrivateKey, ... })`) to pay past the
25
+ * free quota automatically.
26
+ */
27
+ constructor(options?: ClientOptions);
28
+ constructor(baseUrl?: string, options?: ClientOptions);
20
29
  /** IP reputation check: is this IPv4 address on a public threat blocklist (Tor exit nodes, botnets, spam networks) ($0.010, x402) */
21
30
  checkIp(params: {
22
31
  ip: string;
package/dist/index.js CHANGED
@@ -2,8 +2,16 @@
2
2
  * Typed HTTP client and request/response interfaces for ip-blocklist.
3
3
  */
4
4
  import { Client as BaseClient } from "@xyz17711/core";
5
+ /** Production base URL of this service; pass another to self-host or test. */
6
+ export const DEFAULT_BASE_URL = "https://api.17711.xyz/registry/ip-blocklist";
5
7
  /** Typed client for ip-blocklist, e.g. `client.checkIp(...)`. */
6
8
  export class Client extends BaseClient {
9
+ constructor(baseUrlOrOptions, options = {}) {
10
+ const [url, opts] = typeof baseUrlOrOptions === "object"
11
+ ? [DEFAULT_BASE_URL, baseUrlOrOptions]
12
+ : [baseUrlOrOptions ?? DEFAULT_BASE_URL, options];
13
+ super(url, opts);
14
+ }
7
15
  /** IP reputation check: is this IPv4 address on a public threat blocklist (Tor exit nodes, botnets, spam networks) ($0.010, x402) */
8
16
  async checkIp(params) {
9
17
  return this.get("/v1/ip-blocklist/check", { ip: params.ip });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyz17711/ip-blocklist",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "description": "Typed TypeScript client for the 17711.xyz Ip Blocklist API: pay-per-call, settled in USDC via x402.",
5
5
  "license": "MIT",
6
6
  "author": "17711 Services",