diff --git a/docs/build-apps/authentication.md b/docs/build-apps/authentication.md index a2e12bb02..4df79168b 100644 --- a/docs/build-apps/authentication.md +++ b/docs/build-apps/authentication.md @@ -11,7 +11,7 @@ This guide explains how to authenticate users with the [`connect`](https://githu Authentication provides a way for users to identify themselves to an app while retaining complete control over their credentials and personal details. It can be integrated alone or used in conjunction with [transaction signing](/build-apps/transaction-signing) and [data storage](/build-apps/data-storage), for which it is a prerequisite. -Users who register for your app can subsequently authenticate to any other app with support for the [Bitcoin Naming System](https://docs.stacks.co/build-apps/references/bns) and vice versa. +Users who register for your app can subsequently authenticate to any other app with support for the [Bitcoin Naming System](https://docs.stacks.co/clarity/example-contracts/bns) and vice versa. ## How it works diff --git a/docs/build-apps/data-storage.md b/docs/build-apps/data-storage.md index 608159e5d..e8358e167 100644 --- a/docs/build-apps/data-storage.md +++ b/docs/build-apps/data-storage.md @@ -113,7 +113,7 @@ Encrypted files need `decrypt` set to `true` so the app knows to decrypt the dat ## Get data for other user -Apps can also retrieve public data saved by users other than the one with the active session, granted those users have registered usernames via the [Bitcoin Naming System](https://docs.stacks.co/build-apps/references/bns). +Apps can also retrieve public data saved by users other than the one with the active session, granted those users have registered usernames via the [Bitcoin Naming System](https://docs.stacks.co/clarity/example-contracts/bns). Simply indicate the username of such a user in the `options` object: diff --git a/docs/build-apps/integrate-stacking-delegation.md b/docs/build-apps/integrate-stacking-delegation.md index 55acecb76..d5d2dd00d 100644 --- a/docs/build-apps/integrate-stacking-delegation.md +++ b/docs/build-apps/integrate-stacking-delegation.md @@ -98,7 +98,7 @@ const delegetateResponse = await client.delegateStx({ // } ``` -This method calls the [`delegate-stx`](https://docs.stacks.co/references/stacking-contract#delegate-stx) method of the Stacking contract. Note, that the amount can be higher or lower than the current account balance. Delegation does not yet lock the STX tokens, users can still transfer them. +This method calls the [`delegate-stx`](https://docs.stacks.co/clarity/example-contracts/stacking#delegate-stx) method of the Stacking contract. Note, that the amount can be higher or lower than the current account balance. Delegation does not yet lock the STX tokens, users can still transfer them. :::tip @@ -122,7 +122,7 @@ const revokeResponse = await client.revokeDelegateStx(privateKey); // } ``` -This method calls the [`revoke-delegate-stx`](https://docs.stacks.co/references/stacking-contract#revoke-delegate-stx) method of the Stacking contract. +This method calls the [`revoke-delegate-stx`](https://docs.stacks.co/clarity/example-contracts/stacking#revoke-delegate-stx) method of the Stacking contract. :::tip @@ -172,7 +172,7 @@ const delegetateStackResponses = await delegatorClient.delegateStackStx({ // } ``` -This function calls the [`delegate-stack-stx`](https://docs.stacks.co/references/stacking-contract#delegate-stack-stx) method of the Stacking contract to lock up the STX token from the account holder. +This function calls the [`delegate-stack-stx`](https://docs.stacks.co/clarity/example-contracts/stacking#delegate-stack-stx) method of the Stacking contract to lock up the STX token from the account holder. The delegator must call this method multiple times (for all stackers), until enough tokens are locked up to participate in Stacking. This is the first part of delegated stacking for the delegator. @@ -201,7 +201,7 @@ const delegetateCommitResponse = await delegatorClient.stackAggregationCommit({ // } ``` -This method calls the [`stack-aggregation-commit`](https://docs.stacks.co/references/stacking-contract#stack-aggregation-commit) function of the Stacking contract. This call also includes locked Stacks from previous cycles. This is the second part of delegated stacking for the delegator. +This method calls the [`stack-aggregation-commit`](https://docs.stacks.co/clarity/example-contracts/stacking#stack-aggregation-commit) function of the Stacking contract. This call also includes locked Stacks from previous cycles. This is the second part of delegated stacking for the delegator. This method has to be called once for each reward cycle, even if all account holders have already locked their Stacks for several cycles in a row. If no new account holders are added to the pool, then this method call can be made even several cycles before the actual rewards cycle. diff --git a/docs/clarinet/guides/how-to-use-deployment-plans.md b/docs/clarinet/guides/how-to-use-deployment-plans.md index 5e7a69859..847c07fcc 100644 --- a/docs/clarinet/guides/how-to-use-deployment-plans.md +++ b/docs/clarinet/guides/how-to-use-deployment-plans.md @@ -68,7 +68,7 @@ Specifications in the `Clarinet.toml` file you can change include Specifications in the `Devnet.toml` file you can change include - Accounts, balances, and names - Blockchain environment features, such as block time or API ports, of your devnet -- [Stacking](https://docs.stacks.co/docs/understand-stacks/stacking) orders +- [Stacking](https://docs.stacks.co/stacks-101/stacking) orders ## Adding project contract requirements diff --git a/docs/example-apps/heystack.md b/docs/example-apps/heystack.md index 9260c2ace..8e4d3f2f7 100644 --- a/docs/example-apps/heystack.md +++ b/docs/example-apps/heystack.md @@ -635,7 +635,7 @@ specific implementation details. [`/src/store/auth.ts`]: https://github.com/hirosystems/heystack/blob/main/src/store/auth.ts [clarity types in javascript]: #clarity-types-in-javascript [`@stacks/transactions`]: https://github.com/blockstack/stacks.js/tree/master/packages/transactions#constructing-clarity-values -[bitcoin naming system]: https://docs.stacks.co/build-apps/references/bns +[bitcoin naming system]: https://docs.stacks.co/clarity/example-contracts/bns [`src/store/names.ts`]: https://github.com/hirosystems/heystack/blob/main/src/store/names.ts [javascript types to clarity types]: #clarity-types-in-javascript [`@stacks/blockchain-api-client`]: https://github.com/hirosystems/stacks-blockchain-api/tree/master/client diff --git a/docs/stacks-2.1-upgrades.md b/docs/stacks-2.1-upgrades.md index a0dffa99d..58632bc5e 100644 --- a/docs/stacks-2.1-upgrades.md +++ b/docs/stacks-2.1-upgrades.md @@ -8,11 +8,11 @@ In this article, you will learn about Stacks 2.05 to 2.1 migration and how the H ## What is Stacks 2.1? -[Stacks 2.1](https://stacks.org/stacks-21-what-to-expect) is a fork and protocol upgrade of the Stacks blockchain. Among [other improvements](https://www.hiro.so/blog/a-developers-guide-to-stacks-2-1), Stacks 2.1 includes an updated [Proof-of-Transfer](https://docs.stacks.co/docs/understand-stacks/proof-of-transfer) (PoX) [contract](https://docs.stacks.co/docs/clarity/noteworthy-contracts/stacking-contract) (often informally referred to as "PoX-2") for Stacking. Stacking allows users to lock up STX to support the network and earn BTC. For more information on stacking changes, refer to [How Stacks 2.1 Impacts Stacking](https://www.hiro.so/blog/how-the-stacks-2-1-transition-impacts-stacking). +[Stacks 2.1](https://stacks.org/stacks-21-what-to-expect) is a fork and protocol upgrade of the Stacks blockchain. Among [other improvements](https://www.hiro.so/blog/a-developers-guide-to-stacks-2-1), Stacks 2.1 includes an updated [Proof-of-Transfer](https://docs.stacks.co/stacks-101/proof-of-transfer) (PoX) [contract](https://docs.stacks.co/docs/clarity/noteworthy-contracts/stacking-contract) (often informally referred to as "PoX-2") for Stacking. Stacking allows users to lock up STX to support the network and earn BTC. For more information on stacking changes, refer to [How Stacks 2.1 Impacts Stacking](https://www.hiro.so/blog/how-the-stacks-2-1-transition-impacts-stacking). ## What is PoX-2? -[Proof-of-transfer (PoX)](https://docs.stacks.co/docs/understand-stacks/proof-of-transfer) is a consensus mechanism in modern blockchains. In Stacks 2.05 or earlier versions, this consensus mechanism uses the `.pox` ([boot/pox.clar](https://explorer.hiro.so/txid/SP000000000000000000002Q6VF78.pox?chain=mainnet&_gl=1*6fljeg*_ga*MTY3NTgyOTg2OS4xNjY2MjA3NDM3*_ga_NB2VBT0KY2*MTY3MDk1ODcyNS4xMTEuMC4xNjcwOTU4NzI1LjAuMC4w), aka PoX-1) boot smart contract. With the Stacks 2.1 upgrade, the new fork is updated to `.pox-2` ([boot/pox-2.clar](https://github.com/stacks-network/stacks-core/blob/1d8920ed68be2d1982b91f729522ff0c6e00572f/stackslib/src/chainstate/stacks/boot/pox-2.clar), aka PoX-2). +[Proof-of-transfer (PoX)](https://docs.stacks.co/stacks-101/proof-of-transfer) is a consensus mechanism in modern blockchains. In Stacks 2.05 or earlier versions, this consensus mechanism uses the `.pox` ([boot/pox.clar](https://explorer.hiro.so/txid/SP000000000000000000002Q6VF78.pox?chain=mainnet&_gl=1*6fljeg*_ga*MTY3NTgyOTg2OS4xNjY2MjA3NDM3*_ga_NB2VBT0KY2*MTY3MDk1ODcyNS4xMTEuMC4xNjcwOTU4NzI1LjAuMC4w), aka PoX-1) boot smart contract. With the Stacks 2.1 upgrade, the new fork is updated to `.pox-2` ([boot/pox-2.clar](https://github.com/stacks-network/stacks-core/blob/1d8920ed68be2d1982b91f729522ff0c6e00572f/stackslib/src/chainstate/stacks/boot/pox-2.clar), aka PoX-2). ### PoX-2 periods diff --git a/docs/stacks-blockchain-api/index.md b/docs/stacks-blockchain-api/index.md index 3a06795bf..6231c65e8 100644 --- a/docs/stacks-blockchain-api/index.md +++ b/docs/stacks-blockchain-api/index.md @@ -35,7 +35,7 @@ The Stacks Blockchain API is hosted by Hiro. Using it requires you to trust us a - The API also implements the Rosetta spec created by Coinbase -- "an open standard designed to simplify blockchain deployment and interaction." - See: https://www.rosetta-api.org/ - The API also implements the BNS (Blockchain Naming System) endpoints. - - See https://docs.stacks.co/build-apps/references/bns + - See https://docs.stacks.co/clarity/example-contracts/bns - See `/src/api/routes` for the Express.js routes. - The API creates an "event observer" http server which listens for events from a `stacks-node` "event emitter" diff --git a/docs/stacks.js/guides/authenticate-users-with-connect.md b/docs/stacks.js/guides/authenticate-users-with-connect.md index bebd178dc..6c8a7d85f 100644 --- a/docs/stacks.js/guides/authenticate-users-with-connect.md +++ b/docs/stacks.js/guides/authenticate-users-with-connect.md @@ -21,7 +21,7 @@ npm install @stacks/connect Authentication provides a way for users to identify themselves to an app while retaining complete control over their credentials and personal details. It can be integrated alone or used in conjunction with [transaction signing](/build-apps/transaction-signing) and [data storage](/build-apps/data-storage), for which it is a prerequisite. -Users who register for your app can subsequently authenticate to any other app with support for the [Blockchain Naming System](https://docs.stacks.co/build-apps/references/bns) and vice versa. +Users who register for your app can subsequently authenticate to any other app with support for the [Blockchain Naming System](https://docs.stacks.co/clarity/example-contracts/bns) and vice versa. ### Initiate `userSession` diff --git a/docs/stacks.js/guides/how-to-integrate-stacking-delegation.md b/docs/stacks.js/guides/how-to-integrate-stacking-delegation.md index 843964e66..97c7a95c7 100644 --- a/docs/stacks.js/guides/how-to-integrate-stacking-delegation.md +++ b/docs/stacks.js/guides/how-to-integrate-stacking-delegation.md @@ -95,7 +95,7 @@ const delegetateResponse = await client.delegateStx({ // } ``` -This method calls the [`delegate-stx`](https://docs.stacks.co/references/stacking-contract#delegate-stx) method of the Stacking contract. Note, that the amount can be higher or lower than the current account balance. Delegation does not yet lock the STX tokens, users can still transfer them. +This method calls the [`delegate-stx`](https://docs.stacks.co/clarity/example-contracts/stacking#delegate-stx) method of the Stacking contract. Note, that the amount can be higher or lower than the current account balance. Delegation does not yet lock the STX tokens, users can still transfer them. :::tip To avoid handling private keys, it is recommended to use the [Stacks Wallet](https://www.hiro.so/wallet) to sign the delegation transaction @@ -117,7 +117,7 @@ const revokeResponse = await client.revokeDelegateStx(privateKey); // } ``` -This method calls the [`revoke-delegate-stx`](https://docs.stacks.co/references/stacking-contract#revoke-delegate-stx) method of the Stacking contract. +This method calls the [`revoke-delegate-stx`](https://docs.stacks.co/clarity/example-contracts/stacking#revoke-delegate-stx) method of the Stacking contract. :::tip To avoid handling private keys, it is recommended to use the [Stacks Wallet](https://www.hiro.so/wallet) to sign the revoke transaction @@ -165,7 +165,7 @@ const delegetateStackResponses = await delegatorClient.delegateStackStx({ // } ``` -This function calls the [`delegate-stack-stx`](https://docs.stacks.co/references/stacking-contract#delegate-stack-stx) method of the Stacking contract to lock up the STX token from the account holder. +This function calls the [`delegate-stack-stx`](https://docs.stacks.co/clarity/example-contracts/stacking#delegate-stack-stx) method of the Stacking contract to lock up the STX token from the account holder. The delegator must call this method multiple times (for all stackers), until enough tokens are locked up to participate in Stacking. This is the first part of delegated stacking for the delegator. @@ -192,7 +192,7 @@ const delegetateCommitResponse = await delegatorClient.stackAggregationCommit({ // } ``` -This method calls the [`stack-aggregation-commit`](https://docs.stacks.co/references/stacking-contract#stack-aggregation-commit) function of the Stacking contract. This call also includes locked Stacks from previous cycles. This is the second part of delegated stacking for the delegator. +This method calls the [`stack-aggregation-commit`](https://docs.stacks.co/clarity/example-contracts/stacking#stack-aggregation-commit) function of the Stacking contract. This call also includes locked Stacks from previous cycles. This is the second part of delegated stacking for the delegator. This method has to be called once for each reward cycle, even if all account holders have already locked their Stacks for several cycles in a row. If no new account holders are added to the pool, then this method call can be made even several cycles before the actual rewards cycle. diff --git a/docs/stacks.js/guides/store-data-securely.md b/docs/stacks.js/guides/store-data-securely.md index 4f5460af4..3326cd370 100644 --- a/docs/stacks.js/guides/store-data-securely.md +++ b/docs/stacks.js/guides/store-data-securely.md @@ -110,7 +110,7 @@ Encrypted files need `decrypt` set to `true` so the app knows to decrypt the dat ## Get data for other user -Apps can also retrieve public data saved by users other than the one with the active session, granted those users have registered usernames via the [Blockchain Naming System](https://docs.stacks.co/build-apps/references/bns). +Apps can also retrieve public data saved by users other than the one with the active session, granted those users have registered usernames via the [Blockchain Naming System](https://docs.stacks.co/clarity/example-contracts/bns). Simply indicate the username of such a user in the `options` object: diff --git a/docs/tutorials/sending-tokens.md b/docs/tutorials/sending-tokens.md index b709e13d8..32b28399f 100644 --- a/docs/tutorials/sending-tokens.md +++ b/docs/tutorials/sending-tokens.md @@ -27,7 +27,7 @@ You will need [NodeJS](https://nodejs.org/en/download/) `8.12.0` or higher to co node --version ``` -You should also complete the [Accounts Tutorial](https://docs.stacks.co/docs/understand-stacks/accounts). The following steps assume we have access to an existing Stacks 2.0 account. +You should also complete the [Accounts Tutorial](https://docs.stacks.co/stacks-101/accounts). The following steps assume we have access to an existing Stacks 2.0 account. ## Step 1: Installing libraries