npm

Does your artifact manager get in the way? Join us on Oct. 8 at 10am PT, to discuss how npm can help.Sign up »

xud

1.0.0-testnet.1 • Public • Published

Exchange Union Daemon

Discord Build Status Codacy Badge

The Exchange Union Daemon (xud) powers Exchange Union, a decentralized exchange (DEX) built on the Lightning and Raiden networks to enable instant and trustless cryptocurrency swaps. The vision is to bring individuals and existing, centralized exchanges onto the same network and form one, global liquidity pool. This gives users a choice to either trade directly on the DEX, managing private keys and software stack, or to conveniently trade via a trusted exchange. Exchanges participating in the network aggregate the network's 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 with remote peers.
  • Peer-to-peer networking with and discovery of other nodes.
  • gRPC API with web proxy to serve other applications, also accessible via the command-line interface xucli.

Install

This section contains 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 setup via docker.

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

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

Open a new terminal and issue commands to xud with the xucli command line tool. To see a list of available commands, run:

./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.

Discussion

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

install

npm i xud

Downloadsweekly downloads

0

version

1.0.0-testnet.1

license

AGPL-3.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
  • avatar
Report a vulnerability