{"id":29560941,"url":"https://github.com/decred/decrediton","last_synced_at":"2025-07-18T15:39:33.673Z","repository":{"id":13184896,"uuid":"73312295","full_name":"decred/decrediton","owner":"decred","description":"Cross-platform GUI for Decred.","archived":false,"fork":false,"pushed_at":"2025-02-28T17:29:21.000Z","size":112962,"stargazers_count":196,"open_issues_count":180,"forks_count":120,"subscribers_count":34,"default_branch":"master","last_synced_at":"2025-02-28T21:52:00.060Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.decred.org/wallets/decrediton/decrediton-setup/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/decred.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-11-09T18:55:33.000Z","updated_at":"2025-02-28T17:29:18.000Z","dependencies_parsed_at":"2022-08-07T07:01:08.581Z","dependency_job_id":"e5072842-c4fd-4994-a54e-3902b20dbc01","html_url":"https://github.com/decred/decrediton","commit_stats":{"total_commits":2025,"total_committers":66,"mean_commits":"30.681818181818183","dds":0.7086419753086419,"last_synced_commit":"587d0993a8209c2337a0dd51e821720ebbf6b30f"},"previous_names":[],"tags_count":65,"template":false,"template_full_name":null,"purl":"pkg:github/decred/decrediton","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdecrediton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdecrediton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdecrediton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdecrediton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/decred","download_url":"https://codeload.github.com/decred/decrediton/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdecrediton/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265787620,"owners_count":23828461,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-18T15:39:28.414Z","updated_at":"2025-07-18T15:39:33.650Z","avatar_url":"https://github.com/decred.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# decrediton\n\n[![Build Status](https://github.com/decred/decrediton/workflows/Build%20and%20Test/badge.svg)](https://github.com/decred/decrediton/actions)\n[![ISC License](https://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)\n\ndecrediton is a cross-platform GUI for decred written in node.js using\nElectron.\n\n## Installation\n\nCurrently decrediton is available on Windows, Linux, and macOS.\n\nDecrediton will NOT use or in any way disrupt the CLI wallet file you may\nalready be using at this time.\n\nDownload the decrediton release for your operating system on [decred/decred-binaries](https://github.com/decred/decred-binaries/releases).\n\nOn macOS, Ubuntu (14.04 LTS kernel 3.16 and later), and recent Debians, there should be\nno additional dependencies needed (exception: Ubuntu 18.04+, see [issue #1404](https://github.com/decred/decrediton/issues/1404)).\n\nOn Fedora or similar distros you may need to install the libXScrnSaver\npackage if you see this error:\n```\nerror while loading shared libraries: libXss.so.1\n```\n\nYou can install this on a recent Fedora with the command:\n\n```bash\nsudo dnf -y install libXScrnSaver\n```\n\nOn linux you will need to decompress the package:\n```bash\ntar -xvzf decrediton-X.X.X.tar.gz\n```\nand then run the file:\n```bash\n./decrediton\n```\n\nThis will start dcrd and dcrwallet for you.\n\nOn macOS, double-click the .dmg file, drag the .app to your\nApplications folder.  Double click on Decrediton.app to start.\n\nYou can also install via [brew cask](https://caskroom.github.io):\n```bash\nbrew cask install decrediton\n```\n\nFrom there follow the on screen instructions to setup your wallet.\n\n### Options\n\nWhen running a release version, there are a few options available.\n\nTo see additional debug information (including the output of dcrd and dcrwallet) run:\n\n```\ndecrediton --debug\n```\n\nTo pass additional arguments to dcrwallet (such as to increase the logging level run:\n\n```\ndecrediton --extrawalletargs='-d=debug'\n```\n\n## Development Setup\n\n### Node and Electron Versions\n\nYou need to use compatible node and electron versions to build native modules\nand in general to ensure the code you're working on will behave correctly in\nproduction.\n\nThe current recommended versions for the main tools are:\n\n  - Node: 14.16.1\n  - Npm: 6.4+\n  - Yarn: 1.12+\n\nTo ease node version management, install all top-level tools (node/npm/yarn) using [nvm](https://github.com/nvm-sh/nvm).\n\n### Electron extensions\n\nDecrediton uses [electron-devtools-installer](https://github.com/MarshallOfSound/electron-devtools-installer) to automatically install react and redux dev tools in the `userData/extensions` directory.\n\nThe extensions *will not* be updated unless you set the `UPGRADE_EXTENSIONS` environment variable to `true`.\n\n### Decred Binaries\n\nDevelopment using the master version of decrediton usually requires using a\ncorresponding master version of dcrd, dcrwallet and dcrlnd.\n\nFollow the instructions to install these from source from their respective repos:\n\n- [dcrd installation instructions](https://github.com/decred/dcrd#updating)\n- [dcrwallet installation instructions](https://github.com/decred/dcrwallet#installation-and-updating)\n- [dcrlnd installation instructions](https://github.com/decred/dcrlnd#installation)\n\n\n### Basic Development Setup\n\nThese steps are usually the only ones required for basic development on\nlinux/macOS (after compiling dcrd/dcrwallet/dcrlnd from source).\n\nFor Windows users, it's usually a good idea to use\n[MSYS2](https://www.msys2.org/) instead of the standard cmd.exe (see below for\nmore Windows tips).\n\n```bash\ngit clone https://github.com/decred/decrediton.git\ncd decrediton\nmkdir bin/\ncp $GOPATH/bin/dcr* bin/\nyarn\nyarn dev\n```\n\n### Requirements for DEX Development Usage\n\nThe building of the dex module requires Go to be installed.\n\n### Keeping up with dcrd/dcrwallet changes\n\nIf you're developing decrediton improvements on a daily basis, you need to also keep up to date with dcrd/dcrwallet changes (especially when developing things like new grpc calls).\n\nIn that case, instead of copying the binaries to `/bin` it's better to symlink\nthem so that you only need a single step (go install) to run newer versions of\nthese tools:\n\n```bash\ncd bin\nln -s `which dcrd` dcrd\nln -s `which dcrwallet` dcrwallet\nln -s `which dcrlnd` dcrlnd\n```\n\n### Advanced Daemon Mode\n\nThis step is only recommended if you're constantly restarting decrediton. If\nyou're not developing on a daily basis, you can safely ignore this for the\nmoment.\n\nWhen starting decrediton in RPC (or \"normal\") mode, it automatically runs dcrd\nin the backgound to gather blockchain data. If you need to constantly restart\ndecrediton, loading the node every time may be time consuming.\n\nIn that case, it's helpful to run the dcrd node in a separate process and simply\nattach to it between decrediton restarts. In order to see the advanced daemon\nconfiguration options either start decrediton with the ```--advanced``` option or open ```config.json``` and set the\n```daemon_start_advanced``` flag to ```true``` as follows:\n\n```\"daemon_start_advanced\": true,```\n\nNote: Your config.json file is located in the following directories:\n\nWindows - ```C:\\Users\\\u003cyour-username\u003e\\AppData\\Local\\Decrediton\\config.json```\n\nmacOS - ```$HOME/Library/Application\\ Support/Decrediton/config.json```\n\nLinux - ```~/.config/decrediton/config.json```\n\nRun the following to start the Decred daemon in a standalone terminal window:\n\nWindows - ```dcrd --testnet -u USER -P PASSWORD --rpclisten=127.0.0.1:19119 --rpccert=C:\\Users\\\u003cusername\u003e\\AppData\\Local\\Dcrd\\rpc.cert```\n\nmacOS - ```dcrd --testnet -u USER -P PASSWORD --rpclisten=127.0.0.1:19119 --rpccert=$HOME/Library/Application\\ Support/Dcrd/rpc.cert```\n\nLinux - ```dcrd --testnet -u USER -P PASSWORD --rpclisten=127.0.0.1:19119 --rpccert=~/.dcrd/rpc.cert```\n\nOnce you restart decrediton, you should be presented with a screen to specify\nthe node parameters. Note that all of them are present in the command you used\nto start the node for your respective system.\n\nCLI options (including ```--advanced```) when running `yarn dev` are currently not supported.\n\nWhen generating the TLS keypairs for the rpc endpoint you should use the P-256 curve by starting the daemon with `--tlscurve=P-256`. Note that the rpccert/rpckey files need to be deleted before this.\n\n## Platform-specific instructions\n\n### macOS\n\nTo start decrediton from command-line (assuming it is installed in `/Applications`):\n\n```$ /Applications/decrediton.app/Contents/MacOS/decrediton```\n\n\n### Windows\n\nRequires at least Windows 10.\n\nWindows is tricky, due to some things working better on MSYS2, while some things\nonly working on cmd.exe, and native module building being very tough to get\nright.\n\nOn a day-to-day basis, for development and testing (of general decrediton\nfunctionality) MSYS2 is fine, and usually useful for providing GNU-like CLI\ntools.\n\nHowever, for building native modules, you'll need to use the cmd.exe prompt.\n\nFirst, from an *administrative prompt* (cmd.exe), install `windows-build-tools`:\n\n```bash\nnpm install --global --production windows-build-tools\n```\n\nThis _usually_ works, but sometimes bugs out. If it does, try manually\ninstalling the vs tools by going opening an explorer window to\n`c:\\users\\[user]\\.windows-build-tools`, then running `vs_BuildTools.exe`.\n\nAfter installing windows-build-tools, open a *non-administrative* prompt\n(cmd.exe) and then try recompiling the native modules:\n\n```bash\nyarn\nyarn rebuild-natives\n```\n\nIf you have multiple versions of VS Build Tools installed, you may need to\nconfigure which version to use:\n\n```bash\nnpm config set msvs_version 2015 -g\n```\n\nSometimes you have to nuke `/node_modules` and `/app/node_modules` for the\nnative modules to be forced to rebuild.\n\nYou might also run into trouble when compiling or trying to use modules compiled\nwith a different version of node than the one that electron internally uses. In\nthat case, switch to the same version of node from electron (check the\nelectron/node version [here](https://github.com/electron/node)) then try\neverything again.\n\nThe end result for module compilation should be the following files:\n\n- `app/node_modules/blake-hash/bin/win32-x64-64/blake-hash.node`\n- `app/node_modules/dcrwin32ipc/build/Release/dcrwin32ipc.node`\n- `app/node_modules/grpc/src/node/extension_binary/electron-v3.0-win32-x64/grpc_node.node`\n\n*Note*: `yarn start` does _not_ currently correctly load the dcrwin32ipc module, so\ntesting with yarn build/start will fail to correctly unload dcrd/dcrwallet when\nclosing.\n\nWhen using git bash, `cmd.exe` or Powershell, you might need to install [MingW-w64](https://www.mingw-w64.org/) to get access to gcc and be able to compile libdex. After installing it, ensure `gcc` and `python` are accessible in console (add the appropriate binary paths to the `%PATH%` environment variable).\n\n\n### Raspberry Pi \u0026 Other Platforms\n\nBuilding on a Raspberry Pi (and other less common platforms) requires rebuilding\nthe native modules, given that most of them (specially grpc) do not come with\nprecompiled binaries for them.\n\nDo note that for the moment, support for this platform is experimental, so you\nmight need to tweak stuff (in particular, you'll need to disable hardware\nacceleration and ui animations) to run decrediton on it.\n\n```bash\nyarn rebuild-natives\n```\n\n\n## Building release versions\n\nYou need the binaries _copied_ into the `bin/` directly (note that symlinks\ndon't work for production builds: you need to actually copy the executables).\n\nYou can test the production version (without most of the debugging info and with\ncompiled and minified code) by using:\n\n```bash\nyarn build\nyarn start\n```\n\nAnd finally, a packaged version (including the final standalone electron\nbinaries) for the current platform can be built with:\n\n```bash\nyarn package\n```\n\n### Linux\n\nYou need to make sure you have the rpm-build package installed for the building to work.\n\n```bash\nyarn package-linux\n```\n\nAfter it is finished it will have the built rpm, deb and tar.gz in the release/ directory.\n\nIf you're only interested in a tar.gz, you can alternatively use:\n\n```bash\nyarn package-dev-linux\n```\n\n## Contact\n\nIf you have any further questions you can find us at:\n\u003chttps://decred.org/community/\u003e\n\n## Issue Tracker\n\nThe\n[integrated github issue tracker](https://github.com/decred/decrediton/issues)\nis used for this project.\n\n## License\n\ndecrediton is licensed under the [copyfree](http://copyfree.org) ISC License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecred%2Fdecrediton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdecred%2Fdecrediton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecred%2Fdecrediton/lists"}