How remnawave/xtls-sdk works
XTLS SDK is a TypeScript client for XRAY Core’s gRPC API. Callers use the client’s handler, router, and statistics services to manage inbound users and routing rules and retrieve system, user, inbound, outbound, and connection statistics. The services make gRPC calls and return typed SDK responses; generated protobuf modules define the wire messages, while user decoding and response models shape returned data. Edges reflect the README, source index, and excerpts; unsampled implementation details are not inferred.
Main entry points: decode-user.ts User decoder · handler.service.ts HandlerService · stats.service.ts StatsService · router.service.ts RouterService
Components 22
SDK API
- XtlsApi
index.ts
User Management
- HandlerService
src/handler/handler.service.ts - User decoder
src/common/utils/decode-user/decode-user.ts - User response models
src/handler/models/get-inbound-users/get-inbound-users.response.model.ts - Typed-message helper
src/common/utils/create-typed-message/create-typed-message.ts
Statistics
- StatsService
src/stats/stats.service.ts - Statistics response models
src/stats/models
Routing
- RouterService
src/router/router.service.ts
Protobuf Types
- Protocol user
src/xray-protos/common/protocol/user.ts - Typed message
src/xray-protos/common/serial/typed_message.ts - Handler commands
src/xray-protos/app/proxyman/command/command.ts - HTTP account
src/xray-protos/proxy/http/config.ts - Shadowsocks account
src/xray-protos/proxy/shadowsocks/config.ts - Shadowsocks 2022 account
src/xray-protos/proxy/shadowsocks_2022/config.ts - SOCKS account
src/xray-protos/proxy/socks/config.ts - Trojan account
src/xray-protos/proxy/trojan/config.ts - VLESS account
src/xray-protos/proxy/vless/account.ts - Statistics commands
src/xray-protos/app/stats/command/command.ts - Routing commands
src/xray-protos/app/router/command/command.ts - Message registry
src/xray-protos/typeRegistry.ts
Other components
- SDK caller
- XRAY Core gRPC
Connections 33
- SDK caller → XtlsApi: creates
README.md - XtlsApi → HandlerService: exposes
index.ts - XtlsApi → StatsService: exposes
index.ts - XtlsApi → RouterService: exposes
index.ts - SDK caller → HandlerService: manages users
README.md - SDK caller → StatsService: requests stats
README.md - SDK caller → RouterService: manages rules
- HandlerService → XRAY Core gRPC: calls gRPC
src/handler/handler.service.ts - StatsService → XRAY Core gRPC: calls gRPC
src/stats/stats.service.ts - RouterService → XRAY Core gRPC: calls gRPC
src/router/router.service.ts - HandlerService → Handler commands: uses commands
src/handler/handler.service.ts - StatsService → Statistics commands: uses commands
src/stats/stats.service.ts - RouterService → Routing commands: uses commands
src/router/router.service.ts - HandlerService → Typed-message helper: builds messages
src/handler/handler.service.ts - Typed-message helper → Typed message: creates
src/common/utils/create-typed-message/create-typed-message.ts - Handler commands → Protocol user: encodes user
src/xray-protos/app/proxyman/command/command.ts - Protocol user → Typed message: encodes account
src/xray-protos/common/protocol/user.ts - User response models → User decoder: decodes users
src/handler/models/get-inbound-users/get-inbound-users.response.model.ts - User decoder → Protocol user: reads user
src/common/utils/decode-user/decode-user.ts - User decoder → HTTP account: maps account
- User decoder → Shadowsocks account: maps account
- User decoder → Shadowsocks 2022 account: maps account
- User decoder → SOCKS account: maps account
- User decoder → Trojan account: maps account
- User decoder → VLESS account: maps account
- StatsService → Statistics response models: returns models
src/stats/stats.service.ts - Statistics response models → Statistics commands: models responses
src/stats/models/get-all-inbounds-stats/get-all-inbounds-stats.response.model.ts - RouterService → Routing commands: removes rules
src/router/router.service.ts - Protocol user → Message registry: registers type
src/xray-protos/common/protocol/user.ts - Typed message → Message registry: registers type
src/xray-protos/common/serial/typed_message.ts - Handler commands → Message registry: uses registry
src/xray-protos/app/proxyman/command/command.ts - Routing commands → Message registry: uses registry
src/xray-protos/app/router/command/command.ts - Statistics commands → Message registry: uses registry
src/xray-protos/app/stats/command/command.ts