README.md

BitcoinOil Core

Setup

BitcoinOil Core is the original BitcoinOil client and it builds the backbone of the network. It downloads and, by default, stores the entire history of BitcoinOil transactions, which requires a few hundred gigabytes of disk space. Depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.

To download BitcoinOil Core, visit bitcoinoilcore.org.

Running

The following are some helpful notes on how to run BitcoinOil Core on your native platform.

Unix

Unpack the files into a directory and run:

• bin/bitcoinoil-qt (GUI) or
• bin/bitcoinoild (headless)

Windows

Unpack the files into a directory, and then run bitcoinoil-qt.exe.

macOS

Drag BitcoinOil Core to your applications folder, and then run BitcoinOil Core.

Need Help?

• See the documentation at the BitcoinOil Wiki for help and more information.
• Ask for help on BitcoinOil StackExchange.
• Ask for help on #bitcoinoil on Libera Chat. If you don't have an IRC client, you can use web.libera.chat.
• Ask for help on the BitcoinOilTalk forums, in the Technical Support board.

Building

The following are developer notes on how to build BitcoinOil Core on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.

• Dependencies
• macOS Build Notes
• Unix Build Notes
• Windows Build Notes
• FreeBSD Build Notes
• OpenBSD Build Notes
• NetBSD Build Notes
• Android Build Notes

Development

The BitcoinOil repo's root README contains relevant information on the development process and automated testing.

• Developer Notes
• Productivity Notes
• Release Process
• Source Code Documentation (External Link)
• Translation Process
• Translation Strings Policy
• JSON-RPC Interface
• Unauthenticated REST Interface
• Shared Libraries
• BIPS
• Dnsseed Policy
• Benchmarking
• Internal Design Docs

Resources

• Discuss on the BitcoinOilTalk forums, in the Development & Technical Discussion board.
• Discuss project-specific development on #bitcoinoil-core-dev on Libera Chat. If you don't have an IRC client, you can use web.libera.chat.

Miscellaneous

• Assets Attribution
• bitcoinoil.conf Configuration File
• CJDNS Support
• Files
• Fuzz-testing
• I2P Support
• Init Scripts (systemd/upstart/openrc)
• Managing Wallets
• Multisig Tutorial
• P2P bad ports definition and list
• PSBT support
• Reduce Memory
• Reduce Traffic
• Tor Support
• Transaction Relay Policy
• ZMQ

License

Distributed under the MIT software license.