* First sweep packages + some minor tweaking
* Second sweep
* Regenerate lockfile + package.json mods
* Regenerate lockfile again
* Fix CI
* Fix CI again
* All building properly
* unblock
* Tweak examples
* Comments + readme + fix rotten unit test
* First pass docs
* Big pass
* Massive pass on new docs
* Update integrations.md w mobile
* Partial overhaul review
* new playground + big pass
* new fix lychee err
* IPR notice tweak
* Diatixisify!
* First pass at Typedoc generation for TS SDK
* Remove overview pages
* Fix typos and remove codebase references from docs
Fix typos across network and developer docs: Quorum, available,
cryptosystem, transaction, proportional, Standalone. Remove TODO
placeholder from dVPN protocol page. Strip GitHub source links
from network docs to decouple documentation from repo structure.
* Expand thin landing pages across network and developer docs
- Add intro content to network overview, infrastructure, and reference landing pages
- Expand developer index with "where to start" guide
- Add usage instructions and explanations to all five TS playground pages
- Expand WebSocket client page with setup and message format examples
* Restructure Rust SDK developer docs
- Delete redundant mixnet example, message-helpers, and message-types subpages
- Delete client-pool architecture and example subpages (content folded into landing)
- Delete tcpproxy troubleshooting (folded into landing page)
- Add deprecation notices to TcpProxy pages, pointing to Stream module
- Add stream module docs: landing page, architecture, tutorial, and 4 example pages
- Add mixnet and client-pool tutorials
- Add SDK tour page
- Update navigation and landing pages with docs.rs links
* Restructure TS SDK developer docs
- Merge overview, installation, and getting started into TS SDK landing page
- Fold FAQ content into bundling/troubleshooting section
- Delete redundant overview, installation, start, and FAQ pages
- Update internal links in browsers.mdx and native.mdx
- Update navigation and example page imports
* Flatten and expand APIs section
- Collapse nested API subpages into single pages with inline Redoc embeds
- Rewrite introduction as landing page with decision table
- Add endpoint categories, quick curl examples to each API page
- Mark Explorer API as deprecated
- Move NS API deployment guide to operators/performance-and-testing
- Fix dangling /apis/nym-api/mainnet link in network-components
- Remove sandbox endpoints from all API pages
* Add redirects for moved and deleted pages
- Add 25 redirects covering TS SDK, Rust SDK, APIs, and network sections
- Fix dangling /developers/typescript/start link in operators changelog
* Replace individual example doc pages with GitHub-linked tables, expand tutorials
- replace individual example doc pages with GitHub-linked tables
- expand mixnet tutorial with persistent identity and split_sender sections
- add tcpproxy tutorial
- rename "API Reference" to "TypeDoc Reference" in TS SDK sidebar
- rename "Misc" to "Extras" in developer sidebar, move VPN CLI up
- remove echo server from tools
- update message-queue callout to reference actual modules
- fix mixnet/examples redirect collision
* Add SEO frontmatter, validate encryption standards, clean up URLs
- add title/description/schemaType/section/lastUpdated frontmatter to 48
pages across developers, network, and APIs sections
- remove network/.archive/ directory (compare against develop instead)
- update nymtech.net → nym.com for website/blog links (keep infra URLs)
- add native proxy "in progress" callout for Rust/C/Go
* API-scraper update (#6598)
* read nodes and locations
* update python-prebuild.sh
* Address PR #6494 review feedback
- Use "mode" consistently instead of "role" on nym-nodes page
- Replace "staking" with "bonding" for NYM token collateral
- Wire up auto-scraped node counts via TimeNow + nodes-count.json
- Fix broken licensing images: download CC icons locally, replace inline HTML
- Fix 9 stale redirects pointing through deleted /network/architecture path
* Fix linkcheck errors
- Fix stale cross-links: /network/concepts/ → /network/mixnet-mode/
- Replace README.md references with globals.md in TypeDoc output
- Add entryFileName: globals to typedoc.json configs to prevent recurrence
* Fix remaining stale /network/architecture links
- zk-nym-overview: architecture/nyx#nym-api → /network/infrastructure/nyx#nym-api
- setup: network/architecture → /network/overview
* Remove accidentally re-included architecture.md file from rebase
* Standardize tutorials, document examples, add llms.txt, apply tone fixes
- Expand Rust SDK tutorials with step-by-step structure; document all SDK examples across mixnet, client-pool, and tcpproxy pages
- Add llms.txt generation script, wire into build and CI workflows
- Apply tone/style fixes: deduplicate callouts, vary sentence structure, standardize voice consistency across changed pages
* Consolidate redundant network overview docs
* Trim dev docs: git-first imports, stream notice, collapse TcpProxy
* Update tutorial
* Refresh auto-generated API and command outputs
* Update network section docs
* Update developer and API docs: reusable components, stream protocol, conventions, tutorial fixes
* Fix Rust SDK tutorial bugs: setup_env, port conflicts, logging,
open_stream race condition
* Update stream.mdx
* Remove docs.rs link from Stream overview for the moment
* add llms.txt and llms-full.txt note to readme
---------
Co-authored-by: import this <97586125+serinko@users.noreply.github.com>
* feat: unify HTTP client creation and enable domain fronting
Enhanced the base nym_http_api_client to reduce fragmentation and enable domain fronting:
- Added SerializationFormat enum for explicit JSON/bincode choice (no auto-detection)
- Added from_network() method to create clients from NymNetworkDetails with domain fronting
- Added with_bincode() builder method for explicit serialization configuration
- Set Accept header based on serialization preference
- Added deprecation paths for NymApiClient wrapper and nym_api::Client re-export
- Enabled domain fronting support via network defaults feature
This is part of a broader effort to consolidate HTTP client implementations across the codebase,
reducing ~500 lines of wrapper code and providing automatic domain fronting for censorship resistance.
* feat: migrate NymApiClient usage to unified HTTP client
- Wire up domain fronting configuration in NymNetworkDetails
- Implement NymApiClientExt trait for base nym_http_api_client::Client
- Migrate direct NymApiClient usage in multiple components:
- nym-network-monitor
- verloc measurements
- connection tester
- coconut/ecash client
- validator rewarder
- Add Copy derive to ApiUrlConst to enable iteration
- Update error handling and Display implementations
This enables automatic domain fronting for all Nym API calls via the configured CDN front hosts.
* fix: resolve all compilation errors after NymApiClient migration
- Add missing nym-http-api-client dependencies to multiple crates
- Add NymApiClientExt trait imports where needed
- Fix type mismatches from NymApiClient to unified Client
- Add error conversions for NymAPIError in various error enums
- Implement missing trait methods (get_current_rewarded_set, get_all_basic_nodes_with_metadata, get_all_described_nodes)
- Fix type conversions for RewardedSetResponse in network monitor
- Update all API client instantiation to use new unified HTTP client
* feat: complete migration to unified HTTP client and fix all compilation errors
- Added missing NymApiClientExt trait methods (get_all_expanded_nodes, change_base_urls)
- Fixed all compilation errors across the workspace
- Updated nym-node to use unified client instead of deprecated NymApiClient
- Fixed type conversions for RewardedSetResponse → EpochRewardedSet
- Added nym-http-api-client dependency where needed
- Updated all examples and documentation to use new client API
* fix: provide all API URLs for automatic failover in endpoint rotation
Previously, when rotating API endpoints, only a single URL was provided to the
HTTP client, defeating the purpose of having multiple URLs for resilience.
Changes:
- NymApiTopologyProvider now provides all URLs in rotated order when switching endpoints
- NymApisClient similarly provides all URLs starting from the working endpoint
- Added clarifying comments for broadcast/exhaustive query methods where single URLs are intentionally used
- This enables the HTTP client's built-in failover mechanism while maintaining endpoint rotation behavior
The fix ensures that if the primary endpoint fails, the client can automatically
failover to alternative endpoints without manual intervention, improving overall
network resilience.
* Update common/client-core/src/client/base_client/mod.rs
Co-authored-by: Jędrzej Stuczyński <jedrzej.stuczynski@gmail.com>
* Remove error generics, address PR comments
* Explicit warning on missing fronting configuration
* Assorted CI fixes
* Registry proc-macro
* Rename macro
* Syn workspace version
* Where do we need to put inventory
* Ergonomics and call sites, incept the builder
* fix: Address critical issues in client configuration registry implementation
- Fixed HeaderMapInit parsing bug that would cause compilation errors
- Added comprehensive documentation with usage examples and DSL reference
- Improved error handling with better error messages for invalid headers
- Added test coverage for both macro and registry functionality
- Added debug inspection capabilities for registered configurations
- Fixed module name conflicts in tests by using separate modules
All tests now passing:
- 7 macro tests validating DSL parsing and code generation
- 4 registry tests verifying configuration collection and application
* Use default value for the ports until api is deployed
* Feature/improved http error (#6025)
* use display impl for urls
* feat: attempt to add more details to reqwest errors
* temporarily restored GenericRequestFailure variant
* another restoration
* cleanup
* Some debug tooling, and default timeout fix
* Fix user-agent override
* Fix various wasm things
---------
Co-authored-by: Jędrzej Stuczyński <jedrzej.stuczynski@gmail.com>
Co-authored-by: Bogdan-Ștefan Neacşu <bogdan@nymtech.net>
- new instance of echo server with lib / cli split
- echo server docs update
- tcpproxy and echosever now listen for kill signal
- ffi bindings of tcpproxy functions updated
* new api link for explorer v2
* remove footer add explorer to navbar
* include image
* @ fix menu icons
* + explorer link in footer
---------
Co-authored-by: RadekSabacky <radek@nymtech.net>
* fix socks5 syntax
* reshape backup and restore and add proxy
* fix URLS
* remove deprecated node-api-check - archived for when there is time to maintain the tool
* add hash verification step
* tcp conn tracker
* make default decay const
* first pass connpool
* err handling conpool start
* added notes for next features
* first version working
* first pass spin out client_pool
* cancel token
* logging change
* bump default decay time
* bugfix: make sure to apply gateway score filtering when choosing initial node
* add duplicate packets received to troubleshooting
* client_pool.rs mod
* client pool example
* clippy
* client pool example done
* added disconnect to client pool
* update mod file
* add cancel token disconnect fn
* comments
* comments
* add clone
* added disconnect thread
* update example files tcpproxy
* client pool docs
* remove comments for future ffi push + lower default pool size from 4 to 2
* comment on ffi
* update command help
* clone impl
* remove clone
* fix clippy
* fix clippy again
* fix test
* tweaked text grammar
* updated comment in example
* future is now
* cherry
* cherry
* fix borked rebase
* fix fmt
* wasm fix
---------
Co-authored-by: Jędrzej Stuczyński <jedrzej.stuczynski@gmail.com>
* + add header into Packet Mixing docs
* + add head changes for testing
* / updated version of metatags in theme.config
* + add env file
* / theme.config to use NEXT_PUBLIC_SITE_URL from env file
* @ Fix broken link in theme.config
* - remove favicon code
* + add desription for intro pages
* first pass redoc apis
* new landing + component update
* added intro
* new structure
* link list
* add sandbox sdk
* remove theme colours
* revert credit to ticket & ticketbook and actually get all the instances to replace
* Max/zknym doc tweak (#5223)
* revert credit to ticket & ticketbook
* revert credit to ticket & ticketbook and actually get all the instances to replace
* theme tweak to widen text area
* theme redoc component
* tweak padding topbar
* modified socks5 page to be in line with websocket client
* modify h size of autodoc generated command info
* tweak script to build from master
* add autodoc to workspace
* auto commit generated command files
* clean autodoc-generated-markdown in script
* auto commit generated command files
* tweak works
* clippy
* fix borked toml from cherrypick
* remove rm command
* auto commit generated command files
* blow away images
* auto commit generated command files
* remove redoc for nymapi for the moment but retain everything else
* fix double paste
* temp remove sandbox
* started todo list for rework
* startd long todo list
* startd long todo list
* remove ts docs from ts sdk dir
* started new docs draft
* rearranged code example dir structure
* modified code component filepaths
* first pass rust sdk
* small shift typescript org
* updated todo list
* consolidating images folders in one place
* first pass @ operator docs
* gen updates
* sdk in its own dir
* first pass developers structure
* first pass network structure
* structure
* add licensing
* moved old docs -> old_docs dir for clarity when devving
* moving around new docs - think this is the final dir structure
* updated todo list
* new autodoc version (#4781)
* Update rework_todo.md
* quick first sketch of landing page
* rework of structure of developers
* added arch and concepts stubs
* add new bits to todo list
* new list
* tweak to overview
* mixnet node overview
* tweak overview
* first pass new arch
* first pass concepts
* first pass traffic
* more network docs
* moved some chain files to the dev portal stubs
* removed old reference to archive
* note to client
* concepts 2nd pass
* crypto first proper pass, sphinx
* stub for not p2p
* structure change
* traffic 2nd pass
* misc
* hid root index
* overhaul arch
* overhaul arch
* add links + tweaks
* update todo list
* updating nyx section
* added zknym docs
* added zknym docs
* note on where to find deployed info
* smart contracts done
* started moving integrations docs over from ts sdk
* pass @ integration page
* todo for the tldr overview
* added ffi stub files
* updated todo list
* move sdks to developers
* initial pass at new clients overview for developers
* rework intro
* add echo serv to tools
* sidebar autocollapse
* integration overview work + tools
* concepts overview for devporta
* stub
* more for networking pages
* added to concepts in dev portal
* updated arch
* crypto overview page
* typo fix
* add credential stub
* first pass concepts done
* start reorg of rust sdk docs
* reorg + added FFI table
* added no scroll to inline code
* finished ffi overview page
* first pass @ rest of rust sdk doc
* first pass ffi
* tweaks
* added testnet example + note to custom topology example overview
* stripped unnecessary stuff from TS
* tweaks to ffi
* updated faq
* first pass tcpproxy
* commit before moving image dir
* moved images/ to correct place
* started on client redo
* chain first pass
* moved cli wallet out of tools
* first pass new ws client
* new chain info, left todo links in
* links
* more links
* chain registry
* added echo server to tools
* rust sdk links
* ts sdk links
* final linkchecks
* redo acks diagram as mermaid
* add mermaid flow diagram
* added links for codecs + full flow diagram
* removed todo
* remove forced dark mode
* diagram + concepts overview
* small correction re tcpproxy ffi
* remove diagram title
* new sock5 diagram, minor client docs tweaks
* diagrams
* change order in list
* added note for standalone: can be accessed via sdk
* tweaks
* replaced old diagram with mermaid
* fixed link
* hardcoded import version for the moment
* update deps
* remove test component
* recreated tools dir
* remove tools dir moved to wrong palce
* prebuild and predev script for autodoc commands
* make script own command instead of prebuild
* made code blocks sh
* updated autogenerated docs
* temp
* auto commit generated command files
* add link to autodoc generated files
* updated autodoc for committing changing else exit
* auto commit generated command files
* updated readme
* make subcommand headers smaller
* removed mdbook related scripts
* update readme
* update readme
* removed backups of root meta.json
* cherry pick yana commits + some extra config in theme
* update readme
* update theme: width of page and padding
* some more themeing
* changed erroneous note
* docs redirects first pass
* tweaking
* new pages + rest of redirects for old docs/
* brought in archive + done rewrites for devportal
* cherry pick yana landingpage
* tweaked landing page component
* changed theme of mermaid diagram to match everything else
* updated todo list
* [DOCs]: Operators rework to next.js (#4930)
* initialise operators guides v2
* new introduction page
* add variables csv and page
* add baseurl to allow short path
* add sandbox page
* added building from source page
* add binary pages
* add preliminary steps
* clean preliminary steps dir
* syntax edit
* syntax edit
* add configuration page
* create new proxy configuration page
* create new proxy configuration page
* create bonding.mdx page
* correct images path
* syntax edit
* add new validator setup page
* add api setup page
* add nyx configuration page
* add nym node and maintenance pages
* finish maintenance and add nymvisor conf page
* add manual upgrade page
* add nymvisor upgrade page
* add performance testing page and dir
* add node api check page
* add explore nym scripts page
* add testing pages
* fix menu issue by moving snippets to coomponents
* add all troubleshooting pages
* add general faq page
* add nym node faq page
* add nyx faq page
* revamp legal forum to community counsel and add all pages
* rewire relative paths to new structure
* simplify setup and remove lock file
* syntax fix
* rm package.json
* re add package.json, rm package-lock.json
* removed old books from commit
* address review comments
---------
Co-authored-by: mfahampshire <maxhampshire@pm.me>
Co-authored-by: mx <33262279+mfahampshire@users.noreply.github.com>
* tweak client links
* also moved matrix images to correct place
* Max/fix links new docs framework (#4989)
* tweak client links
* standardise images in public/
* old images move to public/archive
* rename overview to more descriptive
* links (#4990)
* links
* removed todos
* updated todo list
* minor themeing
* operator redirects
* pick yana's edits: remove specified callout theming
* added todo comments for old ts sdk redirects
* [new/docs/operators]: Create archive section - PR ready to merge (#5004)
* [new-docs/operators] : Fix callout syntax (#5006)
* fix callout syntax from color to type
* correct callout from danger to warning
* update footer
* updated footer
* finalised rewrites
* tweaks to clients and reintroduced old examples page
* update todo
* Max/individual command autodocs (#5015)
* auto commit generated command files
* added to autodoc.sh: build all binaries before running
* autodoc move individual command outputs to components
* Max/individual command autodocs (#5018)
* updated autodoc script
* updated autodoc script for fix + reintroduced gitignore file for generated markdown
* auto commit generated command files
* auto commit generated command files
* added command-outputs to autodoc script
* fix merge conflicts
* repush components
* remove old docs dirs
* auto commit generated command files
* auto commit generated command files
* updated messages paradigm with the standalone proxies
* [NEW-DOCs/operators]: Command output, accordion, api scraping & all final tasks (#5026)
* add custom scripts, create prebuild to import data to pages
* update after latest prebuild
* auto commit generated command files
* add accordion component
* add changbelog page
* add node_api_check outputs
* finish all command outputs
* more accordions beautifications
* finish accordion
* PR ready to go
* address review comments
---------
Co-authored-by: mfahampshire <maxhampshire@pm.me>
* Adjust padding
* Fix responsive design
* cherry pick yana landingpage flex update
* reremove old docs
* added dependencies to readme
* pushing build attempt changes
* fix merge errors, path errors, dump uselss dinosaurs - BUILT THE F*N DOCS w success
* moved prebuild to its own script
* generate timenow
* auto commit generated command files
* remove comment
* auto commit generated command files
* auto commit generated command files
* auto commit generated command files
* build from new configs
* add mdx type as explicit dep
* remove rc from version in package
* change predev script
* update readme with scripts
* update general info
* add license
* auto commit generated command files
* add updated components
* removed old examples page for the moment
* remove old list will reintroduce hidden behind gitignore for future
* reintroduce todo list behind gitignore
* added standalone tcpproxy binary info
* nothing change for redeploy test
* make build standalone
* updated readme
* working on new cd
* remove export
* updated ci/cd for docs
* added ci script for dist
* hide text on laptop wide screen
* add pnpm to ci/cd
* add pnpm version to ci/cd
* add default dir to ci/cd
* change path to script
* update projct name ci
* lint ci branch ignore
* add basePath to next.config.js
* update doc rewrites
* revert basePath addition
* update basePath
* add mobile styles
* fix responsive style
* remove old ts sdk docs workflow
* temp remove autodoc from workspace
* update sidebar for clarity: crypto = cryptography
* ignore documentation in pr-validation workflow
---------
Co-authored-by: Yana <yanok87@users.noreply.github.com>
Co-authored-by: import this <97586125+serinko@users.noreply.github.com>
Co-authored-by: fmtabbara <fmtabbara@hotmail.co.uk>
mfahampshire