-
Notifications
You must be signed in to change notification settings - Fork 238
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'upstream/update-sbtc-docs' into patch-2
- Loading branch information
Showing
30 changed files
with
1,106 additions
and
1,136 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,53 @@ | ||
## Introduction to sBTC | ||
|
||
sBTC is a SIP-10 token on the Stacks blockchain that represents Bitcoin (BTC) in a 1:1 ratio. It enables Bitcoin holders to utilize their BTC within the Stacks ecosystem, allowing participation in DeFi applications and other smart contract functionalities while maintaining a peg to the underlying Bitcoin. | ||
sBTC is a SIP-010 token on the Stacks blockchain that represents Bitcoin (BTC) in a 1:1 ratio. It enables Bitcoin holders to participate in DeFi applications and other smart contract functionalities while maintaining a peg to the underlying Bitcoin. | ||
|
||
### Purpose | ||
|
||
The primary purpose of sBTC is to bridge the Bitcoin and Stacks ecosystems, providing Bitcoin holders with access to the rich functionality of smart contracts on the Stacks blockchain without sacrificing the security and value of their BTC holdings. | ||
|
||
### Version | ||
|
||
This documentation primarily covers sBTC-v1, which is designed as a builder-first stand-in for a more decentralized version. Future versions (e.g., sBTC-v2) will introduce a more robust, open-network signer set and additional economic incentives for signers to faithfully process transactions. | ||
The primary purpose of sBTC is to bridge Bitcoin to DeFi via the Stacks blockchain, providing Bitcoin holders with access to the rich functionality of smart contracts without sacrificing the security and value of their BTC holdings. | ||
|
||
### Key Benefits | ||
|
||
1. **Bitcoin Compatibility**: Allows Bitcoin holders to participate in the Stacks ecosystem without selling their BTC. | ||
2. **DeFi Access**: Enables BTC holders to engage with decentralized finance applications on Stacks. | ||
2. **DeFi Access**: Enables BTC holders to participate in DeFi. | ||
3. **Quick Conversions**: Facilitates rapid movement between BTC and sBTC. | ||
4. **Decentralized Management**: Utilizes a set of signers for maintaining the peg wallet. | ||
5. **Community Governance**: Involves the community in key decisions, such as selecting the initial signing set. | ||
|
||
## Table of Contents | ||
|
||
1. [Key Concepts](key-concepts.md) | ||
2. [Core Features](core-features.md) | ||
3. [sBTC Operations](operations/README.md) | ||
- [Deposit](operations/deposit.md) | ||
- [Withdrawal](operations/withdrawal.md) | ||
4. [Peg Wallet UTxO](peg-wallet-utxo.md) | ||
5. [Clarity Contracts](clarity-contracts.md) | ||
6. [Auxiliary Features](auxiliary-features/README.md) | ||
- [Transaction Fee Sponsorship](auxiliary-features/fee-sponsorship.md) | ||
- [Dynamic Blocklist](auxiliary-features/dynamic-blocklist.md) | ||
- [Signer Wallet Rotation](auxiliary-features/signer-wallet-rotation.md) | ||
7. [Security Considerations](security-considerations.md) | ||
8. [Future Development](future-development.md) | ||
|
||
For developers and contributors, please refer to the [sBTC-v1 GitHub repository](https://github.com/stacks-network/sbtc) for the latest updates and development progress. | ||
## Key Concepts | ||
|
||
Understanding sBTC requires familiarity with several key concepts. | ||
|
||
### sBTC | ||
|
||
sBTC is a SIP-010 token on the Stacks Blockchain that can be converted back to BTC on the Bitcoin Blockchain. The key property of sBTC is its 1:1 peg to Bitcoin, meaning 1 sBTC is always equivalent to 1 BTC. | ||
|
||
### sBTC UTXO | ||
|
||
The sBTC UTXO is the single unspent transaction output (UTXO) on the Bitcoin blockchain that holds the entire BTC balance pegged into sBTC. This UTXO is managed and maintained by the sBTC Signers. | ||
|
||
### sBTC Signer | ||
|
||
In sBTC, the sBTC Signer is a signer entity separate from the Stacks Nakamoto signer. sBTC signer responsibilities include: | ||
|
||
- Signing sBTC operations | ||
- Communicating with contracts on the Stacks chain | ||
- Managing the sBTC UTXO | ||
|
||
### sBTC Signer Set | ||
|
||
The sBTC Signer Set is the group of all sBTC signers. This set has full democratic access to the sBTC UTXO. Key properties include: | ||
|
||
- Selected through a community vote weighted by STX holdings | ||
- Responsible for maintaining the security of the peg wallet | ||
- Ability to rotate their private keys for enhanced security | ||
|
||
### Emily API | ||
|
||
Emily is an API that helps facilitate and supervise the sBTC Bridge in addition to serving as a programmatic liaison between sBTC users and signers. | ||
|
||
### SIP-010 Token | ||
|
||
sBTC adheres to the SIP-010 standard for fungible tokens on the Stacks blockchain. This ensures compatibility with wallets and applications that support the SIP-010 standard. | ||
|
||
Understanding these concepts is crucial for grasping the overall architecture and functionality of sBTC. In the following sections, we'll explore how these concepts come together to create sBTC. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
188 changes: 0 additions & 188 deletions
188
concepts/sbtc/clarity-contracts/sbtc-bootstrap-signers.md
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.