Skip to content

Commit 0c3455e

Browse files
kenrogersgitbook-bot
authored andcommitted
GITBOOK-223: Add overview for Clarity contracts
1 parent e1c5513 commit 0c3455e

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,39 @@
11
# Clarity Contracts
22

3+
This graph summarizes the overall of the Clarity portion of the sBTC protocol.
4+
5+
Throughout this section, we'll expand on each contract and its functionality.
6+
7+
<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXe6LEEESrk6Az-iRR5ZeEuqOQvBESKtFvBIjSYPhAjLZ2LpEwM-UOnSWn4b6hFFv0uFnysxL6wO-BVgJaPTAdYUkbvBenJrY8rY-YrGT9CSwqdCl2kuS5ZhNheumR-yBPAOHtccAt1eOD4dU5Zi-14gBgwv?key=uPKXlfIDnNUlnyka_NtgIw" alt=""><figcaption></figcaption></figure>
8+
9+
### sBTC Clarity Contracts
10+
11+
At a high level, the sBTC Clarity contracts are responsible for the following:
12+
13+
#### sbtc-bootstrap signers
14+
15+
Core contract for meta signer functionality such as registration & the rotation process.
16+
17+
#### sbtc-deposit
18+
19+
Processing contract called by the signers to record a consumed Bitcoin transaction & mint some amount of sBTC to a principal contained in the payload.
20+
21+
#### sbtc-registry
22+
23+
State storage for maintaining upgradability across protocol.
24+
25+
#### sbtc-withdrawal
26+
27+
Interaction points for users and signers to update withdrawal request state.
28+
29+
### User Types
30+
31+
In addition to the contracts themselves, there are two main user types that will interact with these contracts.
32+
33+
#### Signer
34+
35+
A signer that is part of the current sBTC signer set. More information on signers and their role in sBTC can be found in the [Signer Process Walkthrough](../walkthroughs/signer-process.md).
36+
37+
#### Wallet
38+
39+
A participant in the Stacks/Bitcoin ecosystem that wants to deposit/withdraw/use sbtc.

0 commit comments

Comments
 (0)