Atomic Swaps

On chain atomic swaps for DIVI, Bitcoin and other cryptocurrencies with gRPC support.

Based off of the original Atomic Swap implementation by Decred, DIVI has created a production ready Atomic Swap implementation that is gRPC and HTTP enabled. This enables Atomic Swaps to be workable with mobile and web applications.

If you want to learn more about how to use atomic swaps. Head to our documentation page.

Compiling from source

Compilation and Installation

Without Docker

export GO111MODULE=auto
go mod verify
go mod tidy

# Build for Unix
go build -i -o ./dist/atomicswap ./src/atomicswap.go

# Build for Windows
SET GOOS=windows
SET GOARCH=amd64
go build -i -o ./dist/atomicswap.exe ./src/atomicswap.go

# To simply just run the project
go run src/atomicswap.go

With Docker

docker build -t atomicswaps .
docker run atomicswaps
docker attach atomicswaps

Command line usage

$ atomicswap --help

A fast and easy way to do atomic swaps for Divi and Bitcoin. Learn more at https://github.com/DiviProject/atomic-swaps

Usage:
  atomicswap [flags]
  atomicswap [command]

Available Commands:
  audit       audit and validate an existing atomic swap contract. Usage: audit [contract bytes] [contract transaction bytes]
  extract     extract the secret for an atomic swap. Usage: extract [contract transaction bytes] [secret]
  help        Help about any command
  initiate    initiate an atomic swap. Usage: initiate [participant's address] [amount]
  participate participate in an atomic swap. Usage: participate [initiator's address] [amount] [secret]
  redeem      redeem an atomic swap. Usage: redeem [contract bytes] [contract transaction bytes] [secret]
  refund      refund an atomic swap. Usage: refund [contract bytes] [contract transaction bytes]
  version     print the version of atomicswap

Flags:
      --base-confirmations int     the base currency confirmations required to redeem a swap (default 1)
      --base-rpc-currency string   the base currency (default "bitcoin")
      --base-rpc-host string       the base currency host of the wallet RPC server (default "localhost")
      --base-rpc-network string    the base network configuration (default "regtest")
      --base-rpc-password string   the base currency password of the wallet RPC server (default "password")
      --base-rpc-port int          the base currency port of the wallet RPC server (default 1337)
      --base-rpc-user string       the base currency user of the wallet RPC server (default "user")
  -c, --config string              the path to the Configuration file
      --database string            the default mongo database (default "atomic-swaps")
      --grpc-port int              the port of the gRPC server (raw tcp) (default 9999)
  -h, --help                       help for atomicswap
      --mongo-url string           the url for the MongoDB service (default "mongodb://localhost:27017")
  -y, --no-prompt                  do not prompt transactions with a y/n
      --server-port int            the port of the HTTP server (default 9001)
      --swap-confirmations int     the swap currency confirmations required to redeem a swap (default 1)
      --swap-rpc-currency string   the swap currency (default "divi")
      --swap-rpc-host string       the swap currency host of the wallet RPC server (default "localhost")
      --swap-rpc-network string    the swap network configuration (default "regtest")
      --swap-rpc-password string   the swap currency password of the wallet RPC server (default "password")
      --swap-rpc-port int          the swap currency port of the wallet RPC server (default 1337)
      --swap-rpc-user string       the swap currency user of the wallet RPC server (default "user")
      --use-base string            Use the base currency RPC specs for the CLI command, default is base (default "base")
      --use-swap string            Use the swap currency RPC specs for the CLI command, default is base (default "swap")

Atomic Swap environment files

By default the binary will reference ./.atomicswap.json as an environment file.

You can also define a configuration file with a flag

atomicswap --config .atomicswap.json

Below is a sample definition of an atomic swap configuration.

{
    "base-currency": "divi",
    "base-confirmations": 1,
    "base-rpc-host": "localhost",
    "base-rpc-port": 1337,
    "base-rpc-user": "divi",
    "base-rpc-password": "divi",
    "base-network": "regtest",
    "swap-currency": "bitcoin",
    "swap-confirmations": 1,
    "swap-rpc-host": "localhost",
    "swap-rpc-port": 1338,
    "swap-rpc-user": "bitcoin",
    "swap-rpc-password": "bitcoin",
    "swap-network": "regtest",
    "mongodb": "mongodb://localhost:27017",
    "database": "atomic-swaps",
    "server-port": 9001,
    "grpc-port": 9999
}

HTTP usage

Run as a HTTP gRPC server

atomicswap --serverport 9001

You can now run JSON RPC HTTP requests to the server. Please refer to our documentation page to learn how to interact with the RPC HTTP API.

Testing

Running go test will cover unit tests for the project. Keep in mind that in order to run regtest nodes. It's best that you use a shared Docker volume.

# Unix
docker build -t atomicswaps -f docker/test.Dockerfile .
docker run -it -v $PWD:/app atomicswaps

# Windows
docker build -t atomicswaps -f docker/test.Dockerfile .
docker run -it -v %cd%:/app atomicswaps

# After connecting to the container
sh bin/regtest.divi.sh
sh bin/regtest.bitcoin.sh

Once you have two functional regtest nodes running you will be able to run HTTP and CLI tests.

cd test
yarn # or npm install

# Test HTTP Queries
export SERVER_URL='http://localhost:9001'
yarn test-http

# Test CLI Queries
export BINARY_PATH='../dist/atomicswap'
yarn test-cli

# Setting CLI path on Windows
SET BINARY_PATH=..\dist\atomicswap.exe

Be mindful it may take a while to build and compile the container. Also make sure you have the minimum device specs to run the container. Suggested minimum specs are approximately 1GB of RAM on any normal VPS.

Issues and Pull Requests

Issues and pull requests are open on this repository. Please try to follow the guidelines specified in .github.