bsvb/arc repository overview

⁠ARC

ARC is a transaction processor for Bitcoin that keeps track of the life cycle of a transaction as it is processed by the Bitcoin network. Next to the mining status of a transaction, ARC also keeps track of the various states that a transaction can be in.

Find the full documentation at https://bitcoin-sv.github.io/arc⁠

A more detailed documentation on how to run ARC can be found here: https://github.com/bitcoin-sv/arc/blob/main/README.md⁠

⁠Running ARC with Docker

ARC relies on the folowing other services to run alongside it:

• A Postgres DB with executed migrations
  • Migration files for BlockTx service can be found here: https://github.com/bitcoin-sv/arc/tree/main/internal/blocktx/store/postgresql/migrations⁠
  • Migration files for Metamorph service can be found here: https://github.com/bitcoin-sv/arc/tree/main/internal/metamorph/store/postgresql/migrations⁠
  • In order to run the migrations, it is suggeseted to use the go-migrate⁠ tooling
• A NATS⁠ message queue

This docker-compose file⁠ shows how ARC runs along with the required services.

Provided a postgres DB, a Bitcoin node and a NATS message queue is running, you can run ARC with the following command:

docker run -it --rm -p 9090:9090 -v $(pwd)/config.yaml:/service/config.yaml "/service/arc"

The configuration of ports, URLs, DB etc need to be provided in a configuration file. This configuration file should be mounted into the container. The configuration file should be mounted at /service/config.yaml. A sample config can be found in the repository: config.yaml⁠

You can also run each service seperately:

docker run -it --rm -p 9090:9090 -v $(pwd)/config.yaml:/service/config.yaml "/service/arc" "-api=true"
docker run -it --rm -p 9090:9090 -v $(pwd)/config.yaml:/service/config.yaml "/service/arc" "-blocktx=true"
docker run -it --rm -p 9090:9090 -v $(pwd)/config.yaml:/service/config.yaml "/service/arc" "-metamorph=true"