tBTC is a trustlessly Bitcoin-backed ERC-20 token.
The goal of the project is to provide a stronger 2-way peg than federated sidechains like Liquid, expanding use cases possible via today's Bitcoin network, while bringing superior money to other chains.
This is the primary repo of the project, containing the project documentation and majority of the on-chain code.
The docs and Solidity are built via CircleCI.
The documentation includes a project overview and rationale, as well as the on-chain specification. Docs should always be updated before or in tandem with code.
Docs are written in AsciiDoc, diagrams in a LaTeX package called Tikz. To build:
cd docs
# Generate diagrams
make pngs
# Generate index.pdf
asciidoctor-pdf index.adocInstall TeX Live manually, and other dependencies using CLI:
gem install asciidoctor-pdf --pre
brew install popplerInstall the TikZ package to your local LaTeX environment:
sudo cp docs/latex/tikz-uml.sty /usr/local/texlive/texmf-local/
# Update TeX package tree
sudo texhash
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}