[{"_1":2,"_174":-5,"_175":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_153":154},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_85":86,"_106":107,"_144":-5,"_145":11,"_146":17,"_147":11,"_148":-5,"_149":11,"_150":-5,"_151":152},"canonicalUrl","https://hub.docker.com/r/dusknode/rusk/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","dusknode","reponame","rusk","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":69,"_70":71,"_76":11,"_77":78,"_82":29,"_83":84},"categories",[],"content_types",[40],"image","date_registered","2024-09-18T11:30:16.433044Z","description","The reference Dusk platform implementation and tools","is_private","last_updated","2026-06-17T11:25:45.810606Z","last_modified","2026-06-17T11:25:50.168397Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",6028,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","

\n $\"Rusk\"$ \n $\"Rusk\"$ \n

\n\n

\n The official Dusk protocol node client and smart contract platform.\n

\n\n

\n\n $\"Rusk$ \n \n\n $\"GitHub$ \n \n\n $\"Join$ \n \n\n $\"X$ \n \n\n $\"Static$ \n\n

\n\n# 🖧 How to run a node\n\nThis README is for people who want to develop, test nodes locally, and\ncontribute to the Rusk codebase.\n\nFor more information on **running a node for main- or testnet**, see our\n[Node operator docs](https://docs.dusk.network/operator/overview/)\n\n# 📃 Table of Contents\n\n- [Repo Overview](#️-overview)\n- [Prerequisites](#-prerequisites)\n - [Setup script](#setup-script)\n - [Rust Installation](#rust-installation)\n- [Build and Tests](#️-build-and-tests)\n- [Make Commands](#-make-commands)\n- [Run a local node for development](#-run-a-local-node-for-development)\n - [Spin up local node](#spin-up-local-node)\n - [Prepare modules](#prepare-modules)\n - [Run a node](#run-a-node)\n - [Run an archive node](#run-an-archive-node)\n - [Run a prover node](#run-a-prover-node)\n- [Contracts compilation](#-contracts-compilation)\n- [Docker support](#-docker-support)\n\n## 🗺️ Overview\n\n#### Code projects\n\n| Name | Description |\n| :------------------------------------ | :-------------------------------------------------------------------------- |\n| 🌒 [rusk](/rusk/) | Entrypoint for the blockchain node |\n| 🔗 [consensus](/consensus/) | Implementation of Dusk's succinct attestation consensus |\n| 📜 [contracts](https://github.com/dusk-network/contracts) | Contains Dusk genesis, test and ecosystem contracts |\n| 🧩 [data-drivers](/data-drivers/) | Tools to encode/decode contract arguments between RKYV and JS I/O |\n| 🧬 [dusk-core](/core/) | Core types used for interacting with Dusk and writing smart contracts |\n| 🌐 [dusk-abi](/core/src/abi.rs) | Dusk application binary interface to develop smart contracts (part of core) |\n| 📊 [node-data](/node-data/) | Core datatypes for the blockchain node |\n| ⚙️ [dusk-vm](/vm/) | The virtual machine to run Dusk smart contracts |\n| 🪪 [rusk-profile](/rusk-profile/) | Utility to generate a genesis state based on a set profile |\n| 📨 [rusk-prover](/rusk-prover/) | Service exposing functionality to remotely prove zero knowledge proofs |\n| ⬇️ [rusk-recovery](/rusk-recovery/) | Utility to recover the state of a chain |\n| ⌨️ [rusk-wallet](/rusk-wallet/) | Dusk CLI wallet |\n| 🔨 [w3sper.js](/w3sper.js/) | Js SDK to integrate Dusk features into applications |\n| ⚙️ [wallet-core](/wallet-core/) | WASM library providing core logic for Dusk wallet implementations |\n\n#### Infrastructure & Testing\n\n| Name | Description |\n| :-------------- | :--------------------------------------------------------- |\n| 📂 examples | Example data used for local chain spawning and development |\n| 📄 scripts | Utility scripts |\n| 🔧 test-wallet | Wallet for testing against the specifications |\n\n## 📝 Prerequisites\n\n- Rust 1.82 nightly or higher\n- GCC 13 or higher\n- Clang 18 or higher\n- Deno 2.x\n\n### Setup script\n\nWe provide a setup script in the `scripts` folder that can take care of\neverything.\n\n```bash\nbash scripts/dev-setup.sh\n```\n\n### Rust Installation\n\nRusk makes use of the nightly toolchain, make sure it is installed. Furthermore,\nto build the WASM contracts, `wasm-pack` is required.\n\nTo install and set the nightly toolchain, and install `wasm-pack`, run:\n\n```bash\nrustup toolchain install nightly\nrustup default nightly\ncargo install wasm-pack\n```\n\n## 🛠️ Build and Tests\n\nTo build `rusk` from source, make sure the prerequisites are met. Then you can\nsimply run the following command to compile everything:\n\n```bash\nmake\n```\n\nTo run tests:\n\n```bash\nmake test\n```\n\nThat will also compile all the genesis contracts and its associated circuits.\nSee also `make help` for all the available commands.\n\n## 📋 Make Commands\n\n| Command | Description |\n|---------|-------------|\n| `make` | Build everything (keys, wasm, abi, state, rusk, rusk-wallet) |\n| `make help` | Display available make commands |\n| `make abi` | Build the ABI |\n| `make keys` | Generate ZK circuit proving keys |\n| `make state` | Create the network genesis state |\n| `make wasm` | Compile wallet-core to WASM |\n| `make data-drivers` | Build data-driver WASM files |\n| `make data-drivers-js` | Build data-driver WASM files with JS/alloc support |\n| `make rusk` | Build the rusk node binary |\n| `make rusk-wallet` | Build the CLI wallet binary |\n| `make test` | Run the full test suite |\n| `make clippy` | Run clippy on all crates (warnings = errors) |\n| `make doc` | Generate documentation for all crates |\n| `make bench` | Run benchmarks for node and rusk |\n| `make prepare-dev` | One-time setup for local development node |\n| `make run-dev` | Launch local ephemeral node |\n| `make run-dev-archive` | Launch local ephemeral archive node |\n| `make run` | Build and run the node (with keys and state) |\n\n## 💻 Run a local node for development\n\n### Spin up local node\n\nRun a single full-node cluster with example state.\n\n#### Prepare modules:\n\n```bash\n# Generate the keys used by the circuits\n# Compile all the genesis contracts\n# Copy example consensus.keys\nmake prepare-dev\n```\n\n`make prepare-dev` only prepares the example consensus keys and example state.\nIt does not create any rusk toml config.\n\nIf you change `examples/genesis.toml`, delete `/tmp/example.state` before\nrunning `make prepare-dev` again. The target keeps an existing example state\ninstead of overwriting it.\n\n#### Run a Node\n\n```bash\n# Launch a local ephemeral node\nmake run-dev\n```\n\nIf no HTTP address override is provided, `rusk` falls back to `127.0.0.1:8080`.\n\nOverride the local HTTP bind address for one run:\n\n```bash\nmake run-dev RUSK_HTTP_ADDR=127.0.0.1:9080\n```\n\nUse a gitignored per-developer config file:\n\n```bash\nmkdir -p .rusk\ncat > .rusk/local.toml <<'EOF'\n[http]\nlisten_address = \"127.0.0.1:9080\"\nEOF\n\nmake run-dev RUSK_CONFIG=.rusk/local.toml\n```\n\nPass additional `dusk-rusk` CLI arguments through:\n\n```bash\nmake run-dev RUSK_ARGS='--log-level debug'\n```\n\nIf both `RUSK_CONFIG` and `RUSK_HTTP_ADDR` are set, `RUSK_HTTP_ADDR` wins because\nthe CLI flag overrides the TOML value.\n\n#### Run an Archive node\n\n```bash\nmake run-dev-archive\n```\n\nThe same overrides work for archive mode:\n\n```bash\nmake run-dev-archive RUSK_HTTP_ADDR=127.0.0.1:9080\nmake run-dev-archive RUSK_CONFIG=.rusk/local.toml\n```\n\n> `rusk/default.config.toml` and `rusk/mainnet.config.toml` are templates for\nuser-supplied config. They are not auto-discovered at runtime.\n\nIf you move rusk off `127.0.0.1:8080`, point `rusk-wallet` at the same\naddress:\n\n```bash\nrusk-wallet --state http://127.0.0.1:9080 --prover http://127.0.0.1:9080\n```\n\nIf archive endpoints matter for your workflow:\n\n```bash\nrusk-wallet --state http://127.0.0.1:9080 --prover http://127.0.0.1:9080 --archiver http://127.0.0.1:9080\n```\n\nFor a persistent wallet-side override, update `[network.local]` in\n`~/.config/rusk-wallet/config.toml` or `{wallet_dir}/config.toml`.\n\n#### Use the unstaked example wallet\n\nThe default example recovery phrase in `examples/recovery-phrase.txt` is funded\nand staked. For localnet testing with a funded wallet that has no active stake,\nuse `make run-dev-second` from `rusk-wallet/`. The target copies\n`examples/wallet-unstaked.dat` into an explicit wallet directory on first use.\nThe matching recovery phrase is stored in `examples/recovery-phrase-unstaked.txt`.\n\n#### Run a Prover Node\n\nThe node can be build as a prover only as follows:\n\n```bash\ncargo r --release --no-default-features --features prover -p dusk-rusk\n```\n\nThis prover node will be accessible on `https://localhost:8080`. Apps like the\n[rusk-wallet](https://github.com/dusk-network/rusk/tree/master/rusk-wallet) can\nbe connected to it for quicker and more private local proving.\n\n## 📜 Contracts compilation\n\nCompile all the genesis contracts without running the server:\n\n```bash\nmake contracts\n```\n\nCompile a specific genesis contract:\n\n```bash\n# generate the wasm for `transfer` contract\nmake wasm for=transfer\n```\n\n## 🐳 Docker support\n\n### Local Ephemeral Node\n\nIt's also possible to run a local ephemeral node with Docker.\n\nTo build the Docker image with archive:\n\n```bash\ndocker build -f Dockerfile.ephemeral -t rusk .\n```\n\nTo build the Docker image **without** archive:\n\n```bash\ndocker build -t -f Dockerfile.ephemeral rusk --build-arg CARGO_FEATURES=\"\" .\n```\n\nTo run Rusk inside a Docker container:\n\n```bash\ndocker run -p 9000:9000/udp -p 8080:8080/tcp rusk\n```\n\nPort 9000 is used for Kadcast, port 8080 for the HTTP and GraphQL APIs.\n\n### Persistent Node\n\nTo build the docker image for a provisioner\n```bash\ndocker build -f Dockerfile.persistent -t rusk --build-arg NODE_TYPE=provisioner .\n```\n\nTo build for an archiver or prover instead, build with NODE_TYPE=archive or NODE_TYPE=prover,\nrespectively.\n\nTo run:\n\n```bash\ndocker run -it \\\n -v /path/to/consensus.keys:/opt/dusk/conf/consensus.keys \\\n -v /path/to/rusk/profile:/opt/dusk/rusk \\\n -e NETWORK= \\\n -e DUSK_CONSENSUS_KEYS_PASS= \\\n -p 9000:9000/udp \\\n -p 8080:8080/tcp \\\n rusk\n```\n\n#### Customizing Configuration\n\nThe configuration used for rusk is based on the template file at `https://raw.githubusercontent.com/dusk-network/node-installer/ac1dd78eb31be4dba1c9c0986f6d6a06b5bd4fcc/conf/mainnet.toml` for mainnet and `https://raw.githubusercontent.com/dusk-network/node-installer/ac1dd78eb31be4dba1c9c0986f6d6a06b5bd4fcc/conf/testnet.toml` for testnet.\nAs part of the node setup process when the container is started, the IP addresses used for listening in kadcast and, if \nconfigured, http will be detected and automatically configured.\n\nTo customize the configuration, the configuration template file can be copied and modified. The custom configuration template\nshould be mounted on `/opt/dusk/conf/rusk.template.toml`.\n\n```bash\ndocker run -it \\\n -v /path/to/consensus.keys:/opt/dusk/conf/consensus.keys\n -v /path/to/rusk/profile:/opt/dusk/rusk \\\n -v /path/to/rusk.modified-template.toml:/opt/dusk/conf/rusk.template.toml \\\n -e NETWORK= \\\n -e DUSK_CONSENSUS_KEYS_PASS= \\\n -p 9000:9000/udp \\\n -p 8080:8080/tcp \\\n rusk\n```\n\n##### IP Addresses\n\nWhen using a custom configuration file, properties that use IP addresses should be set to 'N/A'. For example, if\nyou want HTTP to be configured:\n\n```toml\n[http]\nlisten_address = 'N/A'\n```\n\nThis entry should be present in the template configuration file. When the node is starting, the address to be used\nwill be detected and this configuration will be set to listen at port 8080.\n\nLikewise, the `kadcast.public_address` and `kadcast.listen_address` properties in the configuration file should be set\nto 'N/A'. During node startup, they will be detected and set to use port 9000.\n\n## License\n\nThe Rusk software is licensed under the\n[Mozilla Public License Version 2.0](./LICENSE).\n","has_starred","hub_user","dusknetwork","immutable_tags_settings",{"_72":11,"_73":74},"enabled","rules",[75],".*","is_automated","permissions",{"_79":17,"_80":11,"_81":11},"read","write","admin","user","storage_size",82291556422,"orgData",{"_87":88,"_89":90,"_91":92,"_93":29,"_94":95,"_96":97,"_98":95,"_99":97,"_100":101,"_102":97,"_103":97,"_104":97,"_105":17},"id","45406c26f38647ff943e506fd0d4feab","uuid","45406c26-f386-47ff-943e-506fd0d4feab","type","organization","orgname","full_name","Dusk","location","","company","profile_url","date_joined","2024-09-18T11:15:27.511Z","gravatar_url","gravatar_email","badge","is_active","recentTags",[108],{"_109":40,"_110":111,"_112":113,"_114":115,"_87":116,"_117":118,"_46":133,"_134":111,"_135":29,"_136":52,"_53":137,"_138":139,"_140":124,"_141":133,"_142":62,"_143":17},"content_type","creator",29258101,"digest","sha256:aa7be39ec974e6f2cc596db24e63e79746dcb5995ac22057cf0f1cd4fad4976c","full_size",2213841277,758821168,"images",[119],{"_120":121,"_112":113,"_122":97,"_123":124,"_125":126,"_127":128,"_129":97,"_130":-5,"_131":115,"_59":62,"_132":-5},"architecture","amd64","features","last_pulled","2026-09-23T13:23:54.216963009Z","last_pushed","2026-06-17T11:25:44.418095193Z","os","linux","os_features","os_version","size","variant","2026-06-17T11:25:44.727244Z","last_updater","last_updater_username","media_type","latest","repository",25156781,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":155,"_162":163,"_151":172,"_173":11},{"_36":156,"_38":157,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":158,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":69,"_70":159,"_76":11,"_77":161,"_82":29,"_83":84},[],[40],[52],{"_72":11,"_73":160},[75],{"_79":17,"_80":11,"_81":11},"tags",{"_164":60,"_165":-5,"_166":-5,"_167":168},"count","next","previous","results",[169],{"_109":40,"_110":111,"_112":113,"_114":115,"_87":116,"_117":170,"_46":133,"_134":111,"_135":29,"_136":52,"_53":137,"_138":139,"_140":124,"_141":133,"_142":62,"_143":17},[171],{"_120":121,"_112":113,"_122":97,"_123":124,"_125":126,"_127":128,"_129":97,"_130":-5,"_131":115,"_59":62,"_132":-5},[],"canDeleteTags","actionData","errors"]

\n\n\n

\n $\"Rusk\"$ \n $\"Rusk\"$ \n

dusknode/rusk

Tags for dusknode/rusk