⚙️Overview
A hub for developers looking to build with BitFlow.
Welcome to BitFlow's developer documentation. As an open-source protocol, BitFlow welcomes developers from all backgrounds to contribute to, build upon, and integrate with our codebase. For transparency, all our smart contracts are readily available to the public.
Within our developer documentation, you'll discover:
A comprehensive overview of BitFlow's core smart contracts.
A curated collection of resources tailored specifically for developers.
The Bitflow SDK, including installation, configuration, and usage in your project
Opportunities to make significant contributions to our ecosystem.
Primary Resources
These resources, housed within this documentation, are specifically tailored to BitFlow.
An overview of the Bitflow SDK, including installation, configuration, and usage in your project. Bitflow SDK is a powerful and easy-to-use library for interacting with the Bitflow Protocol. It provides a set of tools to seamlessly integrate Bitflow functionality into your applications.
This page offers a detailed look at BitFlow's core smart contracts, covering aspects like functions, variables, error codes, and more, along with relevant code snippets.
This page contains a list of repositories utilized by BitFlow, either managed and maintained directly by the BitFlow GitHub organization or another organization.
This page contains a list of deployed smart contracts utilized by BitFlow, categorized by their respective chains.
Additional Resources
These supplementary resources can assist you in your development journey. Please note that they are third-party materials and are not directly provided by BitFlow.
A detailed overview of Clarity, a decidable smart contract language designed specifically for predictable execution and developer clarity, used on the Stacks layers.
The official website for sBTC, a novel Bitcoin synthetic derivative featuring a decentralized two-way peg mechanism with Bitcoin, operating on the Stacks layer.
A detailed overview of the functionalities, integration methods, and core concepts of the Magic Protocol, a trustless bridge facilitating xBTC <-> BTC transfers between the Stacks layer and the Bitcoin blockchain.
An overview of Sovryn, a decentralized suite of financial services that operates on the Rootstock network.
A detailed overview of the Stacks layer, its consensus mechanism, smart contract capabilities, and how it extends the functionalities of the Bitcoin network.
A detailed overview of Rootstock, a Bitcoin sidechain with merge-mining and Ethereum-compatible smart contracts.
Codebase Contribution
BitFlow believes in the power of collective intelligence and the open-source ethos. By harnessing the skills and insights of developers worldwide, we can refine, expand, and optimize our protocol, ensuring robustness, security, and innovative growth.
For questions about contributing, please join our Discord server.
Last updated