Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 3.34 KB

README.md

File metadata and controls

44 lines (28 loc) · 3.34 KB
Raw

GitHub Workflow Status: build GitHub Workflow Status: test Crates.io License: MIT MSRV

Farcaster: cross-chain atomic swaps

This work is still evolving, use it on mainnet at your own risk!

The Farcaster Node is a collection of microservices for running cross-chain atomic swaps. Currently, the node is focused on Bitcoin-Monero atomic swaps, but it is designed to be flexible and integrate new crypto-pairs in the future.

Microservices currently implemented:

  • farcasterd (1 instance): the swap manager, it is aware of every initiated swap and interconnects all the other microservices, launches and kills other microservices, and exposes an API for the swap-cli client
  • swapd (1 instance per swap): control centre for an individual swap -- keeps track of the swap's state as it runs the protocol's state machine, and orchestrates the swap with peerd for communicating with swap counterparty, walletd for signing, and syncers for blockchain interactions.
  • walletd (1 instance): where the master secret keys live, spawns a new key manager for each swap.
  • swap-cli: stateless terminal client (=executes a single command and terminates) that commands farcasterd, for taking or making deals, for example.
  • peerd (1 instance per peer connection): handles the connection to an individual peer.
  • syncerd (1 instance per blockchain, i.e. one for monero and one for bitcoin): interface for getting updates of the blockchain and for broadcasting transactions.
  • databased (1 instance): interface for storing data persistently across restart.
  • grpcd (1 instance): interface for exposing node interfaces as a gRPC endpoint.

Farcaster Node is build on atomic swap primitives described in the RFCs and implemented in Farcaster Core.

Documentation

Checkout Farcaster documentation in the wiki or in the docs/ folder.

Releases and Changelog

See CHANGELOG.md and RELEASING.md.

About

This work is part of the Farcaster cross-chain atomic swap project, see Farcaster Project, and is based on LNP/BP work, this project is a fork from LNP-BP/lnp-node since acbb4c.

Licensing

The code in this project is licensed under the MIT License.

Ways of communication

IRC channels on Libera.chat #monero-swap, Bitcoin-Monero cross-chain atomic swaps research and development.