{"id":16153688,"url":"https://github.com/moneroexamples/generic-xmr-scanner","last_synced_at":"2025-03-18T19:32:43.620Z","repository":{"id":42082644,"uuid":"183723264","full_name":"moneroexamples/generic-xmr-scanner","owner":"moneroexamples","description":"Generic scanner of Monero blockchain","archived":false,"fork":false,"pushed_at":"2023-11-03T09:26:40.000Z","size":470,"stargazers_count":19,"open_issues_count":1,"forks_count":7,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-02-28T11:56:52.559Z","etag":null,"topics":["c-plus-plus","monero","online","outputs"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/moneroexamples.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":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-27T03:25:05.000Z","updated_at":"2024-09-05T13:14:19.000Z","dependencies_parsed_at":"2024-10-27T19:10:55.408Z","dependency_job_id":"ce4d3ff9-6607-4a3d-bd25-ef44f822003d","html_url":"https://github.com/moneroexamples/generic-xmr-scanner","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moneroexamples%2Fgeneric-xmr-scanner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moneroexamples%2Fgeneric-xmr-scanner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moneroexamples%2Fgeneric-xmr-scanner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moneroexamples%2Fgeneric-xmr-scanner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/moneroexamples","download_url":"https://codeload.github.com/moneroexamples/generic-xmr-scanner/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243945561,"owners_count":20372897,"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":["c-plus-plus","monero","online","outputs"],"created_at":"2024-10-10T01:14:11.070Z","updated_at":"2025-03-18T19:32:38.612Z","avatar_url":"https://github.com/moneroexamples.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Generic Monero Scanner\n\nThe project aims to develop generic online scanner/searcher for Monero. Its possible capability includes searching for:\n\n - outputs associated with given address and viewkey (already implemented with full support for subaddresses),\n - possible spendings based on only address and viewkey,\n - transactions which use our outputs as decoys/ring members,\n - transactions associated with given legacy payment ids,\n - multi-output transactions to subaddresses,\n - transactions with integrated payment ids,\n - and more ...\n\n## Screenshot\n\n![Generic Monero Scanner](/img/screenshot.png)\n\n## Motivation\n\nThe idea is based on two projects:\n\n - [onion-monero-viewer](https://github.com/moneroexamples/onion-monero-viewer)\n - [transactions-export](https://github.com/moneroexamples/transactions-export)\n\nThe first project allowed for online identification of outputs associated with \ngiven address and viewkey. The second project additionally\nsearched for transactions which use the outputs as decoys/ring members. \nHowever, the first project got discontinued, while the second is a\ncommand-line program which limits its widespread use. \n\nThe generic Monero scanner is solution to these issues.\n\n## Technologies\n\nThe key technologies used in the scanner are:\n\n- [C++17](https://en.wikipedia.org/wiki/C%2B%2B17) - recent version of the C++ programming language.\n- [websockets](https://en.wikipedia.org/wiki/WebSocket) -  protocol for duplex communication between frontend and backend (support provided by [drogon](https://github.com/an-tao/drogon))\n- [FiberPool](https://github.com/moneroexamples/fiberpool) - single-file header-only C++17 [boost::fiber](https://github.com/boostorg/fiber) thread pool library\n- [xmregcore](https://github.com/moneroexamples/xmregcore) - core utilities used in moneroexample projects.\n\n## Example compilation on Ubuntu 20.04\n\n### Monero download and compilation\n\nTo compile the project, most recent Monero development version (i.e., its `master` branch)\nneeds to be compiled first. \n\nInstruction for compiling monero are here: https://github.com/moneroexamples/monero-compilation\n\nUsing `USE_SINGLE_BUILDDIR` flag is important. Without the flag, cmake of the project\nwill not be able to locate the compiled monero.\n\n### Project download and compilation\n\n```bash\n# go to home folder\ncd ~\n\n# drogon dependencies\nsudo apt install libjsoncpp-dev uuid-dev\n\ngit clone --recurse-submodules https://github.com/moneroexamples/generic-xmr-scanner\n\ncd generic-xmr-scanner\n\nmkdir build \u0026\u0026 cd build\n\ncmake ..\n\n# altearnatively can use cmake -DMONERO_DIR=/path/to/monero_folder ..\n# if monero is not in ~/monero\n\nmake\n```\n\nFollowing the compilation, `xmrscanner` executable should be available in the `build` folder.\n\n#### Html fronted\n\nThe project comes with basic html fronted located in `html` folder. Basic instruction for running `xmrscanner` over `http` or `https` (SSL) protocoles are given here:\n\n- https://github.com/moneroexamples/generic-xmr-scanner/tree/master/html#basic-html-client-for-the-scanner\n\n## Using Docker\n\nInstead of building and compiling everything from scrach your own, you can use `Docker`. You still need to have full blockchain on your host, which you share with the docker. Do docker containers do not run monero themselfs. So basically you still need to have full node before you can run the `xmrscanner`.\n\n```\ngit clone --recurse-submodules https://github.com/moneroexamples/generic-xmr-scanner\n\ncd generic-xmr-scanner\n\n# build backend image (using 2 cpus)\ndocker build --build-arg NPROC=2  . -t xmrscannerbackend\n\n# build frontend image\ndocker build ./html -t xmrscannerfrontend\n```\n\nWhen the two images are build, you can run containers for backend and frontend:\n\n```\n# run backend container on mainnet (-n 0),\ndocker run -it -v \u003cpath-to-monero-blockckain-on-the-host\u003e:/home/monero/.bitmonero -p 8848:8848  xmrscannerbackend \"./xmrscanner -n 0\"\n\n# run frontend container\ndocker run -it -p 9100:80  xmrscannerfrontend\n```\n\nOnce the containers are running, open browser: `http://0.0.0.0:9100/`.\n\n\n#### Program options\n\n```bash\nxmrscanner: generic monero scanner:\n  -h [ --help ]                         Help\n  -n [ --nettype ] arg (=2)             network type: 0-MAINNET, 1-TESTNET, \n                                        2-STAGENET\n  -b [ --blockchain-path ] arg          Non-default path to lmdb folder \n                                        containing the blockchain. Default is \n                                        /home/mwo2/.bitmonero/stagenet/lmdb\n  -d [ --da-path ] arg (=./config/default_addresses.json)\n                                        Non-default path to default_addresses.j\n                                        son file\n  -c [ --config-path ] arg (=./config/config.json)\n                                        Non-default path to config.json file\n  -f [ --fiberthreads ] arg (=0)        Number of fiberpool thread workers. \n                                        Default is 0 - based on hardware\n  -p [ --port ] arg (=8848)             Service port\n```\n\n## How can you help\n\nConstructive criticism, code and website edits are always good. They can be made through github.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoneroexamples%2Fgeneric-xmr-scanner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmoneroexamples%2Fgeneric-xmr-scanner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoneroexamples%2Fgeneric-xmr-scanner/lists"}