Easy, transparent, trustless trading of cryptocurrencies using atomic swaps.
Branch: master
Clone or download
Latest commit c797f95 Feb 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.githooks Run JS check format before commit Feb 12, 2019
.github Only mergify a pr if correct label is set Jan 15, 2019
.idea Add noise_handshake crate Feb 5, 2019
api_tests Rename LQS to btsieve Feb 19, 2019
application Rename LQS to btsieve Feb 19, 2019
vendor Make all Ledgers and Assets Copy Feb 18, 2019
.gitignore Ignore .idea/codeStyle/Project.xml Dec 16, 2018
.mergify.yml Fix mergify label mess Jan 22, 2019
.travis.yml Change toolchain to nightly 2018 Dec 11, 2018
CONTRIBUTING.md Add labels explanation Jan 9, 2019
Cargo.lock Rename LQS to btsieve Feb 19, 2019
Cargo.toml Rename LQS to btsieve Feb 19, 2019
LICENSE.md Moving to GPLv3 Jan 3, 2019
Makefile.toml Rename LQS to btsieve Feb 19, 2019
README.md
rust-toolchain Change toolchain to nightly 2018 Dec 11, 2018
rustfmt.toml Enable more format options Nov 30, 2018

README.md

COMIT-rs

Build Status Waffle.io - Columns and their card count

COMIT is an open protocol facilitating trustless cross-blockchain applications. This is a reference implementation for the COMIT protocol.

WARNING - We do not recommend running COMIT on mainnet for now!!!

Structure

The repository contains two main folders: vendor and application.

Vendor

Contains crates that provide general functionality that is not specific to the domain of atomic swaps. Crates defined in here MUST NOT depend on crates in application. They may be separated from the repository at some point (and possibly released on crates.io).

Application

Contains crates specific to our application. Can depend on libraries located in vendor.

Setup build environment

  1. Install rustup: curl https://sh.rustup.rs -sSf | sh
  2. Install libzmq:
    • Ubuntu/Debian: apt install libzmq3-dev
    • Mac (Homebrew) brew install zeromq
  3. Install SSL libraries
    • Ubuntu/Debian: apt install libssl-dev
    • Mac (Homebrew) brew install openssl
  4. solc is currently needed to build (will be deprecated). 2 choices:
    • Install docker
    • OR install solc

Build & Run

  1. cargo build (do export SOLC_BIN=/usr/bin/solc if solc is installed locally)
  2. Put a default.toml config file into ~/.config/comit_node or set COMIT_NODE_CONFIG_PATH to wherever the config file is located.
  3. ./target/release/comit_node
  4. TODO: similar documentation for btsieve

Setup testing/dev environment

  1. Install docker & docker-compose
  2. Install nvm, npm & yarn
  3. Install cargo-make: cargo install cargo-make
  4. Run cargo make in the root folder of the repository, this will install various crates & tools such as rustfmt & clippy

Testing

  • cargo make runs the whole test suite including integration tests but not end-to-end.
  • cargo make all also runs the whole test suite, including end-to-end tests.
  • cargo make format to format Rust code
  • cargo make js-format to format JavaScript code
  • cargo make btsieve to run btsieve tests
  • cargo make dry to run COMIT node dry tests
  • cargo make e2e to run COMIT node end-to-end tests
  • cargo make e2e *btc* to run COMIT node end-to-end tests with btc in the folder name (supports shell glob)

Contributing

Contributions are welcome, please visit CONTRIBUTING for more details.

License

This project is licensed under the terms of the GNU GENERAL PUBLIC LICENSE v3.