{"id":13407287,"url":"https://github.com/ExchangeUnion/xud","last_synced_at":"2025-03-14T11:31:15.432Z","repository":{"id":38705851,"uuid":"120945739","full_name":"ExchangeUnion/xud","owner":"ExchangeUnion","description":"Exchange Union Daemon 🔁 ⚡️","archived":false,"fork":false,"pushed_at":"2023-02-25T00:32:03.000Z","size":10279,"stargazers_count":116,"open_issues_count":112,"forks_count":49,"subscribers_count":18,"default_branch":"master","last_synced_at":"2024-05-22T08:12:25.073Z","etag":null,"topics":["bitcoin","connext","dex","ethereum","lightning","opendex","xud"],"latest_commit_sha":null,"homepage":"https://exchangeunion.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ExchangeUnion.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.MD","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}},"created_at":"2018-02-09T19:18:54.000Z","updated_at":"2024-04-08T16:28:00.000Z","dependencies_parsed_at":"2024-01-13T17:12:27.714Z","dependency_job_id":"d13248c3-d301-4a29-9448-4be3d41e8e50","html_url":"https://github.com/ExchangeUnion/xud","commit_stats":{"total_commits":1451,"total_committers":27,"mean_commits":53.74074074074074,"dds":0.4128187456926258,"last_synced_commit":"ad6699359ff9f1a8e2fc94f847e0436f403808ee"},"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExchangeUnion%2Fxud","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExchangeUnion%2Fxud/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExchangeUnion%2Fxud/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ExchangeUnion%2Fxud/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ExchangeUnion","download_url":"https://codeload.github.com/ExchangeUnion/xud/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243172142,"owners_count":20247887,"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":["bitcoin","connext","dex","ethereum","lightning","opendex","xud"],"created_at":"2024-07-30T20:00:35.422Z","updated_at":"2025-03-14T11:31:14.184Z","avatar_url":"https://github.com/ExchangeUnion.png","language":"TypeScript","funding_links":[],"categories":["Developer Resources"],"sub_categories":["🖥️ RApps"],"readme":"# Exchange Union Daemon\n\n[![Discord](https://img.shields.io/discord/547402601885466658.svg)](https://discord.gg/YgDhMSn)\n[![CI Status](https://github.com/ExchangeUnion/xud/workflows/CI/badge.svg)](https://github.com/ExchangeUnion/xud/actions?query=workflow%3ACI)\n[![SimTest Status](https://github.com/ExchangeUnion/xud/workflows/Simulation%20tests/badge.svg)](https://github.com/ExchangeUnion/xud/actions?query=workflow%3A%22Simulation+tests%22)\n[![Codacy Badge](https://api.codacy.com/project/badge/Grade/87238907485845eb879bd61c65561775)](https://www.codacy.com/app/sangaman/xud?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=ExchangeUnion/xud\u0026amp;utm_campaign=Badge_Grade)\n[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)\n\n\n![xud logo](logo.png)\n\nThe Exchange Union Daemon ([`xud`](https://github.com/ExchangeUnion/xud)) is the reference implementation powering [OpenDEX](https://opendex.network), a decentralized exchange built on top of the [Lightning](https://lightning.network/) and [Connext](https://connext.network/) networks. `xud` brings individual traders, market makers and exchanges onto OpenDEX to form a single global trading network and liquidity pool.\n\nGet started 👉 [here](https://docs.exchangeunion.com/start-earning/market-maker-guide) 👈\n\n## OpenDEX Network Specification Compliance\n`xud` implements the [OpenDEX protocol](https://opendex.network) and fully conforms to its so-called [BOLD](https://opendex.network/read/00-introduction) specifications. BOLD stands for:\nBasis of L3 DEX. The naming is intentionally derived from [BOLT](https://github.com/lightningnetwork/lightning-rfc), the Lightning Network specifications and role model of OpenDEX. The specifications are currently being drafted by several implementers based around the world, including the developers of `xud`. The BOLDs, as well as `xud`s implementation of it is still a work-in-progress. The current status of `xud`'s BOLD compliance is:\n  - [X] [BOLD #1: Message Format](https://opendex.network/read/01-message-format)\n  - [X] [BOLD #2: Peer Protocol](https://opendex.network/read/02-peer-protocol)\n  - [X] [BOLD #3: Trade Protocol](https://opendex.network/read/03-trade-protocol)\n  - [X] [BOLD #4: Swap Protocol](https://opendex.network/read/04-swap-protocol)\n\n`xud` encompasses the following components:\n\n* Integration with [lnd](https://github.com/lightningnetwork/lnd) and [connext](https://github.com/connext/rest-api-client) clients.\n* Decentralized order book to locally aggregate orders from the known network.\n* Matching engine to match new local orders with existing local and remote orders and initiate atomic swaps with remote peers.\n* Peer-to-peer networking with and discovery of other nodes.\n* [gRPC API](https://grpc.io/) with web proxy to serve other applications, also accessible via the command-line interface `xucli`.\n\n## Documentation\n\nThe daemon has been designed to be as developer friendly as possible in order to facilitate application development on top of `xud`.\n* [docs.exchangeunion.com](https://docs.exchangeunion.com): the starting point and up-to-date collection of guides, links and examples\n* [api.exchangeunion.com](https://api.exchangeunion.com): The automatically generated gRPC API documentation\n* [typedoc.exchangeunion.com](https://typedoc.exchangeunion.com): The automatically generated code documentation\n\n## Installation\n\nThis section contains brief instructions for installing `xud` manually, without treating setup of dependencies like `bitcoind` or `lnd`. It is mainly geared towards developers. For all other users, we recommend our streamlined [xud-docker](https://docs.exchangeunion.com/start-earning/market-maker-guide) setup.\n\nIf you already have [Node.js](https://nodejs.org/en/download/) installed, you can install `xud` via npm by running\n\n```bash\nsudo npm install xud -g --unsafe-perm\n```\n\nWe officially support the current Node.js LTS only, since it often takes time for the latest version to be supported by the gRPC library. Detailed instructions for installing `xud` can be found in the [installation](https://docs.exchangeunion.com/development/native-installation) \u0026  [developer docs](https://docs.exchangeunion.com/development).\n\n## Usage\n\nLaunch `xud`:\n\n```\n./xud\n2018-9-11 01:11:59 [GLOBAL] info: config loaded\n2018-9-11 01:11:59 [GLOBAL] info: Local nodePubKey is 029a96c975d301c1c8787fcb4647b5be65a3b8d8a70153ff72e3eac73759e5e345\n2018-9-11 01:11:59 [DB] info: connected to database. host:localhost port:3306 database:xud\n2018-9-11 01:11:59 [P2P] info: p2p server listening on 0.0.0.0:8885\n2018-9-11 01:11:59 [RPC] info: gRPC server listening on localhost:8886\n```\n\nOpen a new terminal and issue commands to `xud` with the `xucli` command line tool. To see a list of available commands, run:\n\n```\n./xucli --help\n```\n\nYou can find more information on how to use \u0026 configure `xud` in the [docs for developers](https://docs.exchangeunion.com/development).\n\nNote: If you installed `xud` globally via npm, you can run `xud` and `xucli` from anywhere. Otherwise you must run them from the `bin` folder.\n\n## License\n\nAll files in this repository are licensed under the [GNU Affero General Public License v3.0](LICENSE) unless explicitly stated otherwise in the header of a given file.\n\n## Discussion\n\nComments, questions, and any development-related discussions are welcome in our [Discord chat](https://discord.gg/YgDhMSn)!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FExchangeUnion%2Fxud","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FExchangeUnion%2Fxud","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FExchangeUnion%2Fxud/lists"}