Files
ark/server/README.md
Marco Argentieri a8ed0bf6a4 Update README.md (#231)
Signed-off-by: Marco Argentieri <3596602+tiero@users.noreply.github.com>
2024-08-09 11:38:38 +02:00

26 lines
659 B
Markdown
Executable File

# Ark Server
The Ark Server is a Go implementation of an Ark Service Provider (ASP). An ASP it's an always-on server that provides bitcoin liquidity in the Ark layer-two protocol. It supports Bitcoin and Liquid (with more experimantal features using covenants).
**ALPHA STAGE SOFTWARE: USE AT YOUR OWN RISK!**
## Development
### Prerequisites
- [Go](https://go.dev/doc/install)
- [Bitcoin Core](https://bitcoincore.org) with `compact block filters` enabled
### Build Server
```bash
make build
```
### Run the server
```bash
go run ./cmd/arkd
```
Refer to [config.go](./internal/config/config.go) for the available configuration options via ENV VARs.