@openzeppelin/relayer-plugin-channels 0.4.0 → 0.6.0

package/README.md

@@ -19,6 +19,10 @@ A plugin for OpenZeppelin Relayer that enables parallel transaction submission o
 - [Management API](#management-api)
   - [List Channel Accounts](#list-channel-accounts)
   - [Set Channel Accounts](#set-channel-accounts)
+  - [Get Fee Usage](#get-fee-usage)
+  - [Get Fee Limit](#get-fee-limit)
+  - [Set Fee Limit](#set-fee-limit)
+  - [Delete Fee Limit](#delete-fee-limit)
 - [Plugin Client](#plugin-client)
   - [Installation](#installation)
   - [Quick Start](#quick-start-1)
@@ -215,7 +219,11 @@ export PLUGIN_ADMIN_SECRET="your-secret-here"  # Required for management API
 
 # Optional environment variables
 export LOCK_TTL_SECONDS=10              # default: 30, min: 3, max: 30
-export MAX_FEE=1000000                  # default: 1,000,000 stroops
+
+# Fee tracking (optional)
+export FEE_LIMIT=1000000                  # Default max fee per API key in stroops (disabled if not set)
+export FEE_RESET_PERIOD_SECONDS=86400     # Reset fee consumption every N seconds (e.g., 86400 = 24 hours)
+export API_KEY_HEADER="x-api-key"         # Header name to extract API key (default: x-api-key)
 ```
 
 Your Relayer should now contain:
@@ -341,6 +349,127 @@ curl -X POST http://localhost:8080/api/v1/plugins/channels/call \
 }
 ```
 
+### Get Fee Usage
+
+Query fee consumption for a specific API key:
+
+```bash
+curl -X POST http://localhost:8080/api/v1/plugins/channels/call \
+  -H "Authorization: Bearer YOUR_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "params": {
+      "management": {
+        "action": "getFeeUsage",
+        "adminSecret": "your-secret-here",
+        "apiKey": "client-api-key-to-query"
+      }
+    }
+  }'
+```
+
+**Response:**
+
+```json
+{
+  "consumed": 500000,
+  "limit": 1000000,
+  "remaining": 500000,
+  "periodStartAt": "2024-01-15T00:00:00.000Z",
+  "periodEndsAt": "2024-01-16T00:00:00.000Z"
+}
+```
+
+- `limit`: Effective fee limit (custom if set, otherwise default)
+- `remaining`: Remaining fee budget in stroops
+- `periodStartAt`: Datetime string when current period started (if reset period configured)
+- `periodEndsAt`: Datetime string when period will reset (if reset period configured)
+
+### Get Fee Limit
+
+Query fee limit configuration for a specific API key:
+
+```bash
+curl -X POST http://localhost:8080/api/v1/plugins/channels/call \
+  -H "Authorization: Bearer YOUR_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "params": {
+      "management": {
+        "action": "getFeeLimit",
+        "adminSecret": "your-secret-here",
+        "apiKey": "client-api-key-to-query"
+      }
+    }
+  }'
+```
+
+**Response:**
+
+```json
+{
+  "limit": 500000
+}
+```
+
+### Set Fee Limit
+
+Set a custom fee limit for a specific API key:
+
+```bash
+curl -X POST http://localhost:8080/api/v1/plugins/channels/call \
+  -H "Authorization: Bearer YOUR_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "params": {
+      "management": {
+        "action": "setFeeLimit",
+        "adminSecret": "your-secret-here",
+        "apiKey": "client-api-key",
+        "limit": 500000
+      }
+    }
+  }'
+```
+
+**Response:**
+
+```json
+{
+  "ok": true,
+  "limit": 500000
+}
+```
+
+Note: If custom limit is set to 0 it will block all transactions
+
+### Delete Fee Limit
+
+Remove a custom fee limit for a specific API key (reverts to default limit):
+
+```bash
+curl -X POST http://localhost:8080/api/v1/plugins/channels/call \
+  -H "Authorization: Bearer YOUR_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "params": {
+      "management": {
+        "action": "deleteFeeLimit",
+        "adminSecret": "your-secret-here",
+        "apiKey": "client-api-key"
+      }
+    }
+  }'
+```
+
+**Response:**
+
+```json
+{
+  "ok": true
+}
+```
+
 **Important Notes:**
 
 - You must configure at least one channel account before the plugin can process transactions
@@ -477,6 +606,47 @@ console.log(result.ok); // true
 console.log(result.appliedRelayerIds); // ['channel-001', 'channel-002', 'channel-003']
 ```
 
+#### Get Fee Usage (Management)
+
+```typescript
+// Query fee consumption for an API key (requires adminSecret)
+const usage = await adminClient.getFeeUsage("client-api-key");
+
+console.log(usage.consumed); // 500000 (stroops)
+console.log(usage.limit); // 1000000 (effective limit)
+console.log(usage.remaining); // 500000 (remaining budget)
+console.log(usage.periodStartAt); // '2024-01-15T00:00:00.000Z'
+console.log(usage.periodEndsAt); // '2024-01-16T00:00:00.000Z'
+```
+
+#### Get Fee Limit (Management)
+
+```typescript
+// Query fee limit configuration for an API key (requires adminSecret)
+const limitInfo = await adminClient.getFeeLimit("client-api-key");
+
+console.log(limitInfo.limit); // 500000 (custom limit if set, otherwise default)
+```
+
+#### Set Fee Limit (Management)
+
+```typescript
+// Set a custom fee limit for an API key (requires adminSecret)
+const result = await adminClient.setFeeLimit("client-api-key", 500000);
+
+console.log(result.ok); // true
+console.log(result.limit); // 500000
+```
+
+#### Delete Fee Limit (Management)
+
+```typescript
+// Remove custom fee limit, revert to default (requires adminSecret)
+const result = await adminClient.deleteFeeLimit("client-api-key");
+
+console.log(result.ok); // true
+```
+
 ### Error Handling
 
 The client provides three types of errors:
@@ -531,6 +701,10 @@ import type {
   ChannelsTransactionResponse,
   ListChannelAccountsResponse,
   SetChannelAccountsResponse,
+  GetFeeUsageResponse,
+  GetFeeLimitResponse,
+  SetFeeLimitResponse,
+  DeleteFeeLimitResponse,
 } from "@openzeppelin/relayer-plugin-channels";
 ```
 
@@ -539,13 +713,14 @@ import type {
 ```typescript
 interface ChannelsClientConfig {
   // Required
-  baseUrl: string; // Service or Relayer URL
+  baseUrl: string; // Service URL
   apiKey: string; // API key for authentication
 
   // Optional
   pluginId?: string; // Include when connecting to a Relayer directly
   adminSecret?: string; // Required for management operations
   timeout?: number; // Request timeout in ms (default: 30000)
+  apiKeyHeader?: string; // Header name for API key (default: 'x-api-key')
 }
 ```
 
@@ -659,6 +834,16 @@ Plugin error example:
 - **Value**: `{ token: string, lockedAt: ISOString }`
 - **TTL**: Configured by `LOCK_TTL_SECONDS`.
 
+### Fee Tracking
+
+- **Key**: `<network>:api-key-fees:<apiKey>`
+- **Value**: `{ consumed: number, periodStart?: number }` (fees in stroops, period start timestamp in ms)
+
+### Custom Fee Limits
+
+- **Key**: `<network>:api-key-limit:<apiKey>`
+- **Value**: `{ limit: number }` (custom fee limit in stroops)
+
 ## Error Codes
 
 - `CONFIG_MISSING`: Missing required environment variable
@@ -676,6 +861,8 @@ Plugin error example:
 - `MANAGEMENT_DISABLED`: Management API not enabled
 - `UNAUTHORIZED`: Invalid admin secret
 - `LOCKED_CONFLICT`: Cannot remove locked channel accounts
+- `API_KEY_REQUIRED`: API key header missing when `FEE_LIMIT` is configured (HTTP 403)
+- `FEE_LIMIT_EXCEEDED`: API key has exceeded its fee limit (HTTP 429)
 
 ## License
 

package/dist/client/channels-client.d.ts

@@ -1,4 +1,4 @@
-import type { ChannelsClientConfig, ChannelsXdrRequest, ChannelsFuncAuthRequest, ChannelsTransactionResponse, ListChannelAccountsResponse, SetChannelAccountsResponse } from "./types";
+import type { ChannelsClientConfig, ChannelsXdrRequest, ChannelsFuncAuthRequest, ChannelsTransactionResponse, ListChannelAccountsResponse, SetChannelAccountsResponse, GetFeeUsageResponse, GetFeeLimitResponse, SetFeeLimitResponse, DeleteFeeLimitResponse } from "./types";
 /**
  * Client for interacting with the Channels plugin
  *
@@ -88,6 +88,55 @@ export declare class ChannelsClient {
      * ]);
      */
     setChannelAccounts(relayerIds: string[]): Promise<SetChannelAccountsResponse>;
+    /**
+     * Get fee usage for a specific API key (requires adminSecret)
+     *
+     * @param apiKey The client API key to query fee usage for
+     * @returns Fee usage data including total consumed
+     * @throws {Error} If adminSecret not provided in config
+     * @throws {PluginTransportError} Network/HTTP failures
+     * @throws {PluginExecutionError} Plugin rejected the request
+     * @throws {PluginUnexpectedError} Malformed response or client-side errors
+     *
+     * @example
+     * const usage = await client.getFeeUsage('client-api-key-123');
+     * console.log(`Consumed: ${usage.consumed} stroops`);
+     */
+    getFeeUsage(apiKey: string): Promise<GetFeeUsageResponse>;
+    /**
+     * Get fee limit configuration for a specific API key (requires adminSecret)
+     *
+     * @param apiKey The client API key to query fee limit for
+     * @returns Fee limit data
+     * @throws {Error} If adminSecret not provided in config
+     * @throws {PluginTransportError} Network/HTTP failures
+     * @throws {PluginExecutionError} Plugin rejected the request
+     * @throws {PluginUnexpectedError} Malformed response or client-side errors
+     */
+    getFeeLimit(apiKey: string): Promise<GetFeeLimitResponse>;
+    /**
+     * Set a custom fee limit for a specific API key (requires adminSecret)
+     *
+     * @param apiKey The client API key to set the limit for
+     * @param limit The fee limit in stroops (0 blocks all transactions)
+     * @returns Confirmation with the applied limit
+     * @throws {Error} If adminSecret not provided in config
+     * @throws {PluginTransportError} Network/HTTP failures
+     * @throws {PluginExecutionError} Plugin rejected the request
+     * @throws {PluginUnexpectedError} Malformed response or client-side errors
+     */
+    setFeeLimit(apiKey: string, limit: number): Promise<SetFeeLimitResponse>;
+    /**
+     * Delete a custom fee limit for a specific API key (requires adminSecret)
+     *
+     * @param apiKey The client API key to remove the custom limit for
+     * @returns Confirmation of deletion
+     * @throws {Error} If adminSecret not provided in config
+     * @throws {PluginTransportError} Network/HTTP failures
+     * @throws {PluginExecutionError} Plugin rejected the request
+     * @throws {PluginUnexpectedError} Malformed response or client-side errors
+     */
+    deleteFeeLimit(apiKey: string): Promise<DeleteFeeLimitResponse>;
     /**
      * Ensures adminSecret is configured
      *

package/dist/client/channels-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"channels-client.d.ts","sourceRoot":"","sources":["../../src/client/channels-client.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,oBAAoB,EACpB,kBAAkB,EAClB,uBAAuB,EACvB,2BAA2B,EAC3B,2BAA2B,EAC3B,0BAA0B,EAE3B,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAgB;IAC7C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAa;IACzC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAS;gBAEvB,MAAM,EAAE,oBAAoB;IA6BxC;;;;;;;;;;;;;OAaG;IACG,iBAAiB,CACrB,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,2BAA2B,CAAC;IAIvC;;;;;;;;;;;;;;;OAeG;IACG,wBAAwB,CAC5B,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,2BAA2B,CAAC;IAIvC;;;;;;;;;;;;OAYG;IACG,mBAAmB,IAAI,OAAO,CAAC,2BAA2B,CAAC;IASjE;;;;;;;;;;;;;;;OAeG;IACG,kBAAkB,CACtB,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,0BAA0B,CAAC;IAUtC;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IAS1B;;;;;;;OAOG;IAEH,OAAO,CAAC,eAAe;IAoBvB;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;IAgBxB;;;;;;OAMG;IACH,OAAO,CAAC,aAAa;IAUrB;;;;;;;;OAQG;YACW,IAAI;IA6BlB;;;;;;OAMG;YACW,QAAQ;CAYvB"}
+{"version":3,"file":"channels-client.d.ts","sourceRoot":"","sources":["../../src/client/channels-client.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,oBAAoB,EACpB,kBAAkB,EAClB,uBAAuB,EACvB,2BAA2B,EAC3B,2BAA2B,EAC3B,0BAA0B,EAC1B,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,sBAAsB,EAEvB,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAgB;IAC7C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAa;IACzC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAS;gBAEvB,MAAM,EAAE,oBAAoB;IAiCxC;;;;;;;;;;;;;OAaG;IACG,iBAAiB,CACrB,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,2BAA2B,CAAC;IAIvC;;;;;;;;;;;;;;;OAeG;IACG,wBAAwB,CAC5B,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,2BAA2B,CAAC;IAIvC;;;;;;;;;;;;OAYG;IACG,mBAAmB,IAAI,OAAO,CAAC,2BAA2B,CAAC;IASjE;;;;;;;;;;;;;;;OAeG;IACG,kBAAkB,CACtB,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,0BAA0B,CAAC;IAUtC;;;;;;;;;;;;;OAaG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAU/D;;;;;;;;;OASG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAU/D;;;;;;;;;;OAUG;IACG,WAAW,CACf,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,mBAAmB,CAAC;IAW/B;;;;;;;;;OASG;IACG,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAUrE;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IAS1B;;;;;;;OAOG;IAEH,OAAO,CAAC,eAAe;IAoBvB;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;IAgBxB;;;;;;OAMG;IACH,OAAO,CAAC,aAAa;IAUrB;;;;;;;;OAQG;YACW,IAAI;IA6BlB;;;;;;OAMG;YACW,QAAQ;CAYvB"}

package/dist/client/channels-client.js

@@ -33,9 +33,13 @@ class ChannelsClient {
         // Route through Relayer plugin system if pluginId provided, otherwise connect directly
         if ("pluginId" in config && config.pluginId) {
             this.pluginId = config.pluginId;
+            const apiKeyHeader = config.apiKeyHeader || "x-api-key";
             const relayerConfig = new relayer_sdk_1.Configuration({
                 basePath: config.baseUrl,
                 accessToken: config.apiKey,
+                baseOptions: {
+                    headers: { [apiKeyHeader]: config.apiKey },
+                },
             });
             this.pluginsApi = new relayer_sdk_1.PluginsApi(relayerConfig);
         }
@@ -135,6 +139,88 @@ class ChannelsClient {
             },
         });
     }
+    /**
+     * Get fee usage for a specific API key (requires adminSecret)
+     *
+     * @param apiKey The client API key to query fee usage for
+     * @returns Fee usage data including total consumed
+     * @throws {Error} If adminSecret not provided in config
+     * @throws {PluginTransportError} Network/HTTP failures
+     * @throws {PluginExecutionError} Plugin rejected the request
+     * @throws {PluginUnexpectedError} Malformed response or client-side errors
+     *
+     * @example
+     * const usage = await client.getFeeUsage('client-api-key-123');
+     * console.log(`Consumed: ${usage.consumed} stroops`);
+     */
+    async getFeeUsage(apiKey) {
+        return this.call({
+            management: {
+                action: "getFeeUsage",
+                adminSecret: this.requireAdminSecret(),
+                apiKey,
+            },
+        });
+    }
+    /**
+     * Get fee limit configuration for a specific API key (requires adminSecret)
+     *
+     * @param apiKey The client API key to query fee limit for
+     * @returns Fee limit data
+     * @throws {Error} If adminSecret not provided in config
+     * @throws {PluginTransportError} Network/HTTP failures
+     * @throws {PluginExecutionError} Plugin rejected the request
+     * @throws {PluginUnexpectedError} Malformed response or client-side errors
+     */
+    async getFeeLimit(apiKey) {
+        return this.call({
+            management: {
+                action: "getFeeLimit",
+                adminSecret: this.requireAdminSecret(),
+                apiKey,
+            },
+        });
+    }
+    /**
+     * Set a custom fee limit for a specific API key (requires adminSecret)
+     *
+     * @param apiKey The client API key to set the limit for
+     * @param limit The fee limit in stroops (0 blocks all transactions)
+     * @returns Confirmation with the applied limit
+     * @throws {Error} If adminSecret not provided in config
+     * @throws {PluginTransportError} Network/HTTP failures
+     * @throws {PluginExecutionError} Plugin rejected the request
+     * @throws {PluginUnexpectedError} Malformed response or client-side errors
+     */
+    async setFeeLimit(apiKey, limit) {
+        return this.call({
+            management: {
+                action: "setFeeLimit",
+                adminSecret: this.requireAdminSecret(),
+                apiKey,
+                limit,
+            },
+        });
+    }
+    /**
+     * Delete a custom fee limit for a specific API key (requires adminSecret)
+     *
+     * @param apiKey The client API key to remove the custom limit for
+     * @returns Confirmation of deletion
+     * @throws {Error} If adminSecret not provided in config
+     * @throws {PluginTransportError} Network/HTTP failures
+     * @throws {PluginExecutionError} Plugin rejected the request
+     * @throws {PluginUnexpectedError} Malformed response or client-side errors
+     */
+    async deleteFeeLimit(apiKey) {
+        return this.call({
+            management: {
+                action: "deleteFeeLimit",
+                adminSecret: this.requireAdminSecret(),
+                apiKey,
+            },
+        });
+    }
     /**
      * Ensures adminSecret is configured
      *

package/dist/client/index.d.ts

@@ -5,6 +5,6 @@
  * in both direct HTTP mode and OpenZeppelin Relayer mode.
  */
 export { ChannelsClient } from "./channels-client";
-export { ChannelsClientConfig, DirectHttpConfig, RelayerConfig, ChannelsXdrRequest, ChannelsFuncAuthRequest, ChannelsTransactionResponse, ListChannelAccountsResponse, SetChannelAccountsResponse, } from "./types";
+export { ChannelsClientConfig, DirectHttpConfig, RelayerConfig, ChannelsXdrRequest, ChannelsFuncAuthRequest, ChannelsTransactionResponse, ListChannelAccountsResponse, SetChannelAccountsResponse, GetFeeUsageResponse, GetFeeLimitResponse, SetFeeLimitResponse, DeleteFeeLimitResponse, } from "./types";
 export { PluginClientError, PluginTransportError, PluginExecutionError, PluginUnexpectedError, } from "./errors";
 //# sourceMappingURL=index.d.ts.map

package/dist/client/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EACL,oBAAoB,EACpB,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,uBAAuB,EACvB,2BAA2B,EAC3B,2BAA2B,EAC3B,0BAA0B,GAC3B,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,GACtB,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EACL,oBAAoB,EACpB,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,uBAAuB,EACvB,2BAA2B,EAC3B,2BAA2B,EAC3B,0BAA0B,EAC1B,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,sBAAsB,GACvB,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,GACtB,MAAM,UAAU,CAAC"}

package/dist/client/types.d.ts

@@ -26,6 +26,8 @@ export interface RelayerConfig {
     adminSecret?: string;
     /** Optional request timeout in milliseconds (default: 30000) */
     timeout?: number;
+    /** Header name for API key forwarding to plugin (default: 'x-api-key') */
+    apiKeyHeader?: string;
 }
 /**
  * Configuration for ChannelsClient
@@ -92,6 +94,64 @@ export interface SetChannelAccountsResponse {
         traces?: any[];
     };
 }
+/**
+ * Response from getting fee usage
+ */
+export interface GetFeeUsageResponse {
+    /** Total fees consumed (in stroops) */
+    consumed: number;
+    /** Effective fee limit (in stroops), undefined if unlimited */
+    limit?: number;
+    /** Remaining fee budget (in stroops), undefined if unlimited */
+    remaining?: number;
+    /** When the current reset period started, undefined if no reset period */
+    periodStartAt?: string;
+    /** When the current period will end, undefined if no reset period */
+    periodEndsAt?: string;
+    /** Optional metadata (logs and traces) */
+    metadata?: {
+        logs?: LogEntry[];
+        traces?: any[];
+    };
+}
+/**
+ * Response from getting fee limit
+ */
+export interface GetFeeLimitResponse {
+    /** Fee limit (in stroops), undefined if unlimited */
+    limit?: number;
+    /** Optional metadata (logs and traces) */
+    metadata?: {
+        logs?: LogEntry[];
+        traces?: any[];
+    };
+}
+/**
+ * Response from setting fee limit
+ */
+export interface SetFeeLimitResponse {
+    /** Success indicator */
+    ok: boolean;
+    /** The limit that was set (in stroops) */
+    limit: number;
+    /** Optional metadata (logs and traces) */
+    metadata?: {
+        logs?: LogEntry[];
+        traces?: any[];
+    };
+}
+/**
+ * Response from deleting fee limit
+ */
+export interface DeleteFeeLimitResponse {
+    /** Success indicator */
+    ok: boolean;
+    /** Optional metadata (logs and traces) */
+    metadata?: {
+        logs?: LogEntry[];
+        traces?: any[];
+    };
+}
 /**
  * Plugin response structure for successful operations
  */

package/dist/client/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/client/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gEAAgE;IAChE,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,wCAAwC;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,sDAAsD;IACtD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gEAAgE;IAChE,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG,aAAa,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,+CAA+C;IAC/C,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,sCAAsC;IACtC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,gCAAgC;IAChC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,yBAAyB;IACzB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;KAChB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,oEAAoE;IACpE,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;KAChB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,wBAAwB;IACxB,EAAE,EAAE,OAAO,CAAC;IACZ,6CAA6C;IAC7C,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,0CAA0C;IAC1C,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;KAChB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,OAAO,EAAE,IAAI,CAAC;IACd,IAAI,EAAE,CAAC,CAAC;IACR,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;KAChB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,KAAK,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;KAChB,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,qBAAqB,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/client/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gEAAgE;IAChE,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,wCAAwC;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,sDAAsD;IACtD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gEAAgE;IAChE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0EAA0E;IAC1E,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,GAAG,aAAa,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,+CAA+C;IAC/C,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,sCAAsC;IACtC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,gCAAgC;IAChC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,yBAAyB;IACzB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;KAChB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,oEAAoE;IACpE,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;KAChB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,wBAAwB;IACxB,EAAE,EAAE,OAAO,CAAC;IACZ,6CAA6C;IAC7C,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,0CAA0C;IAC1C,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;KAChB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,+DAA+D;IAC/D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gEAAgE;IAChE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0EAA0E;IAC1E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,qEAAqE;IACrE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;KAChB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,qDAAqD;IACrD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;KAChB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,wBAAwB;IACxB,EAAE,EAAE,OAAO,CAAC;IACZ,0CAA0C;IAC1C,KAAK,EAAE,MAAM,CAAC;IACd,0CAA0C;IAC1C,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;KAChB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,wBAAwB;IACxB,EAAE,EAAE,OAAO,CAAC;IACZ,0CAA0C;IAC1C,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;KAChB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,OAAO,EAAE,IAAI,CAAC;IACd,IAAI,EAAE,CAAC,CAAC;IACR,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;KAChB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,KAAK,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;KAChB,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,qBAAqB,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAC"}

package/dist/plugin/config.d.ts

@@ -6,6 +6,11 @@
 export interface ChannelAccountsConfig {
     fundRelayerId: string;
     network: "testnet" | "mainnet";
+    lockTtlSeconds: number;
+    adminSecret?: string;
+    feeLimit?: number;
+    feeResetPeriodMs?: number;
+    apiKeyHeader: string;
 }
 /**
  * Load configuration from environment variables
@@ -15,12 +20,4 @@ export declare function loadConfig(): ChannelAccountsConfig;
  * Get the network passphrase based on the configuration
  */
 export declare function getNetworkPassphrase(network: "testnet" | "mainnet"): string;
-/**
- * Get the per-channel lock TTL in seconds (default 30)
- */
-export declare function getLockTtlSeconds(): number;
-/**
- * Get the admin secret for management API
- */
-export declare function getAdminSecret(): string | undefined;
 //# sourceMappingURL=config.d.ts.map

package/dist/plugin/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/plugin/config.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAMH,MAAM,WAAW,qBAAqB;IACpC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,SAAS,GAAG,SAAS,CAAC;CAChC;AAcD;;GAEG;AACH,wBAAgB,UAAU,IAAI,qBAAqB,CAelD;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAE3E;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,CAY1C;AAED;;GAEG;AACH,wBAAgB,cAAc,IAAI,MAAM,GAAG,SAAS,CAKnD"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/plugin/config.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAMH,MAAM,WAAW,qBAAqB;IACpC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,SAAS,GAAG,SAAS,CAAC;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;CACtB;AAwDD;;GAEG;AACH,wBAAgB,UAAU,IAAI,qBAAqB,CAkBlD;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,SAAS,GAAG,SAAS,GAAG,MAAM,CAE3E"}

package/dist/plugin/config.js

@@ -7,8 +7,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadConfig = loadConfig;
 exports.getNetworkPassphrase = getNetworkPassphrase;
-exports.getLockTtlSeconds = getLockTtlSeconds;
-exports.getAdminSecret = getAdminSecret;
 const stellar_sdk_1 = require("@stellar/stellar-sdk");
 const relayer_sdk_1 = require("@openzeppelin/relayer-sdk");
 const constants_1 = require("./constants");
@@ -23,6 +21,46 @@ function requireEnv(name) {
     }
     return v.trim();
 }
+function parseOptionalString(name) {
+    const v = process.env[name];
+    if (!v)
+        return undefined;
+    const t = v.trim();
+    return t.length ? t : undefined;
+}
+function parseLockTtl() {
+    const raw = process.env.LOCK_TTL_SECONDS;
+    if (!raw)
+        return constants_1.CONFIG.DEFAULT_LOCK_TTL_SECONDS;
+    const n = Number(raw);
+    if (!Number.isFinite(n) ||
+        n < constants_1.CONFIG.MIN_LOCK_TTL_SECONDS ||
+        n > constants_1.CONFIG.MAX_LOCK_TTL_SECONDS) {
+        return constants_1.CONFIG.DEFAULT_LOCK_TTL_SECONDS;
+    }
+    return Math.floor(n);
+}
+function parseFeeLimit() {
+    const raw = process.env.FEE_LIMIT;
+    if (!raw)
+        return undefined;
+    const n = Number(raw);
+    return Number.isFinite(n) && n >= 0 ? Math.floor(n) : undefined;
+}
+function parseFeeResetPeriod() {
+    const raw = process.env.FEE_RESET_PERIOD_SECONDS;
+    if (!raw)
+        return undefined;
+    const n = Number(raw);
+    return Number.isFinite(n) && n > 0 ? Math.floor(n) * 1000 : undefined;
+}
+function parseApiKeyHeader() {
+    const raw = process.env.API_KEY_HEADER;
+    if (!raw)
+        return "x-api-key";
+    const trimmed = raw.trim().toLowerCase();
+    return trimmed.length > 0 ? trimmed : "x-api-key";
+}
 /**
  * Load configuration from environment variables
  */
@@ -34,10 +72,14 @@ function loadConfig() {
             status: constants_1.HTTP_STATUS.BAD_REQUEST,
         });
     }
-    const fundRelayerId = requireEnv("FUND_RELAYER_ID");
     return {
-        fundRelayerId,
+        fundRelayerId: requireEnv("FUND_RELAYER_ID"),
         network: networkRaw,
+        lockTtlSeconds: parseLockTtl(),
+        adminSecret: parseOptionalString("PLUGIN_ADMIN_SECRET"),
+        feeLimit: parseFeeLimit(),
+        feeResetPeriodMs: parseFeeResetPeriod(),
+        apiKeyHeader: parseApiKeyHeader(),
     };
 }
 /**
@@ -46,28 +88,3 @@ function loadConfig() {
 function getNetworkPassphrase(network) {
     return network === "mainnet" ? stellar_sdk_1.Networks.PUBLIC : stellar_sdk_1.Networks.TESTNET;
 }
-/**
- * Get the per-channel lock TTL in seconds (default 30)
- */
-function getLockTtlSeconds() {
-    const raw = process.env.LOCK_TTL_SECONDS;
-    if (!raw)
-        return constants_1.CONFIG.DEFAULT_LOCK_TTL_SECONDS;
-    const n = Number(raw);
-    if (!Number.isFinite(n) ||
-        n < constants_1.CONFIG.MIN_LOCK_TTL_SECONDS ||
-        n > constants_1.CONFIG.MAX_LOCK_TTL_SECONDS) {
-        return constants_1.CONFIG.DEFAULT_LOCK_TTL_SECONDS;
-    }
-    return Math.floor(n);
-}
-/**
- * Get the admin secret for management API
- */
-function getAdminSecret() {
-    const v = process.env.PLUGIN_ADMIN_SECRET;
-    if (!v)
-        return undefined;
-    const t = v.trim();
-    return t.length ? t : undefined;
-}

package/dist/plugin/constants.d.ts

@@ -8,6 +8,7 @@ export declare const HTTP_STATUS: {
     readonly UNAUTHORIZED: 401;
     readonly FORBIDDEN: 403;
     readonly CONFLICT: 409;
+    readonly TOO_MANY_REQUESTS: 429;
     readonly INTERNAL_SERVER_ERROR: 500;
     readonly BAD_GATEWAY: 502;
     readonly SERVICE_UNAVAILABLE: 503;
@@ -15,7 +16,7 @@ export declare const HTTP_STATUS: {
 };
 export declare const CONFIG: {
     readonly DEFAULT_LOCK_TTL_SECONDS: 30;
-    readonly MIN_LOCK_TTL_SECONDS: 10;
+    readonly MIN_LOCK_TTL_SECONDS: 3;
     readonly MAX_LOCK_TTL_SECONDS: 30;
 };
 export declare const POOL: {
@@ -38,8 +39,6 @@ export declare const POLLING: {
     readonly TIMEOUT_MS: 25000;
 };
 export declare const FEE: {
-    readonly MIN_BASE_FEE: 205;
-    readonly MAX_BASE_FEE: 605;
     readonly NON_SOROBAN_FEE: 100000;
 };
 //# sourceMappingURL=constants.d.ts.map