fix(build): bump dev dependencies, update build script, and refresh README docs

This commit is contained in:
2026-02-17 10:04:54 +00:00
parent 1f90b91252
commit 5321e5f0e0
6 changed files with 154 additions and 119 deletions

View File

@@ -1,5 +1,13 @@
# Changelog
## 2026-02-17 - 3.0.4 - fix(build)
bump dev dependencies, update build script, and refresh README docs
- Bumped devDependencies: @git.zone/tsbuild ^2.1.25 → ^4.1.2, @git.zone/tsbundle ^2.0.5 → ^2.8.3, @git.zone/tsrun ^1.2.46 → ^2.0.1, @git.zone/tstest ^1.0.44 → ^3.1.8, @push.rocks/tapbundle ^5.0.15 → ^6.0.3, @types/node ^20.8.7 → ^25.2.3
- Bumped runtime dependency: @push.rocks/qenv ^6.0.5 → ^6.1.3
- Changed build script: replaced "tsbuild --web --allowimplicitany" with "tsbuild tsfolders --allowimplicitany" (kept tsrust invocation)
- README updates: added RustBridge notes (localPaths must be full file paths), production binary naming conventions, rust core uses ring as rustls provider; removed emoji from example console output; clarified stunIntervalSecs is optional; renamed example status variable to edgeStatus; minor wire-protocol formatting and wording/legal text tweaks
## 2026-02-17 - 3.0.3 - fix(rust,ts)
initialize rustls ring CryptoProvider at startup; add rustls dependency and features; make native binary lookup platform-aware

View File

