Skip to content

rsercano/xud

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Exchange Union Daemon

Gitter chat Build Status Codacy Badge

The Exchange Union Daemon (xud) powers Exchange Union, a decentralized exchange built on the Lightning and Raiden networks to enable instant and trustless cryptocurrency swaps and order fulfillment between cryptocurrency exchanges. Exchanges participating in the network aggregate their liquidity and can provide deeper order books and new trading pairs to their users. xud encompasses the following components:

  • Integration with lnd and raiden nodes.
  • Decentralized order book to locally aggregate orders from the known network.
  • Matching engine to match new local orders with existing local and remote orders and initiate atomic swaps.
  • Peer-to-peer networking with other XU nodes.
  • gRPC API with web proxy to serve other applications, also accessible via the command-line interface xucli.

Install

If you already have Node.js (min 10.15.3) installed, you can install xud via npm by running

sudo npm install xud -g --unsafe-perm

Detailed instructions for installing xud can be found in the wiki on our Installation page.

Usage

Open a new terminal and launch xud.

$ ./xud
2018-9-11 01:11:59 [GLOBAL] info: config loaded
2018-9-11 01:11:59 [GLOBAL] info: Local nodePubKey is 029a96c975d301c1c8787fcb4647b5be65a3b8d8a70153ff72e3eac73759e5e345
2018-9-11 01:11:59 [DB] info: connected to database. host:localhost port:3306 database:xud
2018-9-11 01:11:59 [P2P] info: p2p server listening on 0.0.0.0:8885
2018-9-11 01:11:59 [RPC] info: gRPC server listening on localhost:8886

Issue commands to xud with the xucli command line tool. To see a list of available commands:

./xucli --help

You can find more information on how to use xud in the wiki at Running xud and Command Line Interface.

Note: If you installed xud globally via npm, you can run xud and xucli from anywhere. Otherwise you must run them from the bin folder.

Documentation

Read the xud API documentation here and code documentation here.

License

All files in this repository are licensed under the GNU Affero General Public License v3.0 unless explicitly stated otherwise in the header of a given file.

Development & Testing Discussion

Comments, questions, and any development-related discussions are welcome in our Gitter chat

About

Exchange Union Daemon

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 91.8%
  • Go 7.0%
  • Other 1.2%