Yana Matrosova
ec51855500
The generated NodeAnnotationV1/V2.ts imported DetailedNodePerformanceV1/V2, DisplayRole, RoutingScore, ConfigScore and StressTestingScore, but those types (all of which derive ts_rs::TS with an export_to) were missing from tools/ts-rs-cli, so the files were never emitted — leaving dangling imports that broke `tsc` for the whole @nymproject/types package. Add the 6 types to ts-rs-cli (use + do_export!) and regenerate. The package now builds with 0 tsc errors, and the full nym-wallet Jest run goes from "84 pass + 4 suites unable to run" to 101 pass / 0 fail — recovering delegationIdentity and unbondedDelegation.acceptance. The 3 touched FamilyInvitation*/PastFamilyInvitation files are doc-comment syncs from the regeneration (the `at: number` overrides and enum variants are unchanged). Out of scope / still failing for a separate reason: api/nodeStatus.test.ts and api/networkOverview.test.ts reference the network value 'QA', which the Network enum (nym-wallet-types → SANDBOX | MAINNET) no longer includes — an app-code drift unrelated to families or type generation. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Nym Wallet
Nym is an open-source, decentralized and permissionless privacy system. It provides full-stack privacy, allowing other applications, services or blockchains to provide their users with strong metadata protection, at both the network level (mixnet), and the application level (anonymous credentials) without the need to build privacy from scratch.
The Nym desktop wallet enables you to use the Nym network and take advantage of its key capabilities
Installation prerequisites - Linux / Mac
YarnNodeJS >= v16.8.0Rust & cargo >= v1.56
Linux: WebKit and EGL troubleshooting
Some rolling distributions (for example Arch-based) or Wayland compositors can hit WebKitGTK / EGL errors at startup (for example EGL_BAD_PARAMETER, EGL_BAD_ALLOC, or Could not create default EGL display).
Wayland (all Linux bundles, including AppImage): On startup, when WAYLAND_DISPLAY is set, the wallet sets GDK_BACKEND, GDK_SCALE, GDK_DPI_SCALE, and defaults WEBKIT_DISABLE_DMABUF_RENDERER=1 before the webview initializes. Override if needed: WEBKIT_DISABLE_DMABUF_RENDERER=0, or set your own GDK_* / LD_PRELOAD before launching. (Tauri’s AppImage bundler only copies paths under /usr/ into the image, so an apprun-hooks/ file in config would not be included; defaults live in main() instead.)
.deb, installed binary, or target/release binary: You can also set the same variables in a wrapper script or .desktop file, for example:
Exec=env WEBKIT_DISABLE_DMABUF_RENDERER=1 GDK_BACKEND=wayland GDK_SCALE=1 GDK_DPI_SCALE=0.8 /path/to/NymWallet
If problems persist on Wayland, try preloading the system client library (path may vary by distro):
LD_PRELOAD=/usr/lib/libwayland-client.so (or /usr/lib64/...).
Diagnostic (slow): LIBGL_ALWAYS_SOFTWARE=1 forces software GL to confirm a GPU / EGL stack mismatch.
Installation prerequisites - Windows
- When running on Windows you will need to install c++ build tools
- An easy guide to get rust up and running Installation
- When installing NodeJS please use the
current featuresversion - Using a package manager like Chocolatey is recommended
- The nym wallet requires you to have
Webview2installed, please head to the Installer, this will ensure a smooth app launch
Installation
Inside the nym-wallet directory, run the following command:
yarn install
Populate environment variables
The wallet requires you to supply a .env file, this populates values in the wallet once it's compiled.
In the project roots there's a .env.sample file, these values currently match what the .env file should be populated with. However, if you want to change these values you can do so accordingly.
- In the root directory, create a new file named
.env - Input the values against the variables
Terminal
The terminal is shown either in development mode, or by setting the SHOW_TERMINAL to any value, e.g. true.
When enabled, the terminal icon is shown in the nav and clicking it displays a modal that shows the inner state of the wallet. In the future, this will also allow interactions, e.g. queries or executing commands such as delegation or undelegating.
It is intended to be used during development and for troubleshooting.
Development mode
You can compile the wallet in development mode by running the following command inside the nym-wallet directory:
pnpm run dev
This will produce a binary in - nym-wallet/target/debug/ named NymWallet
To launch the wallet, navigate to the directory and run the following command: ./NymWallet
Production mode
Run the following command from the nym-wallet folder
yarn build
The output will compile different types of binaries dependent on your hardware / OS system. Once the binaries are built, they can be located as follows:
Admin mode
The admin screens can be shown by setting the environment variable ADMIN_ADDRESS. You'll need to know the admin account address for the network you are using.
QA mode
On built versions of the wallet, you can set the environment variable ENABLE_QA_MODE=true to add the QA network to the list of available networks.
Binary output directory structure
**macos**
|
└─── target/release
| |─ nym-wallet
└───target/release/bundle/dmg
│ │─ bundle_dmg.sh
│ │─ nym-wallet.*.dmg
└───target/release/bundle/macos/MacOs
│ │─ nym-wallet
|
**Linux**
└─── target/release
| │─ nym-wallet
└───target/release/bundle/appimage
│ │─ nym-wallet_*_.AppImage
│ │─ build_appimage.sh
└───target/release/bundle/deb
│ │─ nym-wallet_*_.deb
|
**Windows**
└─── target/release
| │─ nym-wallet.exe
└───target/release/bundle/msi
│ │─ nym-wallet_*_.msi
For instructions on how to release the wallet, please see RELEASE.md.