A work-in-progress for Zcash Bitcoin Cross-Chain Atomic Transactions
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
README.md
api.py
bXcat.py
bitcoin-xcat.py
btc-p2sh-htlc.py
htlc-redeemAfterTimeLock.py
requirements.txt
secret.json
test.py
trades.py
userInput.py
utils.py
xcat.json
xcat.py
zXcat.py
zcashcli.py
zec-p2sh-htlc.py

README.md

ZBXCAT

A work-in-progress for Zcash Bitcoin Cross-Chain Atomic Transactions

Contains basic scripts we're still testing in regtest mode on both networks. This may all be refactored as we go.

Bitcoin scripts use the rpc proxy code in python-bitcoinlib, and Zcash script will use python-zcashlib (a Zcash fork of python-bitcoinlib).

Setup

To successfully run this, you'll need python3, the dependencies installed, and a bitcoin daemon running in regtest mode.

To install python3 in a virtualenv, run this command from the top level of the directory:

virtualenv -p python3 venv
source venv/bin/activate

To install dependencies, run:

pip install -r requirements.txt

To install python-zcashlib for testing and editing, clone the repository to your local filesystem. It is currently on a branch of python-bitcoinlib maintained by @arcalinea.

git clone https://github.com/arcalinea/python-bitcoinlib.git
cd python-bitcoinlib
git checkout zcashlib

Then, install the module locally in editable mode through pip, so that you can make changes to the code of python-zcashlib and they will be applied immediately. It is necessary to install python-zcashlib this way for now because the fork of the library likely contains many bugs, which need to be fixed before zec-p2sh-htlc.py will work properly.

To install python-zcashlib from your local filesystem path in editable mode:

pip install --editable (-e) <path-to-zcashlib-fork-of-python-bitcoinlib>

Run Zcash and Bitcoin daemons locally

To test, run a Zcash daemon and bitcoin daemon in regtest mode. You may have to change the port one of them runs on, for example with the flag -port=18445.

To run a bitcoin daemon in regtest mode, with the ability to inspect transactions outside your wallet (useful for testing purposes), use the command

bitcoind -regtest -txindex=1 -daemon -port=18445

Be sure to run a Zcash daemon in regtest mode.

zcashd -regtest -txindex=1 --daemon

XCAT CLI interface

Run xcat.py to go through the protocol. xcat.py new creats a new trade, xcat.py seller progresses with the seller's next step, xcat.py buyer progresses with the buyer's next step.

To test the entire script workflow, run test.py.

Misc

I used the module future to make existing python2 code for the rpc interface compatible with python3.