https://github.com/kanzure/bitcoin-reorg-compatibility-toy

Bitcoin reorg-compatibility service example.
https://github.com/kanzure/bitcoin-reorg-compatibility-toy

Last synced: 9 days ago
JSON representation

Bitcoin reorg-compatibility service example.

• Host: GitHub
• URL: https://github.com/kanzure/bitcoin-reorg-compatibility-toy
• Owner: kanzure
• License: other
• Created: 2014-11-16T14:18:38.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2014-11-16T14:18:48.000Z (about 10 years ago)
• Last Synced: 2025-01-11T15:56:04.380Z (13 days ago)
• Language: Shell
• Size: 105 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bitcoin-reorg-compatibility-toy

**bitcoin-reorg-compatibility-toy** is a small python project to demonstrate the concept of "reorg-compatibility". Any software implementing a Bitcoin service must be reorg-compatible except in the most mundane and stateless scenarios. Reorg-compatibility is when software is written in a way that aggressively correctly handles reorgs. Although reorg-compatibility has many benefits, in general it is good to prefer architecture that does not need to be concerned with blockchain reorganizations.

# Usage

## Installing development dependencies

See [requirements-dev.apt](requirements-dev.apt) for a list of packages required to develop and work with the software in this repository. Basically just run something like:

```

sudo apt-get install -y $(cat ./requirements-dev.apt)

```

## Building the docker container

```

make build

```

# Words of caution

## Only one docker container?

The toy in this repo is used in a docker container that runs bitcoind as well as the example software. This is a bad idea and it is not recommended.

## Private keys

Never store private keys in production.

# License

BSD