From 28cafffc59d70b3cb152d86b1301cfde22ad2d34 Mon Sep 17 00:00:00 2001 From: wileyj <2847772+wileyj@users.noreply.github.com> Date: Mon, 8 Jul 2024 14:04:46 -0700 Subject: [PATCH 1/3] addressing all the old PR's that still had conflicts --- clarity/clarity-crash-course.md | 4 ++-- stacks-101/sips.md | 6 +++++ .../mine-mainnet-stacks-tokens.md | 23 ++++++++++--------- .../mine-testnet-stacks-tokens.md | 6 ++--- .../run-a-node-with-a-hosted-provider.md | 2 +- .../run-a-node-with-digital-ocean.md | 2 +- .../sending-bitcoin-with-leather-wallet.md | 2 +- .../verifying-a-bitcoin-transaction.md | 2 +- .../post-conditions-with-stacks.js.md | 4 ++-- tutorials/hello-stacks-quickstart-tutorial.md | 4 ++-- tutorials/tokens/creating-a-nft.md | 2 +- 11 files changed, 32 insertions(+), 25 deletions(-) diff --git a/clarity/clarity-crash-course.md b/clarity/clarity-crash-course.md index 9bb6f5b4bb..eea03f1a66 100644 --- a/clarity/clarity-crash-course.md +++ b/clarity/clarity-crash-course.md @@ -22,7 +22,7 @@ Those two semicolons are how we denote comments in Clarity. Then the next line down we have a public function declaration. -Here is out first glimpse of Clarity's syntax, which may be new to you depending on your development background. +Here is our first glimpse of Clarity's syntax, which may be new to you depending on your development background. For those new to Clarity, it's a little weird and uncomfortable at first, but one of the core design tenets of Clarity is simplicity and readability, and the more you work with it the more you come to appreciate the succinctness and _clarity_ (sorry) of the code you are writing. @@ -69,7 +69,7 @@ This will be a persistent state variable, so this is actually getting written to So if we were to write and deploy this contract (which you can do in the Stacks Explorer if you like), as soon as it gets deployed, it will run through the contract line by line executing anything at the root level. -Remember that Clarity is interpreted, not compiled, so there's not compile step when developing Clarity contracts. +Remember that Clarity is interpreted, no compiled, so there's not compile step when developing Clarity contracts. So this `define-data-var` will be evaluated and the `count` variable will be initialized with a value of 0. diff --git a/stacks-101/sips.md b/stacks-101/sips.md index 4ab6b46c66..cc11868ae7 100644 --- a/stacks-101/sips.md +++ b/stacks-101/sips.md @@ -22,6 +22,7 @@ More details of the meetings are available [here](https://github.com/stacksgov/s ### Ratified SIPSs +* [x] [SIP 000: Improvement Proposal Process](https://github.com/stacksgov/sips/blob/main/sips/sip-000/sip-000-stacks-improvement-proposal-process.md) * [x] [SIP 001: Burn Election](https://github.com/stacksgov/sips/blob/main/sips/sip-001/sip-001-burn-election.md) * [x] [SIP 002: Clarity, a language for predictable smart contracts](https://github.com/stacksgov/sips/blob/main/sips/sip-002/sip-002-smart-contract-language.md) * [x] [SIP 003: Peer Network](https://github.com/stacksgov/sips/blob/main/sips/sip-003/sip-003-peer-network.md) @@ -33,10 +34,15 @@ More details of the meetings are available [here](https://github.com/stacksgov/s * [x] [SIP 009: Standard Trait Definition for Non-Fungible Tokens](https://github.com/stacksgov/sips/blob/main/sips/sip-009/sip-009-nft-standard.md) * [x] [SIP 010: Standard Trait Definition for Fungible Tokens](https://github.com/stacksgov/sips/blob/main/sips/sip-010/sip-010-fungible-token-standard.md) * [x] [SIP 012: Burn Height Selection for a Network Upgrade to Introduce New Cost-Limits](https://github.com/stacksgov/sips/blob/main/sips/sip-012/sip-012-cost-limits-network-upgrade.md) +* [x] [SIP 013: Standard Trait Definition for Semi-Fungible Tokens](https://github.com/stacksgov/sips/blob/main/sips/sip-013/sip-013-semi-fungible-token-standard.md) * [x] [SIP-015: Stacks Upgrade of Proof-of-Transfer and Clarity](https://github.com/stacksgov/sips/blob/main/sips/sip-015/sip-015-network-upgrade.md) * [x] [SIP-016: Metadata for Tokens](https://github.com/stacksgov/sips/blob/main/sips/sip-016/sip-016-token-metadata.md) * [x] [SIP-018: Signed Structured Data](https://github.com/stacksgov/sips/blob/main/sips/sip-018/sip-018-signed-structured-data.md) +* [x] [SIP-019: Notifications for Token Metadata Updates](https://github.com/stacksgov/sips/blob/main/sips/sip-019/sip-019-token-metadata-update-notifications.md) * [x] [SIP-020: Bitwise Operations in Clarity](https://github.com/stacksgov/sips/blob/main/sips/sip-020/sip-020-bitwise-ops.md) +* [x] [SIP-022: Emergency Fix to PoX Stacking Increases](https://github.com/stacksgov/sips/blob/main/sips/sip-022/sip-022-emergency-pox-fix.md) +* [x] [SIP-023: Emergency Fix to Trait Invocation Behavior](https://github.com/stacksgov/sips/blob/main/sips/sip-023/sip-023-emergency-fix-traits.md) +* [x] [SIP-024: Emergency Fix to Data Validation and Serialization Behavior](https://github.com/stacksgov/sips/blob/main/sips/sip-024/sip-024-least-supertype-fix.md) ### How to Get Involved diff --git a/stacks-in-depth/nodes-and-miners/mine-mainnet-stacks-tokens.md b/stacks-in-depth/nodes-and-miners/mine-mainnet-stacks-tokens.md index 94309c5450..3da6465d4c 100644 --- a/stacks-in-depth/nodes-and-miners/mine-mainnet-stacks-tokens.md +++ b/stacks-in-depth/nodes-and-miners/mine-mainnet-stacks-tokens.md @@ -19,7 +19,7 @@ First, download a [bitcoin binary](https://bitcoin.org/en/download), or [build f If you want to learn more about the technical details of mining, please review the mining guide: {% hint style="info" %} -**Tip:** It is recommened to use a persistent location for the chainstate, in the steps below we're using `/bitcoin`. +**Tip:** It is recommended to use a persistent location for the chainstate, in the steps below we're using `/bitcoin`. {% endhint %} #### Update the Bitcoin Configuration File @@ -79,7 +79,7 @@ getblockchaininfo | jq .blocks First, download the latest tagged [stacks blockchain binary](https://github.com/stacks-network/stacks-blockchain/releases/latest), or [build from source](https://github.com/stacksfoundation/miner-docs/blob/main/stacks-blockchain.md#build-and-install-stacks-blockchain-from-source) (_there may be some extra requirements to building,_ [_defined here_](https://github.com/stacksfoundation/miner-docs/blob/main/prerequisites.md#install-required-packages)). {% hint style="info" %} -**Tip:** It is recommened to use a persistent location for the chainstate, in the steps below we're using `/stacks-blockchain`. +**Tip:** It is recommended to use a persistent location for the chainstate, in the steps below we're using `/stacks-blockchain`. {% endhint %} #### Generate a keychain @@ -121,13 +121,14 @@ bitcoin-cli \ -rpcport=8332 \ -rpcuser=btcuser \ -rpcpassword=btcpass \ - createwallet "miner" \ - false \ - false \ - "" \ - false \ - false \ - true + createwallet \ + wallet_name="miner" \ + disable_private_keys=false \ + blank=false \ + passphrase="" \ + avoid_reuse=false \ + descriptors=false \ + load_on_startup=true ``` Now, import your wif (bitcoin private key) inside the newly created wallet. @@ -156,7 +157,7 @@ bitcoin-cli \ getaddressinfo ``` -Once imported, we need to get some BTC to that address. You should be able to transfer BTC to this address using a crytpocurrency exchange such as [Coinbase](https://www.coinbase.com), [Binance](https://www.binance.com), or [Kraken](https://www.kraken.com). +Once imported, we need to get some BTC to that address. You should be able to transfer BTC to this address using a cryptocurrency exchange such as [Coinbase](https://www.coinbase.com), [Binance](https://www.binance.com), or [Kraken](https://www.kraken.com). #### Update the Stacks Blockchain Configuration File @@ -231,7 +232,7 @@ We need to get some BTC to that address. You should be able to transfer BTC to t #### Update Stacks Blockchain Docker Configuration File -Use the steps oulined above to create the configuration file. +Use the steps outlined above to create the configuration file. #### Start the Stacks Blockchain miner with Docker diff --git a/stacks-in-depth/nodes-and-miners/mine-testnet-stacks-tokens.md b/stacks-in-depth/nodes-and-miners/mine-testnet-stacks-tokens.md index 9062f958f4..c456ca0f70 100644 --- a/stacks-in-depth/nodes-and-miners/mine-testnet-stacks-tokens.md +++ b/stacks-in-depth/nodes-and-miners/mine-testnet-stacks-tokens.md @@ -17,7 +17,7 @@ To participate as a miner on testnet, you must have access to a testnet bitcoin First, download a [bitcoin binary](https://bitcoin.org/en/download), or [build from source](https://github.com/stacksfoundation/miner-docs/blob/testnet/bitcoin.md#source-install) (_there may be some extra requirements to building,_ [_defined here_](https://github.com/stacksfoundation/miner-docs/blob/testnet/prerequisites.md#install-required-packages)). {% hint style="info" %} -**Tip:** It is recommened to use a persistent location for the chainstate, in the steps below we're using `/bitcoin`. +**Tip:** It is recommended to use a persistent location for the chainstate, in the steps below we're using `/bitcoin`. {% endhint %} #### Update the Bitcoin Configuration File @@ -81,7 +81,7 @@ getblockchaininfo | jq .blocks First, download the latest tagged [stacks blockchain binary](https://github.com/stacks-network/stacks-blockchain/releases/latest), or [build from source](https://github.com/stacksfoundation/miner-docs/blob/testnet/stacks-blockchain.md#build-and-install-stacks-blockchain-from-source) (_there may be some extra requirements to building,_ [_defined here_](https://github.com/stacksfoundation/miner-docs/blob/testnet/prerequisites.md#install-required-packages)). {% hint style="info" %} -**Tip:** It is recommened to use a persistent location for the chainstate, in the steps below we're using `/stacks-blockchain`. +**Tip:** It is recommended to use a persistent location for the chainstate, in the steps below we're using `/stacks-blockchain`. {% endhint %} #### Generate a keychain @@ -247,7 +247,7 @@ Now, we need to get some tBTC. Grab the `btcAddress` field, and paste it into [t #### Update Stacks Blockchain Docker Configuration File -Use the steps oulined above to create the configuration file. +Use the steps outlined above to create the configuration file. #### Start the Stacks Blockchain miner with Docker diff --git a/stacks-in-depth/nodes-and-miners/run-a-node-with-a-hosted-provider.md b/stacks-in-depth/nodes-and-miners/run-a-node-with-a-hosted-provider.md index edc1cd5a00..7af4130744 100644 --- a/stacks-in-depth/nodes-and-miners/run-a-node-with-a-hosted-provider.md +++ b/stacks-in-depth/nodes-and-miners/run-a-node-with-a-hosted-provider.md @@ -1,6 +1,6 @@ # Run a Node with a Hosted Provider -We're always looking for new hosting providers that enable anyone to run the Stacks Blockchain. Below, you'll find some examples on the current providers that are know to support running a node. +We're always looking for new hosting providers that enable anyone to run the Stacks Blockchain. Below, you'll find some examples of the current providers that are known to support running a node. ### Quicknode diff --git a/stacks-in-depth/nodes-and-miners/run-a-node-with-digital-ocean.md b/stacks-in-depth/nodes-and-miners/run-a-node-with-digital-ocean.md index 3e29ae9c6c..c863bba00e 100644 --- a/stacks-in-depth/nodes-and-miners/run-a-node-with-digital-ocean.md +++ b/stacks-in-depth/nodes-and-miners/run-a-node-with-digital-ocean.md @@ -18,7 +18,7 @@ Choose a plan (it will only allow you to select a droplet that meets the minimum **Step 3** -Enter a root password or [enable SSH keys](https://docs.digitalocean.com/products/droplets/how-to/add-ssh-keys/) if your prefer. +Enter a root password or [enable SSH keys](https://docs.digitalocean.com/products/droplets/how-to/add-ssh-keys/) if you prefer. **Step 4** diff --git a/tutorials/bitcoin-integration/sending-bitcoin-with-leather-wallet.md b/tutorials/bitcoin-integration/sending-bitcoin-with-leather-wallet.md index 83b98187a4..e1d2181bb1 100644 --- a/tutorials/bitcoin-integration/sending-bitcoin-with-leather-wallet.md +++ b/tutorials/bitcoin-integration/sending-bitcoin-with-leather-wallet.md @@ -2,7 +2,7 @@ Using Leather's web wallet, we can easily initiate a simple Bitcoin transaction using only a few lines of code. -You'll need to be authenticated with the Leather wallet for this to work, with you can see how to do in the Authentication with Stacks.js tutorial. +You'll need to be authenticated with the Leather wallet for this to work, which you can see how to do in the Authentication with Stacks.js tutorial. Once you have the wallet hooked up, you can use the Leather wallet API to initiate a simple Bitcoin transaction in your JS app like this. diff --git a/tutorials/bitcoin-integration/verifying-a-bitcoin-transaction.md b/tutorials/bitcoin-integration/verifying-a-bitcoin-transaction.md index a3c24ac31a..ae2ccef9f0 100644 --- a/tutorials/bitcoin-integration/verifying-a-bitcoin-transaction.md +++ b/tutorials/bitcoin-integration/verifying-a-bitcoin-transaction.md @@ -42,7 +42,7 @@ Here's a basic example where we are calling [Blockstream's API](https://github.c We can get all the information we need with nothing but the transaction ID, which will usually be passed to us when we use a wallet like [Hiro's web wallet](https://hirowallet.gitbook.io/developers/bitcoin/sign-transactions/sending-bitcoin) to initiate the Bitcoin transaction. -Let's go through the code we can use to implement this. For full context, this code is taken from the example [bitbadge](https://github.com/kenrogers/bitbadge) repo, which you can take a look at. For a complete ste-by-step walkthrough of how to implement this, check out the [Bitcoin Primer](https://bitcoinprimer.dev). +Let's go through the code we can use to implement this. For full context, this code is taken from the example [bitbadge](https://github.com/kenrogers/bitbadge) repo, which you can take a look at. For a complete step-by-step walkthrough of how to implement this, check out the [Bitcoin Primer](https://bitcoinprimer.dev). Here's the mint function: diff --git a/tutorials/frontend/post-conditions-with-stacks.js.md b/tutorials/frontend/post-conditions-with-stacks.js.md index a0706f56cd..04eee406d4 100644 --- a/tutorials/frontend/post-conditions-with-stacks.js.md +++ b/tutorials/frontend/post-conditions-with-stacks.js.md @@ -1,6 +1,6 @@ # Post Conditions with Stacks.js -The content in this recipe has ben pulled from the [tutorial on post conditions](https://dev.to/stacks/understanding-stacks-post-conditions-e65). Post conditions are an additional safety feature built into the Stacks chain itself that help to protect end users. +The content in this recipe has been pulled from the [tutorial on post conditions](https://dev.to/stacks/understanding-stacks-post-conditions-e65). Post conditions are an additional safety feature built into the Stacks chain itself that help to protect end users. Rather than being a function of Clarity smart contracts, they are implemented on the client side and meant to be an additional failsafe against malicious contracts. @@ -8,7 +8,7 @@ Put simply, post conditions are a set of conditions that must be met before a us So they are sent as part of the transaction when the user initiates it, meaning we need a frontend library to utilize them. -Whenever you are transferring an asset (fungible or non-fungible) from one address to another, you should taker advantage of post conditions. +Whenever you are transferring an asset (fungible or non-fungible) from one address to another, you should take advantage of post conditions. We're going to use [Stacks.js](https://github.com/hirosystems/stacks.js/tree/master/packages/transactions#post-conditions) to familiarize ourselves with them. diff --git a/tutorials/hello-stacks-quickstart-tutorial.md b/tutorials/hello-stacks-quickstart-tutorial.md index d4b370a238..a279804b1a 100644 --- a/tutorials/hello-stacks-quickstart-tutorial.md +++ b/tutorials/hello-stacks-quickstart-tutorial.md @@ -213,7 +213,7 @@ One of the coolest features of Clarinet is that it allows us to set up an entire This comes complete with a local block explorer and sandbox environment so we can further test our contracts. -Make sure you have Docker installed and running, exit out of console with `CMD/CTRL + C` and run `clarinet integrate`. +Make sure you have Docker installed and running, exit out of console with `CMD/CTRL + C` and run `clarinet devnet start`. It will take a few minutes to get up and running, but then we can open up our local Stacks block explorer. @@ -247,7 +247,7 @@ Make sure you copy your secret key before you sign out. You'll need it to restor Go ahead and copy the mnemonic listed in the `Devnet.toml` file and use that to import your local wallet into the Leather wallet. Then we can use that for interacting with our local Devnet chain. -Once you do that, go ahead and restart `clarinet integrate`. +Once you do that, go ahead and restart `clarinet devnet start`. Now we can go back to the sandbox and call that function. You might need to sign out of the sandbox first and reauthenticate. diff --git a/tutorials/tokens/creating-a-nft.md b/tutorials/tokens/creating-a-nft.md index 7d35e3aa3c..6ce6a6a78d 100644 --- a/tutorials/tokens/creating-a-nft.md +++ b/tutorials/tokens/creating-a-nft.md @@ -32,7 +32,7 @@ The official mainnet trait can be [found on the Stacks Explorer](https://explore ) ``` -All we are doing here is defining the function signatures for functions we'll need to implement in out Clarity contract, which we can see a simple version of below. +All we are doing here is defining the function signatures for functions we'll need to implement in our Clarity contract, which we can see a simple version of below. ### Clarity Code From c1c3e6728f1c4adadc156928d25b3cd08c641d97 Mon Sep 17 00:00:00 2001 From: wileyj <2847772+wileyj@users.noreply.github.com> Date: Mon, 8 Jul 2024 14:09:01 -0700 Subject: [PATCH 2/3] resolving conflicts in #1617 --- sbtc/developer-guides/end-to-end-tutorial.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sbtc/developer-guides/end-to-end-tutorial.md b/sbtc/developer-guides/end-to-end-tutorial.md index befb3a96c8..39d011243e 100644 --- a/sbtc/developer-guides/end-to-end-tutorial.md +++ b/sbtc/developer-guides/end-to-end-tutorial.md @@ -618,7 +618,7 @@ Next it's time to actually build the transaction. To do that we need to pass i: * Our utxos that we fetched * And where to send the remaining Bitcoin change after the transaction (UTXOs can only be spent as a whole, so we need to create another transaction to send any remainder) -Then we need to covnert that transaction to a PSBT. In order to use the Leather wallet, our transaction needs to be a PSBT, which we then pass to the wallet, use the wallet to sign, and then use the `sbtc` helper to broadcast it. +Then we need to convert that transaction to a PSBT. In order to use the Leather wallet, our transaction needs to be a PSBT, which we then pass to the wallet, use the wallet to sign, and then use the `sbtc` helper to broadcast it. The next few lines are converting the transaction to the right format, calling the wallet API to sign it, and broadcasting it. From 38b2887d91aec1298d940369279f4b493e775e85 Mon Sep 17 00:00:00 2001 From: wileyj <2847772+wileyj@users.noreply.github.com> Date: Tue, 9 Jul 2024 08:20:05 -0700 Subject: [PATCH 3/3] fix more typos --- clarity/functions.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/clarity/functions.md b/clarity/functions.md index 0ef082432c..0be9424de7 100644 --- a/clarity/functions.md +++ b/clarity/functions.md @@ -372,7 +372,7 @@ Introduced in: **Clarity 2** **description:** -Returns the one's compliement (sometimes also called the bitwise compliment or not operator) of `i1`, effectively reversing the bits in `i1`. In other words, every bit that is `1` in ì1`will be`0`in the result. Conversely, every bit that is`0`in`i1`will be`1\` in the result. +Returns the one's complement (sometimes also called the bitwise compliment or not operator) of `i1`, effectively reversing the bits in `i1`. In other words, every bit that is `1` in ì1`will be`0`in the result. Conversely, every bit that is`0`in`i1`will be`1\` in the result. **example:** @@ -1089,7 +1089,7 @@ Introduced in: **Clarity 1** **description:** -`ft-burn?` is used to decrease the token balance for the `sender` principal for a token type defined using `define-fungible-token`. The decreased token balance is _not_ transfered to another principal, but rather destroyed, reducing the circulating supply. +`ft-burn?` is used to decrease the token balance for the `sender` principal for a token type defined using `define-fungible-token`. The decreased token balance is _not_ transferred to another principal, but rather destroyed, reducing the circulating supply. On a successful burn, it returns `(ok true)`. In the event of an unsuccessful burn it returns one of the following error codes: @@ -1161,7 +1161,7 @@ Introduced in: **Clarity 1** `ft-mint?` is used to increase the token balance for the `recipient` principal for a token type defined using `define-fungible-token`. The increased token balance is _not_ transfered from another principal, but rather minted. -If a non-positive amount is provided to mint, this function returns `(err 1)`. Otherwise, on successfuly mint, it returns `(ok true)`. +If a non-positive amount is provided to mint, this function returns `(err 1)`. Otherwise, on successfully mint, it returns `(ok true)`. **example:**