Skip to content
This repository has been archived by the owner on Dec 4, 2024. It is now read-only.

Commit

Permalink
deploy: 830f5ea
Browse files Browse the repository at this point in the history
  • Loading branch information
Deploy from CI committed Oct 19, 2023
1 parent 379401f commit 1b7ac9c
Show file tree
Hide file tree
Showing 9 changed files with 26 additions and 26 deletions.
10 changes: 5 additions & 5 deletions how-to-deposit-and-withdraw.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ <h1 id="how-to-deposit-and-withdraw"><a class="header" href="#how-to-deposit-and
<li>Using an app which integrates with sBTC natively.</li>
</ol>
<p>This guide will walk you through how to deposit and withdraw sBTC using the sBTC Brdige application.</p>
<h2 id="perparation"><a class="header" href="#perparation">Perparation</a></h2>
<h2 id="preparation"><a class="header" href="#preparation">Preparation</a></h2>
<p>First, make sure you have the <a href="https://wallet.hiro.so/">Hiro Wallet</a> browser extension installed.
Then, to begin your deposit or withdrawal, navigate to <a href="https://bridge.stx.eco/">https://bridge.stx.eco/</a>.
Once there, click the <code>Settings</code> dropdown and make sure you're on the right network.
Expand All @@ -190,24 +190,24 @@ <h2 id="perparation"><a class="header" href="#perparation">Perparation</a></h2>
</ul>
<p>With these settings in place, you may proceed to do your deposit or withdrawal.</p>
<h2 id="how-to-deposit"><a class="header" href="#how-to-deposit">How to Deposit</a></h2>
<p>To deposit you will be promted to enter</p>
<p>To deposit you will be prompted to enter</p>
<ol>
<li>Your bitcoin address to deposit from.</li>
<li>A stacks address to receive the sBTC.</li>
<li>The amount to deposit.</li>
</ol>
<p>Once you have entered this information and continue, you will either be prompted to sign a transaction with the Hiro Wallet or receive a QR code to scan depending on your transaction mode.</p>
<p>When you have signed or payed to the QR code you'll get a link to follow your request on the Bitcoin chain. The sBTC should be minted shortly after your request is mined.</p>
<p>When you have signed or paid to the QR code you'll get a link to follow your request on the Bitcoin chain. The sBTC should be minted shortly after your request is mined.</p>
<h2 id="how-to-withdraw"><a class="header" href="#how-to-withdraw">How to Withdraw</a></h2>
<p>To withdraw you will be promted to enter</p>
<p>To withdraw you will be prompted to enter</p>
<ol>
<li>Your bitcoin address to receive the BTC which is also used to request the withdrawal.</li>
<li>Your stacks address from which the sBTC should be withdrawn.</li>
<li>The amount to withdraw.</li>
</ol>
<p>You will then be prompted to sign a message payload with the Hiro Wallet to authenticate your request.
Once the request is authenticated you will be prompted to either sign a bitcoin transaction or receive a QR code to scan depending on your transaction mode.</p>
<p>When you have signed or payed to the QR code you'll get a link to follow your request on the Bitcoin chain. The sBTC should be burned shortly after your request is mined.
<p>When you have signed or paid to the QR code you'll get a link to follow your request on the Bitcoin chain. The sBTC should be burned shortly after your request is mined.
Thereafter, the system will wait until the sBTC burn is final before fulfilling your withdrawal on the Bitcoin chain. This may take up to 150 bitcoin blocks.</p>

