Fix typos (#105)

* fix typos * fix typos * fix typo * fix typo * fix typos * fix typo * fix typos
stacks-network · Oct 19, 2023 · 830f5ea · 830f5ea
1 parent b7e190c
commit 830f5ea
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 13 deletions.
diff --git a/src/how-to-deposit-and-withdraw.md b/src/how-to-deposit-and-withdraw.md
@@ -7,7 +7,7 @@ Depositing and withdrawing sBTC can be done in three ways:
 
 This guide will walk you through how to deposit and withdraw sBTC using the sBTC Brdige application.
 
-## Perparation
+## Preparation
 First, make sure you have the [Hiro Wallet](https://wallet.hiro.so/) browser extension installed.
 Then, to begin your deposit or withdrawal, navigate to [https://bridge.stx.eco/](https://bridge.stx.eco/).
 Once there, click the `Settings` dropdown and make sure you're on the right network.
@@ -19,18 +19,18 @@ Thereafter, you should select the appropriate transaction mode:
 With these settings in place, you may proceed to do your deposit or withdrawal.
 
 ## How to Deposit
-To deposit you will be promted to enter
+To deposit you will be prompted to enter
 
 1. Your bitcoin address to deposit from.
 2. A stacks address to receive the sBTC.
 3. The amount to deposit.
 
 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.
 
-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.
+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.
 
 ## How to Withdraw
-To withdraw you will be promted to enter
+To withdraw you will be prompted to enter
 
 1. Your bitcoin address to receive the BTC which is also used to request the withdrawal.
 2. Your stacks address from which the sBTC should be withdrawn.
@@ -39,5 +39,5 @@ To withdraw you will be promted to enter
 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.
 
-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.
+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.
diff --git a/src/introduction.md b/src/introduction.md
@@ -13,7 +13,7 @@ To understand sBTC, we first need to understand the current limitations of Bitco
 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.
+Although Bitcoin has a simple scripting system built in, it lacks the expressiveness of many other smart contract languages.
 
 sBTC is for:
 
@@ -47,7 +47,7 @@ To withdraw BTC, a Bitcoin holder creates a withdrawal transaction on the Bitcoi
 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.
 
-The following diagram illustrate the deposit and withdrawal flows.
+The following diagram illustrates the deposit and withdrawal flows.
 
 ```mermaid
 sequenceDiagram

diff --git a/src/local-setup.md b/src/local-setup.md
@@ -46,7 +46,7 @@ Let's check to make sure things are running by visiting the Stacks explorer and
 
 The deployment of the Clarity contracts `asset.clar` and `clarinet-bitcoin-mini.clar` happens during the launch of devenv.sbtcWalletAddress
 
-Under the hood, the there is a script `utils/deploy_contracts.sh` 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.
+Under the hood, there is a script `utils/deploy_contracts.sh` 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.
 
 ## Prepare Wallet
 You can take a look at the config file at `sbtc/devenv/sbtc/docker/config.json` 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 `mint` function in the sBTC contract.

diff --git a/src/nakamoto-signer-developer-guide.md b/src/nakamoto-signer-developer-guide.md
@@ -6,7 +6,7 @@ The readers of this are assumed to be anyone who is looking to run a sBTC Signer
 
 # Disclaimer
 
-Development is on going and changes to the Signer configuration should be expected. This document will be updated every sprint to ensure its accuracy.
+Development is ongoing and changes to the Signer configuration should be expected. This document will be updated every sprint to ensure its accuracy.
 
 ## Prerequisites
 

diff --git a/src/pox-contract.md b/src/pox-contract.md
@@ -1,4 +1,4 @@
 # The PoX Contract
-Explanation of the PoX contracts and it's public functions. It should be clear which functions a user would interact with, which ones are used by stackers, and which ones that are called as part of Stacks consensus (sBTC mint/burn).
+Explanation of the PoX contracts and its public functions. It should be clear which functions a user would interact with, which ones are used by stackers, and which ones are called as part of Stacks consensus (sBTC mint/burn).
 
 TODO: [#9](https://github.com/stacks-network/sbtc-docs/issues/9)
diff --git a/src/sbtc-roadmap.md b/src/sbtc-roadmap.md
@@ -67,7 +67,7 @@ Once the deposit flow is implemented, the next effort is to ensure withdrawals w
 When deposits and withdrawals work end to end, the first version of the developer release is done. This should be promptly followed by an upgraded version supporting both flows with commit-reveal operations. This version should be able to monitor bitcoin testnet for revealed deposit and withdrawal request transactions. Moreover, the version should also provide a revealer implementation where clients can provide the commit witness script and address allowing the developer release system to reveal the committed transaction.
 
 ## sBTC Nakamoto
-The secure and decentralized version of sBTC, titled "sBTC Nakamoto", builds on the updated block production rules introduced in the [Stacks Nakamoto Release](https://github.com/stacks-network/stacks/blob/master/sBTC/nakamoto.md). As we approach this release, the sBTC implementation plan should be refined, but for now we have identified the main components with rough estimates of how much work they will need. The following sections explains those efforts.
+The secure and decentralized version of sBTC, titled "sBTC Nakamoto", builds on the updated block production rules introduced in the [Stacks Nakamoto Release](https://github.com/stacks-network/stacks/blob/master/sBTC/nakamoto.md). As we approach this release, the sBTC implementation plan should be refined, but for now we have identified the main components with rough estimates of how much work they will need. The following sections explain those efforts.
 
 ### sBTC Signer
 The sBTC signer will build on the stacks signer implemented in the Nakamoto Release. This effort is to adapt the signer to maintain custody of the sBTC wallet, so that the stackers can sign and broadcast withdrawal fulfillment transactions, sBTC wallet handoff transactions and reveal transactions in commit-reveal.

diff --git a/src/stacker-responsibilities.md b/src/stacker-responsibilities.md
@@ -1,6 +1,6 @@
 # Stacker responsibilities
 
-One of the most significant changes to accomodate the sBTC design is that Stackers must now perform active work to continue receiving PoX rewards. Stackers provide partial signatures for BTC withdrawal fulfillment transactions[the BTC wallet] for the duration of each reward cycle in which their STX are locked. This chapter outlines the new role of the stackers, and how they interact with each other to fulfill their duties.
+One of the most significant changes to accommodate the sBTC design is that Stackers must now perform active work to continue receiving PoX rewards. Stackers provide partial signatures for BTC withdrawal fulfillment transactions[the BTC wallet] for the duration of each reward cycle in which their STX are locked. This chapter outlines the new role of the stackers, and how they interact with each other to fulfill their duties.
 
 ## sBTC wallet address generation
 
@@ -16,6 +16,6 @@ An sBTC Wallet handoff is used by the current reward cycle's Stackers to send al
 
 ## sBTC Withdrawal fulfillment
 
-To fulfill an sBTC withdrawal request, Stackers send one or more Bitcoin transactions that pay the requested amount of BTC to the withdrawal address stipulated by the withdrawal request. If Stackers have receieved their sBTC wallet handoff and they fail to fulfill a request within 50 Bitcoin blocks of the request being finalized (i.e. at most 150 Bitcoin blocks after the request is submitted), then the system transitions to Recovery mode and PoX payouts are repurposed for fulfilling pending withdrawal requests.
+To fulfill an sBTC withdrawal request, Stackers send one or more Bitcoin transactions that pay the requested amount of BTC to the withdrawal address stipulated by the withdrawal request. If Stackers have received their sBTC wallet handoff and they fail to fulfill a request within 50 Bitcoin blocks of the request being finalized (i.e. at most 150 Bitcoin blocks after the request is submitted), then the system transitions to Recovery mode and PoX payouts are repurposed for fulfilling pending withdrawal requests.
 
 If Stackers do not fulfill the pending sBTC withdrawal requests, their STX will be frozen by .pox and any earned BTC used to fulfill these pending requests. Stackers may only receive back their STX and resume earning BTC once all the withdrawal requests for which they were responsible are fulfilled.