atomic-swap/docs/build.md

Building the project

From source

1. Install Golang

On Ubuntu, the easiest way to keep up-to-date with the latest stable version of Go is with snap:

sudo snap install go --classic

On other systems or in docker, use the directions here: https://go.dev/doc/install. Summary for X86-64 Linux (update GO_VERSION below to the latest stable release):

GO_VERSION=1.20.3
wget "https://go.dev/dl/go${GO_VERSION}.linux-amd64.tar.gz"
rm -rf /usr/local/go && tar -C /usr/local -xzf go${GO_VERSION}.linux-amd64.tar.gz
echo "export PATH=$PATH:/usr/local/go/bin" >> .profile
source .profile

2. Clone the repo:

git clone https://github.com/athanorlabs/atomic-swap.git
cd atomic-swap

3. Finally, build the repo:

make build

This creates swapd and swapcli binaries in the bin folder.

Note: if you wish to run a bootnode (see here), run make build-all.

Docker

1. Ensure docker is installed on your machine.

2. Build the docker image:

make docker-images

3. For an example of how to run swapd with docker on stagenet:

./scripts/docker-swapd/run-docker-image.sh

This runs swapd on stagenet. The container name is swapd-stagenet.

You can interact with it by running swapcli inside the container:

docker exec CONTAINER_NAME_OR_ID swapcli SUBCOMMAND ...

You can also set command line arguments with environment variables, eg. to run on mainnet:

SWAPD_ENV=mainnet SWAPD_ETH_ENDPOINT=your-eth-endpoint ./scripts/docker-swapd/run-docker-image.sh