smartproxy/summary-nftables-naming-consolidation.md

34 lines
1.5 KiB
Markdown

# NFTables Naming Consolidation Summary
This document summarizes the changes made to consolidate the naming convention for IP allow/block lists in the NFTables integration.
## Changes Made
1. **Updated NFTablesProxy interface** (`ts/proxies/nftables-proxy/models/interfaces.ts`):
- Changed `allowedSourceIPs` to `ipAllowList`
- Changed `bannedSourceIPs` to `ipBlockList`
2. **Updated NFTablesProxy implementation** (`ts/proxies/nftables-proxy/nftables-proxy.ts`):
- Updated all references from `allowedSourceIPs` to `ipAllowList`
- Updated all references from `bannedSourceIPs` to `ipBlockList`
3. **Updated NFTablesManager** (`ts/proxies/smart-proxy/nftables-manager.ts`):
- Changed mapping from `allowedSourceIPs` to `ipAllowList`
- Changed mapping from `bannedSourceIPs` to `ipBlockList`
## Files Already Using Consistent Naming
The following files already used the consistent naming convention `ipAllowList` and `ipBlockList`:
1. **Route helpers** (`ts/proxies/smart-proxy/utils/route-helpers.ts`)
2. **Integration test** (`test/test.nftables-integration.ts`)
3. **NFTables example** (`examples/nftables-integration.ts`)
4. **Route types** (`ts/proxies/smart-proxy/models/route-types.ts`)
## Result
The naming is now consistent throughout the codebase:
- `ipAllowList` is used for lists of allowed IP addresses
- `ipBlockList` is used for lists of blocked IP addresses
This matches the naming convention already established in SmartProxy's core routing system.