Update docs to reflect segwit support in Stacks 2.1

Pearltechie commented 2 days ago

Description: This pull request updates the documentation regarding Segwit address support in the Stacks project. The current documentation stated that "It cannot be a native Segwit address," which was accurate before Stacks 2.1. However, with the release of Stacks 2.1, native Segwit addresses are now supported, and this change has been reflected in the documentation.

Applicable issues

N/A

fixes #5472
Outdated documentation regarding native Segwit address support.

The statement "It cannot be a native Segwit address" was incorrect after Stacks 2.1. It is now corrected to reflect the current capabilities.

Additional info (benefits, drawbacks, caveats)

This change ensures the documentation accurately reflects the capabilities of Stacks 2.1, providing clarity for developers using Segwit addresses.

Checklist

[ ] My code follows the project's style guidelines.
[ ] I have updated the documentation accordingly.
[ ] I have reviewed the contribution guidelines for this project.
[ ] Test coverage for new or modified code paths
[x] Changelog is updated
[x] Required documentation changes (e.g., docs/rpc/openapi.yaml and rpc-endpoints.md for v2 endpoints, event-dispatcher.md for new events)
[ ] New clarity functions have corresponding PR in clarity-benchmarking repo
[ ] New integration test(s) added to bitcoin-tests.yml

CLAassistant commented 2 days ago

All committers have signed the CLA.

CLAassistant commented 2 days ago

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

Pearltechie commented 2 days ago

Thanks for reaching out. I have fixed it so that sentence syntax is correct in English

On Tue, Nov 19, 2024, 2:25 PM Adriano Di Luzio @.***> wrote:

@.**** commented on this pull request.

In stackslib/src/chainstate/stacks/boot/docs.rs https://github.com/stacks-network/stacks-core/pull/5480#discussion_r1848364215 :

@@ -33,7 +33,7 @@ This is the self-service interface. tx-sender will be the Stacker.

You will need the minimum uSTX threshold. This isn't determined until the reward cycle begins, but this method still requires stacking over the absolute minimum amount, which can be obtained by calling get-stacking-minimum.

The pox-addr argument must represent a valid reward address. Right now, this must be a Bitcoin -p2pkh or p2sh address. It cannot be a native Segwit address, but it may be a p2wpkh-p2sh or p2wsh-p2sh address. +p2pkh or p2sh address. // Native Segwit addresses are now supported as of Stacks 2.1. but it may be a p2wpkh-p2sh or p2wsh-p2sh address.

Thank you! Could you fix this so that the sentence syntax is correct in English?

— Reply to this email directly, view it on GitHub https://github.com/stacks-network/stacks-core/pull/5480#pullrequestreview-2445473798, or unsubscribe https://github.com/notifications/unsubscribe-auth/BLBHANZDFF5PI6UHOWQVEDD2BM34XAVCNFSM6AAAAABSCBFIRSVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDINBVGQ3TGNZZHA . You are receiving this because you authored the thread.Message ID: @.***>

stacks-network / stacks-core