</main>
Expand Down
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ <h1 id="introduction-to-sbtc"><a class="header" href="#introduction-to-sbtc">Int
<p>Bitcoin is to date the most secure and decentralized blockchain.
While Bitcoin is the largest cryptocurrency by market cap, comparatively few applications exist within the Bitcoin ecosystem.
Developers interested in building applications for the Bitcoin community often find it difficult or impossible to implement their logic directly on the Bitcoin chain.
Although Bitcoin has a simple scripting system built in, it lacks lacks the expressiveness of many other smart contract languages.</p>
Although Bitcoin has a simple scripting system built in, it lacks the expressiveness of many other smart contract languages.</p>
<p>sBTC is for:</p>
<ul>
<li>Bitcoin holders who want to participate in smart contracts.</li>
Expand Down Expand Up @@ -208,7 +208,7 @@ <h1 id="how-does-sbtc-work"><a class="header" href="#how-does-sbtc-work">How doe
<p>To withdraw BTC, a Bitcoin holder creates a withdrawal transaction on the Bitcoin chain.
This withdrawal transaction informs the protocol how much sBTC the holder wishes to withdraw, from which stacks address the sBTC should be withdrawn and which Bitcoin address should receive the withdrawn BTC.
In response to this transaction, the sBTC system burns the requested amount of sBTC from the given Stacks address and fulfills the withdrawal by issuing a BTC payment to the given BTC address with the same amount.</p>
<p>The following diagram illustrate the deposit and withdrawal flows.</p>
<p>The following diagram illustrates the deposit and withdrawal flows.</p>
<pre class="mermaid">sequenceDiagram
Actor Bitcoin holder
participant Bitcoin
Expand Down
4 changes: 2 additions & 2 deletions introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ <h1 id="introduction-to-sbtc"><a class="header" href="#introduction-to-sbtc">Int
<p>Bitcoin is to date the most secure and decentralized blockchain.
While Bitcoin is the largest cryptocurrency by market cap, comparatively few applications exist within the Bitcoin ecosystem.
Developers interested in building applications for the Bitcoin community often find it difficult or impossible to implement their logic directly on the Bitcoin chain.
Although Bitcoin has a simple scripting system built in, it lacks lacks the expressiveness of many other smart contract languages.</p>
Although Bitcoin has a simple scripting system built in, it lacks the expressiveness of many other smart contract languages.</p>
<p>sBTC is for:</p>
<ul>
<li>Bitcoin holders who want to participate in smart contracts.</li>
Expand Down Expand Up @@ -208,7 +208,7 @@ <h1 id="how-does-sbtc-work"><a class="header" href="#how-does-sbtc-work">How doe
<p>To withdraw BTC, a Bitcoin holder creates a withdrawal transaction on the Bitcoin chain.
This withdrawal transaction informs the protocol how much sBTC the holder wishes to withdraw, from which stacks address the sBTC should be withdrawn and which Bitcoin address should receive the withdrawn BTC.
In response to this transaction, the sBTC system burns the requested amount of sBTC from the given Stacks address and fulfills the withdrawal by issuing a BTC payment to the given BTC address with the same amount.</p>
<p>The following diagram illustrate the deposit and withdrawal flows.</p>
<p>The following diagram illustrates the deposit and withdrawal flows.</p>
<pre class="mermaid">sequenceDiagram
Actor Bitcoin holder
participant Bitcoin
Expand Down
2 changes: 1 addition & 1 deletion local-setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ <h2 id="launch-devnet"><a class="header" href="#launch-devnet">Launch Devnet</a>
</ul>
<h2 id="deploy-contracts"><a class="header" href="#deploy-contracts">Deploy Contracts</a></h2>
<p>The deployment of the Clarity contracts <code>asset.clar</code> and <code>clarinet-bitcoin-mini.clar</code> happens during the launch of devenv.sbtcWalletAddress</p>
<p>Under the hood, the there is a script <code>utils/deploy_contracts.sh</code> that is used to deploy the contracts The local environment defines wallets that are already funded. The deployer wallet is used to deploy the contract using clarinet deployments.</p>
<p>Under the hood, there is a script <code>utils/deploy_contracts.sh</code> that is used to deploy the contracts The local environment defines wallets that are already funded. The deployer wallet is used to deploy the contract using clarinet deployments.</p>
<h2 id="prepare-wallet"><a class="header" href="#prepare-wallet">Prepare Wallet</a></h2>
<p>You can take a look at the config file at <code>sbtc/devenv/sbtc/docker/config.json</code> to see the mnemonic that defines the taproot address that will be the contract owner for sBTC. This is the mnemonic that generates the address that will actually call the <code>mint</code> function in the sBTC contract.</p>
<p>If you take a look at the <code>sbtc/romeo/asset-contract/settings/Devnet.toml</code> you can see this mnemonic associated with a specific Stacks address. This will also be the address that will be used to deploy the actual contracts.</p>
Expand Down
2 changes: 1 addition & 1 deletion nakamoto-signer-developer-guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ <h1 id="what-is-this"><a class="header" href="#what-is-this">What is this</a></h
<p>Draft documentation for sBTC Signer specifically for the Nakamoto <a href="https://stacks-network.github.io/sbtc-docs/sbtc-roadmap.html">release</a></p>
<p>The readers of this are assumed to be anyone who is looking to run a sBTC Signer with minimal custom configuration.</p>
<h1 id="disclaimer"><a class="header" href="#disclaimer">Disclaimer</a></h1>
<p>Development is on going and changes to the Signer configuration should be expected. This document will be updated every sprint to ensure its accuracy.</p>
<p>Development is ongoing and changes to the Signer configuration should be expected. This document will be updated every sprint to ensure its accuracy.</p>
<h2 id="prerequisites"><a class="header" href="#prerequisites">Prerequisites</a></h2>
<p>Rust - <a href="https://www.rust-lang.org/tools/install">To install</a>.</p>
<p>Accessible Stacks node - A Stacks node running the stackerDB instance which is used for signer communication and transaction monitoring and broadcasting.</p>
Expand Down
Loading

0 comments on commit 1b7ac9c

Please sign in to comment.