@@ -10,20 +10,20 @@
"license": "MIT",
"scripts": {
"test": "(tstest test/ --web)",
"build": "(tsbuild --web --allowimplicitany && tsrust)",
"build": "(tsbuild tsfolders --allowimplicitany && tsrust)",
"buildDocs": "(tsdoc)"
},
"devDependencies": {
"@git.zone/tsbuild": "^2.1.25",
"@git.zone/tsbundle": "^2.0.5",
"@git.zone/tsrun": "^1.2.46",
"@git.zone/tsbuild": "^4.1.2",
"@git.zone/tsbundle": "^2.8.3",
"@git.zone/tsrun": "^2.0.1",
"@git.zone/tsrust": "^1.3.0",
"@git.zone/tstest": "^1.0.44",
"@push.rocks/tapbundle": "^5.0.15",
"@types/node": "^20.8.7"
"@git.zone/tstest": "^3.1.8",
"@push.rocks/tapbundle": "^6.0.3",
"@types/node": "^25.2.3"
},
"dependencies": {
"@push.rocks/qenv": "^6.0.5",
"@push.rocks/qenv": "^6.1.3",
"@push.rocks/smartrust": "^1.2.1"
},
"repository": {

174
pnpm-lock.yaml generated
View File

@@ -9,33 +9,33 @@ importers:
.:
dependencies:
'@push.rocks/qenv':
specifier: ^6.0.5
specifier: ^6.1.3
version: 6.1.3
'@push.rocks/smartrust':
specifier: ^1.2.1
version: 1.2.1
devDependencies:
'@git.zone/tsbuild':
specifier: ^2.1.25
version: 2.7.3
specifier: ^4.1.2
version: 4.1.2
'@git.zone/tsbundle':
specifier: ^2.0.5
specifier: ^2.8.3
version: 2.8.3
'@git.zone/tsrun':
specifier: ^1.2.46
version: 1.6.2
specifier: ^2.0.1
version: 2.0.1
'@git.zone/tsrust':
specifier: ^1.3.0
version: 1.3.0
'@git.zone/tstest':
specifier: ^1.0.44
version: 1.11.5(socks@2.8.7)(typescript@5.9.3)
specifier: ^3.1.8
version: 3.1.8(socks@2.8.7)(typescript@5.9.3)
'@push.rocks/tapbundle':
specifier: ^5.0.15
version: 5.6.3(socks@2.8.7)
specifier: ^6.0.3
version: 6.0.3(socks@2.8.7)
'@types/node':
specifier: ^20.8.7
version: 20.19.33
specifier: ^25.2.3
version: 25.2.3
packages:
@@ -427,8 +427,8 @@ packages:
'@esm-bundle/chai@4.3.4-fix.0':
resolution: {integrity: sha512-26SKdM4uvDWlY8/OOOxSB1AqQWeBosCX3wRYUZO7enTAj03CtVxIiCimYVG2WpULcyV51qapK4qTovwkUr5Mlw==}
'@git.zone/tsbuild@2.7.3':
resolution: {integrity: sha512-GMM6VU6TcVvYINfV6b1ZVGZXYhdtriYyAHifvrn8IdRar6thIN3ig3N2J/S1kmX2KLrBbx0JyF3tNChHdNR+wA==}
'@git.zone/tsbuild@4.1.2':
resolution: {integrity: sha512-S518ulKveO76pS6jrAELrnFaCw5nDAIZD9j6QzVmLYDiZuJmlRwPK3/2E8ugQ+b7ffpkwJ9MT685ooEGDcWQ4Q==}
hasBin: true
'@git.zone/tsbundle@2.8.3':
@@ -439,16 +439,16 @@ packages:
resolution: {integrity: sha512-dkgaDBTzZJ53lAV72r7OW/W7l/KqpkncFuPojr11JO35OKAbjjDhZbAwPv4oGX9NplyXrhC5VJRPNX/orqNTHA==}
hasBin: true
'@git.zone/tsrun@1.6.2':
resolution: {integrity: sha512-SOHbQqBg3/769/jPQcdpPCmugdEtIJINiG0O6aWx+su91GvGhheha5dAhccsCutJYErr+aJcBqBYuUYfhOfkFQ==}
'@git.zone/tsrun@2.0.1':
resolution: {integrity: sha512-NEcnsjvlC1o3Z6SS3VhKCf6Ev+Sh4EAinmggslrIR/ppMrvjDbXNFXoyr3PB+GLeSAR0JRZ1fGvVYjpEzjBdIg==}
hasBin: true
'@git.zone/tsrust@1.3.0':
resolution: {integrity: sha512-dvmTAiM04Pkd7J1Gail3fu7aasmILQhC5vKL71/g6HYhpvl16/c+Dj3We5G4HsFr0jvAr+Xu570ZGEuZrtRcCg==}
hasBin: true
'@git.zone/tstest@1.11.5':
resolution: {integrity: sha512-7YHFNGMjUd3WOFXi0DlUieQcdxzwYqxL7n2XDE7SOUd8XpMxVsGsY2SuwBKXlbT10By/H3thQTsy+Hjy9ahGWA==}
'@git.zone/tstest@3.1.8':
resolution: {integrity: sha512-nmiLGeOkKMkLDyIk5BUBLx5ExskFbKHKlPdrWCARPVFkU4cAAiuIyJWVfLwISoS0TO/zSInLqArPwIc76yvaNw==}
hasBin: true
'@hapi/bourne@3.0.0':
@@ -693,6 +693,9 @@ packages:
'@push.rocks/smartbucket@3.3.10':
resolution: {integrity: sha512-0H2MioALspC8Aj0Q1FPCs2w4k2u9oJg7Q5yM8+1TZo7aRfrdxgM5HQ7z3apUaqC3ZEDewW6vSlttjHFHhMEC3A==}
'@push.rocks/smartbucket@4.4.1':
resolution: {integrity: sha512-68GFLgJKW+LXvuN+yuV8O/FozGMecraoT+PkI5whdRPFe7N3u2iYIHWAUjvQvVU4ygpdJv0kih2JDf5k3PYycw==}
'@push.rocks/smartbuffer@3.0.5':
resolution: {integrity: sha512-pWYF08Mn8s/KF/9nHRk7pZPzuMjmYVQay2c5gGexdayxn1W4eCSYYhWH73vR2JBfGeGq/izbRNuUuEaIEeTIKA==}
@@ -733,9 +736,6 @@ packages:
'@push.rocks/smartexit@1.1.0':
resolution: {integrity: sha512-GD8VLIbxQuwvhPXwK4eH162XAYSj+M3wGKWGNO3i1iY4bj8P3BARcgsWx6/ntN3aCo5ygWtrevrfD5iecYY2Ng==}
'@push.rocks/smartexpect@1.6.1':
resolution: {integrity: sha512-NFQXEPkGiMNxyvFwKyzDWe3ADYdf8KNvIcV7TGNZZT3uPQtk65te4Q+a1cWErjP/61yE9XdYiQA66QQp+TV9IQ==}
'@push.rocks/smartexpect@2.5.0':
resolution: {integrity: sha512-yoyuCoQ3tTiAriuvF+/09fNbVfFnacudL2SwHSzPhX/ugaE7VTSWXQ9A34eKOWvil0MPyDcOY36fVZDxvrPd8A==}
@@ -850,6 +850,9 @@ packages:
'@push.rocks/smarts3@2.2.7':
resolution: {integrity: sha512-9ZXGMlmUL2Wd+YJO0xOB8KyqPf4V++fWJvTq4s76bnqEuaCr9OLfq6czhban+i4cD3ZdIjehfuHqctzjuLw8Jw==}
'@push.rocks/smarts3@3.0.3':
resolution: {integrity: sha512-Y9nXMwurthJ9Z7yi0RwjhPFUC58aY8Mhia8kFo6Xj1tBM4LE8Oxg/ydejF7otHqQGr3QyqV5C4YrDEG17rUuzg==}
'@push.rocks/smartshell@3.3.0':
resolution: {integrity: sha512-m0w618H6YBs+vXGz1CgS4nPi5CUAnqRtckcS9/koGwfcIx1IpjqmiP47BoCTbdgcv0IPUxQVBG1IXTHPuZ8Z5g==}
@@ -892,8 +895,8 @@ packages:
'@push.rocks/smartyaml@3.0.4':
resolution: {integrity: sha512-1JRt+hnoc2zHw3AW+vXKlCdSVwqOmY/01fu+2HBviS0UDjoZCa+/rp6E3GaQb5lEEafKi8ENbffAfjXXp3N2xQ==}
'@push.rocks/tapbundle@5.6.3':
resolution: {integrity: sha512-hFzsf59rg1K70i45llj7PCyyCZp7JW19XRR+Q1gge1T0pBN8Wi53aYqP/2qtxdMiNVe2s3ESp6VJZv3sLOMYPQ==}
'@push.rocks/tapbundle@6.0.3':
resolution: {integrity: sha512-SuP14V6TPdtd1y1CYTvwTKJdpHa7EzY55NfaaEMxW4oRKvHgJiOiPEiR/IrtL9tSiDMSfrx12waTMgZheYaBug==}
'@push.rocks/taskbuffer@3.5.0':
resolution: {integrity: sha512-Y9WwIEIyp6oVFdj06j84tfrZIvjhbMb3DF52rYxlTeYLk3W7RPhSg1bGPCbtkXWeKdBrSe37V90BkOG7Qq8Pqg==}
@@ -1495,12 +1498,12 @@ packages:
'@types/node-forge@1.3.14':
resolution: {integrity: sha512-mhVF2BnD4BO+jtOp7z1CdzaK4mbuK0LLQYAvdOLqHTavxFNq4zA1EmYkpnFjP8HOUzedfQkRnp0E2ulSAYSzAw==}
'@types/node@20.19.33':
resolution: {integrity: sha512-Rs1bVAIdBs5gbTIKza/tgpMuG1k3U/UMJLWecIMxNdJFDMzcM5LOiLVRYh3PilWEYDIeUDv7bpiHPLPsbydGcw==}
'@types/node@22.19.11':
resolution: {integrity: sha512-BH7YwL6rA93ReqeQS1c4bsPpcfOmJasG+Fkr6Y59q83f9M1WcBRHR2vM+P9eOisYRcN3ujQoiZY8uk5W+1WL8w==}
'@types/node@25.2.3':
resolution: {integrity: sha512-m0jEgYlYz+mDJZ2+F4v8D1AyQb+QzsNqRuI7xg1VQX/KlKS0qT9r1Mo16yo5F/MtifXFgaofIFsdFMox2SxIbQ==}
'@types/parse5@6.0.3':
resolution: {integrity: sha512-SuT16Q1K51EAVPz1K29DJ/sXjhSQ0zjvsypYJ6tlwVsRV9jwW5Adq2ch8Dq8kDBCkYnELS7N7VNCSB5nC56t/g==}
@@ -3983,6 +3986,9 @@ packages:
undici-types@6.21.0:
resolution: {integrity: sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ==}
undici-types@7.16.0:
resolution: {integrity: sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw==}
unified@11.0.5:
resolution: {integrity: sha512-xKvGhPWw3k84Qjh8bI3ZeJjqnyadK+GEFtazSfZv/rKeTkTjOJho6mFqh2SM96iIcZokxiOpg78GazTSg8+KHA==}
@@ -4916,13 +4922,14 @@ snapshots:
dependencies:
'@types/chai': 4.3.20
'@git.zone/tsbuild@2.7.3':
'@git.zone/tsbuild@4.1.2':
dependencies:
'@git.zone/tspublish': 1.11.0
'@push.rocks/early': 4.0.4
'@push.rocks/smartcli': 4.0.20
'@push.rocks/smartdelay': 3.0.5
'@push.rocks/smartfile': 11.2.7
'@push.rocks/smartfile': 13.1.2
'@push.rocks/smartfs': 1.3.1
'@push.rocks/smartlog': 3.1.11
'@push.rocks/smartpath': 6.0.0
'@push.rocks/smartpromise': 4.2.3
@@ -4984,9 +4991,9 @@ snapshots:
- supports-color
- vue
'@git.zone/tsrun@1.6.2':
'@git.zone/tsrun@2.0.1':
dependencies:
'@push.rocks/smartfile': 11.2.7
'@push.rocks/smartfile': 13.1.2
'@push.rocks/smartshell': 3.3.0
tsx: 4.21.0
@@ -5005,26 +5012,28 @@ snapshots:
- supports-color
- vue
'@git.zone/tstest@1.11.5(socks@2.8.7)(typescript@5.9.3)':
'@git.zone/tstest@3.1.8(socks@2.8.7)(typescript@5.9.3)':
dependencies:
'@api.global/typedserver': 3.0.80
'@git.zone/tsbundle': 2.8.3
'@git.zone/tsrun': 1.6.2
'@git.zone/tsrun': 2.0.1
'@push.rocks/consolecolor': 2.0.3
'@push.rocks/qenv': 6.1.3
'@push.rocks/smartbrowser': 2.0.8(typescript@5.9.3)
'@push.rocks/smartchok': 1.2.0
'@push.rocks/smartcrypto': 2.0.4
'@push.rocks/smartdelay': 3.0.5
'@push.rocks/smartenv': 5.0.13
'@push.rocks/smartenv': 6.0.0
'@push.rocks/smartexpect': 2.5.0
'@push.rocks/smartfile': 11.2.7
'@push.rocks/smartjson': 5.2.0
'@push.rocks/smartlog': 3.1.11
'@push.rocks/smartmongo': 2.2.0(socks@2.8.7)
'@push.rocks/smartpath': 5.1.0
'@push.rocks/smartnetwork': 4.4.0
'@push.rocks/smartpath': 6.0.0
'@push.rocks/smartpromise': 4.2.3
'@push.rocks/smartrequest': 2.1.0
'@push.rocks/smarts3': 2.2.7
'@push.rocks/smartrequest': 5.0.1
'@push.rocks/smarts3': 3.0.3
'@push.rocks/smartshell': 3.3.0
'@push.rocks/smarttime': 4.2.3
'@types/ws': 8.18.1
@@ -5169,7 +5178,7 @@ snapshots:
'@jest/schemas': 29.6.3
'@types/istanbul-lib-coverage': 2.0.6
'@types/istanbul-reports': 3.0.4
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/yargs': 17.0.35
chalk: 4.1.2
@@ -5549,6 +5558,21 @@ snapshots:
transitivePeerDependencies:
- aws-crt
'@push.rocks/smartbucket@4.4.1':
dependencies:
'@aws-sdk/client-s3': 3.990.0
'@push.rocks/smartmime': 2.0.4
'@push.rocks/smartpath': 6.0.0
'@push.rocks/smartpromise': 4.2.3
'@push.rocks/smartrx': 3.0.10
'@push.rocks/smartstream': 3.2.5
'@push.rocks/smartstring': 4.1.0
'@push.rocks/smartunique': 3.0.9
'@tsclass/tsclass': 9.3.0
minimatch: 10.2.0
transitivePeerDependencies:
- aws-crt
'@push.rocks/smartbuffer@3.0.5':
dependencies:
uint8array-extras: 1.5.0
@@ -5658,12 +5682,6 @@ snapshots:
'@push.rocks/smartpromise': 4.2.3
tree-kill: 1.2.2
'@push.rocks/smartexpect@1.6.1':
dependencies:
'@push.rocks/smartdelay': 3.0.5
'@push.rocks/smartpromise': 4.2.3
fast-deep-equal: 3.1.3
'@push.rocks/smartexpect@2.5.0':
dependencies:
'@push.rocks/smartdelay': 3.0.5
@@ -5986,6 +6004,16 @@ snapshots:
- aws-crt
- supports-color
'@push.rocks/smarts3@3.0.3':
dependencies:
'@push.rocks/smartbucket': 4.4.1
'@push.rocks/smartfs': 1.3.1
'@push.rocks/smartpath': 6.0.0
'@push.rocks/smartxml': 2.0.0
'@tsclass/tsclass': 9.3.0
transitivePeerDependencies:
- aws-crt
'@push.rocks/smartshell@3.3.0':
dependencies:
'@push.rocks/smartdelay': 3.0.5
@@ -6095,7 +6123,7 @@ snapshots:
dependencies:
yaml: 2.8.2
'@push.rocks/tapbundle@5.6.3(socks@2.8.7)':
'@push.rocks/tapbundle@6.0.3(socks@2.8.7)':
dependencies:
'@open-wc/testing': 4.0.0
'@push.rocks/consolecolor': 2.0.3
@@ -6103,7 +6131,7 @@ snapshots:
'@push.rocks/smartcrypto': 2.0.4
'@push.rocks/smartdelay': 3.0.5
'@push.rocks/smartenv': 5.0.13
'@push.rocks/smartexpect': 1.6.1
'@push.rocks/smartexpect': 2.5.0
'@push.rocks/smartfile': 11.2.7
'@push.rocks/smartjson': 5.2.0
'@push.rocks/smartmongo': 2.2.0(socks@2.8.7)
@@ -6708,14 +6736,14 @@ snapshots:
'@types/accepts@1.3.7':
dependencies:
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/babel__code-frame@7.27.0': {}
'@types/body-parser@1.19.6':
dependencies:
'@types/connect': 3.4.38
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/buffer-json@2.0.3': {}
@@ -6732,17 +6760,17 @@ snapshots:
'@types/clean-css@4.2.11':
dependencies:
'@types/node': 20.19.33
'@types/node': 25.2.3
source-map: 0.6.1
'@types/co-body@6.1.3':
dependencies:
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/qs': 6.14.0
'@types/connect@3.4.38':
dependencies:
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/content-disposition@0.5.9': {}
@@ -6753,11 +6781,11 @@ snapshots:
'@types/connect': 3.4.38
'@types/express': 5.0.6
'@types/keygrip': 1.0.6
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/cors@2.8.19':
dependencies:
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/debounce@1.2.4': {}
@@ -6769,7 +6797,7 @@ snapshots:
'@types/express-serve-static-core@5.1.1':
dependencies:
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/qs': 6.14.0
'@types/range-parser': 1.2.7
'@types/send': 1.2.1
@@ -6783,7 +6811,7 @@ snapshots:
'@types/fs-extra@11.0.4':
dependencies:
'@types/jsonfile': 6.1.4
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/hast@3.0.4':
dependencies:
@@ -6817,7 +6845,7 @@ snapshots:
'@types/jsonfile@6.1.4':
dependencies:
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/keygrip@1.0.6': {}
@@ -6834,7 +6862,7 @@ snapshots:
'@types/http-errors': 2.0.5
'@types/keygrip': 1.0.6
'@types/koa-compose': 3.2.9
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/mdast@4.0.4':
dependencies:
@@ -6848,20 +6876,20 @@ snapshots:
'@types/mute-stream@0.0.4':
dependencies:
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/node-forge@1.3.14':
dependencies:
'@types/node': 20.19.33
'@types/node@20.19.33':
dependencies:
undici-types: 6.21.0
'@types/node': 25.2.3
'@types/node@22.19.11':
dependencies:
undici-types: 6.21.0
'@types/node@25.2.3':
dependencies:
undici-types: 7.16.0
'@types/parse5@6.0.3': {}
'@types/ping@0.4.4': {}
@@ -6876,18 +6904,18 @@ snapshots:
'@types/s3rver@3.7.4':
dependencies:
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/semver@7.7.1': {}
'@types/send@1.2.1':
dependencies:
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/serve-static@2.2.0':
dependencies:
'@types/http-errors': 2.0.5
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/sinon-chai@3.2.12':
dependencies:
@@ -6906,11 +6934,11 @@ snapshots:
'@types/tar-stream@3.1.4':
dependencies:
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/through2@2.0.41':
dependencies:
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/triple-beam@1.3.5': {}
@@ -6938,11 +6966,11 @@ snapshots:
'@types/ws@7.4.7':
dependencies:
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/ws@8.18.1':
dependencies:
'@types/node': 20.19.33
'@types/node': 25.2.3
'@types/yargs-parser@21.0.3': {}
@@ -6952,7 +6980,7 @@ snapshots:
'@types/yauzl@2.10.3':
dependencies:
'@types/node': 20.19.33
'@types/node': 25.2.3
optional: true
'@ungap/structured-clone@1.3.0': {}
@@ -7557,7 +7585,7 @@ snapshots:
engine.io@6.6.4:
dependencies:
'@types/cors': 2.8.19
'@types/node': 20.19.33
'@types/node': 25.2.3
accepts: 1.3.8
base64id: 2.0.0
cookie: 0.7.2
@@ -8271,7 +8299,7 @@ snapshots:
jest-util@29.7.0:
dependencies:
'@jest/types': 29.6.3
'@types/node': 20.19.33
'@types/node': 25.2.3
chalk: 4.1.2
ci-info: 3.9.0
graceful-fs: 4.2.11
@@ -9779,6 +9807,8 @@ snapshots:
undici-types@6.21.0: {}
undici-types@7.16.0: {}
unified@11.0.5:
dependencies:
'@types/unist': 3.0.3

View File

@@ -7,3 +7,6 @@
* STUN-based public IP discovery at the edge (Cloudflare STUN server)
* Cross-compiled Rust binary for linux/amd64 and linux/arm64
* Old `ConnectorPublic`/`ConnectorPrivate` classes no longer exist (removed in v2.0.0/v3.0.0)
* `localPaths` in RustBridge config must be full file paths (not directories) — smartrust's `RustBinaryLocator` checks `isExecutable()` on each entry directly
* Production binaries are named with platform suffixes: `remoteingress-bin_linux_amd64`, `remoteingress-bin_linux_arm64`
* Rust core uses `ring` as the rustls CryptoProvider (explicitly installed in main.rs, aws-lc-rs disabled via default-features=false)

View File

@@ -2,19 +2,15 @@
Edge ingress tunnel for DcRouter — accepts incoming TCP connections at the network edge and tunnels them to a DcRouter SmartProxy instance, preserving the original client IP via PROXY protocol v1.
## Issue Reporting and Security
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
## Install
```sh
pnpm install @serve.zone/remoteingress
```
## 🏗️ Architecture
## Architecture
`@serve.zone/remoteingress` uses a **HubEdge** topology with a high-performance Rust core and a TypeScript API surface:
`@serve.zone/remoteingress` uses a **Hub/Edge** topology with a high-performance Rust core and a TypeScript API surface:
```
┌─────────────────────┐ TLS Tunnel ┌─────────────────────┐
@@ -36,16 +32,16 @@ pnpm install @serve.zone/remoteingress
| **RemoteIngressHub** | Deployed alongside DcRouter/SmartProxy in a private cluster. Accepts edge connections, demuxes streams, and forwards each to SmartProxy with a PROXY protocol v1 header so the real client IP is preserved. |
| **Rust Binary** (`remoteingress-bin`) | The performance-critical networking core. Managed via `@push.rocks/smartrust` RustBridge IPC — you never interact with it directly. Cross-compiled for `linux/amd64` and `linux/arm64`. |
### 🔑 Key Features
### Key Features
- 🔒 **TLS-encrypted tunnel** between edge and hub (auto-generated self-signed cert or bring your own)
- 🔀 **Multiplexed streams** — thousands of client connections flow over a single tunnel
- 🌐 **PROXY protocol v1** — SmartProxy sees the real client IP, not the tunnel IP
- 🔐 **Shared-secret authentication** — edges must present valid credentials to connect
- 📡 **STUN-based public IP discovery** — the edge automatically discovers its public IP via Cloudflare STUN
- 🔄 **Auto-reconnect** with exponential backoff if the tunnel drops
- 📢 **Event-driven** — both Hub and Edge extend `EventEmitter` for real-time monitoring
- **Rust core** — all frame encoding, TLS, and TCP proxying happen in native code for maximum throughput
- **TLS-encrypted tunnel** between edge and hub (auto-generated self-signed cert or bring your own)
- **Multiplexed streams** — thousands of client connections flow over a single tunnel
- **PROXY protocol v1** — SmartProxy sees the real client IP, not the tunnel IP
- **Shared-secret authentication** — edges must present valid credentials to connect
- **STUN-based public IP discovery** — the edge automatically discovers its public IP via Cloudflare STUN
- **Auto-reconnect** with exponential backoff if the tunnel drops
- **Event-driven** — both Hub and Edge extend `EventEmitter` for real-time monitoring
- **Rust core** — all frame encoding, TLS, and TCP proxying happen in native code for maximum throughput
## Usage
@@ -60,21 +56,21 @@ const hub = new RemoteIngressHub();
// Listen for events
hub.on('edgeConnected', ({ edgeId }) => {
console.log(`Edge ${edgeId} connected`);
console.log(`Edge ${edgeId} connected`);
});
hub.on('edgeDisconnected', ({ edgeId }) => {
console.log(`Edge ${edgeId} disconnected`);
console.log(`Edge ${edgeId} disconnected`);
});
hub.on('streamOpened', ({ edgeId, streamId }) => {
console.log(`🔗 Stream ${streamId} opened from edge ${edgeId}`);
console.log(`Stream ${streamId} opened from edge ${edgeId}`);
});
hub.on('streamClosed', ({ edgeId, streamId }) => {
console.log(`🔗 Stream ${streamId} closed from edge ${edgeId}`);
console.log(`Stream ${streamId} closed from edge ${edgeId}`);
});
// Start the hub — it will listen for incoming edge TLS connections
await hub.start({
tunnelPort: 8443, // port edges connect to (default: 8443)
tunnelPort: 8443, // port edges connect to (default: 8443)
targetHost: '127.0.0.1', // SmartProxy host to forward streams to (default: 127.0.0.1)
});
@@ -108,13 +104,13 @@ const edge = new RemoteIngressEdge();
// Listen for events
edge.on('tunnelConnected', () => {
console.log('🟢 Tunnel to hub established');
console.log('Tunnel to hub established');
});
edge.on('tunnelDisconnected', () => {
console.log('🔴 Tunnel to hub lost — will auto-reconnect');
console.log('Tunnel to hub lost — will auto-reconnect');
});
edge.on('publicIpDiscovered', ({ ip }) => {
console.log(`🌐 Public IP: ${ip}`);
console.log(`Public IP: ${ip}`);
});
// Start the edge — it connects to the hub and starts listening for clients
@@ -124,12 +120,12 @@ await edge.start({
edgeId: 'edge-nyc-01', // unique edge identifier
secret: 'supersecrettoken1', // must match the hub's allowed edge secret
listenPorts: [80, 443], // public ports to accept TCP connections on
stunIntervalSecs: 300, // STUN refresh interval in seconds (default: 300)
stunIntervalSecs: 300, // STUN refresh interval in seconds (optional)
});
// Check status at any time
const status = await edge.getStatus();
console.log(status);
const edgeStatus = await edge.getStatus();
console.log(edgeStatus);
// {
// running: true,
// connected: true,
@@ -167,7 +163,7 @@ await edge.stop();
**Events:** `tunnelConnected`, `tunnelDisconnected`, `publicIpDiscovered`
### 🔌 Wire Protocol
### Wire Protocol
The tunnel uses a custom binary frame protocol over TLS:
@@ -177,11 +173,11 @@ The tunnel uses a custom binary frame protocol over TLS:
| Frame Type | Value | Direction | Purpose |
|------------|-------|-----------|---------|
| `OPEN` | `0x01` | Edge Hub | Open a new stream; payload is PROXY v1 header |
| `DATA` | `0x02` | Edge Hub | Client data flowing upstream |
| `CLOSE` | `0x03` | Edge Hub | Client closed the connection |
| `DATA_BACK` | `0x04` | Hub Edge | Response data flowing downstream |
| `CLOSE_BACK` | `0x05` | Hub Edge | Upstream (SmartProxy) closed the connection |
| `OPEN` | `0x01` | Edge -> Hub | Open a new stream; payload is PROXY v1 header |
| `DATA` | `0x02` | Edge -> Hub | Client data flowing upstream |
| `CLOSE` | `0x03` | Edge -> Hub | Client closed the connection |
| `DATA_BACK` | `0x04` | Hub -> Edge | Response data flowing downstream |
| `CLOSE_BACK` | `0x05` | Hub -> Edge | Upstream (SmartProxy) closed the connection |
Max payload size per frame: **16 MB**.
@@ -195,21 +191,19 @@ Max payload size per frame: **16 MB**.
## License and Legal Information
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
### Company Information
Task Venture Capital GmbH
Registered at District Court Bremen HRB 35230 HB, Germany
Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or further information, please contact us via email at hello@task.vc.
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

View File

@@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@serve.zone/remoteingress',
version: '3.0.3',
version: '3.0.4',
description: 'Edge ingress tunnel for DcRouter - accepts incoming TCP connections at network edge and tunnels them to DcRouter SmartProxy preserving client IP via PROXY protocol v1.'
}