diff --git a/.cargo/config b/.cargo/config.toml
similarity index 100%
rename from .cargo/config
rename to .cargo/config.toml
diff --git a/.github/actions/dockerfiles/Dockerfile.alpine-binary b/.github/actions/dockerfiles/Dockerfile.alpine-binary
index 1915a13d113..d185121e735 100644
--- a/.github/actions/dockerfiles/Dockerfile.alpine-binary
+++ b/.github/actions/dockerfiles/Dockerfile.alpine-binary
@@ -23,5 +23,18 @@ RUN case ${TARGETPLATFORM} in \
&& unzip ${BIN_ARCH}.zip -d /out
FROM --platform=${TARGETPLATFORM} alpine
-COPY --from=builder /out/stacks-node /out/stacks-signer /bin/
-CMD ["stacks-node", "mainnet"]
+COPY --from=builder /out/* /bin/
+ARG TAG
+
+RUN case "${TAG}" in \
+ signer-*) \
+ echo "/bin/stacks-signer run --config /signer-config.toml" > /tmp/command.sh \
+ ;; \
+ *) \
+ echo "/bin/stacks-node mainnet" > /tmp/command.sh && \
+ rm /bin/blockstack-cli /bin/clarity-cli /bin/relay-server /bin/stacks-events /bin/stacks-inspect \
+ ;; \
+ esac && \
+ chmod +x /tmp/command.sh
+
+CMD ["sh", "-c", "/tmp/command.sh"]
diff --git a/.github/actions/dockerfiles/Dockerfile.debian-binary b/.github/actions/dockerfiles/Dockerfile.debian-binary
index 5432e923778..757379095c3 100644
--- a/.github/actions/dockerfiles/Dockerfile.debian-binary
+++ b/.github/actions/dockerfiles/Dockerfile.debian-binary
@@ -23,5 +23,18 @@ RUN case ${TARGETPLATFORM} in \
&& unzip ${BIN_ARCH}.zip -d /out
FROM --platform=${TARGETPLATFORM} debian:bookworm
-COPY --from=builder /out/stacks-node /out/stacks-signer /bin/
-CMD ["stacks-node", "mainnet"]
+COPY --from=builder /out/* /bin/
+ARG TAG
+
+RUN case "${TAG}" in \
+ signer-*) \
+ echo "/bin/stacks-signer run --config /signer-config.toml" > /tmp/command.sh \
+ ;; \
+ *) \
+ echo "/bin/stacks-node mainnet" > /tmp/command.sh && \
+ rm /bin/blockstack-cli /bin/clarity-cli /bin/relay-server /bin/stacks-events /bin/stacks-inspect \
+ ;; \
+ esac && \
+ chmod +x /tmp/command.sh
+
+CMD ["sh", "-c", "/tmp/command.sh"]
diff --git a/.github/workflows/bitcoin-tests.yml b/.github/workflows/bitcoin-tests.yml
index 76ca85b6463..e14934558a5 100644
--- a/.github/workflows/bitcoin-tests.yml
+++ b/.github/workflows/bitcoin-tests.yml
@@ -81,16 +81,41 @@ jobs:
- tests::nakamoto_integrations::correct_burn_outs
- tests::nakamoto_integrations::vote_for_aggregate_key_burn_op
- tests::nakamoto_integrations::follower_bootup
- - tests::signer::stackerdb_dkg
- - tests::signer::stackerdb_sign
- - tests::signer::stackerdb_block_proposal
- - tests::signer::stackerdb_filter_bad_transactions
- - tests::signer::stackerdb_mine_2_nakamoto_reward_cycles
- - tests::signer::stackerdb_sign_after_signer_reboot
+ - tests::nakamoto_integrations::forked_tenure_is_ignored
+ - tests::nakamoto_integrations::nakamoto_attempt_time
+ - tests::signer::v0::block_proposal_rejection
+ - tests::signer::v0::miner_gather_signatures
+ - tests::signer::v0::mine_2_nakamoto_reward_cycles
+ - tests::signer::v0::end_of_tenure
+ - tests::signer::v0::forked_tenure_okay
+ - tests::signer::v0::forked_tenure_invalid
+ - tests::signer::v0::empty_sortition
+ - tests::signer::v0::bitcoind_forking_test
+ - tests::signer::v0::multiple_miners
+ - tests::signer::v0::mock_sign_epoch_25
+ - tests::signer::v0::signer_set_rollover
+ - tests::signer::v0::miner_forking
+ - tests::signer::v0::reloads_signer_set_in
- tests::nakamoto_integrations::stack_stx_burn_op_integration_test
+ - tests::nakamoto_integrations::check_block_heights
+ - tests::nakamoto_integrations::clarity_burn_state
+ - tests::nakamoto_integrations::check_block_times
+ - tests::nakamoto_integrations::check_block_info
+ - tests::nakamoto_integrations::check_block_info_rewards
+ - tests::nakamoto_integrations::continue_tenure_extend
+ - tests::nakamoto_integrations::mock_mining
+ - tests::nakamoto_integrations::multiple_miners
# Do not run this one until we figure out why it fails in CI
# - tests::neon_integrations::bitcoin_reorg_flap
# - tests::neon_integrations::bitcoin_reorg_flap_with_follower
+ # TODO: enable these once v1 signer is supported by a new nakamoto epoch
+ # - tests::signer::v1::dkg
+ # - tests::signer::v1::sign_request_rejected
+ # - tests::signer::v1::filter_bad_transactions
+ # - tests::signer::v1::delayed_dkg
+ # - tests::signer::v1::mine_2_nakamoto_reward_cycles
+ # - tests::signer::v1::sign_after_signer_reboot
+ # - tests::signer::v1::block_proposal
steps:
## Setup test environment
- name: Setup Test Environment
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 39048dc01b6..d1ae6522663 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -14,10 +14,6 @@ on:
- "**.md"
- "**.yml"
workflow_dispatch:
- inputs:
- tag:
- description: "The tag to create (optional)"
- required: false
pull_request:
types:
- opened
@@ -34,7 +30,7 @@ concurrency:
## Always cancel duplicate jobs
cancel-in-progress: true
-run-name: ${{ inputs.tag }}
+run-name: ${{ github.ref_name }}
jobs:
##
@@ -48,90 +44,99 @@ jobs:
name: Rust Format
runs-on: ubuntu-latest
steps:
- - name: Checkout the latest code
- id: git_checkout
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
-
- - name: Setup Rust Toolchain
- id: setup_rust_toolchain
- uses: actions-rust-lang/setup-rust-toolchain@f3c84ee10bf5a86e7a5d607d487bf17d57670965 # v1.5.0
- with:
- components: rustfmt
- cache: false
-
- name: Rustfmt
id: rustfmt
uses: stacks-network/actions/rustfmt@main
with:
alias: "fmt-stacks"
+ ######################################################################################
+ ## Check if the branch that this workflow is being run against is a release branch
+ check-release:
+ name: Check Release
+ needs:
+ - rustfmt
+ runs-on: ubuntu-latest
+ outputs:
+ tag: ${{ steps.check_release.outputs.tag }}
+ docker_tag: ${{ steps.check_release.outputs.docker_tag }}
+ is_release: ${{ steps.check_release.outputs.is_release }}
+ steps:
+ - name: Check Release
+ id: check_release
+ uses: stacks-network/actions/stacks-core/check-release@main
+ with:
+ tag: ${{ github.ref_name }}
+
######################################################################################
## Create a tagged github release
##
- ## Runs when the following is true:
- ## - tag is provided
+ ## Runs when:
+ ## - it is a release run
create-release:
if: |
- inputs.tag != ''
+ needs.check-release.outputs.is_release == 'true'
name: Create Release
needs:
- rustfmt
+ - check-release
uses: ./.github/workflows/github-release.yml
with:
- tag: ${{ inputs.tag }}
+ tag: ${{ needs.check-release.outputs.tag }}
+ docker_tag: ${{ needs.check-release.outputs.docker_tag }}
secrets: inherit
## Build and push Debian image built from source
##
## Runs when:
- ## - tag is not provided
+ ## - it is not a release run
docker-image:
if: |
- inputs.tag == ''
+ needs.check-release.outputs.is_release != 'true'
name: Docker Image (Source)
uses: ./.github/workflows/image-build-source.yml
needs:
- rustfmt
+ - check-release
secrets: inherit
## Create a reusable cache for tests
##
## Runs when:
- ## - tag is provided
+ ## - it is a release run
## or:
- ## - no tag provided
+ ## - it is not a release run
## and any of:
## - this workflow is called manually
## - PR is opened
## - commit to either (development, master) branch
create-cache:
if: |
- inputs.tag != '' || (
- inputs.tag == '' && (
- github.event_name == 'workflow_dispatch' ||
- github.event_name == 'pull_request' ||
- github.event_name == 'merge_group' ||
- (
- contains('
- refs/heads/master
- refs/heads/develop
- refs/heads/next
- ', github.event.pull_request.head.ref) &&
- github.event_name == 'push'
- )
+ needs.check-release.outputs.is_release == 'true' || (
+ github.event_name == 'workflow_dispatch' ||
+ github.event_name == 'pull_request' ||
+ github.event_name == 'merge_group' ||
+ (
+ contains('
+ refs/heads/master
+ refs/heads/develop
+ refs/heads/next
+ ', github.event.pull_request.head.ref) &&
+ github.event_name == 'push'
)
)
name: Create Test Cache
needs:
- rustfmt
+ - check-release
uses: ./.github/workflows/create-cache.yml
## Tests to run regularly
##
## Runs when:
- ## - tag is provided
+ ## - it is a release run
## or:
- ## - no tag provided
+ ## - it is not a release run
## and any of:
## - this workflow is called manually
## - PR is opened
@@ -139,75 +144,75 @@ jobs:
## - commit to either (development, next, master) branch
stacks-core-tests:
if: |
- inputs.tag != '' || (
- inputs.tag == '' && (
- github.event_name == 'workflow_dispatch' ||
- github.event_name == 'pull_request' ||
- github.event_name == 'merge_group' ||
- (
- contains('
- refs/heads/master
- refs/heads/develop
- refs/heads/next
- ', github.event.pull_request.head.ref) &&
- github.event_name == 'push'
- )
+ needs.check-release.outputs.is_release == 'true' || (
+ github.event_name == 'workflow_dispatch' ||
+ github.event_name == 'pull_request' ||
+ github.event_name == 'merge_group' ||
+ (
+ contains('
+ refs/heads/master
+ refs/heads/develop
+ refs/heads/next
+ ', github.event.pull_request.head.ref) &&
+ github.event_name == 'push'
)
)
name: Stacks Core Tests
needs:
- rustfmt
- create-cache
+ - check-release
uses: ./.github/workflows/stacks-core-tests.yml
bitcoin-tests:
if: |
- inputs.tag != '' || (
- inputs.tag == '' && (
- github.event_name == 'workflow_dispatch' ||
- github.event_name == 'pull_request' ||
- github.event_name == 'merge_group' ||
- (
- contains('
- refs/heads/master
- refs/heads/develop
- refs/heads/next
- ', github.event.pull_request.head.ref) &&
- github.event_name == 'push'
- )
+ needs.check-release.outputs.is_release == 'true' || (
+ github.event_name == 'workflow_dispatch' ||
+ github.event_name == 'pull_request' ||
+ github.event_name == 'merge_group' ||
+ (
+ contains('
+ refs/heads/master
+ refs/heads/develop
+ refs/heads/next
+ ', github.event.pull_request.head.ref) &&
+ github.event_name == 'push'
)
)
name: Bitcoin Tests
needs:
- rustfmt
- create-cache
+ - check-release
uses: ./.github/workflows/bitcoin-tests.yml
## Test to run on a tagged release
##
## Runs when:
- ## - tag is provided
+ ## - it is a release run
atlas-tests:
- if: inputs.tag != ''
+ if: needs.check-release.outputs.is_release == 'true'
name: Atlas Tests
needs:
- rustfmt
- create-cache
+ - check-release
uses: ./.github/workflows/atlas-tests.yml
epoch-tests:
- if: inputs.tag != ''
+ if: needs.check-release.outputs.is_release == 'true'
name: Epoch Tests
needs:
- rustfmt
- create-cache
+ - check-release
uses: ./.github/workflows/epoch-tests.yml
slow-tests:
- if: inputs.tag != ''
+ if: needs.check-release.outputs.is_release == 'true'
name: Slow Tests
needs:
- rustfmt
- create-cache
+ - check-release
uses: ./.github/workflows/slow-tests.yml
-
diff --git a/.github/workflows/clarity-js-sdk-pr.yml b/.github/workflows/clarity-js-sdk-pr.yml
index 45238084100..6bcd555ca9f 100644
--- a/.github/workflows/clarity-js-sdk-pr.yml
+++ b/.github/workflows/clarity-js-sdk-pr.yml
@@ -28,7 +28,7 @@ jobs:
steps:
- name: Checkout latest clarity js sdk
id: git_checkout
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+ uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
with:
token: ${{ secrets.GH_TOKEN }}
repository: ${{ env.CLARITY_JS_SDK_REPOSITORY }}
@@ -46,7 +46,7 @@ jobs:
- name: Create Pull Request
id: create_pr
- uses: peter-evans/create-pull-request@153407881ec5c347639a548ade7d8ad1d6740e38 # v5.0.2
+ uses: peter-evans/create-pull-request@6d6857d36972b65feb161a90e484f2984215f83e # v6.0.5
with:
token: ${{ secrets.GH_TOKEN }}
commit-message: "chore: update clarity-native-bin tag"
diff --git a/.github/workflows/docs-pr.yml b/.github/workflows/docs-pr.yml
index 7543bdd7507..8b005e0402c 100644
--- a/.github/workflows/docs-pr.yml
+++ b/.github/workflows/docs-pr.yml
@@ -36,7 +36,7 @@ jobs:
steps:
- name: Checkout the latest code
id: git_checkout
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+ uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
- name: Build docs
id: build_docs
@@ -46,7 +46,7 @@ jobs:
- name: Checkout latest docs
id: git_checkout_docs
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+ uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
with:
token: ${{ secrets.DOCS_GITHUB_TOKEN }}
repository: ${{ env.TARGET_REPOSITORY }}
@@ -77,7 +77,7 @@ jobs:
- name: Open PR
id: open_pr
if: ${{ steps.push.outputs.open_pr == '1' }}
- uses: actions/github-script@d7906e4ad0b1822421a7e6a35d5ca353c962f410 # v6.4.1
+ uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
with:
github-token: ${{ secrets.DOCS_GITHUB_TOKEN }}
script: |
diff --git a/.github/workflows/github-release.yml b/.github/workflows/github-release.yml
index 02243c4cbf0..9d4e18c6653 100644
--- a/.github/workflows/github-release.yml
+++ b/.github/workflows/github-release.yml
@@ -9,6 +9,10 @@ on:
description: "Release Tag"
required: true
type: string
+ docker_tag:
+ description: "Docker Release Tag"
+ required: true
+ type: string
secrets:
GH_TOKEN:
required: true
@@ -48,25 +52,28 @@ jobs:
## Downloads the artifacts built in `create-source-binary.yml`
- name: Download Artifacts
id: download_artifacts
- uses: actions/download-artifact@9bc31d5ccc31df68ecc42ccf4149144866c47d8a # v3.0.2
+ uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4.1.7
with:
- name: artifact
+ pattern: ${{ inputs.tag }}-binary-build-*
path: release
+ merge-multiple: true
## Generate a checksums file to be added to the release page
- name: Generate Checksums
id: generate_checksum
uses: stacks-network/actions/generate-checksum@main
+ with:
+ artifact_download_pattern: "${{ inputs.tag }}-binary-build-*"
## Upload the release archives with the checksums file
- name: Upload Release
id: upload_release
- uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844 #v0.1.15
+ uses: softprops/action-gh-release@69320dbe05506a9a39fc8ae11030b214ec2d1f87 #v2.0.5
env:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
with:
- name: Release ${{ github.event.inputs.tag || github.ref }}
- tag_name: ${{ github.event.inputs.tag || github.ref }}
+ name: Release ${{ inputs.tag || github.ref }}
+ tag_name: ${{ inputs.tag || github.ref }}
draft: false
prerelease: true
fail_on_unmatched_files: true
@@ -91,4 +98,5 @@ jobs:
- create-release
with:
tag: ${{ inputs.tag }}
+ docker_tag: ${{ inputs.docker_tag }}
secrets: inherit
diff --git a/.github/workflows/image-build-binary.yml b/.github/workflows/image-build-binary.yml
index 74415e7f16a..5966d7e68a4 100644
--- a/.github/workflows/image-build-binary.yml
+++ b/.github/workflows/image-build-binary.yml
@@ -6,6 +6,10 @@ on:
workflow_call:
inputs:
tag:
+ required: true
+ type: string
+ description: "Version tag of release"
+ docker_tag:
required: true
type: string
description: "Version tag for docker images"
@@ -57,34 +61,81 @@ jobs:
run: |
echo "docker-org=${{ github.repository_owner }}" >> "$GITHUB_ENV"
+ - name: Check Signer Release
+ id: check_signer_release
+ run: |
+ case "${{ inputs.tag }}" in
+ signer-*)
+ echo "is-signer-release=true" >> $GITHUB_ENV
+ ;;
+ *)
+ echo "is-signer-release=false" >> $GITHUB_ENV
+ ;;
+ esac
+
## Set docker metatdata
## - depending on the matrix.dist, different tags will be enabled
## ex. debian will have this tag: `type=ref,event=tag,enable=${{ matrix.dist == 'debian' }}`
- name: Docker Metadata ( ${{matrix.dist}} )
- id: docker_metadata
- uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 #v5.0.0
+ if: ${{ env.is-signer-release == 'true' }}
+ id: docker_metadata_signer
+ uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81 #v5.5.1
+ with:
+ images: |
+ ${{env.docker-org}}/stacks-signer
+ tags: |
+ type=raw,value=latest,enable=${{ inputs.docker_tag != '' && (github.ref == format('refs/heads/{0}', github.event.repository.default_branch) ) && matrix.dist == 'debian' }}
+ type=raw,value=${{ inputs.docker_tag }}-${{ matrix.dist }},enable=${{ inputs.docker_tag != '' && matrix.dist == 'debian'}}
+ type=raw,value=${{ inputs.docker_tag }},enable=${{ inputs.docker_tag != '' && matrix.dist == 'debian' }}
+ type=ref,event=tag,enable=${{ matrix.dist == 'debian' }}
+ type=raw,value=latest-${{ matrix.dist }},enable=${{ inputs.docker_tag != '' && (github.ref == format('refs/heads/{0}', github.event.repository.default_branch) ) && matrix.dist == 'alpine' }}
+ type=raw,value=${{ inputs.docker_tag }}-${{ matrix.dist }},enable=${{ inputs.docker_tag != '' && matrix.dist == 'alpine' }}
+
+ - name: Docker Metadata ( ${{matrix.dist}} )
+ if: ${{ env.is-signer-release == 'false' }}
+ id: docker_metadata_node
+ uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81 #v5.5.1
with:
## tag images with current repo name `stacks-core` as well as legacy `stacks-blockchain`
images: |
${{env.docker-org}}/${{ github.event.repository.name }}
${{env.docker-org}}/stacks-blockchain
tags: |
- type=raw,value=latest,enable=${{ inputs.tag != '' && (github.ref == format('refs/heads/{0}', github.event.repository.default_branch) ) && matrix.dist == 'debian' }}
- type=raw,value=${{ inputs.tag }}-${{ matrix.dist }},enable=${{ inputs.tag != '' && matrix.dist == 'debian'}}
- type=raw,value=${{ inputs.tag }},enable=${{ inputs.tag != '' && matrix.dist == 'debian' }}
+ type=raw,value=latest,enable=${{ inputs.docker_tag != '' && (github.ref == format('refs/heads/{0}', github.event.repository.default_branch) ) && matrix.dist == 'debian' }}
+ type=raw,value=${{ inputs.docker_tag }}-${{ matrix.dist }},enable=${{ inputs.docker_tag != '' && matrix.dist == 'debian'}}
+ type=raw,value=${{ inputs.docker_tag }},enable=${{ inputs.docker_tag != '' && matrix.dist == 'debian' }}
type=ref,event=tag,enable=${{ matrix.dist == 'debian' }}
- type=raw,value=latest-${{ matrix.dist }},enable=${{ inputs.tag != '' && (github.ref == format('refs/heads/{0}', github.event.repository.default_branch) ) && matrix.dist == 'alpine' }}
- type=raw,value=${{ inputs.tag }}-${{ matrix.dist }},enable=${{ inputs.tag != '' && matrix.dist == 'alpine' }}
+ type=raw,value=latest-${{ matrix.dist }},enable=${{ inputs.docker_tag != '' && (github.ref == format('refs/heads/{0}', github.event.repository.default_branch) ) && matrix.dist == 'alpine' }}
+ type=raw,value=${{ inputs.docker_tag }}-${{ matrix.dist }},enable=${{ inputs.docker_tag != '' && matrix.dist == 'alpine' }}
+
+ ## Build docker image for signer release
+ - name: Build and Push ( ${{matrix.dist}} )
+ if: ${{ env.is-signer-release == 'true' }}
+ id: docker_build_signer
+ uses: docker/build-push-action@2cdde995de11925a030ce8070c3d77a52ffcf1c0 # v5.3.0
+ with:
+ file: ./.github/actions/dockerfiles/Dockerfile.${{ matrix.dist }}-binary
+ platforms: ${{ env.docker_platforms }}
+ tags: ${{ steps.docker_metadata_signer.outputs.tags }}
+ labels: ${{ steps.docker_metadata_signer.outputs.labels }}
+ build-args: |
+ TAG=${{ inputs.tag }}
+ REPO=${{ github.repository_owner }}/${{ github.event.repository.name }}
+ STACKS_NODE_VERSION=${{ inputs.tag || env.GITHUB_SHA_SHORT }}
+ GIT_BRANCH=${{ env.GITHUB_REF_SHORT }}
+ GIT_COMMIT=${{ env.GITHUB_SHA_SHORT }}
+ push: ${{ env.DOCKER_PUSH }}
- ## Build docker image for release
+ ## Build docker image for node release
- name: Build and Push ( ${{matrix.dist}} )
- id: docker_build
- uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09 # v5.0.0
+ if: ${{ env.is-signer-release == 'false' }}
+ id: docker_build_node
+ uses: docker/build-push-action@2cdde995de11925a030ce8070c3d77a52ffcf1c0 # v5.3.0
with:
file: ./.github/actions/dockerfiles/Dockerfile.${{ matrix.dist }}-binary
platforms: ${{ env.docker_platforms }}
- tags: ${{ steps.docker_metadata.outputs.tags }}
- labels: ${{ steps.docker_metadata.outputs.labels }}
+ tags: ${{ steps.docker_metadata_node.outputs.tags }}
+ labels: ${{ steps.docker_metadata_node.outputs.labels }}
build-args: |
TAG=${{ inputs.tag }}
REPO=${{ github.repository_owner }}/${{ github.event.repository.name }}
diff --git a/.github/workflows/image-build-source.yml b/.github/workflows/image-build-source.yml
index ebb9afc6790..e45455f05b6 100644
--- a/.github/workflows/image-build-source.yml
+++ b/.github/workflows/image-build-source.yml
@@ -49,7 +49,7 @@ jobs:
## Set docker metatdata
- name: Docker Metadata ( ${{matrix.dist}} )
id: docker_metadata
- uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 #v5.0.0
+ uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81 #v5.5.1
with:
images: |
${{env.docker-org}}/${{ github.event.repository.name }}
@@ -61,7 +61,7 @@ jobs:
## Build docker image
- name: Build and Push ( ${{matrix.dist}} )
id: docker_build
- uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09 # v5.0.0
+ uses: docker/build-push-action@2cdde995de11925a030ce8070c3d77a52ffcf1c0 # v5.3.0
with:
file: ./.github/actions/dockerfiles/Dockerfile.${{matrix.dist}}-source
platforms: ${{ env.docker_platforms }}
diff --git a/.github/workflows/lock-threads.yml b/.github/workflows/lock-threads.yml
new file mode 100644
index 00000000000..83b5a6b63f1
--- /dev/null
+++ b/.github/workflows/lock-threads.yml
@@ -0,0 +1,36 @@
+## Workflow to lock closed PRs/issues/discussions
+## timeframe to lock defaults to:
+## issues: 30 days
+## prs: 30 days
+## discussions: 365 days
+
+name: "Lock Threads"
+
+on:
+ schedule:
+ - cron: "0 0 * * *"
+ workflow_dispatch:
+
+permissions:
+ issues: write
+ pull-requests: write
+ discussions: write
+
+concurrency:
+ group: lock-threads
+
+jobs:
+ ## Lock closed issues/prs/discussions
+ lock:
+ name: Lock Threads
+ runs-on: ubuntu-latest
+ steps:
+ - name: Lock Threads
+ id: lock_threads
+ uses: stacks-network/actions/lock-threads@main
+ with:
+ github-token: ${{ secrets.GH_TOKEN }}
+ issue-inactive-days: 7
+ pr-inactive-days: 7
+ discussion-inactive-days: 7
+
diff --git a/.github/workflows/pr-differences-mutants.yml b/.github/workflows/pr-differences-mutants.yml
index fc4a7256873..788e4ccb520 100644
--- a/.github/workflows/pr-differences-mutants.yml
+++ b/.github/workflows/pr-differences-mutants.yml
@@ -9,6 +9,11 @@ on:
- ready_for_review
paths:
- '**.rs'
+ workflow_dispatch:
+ inputs:
+ automated:
+ description: "Set to 'false' to ignore mutants limit."
+ required: true
concurrency:
group: pr-differences-${{ github.head_ref || github.ref || github.run_id }}
@@ -33,7 +38,9 @@ jobs:
steps:
- id: check_packages_and_shards
- uses: stacks-network/actions/stacks-core/mutation-testing/check-packages-and-shards@main
+ uses: stacks-network/actions/stacks-core/mutation-testing/check-packages-and-shards@feat/mutation-testing
+ with:
+ automated: ${{ inputs.automated }}
# Mutation testing - Execute on PR on small packages that have functions modified (normal run, no shards)
pr-differences-mutants-small-normal:
@@ -49,7 +56,7 @@ jobs:
steps:
- name: Run mutants on diffs
- uses: stacks-network/actions/stacks-core/mutation-testing/pr-differences@main
+ uses: stacks-network/actions/stacks-core/mutation-testing/pr-differences@feat/mutation-testing
with:
package: 'small'
@@ -72,7 +79,7 @@ jobs:
steps:
- name: Run mutants on diffs
- uses: stacks-network/actions/stacks-core/mutation-testing/pr-differences@main
+ uses: stacks-network/actions/stacks-core/mutation-testing/pr-differences@feat/mutation-testing
with:
shard: ${{ matrix.shard }}
package: 'small'
@@ -94,7 +101,7 @@ jobs:
env:
BITCOIND_TEST: 1
RUST_BACKTRACE: full
- uses: stacks-network/actions/stacks-core/mutation-testing/pr-differences@main
+ uses: stacks-network/actions/stacks-core/mutation-testing/pr-differences@feat/mutation-testing
with:
package: 'stackslib'
@@ -120,7 +127,7 @@ jobs:
env:
BITCOIND_TEST: 1
RUST_BACKTRACE: full
- uses: stacks-network/actions/stacks-core/mutation-testing/pr-differences@main
+ uses: stacks-network/actions/stacks-core/mutation-testing/pr-differences@feat/mutation-testing
with:
shard: ${{ matrix.shard }}
package: 'stackslib'
@@ -142,7 +149,7 @@ jobs:
env:
BITCOIND_TEST: 1
RUST_BACKTRACE: full
- uses: stacks-network/actions/stacks-core/mutation-testing/pr-differences@main
+ uses: stacks-network/actions/stacks-core/mutation-testing/pr-differences@feat/mutation-testing
with:
package: 'stacks-node'
@@ -168,7 +175,7 @@ jobs:
env:
BITCOIND_TEST: 1
RUST_BACKTRACE: full
- uses: stacks-network/actions/stacks-core/mutation-testing/pr-differences@main
+ uses: stacks-network/actions/stacks-core/mutation-testing/pr-differences@feat/mutation-testing
with:
shard: ${{ matrix.shard }}
package: 'stacks-node'
@@ -186,7 +193,7 @@ jobs:
steps:
- name: Run mutants on diffs
- uses: stacks-network/actions/stacks-core/mutation-testing/pr-differences@main
+ uses: stacks-network/actions/stacks-core/mutation-testing/pr-differences@feat/mutation-testing
with:
package: 'stacks-signer'
@@ -211,7 +218,7 @@ jobs:
steps:
- name: Output Mutants
- uses: stacks-network/actions/stacks-core/mutation-testing/output-pr-mutants@main
+ uses: stacks-network/actions/stacks-core/mutation-testing/output-pr-mutants@feat/mutation-testing
with:
stackslib_package: ${{ needs.check-big-packages-and-shards.outputs.run_stackslib }}
shards_for_stackslib_package: ${{ needs.check-big-packages-and-shards.outputs.stackslib_with_shards }}
diff --git a/.github/workflows/slow-tests.yml b/.github/workflows/slow-tests.yml
index bce6a15a1f0..02c5bdf552d 100644
--- a/.github/workflows/slow-tests.yml
+++ b/.github/workflows/slow-tests.yml
@@ -32,6 +32,7 @@ jobs:
test-name:
- tests::epoch_21::test_pox_reorg_flap_duel
- tests::epoch_21::test_pox_reorg_flap_reward_cycles
+ - tests::nakamoto_integrations::check_block_info_rewards
steps:
## Setup test environment
- name: Setup Test Environment
diff --git a/.github/workflows/stacks-core-tests.yml b/.github/workflows/stacks-core-tests.yml
index 3195f279fcb..98eb5cf92c0 100644
--- a/.github/workflows/stacks-core-tests.yml
+++ b/.github/workflows/stacks-core-tests.yml
@@ -127,7 +127,7 @@ jobs:
## checkout the code
- name: Checkout the latest code
id: git_checkout
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+ uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
- name: Run network relay tests
id: nettest
@@ -145,10 +145,10 @@ jobs:
steps:
- name: Checkout the latest code
id: git_checkout
- uses: actions/checkout@v3
+ uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
- name: Execute core contract unit tests with clarinet-sdk
id: clarinet_unit_test
- uses: actions/setup-node@v3
+ uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
with:
node-version: 18.x
cache: "npm"
@@ -174,7 +174,7 @@ jobs:
steps:
- name: Checkout the latest code
id: git_checkout
- uses: actions/checkout@v3
+ uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
- name: Execute core contract unit tests in Clarinet
id: clarinet_unit_test_v1
uses: docker://hirosystems/clarinet:1.7.1
@@ -187,7 +187,6 @@ jobs:
if: always()
needs:
- full-genesis
- - unit-tests
- open-api-validation
- core-contracts-clarinet-test
steps:
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
index be7e11c2a88..00035443cbf 100644
--- a/.vscode/extensions.json
+++ b/.vscode/extensions.json
@@ -2,7 +2,7 @@
"recommendations": [
"rust-lang.rust-analyzer",
"vadimcn.vscode-lldb",
- "serayuzgur.crates",
+ "fill-labs.dependi",
"editorconfig.editorconfig",
]
}
diff --git a/CHANGELOG.md b/CHANGELOG.md
index c318efebc87..eb6061cb9d4 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,62 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to the versioning scheme outlined in the [README.md](README.md).
+## [Unreleased]
+
+- Added support for Clarity 3
+ - Keywords / variable
+ - `tenure-height` added
+ - `stacks-block-height` added
+ - `block-height` removed
+ - Functions
+ - `get-stacks-block-info?` added
+ - `get-tenure-info?` added
+ - `get-block-info?` removed
+
+## [2.5.0.0.5]
+
+### Added
+
+- Added configuration option `connections.antientropy_retry` (#4932)
+
+### Changed
+
+- Set default antientropy_retry to run once per hour (#4935)
+
+## [2.5.0.0.4]
+
+### Added
+
+- Adds the solo stacking scenarios to the stateful property-based testing strategy for PoX-4 (#4725)
+- Add signer-key to synthetic stack-aggregation-increase event (#4728)
+- Implement the assumed total commit with carry-over (ATC-C) strategy for denying opportunistic Bitcoin miners from mining Stacks at a discount (#4733)
+- Adding support for stacks-block-height and tenure-height in Clarity 3 (#4745)
+- Preserve PeerNetwork struct when transitioning to 3.0 (#4767)
+- Implement singer monitor server error (#4773)
+- Pull current stacks signer out into v1 implementation and create placeholder v0 mod (#4778)
+- Create new block signature message type for v0 signer (#4787)
+- Isolate the rusqlite dependency in stacks-common and clarity behind a cargo feature (#4791)
+- Add next_initiative_delay config option to control how frequently the miner checks if a new burnchain block has been processed (#4795)
+- Various performance improvements and cleanup
+
+### Changed
+
+- Downgraded log messages about transactions from warning to info (#4697)
+- Fix race condition between the signer binary and the /v2/pox endpoint (#4738)
+- Make node config mock_miner item hot-swappable (#4743)
+- Mandates that a burnchain block header be resolved by a BurnchainHeaderReader, which will resolve a block height to at most one burnchain header (#4748)
+- Optional config option to resolve DNS of bootstrap nodes (#4749)
+- Limit inventory syncs with new peers (#4750)
+- Update /v2/fees/transfer to report the median transaction fee estimate for a STX-transfer of 180 bytes (#4754)
+- Reduce connection spamming in stackerdb (#4759)
+- Remove deprecated signer cli commands (#4772)
+- Extra pair of signer slots got introduced at the epoch 2.5 boundary (#4845, #4868, #4891)
+- Never consider Stacks chain tips that are not on the canonical burn chain #4886 (#4893)
+
+### Fixed
+
+- Allow Nakamoto blocks to access the burn block associated with the current tenure (#4333)
+
## [2.5.0.0.3]
This release fixes a regression in `2.5.0.0.0` from `2.4.0.1.0` caused by git merge
@@ -22,7 +78,6 @@ This is the first consensus-critical release for Nakamoto. Nodes which do not up
**This is a required release before Nakamoto rules are enabled in 3.0.**
-
### Timing of Release from 2.5 to 3.0
Activating Nakamoto will include two epochs:
diff --git a/CODEOWNERS b/CODEOWNERS
new file mode 100644
index 00000000000..b30973662f6
--- /dev/null
+++ b/CODEOWNERS
@@ -0,0 +1,20 @@
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @stacks-network/blockchain-team-codeowners will be requested for
+# review when someone opens a pull request.
+* @stacks-network/blockchain-team-codeowners
+
+# Generic file extensions that shouldn't require much scrutiny. Anyone with write access to the repo may approve a PR
+*.md @stacks-network/blockchain-team
+*.yml @stacks-network/blockchain-team
+*.yaml @stacks-network/blockchain-team
+*.txt @stacks-network/blockchain-team
+*.toml @stacks-network/blockchain-team
+
+# Signer code
+libsigner/**/*.rs @stacks-network/blockchain-team-signer
+stacks-signer/**/*.rs @stacks-network/blockchain-team-signer
+
+# CI workflows
+/.github/workflows/ @stacks-network/blockchain-team-ci
+/.github/actions/ @stacks-network/blockchain-team-ci
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7609cba29f7..5bdfbfc8eac 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -43,6 +43,11 @@ Branch names should use a prefix that conveys the overall goal of the branch:
- `test/more-coverage` for branches that only add more tests
- `refactor/formatting-fix` for refactors
+The branch suffix must only include ASCII lowercase and uppercase letters,
+digits, underscores, periods and dashes.
+
+The full branch name must be max 128 characters long.
+
### Merging PRs from Forks
PRs from forks or opened by contributors without commit access require
diff --git a/Cargo.lock b/Cargo.lock
index 9cfd1ad9a1e..357a9def709 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -112,12 +112,6 @@ dependencies = [
"opaque-debug",
]
-[[package]]
-name = "ahash"
-version = "0.4.8"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0453232ace82dee0dd0b4c87a59bd90f7b53b314f3e0f61fe2ee7c8a16482289"
-
[[package]]
name = "ahash"
version = "0.8.8"
@@ -717,7 +711,7 @@ name = "clarity"
version = "0.0.1"
dependencies = [
"assert-json-diff",
- "hashbrown 0.14.3",
+ "hashbrown",
"integer-sqrt",
"lazy_static",
"mutants",
@@ -1188,9 +1182,9 @@ dependencies = [
[[package]]
name = "fallible-iterator"
-version = "0.2.0"
+version = "0.3.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4443176a9f2c162692bd3d352d745ef9413eec5782a80d8fd6f8a1ac692a07f7"
+checksum = "2acce4a10f12dc2fb14a218589d4f1f62ef011b2d0cc4b3cb1bba8e94da14649"
[[package]]
name = "fallible-streaming-iterator"
@@ -1495,33 +1489,24 @@ version = "1.8.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "eabb4a44450da02c90444cf74558da904edde8fb4e9035a9a6a4e15445af0bd7"
-[[package]]
-name = "hashbrown"
-version = "0.9.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d7afe4a420e3fe79967a00898cc1f4db7c8a49a9333a29f8a4bd76a253d5cd04"
-dependencies = [
- "ahash 0.4.8",
-]
-
[[package]]
name = "hashbrown"
version = "0.14.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "290f1a1d9242c78d09ce40a5e87e7554ee637af1351968159f4952f028f75604"
dependencies = [
- "ahash 0.8.8",
+ "ahash",
"allocator-api2",
"serde",
]
[[package]]
name = "hashlink"
-version = "0.6.0"
+version = "0.9.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d99cf782f0dc4372d26846bec3de7804ceb5df083c2d4462c0b8d2330e894fa8"
+checksum = "6ba4ff7128dee98c7dc9794b6a411377e1404dba1c97deb8d1a55297bd25d8af"
dependencies = [
- "hashbrown 0.9.1",
+ "hashbrown",
]
[[package]]
@@ -1758,7 +1743,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "233cf39063f058ea2caae4091bf4a3ef70a653afbc026f5c4a4135d114e3c177"
dependencies = [
"equivalent",
- "hashbrown 0.14.3",
+ "hashbrown",
]
[[package]]
@@ -1920,9 +1905,12 @@ name = "libsigner"
version = "0.0.1"
dependencies = [
"clarity",
- "hashbrown 0.14.3",
+ "hashbrown",
+ "lazy_static",
"libc",
"libstackerdb",
+ "mutants",
+ "prometheus",
"rand 0.8.5",
"rand_core 0.6.4",
"secp256k1",
@@ -1943,9 +1931,9 @@ dependencies = [
[[package]]
name = "libsqlite3-sys"
-version = "0.20.1"
+version = "0.28.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "64d31059f22935e6c31830db5249ba2b7ecd54fd73a9909286f0a67aa55c2fbd"
+checksum = "0c10584274047cb335c23d3e61bcef8e323adae7c5c8c760540f73610177fc3f"
dependencies = [
"cc",
"pkg-config",
@@ -2446,6 +2434,7 @@ name = "pox-locking"
version = "2.4.0"
dependencies = [
"clarity",
+ "mutants",
"slog",
"stacks-common",
]
@@ -2718,7 +2707,7 @@ checksum = "c08c74e62047bb2de4ff487b251e4a92e24f48745648451635cec7d591162d9f"
name = "relay-server"
version = "0.0.1"
dependencies = [
- "hashbrown 0.14.3",
+ "hashbrown",
]
[[package]]
@@ -2870,17 +2859,15 @@ dependencies = [
[[package]]
name = "rusqlite"
-version = "0.24.2"
+version = "0.31.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d5f38ee71cbab2c827ec0ac24e76f82eca723cee92c509a65f67dee393c25112"
+checksum = "b838eba278d213a8beaf485bd313fd580ca4505a00d5871caeb1457c55322cae"
dependencies = [
- "bitflags 1.3.2",
- "byteorder",
+ "bitflags 2.4.2",
"fallible-iterator",
"fallible-streaming-iterator",
"hashlink",
"libsqlite3-sys",
- "memchr",
"serde_json",
"smallvec",
]
@@ -3291,7 +3278,7 @@ dependencies = [
"serde",
"serde_json",
"slog",
- "time 0.3.34",
+ "time 0.3.36",
]
[[package]]
@@ -3304,7 +3291,7 @@ dependencies = [
"slog",
"term",
"thread_local",
- "time 0.3.34",
+ "time 0.3.36",
]
[[package]]
@@ -3376,7 +3363,7 @@ dependencies = [
"chrono",
"curve25519-dalek 2.0.0",
"ed25519-dalek",
- "hashbrown 0.14.3",
+ "hashbrown",
"lazy_static",
"libc",
"nix",
@@ -3412,7 +3399,7 @@ dependencies = [
"base64 0.12.3",
"chrono",
"clarity",
- "hashbrown 0.14.3",
+ "hashbrown",
"http-types",
"lazy_static",
"libc",
@@ -3449,11 +3436,13 @@ dependencies = [
"backoff",
"clap 4.5.0",
"clarity",
- "hashbrown 0.14.3",
+ "hashbrown",
+ "lazy_static",
"libsigner",
"libstackerdb",
"num-traits",
"polynomial",
+ "prometheus",
"rand 0.8.5",
"rand_core 0.6.4",
"reqwest",
@@ -3469,6 +3458,7 @@ dependencies = [
"stacks-common",
"stackslib",
"thiserror",
+ "tiny_http",
"toml 0.5.11",
"tracing",
"tracing-subscriber",
@@ -3486,7 +3476,7 @@ dependencies = [
"criterion",
"curve25519-dalek 2.0.0",
"ed25519-dalek",
- "hashbrown 0.14.3",
+ "hashbrown",
"integer-sqrt",
"lazy_static",
"libc",
@@ -3770,9 +3760,9 @@ dependencies = [
[[package]]
name = "time"
-version = "0.3.34"
+version = "0.3.36"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c8248b6521bb14bc45b4067159b9b6ad792e2d6d754d6c41fb50e29fefe38749"
+checksum = "5dfd88e563464686c916c7e46e623e520ddc6d79fa6641390f2e3fa86e83e885"
dependencies = [
"deranged",
"itoa",
@@ -3782,7 +3772,7 @@ dependencies = [
"powerfmt",
"serde",
"time-core",
- "time-macros 0.2.17",
+ "time-macros 0.2.18",
]
[[package]]
@@ -3803,9 +3793,9 @@ dependencies = [
[[package]]
name = "time-macros"
-version = "0.2.17"
+version = "0.2.18"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7ba3a3ef41e6672a2f0f001392bb5dcd3ff0a9992d618ca761a11c3121547774"
+checksum = "3f252a68540fde3a3877aeea552b832b40ab9a69e318efd078774a01ddee1ccf"
dependencies = [
"num-conv",
"time-core",
@@ -4604,7 +4594,7 @@ checksum = "9c80d57a61294350ed91e91eb20a6c34da084ec8f15d039bab79ce3efabbd1a4"
dependencies = [
"aes-gcm 0.10.3",
"bs58 0.5.0",
- "hashbrown 0.14.3",
+ "hashbrown",
"hex",
"num-traits",
"p256k1",
diff --git a/Cargo.toml b/Cargo.toml
index feab983833c..8ac168f1f7e 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -21,6 +21,7 @@ rand = "0.8"
rand_chacha = "0.3.1"
tikv-jemallocator = "0.5.4"
wsts = { version = "9.0.0", default-features = false }
+rusqlite = { version = "0.31.0", features = ["blob", "serde_json", "i128_blob", "bundled", "trace"] }
# Use a bit more than default optimization for
# dev builds to speed up test execution
diff --git a/Dockerfile b/Dockerfile
index 055cc3df764..5cfacc8ab08 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -12,7 +12,7 @@ RUN apk add --no-cache musl-dev
RUN mkdir /out
-RUN cd testnet/stacks-node && cargo build --features monitoring_prom,slog_json --release
+RUN cargo build --features monitoring_prom,slog_json --release
RUN cp target/release/stacks-node /out
diff --git a/Dockerfile.debian b/Dockerfile.debian
index 8b6759527ed..ce219640391 100644
--- a/Dockerfile.debian
+++ b/Dockerfile.debian
@@ -10,7 +10,7 @@ COPY . .
RUN mkdir /out
-RUN cd testnet/stacks-node && cargo build --features monitoring_prom,slog_json --release
+RUN cargo build --features monitoring_prom,slog_json --release
RUN cp target/release/stacks-node /out
diff --git a/README.md b/README.md
index 3f91b1a9f21..6cdb42857f4 100644
--- a/README.md
+++ b/README.md
@@ -55,7 +55,7 @@ _Note on building_: you may set `RUSTFLAGS` to build binaries for your native cp
RUSTFLAGS="-Ctarget-cpu=native"
```
-or uncomment these lines in `./cargo/config`:
+or uncomment these lines in `./cargo/config.toml`:
```
# [build]
@@ -87,7 +87,7 @@ cd testnet/stacks-node
cargo run --bin stacks-node -- start --config ./conf/testnet-follower-conf.toml
```
-_On Windows, many tests will fail if the line endings aren't `LF`. Please ensure that you are have git's `core.autocrlf` set to `input` when you clone the repository to avoid any potential issues. This is due to the Clarity language currently being sensitive to line endings._
+_On Windows, many tests will fail if the line endings aren't `LF`. Please ensure that you have git's `core.autocrlf` set to `input` when you clone the repository to avoid any potential issues. This is due to the Clarity language currently being sensitive to line endings._
Additional testnet documentation is available [here](./docs/testnet.md) and [here](https://docs.stacks.co/docs/nodes-and-miners/miner-testnet)
diff --git a/clarity/Cargo.toml b/clarity/Cargo.toml
index 70cbcec5857..284e856e498 100644
--- a/clarity/Cargo.toml
+++ b/clarity/Cargo.toml
@@ -27,33 +27,33 @@ regex = "1"
lazy_static = "1.4.0"
integer-sqrt = "0.1.3"
slog = { version = "2.5.2", features = [ "max_level_trace" ] }
-stacks_common = { package = "stacks-common", path = "../stacks-common" }
+stacks_common = { package = "stacks-common", path = "../stacks-common", optional = true, default-features = false }
rstest = "0.17.0"
rstest_reuse = "0.5.0"
hashbrown = { workspace = true }
-mutants = "0.0.3"
+rusqlite = { workspace = true, optional = true}
[dependencies.serde_json]
version = "1.0"
features = ["arbitrary_precision", "unbounded_depth"]
-[dependencies.rusqlite]
-version = "=0.24.2"
-features = ["blob", "serde_json", "i128_blob", "bundled", "trace"]
-
[dependencies.time]
version = "0.2.23"
features = ["std"]
[dev-dependencies]
assert-json-diff = "1.0.0"
+mutants = "0.0.3"
# a nightly rustc regression (35dbef235 2021-03-02) prevents criterion from compiling
# but it isn't necessary for tests: only benchmarks. therefore, commenting out for now.
# criterion = "0.3"
[features]
-default = []
-developer-mode = []
+default = ["canonical"]
+canonical = ["rusqlite", "stacks_common/canonical"]
+developer-mode = ["stacks_common/developer-mode"]
slog_json = ["stacks_common/slog_json"]
-testing = []
+testing = ["canonical"]
devtools = []
+rollback_value_check = []
+disable-costs = []
diff --git a/clarity/src/vm/analysis/arithmetic_checker/mod.rs b/clarity/src/vm/analysis/arithmetic_checker/mod.rs
index 5595905a484..aa69f650f01 100644
--- a/clarity/src/vm/analysis/arithmetic_checker/mod.rs
+++ b/clarity/src/vm/analysis/arithmetic_checker/mod.rs
@@ -148,7 +148,7 @@ impl<'a> ArithmeticOnlyChecker<'a> {
{
match native_var {
ContractCaller | TxSender | TotalLiquidMicroSTX | BlockHeight | BurnBlockHeight
- | Regtest | TxSponsor | Mainnet | ChainId => {
+ | Regtest | TxSponsor | Mainnet | ChainId | StacksBlockHeight | TenureHeight => {
Err(Error::VariableForbidden(native_var))
}
NativeNone | NativeTrue | NativeFalse => Ok(()),
@@ -174,13 +174,12 @@ impl<'a> ArithmeticOnlyChecker<'a> {
) -> Result<(), Error> {
use crate::vm::functions::NativeFunctions::*;
match function {
- FetchVar | GetBlockInfo | GetBurnBlockInfo | GetTokenBalance | GetAssetOwner
- | FetchEntry | SetEntry | DeleteEntry | InsertEntry | SetVar | MintAsset
- | MintToken | TransferAsset | TransferToken | ContractCall | StxTransfer
- | StxTransferMemo | StxBurn | AtBlock | GetStxBalance | GetTokenSupply | BurnToken
- | FromConsensusBuff | ToConsensusBuff | BurnAsset | StxGetAccount => {
- Err(Error::FunctionNotPermitted(function))
- }
+ FetchVar | GetBlockInfo | GetBurnBlockInfo | GetStacksBlockInfo | GetTenureInfo
+ | GetTokenBalance | GetAssetOwner | FetchEntry | SetEntry | DeleteEntry
+ | InsertEntry | SetVar | MintAsset | MintToken | TransferAsset | TransferToken
+ | ContractCall | StxTransfer | StxTransferMemo | StxBurn | AtBlock | GetStxBalance
+ | GetTokenSupply | BurnToken | FromConsensusBuff | ToConsensusBuff | BurnAsset
+ | StxGetAccount => Err(Error::FunctionNotPermitted(function)),
Append | Concat | AsMaxLen | ContractOf | PrincipalOf | ListCons | Print
| AsContract | ElementAt | ElementAtAlias | IndexOf | IndexOfAlias | Map | Filter
| Fold | Slice | ReplaceAt => Err(Error::FunctionNotPermitted(function)),
diff --git a/clarity/src/vm/analysis/arithmetic_checker/tests.rs b/clarity/src/vm/analysis/arithmetic_checker/tests.rs
index 4ad02c08d5e..0e7d520cb3b 100644
--- a/clarity/src/vm/analysis/arithmetic_checker/tests.rs
+++ b/clarity/src/vm/analysis/arithmetic_checker/tests.rs
@@ -22,12 +22,13 @@ use stacks_common::types::StacksEpochId;
use crate::vm::analysis::arithmetic_checker::Error::*;
use crate::vm::analysis::arithmetic_checker::{ArithmeticOnlyChecker, Error};
-use crate::vm::analysis::{mem_type_check, ContractAnalysis};
+use crate::vm::analysis::ContractAnalysis;
use crate::vm::ast::parse;
use crate::vm::costs::LimitedCostTracker;
use crate::vm::functions::define::DefineFunctions;
use crate::vm::functions::NativeFunctions;
use crate::vm::tests::test_clarity_versions;
+use crate::vm::tooling::mem_type_check;
use crate::vm::types::QualifiedContractIdentifier;
use crate::vm::variables::NativeVariables;
use crate::vm::ClarityVersion;
diff --git a/clarity/src/vm/analysis/errors.rs b/clarity/src/vm/analysis/errors.rs
index 71fefb64571..f86308f8d9c 100644
--- a/clarity/src/vm/analysis/errors.rs
+++ b/clarity/src/vm/analysis/errors.rs
@@ -132,10 +132,15 @@ pub enum CheckErrors {
// get-block-info? errors
NoSuchBlockInfoProperty(String),
NoSuchBurnBlockInfoProperty(String),
+ NoSuchStacksBlockInfoProperty(String),
+ NoSuchTenureInfoProperty(String),
GetBlockInfoExpectPropertyName,
GetBurnBlockInfoExpectPropertyName,
+ GetStacksBlockInfoExpectPropertyName,
+ GetTenureInfoExpectPropertyName,
NameAlreadyUsed(String),
+ ReservedWord(String),
// expect a function, or applying a function to a list
NonFunctionApplication,
@@ -405,9 +410,14 @@ impl DiagnosableError for CheckErrors {
CheckErrors::ExpectedCallableType(found_type) => format!("expected a callable contract, found {}", found_type),
CheckErrors::NoSuchBlockInfoProperty(property_name) => format!("use of block unknown property '{}'", property_name),
CheckErrors::NoSuchBurnBlockInfoProperty(property_name) => format!("use of burn block unknown property '{}'", property_name),
+ CheckErrors::NoSuchStacksBlockInfoProperty(property_name) => format!("use of unknown stacks block property '{}'", property_name),
+ CheckErrors::NoSuchTenureInfoProperty(property_name) => format!("use of unknown tenure property '{}'", property_name),
CheckErrors::GetBlockInfoExpectPropertyName => "missing property name for block info introspection".into(),
CheckErrors::GetBurnBlockInfoExpectPropertyName => "missing property name for burn block info introspection".into(),
+ CheckErrors::GetStacksBlockInfoExpectPropertyName => "missing property name for stacks block info introspection".into(),
+ CheckErrors::GetTenureInfoExpectPropertyName => "missing property name for tenure info introspection".into(),
CheckErrors::NameAlreadyUsed(name) => format!("defining '{}' conflicts with previous value", name),
+ CheckErrors::ReservedWord(name) => format!("{name} is a reserved word"),
CheckErrors::NonFunctionApplication => "expecting expression of type function".into(),
CheckErrors::ExpectedListApplication => "expecting expression of type list".into(),
CheckErrors::ExpectedSequence(found_type) => format!("expecting expression of type 'list', 'buff', 'string-ascii' or 'string-utf8' - found '{}'", found_type),
diff --git a/clarity/src/vm/analysis/mod.rs b/clarity/src/vm/analysis/mod.rs
index 4da10f88bf9..6a8f64f1b26 100644
--- a/clarity/src/vm/analysis/mod.rs
+++ b/clarity/src/vm/analysis/mod.rs
@@ -37,12 +37,15 @@ use self::type_checker::v2_1::TypeChecker as TypeChecker2_1;
pub use self::types::{AnalysisPass, ContractAnalysis};
use crate::vm::ast::{build_ast_with_rules, ASTRules};
use crate::vm::costs::LimitedCostTracker;
-use crate::vm::database::{MemoryBackingStore, STORE_CONTRACT_SRC_INTERFACE};
+#[cfg(feature = "canonical")]
+use crate::vm::database::MemoryBackingStore;
+use crate::vm::database::STORE_CONTRACT_SRC_INTERFACE;
use crate::vm::representations::SymbolicExpression;
use crate::vm::types::{QualifiedContractIdentifier, TypeSignature};
use crate::vm::ClarityVersion;
/// Used by CLI tools like the docs generator. Not used in production
+#[cfg(feature = "canonical")]
pub fn mem_type_check(
snippet: &str,
version: ClarityVersion,
diff --git a/clarity/src/vm/analysis/read_only_checker/mod.rs b/clarity/src/vm/analysis/read_only_checker/mod.rs
index b02923c1a1a..006b4f0cfe6 100644
--- a/clarity/src/vm/analysis/read_only_checker/mod.rs
+++ b/clarity/src/vm/analysis/read_only_checker/mod.rs
@@ -290,10 +290,11 @@ impl<'a, 'b> ReadOnlyChecker<'a, 'b> {
| BuffToUIntBe | IntToAscii | IntToUtf8 | StringToInt | StringToUInt | IsStandard
| ToConsensusBuff | PrincipalDestruct | PrincipalConstruct | Append | Concat
| AsMaxLen | ContractOf | PrincipalOf | ListCons | GetBlockInfo | GetBurnBlockInfo
- | TupleGet | TupleMerge | Len | Print | AsContract | Begin | FetchVar
- | GetStxBalance | StxGetAccount | GetTokenBalance | GetAssetOwner | GetTokenSupply
- | ElementAt | IndexOf | Slice | ReplaceAt | BitwiseAnd | BitwiseOr | BitwiseNot
- | BitwiseLShift | BitwiseRShift | BitwiseXor2 | ElementAtAlias | IndexOfAlias => {
+ | GetStacksBlockInfo | GetTenureInfo | TupleGet | TupleMerge | Len | Print
+ | AsContract | Begin | FetchVar | GetStxBalance | StxGetAccount | GetTokenBalance
+ | GetAssetOwner | GetTokenSupply | ElementAt | IndexOf | Slice | ReplaceAt
+ | BitwiseAnd | BitwiseOr | BitwiseNot | BitwiseLShift | BitwiseRShift | BitwiseXor2
+ | ElementAtAlias | IndexOfAlias => {
// Check all arguments.
self.check_each_expression_is_read_only(args)
}
diff --git a/clarity/src/vm/analysis/tests/mod.rs b/clarity/src/vm/analysis/tests/mod.rs
index adb36b94fbd..2484ee86cd3 100644
--- a/clarity/src/vm/analysis/tests/mod.rs
+++ b/clarity/src/vm/analysis/tests/mod.rs
@@ -14,10 +14,15 @@
// You should have received a copy of the GNU General Public License
// along with this program. If not, see .
+use stacks_common::types::StacksEpochId;
+
use crate::vm::analysis::errors::CheckErrors;
use crate::vm::analysis::type_checker::v2_1::tests::mem_type_check;
-use crate::vm::analysis::{type_check, AnalysisDatabase, ContractAnalysis};
+use crate::vm::analysis::{
+ mem_type_check as mem_run_analysis, type_check, AnalysisDatabase, ContractAnalysis,
+};
use crate::vm::ast::parse;
+use crate::vm::ClarityVersion;
#[test]
fn test_list_types_must_match() {
@@ -202,18 +207,87 @@ fn test_contract_call_expect_name() {
#[test]
fn test_no_such_block_info_property() {
let snippet = "(get-block-info? unicorn 1)";
- let err = mem_type_check(snippet).unwrap_err();
+ let err =
+ mem_run_analysis(snippet, ClarityVersion::Clarity2, StacksEpochId::latest()).unwrap_err();
assert!(format!("{}", err.diagnostic).contains("use of block unknown property 'unicorn'"));
}
+#[test]
+fn test_no_such_stacks_block_info_property() {
+ let snippet = "(get-stacks-block-info? unicorn 1)";
+ let err =
+ mem_run_analysis(snippet, ClarityVersion::Clarity3, StacksEpochId::latest()).unwrap_err();
+ assert!(
+ format!("{}", err.diagnostic).contains("use of unknown stacks block property 'unicorn'")
+ );
+}
+
+#[test]
+fn test_no_such_tenure_info_property() {
+ let snippet = "(get-tenure-info? unicorn 1)";
+ let err =
+ mem_run_analysis(snippet, ClarityVersion::Clarity3, StacksEpochId::latest()).unwrap_err();
+ assert!(format!("{}", err.diagnostic).contains("use of unknown tenure property 'unicorn'"));
+}
+
#[test]
fn test_get_block_info_expect_property_name() {
let snippet = "(get-block-info? 0 1)";
- let err = mem_type_check(snippet).unwrap_err();
+ let err =
+ mem_run_analysis(snippet, ClarityVersion::Clarity2, StacksEpochId::latest()).unwrap_err();
assert!(format!("{}", err.diagnostic)
.contains("missing property name for block info introspection"));
}
+#[test]
+fn test_get_stacks_block_info_expect_property_name() {
+ let snippet = "(get-stacks-block-info? 0 1)";
+ let err =
+ mem_run_analysis(snippet, ClarityVersion::Clarity3, StacksEpochId::latest()).unwrap_err();
+ assert!(format!("{}", err.diagnostic)
+ .contains("missing property name for stacks block info introspection"));
+}
+
+#[test]
+fn test_get_tenure_info_expect_property_name() {
+ let snippet = "(get-tenure-info? 0 1)";
+ let err =
+ mem_run_analysis(snippet, ClarityVersion::Clarity3, StacksEpochId::latest()).unwrap_err();
+ assert!(format!("{}", err.diagnostic)
+ .contains("missing property name for tenure info introspection"));
+}
+
+#[test]
+fn test_no_such_block_info_height() {
+ let snippet = "(get-block-info? time 1)";
+ let err =
+ mem_run_analysis(snippet, ClarityVersion::Clarity2, StacksEpochId::latest()).unwrap_err();
+ println!("{}", err.diagnostic);
+ assert!(
+ format!("{}", err.diagnostic).contains("expecting expression of type 'uint', found 'int'")
+ );
+}
+
+#[test]
+fn test_no_such_stacks_block_info_height() {
+ let snippet = "(get-stacks-block-info? time 1)";
+ let err =
+ mem_run_analysis(snippet, ClarityVersion::Clarity3, StacksEpochId::latest()).unwrap_err();
+ assert!(
+ format!("{}", err.diagnostic).contains("expecting expression of type 'uint', found 'int'")
+ );
+}
+
+#[test]
+fn test_no_such_tenure_info_height() {
+ let snippet = "(get-tenure-info? time 1)";
+ let err =
+ mem_run_analysis(snippet, ClarityVersion::Clarity3, StacksEpochId::latest()).unwrap_err();
+ assert!(
+ format!("{}", err.diagnostic).contains("expecting expression of type 'uint', found 'int'")
+ );
+}
+
#[test]
fn test_name_already_used() {
let snippet = "(define-constant var1 true) (define-constant var1 1)";
diff --git a/clarity/src/vm/analysis/trait_checker/tests.rs b/clarity/src/vm/analysis/trait_checker/tests.rs
index bc3f9962841..b1d9bdb2228 100644
--- a/clarity/src/vm/analysis/trait_checker/tests.rs
+++ b/clarity/src/vm/analysis/trait_checker/tests.rs
@@ -1463,7 +1463,7 @@ fn test_dynamic_dispatch_pass_bound_principal_as_trait_in_user_defined_functions
_ => panic!("{:?}", err),
};
}
- Ok(_) if version == ClarityVersion::Clarity2 => (),
+ Ok(_) if version >= ClarityVersion::Clarity2 => (),
_ => panic!("got {:?}", result),
}
}
diff --git a/clarity/src/vm/analysis/type_checker/mod.rs b/clarity/src/vm/analysis/type_checker/mod.rs
index c8185dde74e..800347d0f01 100644
--- a/clarity/src/vm/analysis/type_checker/mod.rs
+++ b/clarity/src/vm/analysis/type_checker/mod.rs
@@ -84,3 +84,21 @@ impl FunctionType {
}
}
}
+
+fn is_reserved_word_v3(word: &str) -> bool {
+ match word {
+ "block-height" => true,
+ _ => false,
+ }
+}
+
+/// Is this a reserved word that should trigger an analysis error for the given
+/// Clarity version? Note that most of the reserved words do not trigger an
+/// analysis error, but will trigger an error at runtime. This should likely be
+/// changed in a future Clarity version.
+pub fn is_reserved_word(word: &str, version: ClarityVersion) -> bool {
+ match version {
+ ClarityVersion::Clarity1 | ClarityVersion::Clarity2 => false,
+ ClarityVersion::Clarity3 => is_reserved_word_v3(word),
+ }
+}
diff --git a/clarity/src/vm/analysis/type_checker/v2_05/mod.rs b/clarity/src/vm/analysis/type_checker/v2_05/mod.rs
index d66cad5d4ee..2b913a3ac9c 100644
--- a/clarity/src/vm/analysis/type_checker/v2_05/mod.rs
+++ b/clarity/src/vm/analysis/type_checker/v2_05/mod.rs
@@ -323,9 +323,9 @@ fn type_reserved_variable(variable_name: &str) -> CheckResult TypeSignature::BoolType,
TotalLiquidMicroSTX => TypeSignature::UIntType,
Regtest => TypeSignature::BoolType,
- TxSponsor | Mainnet | ChainId => {
+ TxSponsor | Mainnet | ChainId | StacksBlockHeight | TenureHeight => {
return Err(CheckErrors::Expects(
- "tx-sponsor, mainnet, and chain-id should not reach here in 2.05".into(),
+ "tx-sponsor, mainnet, chain-id, stacks-block-height, and tenure-height should not reach here in 2.05".into(),
)
.into())
}
diff --git a/clarity/src/vm/analysis/type_checker/v2_05/natives/mod.rs b/clarity/src/vm/analysis/type_checker/v2_05/natives/mod.rs
index b38cfd0d115..201c307986e 100644
--- a/clarity/src/vm/analysis/type_checker/v2_05/natives/mod.rs
+++ b/clarity/src/vm/analysis/type_checker/v2_05/natives/mod.rs
@@ -773,9 +773,9 @@ impl TypedNativeFunction {
| StringToUInt | IntToAscii | IntToUtf8 | GetBurnBlockInfo | StxTransferMemo
| StxGetAccount | BitwiseAnd | BitwiseOr | BitwiseNot | BitwiseLShift
| BitwiseRShift | BitwiseXor2 | Slice | ToConsensusBuff | FromConsensusBuff
- | ReplaceAt => {
+ | ReplaceAt | GetStacksBlockInfo | GetTenureInfo => {
return Err(CheckErrors::Expects(
- "Clarity 2 keywords should not show up in 2.05".into(),
+ "Clarity 2+ keywords should not show up in 2.05".into(),
)
.into())
}
diff --git a/clarity/src/vm/analysis/type_checker/v2_05/tests/assets.rs b/clarity/src/vm/analysis/type_checker/v2_05/tests/assets.rs
index df9c35ed0e5..5cfc9ab9922 100644
--- a/clarity/src/vm/analysis/type_checker/v2_05/tests/assets.rs
+++ b/clarity/src/vm/analysis/type_checker/v2_05/tests/assets.rs
@@ -17,9 +17,10 @@
use stacks_common::types::StacksEpochId;
use crate::vm::analysis::errors::CheckErrors;
-use crate::vm::analysis::{mem_type_check, AnalysisDatabase};
+use crate::vm::analysis::AnalysisDatabase;
use crate::vm::ast::parse;
use crate::vm::database::MemoryBackingStore;
+use crate::vm::tooling::mem_type_check;
use crate::vm::types::{
QualifiedContractIdentifier, SequenceSubtype, StringSubtype, TypeSignature,
};
diff --git a/clarity/src/vm/analysis/type_checker/v2_1/contexts.rs b/clarity/src/vm/analysis/type_checker/v2_1/contexts.rs
index 8cbed1a416d..d210194ea40 100644
--- a/clarity/src/vm/analysis/type_checker/v2_1/contexts.rs
+++ b/clarity/src/vm/analysis/type_checker/v2_1/contexts.rs
@@ -19,6 +19,7 @@ use std::collections::BTreeMap;
use hashbrown::{HashMap, HashSet};
use crate::vm::analysis::errors::{CheckError, CheckErrors, CheckResult};
+use crate::vm::analysis::type_checker::is_reserved_word;
use crate::vm::analysis::types::ContractAnalysis;
use crate::vm::contexts::MAX_CONTEXT_DEPTH;
use crate::vm::representations::{ClarityName, SymbolicExpression};
@@ -42,7 +43,7 @@ impl TraitContext {
pub fn new(clarity_version: ClarityVersion) -> TraitContext {
match clarity_version {
ClarityVersion::Clarity1 => Self::Clarity1(HashMap::new()),
- ClarityVersion::Clarity2 => Self::Clarity2 {
+ ClarityVersion::Clarity2 | ClarityVersion::Clarity3 => Self::Clarity2 {
defined: HashSet::new(),
all: HashMap::new(),
},
@@ -128,6 +129,7 @@ impl TraitContext {
}
pub struct ContractContext {
+ clarity_version: ClarityVersion,
contract_identifier: QualifiedContractIdentifier,
map_types: HashMap,
variable_types: HashMap,
@@ -147,6 +149,7 @@ impl ContractContext {
clarity_version: ClarityVersion,
) -> ContractContext {
ContractContext {
+ clarity_version,
contract_identifier,
variable_types: HashMap::new(),
private_function_types: HashMap::new(),
@@ -168,6 +171,10 @@ impl ContractContext {
}
pub fn check_name_used(&self, name: &str) -> CheckResult<()> {
+ if is_reserved_word(name, self.clarity_version) {
+ return Err(CheckError::new(CheckErrors::ReservedWord(name.to_string())));
+ }
+
if self.variable_types.contains_key(name)
|| self.persisted_variable_types.contains_key(name)
|| self.private_function_types.contains_key(name)
@@ -279,6 +286,10 @@ impl ContractContext {
trait_name: ClarityName,
trait_signature: BTreeMap,
) -> CheckResult<()> {
+ if self.clarity_version >= ClarityVersion::Clarity3 {
+ self.check_name_used(&trait_name)?;
+ }
+
self.traits.add_defined_trait(
self.contract_identifier.clone(),
trait_name,
@@ -292,6 +303,10 @@ impl ContractContext {
trait_id: TraitIdentifier,
trait_signature: BTreeMap,
) -> CheckResult<()> {
+ if self.clarity_version >= ClarityVersion::Clarity3 {
+ self.check_name_used(&alias)?;
+ }
+
self.traits.add_used_trait(alias, trait_id, trait_signature)
}
diff --git a/clarity/src/vm/analysis/type_checker/v2_1/mod.rs b/clarity/src/vm/analysis/type_checker/v2_1/mod.rs
index b61d3bb6e28..7caf775c19b 100644
--- a/clarity/src/vm/analysis/type_checker/v2_1/mod.rs
+++ b/clarity/src/vm/analysis/type_checker/v2_1/mod.rs
@@ -37,6 +37,7 @@ use crate::vm::costs::{
analysis_typecheck_cost, cost_functions, runtime_cost, ClarityCostFunctionReference,
CostErrors, CostOverflowingMath, CostTracker, ExecutionCost, LimitedCostTracker,
};
+use crate::vm::diagnostic::Diagnostic;
use crate::vm::functions::define::DefineFunctionsParsed;
use crate::vm::functions::NativeFunctions;
use crate::vm::representations::SymbolicExpressionType::{
@@ -151,7 +152,130 @@ impl TypeChecker<'_, '_> {
pub type TypeResult = CheckResult;
+pub fn compute_typecheck_cost(
+ track: &mut T,
+ t1: &TypeSignature,
+ t2: &TypeSignature,
+) -> Result {
+ let t1_size = t1.type_size().map_err(|_| CostErrors::CostOverflow)?;
+ let t2_size = t2.type_size().map_err(|_| CostErrors::CostOverflow)?;
+ track.compute_cost(
+ ClarityCostFunction::AnalysisTypeCheck,
+ &[std::cmp::max(t1_size, t2_size).into()],
+ )
+}
+
+pub fn check_argument_len(expected: usize, args_len: usize) -> Result<(), CheckErrors> {
+ if args_len != expected {
+ Err(CheckErrors::IncorrectArgumentCount(expected, args_len))
+ } else {
+ Ok(())
+ }
+}
+
impl FunctionType {
+ pub fn check_args_visitor_2_1(
+ &self,
+ accounting: &mut T,
+ arg_type: &TypeSignature,
+ arg_index: usize,
+ accumulated_type: Option<&TypeSignature>,
+ ) -> (
+ Option>,
+ CheckResult>,
+ ) {
+ match self {
+ // variadic stops checking cost at the first error...
+ FunctionType::Variadic(expected_type, _) => {
+ let cost = Some(compute_typecheck_cost(accounting, expected_type, arg_type));
+ let admitted = match expected_type.admits_type(&StacksEpochId::Epoch21, arg_type) {
+ Ok(admitted) => admitted,
+ Err(e) => return (cost, Err(e.into())),
+ };
+ if !admitted {
+ return (
+ cost,
+ Err(CheckErrors::TypeError(expected_type.clone(), arg_type.clone()).into()),
+ );
+ }
+ (cost, Ok(None))
+ }
+ FunctionType::ArithmeticVariadic => {
+ let cost = Some(compute_typecheck_cost(
+ accounting,
+ &TypeSignature::IntType,
+ arg_type,
+ ));
+ if arg_index == 0 {
+ let return_type = match arg_type {
+ TypeSignature::IntType => Ok(Some(TypeSignature::IntType)),
+ TypeSignature::UIntType => Ok(Some(TypeSignature::UIntType)),
+ _ => Err(CheckErrors::UnionTypeError(
+ vec![TypeSignature::IntType, TypeSignature::UIntType],
+ arg_type.clone(),
+ )
+ .into()),
+ };
+ (cost, return_type)
+ } else {
+ let return_type = accumulated_type
+ .ok_or_else(|| CheckErrors::Expects("Failed to set accumulated type for arg indices >= 1 in variadic arithmetic".into()).into());
+ let check_result = return_type.and_then(|return_type| {
+ if arg_type != return_type {
+ Err(
+ CheckErrors::TypeError(return_type.clone(), arg_type.clone())
+ .into(),
+ )
+ } else {
+ Ok(None)
+ }
+ });
+ (cost, check_result)
+ }
+ }
+ // For the fixed function types, the visitor will just
+ // tell the processor that any results greater than the args len
+ // do not need to be stored, because an error will occur before
+ // further checking anyways
+ FunctionType::Fixed(FixedFunction {
+ args: arg_types, ..
+ }) => {
+ if arg_index >= arg_types.len() {
+ // note: argument count will be wrong?
+ return (
+ None,
+ Err(CheckErrors::IncorrectArgumentCount(arg_types.len(), arg_index).into()),
+ );
+ }
+ return (None, Ok(None));
+ }
+ // For the following function types, the visitor will just
+ // tell the processor that any results greater than len 1 or 2
+ // do not need to be stored, because an error will occur before
+ // further checking anyways
+ FunctionType::ArithmeticUnary | FunctionType::UnionArgs(..) => {
+ if arg_index >= 1 {
+ return (
+ None,
+ Err(CheckErrors::IncorrectArgumentCount(1, arg_index).into()),
+ );
+ }
+ return (None, Ok(None));
+ }
+ FunctionType::ArithmeticBinary
+ | FunctionType::ArithmeticComparison
+ | FunctionType::Binary(..) => {
+ if arg_index >= 2 {
+ return (
+ None,
+ Err(CheckErrors::IncorrectArgumentCount(2, arg_index).into()),
+ );
+ }
+ return (None, Ok(None));
+ }
+ }
+ }
+
pub fn check_args_2_1(
&self,
accounting: &mut T,
@@ -858,6 +982,8 @@ fn type_reserved_variable(
.map_err(|_| CheckErrors::Expects("Bad construction".into()))?,
ContractCaller => TypeSignature::PrincipalType,
BlockHeight => TypeSignature::UIntType,
+ StacksBlockHeight => TypeSignature::UIntType,
+ TenureHeight => TypeSignature::UIntType,
BurnBlockHeight => TypeSignature::UIntType,
NativeNone => TypeSignature::new_option(no_type())
.map_err(|_| CheckErrors::Expects("Bad construction".into()))?,
@@ -1015,17 +1141,23 @@ impl<'a, 'b> TypeChecker<'a, 'b> {
args: &[SymbolicExpression],
context: &TypingContext,
) -> TypeResult {
- let mut types_returned = self.type_check_all(args, context)?;
-
- let last_return = types_returned
- .pop()
- .ok_or(CheckError::new(CheckErrors::CheckerImplementationFailure))?;
-
- for type_return in types_returned.iter() {
- if type_return.is_response_type() {
- return Err(CheckErrors::UncheckedIntermediaryResponses.into());
+ let mut last_return = None;
+ let mut return_failure = Ok(());
+ for ix in 0..args.len() {
+ let type_return = self.type_check(&args[ix], context)?;
+ if ix + 1 < args.len() {
+ if type_return.is_response_type() {
+ return_failure = Err(CheckErrors::UncheckedIntermediaryResponses);
+ }
+ } else {
+ last_return = Some(type_return);
}
}
+
+ let last_return = last_return
+ .ok_or_else(|| CheckError::new(CheckErrors::CheckerImplementationFailure))?;
+ return_failure?;
+
Ok(last_return)
}
@@ -1050,8 +1182,56 @@ impl<'a, 'b> TypeChecker<'a, 'b> {
epoch: StacksEpochId,
clarity_version: ClarityVersion,
) -> TypeResult {
- let typed_args = self.type_check_all(args, context)?;
- func_type.check_args(self, &typed_args, epoch, clarity_version)
+ if epoch <= StacksEpochId::Epoch2_05 {
+ let typed_args = self.type_check_all(args, context)?;
+ return func_type.check_args(self, &typed_args, epoch, clarity_version);
+ }
+ // use func_type visitor pattern
+ let mut accumulated_type = None;
+ let mut total_costs = vec![];
+ let mut check_result = Ok(());
+ let mut accumulated_types = Vec::new();
+ for (arg_ix, arg_expr) in args.iter().enumerate() {
+ let arg_type = self.type_check(arg_expr, context)?;
+ if check_result.is_ok() {
+ let (costs, result) = func_type.check_args_visitor_2_1(
+ self,
+ &arg_type,
+ arg_ix,
+ accumulated_type.as_ref(),
+ );
+ // add the accumulated type and total cost *before*
+ // checking for an error: we want the subsequent error handling
+ // to account for this cost
+ accumulated_types.push(arg_type);
+ total_costs.extend(costs);
+
+ match result {
+ Ok(Some(returned_type)) => {
+ accumulated_type = Some(returned_type);
+ }
+ Ok(None) => {}
+ Err(e) => {
+ check_result = Err(e);
+ }
+ };
+ }
+ }
+ if let Err(mut check_error) = check_result {
+ if let CheckErrors::IncorrectArgumentCount(expected, _actual) = check_error.err {
+ check_error.err = CheckErrors::IncorrectArgumentCount(expected, args.len());
+ check_error.diagnostic = Diagnostic::err(&check_error.err)
+ }
+ // accumulate the checking costs
+ // the reason we do this now (instead of within the loop) is for backwards compatibility
+ for cost in total_costs.into_iter() {
+ self.add_cost(cost?)?;
+ }
+
+ return Err(check_error);
+ }
+ // otherwise, just invoke the normal checking routine
+ func_type.check_args(self, &accumulated_types, epoch, clarity_version)
}
fn get_function_type(&self, function_name: &str) -> Option {
diff --git a/clarity/src/vm/analysis/type_checker/v2_1/natives/mod.rs b/clarity/src/vm/analysis/type_checker/v2_1/natives/mod.rs
index c5aefb65eda..b576277a5b4 100644
--- a/clarity/src/vm/analysis/type_checker/v2_1/natives/mod.rs
+++ b/clarity/src/vm/analysis/type_checker/v2_1/natives/mod.rs
@@ -17,8 +17,8 @@
use stacks_common::types::StacksEpochId;
use super::{
- check_argument_count, check_arguments_at_least, check_arguments_at_most, no_type, TypeChecker,
- TypeResult, TypingContext,
+ check_argument_count, check_arguments_at_least, check_arguments_at_most,
+ compute_typecheck_cost, no_type, TypeChecker, TypeResult, TypingContext,
};
use crate::vm::analysis::errors::{CheckError, CheckErrors, CheckResult};
use crate::vm::costs::cost_functions::ClarityCostFunction;
@@ -35,8 +35,9 @@ use crate::vm::types::signatures::{
use crate::vm::types::TypeSignature::SequenceType;
use crate::vm::types::{
BlockInfoProperty, BufferLength, BurnBlockInfoProperty, FixedFunction, FunctionArg,
- FunctionSignature, FunctionType, PrincipalData, TupleTypeSignature, TypeSignature, Value,
- BUFF_1, BUFF_20, BUFF_32, BUFF_33, BUFF_64, BUFF_65, MAX_VALUE_SIZE,
+ FunctionSignature, FunctionType, PrincipalData, StacksBlockInfoProperty, TenureInfoProperty,
+ TupleTypeSignature, TypeSignature, Value, BUFF_1, BUFF_20, BUFF_32, BUFF_33, BUFF_64, BUFF_65,
+ MAX_VALUE_SIZE,
};
use crate::vm::{ClarityName, ClarityVersion, SymbolicExpression, SymbolicExpressionType};
@@ -61,14 +62,43 @@ fn check_special_list_cons(
args: &[SymbolicExpression],
context: &TypingContext,
) -> TypeResult {
- let typed_args = checker.type_check_all(args, context)?;
- for type_arg in typed_args.iter() {
- runtime_cost(
- ClarityCostFunction::AnalysisListItemsCheck,
- checker,
- type_arg.type_size()?,
- )?;
+ let mut result = Vec::with_capacity(args.len());
+ let mut entries_size: Option = Some(0);
+ let mut costs = Vec::with_capacity(args.len());
+
+ for arg in args.iter() {
+ // don't use map here, since type_check has side-effects.
+ let checked = checker.type_check(arg, context)?;
+ let cost = checked.type_size().and_then(|ty_size| {
+ checker
+ .compute_cost(
+ ClarityCostFunction::AnalysisListItemsCheck,
+ &[ty_size.into()],
+ )
+ .map_err(CheckErrors::from)
+ });
+ costs.push(cost);
+
+ if let Some(cur_size) = entries_size.clone() {
+ entries_size = cur_size.checked_add(checked.size()?);
+ }
+ if let Some(cur_size) = entries_size {
+ if cur_size > MAX_VALUE_SIZE {
+ entries_size = None;
+ }
+ }
+ if entries_size.is_some() {
+ result.push(checked);
+ }
+ }
+
+ for cost in costs.into_iter() {
+ checker.add_cost(cost?)?;
}
+ if entries_size.is_none() {
+ return Err(CheckErrors::ValueTooLarge.into());
+ }
+ let typed_args = result;
TypeSignature::parent_list_type(&typed_args)
.map_err(|x| x.into())
.map(TypeSignature::from)
@@ -202,6 +232,9 @@ pub fn check_special_tuple_cons(
args.len(),
)?;
+ let mut type_size = 0u32;
+ let mut cons_error = Ok(());
+
handle_binding_list(args, |var_name, var_sexp| {
checker.type_check(var_sexp, context).and_then(|var_type| {
runtime_cost(
@@ -209,11 +242,21 @@ pub fn check_special_tuple_cons(
checker,
var_type.type_size()?,
)?;
- tuple_type_data.push((var_name.clone(), var_type));
+ if type_size < MAX_VALUE_SIZE {
+ type_size = type_size
+ .saturating_add(var_name.len() as u32)
+ .saturating_add(var_name.len() as u32)
+ .saturating_add(var_type.type_size()?)
+ .saturating_add(var_type.size()?);
+ tuple_type_data.push((var_name.clone(), var_type));
+ } else {
+ cons_error = Err(CheckErrors::BadTupleConstruction);
+ }
Ok(())
})
})?;
+ cons_error?;
let tuple_signature = TupleTypeSignature::try_from(tuple_type_data)
.map_err(|_e| CheckErrors::BadTupleConstruction)?;
@@ -338,15 +381,33 @@ fn check_special_equals(
) -> TypeResult {
check_arguments_at_least(1, args)?;
- let arg_types = checker.type_check_all(args, context)?;
+ let mut arg_type = None;
+ let mut costs = Vec::with_capacity(args.len());
- let mut arg_type = arg_types[0].clone();
- for x_type in arg_types.into_iter() {
- analysis_typecheck_cost(checker, &x_type, &arg_type)?;
- arg_type = TypeSignature::least_supertype(&StacksEpochId::Epoch21, &x_type, &arg_type)
- .map_err(|_| CheckErrors::TypeError(x_type, arg_type))?;
+ for arg in args.iter() {
+ let x_type = checker.type_check(arg, context)?;
+ if arg_type.is_none() {
+ arg_type = Some(Ok(x_type.clone()));
+ }
+ if let Some(Ok(cur_type)) = arg_type {
+ let cost = compute_typecheck_cost(checker, &x_type, &cur_type);
+ costs.push(cost);
+ arg_type = Some(
+ TypeSignature::least_supertype(&StacksEpochId::Epoch21, &x_type, &cur_type)
+ .map_err(|_| CheckErrors::TypeError(x_type, cur_type)),
+ );
+ }
}
+ for cost in costs.into_iter() {
+ checker.add_cost(cost?)?;
+ }
+
+ // check if there was a least supertype failure.
+ arg_type.ok_or_else(|| {
+ CheckErrors::Expects("Arg type should be set because arguments checked for >= 1".into())
+ })??;
+
Ok(TypeSignature::BoolType)
}
@@ -699,6 +760,48 @@ fn check_get_burn_block_info(
)?)
}
+fn check_get_stacks_block_info(
+ checker: &mut TypeChecker,
+ args: &[SymbolicExpression],
+ context: &TypingContext,
+) -> TypeResult {
+ check_argument_count(2, args)?;
+
+ let block_info_prop_str = args[0].match_atom().ok_or(CheckError::new(
+ CheckErrors::GetStacksBlockInfoExpectPropertyName,
+ ))?;
+
+ let block_info_prop =
+ StacksBlockInfoProperty::lookup_by_name(block_info_prop_str).ok_or(CheckError::new(
+ CheckErrors::NoSuchStacksBlockInfoProperty(block_info_prop_str.to_string()),
+ ))?;
+
+ checker.type_check_expects(&args[1], context, &TypeSignature::UIntType)?;
+
+ Ok(TypeSignature::new_option(block_info_prop.type_result())?)
+}
+
+fn check_get_tenure_info(
+ checker: &mut TypeChecker,
+ args: &[SymbolicExpression],
+ context: &TypingContext,
+) -> TypeResult {
+ check_argument_count(2, args)?;
+
+ let block_info_prop_str = args[0].match_atom().ok_or(CheckError::new(
+ CheckErrors::GetTenureInfoExpectPropertyName,
+ ))?;
+
+ let block_info_prop =
+ TenureInfoProperty::lookup_by_name(block_info_prop_str).ok_or(CheckError::new(
+ CheckErrors::NoSuchTenureInfoProperty(block_info_prop_str.to_string()),
+ ))?;
+
+ checker.type_check_expects(&args[1], context, &TypeSignature::UIntType)?;
+
+ Ok(TypeSignature::new_option(block_info_prop.type_result())?)
+}
+
impl TypedNativeFunction {
pub fn type_check_application(
&self,
@@ -1034,6 +1137,8 @@ impl TypedNativeFunction {
PrincipalOf => Special(SpecialNativeFunction(&check_principal_of)),
GetBlockInfo => Special(SpecialNativeFunction(&check_get_block_info)),
GetBurnBlockInfo => Special(SpecialNativeFunction(&check_get_burn_block_info)),
+ GetStacksBlockInfo => Special(SpecialNativeFunction(&check_get_stacks_block_info)),
+ GetTenureInfo => Special(SpecialNativeFunction(&check_get_tenure_info)),
ConsSome => Special(SpecialNativeFunction(&options::check_special_some)),
ConsOkay => Special(SpecialNativeFunction(&options::check_special_okay)),
ConsError => Special(SpecialNativeFunction(&options::check_special_error)),
diff --git a/clarity/src/vm/analysis/type_checker/v2_1/natives/sequences.rs b/clarity/src/vm/analysis/type_checker/v2_1/natives/sequences.rs
index 090b259a26d..c1b3aabb178 100644
--- a/clarity/src/vm/analysis/type_checker/v2_1/natives/sequences.rs
+++ b/clarity/src/vm/analysis/type_checker/v2_1/natives/sequences.rs
@@ -22,7 +22,8 @@ use crate::vm::analysis::type_checker::v2_1::{
TypeResult, TypingContext,
};
use crate::vm::costs::cost_functions::ClarityCostFunction;
-use crate::vm::costs::{analysis_typecheck_cost, cost_functions, runtime_cost};
+use crate::vm::costs::{analysis_typecheck_cost, cost_functions, runtime_cost, CostTracker};
+use crate::vm::diagnostic::Diagnostic;
use crate::vm::functions::NativeFunctions;
use crate::vm::representations::{SymbolicExpression, SymbolicExpressionType};
pub use crate::vm::types::signatures::{BufferLength, ListTypeData, StringUTF8Length, BUFF_1};
@@ -73,9 +74,15 @@ pub fn check_special_map(
)?;
let iter = args[1..].iter();
- let mut func_args = Vec::with_capacity(iter.len());
let mut min_args = u32::MAX;
- for arg in iter {
+
+ // use func_type visitor pattern
+ let mut accumulated_type = None;
+ let mut total_costs = vec![];
+ let mut check_result = Ok(());
+ let mut accumulated_types = Vec::new();
+
+ for (arg_ix, arg) in iter.enumerate() {
let argument_type = checker.type_check(arg, context)?;
let entry_type = match argument_type {
TypeSignature::SequenceType(sequence) => {
@@ -101,11 +108,52 @@ pub fn check_special_map(
return Err(CheckErrors::ExpectedSequence(argument_type).into());
}
};
- func_args.push(entry_type);
+
+ if check_result.is_ok() {
+ let (costs, result) = function_type.check_args_visitor_2_1(
+ checker,
+ &entry_type,
+ arg_ix,
+ accumulated_type.as_ref(),
+ );
+ // add the accumulated type and total cost *before*
+ // checking for an error: we want the subsequent error handling
+ // to account for this cost
+ accumulated_types.push(entry_type);
+ total_costs.extend(costs);
+
+ match result {
+ Ok(Some(returned_type)) => {
+ accumulated_type = Some(returned_type);
+ }
+ Ok(None) => {}
+ Err(e) => {
+ check_result = Err(e);
+ }
+ };
+ }
}
- let mapped_type =
- function_type.check_args(checker, &func_args, context.epoch, context.clarity_version)?;
+ if let Err(mut check_error) = check_result {
+ if let CheckErrors::IncorrectArgumentCount(expected, _actual) = check_error.err {
+ check_error.err =
+ CheckErrors::IncorrectArgumentCount(expected, args.len().saturating_sub(1));
+ check_error.diagnostic = Diagnostic::err(&check_error.err)
+ }
+ // accumulate the checking costs
+ for cost in total_costs.into_iter() {
+ checker.add_cost(cost?)?;
+ }
+
+ return Err(check_error);
+ }
+
+ let mapped_type = function_type.check_args(
+ checker,
+ &accumulated_types,
+ context.epoch,
+ context.clarity_version,
+ )?;
TypeSignature::list_of(mapped_type, min_args)
.map_err(|_| CheckErrors::ConstructedListTooLarge.into())
}
diff --git a/clarity/src/vm/analysis/type_checker/v2_1/tests/assets.rs b/clarity/src/vm/analysis/type_checker/v2_1/tests/assets.rs
index c870fdbab7a..ba120575bd3 100644
--- a/clarity/src/vm/analysis/type_checker/v2_1/tests/assets.rs
+++ b/clarity/src/vm/analysis/type_checker/v2_1/tests/assets.rs
@@ -130,7 +130,7 @@ fn test_names_tokens_contracts(#[case] version: ClarityVersion, #[case] epoch: S
#[test]
fn test_bad_asset_usage() {
- use crate::vm::analysis::type_check;
+ use crate::vm::analysis::mem_type_check as mem_run_analysis;
let bad_scripts = [
"(ft-get-balance stackoos tx-sender)",
@@ -218,7 +218,12 @@ fn test_bad_asset_usage() {
for (script, expected_err) in bad_scripts.iter().zip(expected.iter()) {
let tokens_contract = format!("{}\n{}", FIRST_CLASS_TOKENS, script);
- let actual_err = mem_type_check(&tokens_contract).unwrap_err();
+ let actual_err = mem_run_analysis(
+ &tokens_contract,
+ ClarityVersion::Clarity2,
+ StacksEpochId::latest(),
+ )
+ .unwrap_err();
println!("{}", script);
assert_eq!(&actual_err.err, expected_err);
}
diff --git a/clarity/src/vm/analysis/type_checker/v2_1/tests/contracts.rs b/clarity/src/vm/analysis/type_checker/v2_1/tests/contracts.rs
index 99942ba42c2..b87177062ce 100644
--- a/clarity/src/vm/analysis/type_checker/v2_1/tests/contracts.rs
+++ b/clarity/src/vm/analysis/type_checker/v2_1/tests/contracts.rs
@@ -433,7 +433,7 @@ fn test_names_tokens_contracts_interface() {
"fungible_tokens": [],
"non_fungible_tokens": [],
"epoch": "Epoch21",
- "clarity_version": "Clarity2"
+ "clarity_version": "Clarity3"
}"#).unwrap();
eprintln!("{}", test_contract_json_str);
@@ -1894,7 +1894,7 @@ fn clarity_trait_experiments_double_trait(
// Can we define a trait with two methods with the same name and different types?
match db.execute(|db| load_versioned(db, "double-trait", version, epoch)) {
Ok(_) if version == ClarityVersion::Clarity1 => (),
- Err(err) if version == ClarityVersion::Clarity2 => {
+ Err(err) if version >= ClarityVersion::Clarity2 => {
assert!(err.starts_with("DefineTraitDuplicateMethod(\"foo\")"))
}
res => panic!("got {:?}", res),
@@ -1915,7 +1915,7 @@ fn clarity_trait_experiments_impl_double_trait_both(
load_versioned(db, "impl-double-trait-both", version, epoch)
}) {
Ok(_) if version == ClarityVersion::Clarity1 => (),
- Err(err) if version == ClarityVersion::Clarity2 => {
+ Err(err) if version >= ClarityVersion::Clarity2 => {
assert!(err.starts_with("DefineTraitDuplicateMethod(\"foo\")"))
}
res => panic!("got {:?}", res),
@@ -1938,7 +1938,7 @@ fn clarity_trait_experiments_impl_double_trait_1(
Err(err) if version == ClarityVersion::Clarity1 => {
assert!(err.starts_with("BadTraitImplementation(\"double-method\", \"foo\")"))
}
- Err(err) if version == ClarityVersion::Clarity2 => {
+ Err(err) if version >= ClarityVersion::Clarity2 => {
assert!(err.starts_with("DefineTraitDuplicateMethod(\"foo\")"))
}
res => panic!("got {:?}", res),
@@ -1959,7 +1959,7 @@ fn clarity_trait_experiments_impl_double_trait_2(
load_versioned(db, "impl-double-trait-2", version, epoch)
}) {
Ok(_) if version == ClarityVersion::Clarity1 => (),
- Err(err) if version == ClarityVersion::Clarity2 => {
+ Err(err) if version >= ClarityVersion::Clarity2 => {
assert!(err.starts_with("DefineTraitDuplicateMethod(\"foo\")"))
}
res => panic!("got {:?}", res),
@@ -1983,7 +1983,7 @@ fn clarity_trait_experiments_use_double_trait(
Err(err) if version == ClarityVersion::Clarity1 => {
assert!(err.starts_with("TypeError(BoolType, UIntType)"))
}
- Err(err) if version == ClarityVersion::Clarity2 => {
+ Err(err) if version >= ClarityVersion::Clarity2 => {
assert!(err.starts_with("DefineTraitDuplicateMethod(\"foo\")"))
}
res => panic!("got {:?}", res),
@@ -2007,7 +2007,7 @@ fn clarity_trait_experiments_use_partial_double_trait_1(
Err(err) if version == ClarityVersion::Clarity1 => {
assert!(err.starts_with("TypeError(BoolType, UIntType)"))
}
- Err(err) if version == ClarityVersion::Clarity2 => {
+ Err(err) if version >= ClarityVersion::Clarity2 => {
assert!(err.starts_with("DefineTraitDuplicateMethod(\"foo\")"))
}
res => panic!("got {:?}", res),
@@ -2029,7 +2029,7 @@ fn clarity_trait_experiments_use_partial_double_trait_2(
load_versioned(db, "use-partial-double-trait-2", version, epoch)
}) {
Ok(_) if version == ClarityVersion::Clarity1 => (),
- Err(err) if version == ClarityVersion::Clarity2 => {
+ Err(err) if version >= ClarityVersion::Clarity2 => {
assert!(err.starts_with("DefineTraitDuplicateMethod(\"foo\")"))
}
res => panic!("got {:?}", res),
@@ -2047,7 +2047,7 @@ fn clarity_trait_experiments_identical_double_trait(
// Can we define a trait with two methods with the same name and the same type?
match db.execute(|db| load_versioned(db, "identical-double-trait", version, epoch)) {
Ok(_) if version == ClarityVersion::Clarity1 => (),
- Err(err) if version == ClarityVersion::Clarity2 => {
+ Err(err) if version >= ClarityVersion::Clarity2 => {
assert!(err.starts_with("DefineTraitDuplicateMethod(\"foo\")"))
}
res => panic!("got {:?}", res),
@@ -2068,7 +2068,7 @@ fn clarity_trait_experiments_impl_identical_double_trait(
load_versioned(db, "impl-identical-double-trait", version, epoch)
}) {
Ok(_) if version == ClarityVersion::Clarity1 => (),
- Err(err) if version == ClarityVersion::Clarity2 => {
+ Err(err) if version >= ClarityVersion::Clarity2 => {
assert!(err.starts_with("DefineTraitDuplicateMethod(\"foo\")"))
}
res => panic!("got {:?}", res),
@@ -2126,7 +2126,7 @@ fn clarity_trait_experiments_use_math_trait_transitive_name(
load_versioned(db, "use-math-trait-transitive-name", version, epoch)
}) {
Ok(_) if version == ClarityVersion::Clarity1 => (),
- Err(err) if version == ClarityVersion::Clarity2 => {
+ Err(err) if version >= ClarityVersion::Clarity2 => {
assert!(err.starts_with("TraitReferenceUnknown(\"math-alias\")"))
}
res => panic!("got {:?}", res),
@@ -2147,7 +2147,7 @@ fn clarity_trait_experiments_use_original_and_define_a_trait(
load_versioned(db, "use-original-and-define-a-trait", version, epoch)
});
match result {
- Ok(_) if version == ClarityVersion::Clarity2 => (),
+ Ok(_) if version >= ClarityVersion::Clarity2 => (),
Err(err) if version == ClarityVersion::Clarity1 => {
assert!(err.starts_with("TraitMethodUnknown(\"a\", \"do-it\")"))
}
@@ -2170,7 +2170,7 @@ fn clarity_trait_experiments_use_redefined_and_define_a_trait(
load_versioned(db, "use-redefined-and-define-a-trait", version, epoch)
}) {
Ok(_) if version == ClarityVersion::Clarity1 => (),
- Err(err) if version == ClarityVersion::Clarity2 => {
+ Err(err) if version >= ClarityVersion::Clarity2 => {
assert!(err.starts_with("TraitMethodUnknown(\"a\", \"do-that\")"))
}
res => panic!("got {:?}", res),
@@ -2266,7 +2266,7 @@ fn clarity_trait_experiments_call_nested_trait_1(
Err(err) if version == ClarityVersion::Clarity1 => {
assert!(err.starts_with("TypeError"))
}
- Ok(_) if version == ClarityVersion::Clarity2 => (),
+ Ok(_) if version >= ClarityVersion::Clarity2 => (),
res => panic!("got {:?}", res),
};
}
@@ -2292,7 +2292,7 @@ fn clarity_trait_experiments_call_nested_trait_2(
Err(err) if version == ClarityVersion::Clarity1 => {
assert!(err.starts_with("TypeError"))
}
- Ok(_) if version == ClarityVersion::Clarity2 => (),
+ Ok(_) if version >= ClarityVersion::Clarity2 => (),
res => panic!("got {:?}", res),
};
}
@@ -2318,7 +2318,7 @@ fn clarity_trait_experiments_call_nested_trait_3_ok(
Err(err) if version == ClarityVersion::Clarity1 => {
assert!(err.starts_with("TypeError"))
}
- Ok(_) if version == ClarityVersion::Clarity2 => (),
+ Ok(_) if version >= ClarityVersion::Clarity2 => (),
res => panic!("got {:?}", res),
};
}
@@ -2374,7 +2374,7 @@ fn clarity_trait_experiments_call_nested_trait_4(
Err(err) if version == ClarityVersion::Clarity1 => {
assert!(err.starts_with("TypeError"))
}
- Ok(_) if version == ClarityVersion::Clarity2 => (),
+ Ok(_) if version >= ClarityVersion::Clarity2 => (),
res => panic!("got {:?}", res),
};
}
@@ -2469,7 +2469,7 @@ fn clarity_trait_experiments_call_let_rename_trait(
load_versioned(db, "call-let-rename-trait", version, epoch)
});
match result {
- Ok(_) if version == ClarityVersion::Clarity2 => (),
+ Ok(_) if version >= ClarityVersion::Clarity2 => (),
Err(err) if version == ClarityVersion::Clarity1 => {
assert!(err.starts_with("TraitReferenceUnknown(\"new-math-contract\")"))
}
@@ -2637,7 +2637,7 @@ fn clarity_trait_experiments_constant_call(
load_versioned(db, "constant-call", version, epoch)
});
match result {
- Ok(_) if version == ClarityVersion::Clarity2 => (),
+ Ok(_) if version >= ClarityVersion::Clarity2 => (),
Err(err) if version == ClarityVersion::Clarity1 => {
assert!(err.starts_with("TraitReferenceUnknown(\"principal-value\")"))
}
@@ -2660,7 +2660,7 @@ fn clarity_trait_experiments_constant_to_trait(
load_versioned(db, "constant-to-trait", version, epoch)
});
match result {
- Ok(_) if version == ClarityVersion::Clarity2 => (),
+ Ok(_) if version >= ClarityVersion::Clarity2 => (),
Err(err) if epoch <= StacksEpochId::Epoch2_05 => {
assert!(err.starts_with("TypeError(TraitReferenceType"))
}
@@ -2687,7 +2687,7 @@ fn clarity_trait_experiments_constant_to_constant_call(
load_versioned(db, "constant-to-constant-call", version, epoch)
});
match result {
- Ok(_) if version == ClarityVersion::Clarity2 => (),
+ Ok(_) if version >= ClarityVersion::Clarity2 => (),
Err(err) if epoch <= StacksEpochId::Epoch2_05 => {
assert!(err.starts_with("TypeError(TraitReferenceType"))
}
@@ -2740,7 +2740,9 @@ fn clarity_trait_experiments_downcast_literal_2(
})
.unwrap_err();
match version {
- ClarityVersion::Clarity2 => assert!(err.starts_with("ExpectedCallableType(PrincipalType)")),
+ ClarityVersion::Clarity2 | ClarityVersion::Clarity3 => {
+ assert!(err.starts_with("ExpectedCallableType(PrincipalType)"))
+ }
ClarityVersion::Clarity1 => {
assert!(err.starts_with("TraitReferenceUnknown(\"principal-value\")"))
}
@@ -2874,7 +2876,7 @@ fn clarity_trait_experiments_identical_trait_cast(
load_versioned(db, "identical-trait-cast", version, epoch)
});
match result {
- Ok(_) if version == ClarityVersion::Clarity2 => (),
+ Ok(_) if version >= ClarityVersion::Clarity2 => (),
Err(err) if epoch <= StacksEpochId::Epoch2_05 => {
assert!(err.starts_with("TypeError(TraitReferenceType(TraitIdentifier"))
}
@@ -2900,7 +2902,7 @@ fn clarity_trait_experiments_trait_cast(
load_versioned(db, "trait-cast", version, epoch)
});
match result {
- Ok(_) if version == ClarityVersion::Clarity2 => (),
+ Ok(_) if version >= ClarityVersion::Clarity2 => (),
Err(err) if epoch <= StacksEpochId::Epoch2_05 => {
assert!(err.starts_with("TypeError(TraitReferenceType(TraitIdentifier"))
}
@@ -2935,7 +2937,9 @@ fn clarity_trait_experiments_trait_cast_incompatible(
assert!(err.starts_with("TypeError(CallableType(Trait(TraitIdentifier"))
}
}
- ClarityVersion::Clarity2 => assert!(err.starts_with("IncompatibleTrait")),
+ ClarityVersion::Clarity2 | ClarityVersion::Clarity3 => {
+ assert!(err.starts_with("IncompatibleTrait"))
+ }
}
}
@@ -3208,7 +3212,7 @@ fn clarity_trait_experiments_call_full_double_trait(
});
match result {
Ok(_) if version == ClarityVersion::Clarity1 => (),
- Err(err) if version == ClarityVersion::Clarity2 => {
+ Err(err) if version >= ClarityVersion::Clarity2 => {
assert!(err.starts_with("DefineTraitDuplicateMethod(\"foo\")"))
}
res => panic!("got {:?}", res),
@@ -3239,7 +3243,7 @@ fn clarity_trait_experiments_call_partial_double_trait(
});
match result {
Ok(_) if version == ClarityVersion::Clarity1 => (),
- Err(err) if version == ClarityVersion::Clarity2 => {
+ Err(err) if version >= ClarityVersion::Clarity2 => {
assert!(err.starts_with("DefineTraitDuplicateMethod(\"foo\")"))
}
res => panic!("got {:?}", res),
@@ -3290,7 +3294,7 @@ fn clarity_trait_experiments_principals_list_to_traits_list(
load_versioned(db, "list-of-principals", version, epoch)
});
match result {
- Ok(_) if version == ClarityVersion::Clarity2 => (),
+ Ok(_) if version >= ClarityVersion::Clarity2 => (),
Err(err) if version == ClarityVersion::Clarity1 => {
assert!(err.starts_with("TypeError(SequenceType(ListType"))
}
@@ -3333,7 +3337,7 @@ fn clarity_trait_experiments_mixed_list_to_traits_list(
load_versioned(db, "mixed-list", version, epoch)
});
match result {
- Ok(_) if version == ClarityVersion::Clarity2 => (),
+ Ok(_) if version >= ClarityVersion::Clarity2 => (),
Err(err) if epoch <= StacksEpochId::Epoch2_05 => {
assert!(err.starts_with("TypeError(TraitReferenceType"))
}
diff --git a/clarity/src/vm/analysis/type_checker/v2_1/tests/mod.rs b/clarity/src/vm/analysis/type_checker/v2_1/tests/mod.rs
index 85a6b39ea9c..12597c88fae 100644
--- a/clarity/src/vm/analysis/type_checker/v2_1/tests/mod.rs
+++ b/clarity/src/vm/analysis/type_checker/v2_1/tests/mod.rs
@@ -29,7 +29,6 @@ use crate::vm::analysis::{mem_type_check as mem_run_analysis, AnalysisDatabase};
use crate::vm::ast::errors::ParseErrors;
use crate::vm::ast::{build_ast, parse};
use crate::vm::contexts::OwnedEnvironment;
-use crate::vm::database::MemoryBackingStore;
use crate::vm::representations::SymbolicExpression;
use crate::vm::tests::test_clarity_versions;
use crate::vm::types::signatures::TypeSignature::OptionalType;
@@ -61,11 +60,15 @@ fn type_check_helper(exp: &str) -> TypeResult {
mem_type_check(exp).map(|(type_sig_opt, _)| type_sig_opt.unwrap())
}
-fn type_check_helper_v1(exp: &str) -> TypeResult {
- mem_run_analysis(exp, ClarityVersion::Clarity1, StacksEpochId::latest())
+fn type_check_helper_version(exp: &str, version: ClarityVersion) -> TypeResult {
+ mem_run_analysis(exp, version, StacksEpochId::latest())
.map(|(type_sig_opt, _)| type_sig_opt.unwrap())
}
+fn type_check_helper_v1(exp: &str) -> TypeResult {
+ type_check_helper_version(exp, ClarityVersion::Clarity1)
+}
+
fn buff_type(size: u32) -> TypeSignature {
TypeSignature::SequenceType(BufferType(size.try_into().unwrap()))
}
@@ -270,18 +273,29 @@ fn test_get_block_info() {
for (good_test, expected) in good.iter().zip(expected.iter()) {
assert_eq!(
expected,
- &format!("{}", type_check_helper(good_test).unwrap())
+ &format!(
+ "{}",
+ type_check_helper_version(good_test, ClarityVersion::Clarity2).unwrap()
+ )
);
}
for (good_test_v210, expected_v210) in good_v210.iter().zip(expected_v210.iter()) {
assert_eq!(
expected_v210,
- &format!("{}", type_check_helper(good_test_v210).unwrap())
+ &format!(
+ "{}",
+ type_check_helper_version(good_test_v210, ClarityVersion::Clarity2).unwrap()
+ )
);
}
for (bad_test, expected) in bad.iter().zip(bad_expected.iter()) {
- assert_eq!(expected, &type_check_helper(bad_test).unwrap_err().err);
+ assert_eq!(
+ expected,
+ &type_check_helper_version(bad_test, ClarityVersion::Clarity2)
+ .unwrap_err()
+ .err
+ );
}
for good_test in good_v210.iter() {
diff --git a/clarity/src/vm/ast/definition_sorter/tests.rs b/clarity/src/vm/ast/definition_sorter/tests.rs
index d0b24164ae9..2c993db2660 100644
--- a/clarity/src/vm/ast/definition_sorter/tests.rs
+++ b/clarity/src/vm/ast/definition_sorter/tests.rs
@@ -25,7 +25,6 @@ use crate::vm::ast::errors::{ParseErrors, ParseResult};
use crate::vm::ast::expression_identifier::ExpressionIdentifier;
use crate::vm::ast::parser;
use crate::vm::ast::types::{BuildASTPass, ContractAST};
-use crate::vm::database::MemoryBackingStore;
use crate::vm::types::QualifiedContractIdentifier;
use crate::vm::ClarityVersion;
diff --git a/clarity/src/vm/ast/parser/v1.rs b/clarity/src/vm/ast/parser/v1.rs
index 75c5ea2df94..5c2715e9f79 100644
--- a/clarity/src/vm/ast/parser/v1.rs
+++ b/clarity/src/vm/ast/parser/v1.rs
@@ -508,6 +508,8 @@ fn handle_expression(
}
}
+// TODO: add tests from mutation testing results #4828
+#[cfg_attr(test, mutants::skip)]
pub fn parse_lexed(input: Vec<(LexItem, u32, u32)>) -> ParseResult> {
let mut parse_stack = Vec::new();
diff --git a/clarity/src/vm/ast/parser/v2/mod.rs b/clarity/src/vm/ast/parser/v2/mod.rs
index a7ba4eb3c89..4c46e76a4d9 100644
--- a/clarity/src/vm/ast/parser/v2/mod.rs
+++ b/clarity/src/vm/ast/parser/v2/mod.rs
@@ -206,6 +206,8 @@ impl<'a> Parser<'a> {
}
}
+ // TODO: add tests from mutation testing results #4829
+ #[cfg_attr(test, mutants::skip)]
/// Process a new child node for an AST expression that is open and waiting for children nodes. For example,
/// a list or tuple expression that is waiting for child expressions.
///
@@ -275,6 +277,8 @@ impl<'a> Parser<'a> {
}
}
+ // TODO: add tests from mutation testing results #4848
+ #[cfg_attr(test, mutants::skip)]
fn handle_open_tuple(
&mut self,
open_tuple: &mut OpenTuple,
diff --git a/clarity/src/vm/ast/sugar_expander/mod.rs b/clarity/src/vm/ast/sugar_expander/mod.rs
index 0f28093932b..670796cf4cc 100644
--- a/clarity/src/vm/ast/sugar_expander/mod.rs
+++ b/clarity/src/vm/ast/sugar_expander/mod.rs
@@ -58,6 +58,8 @@ impl SugarExpander {
Ok(())
}
+ // TODO: add tests from mutation testing results #4830
+ #[cfg_attr(test, mutants::skip)]
pub fn transform(
&self,
pre_exprs_iter: PreExpressionsDrain,
diff --git a/clarity/src/vm/contexts.rs b/clarity/src/vm/contexts.rs
index 7ad70e4ffbc..a559ad59fd1 100644
--- a/clarity/src/vm/contexts.rs
+++ b/clarity/src/vm/contexts.rs
@@ -74,7 +74,7 @@ pub struct Environment<'a, 'b, 'hooks> {
}
pub struct OwnedEnvironment<'a, 'hooks> {
- context: GlobalContext<'a, 'hooks>,
+ pub(crate) context: GlobalContext<'a, 'hooks>,
call_stack: CallStack,
}
@@ -198,7 +198,7 @@ pub struct GlobalContext<'a, 'hooks> {
read_only: Vec,
pub cost_track: LimitedCostTracker,
pub mainnet: bool,
- /// This is the epoch of the the block that this transaction is executing within.
+ /// This is the epoch of the block that this transaction is executing within.
pub epoch_id: StacksEpochId,
/// This is the chain ID of the transaction
pub chain_id: u32,
@@ -973,7 +973,11 @@ impl<'a, 'b, 'hooks> Environment<'a, 'b, 'hooks> {
let contract = self
.global_context
.database
- .get_contract(contract_identifier)?;
+ .get_contract(contract_identifier)
+ .or_else(|e| {
+ self.global_context.roll_back()?;
+ Err(e)
+ })?;
let result = {
let mut nested_env = Environment::new(
@@ -1049,7 +1053,7 @@ impl<'a, 'b, 'hooks> Environment<'a, 'b, 'hooks> {
result
}
- /// This is the epoch of the the block that this transaction is executing within.
+ /// This is the epoch of the block that this transaction is executing within.
/// Note: in the current plans for 2.1, there is also a contract-specific **Clarity version**
/// which governs which native functions are available / defined. That is separate from this
/// epoch identifier, and most Clarity VM changes should consult that value instead. This
diff --git a/clarity/src/vm/costs/mod.rs b/clarity/src/vm/costs/mod.rs
index 744b6056911..0751822ed01 100644
--- a/clarity/src/vm/costs/mod.rs
+++ b/clarity/src/vm/costs/mod.rs
@@ -19,7 +19,6 @@ use std::{cmp, fmt};
use hashbrown::HashMap;
use lazy_static::lazy_static;
-use rusqlite::types::{FromSql, FromSqlResult, ToSql, ToSqlOutput, ValueRef};
use serde::{Deserialize, Serialize};
use stacks_common::types::StacksEpochId;
@@ -783,12 +782,11 @@ impl LimitedCostTracker {
}
impl TrackerData {
+ // TODO: add tests from mutation testing results #4831
+ #[cfg_attr(test, mutants::skip)]
/// `apply_updates` - tells this function to look for any changes in the cost voting contract
/// which would need to be applied. if `false`, just load the last computed cost state in this
/// fork.
- /// TODO: #4587 add test for Err cases
- /// Or keep the skip and remove the comment
- #[cfg_attr(test, mutants::skip)]
fn load_costs(&mut self, clarity_db: &mut ClarityDatabase, apply_updates: bool) -> Result<()> {
clarity_db.begin();
let epoch_id = clarity_db
@@ -958,6 +956,8 @@ fn parse_cost(
}
}
+// TODO: add tests from mutation testing results #4832
+#[cfg_attr(test, mutants::skip)]
fn compute_cost(
cost_tracker: &mut TrackerData,
cost_function_reference: ClarityCostFunctionReference,
@@ -1166,23 +1166,6 @@ impl fmt::Display for ExecutionCost {
}
}
-impl ToSql for ExecutionCost {
- fn to_sql(&self) -> rusqlite::Result {
- let val = serde_json::to_string(self)
- .map_err(|e| rusqlite::Error::ToSqlConversionFailure(Box::new(e)))?;
- Ok(ToSqlOutput::from(val))
- }
-}
-
-impl FromSql for ExecutionCost {
- fn column_result(value: ValueRef) -> FromSqlResult {
- let str_val = String::column_result(value)?;
- let parsed = serde_json::from_str(&str_val)
- .map_err(|e| rusqlite::types::FromSqlError::Other(Box::new(e)))?;
- Ok(parsed)
- }
-}
-
pub trait CostOverflowingMath {
fn cost_overflow_mul(self, other: T) -> Result;
fn cost_overflow_add(self, other: T) -> Result;
diff --git a/clarity/src/vm/database/clarity_db.rs b/clarity/src/vm/database/clarity_db.rs
index b395f88c6db..cdf411fc3ed 100644
--- a/clarity/src/vm/database/clarity_db.rs
+++ b/clarity/src/vm/database/clarity_db.rs
@@ -25,9 +25,7 @@ use stacks_common::types::chainstate::{
BlockHeaderHash, BurnchainHeaderHash, ConsensusHash, SortitionId, StacksAddress, StacksBlockId,
VRFSeed,
};
-use stacks_common::types::{
- Address, StacksEpoch as GenericStacksEpoch, StacksEpochId, PEER_VERSION_EPOCH_2_0,
-};
+use stacks_common::types::{Address, StacksEpoch as GenericStacksEpoch, StacksEpochId};
use stacks_common::util::hash::{to_hex, Hash160, Sha256Sum, Sha512Trunc256Sum};
use super::clarity_store::SpecialCaseHandler;
@@ -54,6 +52,7 @@ use crate::vm::types::{
};
pub const STORE_CONTRACT_SRC_INTERFACE: bool = true;
+const TENURE_HEIGHT_KEY: &str = "_stx-data::tenure_height";
pub type StacksEpoch = GenericStacksEpoch;
@@ -87,20 +86,55 @@ pub trait HeadersDB {
fn get_stacks_block_header_hash_for_block(
&self,
id_bhh: &StacksBlockId,
+ epoch: &StacksEpochId,
) -> Option;
fn get_burn_header_hash_for_block(&self, id_bhh: &StacksBlockId)
-> Option;
- fn get_consensus_hash_for_block(&self, id_bhh: &StacksBlockId) -> Option;
- fn get_vrf_seed_for_block(&self, id_bhh: &StacksBlockId) -> Option;
- fn get_burn_block_time_for_block(&self, id_bhh: &StacksBlockId) -> Option;
+ fn get_consensus_hash_for_block(
+ &self,
+ id_bhh: &StacksBlockId,
+ epoch: &StacksEpochId,
+ ) -> Option;
+ fn get_vrf_seed_for_block(
+ &self,
+ id_bhh: &StacksBlockId,
+ epoch: &StacksEpochId,
+ ) -> Option;
+ fn get_stacks_block_time_for_block(&self, id_bhh: &StacksBlockId) -> Option;
+ fn get_burn_block_time_for_block(
+ &self,
+ id_bhh: &StacksBlockId,
+ epoch: Option<&StacksEpochId>,
+ ) -> Option;
fn get_burn_block_height_for_block(&self, id_bhh: &StacksBlockId) -> Option;
- fn get_miner_address(&self, id_bhh: &StacksBlockId) -> Option;
- fn get_burnchain_tokens_spent_for_block(&self, id_bhh: &StacksBlockId) -> Option;
- fn get_burnchain_tokens_spent_for_winning_block(&self, id_bhh: &StacksBlockId) -> Option;
- fn get_tokens_earned_for_block(&self, id_bhh: &StacksBlockId) -> Option;
+ fn get_miner_address(
+ &self,
+ id_bhh: &StacksBlockId,
+ epoch: &StacksEpochId,
+ ) -> Option;
+ fn get_burnchain_tokens_spent_for_block(
+ &self,
+ id_bhh: &StacksBlockId,
+ epoch: &StacksEpochId,
+ ) -> Option;
+ fn get_burnchain_tokens_spent_for_winning_block(
+ &self,
+ id_bhh: &StacksBlockId,
+ epoch: &StacksEpochId,
+ ) -> Option;
+ fn get_tokens_earned_for_block(
+ &self,
+ id_bhh: &StacksBlockId,
+ epoch: &StacksEpochId,
+ ) -> Option;
}
pub trait BurnStateDB {
+ /// Get the burn chain height at the current tip.
+ fn get_tip_burn_block_height(&self) -> Option;
+ /// Get the sortition id for the current tip.
+ fn get_tip_sortition_id(&self) -> Option;
+
fn get_v1_unlock_height(&self) -> u32;
fn get_v2_unlock_height(&self) -> u32;
fn get_v3_unlock_height(&self) -> u32;
@@ -149,118 +183,6 @@ pub trait BurnStateDB {
) -> Option<(Vec, u128)>;
}
-impl HeadersDB for &dyn HeadersDB {
- fn get_stacks_block_header_hash_for_block(
- &self,
- id_bhh: &StacksBlockId,
- ) -> Option {
- (*self).get_stacks_block_header_hash_for_block(id_bhh)
- }
- fn get_burn_header_hash_for_block(&self, bhh: &StacksBlockId) -> Option {
- (*self).get_burn_header_hash_for_block(bhh)
- }
- fn get_consensus_hash_for_block(&self, id_bhh: &StacksBlockId) -> Option {
- (*self).get_consensus_hash_for_block(id_bhh)
- }
- fn get_vrf_seed_for_block(&self, bhh: &StacksBlockId) -> Option {
- (*self).get_vrf_seed_for_block(bhh)
- }
- fn get_burn_block_time_for_block(&self, bhh: &StacksBlockId) -> Option {
- (*self).get_burn_block_time_for_block(bhh)
- }
- fn get_burn_block_height_for_block(&self, bhh: &StacksBlockId) -> Option {
- (*self).get_burn_block_height_for_block(bhh)
- }
- fn get_miner_address(&self, bhh: &StacksBlockId) -> Option {
- (*self).get_miner_address(bhh)
- }
- fn get_burnchain_tokens_spent_for_block(&self, id_bhh: &StacksBlockId) -> Option {
- (*self).get_burnchain_tokens_spent_for_block(id_bhh)
- }
- fn get_burnchain_tokens_spent_for_winning_block(&self, id_bhh: &StacksBlockId) -> Option {
- (*self).get_burnchain_tokens_spent_for_winning_block(id_bhh)
- }
- fn get_tokens_earned_for_block(&self, id_bhh: &StacksBlockId) -> Option {
- (*self).get_tokens_earned_for_block(id_bhh)
- }
-}
-
-impl BurnStateDB for &dyn BurnStateDB {
- fn get_v1_unlock_height(&self) -> u32 {
- (*self).get_v1_unlock_height()
- }
-
- fn get_v2_unlock_height(&self) -> u32 {
- (*self).get_v2_unlock_height()
- }
-
- fn get_v3_unlock_height(&self) -> u32 {
- (*self).get_v3_unlock_height()
- }
-
- fn get_pox_3_activation_height(&self) -> u32 {
- (*self).get_pox_3_activation_height()
- }
-
- fn get_pox_4_activation_height(&self) -> u32 {
- (*self).get_pox_4_activation_height()
- }
-
- fn get_burn_block_height(&self, sortition_id: &SortitionId) -> Option {
- (*self).get_burn_block_height(sortition_id)
- }
-
- fn get_sortition_id_from_consensus_hash(
- &self,
- consensus_hash: &ConsensusHash,
- ) -> Option {
- (*self).get_sortition_id_from_consensus_hash(consensus_hash)
- }
-
- fn get_burn_start_height(&self) -> u32 {
- (*self).get_burn_start_height()
- }
-
- fn get_burn_header_hash(
- &self,
- height: u32,
- sortition_id: &SortitionId,
- ) -> Option {
- (*self).get_burn_header_hash(height, sortition_id)
- }
-
- fn get_stacks_epoch(&self, height: u32) -> Option {
- (*self).get_stacks_epoch(height)
- }
-
- fn get_pox_prepare_length(&self) -> u32 {
- (*self).get_pox_prepare_length()
- }
-
- fn get_pox_reward_cycle_length(&self) -> u32 {
- (*self).get_pox_reward_cycle_length()
- }
-
- fn get_pox_rejection_fraction(&self) -> u64 {
- (*self).get_pox_rejection_fraction()
- }
- fn get_stacks_epoch_by_epoch_id(&self, epoch_id: &StacksEpochId) -> Option {
- (*self).get_stacks_epoch_by_epoch_id(epoch_id)
- }
-
- fn get_ast_rules(&self, height: u32) -> ASTRules {
- (*self).get_ast_rules(height)
- }
-
- fn get_pox_payout_addrs(
- &self,
- height: u32,
- sortition_id: &SortitionId,
- ) -> Option<(Vec, u128)> {
- (*self).get_pox_payout_addrs(height, sortition_id)
- }
-}
-
pub struct NullHeadersDB {}
pub struct NullBurnStateDB {
epoch: StacksEpochId,
@@ -286,12 +208,17 @@ impl HeadersDB for NullHeadersDB {
None
}
}
- fn get_vrf_seed_for_block(&self, _bhh: &StacksBlockId) -> Option {
+ fn get_vrf_seed_for_block(
+ &self,
+ _bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
+ ) -> Option {
None
}
fn get_stacks_block_header_hash_for_block(
&self,
id_bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
) -> Option {
if *id_bhh == StacksBlockId::new(&FIRST_BURNCHAIN_CONSENSUS_HASH, &FIRST_STACKS_BLOCK_HASH)
{
@@ -300,10 +227,18 @@ impl HeadersDB for NullHeadersDB {
None
}
}
- fn get_consensus_hash_for_block(&self, _id_bhh: &StacksBlockId) -> Option {
+ fn get_consensus_hash_for_block(
+ &self,
+ _id_bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
+ ) -> Option {
None
}
- fn get_burn_block_time_for_block(&self, id_bhh: &StacksBlockId) -> Option {
+ fn get_burn_block_time_for_block(
+ &self,
+ id_bhh: &StacksBlockId,
+ _epoch: Option<&StacksEpochId>,
+ ) -> Option {
if *id_bhh == StacksBlockId::new(&FIRST_BURNCHAIN_CONSENSUS_HASH, &FIRST_STACKS_BLOCK_HASH)
{
Some(BITCOIN_REGTEST_FIRST_BLOCK_TIMESTAMP as u64)
@@ -311,6 +246,9 @@ impl HeadersDB for NullHeadersDB {
None
}
}
+ fn get_stacks_block_time_for_block(&self, _id_bhh: &StacksBlockId) -> Option {
+ None
+ }
fn get_burn_block_height_for_block(&self, id_bhh: &StacksBlockId) -> Option {
if *id_bhh == StacksBlockId::new(&FIRST_BURNCHAIN_CONSENSUS_HASH, &FIRST_STACKS_BLOCK_HASH)
{
@@ -319,25 +257,46 @@ impl HeadersDB for NullHeadersDB {
Some(1)
}
}
- fn get_miner_address(&self, _id_bhh: &StacksBlockId) -> Option {
+ fn get_miner_address(
+ &self,
+ _id_bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
+ ) -> Option {
None
}
- fn get_burnchain_tokens_spent_for_block(&self, _id_bhh: &StacksBlockId) -> Option {
+ fn get_burnchain_tokens_spent_for_block(
+ &self,
+ _id_bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
+ ) -> Option {
None
}
fn get_burnchain_tokens_spent_for_winning_block(
&self,
_id_bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
) -> Option {
None
}
- fn get_tokens_earned_for_block(&self, _id_bhh: &StacksBlockId) -> Option {
+ fn get_tokens_earned_for_block(
+ &self,
+ _id_bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
+ ) -> Option {
None
}
}
#[allow(clippy::panic)]
impl BurnStateDB for NullBurnStateDB {
+ fn get_tip_burn_block_height(&self) -> Option {
+ Some(0)
+ }
+
+ fn get_tip_sortition_id(&self) -> Option {
+ None
+ }
+
fn get_burn_block_height(&self, _sortition_id: &SortitionId) -> Option {
None
}
@@ -367,7 +326,7 @@ impl BurnStateDB for NullBurnStateDB {
start_height: 0,
end_height: u64::MAX,
block_limit: ExecutionCost::max_value(),
- network_epoch: PEER_VERSION_EPOCH_2_0,
+ network_epoch: 0,
})
}
fn get_stacks_epoch_by_epoch_id(&self, _epoch_id: &StacksEpochId) -> Option {
@@ -855,6 +814,38 @@ impl<'a> ClarityDatabase<'a> {
Ok(())
}
+ /// Returns the tenure height of the current block.
+ pub fn get_tenure_height(&mut self) -> Result {
+ if self.get_clarity_epoch_version()? < StacksEpochId::Epoch30 {
+ // Before epoch 3.0, the tenure height was not stored in the
+ // Clarity state. Instead, it was the same as the block height.
+ return Ok(self.get_current_block_height());
+ }
+
+ self.get_data(TENURE_HEIGHT_KEY)?
+ .ok_or_else(|| {
+ InterpreterError::Expect("No tenure height in stored Clarity state".into()).into()
+ })
+ .and_then(|x| {
+ u32::try_into(x).map_err(|_| {
+ InterpreterError::Expect("Bad tenure height in stored Clarity state".into())
+ .into()
+ })
+ })
+ }
+
+ /// Set the tenure height of the current block. In the first block of a new
+ /// tenure, this height must be incremented before evaluating any
+ /// transactions in the block.
+ pub fn set_tenure_height(&mut self, height: u32) -> Result<()> {
+ if self.get_clarity_epoch_version()? < StacksEpochId::Epoch30 {
+ return Err(Error::Interpreter(InterpreterError::Expect(
+ "Setting tenure height in Clarity state is not supported before epoch 3.0".into(),
+ )));
+ }
+ self.put_data(TENURE_HEIGHT_KEY, &height)
+ }
+
pub fn destroy(self) -> RollbackWrapper<'a> {
self.store
}
@@ -931,39 +922,69 @@ impl<'a> ClarityDatabase<'a> {
/// `get_current_block_height`).
pub fn get_current_burnchain_block_height(&mut self) -> Result {
let cur_stacks_height = self.store.get_current_block_height();
- let last_mined_bhh = if cur_stacks_height == 0 {
- return Ok(self.burn_state_db.get_burn_start_height());
- } else {
- self.get_index_block_header_hash(cur_stacks_height.checked_sub(1).ok_or_else(
- || {
- InterpreterError::Expect(
- "BUG: cannot eval burn-block-height in boot code".into(),
- )
- },
- )?)?
- };
- self.get_burnchain_block_height(&last_mined_bhh)
- .ok_or_else(|| {
- InterpreterError::Expect(format!(
- "Block header hash '{}' must return for provided stacks block height {}",
- &last_mined_bhh, cur_stacks_height
- ))
- .into()
- })
+ // Before epoch 3.0, we can only access the burn block associated with the last block
+ if !self
+ .get_clarity_epoch_version()?
+ .clarity_uses_tip_burn_block()
+ {
+ if cur_stacks_height == 0 {
+ return Ok(self.burn_state_db.get_burn_start_height());
+ };
+ // Safety note: normal subtraction is safe here, because we've already checked
+ // that cur_stacks_height > 0.
+ let last_mined_bhh = self.get_index_block_header_hash(cur_stacks_height - 1)?;
+
+ self.get_burnchain_block_height(&last_mined_bhh)
+ .ok_or_else(|| {
+ InterpreterError::Expect(format!(
+ "Block header hash '{}' must return for provided stacks block height {}",
+ &last_mined_bhh, cur_stacks_height
+ ))
+ .into()
+ })
+ } else {
+ // In epoch 3+, we can access the current burnchain block
+ self.burn_state_db
+ .get_tip_burn_block_height()
+ .ok_or_else(|| {
+ InterpreterError::Expect("Failed to get burnchain tip height.".into()).into()
+ })
+ }
}
pub fn get_block_header_hash(&mut self, block_height: u32) -> Result {
let id_bhh = self.get_index_block_header_hash(block_height)?;
+ let epoch = self.get_stacks_epoch_for_block(&id_bhh)?;
self.headers_db
- .get_stacks_block_header_hash_for_block(&id_bhh)
+ .get_stacks_block_header_hash_for_block(&id_bhh, &epoch)
+ .ok_or_else(|| InterpreterError::Expect("Failed to get block data.".into()).into())
+ }
+
+ pub fn get_burn_block_time(
+ &mut self,
+ block_height: u32,
+ id_bhh_opt: Option,
+ ) -> Result {
+ let id_bhh = match id_bhh_opt {
+ Some(x) => x,
+ None => self.get_index_block_header_hash(block_height)?,
+ };
+ let epoch = self.get_stacks_epoch_for_block(&id_bhh)?;
+ self.headers_db
+ .get_burn_block_time_for_block(&id_bhh, Some(&epoch))
.ok_or_else(|| InterpreterError::Expect("Failed to get block data.".into()).into())
}
pub fn get_block_time(&mut self, block_height: u32) -> Result {
let id_bhh = self.get_index_block_header_hash(block_height)?;
+ let epoch = self.get_stacks_epoch_for_block(&id_bhh)?;
+ if !epoch.uses_nakamoto_blocks() {
+ return self.get_burn_block_time(block_height, Some(id_bhh));
+ }
+
self.headers_db
- .get_burn_block_time_for_block(&id_bhh)
+ .get_stacks_block_time_for_block(&id_bhh)
.ok_or_else(|| InterpreterError::Expect("Failed to get block data.".into()).into())
}
@@ -977,46 +998,57 @@ impl<'a> ClarityDatabase<'a> {
.ok_or_else(|| InterpreterError::Expect("Failed to get block data.".into()).into())
}
+ /// In Epoch 2.x:
/// 1. Get the current Stacks tip height (which is in the process of being evaluated)
/// 2. Get the parent block's StacksBlockId, which is SHA512-256(consensus_hash, block_hash).
/// This is the highest Stacks block in this fork whose consensus hash is known.
/// 3. Resolve the parent StacksBlockId to its consensus hash
/// 4. Resolve the consensus hash to the associated SortitionId
+ /// In Epoch 3+:
+ /// 1. Get the SortitionId of the current Stacks tip
fn get_sortition_id_for_stacks_tip(&mut self) -> Result> {
- let current_stacks_height = self.get_current_block_height();
+ if !self
+ .get_clarity_epoch_version()?
+ .clarity_uses_tip_burn_block()
+ {
+ let current_stacks_height = self.get_current_block_height();
- if current_stacks_height < 1 {
- // we are in the Stacks genesis block
- return Ok(None);
- }
+ if current_stacks_height < 1 {
+ // we are in the Stacks genesis block
+ return Ok(None);
+ }
- // this is the StacksBlockId of the last block evaluated in this fork
- let parent_id_bhh = self.get_index_block_header_hash(current_stacks_height - 1)?;
+ // this is the StacksBlockId of the last block evaluated in this fork
+ let parent_id_bhh = self.get_index_block_header_hash(current_stacks_height - 1)?;
+ let epoch = self.get_stacks_epoch_for_block(&parent_id_bhh)?;
- // infallible, since we always store the consensus hash with the StacksBlockId in the
- // headers DB
- let consensus_hash = self
- .headers_db
- .get_consensus_hash_for_block(&parent_id_bhh)
- .ok_or_else(|| {
- InterpreterError::Expect(format!(
- "FATAL: no consensus hash found for StacksBlockId {}",
- &parent_id_bhh
- ))
- })?;
+ // infallible, since we always store the consensus hash with the StacksBlockId in the
+ // headers DB
+ let consensus_hash = self
+ .headers_db
+ .get_consensus_hash_for_block(&parent_id_bhh, &epoch)
+ .ok_or_else(|| {
+ InterpreterError::Expect(format!(
+ "FATAL: no consensus hash found for StacksBlockId {}",
+ &parent_id_bhh
+ ))
+ })?;
- // infallible, since every sortition has a consensus hash
- let sortition_id = self
- .burn_state_db
- .get_sortition_id_from_consensus_hash(&consensus_hash)
- .ok_or_else(|| {
- InterpreterError::Expect(format!(
- "FATAL: no SortitionID found for consensus hash {}",
- &consensus_hash
- ))
- })?;
+ // infallible, since every sortition has a consensus hash
+ let sortition_id = self
+ .burn_state_db
+ .get_sortition_id_from_consensus_hash(&consensus_hash)
+ .ok_or_else(|| {
+ InterpreterError::Expect(format!(
+ "FATAL: no SortitionID found for consensus hash {}",
+ &consensus_hash
+ ))
+ })?;
- Ok(Some(sortition_id))
+ Ok(Some(sortition_id))
+ } else {
+ Ok(self.burn_state_db.get_tip_sortition_id())
+ }
}
/// Fetch the burnchain block header hash for a given burnchain height.
@@ -1054,22 +1086,24 @@ impl<'a> ClarityDatabase<'a> {
.get_pox_payout_addrs(burnchain_block_height, &sortition_id))
}
- pub fn get_burnchain_block_height(&mut self, id_bhh: &StacksBlockId) -> Option {
+ pub fn get_burnchain_block_height(&self, id_bhh: &StacksBlockId) -> Option {
self.headers_db.get_burn_block_height_for_block(id_bhh)
}
pub fn get_block_vrf_seed(&mut self, block_height: u32) -> Result {
let id_bhh = self.get_index_block_header_hash(block_height)?;
+ let epoch = self.get_stacks_epoch_for_block(&id_bhh)?;
self.headers_db
- .get_vrf_seed_for_block(&id_bhh)
+ .get_vrf_seed_for_block(&id_bhh, &epoch)
.ok_or_else(|| InterpreterError::Expect("Failed to get block data.".into()).into())
}
pub fn get_miner_address(&mut self, block_height: u32) -> Result {
let id_bhh = self.get_index_block_header_hash(block_height)?;
+ let epoch = self.get_stacks_epoch_for_block(&id_bhh)?;
Ok(self
.headers_db
- .get_miner_address(&id_bhh)
+ .get_miner_address(&id_bhh, &epoch)
.ok_or_else(|| InterpreterError::Expect("Failed to get block data.".into()))?
.into())
}
@@ -1080,9 +1114,10 @@ impl<'a> ClarityDatabase<'a> {
}
let id_bhh = self.get_index_block_header_hash(block_height)?;
+ let epoch = self.get_stacks_epoch_for_block(&id_bhh)?;
Ok(self
.headers_db
- .get_burnchain_tokens_spent_for_winning_block(&id_bhh)
+ .get_burnchain_tokens_spent_for_winning_block(&id_bhh, &epoch)
.ok_or_else(|| {
InterpreterError::Expect(
"FATAL: no winning burnchain token spend record for block".into(),
@@ -1097,9 +1132,10 @@ impl<'a> ClarityDatabase<'a> {
}
let id_bhh = self.get_index_block_header_hash(block_height)?;
+ let epoch = self.get_stacks_epoch_for_block(&id_bhh)?;
Ok(self
.headers_db
- .get_burnchain_tokens_spent_for_block(&id_bhh)
+ .get_burnchain_tokens_spent_for_block(&id_bhh, &epoch)
.ok_or_else(|| {
InterpreterError::Expect(
"FATAL: no total burnchain token spend record for block".into(),
@@ -1122,9 +1158,10 @@ impl<'a> ClarityDatabase<'a> {
}
let id_bhh = self.get_index_block_header_hash(block_height)?;
+ let epoch = self.get_stacks_epoch_for_block(&id_bhh)?;
let reward: u128 = self
.headers_db
- .get_tokens_earned_for_block(&id_bhh)
+ .get_tokens_earned_for_block(&id_bhh, &epoch)
.map(|x| x.into())
.ok_or_else(|| {
InterpreterError::Expect("FATAL: matured block has no recorded reward".into())
@@ -2135,4 +2172,17 @@ impl<'a> ClarityDatabase<'a> {
pub fn get_stacks_epoch(&self, height: u32) -> Option {
self.burn_state_db.get_stacks_epoch(height)
}
+
+ pub fn get_stacks_epoch_for_block(&self, id_bhh: &StacksBlockId) -> Result {
+ let burn_block = self.get_burnchain_block_height(&id_bhh).ok_or_else(|| {
+ InterpreterError::Expect(format!(
+ "FATAL: no burnchain block height found for Stacks block {}",
+ id_bhh
+ ))
+ })?;
+ let epoch = self
+ .get_stacks_epoch(burn_block)
+ .ok_or_else(|| InterpreterError::Expect("Failed to get block data.".into()))?;
+ Ok(epoch.epoch_id)
+ }
}
diff --git a/clarity/src/vm/database/clarity_store.rs b/clarity/src/vm/database/clarity_store.rs
index afe2c550ba6..b6a45ee7643 100644
--- a/clarity/src/vm/database/clarity_store.rs
+++ b/clarity/src/vm/database/clarity_store.rs
@@ -16,15 +16,18 @@
use std::path::PathBuf;
+#[cfg(feature = "canonical")]
use rusqlite::Connection;
use stacks_common::types::chainstate::{BlockHeaderHash, StacksBlockId, VRFSeed};
use stacks_common::util::hash::{hex_bytes, to_hex, Hash160, Sha512Trunc256Sum};
use crate::vm::analysis::AnalysisDatabase;
use crate::vm::contexts::GlobalContext;
+#[cfg(feature = "canonical")]
+use crate::vm::database::SqliteConnection;
use crate::vm::database::{
BurnStateDB, ClarityDatabase, ClarityDeserializable, ClaritySerializable, HeadersDB,
- SqliteConnection, NULL_BURN_STATE_DB, NULL_HEADER_DB,
+ NULL_BURN_STATE_DB, NULL_HEADER_DB,
};
use crate::vm::errors::{
CheckErrors, IncomparableError, InterpreterError, InterpreterResult as Result,
@@ -83,6 +86,8 @@ pub trait ClarityBackingStore {
fn get_open_chain_tip_height(&mut self) -> u32;
fn get_open_chain_tip(&mut self) -> StacksBlockId;
+
+ #[cfg(feature = "canonical")]
fn get_side_store(&mut self) -> &Connection;
fn get_cc_special_cases_handler(&self) -> Option {
@@ -106,59 +111,27 @@ pub trait ClarityBackingStore {
fn get_contract_hash(
&mut self,
contract: &QualifiedContractIdentifier,
- ) -> Result<(StacksBlockId, Sha512Trunc256Sum)> {
- let key = make_contract_hash_key(contract);
- let contract_commitment = self
- .get_data(&key)?
- .map(|x| ContractCommitment::deserialize(&x))
- .ok_or_else(|| CheckErrors::NoSuchContract(contract.to_string()))?;
- let ContractCommitment {
- block_height,
- hash: contract_hash,
- } = contract_commitment?;
- let bhh = self.get_block_at_height(block_height)
- .ok_or_else(|| InterpreterError::Expect("Should always be able to map from height to block hash when looking up contract information.".into()))?;
- Ok((bhh, contract_hash))
- }
+ ) -> Result<(StacksBlockId, Sha512Trunc256Sum)>;
fn insert_metadata(
&mut self,
contract: &QualifiedContractIdentifier,
key: &str,
value: &str,
- ) -> Result<()> {
- let bhh = self.get_open_chain_tip();
- SqliteConnection::insert_metadata(
- self.get_side_store(),
- &bhh,
- &contract.to_string(),
- key,
- value,
- )
- }
+ ) -> Result<()>;
fn get_metadata(
&mut self,
contract: &QualifiedContractIdentifier,
key: &str,
- ) -> Result> {
- let (bhh, _) = self.get_contract_hash(contract)?;
- SqliteConnection::get_metadata(self.get_side_store(), &bhh, &contract.to_string(), key)
- }
+ ) -> Result>;
fn get_metadata_manual(
&mut self,
at_height: u32,
contract: &QualifiedContractIdentifier,
key: &str,
- ) -> Result> {
- let bhh = self.get_block_at_height(at_height)
- .ok_or_else(|| {
- warn!("Unknown block height when manually querying metadata"; "block_height" => at_height);
- RuntimeErrorType::BadBlockHeight(at_height.to_string())
- })?;
- SqliteConnection::get_metadata(self.get_side_store(), &bhh, &contract.to_string(), key)
- }
+ ) -> Result>;
fn put_all_metadata(
&mut self,
@@ -240,6 +213,7 @@ impl ClarityBackingStore for NullBackingStore {
panic!("NullBackingStore can't retrieve data")
}
+ #[cfg(feature = "canonical")]
fn get_side_store(&mut self) -> &Connection {
panic!("NullBackingStore has no side store")
}
@@ -263,84 +237,37 @@ impl ClarityBackingStore for NullBackingStore {
fn put_all_data(&mut self, mut _items: Vec<(String, String)>) -> Result<()> {
panic!("NullBackingStore cannot put")
}
-}
-
-pub struct MemoryBackingStore {
- side_store: Connection,
-}
-impl Default for MemoryBackingStore {
- fn default() -> Self {
- MemoryBackingStore::new()
- }
-}
-
-impl MemoryBackingStore {
- #[allow(clippy::unwrap_used)]
- pub fn new() -> MemoryBackingStore {
- let side_store = SqliteConnection::memory().unwrap();
-
- let mut memory_marf = MemoryBackingStore { side_store };
-
- memory_marf.as_clarity_db().initialize();
-
- memory_marf
- }
-
- pub fn as_clarity_db(&mut self) -> ClarityDatabase {
- ClarityDatabase::new(self, &NULL_HEADER_DB, &NULL_BURN_STATE_DB)
- }
-
- pub fn as_analysis_db(&mut self) -> AnalysisDatabase {
- AnalysisDatabase::new(self)
- }
-}
-
-impl ClarityBackingStore for MemoryBackingStore {
- fn set_block_hash(&mut self, bhh: StacksBlockId) -> InterpreterResult {
- Err(RuntimeErrorType::UnknownBlockHeaderHash(BlockHeaderHash(bhh.0)).into())
- }
-
- fn get_data(&mut self, key: &str) -> Result> {
- SqliteConnection::get(self.get_side_store(), key)
- }
-
- fn get_data_with_proof(&mut self, key: &str) -> Result)>> {
- Ok(SqliteConnection::get(self.get_side_store(), key)?.map(|x| (x, vec![])))
- }
-
- fn get_side_store(&mut self) -> &Connection {
- &self.side_store
- }
-
- fn get_block_at_height(&mut self, height: u32) -> Option {
- if height == 0 {
- Some(StacksBlockId([255; 32]))
- } else {
- None
- }
- }
-
- fn get_open_chain_tip(&mut self) -> StacksBlockId {
- StacksBlockId([255; 32])
- }
-
- fn get_open_chain_tip_height(&mut self) -> u32 {
- 0
+ fn get_contract_hash(
+ &mut self,
+ _contract: &QualifiedContractIdentifier,
+ ) -> Result<(StacksBlockId, Sha512Trunc256Sum)> {
+ panic!("NullBackingStore cannot get_contract_hash")
}
- fn get_current_block_height(&mut self) -> u32 {
- 1
+ fn insert_metadata(
+ &mut self,
+ _contract: &QualifiedContractIdentifier,
+ _key: &str,
+ _value: &str,
+ ) -> Result<()> {
+ panic!("NullBackingStore cannot insert_metadata")
}
- fn get_cc_special_cases_handler(&self) -> Option {
- None
+ fn get_metadata(
+ &mut self,
+ _contract: &QualifiedContractIdentifier,
+ _key: &str,
+ ) -> Result> {
+ panic!("NullBackingStore cannot get_metadata")
}
- fn put_all_data(&mut self, items: Vec<(String, String)>) -> Result<()> {
- for (key, value) in items.into_iter() {
- SqliteConnection::put(self.get_side_store(), &key, &value)?;
- }
- Ok(())
+ fn get_metadata_manual(
+ &mut self,
+ _at_height: u32,
+ _contract: &QualifiedContractIdentifier,
+ _key: &str,
+ ) -> Result> {
+ panic!("NullBackingStore cannot get_metadata_manual")
}
}
diff --git a/clarity/src/vm/database/key_value_wrapper.rs b/clarity/src/vm/database/key_value_wrapper.rs
index 69eb74b39ed..3fd845f92ff 100644
--- a/clarity/src/vm/database/key_value_wrapper.rs
+++ b/clarity/src/vm/database/key_value_wrapper.rs
@@ -31,15 +31,15 @@ use crate::vm::types::{
};
use crate::vm::{StacksEpoch, Value};
-#[cfg(rollback_value_check)]
+#[cfg(feature = "rollback_value_check")]
type RollbackValueCheck = String;
-#[cfg(not(rollback_value_check))]
+#[cfg(not(feature = "rollback_value_check"))]
type RollbackValueCheck = ();
-#[cfg(not(rollback_value_check))]
+#[cfg(not(feature = "rollback_value_check"))]
fn rollback_value_check(_value: &str, _check: &RollbackValueCheck) {}
-#[cfg(not(rollback_value_check))]
+#[cfg(not(feature = "rollback_value_check"))]
fn rollback_edits_push(edits: &mut Vec<(T, RollbackValueCheck)>, key: T, _value: &str) {
edits.push((key, ()));
}
@@ -47,7 +47,7 @@ fn rollback_edits_push(edits: &mut Vec<(T, RollbackValueCheck)>, key: T, _val
// wrapper -- i.e., when committing to the underlying store. for the _unchecked_ implementation
// this is used to get the edit _value_ out of the lookupmap, for used in the subsequent `put_all`
// command.
-#[cfg(not(rollback_value_check))]
+#[cfg(not(feature = "rollback_value_check"))]
fn rollback_check_pre_bottom_commit(
edits: Vec<(T, RollbackValueCheck)>,
lookup_map: &mut HashMap>,
@@ -71,11 +71,11 @@ where
output
}
-#[cfg(rollback_value_check)]
+#[cfg(feature = "rollback_value_check")]
fn rollback_value_check(value: &String, check: &RollbackValueCheck) {
assert_eq!(value, check)
}
-#[cfg(rollback_value_check)]
+#[cfg(feature = "rollback_value_check")]
fn rollback_edits_push(edits: &mut Vec<(T, RollbackValueCheck)>, key: T, value: &String)
where
T: Eq + Hash + Clone,
@@ -84,7 +84,7 @@ where
}
// this function is used to check the lookup map when committing at the "bottom" of the
// wrapper -- i.e., when committing to the underlying store.
-#[cfg(rollback_value_check)]
+#[cfg(feature = "rollback_value_check")]
fn rollback_check_pre_bottom_commit(
edits: Vec<(T, RollbackValueCheck)>,
lookup_map: &mut HashMap>,
diff --git a/clarity/src/vm/database/mod.rs b/clarity/src/vm/database/mod.rs
index 1092992982a..d16d944d557 100644
--- a/clarity/src/vm/database/mod.rs
+++ b/clarity/src/vm/database/mod.rs
@@ -15,13 +15,16 @@
// along with this program. If not, see .
use hashbrown::HashMap;
+#[cfg(feature = "canonical")]
+pub use sqlite::MemoryBackingStore;
pub use self::clarity_db::{
BurnStateDB, ClarityDatabase, HeadersDB, StoreType, NULL_BURN_STATE_DB, NULL_HEADER_DB,
STORE_CONTRACT_SRC_INTERFACE,
};
-pub use self::clarity_store::{ClarityBackingStore, MemoryBackingStore, SpecialCaseHandler};
+pub use self::clarity_store::{ClarityBackingStore, SpecialCaseHandler};
pub use self::key_value_wrapper::{RollbackWrapper, RollbackWrapperPersistedLog};
+#[cfg(feature = "canonical")]
pub use self::sqlite::SqliteConnection;
pub use self::structures::{
ClarityDeserializable, ClaritySerializable, DataMapMetadata, DataVariableMetadata,
@@ -31,5 +34,6 @@ pub use self::structures::{
pub mod clarity_db;
pub mod clarity_store;
mod key_value_wrapper;
-mod sqlite;
+#[cfg(feature = "canonical")]
+pub mod sqlite;
mod structures;
diff --git a/clarity/src/vm/database/sqlite.rs b/clarity/src/vm/database/sqlite.rs
index 6b2d64afa5f..dc3ad4f5bde 100644
--- a/clarity/src/vm/database/sqlite.rs
+++ b/clarity/src/vm/database/sqlite.rs
@@ -14,18 +14,28 @@
// You should have received a copy of the GNU General Public License
// along with this program. If not, see .
-use rusqlite::types::{FromSql, ToSql};
+use rusqlite::types::{FromSql, FromSqlResult, ToSql, ToSqlOutput, ValueRef};
use rusqlite::{
- Connection, Error as SqliteError, ErrorCode as SqliteErrorCode, OptionalExtension, Row,
- Savepoint, NO_PARAMS,
+ params, Connection, Error as SqliteError, ErrorCode as SqliteErrorCode, OptionalExtension, Row,
+ Savepoint,
};
-use stacks_common::types::chainstate::StacksBlockId;
+use stacks_common::types::chainstate::{BlockHeaderHash, StacksBlockId};
+use stacks_common::types::sqlite::NO_PARAMS;
use stacks_common::util::db_common::tx_busy_handler;
+use stacks_common::util::hash::Sha512Trunc256Sum;
+use super::clarity_store::{make_contract_hash_key, ContractCommitment};
+use super::{
+ ClarityBackingStore, ClarityDatabase, ClarityDeserializable, SpecialCaseHandler,
+ NULL_BURN_STATE_DB, NULL_HEADER_DB,
+};
+use crate::vm::analysis::{AnalysisDatabase, CheckErrors};
use crate::vm::contracts::Contract;
+use crate::vm::costs::ExecutionCost;
use crate::vm::errors::{
Error, IncomparableError, InterpreterError, InterpreterResult as Result, RuntimeErrorType,
};
+use crate::vm::types::QualifiedContractIdentifier;
const SQL_FAIL_MESSAGE: &str = "PANIC: SQL Failure in Smart Contract VM.";
@@ -34,11 +44,8 @@ pub struct SqliteConnection {
}
fn sqlite_put(conn: &Connection, key: &str, value: &str) -> Result<()> {
- let params: [&dyn ToSql; 2] = [&key, &value];
- match conn.execute(
- "REPLACE INTO data_table (key, value) VALUES (?, ?)",
- ¶ms,
- ) {
+ let params = params![key, value];
+ match conn.execute("REPLACE INTO data_table (key, value) VALUES (?, ?)", params) {
Ok(_) => Ok(()),
Err(e) => {
error!("Failed to insert/replace ({},{}): {:?}", key, value, &e);
@@ -49,11 +56,11 @@ fn sqlite_put(conn: &Connection, key: &str, value: &str) -> Result<()> {
fn sqlite_get(conn: &Connection, key: &str) -> Result> {
trace!("sqlite_get {}", key);
- let params: [&dyn ToSql; 1] = [&key];
+ let params = params![key];
let res = match conn
.query_row(
"SELECT value FROM data_table WHERE key = ?",
- ¶ms,
+ params,
|row| row.get(0),
)
.optional()
@@ -73,6 +80,62 @@ fn sqlite_has_entry(conn: &Connection, key: &str) -> Result {
Ok(sqlite_get(conn, key)?.is_some())
}
+pub fn sqlite_get_contract_hash(
+ store: &mut dyn ClarityBackingStore,
+ contract: &QualifiedContractIdentifier,
+) -> Result<(StacksBlockId, Sha512Trunc256Sum)> {
+ let key = make_contract_hash_key(contract);
+ let contract_commitment = store
+ .get_data(&key)?
+ .map(|x| ContractCommitment::deserialize(&x))
+ .ok_or_else(|| CheckErrors::NoSuchContract(contract.to_string()))?;
+ let ContractCommitment {
+ block_height,
+ hash: contract_hash,
+ } = contract_commitment?;
+ let bhh = store.get_block_at_height(block_height)
+ .ok_or_else(|| InterpreterError::Expect("Should always be able to map from height to block hash when looking up contract information.".into()))?;
+ Ok((bhh, contract_hash))
+}
+
+pub fn sqlite_insert_metadata(
+ store: &mut dyn ClarityBackingStore,
+ contract: &QualifiedContractIdentifier,
+ key: &str,
+ value: &str,
+) -> Result<()> {
+ let bhh = store.get_open_chain_tip();
+ SqliteConnection::insert_metadata(
+ store.get_side_store(),
+ &bhh,
+ &contract.to_string(),
+ key,
+ value,
+ )
+}
+
+pub fn sqlite_get_metadata(
+ store: &mut dyn ClarityBackingStore,
+ contract: &QualifiedContractIdentifier,
+ key: &str,
+) -> Result> {
+ let (bhh, _) = store.get_contract_hash(contract)?;
+ SqliteConnection::get_metadata(store.get_side_store(), &bhh, &contract.to_string(), key)
+}
+
+pub fn sqlite_get_metadata_manual(
+ store: &mut dyn ClarityBackingStore,
+ at_height: u32,
+ contract: &QualifiedContractIdentifier,
+ key: &str,
+) -> Result> {
+ let bhh = store.get_block_at_height(at_height).ok_or_else(|| {
+ warn!("Unknown block height when manually querying metadata"; "block_height" => at_height);
+ RuntimeErrorType::BadBlockHeight(at_height.to_string())
+ })?;
+ SqliteConnection::get_metadata(store.get_side_store(), &bhh, &contract.to_string(), key)
+}
+
impl SqliteConnection {
pub fn put(conn: &Connection, key: &str, value: &str) -> Result<()> {
sqlite_put(conn, key, value)
@@ -90,11 +153,11 @@ impl SqliteConnection {
value: &str,
) -> Result<()> {
let key = format!("clr-meta::{}::{}", contract_hash, key);
- let params: [&dyn ToSql; 3] = [&bhh, &key, &value];
+ let params = params![bhh, key, value];
if let Err(e) = conn.execute(
"INSERT INTO metadata_table (blockhash, key, value) VALUES (?, ?, ?)",
- ¶ms,
+ params,
) {
error!(
"Failed to insert ({},{},{}): {:?}",
@@ -113,10 +176,10 @@ impl SqliteConnection {
from: &StacksBlockId,
to: &StacksBlockId,
) -> Result<()> {
- let params = [to, from];
+ let params = params![to, from];
if let Err(e) = conn.execute(
"UPDATE metadata_table SET blockhash = ? WHERE blockhash = ?",
- ¶ms,
+ params,
) {
error!("Failed to update {} to {}: {:?}", &from, &to, &e);
return Err(InterpreterError::DBError(SQL_FAIL_MESSAGE.into()).into());
@@ -125,7 +188,10 @@ impl SqliteConnection {
}
pub fn drop_metadata(conn: &Connection, from: &StacksBlockId) -> Result<()> {
- if let Err(e) = conn.execute("DELETE FROM metadata_table WHERE blockhash = ?", &[from]) {
+ if let Err(e) = conn.execute(
+ "DELETE FROM metadata_table WHERE blockhash = ?",
+ params![from],
+ ) {
error!("Failed to drop metadata from {}: {:?}", &from, &e);
return Err(InterpreterError::DBError(SQL_FAIL_MESSAGE.into()).into());
}
@@ -139,12 +205,12 @@ impl SqliteConnection {
key: &str,
) -> Result> {
let key = format!("clr-meta::{}::{}", contract_hash, key);
- let params: [&dyn ToSql; 2] = [&bhh, &key];
+ let params = params![bhh, key];
match conn
.query_row(
"SELECT value FROM metadata_table WHERE blockhash = ? AND key = ?",
- ¶ms,
+ params,
|row| row.get(0),
)
.optional()
@@ -199,10 +265,10 @@ impl SqliteConnection {
pub fn check_schema(conn: &Connection) -> Result<()> {
let sql = "SELECT sql FROM sqlite_master WHERE name=?";
let _: String = conn
- .query_row(sql, &["data_table"], |row| row.get(0))
+ .query_row(sql, params!["data_table"], |row| row.get(0))
.map_err(|x| InterpreterError::SqliteError(IncomparableError { err: x }))?;
let _: String = conn
- .query_row(sql, &["metadata_table"], |row| row.get(0))
+ .query_row(sql, params!["metadata_table"], |row| row.get(0))
.map_err(|x| InterpreterError::SqliteError(IncomparableError { err: x }))?;
Ok(())
}
@@ -217,3 +283,133 @@ impl SqliteConnection {
Ok(conn)
}
}
+
+pub struct MemoryBackingStore {
+ side_store: Connection,
+}
+
+impl Default for MemoryBackingStore {
+ fn default() -> Self {
+ MemoryBackingStore::new()
+ }
+}
+
+impl MemoryBackingStore {
+ #[allow(clippy::unwrap_used)]
+ pub fn new() -> MemoryBackingStore {
+ let side_store = SqliteConnection::memory().unwrap();
+
+ let mut memory_marf = MemoryBackingStore { side_store };
+
+ memory_marf.as_clarity_db().initialize();
+
+ memory_marf
+ }
+
+ pub fn as_clarity_db(&mut self) -> ClarityDatabase {
+ ClarityDatabase::new(self, &NULL_HEADER_DB, &NULL_BURN_STATE_DB)
+ }
+
+ pub fn as_analysis_db(&mut self) -> AnalysisDatabase {
+ AnalysisDatabase::new(self)
+ }
+}
+
+impl ClarityBackingStore for MemoryBackingStore {
+ fn set_block_hash(&mut self, bhh: StacksBlockId) -> Result {
+ Err(RuntimeErrorType::UnknownBlockHeaderHash(BlockHeaderHash(bhh.0)).into())
+ }
+
+ fn get_data(&mut self, key: &str) -> Result> {
+ SqliteConnection::get(self.get_side_store(), key)
+ }
+
+ fn get_data_with_proof(&mut self, key: &str) -> Result)>> {
+ Ok(SqliteConnection::get(self.get_side_store(), key)?.map(|x| (x, vec![])))
+ }
+
+ fn get_side_store(&mut self) -> &Connection {
+ &self.side_store
+ }
+
+ fn get_block_at_height(&mut self, height: u32) -> Option {
+ if height == 0 {
+ Some(StacksBlockId([255; 32]))
+ } else {
+ None
+ }
+ }
+
+ fn get_open_chain_tip(&mut self) -> StacksBlockId {
+ StacksBlockId([255; 32])
+ }
+
+ fn get_open_chain_tip_height(&mut self) -> u32 {
+ 0
+ }
+
+ fn get_current_block_height(&mut self) -> u32 {
+ 1
+ }
+
+ fn get_cc_special_cases_handler(&self) -> Option {
+ None
+ }
+
+ fn put_all_data(&mut self, items: Vec<(String, String)>) -> Result<()> {
+ for (key, value) in items.into_iter() {
+ SqliteConnection::put(self.get_side_store(), &key, &value)?;
+ }
+ Ok(())
+ }
+
+ fn get_contract_hash(
+ &mut self,
+ contract: &QualifiedContractIdentifier,
+ ) -> Result<(StacksBlockId, Sha512Trunc256Sum)> {
+ sqlite_get_contract_hash(self, contract)
+ }
+
+ fn insert_metadata(
+ &mut self,
+ contract: &QualifiedContractIdentifier,
+ key: &str,
+ value: &str,
+ ) -> Result<()> {
+ sqlite_insert_metadata(self, contract, key, value)
+ }
+
+ fn get_metadata(
+ &mut self,
+ contract: &QualifiedContractIdentifier,
+ key: &str,
+ ) -> Result> {
+ sqlite_get_metadata(self, contract, key)
+ }
+
+ fn get_metadata_manual(
+ &mut self,
+ at_height: u32,
+ contract: &QualifiedContractIdentifier,
+ key: &str,
+ ) -> Result> {
+ sqlite_get_metadata_manual(self, at_height, contract, key)
+ }
+}
+
+impl ToSql for ExecutionCost {
+ fn to_sql(&self) -> rusqlite::Result {
+ let val = serde_json::to_string(self)
+ .map_err(|e| rusqlite::Error::ToSqlConversionFailure(Box::new(e)))?;
+ Ok(ToSqlOutput::from(val))
+ }
+}
+
+impl FromSql for ExecutionCost {
+ fn column_result(value: ValueRef) -> FromSqlResult {
+ let str_val = String::column_result(value)?;
+ let parsed = serde_json::from_str(&str_val)
+ .map_err(|e| rusqlite::types::FromSqlError::Other(Box::new(e)))?;
+ Ok(parsed)
+ }
+}
diff --git a/clarity/src/vm/docs/contracts.rs b/clarity/src/vm/docs/contracts.rs
index 7426be7966f..138203db713 100644
--- a/clarity/src/vm/docs/contracts.rs
+++ b/clarity/src/vm/docs/contracts.rs
@@ -4,10 +4,13 @@ use hashbrown::{HashMap, HashSet};
use stacks_common::consts::CHAIN_ID_TESTNET;
use stacks_common::types::StacksEpochId;
-use crate::vm::analysis::{mem_type_check, ContractAnalysis};
+#[cfg(feature = "canonical")]
+use crate::vm::analysis::mem_type_check;
+use crate::vm::analysis::ContractAnalysis;
use crate::vm::ast::{build_ast_with_rules, ASTRules};
use crate::vm::contexts::GlobalContext;
use crate::vm::costs::LimitedCostTracker;
+#[cfg(feature = "canonical")]
use crate::vm::database::MemoryBackingStore;
use crate::vm::docs::{get_input_type_string, get_output_type_string, get_signature};
use crate::vm::types::{FunctionType, QualifiedContractIdentifier, Value};
@@ -60,6 +63,7 @@ fn make_func_ref(func_name: &str, func_type: &FunctionType, description: &str) -
}
}
+#[cfg(feature = "canonical")]
#[allow(clippy::expect_used)]
fn get_constant_value(var_name: &str, contract_content: &str) -> Value {
let to_eval = format!("{}\n{}", contract_content, var_name);
@@ -68,6 +72,7 @@ fn get_constant_value(var_name: &str, contract_content: &str) -> Value {
.expect("BUG: failed to return constant value")
}
+#[cfg(feature = "canonical")]
fn doc_execute(program: &str) -> Result, vm::Error> {
let contract_id = QualifiedContractIdentifier::transient();
let mut contract_context = ContractContext::new(contract_id.clone(), ClarityVersion::Clarity2);
@@ -94,11 +99,15 @@ fn doc_execute(program: &str) -> Result, vm::Error> {
})
}
+#[cfg(feature = "canonical")]
#[allow(clippy::expect_used)]
-pub fn make_docs(content: &str, support_docs: &ContractSupportDocs) -> ContractRef {
- let (_, contract_analysis) =
- mem_type_check(content, ClarityVersion::latest(), StacksEpochId::latest())
- .expect("BUG: failed to type check boot contract");
+pub fn make_docs(
+ content: &str,
+ support_docs: &ContractSupportDocs,
+ version: ClarityVersion,
+) -> ContractRef {
+ let (_, contract_analysis) = mem_type_check(content, version, StacksEpochId::latest())
+ .expect("BUG: failed to type check boot contract");
let ContractAnalysis {
public_function_types,
@@ -176,15 +185,17 @@ pub fn make_docs(content: &str, support_docs: &ContractSupportDocs) -> ContractR
/// Produce a set of documents for multiple contracts, supplied as a list of `(contract_name, contract_content)` pairs,
/// and a map from `contract_name` to corresponding `ContractSupportDocs`
+#[cfg(feature = "canonical")]
pub fn produce_docs_refs, B: AsRef>(
contracts: &[(A, B)],
support_docs: &HashMap<&str, ContractSupportDocs>,
+ version: ClarityVersion,
) -> BTreeMap {
let mut docs = BTreeMap::new();
for (contract_name, content) in contracts.iter() {
if let Some(contract_support) = support_docs.get(contract_name.as_ref()) {
- let contract_ref = make_docs(content.as_ref(), contract_support);
+ let contract_ref = make_docs(content.as_ref(), contract_support, version);
docs.insert(contract_name.as_ref().to_string(), contract_ref);
}
diff --git a/clarity/src/vm/docs/mod.rs b/clarity/src/vm/docs/mod.rs
index e0b78403b93..6bf577b680a 100644
--- a/clarity/src/vm/docs/mod.rs
+++ b/clarity/src/vm/docs/mod.rs
@@ -41,7 +41,9 @@ pub struct KeywordAPI {
pub description: &'static str,
pub example: &'static str,
/// The version where this keyword was first introduced.
- pub version: ClarityVersion,
+ pub min_version: ClarityVersion,
+ /// The version where this keyword was disabled.
+ pub max_version: Option,
}
#[derive(Serialize, Clone)]
@@ -63,7 +65,9 @@ pub struct FunctionAPI {
pub description: String,
pub example: String,
/// The version where this keyword was first introduced.
- pub version: ClarityVersion,
+ pub min_version: ClarityVersion,
+ /// The version where this keyword was disabled.
+ pub max_version: Option,
}
pub struct SimpleFunctionAPI {
@@ -96,17 +100,19 @@ const BLOCK_HEIGHT: SimpleKeywordAPI = SimpleKeywordAPI {
name: "block-height",
snippet: "block-height",
output_type: "uint",
- description: "Returns the current block height of the Stacks blockchain as an uint",
+ description: "Returns the current block height of the Stacks blockchain in Clarity 1 and 2.
+Upon activation of epoch 3.0, `block-height` will return the same value as `tenure-height`.
+In Clarity 3, `block-height` is removed and has been replaced with `stacks-block-height`.",
example:
- "(> block-height 1000) ;; returns true if the current block-height has passed 1000 blocks.",
+ "(> block-height u1000) ;; returns true if the current block-height has passed 1000 blocks.",
};
const BURN_BLOCK_HEIGHT: SimpleKeywordAPI = SimpleKeywordAPI {
name: "burn-block-height",
snippet: "burn-block-height",
output_type: "uint",
- description: "Returns the current block height of the underlying burn blockchain as a uint",
- example: "(> burn-block-height 1000) ;; returns true if the current height of the underlying burn blockchain has passed 1000 blocks.",
+ description: "Returns the current block height of the underlying burn blockchain.",
+ example: "(> burn-block-height u832000) ;; returns true if the current height of the underlying burn blockchain has passed 832,000 blocks.",
};
const CONTRACT_CALLER_KEYWORD: SimpleKeywordAPI = SimpleKeywordAPI {
@@ -120,6 +126,25 @@ to the same contract principal.",
example: "(print contract-caller) ;; Will print out a Stacks address of the transaction sender",
};
+const STACKS_BLOCK_HEIGHT_KEYWORD: SimpleKeywordAPI = SimpleKeywordAPI {
+ name: "stacks-block-height",
+ snippet: "stacks-block-height",
+ output_type: "uint",
+ description: "Returns the current block height of the Stacks blockchain.",
+ example:
+ "(<= stacks-block-height u500000) ;; returns true if the current block-height has not passed 500,000 blocks.",
+};
+
+const TENURE_HEIGHT_KEYWORD: SimpleKeywordAPI = SimpleKeywordAPI {
+ name: "tenure-height",
+ snippet: "tenure-height",
+ output_type: "uint",
+ description: "Returns the number of tenures that have passed.
+At the start of epoch 3.0, `tenure-height` will return the same value as `block-height`, then it will continue to increase as each tenures passes.",
+ example:
+ "(< tenure-height u140000) ;; returns true if the current tenure-height has passed 140,000 blocks.",
+};
+
const TX_SENDER_KEYWORD: SimpleKeywordAPI = SimpleKeywordAPI {
name: "tx-sender",
snippet: "tx-sender",
@@ -245,7 +270,7 @@ const BUFF_TO_UINT_LE_API: SimpleFunctionAPI = SimpleFunctionAPI {
name: None,
snippet: "buff-to-uint-le ${1:buff}",
signature: "(buff-to-uint-le (buff 16))",
- description: "Converts a byte buffer to an unsigned integer use a little-endian encoding..
+ description: "Converts a byte buffer to an unsigned integer use a little-endian encoding.
The byte buffer can be up to 16 bytes in length. If there are fewer than 16 bytes, as
this function uses a little-endian encoding, the input behaves as if it is
zero-padded on the _right_.
@@ -857,7 +882,8 @@ fn make_for_simple_native(
signature: api.signature.to_string(),
description: api.description.to_string(),
example: api.example.to_string(),
- version: function.get_version(),
+ min_version: function.get_min_version(),
+ max_version: function.get_max_version(),
}
}
@@ -1701,40 +1727,44 @@ const GET_BLOCK_INFO_API: SpecialAPI = SpecialAPI {
snippet: "get-block-info? ${1:prop} ${2:block-height}",
output_type: "(optional buff) | (optional uint)",
signature: "(get-block-info? prop-name block-height)",
- description: "The `get-block-info?` function fetches data for a block of the given *Stacks* block height. The
+ description: "In Clarity 3, `get-block-info?` is removed. In its place, `get-stacks-block-info?` can be used to retrieve
+information about a Stacks block and `get-tenure-info?` can be used to get information pertaining to the tenure.
+
+The `get-block-info?` function fetches data for a block of the given *Stacks* block height. The
value and type returned are determined by the specified `BlockInfoPropertyName`. If the provided `block-height` does
not correspond to an existing block prior to the current block, the function returns `none`. The currently available property names
are as follows:
-`burnchain-header-hash`: This property returns a `(buff 32)` value containing the header hash of the burnchain (Bitcoin) block that selected the
+- `burnchain-header-hash`: This property returns a `(buff 32)` value containing the header hash of the burnchain (Bitcoin) block that selected the
Stacks block at the given Stacks chain height.
-`id-header-hash`: This property returns a `(buff 32)` value containing the _index block hash_ of a Stacks block. This hash is globally unique, and is derived
+- `id-header-hash`: This property returns a `(buff 32)` value containing the _index block hash_ of a Stacks block. This hash is globally unique, and is derived
from the block hash and the history of accepted PoX operations. This is also the block hash value you would pass into `(at-block)`.
-`header-hash`: This property returns a `(buff 32)` value containing the header hash of a Stacks block, given a Stacks chain height. **WARNING* this hash is
+- `header-hash`: This property returns a `(buff 32)` value containing the header hash of a Stacks block, given a Stacks chain height. **WARNING* this hash is
not guaranteed to be globally unique, since the same Stacks block can be mined in different PoX forks. If you need global uniqueness, you should use `id-header-hash`.
-`miner-address`: This property returns a `principal` value corresponding to the miner of the given block. **WARNING** In Stacks 2.1, this is not guaranteed to
+- `miner-address`: This property returns a `principal` value corresponding to the miner of the given block. **WARNING** In Stacks 2.1, this is not guaranteed to
be the same `principal` that received the block reward, since Stacks 2.1 supports coinbase transactions that pay the reward to a contract address. This is merely
the address of the `principal` that produced the block.
-`time`: This property returns a `uint` value of the block header time field. This is a Unix epoch timestamp in seconds
-which roughly corresponds to when the block was mined. **Note**: this does not increase monotonically with each block
+- `time`: This property returns a `uint` value of the block header time field. This is a Unix epoch timestamp in seconds
+which roughly corresponds to when the block was mined. This timestamp comes from the burnchain block. **Note**: this does not increase monotonically with each block
and block times are accurate only to within two hours. See [BIP113](https://github.com/bitcoin/bips/blob/master/bip-0113.mediawiki) for more information.
+For blocks mined after epoch 3.0, all Stacks blocks in one tenure will share the same timestamp. To get the Stacks block time for a block in epoch 3.0+, use `get-stacks-block-info?`.
-New in Stacks 2.1:
+- `vrf-seed`: This property returns a `(buff 32)` value of the VRF seed for the corresponding block.
-`block-reward`: This property returns a `uint` value for the total block reward of the indicated Stacks block. This value is only available once the reward for
+- `block-reward`: This property returns a `uint` value for the total block reward of the indicated Stacks block. This value is only available once the reward for
the block matures. That is, the latest `block-reward` value available is at least 101 Stacks blocks in the past (on mainnet). The reward includes the coinbase,
the anchored block's transaction fees, and the shares of the confirmed and produced microblock transaction fees earned by this block's miner. Note that this value may
be smaller than the Stacks coinbase at this height, because the miner may have been punished with a valid `PoisonMicroblock` transaction in the event that the miner
-published two or more microblock stream forks.
+published two or more microblock stream forks. Added in Clarity 2.
-`miner-spend-total`: This property returns a `uint` value for the total number of burnchain tokens (i.e. satoshis) spent by all miners trying to win this block.
+- `miner-spend-total`: This property returns a `uint` value for the total number of burnchain tokens (i.e. satoshis) spent by all miners trying to win this block. Added in Clarity 2.
-`miner-spend-winner`: This property returns a `uint` value for the number of burnchain tokens (i.e. satoshis) spent by the winning miner for this Stacks block. Note that
-this value is less than or equal to the value for `miner-spend-total` at the same block height.
+- `miner-spend-winner`: This property returns a `uint` value for the number of burnchain tokens (i.e. satoshis) spent by the winning miner for this Stacks block. Note that
+this value is less than or equal to the value for `miner-spend-total` at the same block height. Added in Clarity 2.
",
example: "(get-block-info? time u0) ;; Returns (some u1557860301)
(get-block-info? header-hash u0) ;; Returns (some 0x374708fff7719dd5979ec875d56cd2286f6d3cf7ec317a3b25632aab28ec37bb)
@@ -1779,6 +1809,74 @@ The `addrs` list contains the same PoX address values passed into the PoX smart
"
};
+const GET_STACKS_BLOCK_INFO_API: SpecialAPI = SpecialAPI {
+ input_type: "StacksBlockInfoPropertyName, uint",
+ snippet: "get-stacks-block-info? ${1:prop} ${2:block-height}",
+ output_type: "(optional buff) | (optional uint)",
+ signature: "(get-stacks-block-info? prop-name block-height)",
+ description: "The `get-stacks-block-info?` function fetches data for a block of the given *Stacks* block height. The
+value and type returned are determined by the specified `StacksBlockInfoPropertyName`. If the provided `block-height` does
+not correspond to an existing block prior to the current block, the function returns `none`. The currently available property names
+are as follows:
+
+- `id-header-hash`: This property returns a `(buff 32)` value containing the _index block hash_ of a Stacks block. This hash is globally unique, and is derived
+from the block hash and the history of accepted PoX operations. This is also the block hash value you would pass into `(at-block)`.
+
+- `header-hash`: This property returns a `(buff 32)` value containing the header hash of a Stacks block, given a Stacks chain height. **WARNING* this hash is
+not guaranteed to be globally unique, since the same Stacks block can be mined in different PoX forks. If you need global uniqueness, you should use `id-header-hash`.
+
+- `time`: This property returns a `uint` value of the block header time field. This is a Unix epoch timestamp in seconds
+which roughly corresponds to when the block was mined. For a block mined before epoch 3.0, this timestamp comes from the burnchain block. **Note**: this does not increase monotonically with each block
+and block times are accurate only to within two hours. See [BIP113](https://github.com/bitcoin/bips/blob/master/bip-0113.mediawiki) for more information.
+For a block mined after epoch 3.0, this timestamp comes from the Stacks block header. **Note**: this is the time, according to the miner, when
+the mining of this block started, but is not guaranteed to be accurate. This time will be validated by the signers to be:
+ - Greater than the timestamp of the previous block
+ - Less than 15 seconds into the future (according to their own local clocks)
+",
+ example: "(get-stacks-block-info? time u0) ;; Returns (some u1557860301)
+(get-stacks-block-info? header-hash u0) ;; Returns (some 0x374708fff7719dd5979ec875d56cd2286f6d3cf7ec317a3b25632aab28ec37bb)
+"
+};
+
+const GET_TENURE_INFO_API: SpecialAPI = SpecialAPI {
+ input_type: "TenureInfoPropertyName, uint",
+ snippet: "get-tenure-info? ${1:prop} ${2:block-height}",
+ output_type: "(optional buff) | (optional uint)",
+ signature: "(get-tenure-info? prop-name block-height)",
+ description: "The `get-tenure-info?` function fetches data for the tenure at the given block height. The
+value and type returned are determined by the specified `TenureInfoPropertyName`. If the provided `block-height` does
+not correspond to an existing block prior to the current block, the function returns `none`. The currently available property names
+are as follows:
+
+- `burnchain-header-hash`: This property returns a `(buff 32)` value containing the header hash of the burnchain (Bitcoin) block that selected the
+tenure at the given height.
+
+- `miner-address`: This property returns a `principal` value corresponding to the miner of the given tenure. **WARNING** This is not guaranteed to
+be the same `principal` that received the block reward, since Stacks 2.1+ supports coinbase transactions that pay the reward to a contract address. This is merely
+the address of the `principal` that produced the tenure.
+
+- `time`: This property returns a `uint` Unix epoch timestamp in seconds which roughly corresponds to when the tenure was started. This timestamp comes
+from the burnchain block. **Note**: this does not increase monotonically with each tenure and tenure times are accurate only to within two hours. See
+[BIP113](https://github.com/bitcoin/bips/blob/master/bip-0113.mediawiki) for more information.
+
+- `vrf-seed`: This property returns a `(buff 32)` value of the VRF seed for the corresponding tenure.
+
+- `block-reward`: This property returns a `uint` value for the total block reward of the indicated tenure. This value is only available once the reward for
+the tenure matures. That is, the latest `block-reward` value available is at least 101 Stacks blocks in the past (on mainnet). The reward includes the coinbase,
+the anchored tenure's transaction fees, and the shares of the confirmed and produced microblock transaction fees earned by this block's miner. Note that this value may
+be smaller than the Stacks coinbase at this height, because the miner may have been punished with a valid `PoisonMicroblock` transaction in the event that the miner
+published two or more microblock stream forks.
+
+- `miner-spend-total`: This property returns a `uint` value for the total number of burnchain tokens (i.e. satoshis) spent by all miners trying to win this tenure.
+
+- `miner-spend-winner`: This property returns a `uint` value for the number of burnchain tokens (i.e. satoshis) spent by the winning miner for this tennure. Note that
+this value is less than or equal to the value for `miner-spend-total` at the same tenure height.
+",
+ example: "(get-tenure-info? time u0) ;; Returns (some u1557860301)
+(get-tenure-info? vrf-seed u0) ;; Returns (some 0xf490de2920c8a35fabeb13208852aa28c76f9be9b03a4dd2b3c075f7a26923b4)
+"
+};
+
const PRINCIPAL_CONSTRUCT_API: SpecialAPI = SpecialAPI {
input_type: "(buff 1), (buff 20), [(string-ascii 40)]",
output_type: "(response principal { error_code: uint, value: (optional principal) })",
@@ -2089,7 +2187,7 @@ const MINT_TOKEN: SpecialAPI = SpecialAPI {
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
+If a non-positive amount is provided to mint, this function returns `(err 1)`. Otherwise, on successfully mint, it
returns `(ok true)`. If this call would result in more supplied tokens than defined by the total supply in
`define-fungible-token`, then a `SupplyOverflow` runtime error is thrown.
",
@@ -2495,6 +2593,8 @@ pub fn make_api_reference(function: &NativeFunctions) -> FunctionAPI {
AsContract => make_for_special(&AS_CONTRACT_API, function),
GetBlockInfo => make_for_special(&GET_BLOCK_INFO_API, function),
GetBurnBlockInfo => make_for_special(&GET_BURN_BLOCK_INFO_API, function),
+ GetStacksBlockInfo => make_for_special(&GET_STACKS_BLOCK_INFO_API, function),
+ GetTenureInfo => make_for_special(&GET_TENURE_INFO_API, function),
ConsOkay => make_for_special(&CONS_OK_API, function),
ConsError => make_for_special(&CONS_ERR_API, function),
ConsSome => make_for_special(&CONS_SOME_API, function),
@@ -2538,13 +2638,15 @@ pub fn make_api_reference(function: &NativeFunctions) -> FunctionAPI {
}
fn make_keyword_reference(variable: &NativeVariables) -> Option {
- let simple_api = match variable {
+ let keyword = match variable {
NativeVariables::TxSender => TX_SENDER_KEYWORD.clone(),
NativeVariables::ContractCaller => CONTRACT_CALLER_KEYWORD.clone(),
NativeVariables::NativeNone => NONE_KEYWORD.clone(),
NativeVariables::NativeTrue => TRUE_KEYWORD.clone(),
NativeVariables::NativeFalse => FALSE_KEYWORD.clone(),
NativeVariables::BlockHeight => BLOCK_HEIGHT.clone(),
+ NativeVariables::StacksBlockHeight => STACKS_BLOCK_HEIGHT_KEYWORD.clone(),
+ NativeVariables::TenureHeight => TENURE_HEIGHT_KEYWORD.clone(),
NativeVariables::BurnBlockHeight => BURN_BLOCK_HEIGHT.clone(),
NativeVariables::TotalLiquidMicroSTX => TOTAL_LIQUID_USTX_KEYWORD.clone(),
NativeVariables::Regtest => REGTEST_KEYWORD.clone(),
@@ -2553,12 +2655,13 @@ fn make_keyword_reference(variable: &NativeVariables) -> Option {
NativeVariables::TxSponsor => TX_SPONSOR_KEYWORD.clone(),
};
Some(KeywordAPI {
- name: simple_api.name,
- snippet: simple_api.snippet,
- output_type: simple_api.output_type,
- description: simple_api.description,
- example: simple_api.example,
- version: variable.get_version(),
+ name: keyword.name,
+ snippet: keyword.snippet,
+ output_type: keyword.output_type,
+ description: keyword.description,
+ example: keyword.example,
+ min_version: variable.get_min_version(),
+ max_version: variable.get_max_version(),
})
}
@@ -2571,7 +2674,8 @@ fn make_for_special(api: &SpecialAPI, function: &NativeFunctions) -> FunctionAPI
signature: api.signature.to_string(),
description: api.description.to_string(),
example: api.example.to_string(),
- version: function.get_version(),
+ min_version: function.get_min_version(),
+ max_version: function.get_max_version(),
}
}
@@ -2584,7 +2688,8 @@ fn make_for_define(api: &DefineAPI, name: String) -> FunctionAPI {
signature: api.signature.to_string(),
description: api.description.to_string(),
example: api.example.to_string(),
- version: ClarityVersion::Clarity1,
+ min_version: ClarityVersion::Clarity1,
+ max_version: None,
}
}
@@ -2641,12 +2746,12 @@ pub fn make_json_api_reference() -> String {
#[cfg(test)]
mod test {
use stacks_common::address::AddressHashMode;
- use stacks_common::consts::CHAIN_ID_TESTNET;
+ use stacks_common::consts::{CHAIN_ID_TESTNET, PEER_VERSION_EPOCH_2_1};
use stacks_common::types::chainstate::{
BlockHeaderHash, BurnchainHeaderHash, ConsensusHash, SortitionId, StacksAddress,
StacksBlockId, VRFSeed,
};
- use stacks_common::types::{Address, StacksEpochId, PEER_VERSION_EPOCH_2_1};
+ use stacks_common::types::{Address, StacksEpochId};
use stacks_common::util::hash::hex_bytes;
use super::{get_input_type_string, make_all_api_reference, make_json_api_reference};
@@ -2684,10 +2789,18 @@ mod test {
) -> Option {
None
}
- fn get_consensus_hash_for_block(&self, _bhh: &StacksBlockId) -> Option {
+ fn get_consensus_hash_for_block(
+ &self,
+ _bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
+ ) -> Option {
Some(ConsensusHash([0; 20]))
}
- fn get_vrf_seed_for_block(&self, _bhh: &StacksBlockId) -> Option {
+ fn get_vrf_seed_for_block(
+ &self,
+ _bhh: &StacksBlockId,
+ epoch: &StacksEpochId,
+ ) -> Option {
Some(
VRFSeed::from_hex(
"f490de2920c8a35fabeb13208852aa28c76f9be9b03a4dd2b3c075f7a26923b4",
@@ -2698,6 +2811,7 @@ mod test {
fn get_stacks_block_header_hash_for_block(
&self,
_id_bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
) -> Option {
Some(
BlockHeaderHash::from_hex(
@@ -2706,27 +2820,47 @@ mod test {
.unwrap(),
)
}
- fn get_burn_block_time_for_block(&self, _id_bhh: &StacksBlockId) -> Option {
+ fn get_burn_block_time_for_block(
+ &self,
+ _id_bhh: &StacksBlockId,
+ _epoch: Option<&StacksEpochId>,
+ ) -> Option {
Some(1557860301)
}
+ fn get_stacks_block_time_for_block(&self, _id_bhh: &StacksBlockId) -> Option {
+ Some(1557860302)
+ }
fn get_burn_block_height_for_block(&self, _id_bhh: &StacksBlockId) -> Option {
Some(567890)
}
- fn get_miner_address(&self, _id_bhh: &StacksBlockId) -> Option {
+ fn get_miner_address(
+ &self,
+ _id_bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
+ ) -> Option {
None
}
- fn get_burnchain_tokens_spent_for_block(&self, id_bhh: &StacksBlockId) -> Option {
+ fn get_burnchain_tokens_spent_for_block(
+ &self,
+ id_bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
+ ) -> Option {
Some(12345)
}
fn get_burnchain_tokens_spent_for_winning_block(
&self,
id_bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
) -> Option {
Some(2345)
}
- fn get_tokens_earned_for_block(&self, id_bhh: &StacksBlockId) -> Option {
+ fn get_tokens_earned_for_block(
+ &self,
+ id_bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
+ ) -> Option {
Some(12000)
}
}
@@ -2735,6 +2869,14 @@ mod test {
const DOC_POX_STATE_DB: DocBurnStateDB = DocBurnStateDB {};
impl BurnStateDB for DocBurnStateDB {
+ fn get_tip_burn_block_height(&self) -> Option {
+ Some(0x9abc)
+ }
+
+ fn get_tip_sortition_id(&self) -> Option {
+ Some(SortitionId([0u8; 32]))
+ }
+
fn get_burn_block_height(&self, _sortition_id: &SortitionId) -> Option {
Some(5678)
}
diff --git a/clarity/src/vm/errors.rs b/clarity/src/vm/errors.rs
index 55977ec6aa5..b3b0ca5feac 100644
--- a/clarity/src/vm/errors.rs
+++ b/clarity/src/vm/errors.rs
@@ -17,6 +17,7 @@
use std::error::Error as ErrorTrait;
use std::{error, fmt};
+#[cfg(feature = "canonical")]
use rusqlite::Error as SqliteError;
use serde_json::Error as SerdeJSONErr;
use stacks_common::types::chainstate::BlockHeaderHash;
@@ -56,6 +57,7 @@ pub enum InterpreterError {
UninitializedPersistedVariable,
FailedToConstructAssetTable,
FailedToConstructEventBatch,
+ #[cfg(feature = "canonical")]
SqliteError(IncomparableError),
BadFileName,
FailedToCreateDataDirectory,
diff --git a/clarity/src/vm/functions/database.rs b/clarity/src/vm/functions/database.rs
index b047faf682b..f048a595367 100644
--- a/clarity/src/vm/functions/database.rs
+++ b/clarity/src/vm/functions/database.rs
@@ -32,9 +32,9 @@ use crate::vm::functions::tuples;
use crate::vm::representations::{SymbolicExpression, SymbolicExpressionType};
use crate::vm::types::{
BlockInfoProperty, BuffData, BurnBlockInfoProperty, OptionalData, PrincipalData, SequenceData,
- TupleData, TypeSignature, Value, BUFF_32,
+ StacksBlockInfoProperty, TenureInfoProperty, TupleData, TypeSignature, Value, BUFF_32,
};
-use crate::vm::{eval, Environment, LocalContext};
+use crate::vm::{eval, ClarityVersion, Environment, LocalContext};
switch_on_global_epoch!(special_fetch_variable(
special_fetch_variable_v200,
@@ -717,12 +717,32 @@ pub fn special_delete_entry_v205(
result.map(|data| data.value)
}
+/// Handles the `get-block-info?` special function.
+/// Interprets `args` as variables `[property-name, block-height]`, and returns
+/// a property value determined by `property-name`:
+/// - `id-header-hash` returns the index block hash at `block-height`
+/// - `header-hash` returns the header hash at `block-height`
+/// - `time` returns the burn block time of the block at `block-height`
+/// - `vrf-seed` returns the VRF seed of the block at `block-height`
+/// - `burnchain-header-hash` returns header hash of the burnchain block corresponding to `block-height`
+/// - `miner-address` returns the address of the principal that mined the block at `block-height`
+/// - `miner-spend-winner` returns the number of satoshis spent by the winning miner for the block at `block-height`
+/// - `miner-spend-total` returns the total number of satoshis spent by all miners for the block at `block-height`
+/// - `block-reward` returns the block reward for the block at `block-height`
+
+///
+/// # Errors:
+/// - CheckErrors::IncorrectArgumentCount if there aren't 2 arguments.
+/// - CheckErrors::GetStacksBlockInfoExpectPropertyName if `args[0]` isn't a ClarityName.
+/// - CheckErrors::NoSuchStacksBlockInfoProperty if `args[0]` isn't a StacksBlockInfoProperty.
+/// - CheckErrors::TypeValueError if `args[1]` isn't a `uint`.
+
pub fn special_get_block_info(
args: &[SymbolicExpression],
env: &mut Environment,
context: &LocalContext,
) -> Result {
- // (get-block-info? property-name block-height-int)
+ // (get-block-info? property-name block-height-uint)
runtime_cost(ClarityCostFunction::BlockInfo, env, 0)?;
check_argument_count(2, args)?;
@@ -732,11 +752,10 @@ pub fn special_get_block_info(
.match_atom()
.ok_or(CheckErrors::GetBlockInfoExpectPropertyName)?;
- let block_info_prop = BlockInfoProperty::lookup_by_name_at_version(
- property_name,
- env.contract_context.get_clarity_version(),
- )
- .ok_or(CheckErrors::GetBlockInfoExpectPropertyName)?;
+ let version = env.contract_context.get_clarity_version();
+
+ let block_info_prop = BlockInfoProperty::lookup_by_name_at_version(property_name, version)
+ .ok_or(CheckErrors::GetBlockInfoExpectPropertyName)?;
// Handle the block-height input arg clause.
let height_eval = eval(&args[1], env, context)?;
@@ -757,7 +776,10 @@ pub fn special_get_block_info(
let result = match block_info_prop {
BlockInfoProperty::Time => {
- let block_time = env.global_context.database.get_block_time(height_value)?;
+ let block_time = env
+ .global_context
+ .database
+ .get_burn_block_time(height_value, None)?;
Value::UInt(u128::from(block_time))
}
BlockInfoProperty::VrfSeed => {
@@ -830,6 +852,7 @@ pub fn special_get_block_info(
Value::some(result)
}
+/// Handles the `get-burn-block-info?` special function.
/// Interprets `args` as variables `[property_name, burn_block_height]`, and returns
/// a property value determined by `property_name`:
/// - `header_hash` returns the burn block header hash at `burn_block_height`
@@ -924,3 +947,188 @@ pub fn special_get_burn_block_info(
}
}
}
+
+/// Handles the `get-stacks-block-info?` special function.
+/// Interprets `args` as variables `[property-name, block-height]`, and returns
+/// a property value determined by `property-name`:
+/// - `id-header-hash` returns the index block hash at `block-height`
+/// - `header-hash` returns the header hash at `block-height`
+/// - `time` returns the block time at `block-height`
+///
+/// # Errors:
+/// - CheckErrors::IncorrectArgumentCount if there aren't 2 arguments.
+/// - CheckErrors::GetStacksBlockInfoExpectPropertyName if `args[0]` isn't a ClarityName.
+/// - CheckErrors::NoSuchStacksBlockInfoProperty if `args[0]` isn't a StacksBlockInfoProperty.
+/// - CheckErrors::TypeValueError if `args[1]` isn't a `uint`.
+pub fn special_get_stacks_block_info(
+ args: &[SymbolicExpression],
+ env: &mut Environment,
+ context: &LocalContext,
+) -> Result {
+ // (get-stacks-block-info? property-name block-height-uint)
+ runtime_cost(ClarityCostFunction::BlockInfo, env, 0)?;
+
+ check_argument_count(2, args)?;
+
+ // Handle the block property name input arg.
+ let property_name = args[0]
+ .match_atom()
+ .ok_or(CheckErrors::GetStacksBlockInfoExpectPropertyName)?;
+
+ let block_info_prop = StacksBlockInfoProperty::lookup_by_name(property_name).ok_or(
+ CheckErrors::NoSuchStacksBlockInfoProperty(property_name.to_string()),
+ )?;
+
+ // Handle the block-height input arg.
+ let height_eval = eval(&args[1], env, context)?;
+ let height_value = match height_eval {
+ Value::UInt(result) => Ok(result),
+ x => Err(CheckErrors::TypeValueError(TypeSignature::UIntType, x)),
+ }?;
+
+ let Ok(height_value) = u32::try_from(height_value) else {
+ return Ok(Value::none());
+ };
+
+ let current_block_height = env.global_context.database.get_current_block_height();
+ if height_value >= current_block_height {
+ return Ok(Value::none());
+ }
+
+ let result = match block_info_prop {
+ StacksBlockInfoProperty::Time => {
+ let block_time = env.global_context.database.get_block_time(height_value)?;
+ Value::UInt(u128::from(block_time))
+ }
+ StacksBlockInfoProperty::HeaderHash => {
+ let header_hash = env
+ .global_context
+ .database
+ .get_block_header_hash(height_value)?;
+ Value::Sequence(SequenceData::Buffer(BuffData {
+ data: header_hash.as_bytes().to_vec(),
+ }))
+ }
+ StacksBlockInfoProperty::IndexHeaderHash => {
+ let id_header_hash = env
+ .global_context
+ .database
+ .get_index_block_header_hash(height_value)?;
+ Value::Sequence(SequenceData::Buffer(BuffData {
+ data: id_header_hash.as_bytes().to_vec(),
+ }))
+ }
+ };
+
+ Value::some(result)
+}
+
+/// Handles the function `get-tenure-info?` special function.
+/// Interprets `args` as variables `[property-name, block-height]`, and returns
+/// a property value determined by `property-name`:
+/// - `time` returns the burn block time for the tenure of which `block-height` is a part
+/// - `vrf-seed` returns the VRF seed for the tenure of which `block-height` is a part
+/// - `burnchain-header-hash` returns header hash of the burnchain block corresponding to the tenure of which `block-height` is a part
+/// - `miner-address` returns the address of the principal that mined the tenure of which `block-height` is a part
+/// - `miner-spend-winner` returns the number of satoshis spent by the winning miner for the tenure of which `block-height` is a part
+/// - `miner-spend-total` returns the total number of satoshis spent by all miners for the tenure of which `block-height` is a part
+/// - `block-reward` returns the block reward for the tenure of which `block-height` is a part
+///
+/// # Errors:
+/// - CheckErrors::IncorrectArgumentCount if there aren't 2 arguments.
+/// - CheckErrors::GetTenureInfoExpectPropertyName if `args[0]` isn't a ClarityName.
+/// - CheckErrors::NoSuchTenureInfoProperty if `args[0]` isn't a TenureInfoProperty.
+/// - CheckErrors::TypeValueError if `args[1]` isn't a `uint`.
+pub fn special_get_tenure_info(
+ args: &[SymbolicExpression],
+ env: &mut Environment,
+ context: &LocalContext,
+) -> Result {
+ // (get-tenure-info? property-name block-height-uint)
+ runtime_cost(ClarityCostFunction::BlockInfo, env, 0)?;
+
+ check_argument_count(2, args)?;
+
+ // Handle the block property name input arg.
+ let property_name = args[0]
+ .match_atom()
+ .ok_or(CheckErrors::GetTenureInfoExpectPropertyName)?;
+
+ let block_info_prop = TenureInfoProperty::lookup_by_name(property_name)
+ .ok_or(CheckErrors::GetTenureInfoExpectPropertyName)?;
+
+ // Handle the block-height input arg.
+ let height_eval = eval(&args[1], env, context)?;
+ let height_value = match height_eval {
+ Value::UInt(result) => Ok(result),
+ x => Err(CheckErrors::TypeValueError(TypeSignature::UIntType, x)),
+ }?;
+
+ let Ok(height_value) = u32::try_from(height_value) else {
+ return Ok(Value::none());
+ };
+
+ let current_height = env.global_context.database.get_current_block_height();
+ if height_value >= current_height {
+ return Ok(Value::none());
+ }
+
+ let result = match block_info_prop {
+ TenureInfoProperty::Time => {
+ let block_time = env
+ .global_context
+ .database
+ .get_burn_block_time(height_value, None)?;
+ Value::UInt(u128::from(block_time))
+ }
+ TenureInfoProperty::VrfSeed => {
+ let vrf_seed = env
+ .global_context
+ .database
+ .get_block_vrf_seed(height_value)?;
+ Value::Sequence(SequenceData::Buffer(BuffData {
+ data: vrf_seed.as_bytes().to_vec(),
+ }))
+ }
+ TenureInfoProperty::BurnchainHeaderHash => {
+ let burnchain_header_hash = env
+ .global_context
+ .database
+ .get_burnchain_block_header_hash(height_value)?;
+ Value::Sequence(SequenceData::Buffer(BuffData {
+ data: burnchain_header_hash.as_bytes().to_vec(),
+ }))
+ }
+ TenureInfoProperty::MinerAddress => {
+ let miner_address = env
+ .global_context
+ .database
+ .get_miner_address(height_value)?;
+ Value::from(miner_address)
+ }
+ TenureInfoProperty::MinerSpendWinner => {
+ let winner_spend = env
+ .global_context
+ .database
+ .get_miner_spend_winner(height_value)?;
+ Value::UInt(winner_spend)
+ }
+ TenureInfoProperty::MinerSpendTotal => {
+ let total_spend = env
+ .global_context
+ .database
+ .get_miner_spend_total(height_value)?;
+ Value::UInt(total_spend)
+ }
+ TenureInfoProperty::BlockReward => {
+ // this is already an optional
+ let block_reward_opt = env.global_context.database.get_block_reward(height_value)?;
+ return Ok(match block_reward_opt {
+ Some(x) => Value::some(Value::UInt(x))?,
+ None => Value::none(),
+ });
+ }
+ };
+
+ Value::some(result)
+}
diff --git a/clarity/src/vm/functions/mod.rs b/clarity/src/vm/functions/mod.rs
index 7c3647c2f63..833ed4baf85 100644
--- a/clarity/src/vm/functions/mod.rs
+++ b/clarity/src/vm/functions/mod.rs
@@ -84,132 +84,119 @@ pub mod principals;
mod sequences;
pub mod tuples;
-define_versioned_named_enum!(NativeFunctions(ClarityVersion) {
- Add("+", ClarityVersion::Clarity1),
- Subtract("-", ClarityVersion::Clarity1),
- Multiply("*", ClarityVersion::Clarity1),
- Divide("/", ClarityVersion::Clarity1),
- CmpGeq(">=", ClarityVersion::Clarity1),
- CmpLeq("<=", ClarityVersion::Clarity1),
- CmpLess("<", ClarityVersion::Clarity1),
- CmpGreater(">", ClarityVersion::Clarity1),
- ToInt("to-int", ClarityVersion::Clarity1),
- ToUInt("to-uint", ClarityVersion::Clarity1),
- Modulo("mod", ClarityVersion::Clarity1),
- Power("pow", ClarityVersion::Clarity1),
- Sqrti("sqrti", ClarityVersion::Clarity1),
- Log2("log2", ClarityVersion::Clarity1),
- BitwiseXor("xor", ClarityVersion::Clarity1),
- And("and", ClarityVersion::Clarity1),
- Or("or", ClarityVersion::Clarity1),
- Not("not", ClarityVersion::Clarity1),
- Equals("is-eq", ClarityVersion::Clarity1),
- If("if", ClarityVersion::Clarity1),
- Let("let", ClarityVersion::Clarity1),
- Map("map", ClarityVersion::Clarity1),
- Fold("fold", ClarityVersion::Clarity1),
- Append("append", ClarityVersion::Clarity1),
- Concat("concat", ClarityVersion::Clarity1),
- AsMaxLen("as-max-len?", ClarityVersion::Clarity1),
- Len("len", ClarityVersion::Clarity1),
- ElementAt("element-at", ClarityVersion::Clarity1),
- ElementAtAlias("element-at?", ClarityVersion::Clarity2),
- IndexOf("index-of", ClarityVersion::Clarity1),
- IndexOfAlias("index-of?", ClarityVersion::Clarity2),
- BuffToIntLe("buff-to-int-le", ClarityVersion::Clarity2),
- BuffToUIntLe("buff-to-uint-le", ClarityVersion::Clarity2),
- BuffToIntBe("buff-to-int-be", ClarityVersion::Clarity2),
- BuffToUIntBe("buff-to-uint-be", ClarityVersion::Clarity2),
- IsStandard("is-standard", ClarityVersion::Clarity2),
- PrincipalDestruct("principal-destruct?", ClarityVersion::Clarity2),
- PrincipalConstruct("principal-construct?", ClarityVersion::Clarity2),
- StringToInt("string-to-int?", ClarityVersion::Clarity2),
- StringToUInt("string-to-uint?", ClarityVersion::Clarity2),
- IntToAscii("int-to-ascii", ClarityVersion::Clarity2),
- IntToUtf8("int-to-utf8", ClarityVersion::Clarity2),
- ListCons("list", ClarityVersion::Clarity1),
- FetchVar("var-get", ClarityVersion::Clarity1),
- SetVar("var-set", ClarityVersion::Clarity1),
- FetchEntry("map-get?", ClarityVersion::Clarity1),
- SetEntry("map-set", ClarityVersion::Clarity1),
- InsertEntry("map-insert", ClarityVersion::Clarity1),
- DeleteEntry("map-delete", ClarityVersion::Clarity1),
- TupleCons("tuple", ClarityVersion::Clarity1),
- TupleGet("get", ClarityVersion::Clarity1),
- TupleMerge("merge", ClarityVersion::Clarity1),
- Begin("begin", ClarityVersion::Clarity1),
- Hash160("hash160", ClarityVersion::Clarity1),
- Sha256("sha256", ClarityVersion::Clarity1),
- Sha512("sha512", ClarityVersion::Clarity1),
- Sha512Trunc256("sha512/256", ClarityVersion::Clarity1),
- Keccak256("keccak256", ClarityVersion::Clarity1),
- Secp256k1Recover("secp256k1-recover?", ClarityVersion::Clarity1),
- Secp256k1Verify("secp256k1-verify", ClarityVersion::Clarity1),
- Print("print", ClarityVersion::Clarity1),
- ContractCall("contract-call?", ClarityVersion::Clarity1),
- AsContract("as-contract", ClarityVersion::Clarity1),
- ContractOf("contract-of", ClarityVersion::Clarity1),
- PrincipalOf("principal-of?", ClarityVersion::Clarity1),
- AtBlock("at-block", ClarityVersion::Clarity1),
- GetBlockInfo("get-block-info?", ClarityVersion::Clarity1),
- GetBurnBlockInfo("get-burn-block-info?", ClarityVersion::Clarity2),
- ConsError("err", ClarityVersion::Clarity1),
- ConsOkay("ok", ClarityVersion::Clarity1),
- ConsSome("some", ClarityVersion::Clarity1),
- DefaultTo("default-to", ClarityVersion::Clarity1),
- Asserts("asserts!", ClarityVersion::Clarity1),
- UnwrapRet("unwrap!", ClarityVersion::Clarity1),
- UnwrapErrRet("unwrap-err!", ClarityVersion::Clarity1),
- Unwrap("unwrap-panic", ClarityVersion::Clarity1),
- UnwrapErr("unwrap-err-panic", ClarityVersion::Clarity1),
- Match("match", ClarityVersion::Clarity1),
- TryRet("try!", ClarityVersion::Clarity1),
- IsOkay("is-ok", ClarityVersion::Clarity1),
- IsNone("is-none", ClarityVersion::Clarity1),
- IsErr("is-err", ClarityVersion::Clarity1),
- IsSome("is-some", ClarityVersion::Clarity1),
- Filter("filter", ClarityVersion::Clarity1),
- GetTokenBalance("ft-get-balance", ClarityVersion::Clarity1),
- GetAssetOwner("nft-get-owner?", ClarityVersion::Clarity1),
- TransferToken("ft-transfer?", ClarityVersion::Clarity1),
- TransferAsset("nft-transfer?", ClarityVersion::Clarity1),
- MintAsset("nft-mint?", ClarityVersion::Clarity1),
- MintToken("ft-mint?", ClarityVersion::Clarity1),
- GetTokenSupply("ft-get-supply", ClarityVersion::Clarity1),
- BurnToken("ft-burn?", ClarityVersion::Clarity1),
- BurnAsset("nft-burn?", ClarityVersion::Clarity1),
- GetStxBalance("stx-get-balance", ClarityVersion::Clarity1),
- StxTransfer("stx-transfer?", ClarityVersion::Clarity1),
- StxTransferMemo("stx-transfer-memo?", ClarityVersion::Clarity2),
- StxBurn("stx-burn?", ClarityVersion::Clarity1),
- StxGetAccount("stx-account", ClarityVersion::Clarity2),
- BitwiseAnd("bit-and", ClarityVersion::Clarity2),
- BitwiseOr("bit-or", ClarityVersion::Clarity2),
- BitwiseNot("bit-not", ClarityVersion::Clarity2),
- BitwiseLShift("bit-shift-left", ClarityVersion::Clarity2),
- BitwiseRShift("bit-shift-right", ClarityVersion::Clarity2),
- BitwiseXor2("bit-xor", ClarityVersion::Clarity2),
- Slice("slice?", ClarityVersion::Clarity2),
- ToConsensusBuff("to-consensus-buff?", ClarityVersion::Clarity2),
- FromConsensusBuff("from-consensus-buff?", ClarityVersion::Clarity2),
- ReplaceAt("replace-at?", ClarityVersion::Clarity2),
+define_versioned_named_enum_with_max!(NativeFunctions(ClarityVersion) {
+ Add("+", ClarityVersion::Clarity1, None),
+ Subtract("-", ClarityVersion::Clarity1, None),
+ Multiply("*", ClarityVersion::Clarity1, None),
+ Divide("/", ClarityVersion::Clarity1, None),
+ CmpGeq(">=", ClarityVersion::Clarity1, None),
+ CmpLeq("<=", ClarityVersion::Clarity1, None),
+ CmpLess("<", ClarityVersion::Clarity1, None),
+ CmpGreater(">", ClarityVersion::Clarity1, None),
+ ToInt("to-int", ClarityVersion::Clarity1, None),
+ ToUInt("to-uint", ClarityVersion::Clarity1, None),
+ Modulo("mod", ClarityVersion::Clarity1, None),
+ Power("pow", ClarityVersion::Clarity1, None),
+ Sqrti("sqrti", ClarityVersion::Clarity1, None),
+ Log2("log2", ClarityVersion::Clarity1, None),
+ BitwiseXor("xor", ClarityVersion::Clarity1, None),
+ And("and", ClarityVersion::Clarity1, None),
+ Or("or", ClarityVersion::Clarity1, None),
+ Not("not", ClarityVersion::Clarity1, None),
+ Equals("is-eq", ClarityVersion::Clarity1, None),
+ If("if", ClarityVersion::Clarity1, None),
+ Let("let", ClarityVersion::Clarity1, None),
+ Map("map", ClarityVersion::Clarity1, None),
+ Fold("fold", ClarityVersion::Clarity1, None),
+ Append("append", ClarityVersion::Clarity1, None),
+ Concat("concat", ClarityVersion::Clarity1, None),
+ AsMaxLen("as-max-len?", ClarityVersion::Clarity1, None),
+ Len("len", ClarityVersion::Clarity1, None),
+ ElementAt("element-at", ClarityVersion::Clarity1, None),
+ ElementAtAlias("element-at?", ClarityVersion::Clarity2, None),
+ IndexOf("index-of", ClarityVersion::Clarity1, None),
+ IndexOfAlias("index-of?", ClarityVersion::Clarity2, None),
+ BuffToIntLe("buff-to-int-le", ClarityVersion::Clarity2, None),
+ BuffToUIntLe("buff-to-uint-le", ClarityVersion::Clarity2, None),
+ BuffToIntBe("buff-to-int-be", ClarityVersion::Clarity2, None),
+ BuffToUIntBe("buff-to-uint-be", ClarityVersion::Clarity2, None),
+ IsStandard("is-standard", ClarityVersion::Clarity2, None),
+ PrincipalDestruct("principal-destruct?", ClarityVersion::Clarity2, None),
+ PrincipalConstruct("principal-construct?", ClarityVersion::Clarity2, None),
+ StringToInt("string-to-int?", ClarityVersion::Clarity2, None),
+ StringToUInt("string-to-uint?", ClarityVersion::Clarity2, None),
+ IntToAscii("int-to-ascii", ClarityVersion::Clarity2, None),
+ IntToUtf8("int-to-utf8", ClarityVersion::Clarity2, None),
+ ListCons("list", ClarityVersion::Clarity1, None),
+ FetchVar("var-get", ClarityVersion::Clarity1, None),
+ SetVar("var-set", ClarityVersion::Clarity1, None),
+ FetchEntry("map-get?", ClarityVersion::Clarity1, None),
+ SetEntry("map-set", ClarityVersion::Clarity1, None),
+ InsertEntry("map-insert", ClarityVersion::Clarity1, None),
+ DeleteEntry("map-delete", ClarityVersion::Clarity1, None),
+ TupleCons("tuple", ClarityVersion::Clarity1, None),
+ TupleGet("get", ClarityVersion::Clarity1, None),
+ TupleMerge("merge", ClarityVersion::Clarity1, None),
+ Begin("begin", ClarityVersion::Clarity1, None),
+ Hash160("hash160", ClarityVersion::Clarity1, None),
+ Sha256("sha256", ClarityVersion::Clarity1, None),
+ Sha512("sha512", ClarityVersion::Clarity1, None),
+ Sha512Trunc256("sha512/256", ClarityVersion::Clarity1, None),
+ Keccak256("keccak256", ClarityVersion::Clarity1, None),
+ Secp256k1Recover("secp256k1-recover?", ClarityVersion::Clarity1, None),
+ Secp256k1Verify("secp256k1-verify", ClarityVersion::Clarity1, None),
+ Print("print", ClarityVersion::Clarity1, None),
+ ContractCall("contract-call?", ClarityVersion::Clarity1, None),
+ AsContract("as-contract", ClarityVersion::Clarity1, None),
+ ContractOf("contract-of", ClarityVersion::Clarity1, None),
+ PrincipalOf("principal-of?", ClarityVersion::Clarity1, None),
+ AtBlock("at-block", ClarityVersion::Clarity1, None),
+ GetBlockInfo("get-block-info?", ClarityVersion::Clarity1, Some(ClarityVersion::Clarity2)),
+ GetBurnBlockInfo("get-burn-block-info?", ClarityVersion::Clarity2, None),
+ ConsError("err", ClarityVersion::Clarity1, None),
+ ConsOkay("ok", ClarityVersion::Clarity1, None),
+ ConsSome("some", ClarityVersion::Clarity1, None),
+ DefaultTo("default-to", ClarityVersion::Clarity1, None),
+ Asserts("asserts!", ClarityVersion::Clarity1, None),
+ UnwrapRet("unwrap!", ClarityVersion::Clarity1, None),
+ UnwrapErrRet("unwrap-err!", ClarityVersion::Clarity1, None),
+ Unwrap("unwrap-panic", ClarityVersion::Clarity1, None),
+ UnwrapErr("unwrap-err-panic", ClarityVersion::Clarity1, None),
+ Match("match", ClarityVersion::Clarity1, None),
+ TryRet("try!", ClarityVersion::Clarity1, None),
+ IsOkay("is-ok", ClarityVersion::Clarity1, None),
+ IsNone("is-none", ClarityVersion::Clarity1, None),
+ IsErr("is-err", ClarityVersion::Clarity1, None),
+ IsSome("is-some", ClarityVersion::Clarity1, None),
+ Filter("filter", ClarityVersion::Clarity1, None),
+ GetTokenBalance("ft-get-balance", ClarityVersion::Clarity1, None),
+ GetAssetOwner("nft-get-owner?", ClarityVersion::Clarity1, None),
+ TransferToken("ft-transfer?", ClarityVersion::Clarity1, None),
+ TransferAsset("nft-transfer?", ClarityVersion::Clarity1, None),
+ MintAsset("nft-mint?", ClarityVersion::Clarity1, None),
+ MintToken("ft-mint?", ClarityVersion::Clarity1, None),
+ GetTokenSupply("ft-get-supply", ClarityVersion::Clarity1, None),
+ BurnToken("ft-burn?", ClarityVersion::Clarity1, None),
+ BurnAsset("nft-burn?", ClarityVersion::Clarity1, None),
+ GetStxBalance("stx-get-balance", ClarityVersion::Clarity1, None),
+ StxTransfer("stx-transfer?", ClarityVersion::Clarity1, None),
+ StxTransferMemo("stx-transfer-memo?", ClarityVersion::Clarity2, None),
+ StxBurn("stx-burn?", ClarityVersion::Clarity1, None),
+ StxGetAccount("stx-account", ClarityVersion::Clarity2, None),
+ BitwiseAnd("bit-and", ClarityVersion::Clarity2, None),
+ BitwiseOr("bit-or", ClarityVersion::Clarity2, None),
+ BitwiseNot("bit-not", ClarityVersion::Clarity2, None),
+ BitwiseLShift("bit-shift-left", ClarityVersion::Clarity2, None),
+ BitwiseRShift("bit-shift-right", ClarityVersion::Clarity2, None),
+ BitwiseXor2("bit-xor", ClarityVersion::Clarity2, None),
+ Slice("slice?", ClarityVersion::Clarity2, None),
+ ToConsensusBuff("to-consensus-buff?", ClarityVersion::Clarity2, None),
+ FromConsensusBuff("from-consensus-buff?", ClarityVersion::Clarity2, None),
+ ReplaceAt("replace-at?", ClarityVersion::Clarity2, None),
+ GetStacksBlockInfo("get-stacks-block-info?", ClarityVersion::Clarity3, None),
+ GetTenureInfo("get-tenure-info?", ClarityVersion::Clarity3, None),
});
-impl NativeFunctions {
- pub fn lookup_by_name_at_version(
- name: &str,
- version: &ClarityVersion,
- ) -> Option {
- NativeFunctions::lookup_by_name(name).and_then(|native_function| {
- if &native_function.get_version() <= version {
- Some(native_function)
- } else {
- None
- }
- })
- }
-}
-
///
/// Returns a callable for the given native function if it exists in the provided
/// ClarityVersion
@@ -436,6 +423,14 @@ pub fn lookup_reserved_functions(name: &str, version: &ClarityVersion) -> Option
"special_get_burn_block_info",
&database::special_get_burn_block_info,
),
+ GetStacksBlockInfo => SpecialFunction(
+ "special_get_stacks_block_info",
+ &database::special_get_stacks_block_info,
+ ),
+ GetTenureInfo => SpecialFunction(
+ "special_get_tenure_info",
+ &database::special_get_tenure_info,
+ ),
ConsSome => NativeFunction(
"native_some",
NativeHandle::SingleArg(&options::native_some),
diff --git a/clarity/src/vm/mod.rs b/clarity/src/vm/mod.rs
index bca5223828f..d64b2075225 100644
--- a/clarity/src/vm/mod.rs
+++ b/clarity/src/vm/mod.rs
@@ -41,6 +41,9 @@ pub mod coverage;
pub mod events;
+#[cfg(feature = "canonical")]
+pub mod tooling;
+
#[cfg(any(test, feature = "testing"))]
pub mod tests;
diff --git a/clarity/src/vm/test_util/mod.rs b/clarity/src/vm/test_util/mod.rs
index b7e58919aa8..2df79766a24 100644
--- a/clarity/src/vm/test_util/mod.rs
+++ b/clarity/src/vm/test_util/mod.rs
@@ -2,12 +2,13 @@ use stacks_common::address::{AddressHashMode, C32_ADDRESS_VERSION_TESTNET_SINGLE
use stacks_common::consts::{
BITCOIN_REGTEST_FIRST_BLOCK_HASH, BITCOIN_REGTEST_FIRST_BLOCK_HEIGHT,
BITCOIN_REGTEST_FIRST_BLOCK_TIMESTAMP, FIRST_BURNCHAIN_CONSENSUS_HASH, FIRST_STACKS_BLOCK_HASH,
+ PEER_VERSION_EPOCH_2_0,
};
use stacks_common::types::chainstate::{
BlockHeaderHash, BurnchainHeaderHash, ConsensusHash, SortitionId, StacksAddress, StacksBlockId,
StacksPrivateKey, StacksPublicKey, VRFSeed,
};
-use stacks_common::types::{StacksEpochId, PEER_VERSION_EPOCH_2_0};
+use stacks_common::types::StacksEpochId;
use crate::vm::ast::ASTRules;
use crate::vm::costs::ExecutionCost;
@@ -136,12 +137,17 @@ impl HeadersDB for UnitTestHeaderDB {
None
}
}
- fn get_vrf_seed_for_block(&self, _bhh: &StacksBlockId) -> Option {
+ fn get_vrf_seed_for_block(
+ &self,
+ _bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
+ ) -> Option {
None
}
fn get_stacks_block_header_hash_for_block(
&self,
id_bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
) -> Option {
if *id_bhh == StacksBlockId::new(&FIRST_BURNCHAIN_CONSENSUS_HASH, &FIRST_STACKS_BLOCK_HASH)
{
@@ -150,7 +156,11 @@ impl HeadersDB for UnitTestHeaderDB {
None
}
}
- fn get_burn_block_time_for_block(&self, id_bhh: &StacksBlockId) -> Option {
+ fn get_burn_block_time_for_block(
+ &self,
+ id_bhh: &StacksBlockId,
+ _epoch: Option<&StacksEpochId>,
+ ) -> Option {
if *id_bhh == StacksBlockId::new(&FIRST_BURNCHAIN_CONSENSUS_HASH, &FIRST_STACKS_BLOCK_HASH)
{
Some(BITCOIN_REGTEST_FIRST_BLOCK_TIMESTAMP as u64)
@@ -161,6 +171,9 @@ impl HeadersDB for UnitTestHeaderDB {
Some(1 + 10 * (id_bhh.as_bytes()[0] as u64))
}
}
+ fn get_stacks_block_time_for_block(&self, id_bhh: &StacksBlockId) -> Option {
+ Some(1713799973 + 10 * (id_bhh.as_bytes()[0] as u64))
+ }
fn get_burn_block_height_for_block(&self, id_bhh: &StacksBlockId) -> Option {
if *id_bhh == StacksBlockId::new(&FIRST_BURNCHAIN_CONSENSUS_HASH, &FIRST_STACKS_BLOCK_HASH)
{
@@ -169,11 +182,19 @@ impl HeadersDB for UnitTestHeaderDB {
Some(1 + id_bhh.as_bytes()[0] as u32)
}
}
- fn get_miner_address(&self, _id_bhh: &StacksBlockId) -> Option {
+ fn get_miner_address(
+ &self,
+ _id_bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
+ ) -> Option {
None
}
- fn get_consensus_hash_for_block(&self, id_bhh: &StacksBlockId) -> Option {
+ fn get_consensus_hash_for_block(
+ &self,
+ id_bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
+ ) -> Option {
if *id_bhh == StacksBlockId::new(&FIRST_BURNCHAIN_CONSENSUS_HASH, &FIRST_STACKS_BLOCK_HASH)
{
Some(FIRST_BURNCHAIN_CONSENSUS_HASH)
@@ -182,23 +203,43 @@ impl HeadersDB for UnitTestHeaderDB {
}
}
- fn get_burnchain_tokens_spent_for_block(&self, id_bhh: &StacksBlockId) -> Option {
+ fn get_burnchain_tokens_spent_for_block(
+ &self,
+ id_bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
+ ) -> Option {
// if the block is defined at all, then return a constant
self.get_burn_block_height_for_block(id_bhh).map(|_| 2000)
}
- fn get_burnchain_tokens_spent_for_winning_block(&self, id_bhh: &StacksBlockId) -> Option {
+ fn get_burnchain_tokens_spent_for_winning_block(
+ &self,
+ id_bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
+ ) -> Option {
// if the block is defined at all, then return a constant
self.get_burn_block_height_for_block(id_bhh).map(|_| 1000)
}
- fn get_tokens_earned_for_block(&self, id_bhh: &StacksBlockId) -> Option {
+ fn get_tokens_earned_for_block(
+ &self,
+ id_bhh: &StacksBlockId,
+ _epoch: &StacksEpochId,
+ ) -> Option {
// if the block is defined at all, then return a constant
self.get_burn_block_height_for_block(id_bhh).map(|_| 3000)
}
}
impl BurnStateDB for UnitTestBurnStateDB {
+ fn get_tip_burn_block_height(&self) -> Option {
+ None
+ }
+
+ fn get_tip_sortition_id(&self) -> Option {
+ None
+ }
+
fn get_burn_block_height(&self, _sortition_id: &SortitionId) -> Option {
None
}
diff --git a/clarity/src/vm/tests/contracts.rs b/clarity/src/vm/tests/contracts.rs
index 817a74917b5..3c4dc14b2e0 100644
--- a/clarity/src/vm/tests/contracts.rs
+++ b/clarity/src/vm/tests/contracts.rs
@@ -129,8 +129,9 @@ fn test_get_block_info_eval(
let contract_identifier =
QualifiedContractIdentifier::local(&format!("test-contract-{}", i)).unwrap();
owned_env
- .initialize_contract(
+ .initialize_versioned_contract(
contract_identifier.clone(),
+ ClarityVersion::Clarity2,
contracts[i],
None,
ASTRules::PrecheckSize,
@@ -1147,3 +1148,38 @@ fn test_cc_trait_stack_depth(
RuntimeErrorType::MaxStackDepthReached.into()
);
}
+
+#[apply(test_epochs)]
+fn test_eval_with_non_existing_contract(
+ epoch: StacksEpochId,
+ mut env_factory: MemoryEnvironmentGenerator,
+) {
+ let mut owned_env = env_factory.get_env(epoch);
+
+ let mut placeholder_context = ContractContext::new(
+ QualifiedContractIdentifier::transient(),
+ ClarityVersion::Clarity2,
+ );
+
+ let mut env = owned_env.get_exec_environment(
+ Some(get_principal().expect_principal().unwrap()),
+ None,
+ &mut placeholder_context,
+ );
+
+ let result = env.eval_read_only(
+ &QualifiedContractIdentifier::local("absent").unwrap(),
+ "(ok 0)",
+ );
+ assert_eq!(
+ result.as_ref().unwrap_err(),
+ &Error::Unchecked(CheckErrors::NoSuchContract(
+ QualifiedContractIdentifier::local("absent")
+ .unwrap()
+ .to_string()
+ ))
+ );
+ drop(env);
+ owned_env.commit().unwrap();
+ assert!(owned_env.destruct().is_some());
+}
diff --git a/clarity/src/vm/tests/mod.rs b/clarity/src/vm/tests/mod.rs
index 9f98e7e9300..2c6f23ef428 100644
--- a/clarity/src/vm/tests/mod.rs
+++ b/clarity/src/vm/tests/mod.rs
@@ -33,6 +33,19 @@ mod sequences;
#[cfg(test)]
mod simple_apply_eval;
mod traits;
+mod variables;
+
+#[cfg(any(test, feature = "testing"))]
+impl<'a, 'hooks> OwnedEnvironment<'a, 'hooks> {
+ pub fn set_tenure_height(&mut self, tenure_height: u32) {
+ self.context.database.begin();
+ self.context
+ .database
+ .set_tenure_height(tenure_height)
+ .unwrap();
+ self.context.database.commit().unwrap();
+ }
+}
macro_rules! epochs_template {
($($epoch:ident,)*) => {
@@ -50,7 +63,6 @@ macro_rules! epochs_template {
match epoch {
// don't test Epoch-1.0
StacksEpochId::Epoch10 => (),
- StacksEpochId::Epoch30 => (),
// this will lead to a compile time failure if an epoch is left out
// of the epochs_template! macro list
$(StacksEpochId::$epoch)|* => (),
@@ -76,10 +88,16 @@ macro_rules! clarity_template {
match (epoch, clarity) {
// don't test Epoch-1.0
(StacksEpochId::Epoch10, _) => (),
- (StacksEpochId::Epoch30, _) => (),
// don't test these pairs, because they aren't supported:
(StacksEpochId::Epoch20, ClarityVersion::Clarity2) => (),
(StacksEpochId::Epoch2_05, ClarityVersion::Clarity2) => (),
+ (StacksEpochId::Epoch20, ClarityVersion::Clarity3) => (),
+ (StacksEpochId::Epoch2_05, ClarityVersion::Clarity3) => (),
+ (StacksEpochId::Epoch21, ClarityVersion::Clarity3) => (),
+ (StacksEpochId::Epoch22, ClarityVersion::Clarity3) => (),
+ (StacksEpochId::Epoch23, ClarityVersion::Clarity3) => (),
+ (StacksEpochId::Epoch24, ClarityVersion::Clarity3) => (),
+ (StacksEpochId::Epoch25, ClarityVersion::Clarity3) => (),
// this will lead to a compile time failure if a pair is left out
// of the clarity_template! macro list
$((StacksEpochId::$epoch, ClarityVersion::$clarity))|* => (),
@@ -103,6 +121,7 @@ epochs_template! {
Epoch23,
Epoch24,
Epoch25,
+ Epoch30,
}
clarity_template! {
@@ -118,6 +137,9 @@ clarity_template! {
(Epoch24, Clarity2),
(Epoch25, Clarity1),
(Epoch25, Clarity2),
+ (Epoch30, Clarity1),
+ (Epoch30, Clarity2),
+ (Epoch30, Clarity3),
}
#[cfg(test)]
@@ -140,7 +162,16 @@ pub fn tl_env_factory() -> TopLevelMemoryEnvironmentGenerator {
pub struct MemoryEnvironmentGenerator(MemoryBackingStore);
impl MemoryEnvironmentGenerator {
fn get_env(&mut self, epoch: StacksEpochId) -> OwnedEnvironment {
- let mut owned_env = OwnedEnvironment::new(self.0.as_clarity_db(), epoch);
+ let mut db = self.0.as_clarity_db();
+ db.begin();
+ db.set_clarity_epoch_version(epoch).unwrap();
+ db.commit().unwrap();
+ if epoch.clarity_uses_tip_burn_block() {
+ db.begin();
+ db.set_tenure_height(1).unwrap();
+ db.commit().unwrap();
+ }
+ let mut owned_env = OwnedEnvironment::new(db, epoch);
// start an initial transaction.
owned_env.begin();
owned_env
@@ -150,8 +181,16 @@ impl MemoryEnvironmentGenerator {
pub struct TopLevelMemoryEnvironmentGenerator(MemoryBackingStore);
impl TopLevelMemoryEnvironmentGenerator {
pub fn get_env(&mut self, epoch: StacksEpochId) -> OwnedEnvironment {
- let owned_env = OwnedEnvironment::new(self.0.as_clarity_db(), epoch);
- owned_env
+ let mut db = self.0.as_clarity_db();
+ db.begin();
+ db.set_clarity_epoch_version(epoch).unwrap();
+ db.commit().unwrap();
+ if epoch.clarity_uses_tip_burn_block() {
+ db.begin();
+ db.set_tenure_height(1).unwrap();
+ db.commit().unwrap();
+ }
+ OwnedEnvironment::new(db, epoch)
}
}
diff --git a/clarity/src/vm/tests/principals.rs b/clarity/src/vm/tests/principals.rs
index 78fcf176594..44f3447bad7 100644
--- a/clarity/src/vm/tests/principals.rs
+++ b/clarity/src/vm/tests/principals.rs
@@ -657,7 +657,7 @@ fn test_principal_destruct_bad_version_byte() {
// Standard case where construction should work. We compare the output of the
// Clarity function to hand-built principals.
fn test_principal_construct_good() {
- // We always use the the same bytes buffer.
+ // We always use the same bytes buffer.
let mut transfer_buffer = [0u8; 20];
transfer_buffer
.copy_from_slice(&hex_bytes("fa6bf38ed557fe417333710d6033e9419391a320").unwrap());
diff --git a/clarity/src/vm/tests/variables.rs b/clarity/src/vm/tests/variables.rs
new file mode 100644
index 00000000000..5b392bb6782
--- /dev/null
+++ b/clarity/src/vm/tests/variables.rs
@@ -0,0 +1,1079 @@
+// Copyright (C) 2013-2020 Blockstack PBC, a public benefit corporation
+// Copyright (C) 2020-2024 Stacks Open Internet Foundation
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see .
+
+#[cfg(any(test, feature = "testing"))]
+use rstest::rstest;
+use stacks_common::types::StacksEpochId;
+
+#[cfg(test)]
+use crate::vm::analysis::type_checker::v2_1::tests::contracts::type_check_version;
+use crate::vm::analysis::{run_analysis, CheckError};
+use crate::vm::ast::{parse, ASTRules};
+use crate::vm::database::MemoryBackingStore;
+use crate::vm::errors::{CheckErrors, Error};
+use crate::vm::tests::{test_clarity_versions, tl_env_factory, TopLevelMemoryEnvironmentGenerator};
+use crate::vm::types::{QualifiedContractIdentifier, Value};
+use crate::vm::{ClarityVersion, ContractContext};
+
+#[apply(test_clarity_versions)]
+fn test_block_height(
+ version: ClarityVersion,
+ epoch: StacksEpochId,
+ mut tl_env_factory: TopLevelMemoryEnvironmentGenerator,
+) {
+ let contract = "(define-read-only (test-func) block-height)";
+
+ let mut placeholder_context =
+ ContractContext::new(QualifiedContractIdentifier::transient(), version);
+
+ let mut owned_env = tl_env_factory.get_env(epoch);
+ let contract_identifier = QualifiedContractIdentifier::local("test-contract").unwrap();
+
+ let mut exprs = parse(&contract_identifier, &contract, version, epoch).unwrap();
+ let mut marf = MemoryBackingStore::new();
+ let mut db = marf.as_analysis_db();
+ let analysis = db.execute(|db| {
+ type_check_version(&contract_identifier, &mut exprs, db, true, epoch, version)
+ });
+ if version >= ClarityVersion::Clarity3 {
+ let err = analysis.unwrap_err();
+ assert_eq!(
+ CheckErrors::UndefinedVariable("block-height".to_string()),
+ err.err
+ );
+ } else {
+ assert!(analysis.is_ok());
+ }
+
+ // Initialize the contract
+ // Note that we're ignoring the analysis failure here so that we can test
+ // the runtime behavior. In Clarity 3, if this case somehow gets past the
+ // analysis, it should fail at runtime.
+ let result = owned_env.initialize_versioned_contract(
+ contract_identifier.clone(),
+ version,
+ contract,
+ None,
+ ASTRules::PrecheckSize,
+ );
+
+ let mut env = owned_env.get_exec_environment(None, None, &mut placeholder_context);
+
+ // Call the function
+ let eval_result = env.eval_read_only(&contract_identifier, "(test-func)");
+ // In Clarity 3, this should trigger a runtime error
+ if version >= ClarityVersion::Clarity3 {
+ let err = eval_result.unwrap_err();
+ assert_eq!(
+ Error::Unchecked(CheckErrors::UndefinedVariable("block-height".to_string(),)),
+ err
+ );
+ } else {
+ assert_eq!(Ok(Value::UInt(1)), eval_result);
+ }
+}
+
+#[apply(test_clarity_versions)]
+fn test_stacks_block_height(
+ version: ClarityVersion,
+ epoch: StacksEpochId,
+ mut tl_env_factory: TopLevelMemoryEnvironmentGenerator,
+) {
+ let contract = "(define-read-only (test-func) stacks-block-height)";
+
+ let mut placeholder_context =
+ ContractContext::new(QualifiedContractIdentifier::transient(), version);
+
+ let mut owned_env = tl_env_factory.get_env(epoch);
+ let contract_identifier = QualifiedContractIdentifier::local("test-contract").unwrap();
+
+ let mut exprs = parse(&contract_identifier, &contract, version, epoch).unwrap();
+ let mut marf = MemoryBackingStore::new();
+ let mut db = marf.as_analysis_db();
+ let analysis = db.execute(|db| {
+ type_check_version(&contract_identifier, &mut exprs, db, true, epoch, version)
+ });
+ if version < ClarityVersion::Clarity3 {
+ let err = analysis.unwrap_err();
+ assert_eq!(
+ CheckErrors::UndefinedVariable("stacks-block-height".to_string()),
+ err.err
+ );
+ } else {
+ assert!(analysis.is_ok());
+ }
+
+ // Initialize the contract
+ // Note that we're ignoring the analysis failure here so that we can test
+ // the runtime behavior. In Clarity 3, if this case somehow gets past the
+ // analysis, it should fail at runtime.
+ let result = owned_env.initialize_versioned_contract(
+ contract_identifier.clone(),
+ version,
+ contract,
+ None,
+ ASTRules::PrecheckSize,
+ );
+
+ let mut env = owned_env.get_exec_environment(None, None, &mut placeholder_context);
+
+ // Call the function
+ let eval_result = env.eval_read_only(&contract_identifier, "(test-func)");
+ // In Clarity 3, this should trigger a runtime error
+ if version < ClarityVersion::Clarity3 {
+ let err = eval_result.unwrap_err();
+ assert_eq!(
+ Error::Unchecked(CheckErrors::UndefinedVariable(
+ "stacks-block-height".to_string(),
+ )),
+ err
+ );
+ } else {
+ assert_eq!(Ok(Value::UInt(1)), eval_result);
+ }
+}
+
+#[apply(test_clarity_versions)]
+fn test_tenure_height(
+ version: ClarityVersion,
+ epoch: StacksEpochId,
+ mut tl_env_factory: TopLevelMemoryEnvironmentGenerator,
+) {
+ let contract = "(define-read-only (test-func) tenure-height)";
+
+ let mut placeholder_context =
+ ContractContext::new(QualifiedContractIdentifier::transient(), version);
+
+ let mut owned_env = tl_env_factory.get_env(epoch);
+ let contract_identifier = QualifiedContractIdentifier::local("test-contract").unwrap();
+
+ let mut exprs = parse(&contract_identifier, &contract, version, epoch).unwrap();
+ let mut marf = MemoryBackingStore::new();
+ let mut db = marf.as_analysis_db();
+ let analysis = db.execute(|db| {
+ type_check_version(&contract_identifier, &mut exprs, db, true, epoch, version)
+ });
+ if version < ClarityVersion::Clarity3 {
+ let err = analysis.unwrap_err();
+ assert_eq!(
+ CheckErrors::UndefinedVariable("tenure-height".to_string()),
+ err.err
+ );
+ } else {
+ assert!(analysis.is_ok());
+ }
+
+ // Initialize the contract
+ // Note that we're ignoring the analysis failure here so that we can test
+ // the runtime behavior. In Clarity 3, if this case somehow gets past the
+ // analysis, it should fail at runtime.
+ let result = owned_env.initialize_versioned_contract(
+ contract_identifier.clone(),
+ version,
+ contract,
+ None,
+ ASTRules::PrecheckSize,
+ );
+
+ let mut env = owned_env.get_exec_environment(None, None, &mut placeholder_context);
+
+ // Call the function
+ let eval_result = env.eval_read_only(&contract_identifier, "(test-func)");
+ // In Clarity 3, this should trigger a runtime error
+ if version < ClarityVersion::Clarity3 {
+ let err = eval_result.unwrap_err();
+ assert_eq!(
+ Error::Unchecked(CheckErrors::UndefinedVariable("tenure-height".to_string(),)),
+ err
+ );
+ } else {
+ assert_eq!(Ok(Value::UInt(1)), eval_result);
+ }
+}
+
+#[derive(Debug, PartialEq)]
+enum WhenError {
+ Analysis,
+ Initialization,
+ Runtime,
+ Never,
+}
+
+#[cfg(test)]
+fn expect_contract_error(
+ version: ClarityVersion,
+ epoch: StacksEpochId,
+ tl_env_factory: &mut TopLevelMemoryEnvironmentGenerator,
+ name: &str,
+ contract: &str,
+ expected_errors: &[(
+ WhenError,
+ fn(ClarityVersion, StacksEpochId) -> bool,
+ CheckErrors,
+ )],
+ expected_success: Value,
+) {
+ let mut placeholder_context =
+ ContractContext::new(QualifiedContractIdentifier::local(name).unwrap(), version);
+
+ let mut owned_env = tl_env_factory.get_env(epoch);
+ let contract_identifier = QualifiedContractIdentifier::local(name).unwrap();
+
+ let mut exprs = parse(&contract_identifier, &contract, version, epoch).unwrap();
+ let mut marf = MemoryBackingStore::new();
+ let mut db = marf.as_analysis_db();
+ let analysis = db.execute(|db| {
+ type_check_version(&contract_identifier, &mut exprs, db, true, epoch, version)
+ });
+
+ for (when, err_condition, expected_error) in expected_errors {
+ if *when == WhenError::Analysis && err_condition(version, epoch) {
+ let err = analysis.unwrap_err();
+ assert_eq!(*expected_error, err.err);
+
+ // Do not continue with the test if the analysis failed.
+ return;
+ }
+ }
+
+ // The type-checker does not report an error for the reuse of the built-in
+ // name `stacks-block-height`. It is instead caught at initialization. This
+ // matches the behavior of Clarity 1 and 2.
+ assert!(analysis.is_ok());
+
+ // Initialize the contract
+ // Note that we're ignoring the analysis failure here so that we can test
+ // the runtime behavior. In Clarity 3, if this case somehow gets past the
+ // analysis, it should fail at runtime.
+ let init_result = owned_env.initialize_versioned_contract(
+ contract_identifier.clone(),
+ version,
+ contract,
+ None,
+ ASTRules::PrecheckSize,
+ );
+
+ for (when, err_condition, expected_error) in expected_errors {
+ if *when == WhenError::Initialization && err_condition(version, epoch) {
+ let err = init_result.unwrap_err();
+ if let Error::Unchecked(inner_err) = &err {
+ assert_eq!(expected_error, inner_err);
+ } else {
+ panic!("Expected an Unchecked error, but got a different error");
+ }
+
+ // Do not continue with the test if the initialization failed.
+ return;
+ }
+ }
+
+ let mut env = owned_env.get_exec_environment(None, None, &mut placeholder_context);
+
+ // Call the function
+ let eval_result = env.eval_read_only(&contract_identifier, "(test-func)");
+
+ for (when, err_condition, expected_error) in expected_errors {
+ if *when == WhenError::Runtime && err_condition(version, epoch) {
+ let err = eval_result.unwrap_err();
+ if let Error::Unchecked(inner_err) = &err {
+ assert_eq!(expected_error, inner_err);
+ } else {
+ panic!("Expected an Unchecked error, but got a different error");
+ }
+
+ // Do not continue with the test if the evaluation failed.
+ return;
+ }
+ }
+
+ assert_eq!(Ok(expected_success), eval_result);
+}
+
+#[apply(test_clarity_versions)]
+fn reuse_block_height(
+ version: ClarityVersion,
+ epoch: StacksEpochId,
+ mut tl_env_factory: TopLevelMemoryEnvironmentGenerator,
+) {
+ // data var
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "data-var",
+ r#"
+ (define-data-var block-height uint u1234)
+ (define-read-only (test-func)
+ (var-get block-height)
+ )
+ "#,
+ &[
+ (
+ WhenError::Initialization,
+ |version, _| version < ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("block-height".to_string()),
+ ),
+ (
+ WhenError::Analysis,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::ReservedWord("block-height".to_string()),
+ ),
+ ],
+ Value::UInt(1234),
+ );
+
+ // map
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "map",
+ r#"
+ (define-map block-height uint uint)
+ (define-private (test-func)
+ (map-insert block-height u1 u2)
+ )
+ "#,
+ &[
+ (
+ WhenError::Initialization,
+ |version, _| version < ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("block-height".to_string()),
+ ),
+ (
+ WhenError::Analysis,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::ReservedWord("block-height".to_string()),
+ ),
+ ],
+ Value::Bool(true),
+ );
+
+ // let
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "let",
+ r#"
+ (define-private (test-func)
+ (let ((block-height 32))
+ block-height
+ )
+ )
+ "#,
+ &[
+ (
+ WhenError::Runtime,
+ |version, _| version < ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("block-height".to_string()),
+ ),
+ (
+ WhenError::Analysis,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::ReservedWord("block-height".to_string()),
+ ),
+ ],
+ Value::Int(32),
+ );
+
+ // match binding
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "match-binding",
+ r#"
+ (define-read-only (test-func)
+ (let ((x (if true (ok u5) (err u7))))
+ (match x
+ block-height 3
+ e 4
+ )
+ )
+ )
+ "#,
+ &[
+ (
+ WhenError::Runtime,
+ |version, _| version < ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("block-height".to_string()),
+ ),
+ (
+ WhenError::Analysis,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::ReservedWord("block-height".to_string()),
+ ),
+ ],
+ Value::Int(3),
+ );
+
+ // private function
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "function",
+ r#"
+ (define-private (block-height) true)
+ (define-private (test-func) (block-height))
+ "#,
+ &[
+ (
+ WhenError::Initialization,
+ |version, _| version < ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("block-height".to_string()),
+ ),
+ (
+ WhenError::Analysis,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::ReservedWord("block-height".to_string()),
+ ),
+ ],
+ Value::Bool(true),
+ );
+
+ // constant
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "constant",
+ r#"
+ (define-constant block-height u1234)
+ (define-read-only (test-func) block-height)
+ "#,
+ &[
+ (
+ WhenError::Initialization,
+ |version, _| version < ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("block-height".to_string()),
+ ),
+ (
+ WhenError::Analysis,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::ReservedWord("block-height".to_string()),
+ ),
+ ],
+ Value::UInt(1234),
+ );
+
+ // define-trait
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "trait",
+ r#"
+ (define-trait block-height ())
+ (define-read-only (test-func) false)
+ "#,
+ &[
+ (
+ WhenError::Initialization,
+ |version, _| version < ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("block-height".to_string()),
+ ),
+ (
+ WhenError::Analysis,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::ReservedWord("block-height".to_string()),
+ ),
+ ],
+ Value::Bool(false),
+ );
+
+ // tuple
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "tuple",
+ r#"
+ (define-read-only (test-func)
+ (get block-height { block-height: 1234 })
+ )
+ "#,
+ &[],
+ Value::Int(1234),
+ );
+
+ // define-fungible-token
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "trait",
+ r#"
+ (define-fungible-token block-height)
+ (define-read-only (test-func) false)
+ "#,
+ &[
+ (
+ WhenError::Initialization,
+ |version, _| version < ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("block-height".to_string()),
+ ),
+ (
+ WhenError::Analysis,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::ReservedWord("block-height".to_string()),
+ ),
+ ],
+ Value::Bool(false),
+ );
+
+ // define-non-fungible-token
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "trait",
+ r#"
+ (define-non-fungible-token block-height uint)
+ (define-read-only (test-func) false)
+ "#,
+ &[
+ (
+ WhenError::Initialization,
+ |version, _| version < ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("block-height".to_string()),
+ ),
+ (
+ WhenError::Analysis,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::ReservedWord("block-height".to_string()),
+ ),
+ ],
+ Value::Bool(false),
+ );
+
+ // define-public
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "function",
+ r#"
+ (define-public (block-height) (ok true))
+ (define-private (test-func) (unwrap-panic (block-height)))
+ "#,
+ &[
+ (
+ WhenError::Initialization,
+ |version, _| version < ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("block-height".to_string()),
+ ),
+ (
+ WhenError::Analysis,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::ReservedWord("block-height".to_string()),
+ ),
+ ],
+ Value::Bool(true),
+ );
+
+ // define-read-only
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "function",
+ r#"
+ (define-read-only (block-height) true)
+ (define-private (test-func) (block-height))
+ "#,
+ &[
+ (
+ WhenError::Initialization,
+ |version, _| version < ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("block-height".to_string()),
+ ),
+ (
+ WhenError::Analysis,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::ReservedWord("block-height".to_string()),
+ ),
+ ],
+ Value::Bool(true),
+ );
+}
+
+#[apply(test_clarity_versions)]
+fn reuse_stacks_block_height(
+ version: ClarityVersion,
+ epoch: StacksEpochId,
+ mut tl_env_factory: TopLevelMemoryEnvironmentGenerator,
+) {
+ // data var
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "data-var",
+ r#"
+ (define-data-var stacks-block-height uint u1234)
+ (define-read-only (test-func)
+ (var-get stacks-block-height)
+ )
+ "#,
+ &[(
+ WhenError::Initialization,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("stacks-block-height".to_string()),
+ )],
+ Value::UInt(1234),
+ );
+
+ // map
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "map",
+ r#"
+ (define-map stacks-block-height uint uint)
+ (define-private (test-func)
+ (map-insert stacks-block-height u1 u2)
+ )
+ "#,
+ &[(
+ WhenError::Initialization,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("stacks-block-height".to_string()),
+ )],
+ Value::Bool(true),
+ );
+
+ // let
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "let",
+ r#"
+ (define-private (test-func)
+ (let ((stacks-block-height 32))
+ stacks-block-height
+ )
+ )
+ "#,
+ &[(
+ WhenError::Runtime,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("stacks-block-height".to_string()),
+ )],
+ Value::Int(32),
+ );
+
+ // match binding
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "match-binding",
+ r#"
+ (define-read-only (test-func)
+ (let ((x (if true (ok u5) (err u7))))
+ (match x
+ stacks-block-height 3
+ e 4
+ )
+ )
+ )
+ "#,
+ &[(
+ WhenError::Runtime,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("stacks-block-height".to_string()),
+ )],
+ Value::Int(3),
+ );
+
+ // function
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "function",
+ r#"
+ (define-private (stacks-block-height) true)
+ (define-private (test-func) (stacks-block-height))
+ "#,
+ &[(
+ WhenError::Initialization,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("stacks-block-height".to_string()),
+ )],
+ Value::Bool(true),
+ );
+
+ // constant
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "constant",
+ r#"
+ (define-constant stacks-block-height u1234)
+ (define-read-only (test-func) stacks-block-height)
+ "#,
+ &[(
+ WhenError::Initialization,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("stacks-block-height".to_string()),
+ )],
+ Value::UInt(1234),
+ );
+
+ // define-trait
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "trait",
+ r#"
+ (define-trait stacks-block-height ())
+ (define-read-only (test-func) false)
+ "#,
+ &[(
+ WhenError::Initialization,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("stacks-block-height".to_string()),
+ )],
+ Value::Bool(false),
+ );
+
+ // tuple
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "tuple",
+ r#"
+ (define-read-only (test-func)
+ (get stacks-block-height { stacks-block-height: 1234 })
+ )
+ "#,
+ &[],
+ Value::Int(1234),
+ );
+
+ // define-fungible-token
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "trait",
+ r#"
+ (define-fungible-token stacks-block-height)
+ (define-read-only (test-func) false)
+ "#,
+ &[(
+ WhenError::Initialization,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("stacks-block-height".to_string()),
+ )],
+ Value::Bool(false),
+ );
+
+ // define-non-fungible-token
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "trait",
+ r#"
+ (define-non-fungible-token stacks-block-height uint)
+ (define-read-only (test-func) false)
+ "#,
+ &[(
+ WhenError::Initialization,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("stacks-block-height".to_string()),
+ )],
+ Value::Bool(false),
+ );
+
+ // define-public
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "function",
+ r#"
+ (define-public (stacks-block-height) (ok true))
+ (define-private (test-func) (unwrap-panic (stacks-block-height)))
+ "#,
+ &[(
+ WhenError::Initialization,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("stacks-block-height".to_string()),
+ )],
+ Value::Bool(true),
+ );
+
+ // define-read-only
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "function",
+ r#"
+ (define-read-only (stacks-block-height) true)
+ (define-private (test-func) (stacks-block-height))
+ "#,
+ &[(
+ WhenError::Initialization,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("stacks-block-height".to_string()),
+ )],
+ Value::Bool(true),
+ );
+}
+
+#[apply(test_clarity_versions)]
+fn reuse_tenure_height(
+ version: ClarityVersion,
+ epoch: StacksEpochId,
+ mut tl_env_factory: TopLevelMemoryEnvironmentGenerator,
+) {
+ // data var
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "data-var",
+ r#"
+ (define-data-var tenure-height uint u1234)
+ (define-read-only (test-func)
+ (var-get tenure-height)
+ )
+ "#,
+ &[(
+ WhenError::Initialization,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("tenure-height".to_string()),
+ )],
+ Value::UInt(1234),
+ );
+
+ // map
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "map",
+ r#"
+ (define-map tenure-height uint uint)
+ (define-private (test-func)
+ (map-insert tenure-height u1 u2)
+ )
+ "#,
+ &[(
+ WhenError::Initialization,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("tenure-height".to_string()),
+ )],
+ Value::Bool(true),
+ );
+
+ // let
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "let",
+ r#"
+ (define-private (test-func)
+ (let ((tenure-height 32))
+ tenure-height
+ )
+ )
+ "#,
+ &[(
+ WhenError::Runtime,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("tenure-height".to_string()),
+ )],
+ Value::Int(32),
+ );
+
+ // match binding
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "match-binding",
+ r#"
+ (define-read-only (test-func)
+ (let ((x (if true (ok u5) (err u7))))
+ (match x
+ tenure-height 3
+ e 4
+ )
+ )
+ )
+ "#,
+ &[(
+ WhenError::Runtime,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("tenure-height".to_string()),
+ )],
+ Value::Int(3),
+ );
+
+ // function
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "function",
+ r#"
+ (define-private (tenure-height) true)
+ (define-private (test-func) (tenure-height))
+ "#,
+ &[(
+ WhenError::Initialization,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("tenure-height".to_string()),
+ )],
+ Value::Bool(true),
+ );
+
+ // constant
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "constant",
+ r#"
+ (define-constant tenure-height u1234)
+ (define-read-only (test-func) tenure-height)
+ "#,
+ &[(
+ WhenError::Initialization,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("tenure-height".to_string()),
+ )],
+ Value::UInt(1234),
+ );
+
+ // define-trait
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "trait",
+ r#"
+ (define-trait tenure-height ())
+ (define-read-only (test-func) false)
+ "#,
+ &[(
+ WhenError::Initialization,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("tenure-height".to_string()),
+ )],
+ Value::Bool(false),
+ );
+
+ // tuple
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "tuple",
+ r#"
+ (define-read-only (test-func)
+ (get tenure-height { tenure-height: 1234 })
+ )
+ "#,
+ &[],
+ Value::Int(1234),
+ );
+
+ // define-fungible-token
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "trait",
+ r#"
+ (define-fungible-token tenure-height)
+ (define-read-only (test-func) false)
+ "#,
+ &[(
+ WhenError::Initialization,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("tenure-height".to_string()),
+ )],
+ Value::Bool(false),
+ );
+
+ // define-non-fungible-token
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "trait",
+ r#"
+ (define-non-fungible-token tenure-height uint)
+ (define-read-only (test-func) false)
+ "#,
+ &[(
+ WhenError::Initialization,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("tenure-height".to_string()),
+ )],
+ Value::Bool(false),
+ );
+
+ // define-public
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "function",
+ r#"
+ (define-public (tenure-height) (ok true))
+ (define-private (test-func) (unwrap-panic (tenure-height)))
+ "#,
+ &[(
+ WhenError::Initialization,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("tenure-height".to_string()),
+ )],
+ Value::Bool(true),
+ );
+
+ // define-read-only
+ expect_contract_error(
+ version,
+ epoch,
+ &mut tl_env_factory,
+ "function",
+ r#"
+ (define-read-only (tenure-height) true)
+ (define-private (test-func) (tenure-height))
+ "#,
+ &[(
+ WhenError::Initialization,
+ |version, _| version >= ClarityVersion::Clarity3,
+ CheckErrors::NameAlreadyUsed("tenure-height".to_string()),
+ )],
+ Value::Bool(true),
+ );
+}
diff --git a/clarity/src/vm/tooling/mod.rs b/clarity/src/vm/tooling/mod.rs
new file mode 100644
index 00000000000..f218b2ccab5
--- /dev/null
+++ b/clarity/src/vm/tooling/mod.rs
@@ -0,0 +1,60 @@
+use std::collections::{BTreeMap, HashMap, HashSet};
+
+use stacks_common::consts::CHAIN_ID_TESTNET;
+use stacks_common::types::StacksEpochId;
+
+use super::analysis::ContractAnalysis;
+use super::contexts::GlobalContext;
+use super::docs::contracts::ContractRef;
+use super::types::TypeSignature;
+use super::{eval_all, ClarityVersion, ContractContext, Error as VmError, Value};
+use crate::vm::analysis::{run_analysis, CheckResult};
+use crate::vm::ast::{build_ast_with_rules, ASTRules};
+use crate::vm::costs::LimitedCostTracker;
+use crate::vm::database::MemoryBackingStore;
+use crate::vm::types::QualifiedContractIdentifier;
+
+/// Used by CLI tools like the docs generator. Not used in production
+pub fn mem_type_check(
+ snippet: &str,
+ version: ClarityVersion,
+ epoch: StacksEpochId,
+) -> CheckResult<(Option, ContractAnalysis)> {
+ let contract_identifier = QualifiedContractIdentifier::transient();
+ let mut contract = build_ast_with_rules(
+ &contract_identifier,
+ snippet,
+ &mut (),
+ version,
+ epoch,
+ ASTRules::PrecheckSize,
+ )
+ .unwrap()
+ .expressions;
+
+ let mut marf = MemoryBackingStore::new();
+ let mut analysis_db = marf.as_analysis_db();
+ let cost_tracker = LimitedCostTracker::new_free();
+ match run_analysis(
+ &QualifiedContractIdentifier::transient(),
+ &mut contract,
+ &mut analysis_db,
+ false,
+ cost_tracker,
+ epoch,
+ version,
+ true,
+ ) {
+ Ok(x) => {
+ // return the first type result of the type checker
+ let first_type = x
+ .type_map
+ .as_ref()
+ .unwrap()
+ .get_type_expected(&x.expressions.last().unwrap())
+ .cloned();
+ Ok((first_type, x))
+ }
+ Err((e, _)) => Err(e),
+ }
+}
diff --git a/clarity/src/vm/types/mod.rs b/clarity/src/vm/types/mod.rs
index 46734dcc517..e1837ee0343 100644
--- a/clarity/src/vm/types/mod.rs
+++ b/clarity/src/vm/types/mod.rs
@@ -732,6 +732,22 @@ define_named_enum!(BurnBlockInfoProperty {
PoxAddrs("pox-addrs"),
});
+define_named_enum!(StacksBlockInfoProperty {
+ IndexHeaderHash("id-header-hash"),
+ HeaderHash("header-hash"),
+ Time("time"),
+});
+
+define_named_enum!(TenureInfoProperty {
+ Time("time"),
+ VrfSeed("vrf-seed"),
+ BurnchainHeaderHash("burnchain-header-hash"),
+ MinerAddress("miner-address"),
+ MinerSpendWinner("miner-spend-winner"),
+ MinerSpendTotal("miner-spend-total"),
+ BlockReward("block-reward"),
+});
+
impl OptionalData {
pub fn type_signature(&self) -> std::result::Result {
let type_result = match self.data {
@@ -771,19 +787,6 @@ impl BlockInfoProperty {
MinerAddress => TypeSignature::PrincipalType,
}
}
-
- pub fn lookup_by_name_at_version(
- name: &str,
- version: &ClarityVersion,
- ) -> Option {
- BlockInfoProperty::lookup_by_name(name).and_then(|native_function| {
- if &native_function.get_version() <= version {
- Some(native_function)
- } else {
- None
- }
- })
- }
}
impl BurnBlockInfoProperty {
@@ -819,6 +822,27 @@ impl BurnBlockInfoProperty {
}
}
+impl StacksBlockInfoProperty {
+ pub fn type_result(&self) -> TypeSignature {
+ use self::StacksBlockInfoProperty::*;
+ match self {
+ Time => TypeSignature::UIntType,
+ IndexHeaderHash | HeaderHash => BUFF_32.clone(),
+ }
+ }
+}
+
+impl TenureInfoProperty {
+ pub fn type_result(&self) -> TypeSignature {
+ use self::TenureInfoProperty::*;
+ match self {
+ Time | MinerSpendWinner | MinerSpendTotal | BlockReward => TypeSignature::UIntType,
+ VrfSeed | BurnchainHeaderHash => BUFF_32.clone(),
+ MinerAddress => TypeSignature::PrincipalType,
+ }
+ }
+}
+
impl PartialEq for ListData {
fn eq(&self, other: &ListData) -> bool {
self.data == other.data
@@ -1529,9 +1553,7 @@ impl TupleData {
self.data_map.is_empty()
}
- ///TODO: #4587 create default for TupleData, then check if the mutation tests are caught for the case:
- /// Ok((Default::default()))
- /// Or keep the skip and remove the comment
+ // TODO: add tests from mutation testing results #4833
#[cfg_attr(test, mutants::skip)]
pub fn from_data(data: Vec<(ClarityName, Value)>) -> Result {
let mut type_map = BTreeMap::new();
@@ -1549,9 +1571,7 @@ impl TupleData {
Self::new(TupleTypeSignature::try_from(type_map)?, data_map)
}
- ///TODO: #4587 create default for TupleData, then check if the mutation tests are caught for the case:
- /// Ok((Default::default()))
- /// Or keep the skip and remove the comment
+ // TODO: add tests from mutation testing results #4834
#[cfg_attr(test, mutants::skip)]
pub fn from_data_typed(
epoch: &StacksEpochId,
diff --git a/clarity/src/vm/types/signatures.rs b/clarity/src/vm/types/signatures.rs
index c9971f97aeb..280258e0266 100644
--- a/clarity/src/vm/types/signatures.rs
+++ b/clarity/src/vm/types/signatures.rs
@@ -15,8 +15,10 @@
// along with this program. If not, see .
use std::collections::btree_map::Entry;
-use std::collections::{hash_map, BTreeMap, HashMap};
+use std::collections::{hash_map, BTreeMap};
use std::hash::{Hash, Hasher};
+use std::ops::Deref;
+use std::sync::Arc;
use std::{cmp, fmt};
// TypeSignatures
@@ -76,7 +78,36 @@ impl AssetIdentifier {
#[derive(Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct TupleTypeSignature {
- type_map: HashMap,
+ #[serde(with = "tuple_type_map_serde")]
+ type_map: Arc>,
+}
+
+mod tuple_type_map_serde {
+ use std::collections::BTreeMap;
+ use std::ops::Deref;
+ use std::sync::Arc;
+
+ use serde::{Deserializer, Serializer};
+
+ use super::TypeSignature;
+ use crate::vm::ClarityName;
+
+ pub fn serialize(
+ map: &Arc>,
+ ser: S,
+ ) -> Result {
+ serde::Serialize::serialize(map.deref(), ser)
+ }
+
+ pub fn deserialize<'de, D>(
+ deser: D,
+ ) -> Result>, D::Error>
+ where
+ D: Deserializer<'de>,
+ {
+ let map = serde::Deserialize::deserialize(deser)?;
+ Ok(Arc::new(map))
+ }
}
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize)]
@@ -787,12 +818,12 @@ impl TypeSignature {
inner_type.1.canonicalize_v2_1(),
))),
TupleType(ref tuple_sig) => {
- let mut canonicalized_fields = HashMap::new();
+ let mut canonicalized_fields = BTreeMap::new();
for (field_name, field_type) in tuple_sig.get_type_map() {
canonicalized_fields.insert(field_name.clone(), field_type.canonicalize_v2_1());
}
TypeSignature::from(TupleTypeSignature {
- type_map: canonicalized_fields,
+ type_map: Arc::new(canonicalized_fields),
})
}
TraitReferenceType(trait_id) => CallableType(CallableSubtype::Trait(trait_id.clone())),
@@ -851,9 +882,9 @@ impl TryFrom> for TupleTypeSignature {
return Err(CheckErrors::EmptyTuplesNotAllowed);
}
- let mut type_map = HashMap::new();
+ let mut type_map = BTreeMap::new();
for (name, type_info) in type_data.into_iter() {
- if let hash_map::Entry::Vacant(e) = type_map.entry(name.clone()) {
+ if let Entry::Vacant(e) = type_map.entry(name.clone()) {
e.insert(type_info);
} else {
return Err(CheckErrors::NameAlreadyUsed(name.into()));
@@ -874,30 +905,7 @@ impl TryFrom> for TupleTypeSignature {
return Err(CheckErrors::TypeSignatureTooDeep);
}
}
- let type_map = type_map.into_iter().collect();
- let result = TupleTypeSignature { type_map };
- let would_be_size = result
- .inner_size()?
- .ok_or_else(|| CheckErrors::ValueTooLarge)?;
- if would_be_size > MAX_VALUE_SIZE {
- Err(CheckErrors::ValueTooLarge)
- } else {
- Ok(result)
- }
- }
-}
-
-impl TryFrom> for TupleTypeSignature {
- type Error = CheckErrors;
- fn try_from(type_map: HashMap) -> Result {
- if type_map.is_empty() {
- return Err(CheckErrors::EmptyTuplesNotAllowed);
- }
- for child_sig in type_map.values() {
- if (1 + child_sig.depth()) > MAX_TYPE_DEPTH {
- return Err(CheckErrors::TypeSignatureTooDeep);
- }
- }
+ let type_map = Arc::new(type_map.into_iter().collect());
let result = TupleTypeSignature { type_map };
let would_be_size = result
.inner_size()?
@@ -925,7 +933,7 @@ impl TupleTypeSignature {
self.type_map.get(field)
}
- pub fn get_type_map(&self) -> &HashMap {
+ pub fn get_type_map(&self) -> &BTreeMap {
&self.type_map
}
@@ -961,7 +969,7 @@ impl TupleTypeSignature {
}
pub fn shallow_merge(&mut self, update: &mut TupleTypeSignature) {
- self.type_map.extend(update.type_map.drain());
+ Arc::make_mut(&mut self.type_map).append(Arc::make_mut(&mut update.type_map));
}
}
@@ -1648,7 +1656,9 @@ impl TypeSignature {
clarity_version: ClarityVersion,
) -> Result> {
let mut trait_signature: BTreeMap = BTreeMap::new();
- let functions_types = type_args[0]
+ let functions_types = type_args
+ .get(0)
+ .ok_or_else(|| CheckErrors::InvalidTypeDescription)?
.match_list()
.ok_or(CheckErrors::DefineTraitBadSignature)?;
diff --git a/clarity/src/vm/variables.rs b/clarity/src/vm/variables.rs
index 539e14c39e4..a5947d00cd2 100644
--- a/clarity/src/vm/variables.rs
+++ b/clarity/src/vm/variables.rs
@@ -14,6 +14,8 @@
// You should have received a copy of the GNU General Public License
// along with this program. If not, see .
+use stacks_common::types::StacksEpochId;
+
use super::errors::InterpreterError;
use crate::vm::contexts::{Environment, LocalContext};
use crate::vm::costs::cost_functions::ClarityCostFunction;
@@ -22,36 +24,23 @@ use crate::vm::errors::{InterpreterResult as Result, RuntimeErrorType};
use crate::vm::types::{BuffData, Value};
use crate::vm::ClarityVersion;
-define_versioned_named_enum!(NativeVariables(ClarityVersion) {
- ContractCaller("contract-caller", ClarityVersion::Clarity1),
- TxSender("tx-sender", ClarityVersion::Clarity1),
- BlockHeight("block-height", ClarityVersion::Clarity1),
- BurnBlockHeight("burn-block-height", ClarityVersion::Clarity1),
- NativeNone("none", ClarityVersion::Clarity1),
- NativeTrue("true", ClarityVersion::Clarity1),
- NativeFalse("false", ClarityVersion::Clarity1),
- TotalLiquidMicroSTX("stx-liquid-supply", ClarityVersion::Clarity1),
- Regtest("is-in-regtest", ClarityVersion::Clarity1),
- TxSponsor("tx-sponsor?", ClarityVersion::Clarity2),
- Mainnet("is-in-mainnet", ClarityVersion::Clarity2),
- ChainId("chain-id", ClarityVersion::Clarity2),
+define_versioned_named_enum_with_max!(NativeVariables(ClarityVersion) {
+ ContractCaller("contract-caller", ClarityVersion::Clarity1, None),
+ TxSender("tx-sender", ClarityVersion::Clarity1, None),
+ BlockHeight("block-height", ClarityVersion::Clarity1, Some(ClarityVersion::Clarity2)),
+ BurnBlockHeight("burn-block-height", ClarityVersion::Clarity1, None),
+ NativeNone("none", ClarityVersion::Clarity1, None),
+ NativeTrue("true", ClarityVersion::Clarity1, None),
+ NativeFalse("false", ClarityVersion::Clarity1, None),
+ TotalLiquidMicroSTX("stx-liquid-supply", ClarityVersion::Clarity1, None),
+ Regtest("is-in-regtest", ClarityVersion::Clarity1, None),
+ TxSponsor("tx-sponsor?", ClarityVersion::Clarity2, None),
+ Mainnet("is-in-mainnet", ClarityVersion::Clarity2, None),
+ ChainId("chain-id", ClarityVersion::Clarity2, None),
+ StacksBlockHeight("stacks-block-height", ClarityVersion::Clarity3, None),
+ TenureHeight("tenure-height", ClarityVersion::Clarity3, None),
});
-impl NativeVariables {
- pub fn lookup_by_name_at_version(
- name: &str,
- version: &ClarityVersion,
- ) -> Option {
- NativeVariables::lookup_by_name(name).and_then(|native_function| {
- if &native_function.get_version() <= version {
- Some(native_function)
- } else {
- None
- }
- })
- }
-}
-
pub fn is_reserved_name(name: &str, version: &ClarityVersion) -> bool {
NativeVariables::lookup_by_name_at_version(name, version).is_some()
}
@@ -92,8 +81,19 @@ pub fn lookup_reserved_variable(
}
NativeVariables::BlockHeight => {
runtime_cost(ClarityCostFunction::FetchVar, env, 1)?;
- let block_height = env.global_context.database.get_current_block_height();
- Ok(Some(Value::UInt(block_height as u128)))
+ // In epoch 2.x, the `block-height` keyword returns the Stacks block height.
+ // For Clarity 1 and Clarity 2 contracts executing in epoch 3, `block-height`
+ // is equal to the tenure height instead of the Stacks block height. This change
+ // is made to maintain a similar pace at which this value increments (e.g. for use
+ // as an expiration). In Clarity 3, `block-height` is removed to avoid confusion.
+ // It is replaced with two new keywords: `stacks-block-height` and `tenure-height`.
+ if env.global_context.epoch_id < StacksEpochId::Epoch30 {
+ let block_height = env.global_context.database.get_current_block_height();
+ Ok(Some(Value::UInt(block_height as u128)))
+ } else {
+ let tenure_height = env.global_context.database.get_tenure_height()?;
+ Ok(Some(Value::UInt(tenure_height as u128)))
+ }
}
NativeVariables::BurnBlockHeight => {
runtime_cost(ClarityCostFunction::FetchVar, env, 1)?;
@@ -123,6 +123,16 @@ pub fn lookup_reserved_variable(
let chain_id = env.global_context.chain_id;
Ok(Some(Value::UInt(chain_id.into())))
}
+ NativeVariables::StacksBlockHeight => {
+ runtime_cost(ClarityCostFunction::FetchVar, env, 1)?;
+ let block_height = env.global_context.database.get_current_block_height();
+ Ok(Some(Value::UInt(block_height as u128)))
+ }
+ NativeVariables::TenureHeight => {
+ runtime_cost(ClarityCostFunction::FetchVar, env, 1)?;
+ let tenure_height = env.global_context.database.get_tenure_height()?;
+ Ok(Some(Value::UInt(tenure_height as u128)))
+ }
}
} else {
Ok(None)
diff --git a/clarity/src/vm/version.rs b/clarity/src/vm/version.rs
index f64d4ee8784..4c437d52ccc 100644
--- a/clarity/src/vm/version.rs
+++ b/clarity/src/vm/version.rs
@@ -9,6 +9,7 @@ use crate::vm::errors::{Error, RuntimeErrorType};
pub enum ClarityVersion {
Clarity1,
Clarity2,
+ Clarity3,
}
impl fmt::Display for ClarityVersion {
@@ -16,13 +17,14 @@ impl fmt::Display for ClarityVersion {
match self {
ClarityVersion::Clarity1 => write!(f, "Clarity 1"),
ClarityVersion::Clarity2 => write!(f, "Clarity 2"),
+ ClarityVersion::Clarity3 => write!(f, "Clarity 3"),
}
}
}
impl ClarityVersion {
pub fn latest() -> ClarityVersion {
- ClarityVersion::Clarity2
+ ClarityVersion::Clarity3
}
pub fn default_for_epoch(epoch_id: StacksEpochId) -> ClarityVersion {
match epoch_id {
@@ -37,7 +39,7 @@ impl ClarityVersion {
StacksEpochId::Epoch23 => ClarityVersion::Clarity2,
StacksEpochId::Epoch24 => ClarityVersion::Clarity2,
StacksEpochId::Epoch25 => ClarityVersion::Clarity2,
- StacksEpochId::Epoch30 => ClarityVersion::Clarity2,
+ StacksEpochId::Epoch30 => ClarityVersion::Clarity3,
}
}
}
@@ -51,9 +53,12 @@ impl FromStr for ClarityVersion {
Ok(ClarityVersion::Clarity1)
} else if s == "clarity2" {
Ok(ClarityVersion::Clarity2)
+ } else if s == "clarity3" {
+ Ok(ClarityVersion::Clarity3)
} else {
Err(RuntimeErrorType::ParseError(
- "Invalid clarity version. Valid versions are: Clarity1, Clarity2.".to_string(),
+ "Invalid clarity version. Valid versions are: Clarity1, Clarity2, Clarity3."
+ .to_string(),
)
.into())
}
diff --git a/contrib/boot-contracts-stateful-prop-tests/.gitignore b/contrib/boot-contracts-stateful-prop-tests/.gitignore
new file mode 100644
index 00000000000..393158bd1c0
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/.gitignore
@@ -0,0 +1,8 @@
+logs
+*.log
+npm-debug.log*
+coverage
+*.info
+costs-reports.json
+node_modules
+history.txt
diff --git a/contrib/boot-contracts-stateful-prop-tests/Clarinet.toml b/contrib/boot-contracts-stateful-prop-tests/Clarinet.toml
new file mode 100644
index 00000000000..f0d404a755c
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/Clarinet.toml
@@ -0,0 +1,2 @@
+[project]
+name = "boot-contracts-stateful-prop-tests"
diff --git a/contrib/boot-contracts-stateful-prop-tests/deployments/default.simnet-plan.yaml b/contrib/boot-contracts-stateful-prop-tests/deployments/default.simnet-plan.yaml
new file mode 100644
index 00000000000..1837aee68a4
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/deployments/default.simnet-plan.yaml
@@ -0,0 +1,52 @@
+---
+id: 0
+name: "Simulated deployment, used as a default for `clarinet console`, `clarinet test` and `clarinet check`"
+network: simnet
+genesis:
+ wallets:
+ - name: deployer
+ address: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
+ balance: "100000000000000"
+ - name: wallet_1
+ address: ST1SJ3DTE5DN7X54YDH5D64R3BCB6A2AG2ZQ8YPD5
+ balance: "100000000000000"
+ - name: wallet_2
+ address: ST2CY5V39NHDPWSXMW9QDT3HC3GD6Q6XX4CFRK9AG
+ balance: "100000000000000"
+ - name: wallet_3
+ address: ST2JHG361ZXG51QTKY2NQCVBPPRRE2KZB1HR05NNC
+ balance: "100000000000000"
+ - name: wallet_4
+ address: ST2NEB84ASENDXKYGJPQW86YXQCEFEX2ZQPG87ND
+ balance: "100000000000000"
+ - name: wallet_5
+ address: ST2REHHS5J3CERCRBEPMGH7921Q6PYKAADT7JP2VB
+ balance: "100000000000000"
+ - name: wallet_6
+ address: ST3AM1A56AK2C1XAFJ4115ZSV26EB49BVQ10MGCS0
+ balance: "100000000000000"
+ - name: wallet_7
+ address: ST3PF13W7Z0RRM42A8VZRVFQ75SV1K26RXEP8YGKJ
+ balance: "100000000000000"
+ - name: wallet_8
+ address: ST3NBRSFKX28FQ2ZJ1MAKX58HKHSDGNV5N7R21XCP
+ balance: "100000000000000"
+ - name: wallet_9
+ address: STNHKEPYEPJ8ET55ZZ0M5A34J0R3N5FM2CMMMAZ6
+ balance: "100000000000000"
+ contracts:
+ - costs
+ - pox
+ - pox-2
+ - pox-3
+ - pox-4
+ - lockup
+ - costs-2
+ - costs-3
+ - cost-voting
+ - bns
+plan:
+ batches:
+ - id: 0
+ transactions: []
+ epoch: "2.4"
diff --git a/contrib/boot-contracts-stateful-prop-tests/package-lock.json b/contrib/boot-contracts-stateful-prop-tests/package-lock.json
new file mode 100644
index 00000000000..e3040db2e21
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/package-lock.json
@@ -0,0 +1,2394 @@
+{
+ "name": "boot-contracts-stateful-prop-tests",
+ "version": "1.0.0",
+ "lockfileVersion": 3,
+ "requires": true,
+ "packages": {
+ "": {
+ "name": "boot-contracts-stateful-prop-tests",
+ "version": "1.0.0",
+ "license": "ISC",
+ "dependencies": {
+ "@hirosystems/clarinet-sdk": "^2.6.0",
+ "@stacks/stacking": "^6.14.0",
+ "@stacks/transactions": "^6.13.1",
+ "chokidar-cli": "^3.0.0",
+ "fast-check": "^3.18.0",
+ "typescript": "^5.4.5",
+ "vite": "^5.2.10",
+ "vitest": "^1.5.2",
+ "vitest-environment-clarinet": "^2.1.0"
+ }
+ },
+ "node_modules/@esbuild/aix-ppc64": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.20.2.tgz",
+ "integrity": "sha512-D+EBOJHXdNZcLJRBkhENNG8Wji2kgc9AZ9KiPr1JuZjsNtyHzrsfLRrY0tk2H2aoFu6RANO1y1iPPUCDYWkb5g==",
+ "cpu": [
+ "ppc64"
+ ],
+ "optional": true,
+ "os": [
+ "aix"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/android-arm": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.20.2.tgz",
+ "integrity": "sha512-t98Ra6pw2VaDhqNWO2Oph2LXbz/EJcnLmKLGBJwEwXX/JAN83Fym1rU8l0JUWK6HkIbWONCSSatf4sf2NBRx/w==",
+ "cpu": [
+ "arm"
+ ],
+ "optional": true,
+ "os": [
+ "android"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/android-arm64": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.20.2.tgz",
+ "integrity": "sha512-mRzjLacRtl/tWU0SvD8lUEwb61yP9cqQo6noDZP/O8VkwafSYwZ4yWy24kan8jE/IMERpYncRt2dw438LP3Xmg==",
+ "cpu": [
+ "arm64"
+ ],
+ "optional": true,
+ "os": [
+ "android"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/android-x64": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.20.2.tgz",
+ "integrity": "sha512-btzExgV+/lMGDDa194CcUQm53ncxzeBrWJcncOBxuC6ndBkKxnHdFJn86mCIgTELsooUmwUm9FkhSp5HYu00Rg==",
+ "cpu": [
+ "x64"
+ ],
+ "optional": true,
+ "os": [
+ "android"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/darwin-arm64": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.20.2.tgz",
+ "integrity": "sha512-4J6IRT+10J3aJH3l1yzEg9y3wkTDgDk7TSDFX+wKFiWjqWp/iCfLIYzGyasx9l0SAFPT1HwSCR+0w/h1ES/MjA==",
+ "cpu": [
+ "arm64"
+ ],
+ "optional": true,
+ "os": [
+ "darwin"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/darwin-x64": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.20.2.tgz",
+ "integrity": "sha512-tBcXp9KNphnNH0dfhv8KYkZhjc+H3XBkF5DKtswJblV7KlT9EI2+jeA8DgBjp908WEuYll6pF+UStUCfEpdysA==",
+ "cpu": [
+ "x64"
+ ],
+ "optional": true,
+ "os": [
+ "darwin"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/freebsd-arm64": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.20.2.tgz",
+ "integrity": "sha512-d3qI41G4SuLiCGCFGUrKsSeTXyWG6yem1KcGZVS+3FYlYhtNoNgYrWcvkOoaqMhwXSMrZRl69ArHsGJ9mYdbbw==",
+ "cpu": [
+ "arm64"
+ ],
+ "optional": true,
+ "os": [
+ "freebsd"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/freebsd-x64": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.20.2.tgz",
+ "integrity": "sha512-d+DipyvHRuqEeM5zDivKV1KuXn9WeRX6vqSqIDgwIfPQtwMP4jaDsQsDncjTDDsExT4lR/91OLjRo8bmC1e+Cw==",
+ "cpu": [
+ "x64"
+ ],
+ "optional": true,
+ "os": [
+ "freebsd"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/linux-arm": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.20.2.tgz",
+ "integrity": "sha512-VhLPeR8HTMPccbuWWcEUD1Az68TqaTYyj6nfE4QByZIQEQVWBB8vup8PpR7y1QHL3CpcF6xd5WVBU/+SBEvGTg==",
+ "cpu": [
+ "arm"
+ ],
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/linux-arm64": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.20.2.tgz",
+ "integrity": "sha512-9pb6rBjGvTFNira2FLIWqDk/uaf42sSyLE8j1rnUpuzsODBq7FvpwHYZxQ/It/8b+QOS1RYfqgGFNLRI+qlq2A==",
+ "cpu": [
+ "arm64"
+ ],
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/linux-ia32": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.20.2.tgz",
+ "integrity": "sha512-o10utieEkNPFDZFQm9CoP7Tvb33UutoJqg3qKf1PWVeeJhJw0Q347PxMvBgVVFgouYLGIhFYG0UGdBumROyiig==",
+ "cpu": [
+ "ia32"
+ ],
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/linux-loong64": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.20.2.tgz",
+ "integrity": "sha512-PR7sp6R/UC4CFVomVINKJ80pMFlfDfMQMYynX7t1tNTeivQ6XdX5r2XovMmha/VjR1YN/HgHWsVcTRIMkymrgQ==",
+ "cpu": [
+ "loong64"
+ ],
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/linux-mips64el": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.20.2.tgz",
+ "integrity": "sha512-4BlTqeutE/KnOiTG5Y6Sb/Hw6hsBOZapOVF6njAESHInhlQAghVVZL1ZpIctBOoTFbQyGW+LsVYZ8lSSB3wkjA==",
+ "cpu": [
+ "mips64el"
+ ],
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/linux-ppc64": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.20.2.tgz",
+ "integrity": "sha512-rD3KsaDprDcfajSKdn25ooz5J5/fWBylaaXkuotBDGnMnDP1Uv5DLAN/45qfnf3JDYyJv/ytGHQaziHUdyzaAg==",
+ "cpu": [
+ "ppc64"
+ ],
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/linux-riscv64": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.20.2.tgz",
+ "integrity": "sha512-snwmBKacKmwTMmhLlz/3aH1Q9T8v45bKYGE3j26TsaOVtjIag4wLfWSiZykXzXuE1kbCE+zJRmwp+ZbIHinnVg==",
+ "cpu": [
+ "riscv64"
+ ],
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/linux-s390x": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.20.2.tgz",
+ "integrity": "sha512-wcWISOobRWNm3cezm5HOZcYz1sKoHLd8VL1dl309DiixxVFoFe/o8HnwuIwn6sXre88Nwj+VwZUvJf4AFxkyrQ==",
+ "cpu": [
+ "s390x"
+ ],
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/linux-x64": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.20.2.tgz",
+ "integrity": "sha512-1MdwI6OOTsfQfek8sLwgyjOXAu+wKhLEoaOLTjbijk6E2WONYpH9ZU2mNtR+lZ2B4uwr+usqGuVfFT9tMtGvGw==",
+ "cpu": [
+ "x64"
+ ],
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/netbsd-x64": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.20.2.tgz",
+ "integrity": "sha512-K8/DhBxcVQkzYc43yJXDSyjlFeHQJBiowJ0uVL6Tor3jGQfSGHNNJcWxNbOI8v5k82prYqzPuwkzHt3J1T1iZQ==",
+ "cpu": [
+ "x64"
+ ],
+ "optional": true,
+ "os": [
+ "netbsd"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/openbsd-x64": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.20.2.tgz",
+ "integrity": "sha512-eMpKlV0SThJmmJgiVyN9jTPJ2VBPquf6Kt/nAoo6DgHAoN57K15ZghiHaMvqjCye/uU4X5u3YSMgVBI1h3vKrQ==",
+ "cpu": [
+ "x64"
+ ],
+ "optional": true,
+ "os": [
+ "openbsd"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/sunos-x64": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.20.2.tgz",
+ "integrity": "sha512-2UyFtRC6cXLyejf/YEld4Hajo7UHILetzE1vsRcGL3earZEW77JxrFjH4Ez2qaTiEfMgAXxfAZCm1fvM/G/o8w==",
+ "cpu": [
+ "x64"
+ ],
+ "optional": true,
+ "os": [
+ "sunos"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/win32-arm64": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.20.2.tgz",
+ "integrity": "sha512-GRibxoawM9ZCnDxnP3usoUDO9vUkpAxIIZ6GQI+IlVmr5kP3zUq+l17xELTHMWTWzjxa2guPNyrpq1GWmPvcGQ==",
+ "cpu": [
+ "arm64"
+ ],
+ "optional": true,
+ "os": [
+ "win32"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/win32-ia32": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.20.2.tgz",
+ "integrity": "sha512-HfLOfn9YWmkSKRQqovpnITazdtquEW8/SoHW7pWpuEeguaZI4QnCRW6b+oZTztdBnZOS2hqJ6im/D5cPzBTTlQ==",
+ "cpu": [
+ "ia32"
+ ],
+ "optional": true,
+ "os": [
+ "win32"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@esbuild/win32-x64": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.20.2.tgz",
+ "integrity": "sha512-N49X4lJX27+l9jbLKSqZ6bKNjzQvHaT8IIFUy+YIqmXQdjYCToGWwOItDrfby14c78aDd5NHQl29xingXfCdLQ==",
+ "cpu": [
+ "x64"
+ ],
+ "optional": true,
+ "os": [
+ "win32"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@hirosystems/clarinet-sdk": {
+ "version": "2.6.0",
+ "resolved": "https://registry.npmjs.org/@hirosystems/clarinet-sdk/-/clarinet-sdk-2.6.0.tgz",
+ "integrity": "sha512-8qyvpaeTmhn/Lrsg7zjNpIr9Ova1zVfzMNeBC4+y42tqxHX0j6MM58nr5m56bz5/0u+KPOvQpAhuVxGR27/NiA==",
+ "dependencies": {
+ "@hirosystems/clarinet-sdk-wasm": "^2.6.0",
+ "@stacks/encryption": "^6.13.0",
+ "@stacks/network": "^6.13.0",
+ "@stacks/stacking": "^6.13.0",
+ "@stacks/transactions": "^6.13.0",
+ "kolorist": "^1.8.0",
+ "prompts": "^2.4.2",
+ "vitest": "^1.0.4",
+ "yargs": "^17.7.2"
+ },
+ "bin": {
+ "clarinet-sdk": "dist/cjs/bin/index.js"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@hirosystems/clarinet-sdk-wasm": {
+ "version": "2.6.0",
+ "resolved": "https://registry.npmjs.org/@hirosystems/clarinet-sdk-wasm/-/clarinet-sdk-wasm-2.6.0.tgz",
+ "integrity": "sha512-cUpYrnLX4VnpnumlYTCUNf1gFfl2kL18q63C1qFzUzkjFszffR+x0U2lxOQrz3EY3/U6eWeZvZPdKbOFO3zgqQ=="
+ },
+ "node_modules/@jest/schemas": {
+ "version": "29.6.3",
+ "resolved": "https://registry.npmjs.org/@jest/schemas/-/schemas-29.6.3.tgz",
+ "integrity": "sha512-mo5j5X+jIZmJQveBKeS/clAueipV7KgiX1vMgCxam1RNYiqE1w62n0/tJJnHtjW8ZHcQco5gY85jA3mi0L+nSA==",
+ "dependencies": {
+ "@sinclair/typebox": "^0.27.8"
+ },
+ "engines": {
+ "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
+ }
+ },
+ "node_modules/@jridgewell/sourcemap-codec": {
+ "version": "1.4.15",
+ "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.15.tgz",
+ "integrity": "sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg=="
+ },
+ "node_modules/@noble/hashes": {
+ "version": "1.1.5",
+ "resolved": "https://registry.npmjs.org/@noble/hashes/-/hashes-1.1.5.tgz",
+ "integrity": "sha512-LTMZiiLc+V4v1Yi16TD6aX2gmtKszNye0pQgbaLqkvhIqP7nVsSaJsWloGQjJfJ8offaoP5GtX3yY5swbcJxxQ==",
+ "funding": [
+ {
+ "type": "individual",
+ "url": "https://paulmillr.com/funding/"
+ }
+ ]
+ },
+ "node_modules/@noble/secp256k1": {
+ "version": "1.7.1",
+ "resolved": "https://registry.npmjs.org/@noble/secp256k1/-/secp256k1-1.7.1.tgz",
+ "integrity": "sha512-hOUk6AyBFmqVrv7k5WAw/LpszxVbj9gGN4JRkIX52fdFAj1UA61KXmZDvqVEm+pOyec3+fIeZB02LYa/pWOArw==",
+ "funding": [
+ {
+ "type": "individual",
+ "url": "https://paulmillr.com/funding/"
+ }
+ ]
+ },
+ "node_modules/@rollup/rollup-android-arm-eabi": {
+ "version": "4.17.1",
+ "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.17.1.tgz",
+ "integrity": "sha512-P6Wg856Ou/DLpR+O0ZLneNmrv7QpqBg+hK4wE05ijbC/t349BRfMfx+UFj5Ha3fCFopIa6iSZlpdaB4agkWp2Q==",
+ "cpu": [
+ "arm"
+ ],
+ "optional": true,
+ "os": [
+ "android"
+ ]
+ },
+ "node_modules/@rollup/rollup-android-arm64": {
+ "version": "4.17.1",
+ "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.17.1.tgz",
+ "integrity": "sha512-piwZDjuW2WiHr05djVdUkrG5JbjnGbtx8BXQchYCMfib/nhjzWoiScelZ+s5IJI7lecrwSxHCzW026MWBL+oJQ==",
+ "cpu": [
+ "arm64"
+ ],
+ "optional": true,
+ "os": [
+ "android"
+ ]
+ },
+ "node_modules/@rollup/rollup-darwin-arm64": {
+ "version": "4.17.1",
+ "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.17.1.tgz",
+ "integrity": "sha512-LsZXXIsN5Q460cKDT4Y+bzoPDhBmO5DTr7wP80d+2EnYlxSgkwdPfE3hbE+Fk8dtya+8092N9srjBTJ0di8RIA==",
+ "cpu": [
+ "arm64"
+ ],
+ "optional": true,
+ "os": [
+ "darwin"
+ ]
+ },
+ "node_modules/@rollup/rollup-darwin-x64": {
+ "version": "4.17.1",
+ "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.17.1.tgz",
+ "integrity": "sha512-S7TYNQpWXB9APkxu/SLmYHezWwCoZRA9QLgrDeml+SR2A1LLPD2DBUdUlvmCF7FUpRMKvbeeWky+iizQj65Etw==",
+ "cpu": [
+ "x64"
+ ],
+ "optional": true,
+ "os": [
+ "darwin"
+ ]
+ },
+ "node_modules/@rollup/rollup-linux-arm-gnueabihf": {
+ "version": "4.17.1",
+ "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.17.1.tgz",
+ "integrity": "sha512-Lq2JR5a5jsA5um2ZoLiXXEaOagnVyCpCW7xvlcqHC7y46tLwTEgUSTM3a2TfmmTMmdqv+jknUioWXlmxYxE9Yw==",
+ "cpu": [
+ "arm"
+ ],
+ "optional": true,
+ "os": [
+ "linux"
+ ]
+ },
+ "node_modules/@rollup/rollup-linux-arm-musleabihf": {
+ "version": "4.17.1",
+ "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.17.1.tgz",
+ "integrity": "sha512-9BfzwyPNV0IizQoR+5HTNBGkh1KXE8BqU0DBkqMngmyFW7BfuIZyMjQ0s6igJEiPSBvT3ZcnIFohZ19OqjhDPg==",
+ "cpu": [
+ "arm"
+ ],
+ "optional": true,
+ "os": [
+ "linux"
+ ]
+ },
+ "node_modules/@rollup/rollup-linux-arm64-gnu": {
+ "version": "4.17.1",
+ "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.17.1.tgz",
+ "integrity": "sha512-e2uWaoxo/rtzA52OifrTSXTvJhAXb0XeRkz4CdHBK2KtxrFmuU/uNd544Ogkpu938BzEfvmWs8NZ8Axhw33FDw==",
+ "cpu": [
+ "arm64"
+ ],
+ "optional": true,
+ "os": [
+ "linux"
+ ]
+ },
+ "node_modules/@rollup/rollup-linux-arm64-musl": {
+ "version": "4.17.1",
+ "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.17.1.tgz",
+ "integrity": "sha512-ekggix/Bc/d/60H1Mi4YeYb/7dbal1kEDZ6sIFVAE8pUSx7PiWeEh+NWbL7bGu0X68BBIkgF3ibRJe1oFTksQQ==",
+ "cpu": [
+ "arm64"
+ ],
+ "optional": true,
+ "os": [
+ "linux"
+ ]
+ },
+ "node_modules/@rollup/rollup-linux-powerpc64le-gnu": {
+ "version": "4.17.1",
+ "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.17.1.tgz",
+ "integrity": "sha512-UGV0dUo/xCv4pkr/C8KY7XLFwBNnvladt8q+VmdKrw/3RUd3rD0TptwjisvE2TTnnlENtuY4/PZuoOYRiGp8Gw==",
+ "cpu": [
+ "ppc64"
+ ],
+ "optional": true,
+ "os": [
+ "linux"
+ ]
+ },
+ "node_modules/@rollup/rollup-linux-riscv64-gnu": {
+ "version": "4.17.1",
+ "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.17.1.tgz",
+ "integrity": "sha512-gEYmYYHaehdvX46mwXrU49vD6Euf1Bxhq9pPb82cbUU9UT2NV+RSckQ5tKWOnNXZixKsy8/cPGtiUWqzPuAcXQ==",
+ "cpu": [
+ "riscv64"
+ ],
+ "optional": true,
+ "os": [
+ "linux"
+ ]
+ },
+ "node_modules/@rollup/rollup-linux-s390x-gnu": {
+ "version": "4.17.1",
+ "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.17.1.tgz",
+ "integrity": "sha512-xeae5pMAxHFp6yX5vajInG2toST5lsCTrckSRUFwNgzYqnUjNBcQyqk1bXUxX5yhjWFl2Mnz3F8vQjl+2FRIcw==",
+ "cpu": [
+ "s390x"
+ ],
+ "optional": true,
+ "os": [
+ "linux"
+ ]
+ },
+ "node_modules/@rollup/rollup-linux-x64-gnu": {
+ "version": "4.17.1",
+ "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.17.1.tgz",
+ "integrity": "sha512-AsdnINQoDWfKpBzCPqQWxSPdAWzSgnYbrJYtn6W0H2E9It5bZss99PiLA8CgmDRfvKygt20UpZ3xkhFlIfX9zQ==",
+ "cpu": [
+ "x64"
+ ],
+ "optional": true,
+ "os": [
+ "linux"
+ ]
+ },
+ "node_modules/@rollup/rollup-linux-x64-musl": {
+ "version": "4.17.1",
+ "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.17.1.tgz",
+ "integrity": "sha512-KoB4fyKXTR+wYENkIG3fFF+5G6N4GFvzYx8Jax8BR4vmddtuqSb5oQmYu2Uu067vT/Fod7gxeQYKupm8gAcMSQ==",
+ "cpu": [
+ "x64"
+ ],
+ "optional": true,
+ "os": [
+ "linux"
+ ]
+ },
+ "node_modules/@rollup/rollup-win32-arm64-msvc": {
+ "version": "4.17.1",
+ "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.17.1.tgz",
+ "integrity": "sha512-J0d3NVNf7wBL9t4blCNat+d0PYqAx8wOoY+/9Q5cujnafbX7BmtYk3XvzkqLmFECaWvXGLuHmKj/wrILUinmQg==",
+ "cpu": [
+ "arm64"
+ ],
+ "optional": true,
+ "os": [
+ "win32"
+ ]
+ },
+ "node_modules/@rollup/rollup-win32-ia32-msvc": {
+ "version": "4.17.1",
+ "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.17.1.tgz",
+ "integrity": "sha512-xjgkWUwlq7IbgJSIxvl516FJ2iuC/7ttjsAxSPpC9kkI5iQQFHKyEN5BjbhvJ/IXIZ3yIBcW5QDlWAyrA+TFag==",
+ "cpu": [
+ "ia32"
+ ],
+ "optional": true,
+ "os": [
+ "win32"
+ ]
+ },
+ "node_modules/@rollup/rollup-win32-x64-msvc": {
+ "version": "4.17.1",
+ "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.17.1.tgz",
+ "integrity": "sha512-0QbCkfk6cnnVKWqqlC0cUrrUMDMfu5ffvYMTUHf+qMN2uAb3MKP31LPcwiMXBNsvoFGs/kYdFOsuLmvppCopXA==",
+ "cpu": [
+ "x64"
+ ],
+ "optional": true,
+ "os": [
+ "win32"
+ ]
+ },
+ "node_modules/@scure/base": {
+ "version": "1.1.6",
+ "resolved": "https://registry.npmjs.org/@scure/base/-/base-1.1.6.tgz",
+ "integrity": "sha512-ok9AWwhcgYuGG3Zfhyqg+zwl+Wn5uE+dwC0NV/2qQkx4dABbb/bx96vWu8NSj+BNjjSjno+JRYRjle1jV08k3g==",
+ "funding": {
+ "url": "https://paulmillr.com/funding/"
+ }
+ },
+ "node_modules/@scure/bip39": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/@scure/bip39/-/bip39-1.1.0.tgz",
+ "integrity": "sha512-pwrPOS16VeTKg98dYXQyIjJEcWfz7/1YJIwxUEPFfQPtc86Ym/1sVgQ2RLoD43AazMk2l/unK4ITySSpW2+82w==",
+ "funding": [
+ {
+ "type": "individual",
+ "url": "https://paulmillr.com/funding/"
+ }
+ ],
+ "dependencies": {
+ "@noble/hashes": "~1.1.1",
+ "@scure/base": "~1.1.0"
+ }
+ },
+ "node_modules/@sinclair/typebox": {
+ "version": "0.27.8",
+ "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.27.8.tgz",
+ "integrity": "sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA=="
+ },
+ "node_modules/@stacks/common": {
+ "version": "6.13.0",
+ "resolved": "https://registry.npmjs.org/@stacks/common/-/common-6.13.0.tgz",
+ "integrity": "sha512-wwzyihjaSdmL6NxKvDeayy3dqM0L0Q2sawmdNtzJDi0FnXuJGm5PeapJj7bEfcI9XwI7Bw5jZoC6mCn9nc5YIw==",
+ "dependencies": {
+ "@types/bn.js": "^5.1.0",
+ "@types/node": "^18.0.4"
+ }
+ },
+ "node_modules/@stacks/encryption": {
+ "version": "6.13.1",
+ "resolved": "https://registry.npmjs.org/@stacks/encryption/-/encryption-6.13.1.tgz",
+ "integrity": "sha512-y5IFX3/nGI3fCk70gE0JwH70GpshD8RhUfvhMLcL96oNaec1cCdj1ZUiQupeicfYTHuraaVBYU9xLls4TRmypg==",
+ "dependencies": {
+ "@noble/hashes": "1.1.5",
+ "@noble/secp256k1": "1.7.1",
+ "@scure/bip39": "1.1.0",
+ "@stacks/common": "^6.13.0",
+ "@types/node": "^18.0.4",
+ "base64-js": "^1.5.1",
+ "bs58": "^5.0.0",
+ "ripemd160-min": "^0.0.6",
+ "varuint-bitcoin": "^1.1.2"
+ }
+ },
+ "node_modules/@stacks/network": {
+ "version": "6.13.0",
+ "resolved": "https://registry.npmjs.org/@stacks/network/-/network-6.13.0.tgz",
+ "integrity": "sha512-Ss/Da4BNyPBBj1OieM981fJ7SkevKqLPkzoI1+Yo7cYR2df+0FipIN++Z4RfpJpc8ne60vgcx7nJZXQsiGhKBQ==",
+ "dependencies": {
+ "@stacks/common": "^6.13.0",
+ "cross-fetch": "^3.1.5"
+ }
+ },
+ "node_modules/@stacks/stacking": {
+ "version": "6.14.0",
+ "resolved": "https://registry.npmjs.org/@stacks/stacking/-/stacking-6.14.0.tgz",
+ "integrity": "sha512-P6ITXYpb5q4hgWMPimJW84mih3hQuQ0ko7AcnJ4SPy17nt1rxEz7/zgyRnqg1Lc18zt4HqfF9SKM7+Sqt/EMZA==",
+ "dependencies": {
+ "@noble/hashes": "1.1.5",
+ "@scure/base": "1.1.1",
+ "@stacks/common": "^6.13.0",
+ "@stacks/encryption": "^6.13.1",
+ "@stacks/network": "^6.13.0",
+ "@stacks/stacks-blockchain-api-types": "^0.61.0",
+ "@stacks/transactions": "^6.13.1",
+ "bs58": "^5.0.0"
+ }
+ },
+ "node_modules/@stacks/stacking/node_modules/@scure/base": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/@scure/base/-/base-1.1.1.tgz",
+ "integrity": "sha512-ZxOhsSyxYwLJj3pLZCefNitxsj093tb2vq90mp2txoYeBqbcjDjqFhyM8eUjq/uFm6zJ+mUuqxlS2FkuSY1MTA==",
+ "funding": [
+ {
+ "type": "individual",
+ "url": "https://paulmillr.com/funding/"
+ }
+ ]
+ },
+ "node_modules/@stacks/stacks-blockchain-api-types": {
+ "version": "0.61.0",
+ "resolved": "https://registry.npmjs.org/@stacks/stacks-blockchain-api-types/-/stacks-blockchain-api-types-0.61.0.tgz",
+ "integrity": "sha512-yPOfTUboo5eA9BZL/hqMcM71GstrFs9YWzOrJFPeP4cOO1wgYvAcckgBRbgiE3NqeX0A7SLZLDAXLZbATuRq9w=="
+ },
+ "node_modules/@stacks/transactions": {
+ "version": "6.13.1",
+ "resolved": "https://registry.npmjs.org/@stacks/transactions/-/transactions-6.13.1.tgz",
+ "integrity": "sha512-PWw2I+2Fj3CaFYQIoVcqQN6E2qGHNhFv03nuR0CxMq0sx8stPgYZbdzUlnlBcJQdsFiHrw3sPeqnXDZt+Hg5YQ==",
+ "dependencies": {
+ "@noble/hashes": "1.1.5",
+ "@noble/secp256k1": "1.7.1",
+ "@stacks/common": "^6.13.0",
+ "@stacks/network": "^6.13.0",
+ "c32check": "^2.0.0",
+ "lodash.clonedeep": "^4.5.0"
+ }
+ },
+ "node_modules/@types/bn.js": {
+ "version": "5.1.5",
+ "resolved": "https://registry.npmjs.org/@types/bn.js/-/bn.js-5.1.5.tgz",
+ "integrity": "sha512-V46N0zwKRF5Q00AZ6hWtN0T8gGmDUaUzLWQvHFo5yThtVwK/VCenFY3wXVbOvNfajEpsTfQM4IN9k/d6gUVX3A==",
+ "dependencies": {
+ "@types/node": "*"
+ }
+ },
+ "node_modules/@types/estree": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.5.tgz",
+ "integrity": "sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw=="
+ },
+ "node_modules/@types/node": {
+ "version": "18.19.31",
+ "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.31.tgz",
+ "integrity": "sha512-ArgCD39YpyyrtFKIqMDvjz79jto5fcI/SVUs2HwB+f0dAzq68yqOdyaSivLiLugSziTpNXLQrVb7RZFmdZzbhA==",
+ "dependencies": {
+ "undici-types": "~5.26.4"
+ }
+ },
+ "node_modules/@vitest/expect": {
+ "version": "1.5.2",
+ "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-1.5.2.tgz",
+ "integrity": "sha512-rf7MTD1WCoDlN3FfYJ9Llfp0PbdtOMZ3FIF0AVkDnKbp3oiMW1c8AmvRZBcqbAhDUAvF52e9zx4WQM1r3oraVA==",
+ "dependencies": {
+ "@vitest/spy": "1.5.2",
+ "@vitest/utils": "1.5.2",
+ "chai": "^4.3.10"
+ },
+ "funding": {
+ "url": "https://opencollective.com/vitest"
+ }
+ },
+ "node_modules/@vitest/runner": {
+ "version": "1.5.2",
+ "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-1.5.2.tgz",
+ "integrity": "sha512-7IJ7sJhMZrqx7HIEpv3WrMYcq8ZNz9L6alo81Y6f8hV5mIE6yVZsFoivLZmr0D777klm1ReqonE9LyChdcmw6g==",
+ "dependencies": {
+ "@vitest/utils": "1.5.2",
+ "p-limit": "^5.0.0",
+ "pathe": "^1.1.1"
+ },
+ "funding": {
+ "url": "https://opencollective.com/vitest"
+ }
+ },
+ "node_modules/@vitest/snapshot": {
+ "version": "1.5.2",
+ "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-1.5.2.tgz",
+ "integrity": "sha512-CTEp/lTYos8fuCc9+Z55Ga5NVPKUgExritjF5VY7heRFUfheoAqBneUlvXSUJHUZPjnPmyZA96yLRJDP1QATFQ==",
+ "dependencies": {
+ "magic-string": "^0.30.5",
+ "pathe": "^1.1.1",
+ "pretty-format": "^29.7.0"
+ },
+ "funding": {
+ "url": "https://opencollective.com/vitest"
+ }
+ },
+ "node_modules/@vitest/spy": {
+ "version": "1.5.2",
+ "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-1.5.2.tgz",
+ "integrity": "sha512-xCcPvI8JpCtgikT9nLpHPL1/81AYqZy1GCy4+MCHBE7xi8jgsYkULpW5hrx5PGLgOQjUpb6fd15lqcriJ40tfQ==",
+ "dependencies": {
+ "tinyspy": "^2.2.0"
+ },
+ "funding": {
+ "url": "https://opencollective.com/vitest"
+ }
+ },
+ "node_modules/@vitest/utils": {
+ "version": "1.5.2",
+ "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-1.5.2.tgz",
+ "integrity": "sha512-sWOmyofuXLJ85VvXNsroZur7mOJGiQeM0JN3/0D1uU8U9bGFM69X1iqHaRXl6R8BwaLY6yPCogP257zxTzkUdA==",
+ "dependencies": {
+ "diff-sequences": "^29.6.3",
+ "estree-walker": "^3.0.3",
+ "loupe": "^2.3.7",
+ "pretty-format": "^29.7.0"
+ },
+ "funding": {
+ "url": "https://opencollective.com/vitest"
+ }
+ },
+ "node_modules/acorn": {
+ "version": "8.11.3",
+ "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.11.3.tgz",
+ "integrity": "sha512-Y9rRfJG5jcKOE0CLisYbojUjIrIEE7AGMzA/Sm4BslANhbS+cDMpgBdcPT91oJ7OuJ9hYJBx59RjbhxVnrF8Xg==",
+ "bin": {
+ "acorn": "bin/acorn"
+ },
+ "engines": {
+ "node": ">=0.4.0"
+ }
+ },
+ "node_modules/acorn-walk": {
+ "version": "8.3.2",
+ "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.2.tgz",
+ "integrity": "sha512-cjkyv4OtNCIeqhHrfS81QWXoCBPExR/J62oyEqepVw8WaQeSqpW2uhuLPh1m9eWhDuOo/jUXVTlifvesOWp/4A==",
+ "engines": {
+ "node": ">=0.4.0"
+ }
+ },
+ "node_modules/ansi-regex": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
+ "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/ansi-styles": {
+ "version": "5.2.0",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz",
+ "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==",
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/ansi-styles?sponsor=1"
+ }
+ },
+ "node_modules/anymatch": {
+ "version": "3.1.3",
+ "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz",
+ "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==",
+ "dependencies": {
+ "normalize-path": "^3.0.0",
+ "picomatch": "^2.0.4"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/assertion-error": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-1.1.0.tgz",
+ "integrity": "sha512-jgsaNduz+ndvGyFt3uSuWqvy4lCnIJiovtouQN5JZHOKCS2QuhEdbcQHFhVksz2N2U9hXJo8odG7ETyWlEeuDw==",
+ "engines": {
+ "node": "*"
+ }
+ },
+ "node_modules/base-x": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/base-x/-/base-x-4.0.0.tgz",
+ "integrity": "sha512-FuwxlW4H5kh37X/oW59pwTzzTKRzfrrQwhmyspRM7swOEZcHtDZSCt45U6oKgtuFE+WYPblePMVIPR4RZrh/hw=="
+ },
+ "node_modules/base64-js": {
+ "version": "1.5.1",
+ "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz",
+ "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ]
+ },
+ "node_modules/binary-extensions": {
+ "version": "2.3.0",
+ "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.3.0.tgz",
+ "integrity": "sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==",
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/braces": {
+ "version": "3.0.2",
+ "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz",
+ "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==",
+ "dependencies": {
+ "fill-range": "^7.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/bs58": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/bs58/-/bs58-5.0.0.tgz",
+ "integrity": "sha512-r+ihvQJvahgYT50JD05dyJNKlmmSlMoOGwn1lCcEzanPglg7TxYjioQUYehQ9mAR/+hOSd2jRc/Z2y5UxBymvQ==",
+ "dependencies": {
+ "base-x": "^4.0.0"
+ }
+ },
+ "node_modules/c32check": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/c32check/-/c32check-2.0.0.tgz",
+ "integrity": "sha512-rpwfAcS/CMqo0oCqDf3r9eeLgScRE3l/xHDCXhM3UyrfvIn7PrLq63uHh7yYbv8NzaZn5MVsVhIRpQ+5GZ5HyA==",
+ "dependencies": {
+ "@noble/hashes": "^1.1.2",
+ "base-x": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/cac": {
+ "version": "6.7.14",
+ "resolved": "https://registry.npmjs.org/cac/-/cac-6.7.14.tgz",
+ "integrity": "sha512-b6Ilus+c3RrdDk+JhLKUAQfzzgLEPy6wcXqS7f/xe1EETvsDP6GORG7SFuOs6cID5YkqchW/LXZbX5bc8j7ZcQ==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/camelcase": {
+ "version": "5.3.1",
+ "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz",
+ "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/chai": {
+ "version": "4.4.1",
+ "resolved": "https://registry.npmjs.org/chai/-/chai-4.4.1.tgz",
+ "integrity": "sha512-13sOfMv2+DWduEU+/xbun3LScLoqN17nBeTLUsmDfKdoiC1fr0n9PU4guu4AhRcOVFk/sW8LyZWHuhWtQZiF+g==",
+ "dependencies": {
+ "assertion-error": "^1.1.0",
+ "check-error": "^1.0.3",
+ "deep-eql": "^4.1.3",
+ "get-func-name": "^2.0.2",
+ "loupe": "^2.3.6",
+ "pathval": "^1.1.1",
+ "type-detect": "^4.0.8"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/check-error": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/check-error/-/check-error-1.0.3.tgz",
+ "integrity": "sha512-iKEoDYaRmd1mxM90a2OEfWhjsjPpYPuQ+lMYsoxB126+t8fw7ySEO48nmDg5COTjxDI65/Y2OWpeEHk3ZOe8zg==",
+ "dependencies": {
+ "get-func-name": "^2.0.2"
+ },
+ "engines": {
+ "node": "*"
+ }
+ },
+ "node_modules/chokidar": {
+ "version": "3.6.0",
+ "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz",
+ "integrity": "sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==",
+ "dependencies": {
+ "anymatch": "~3.1.2",
+ "braces": "~3.0.2",
+ "glob-parent": "~5.1.2",
+ "is-binary-path": "~2.1.0",
+ "is-glob": "~4.0.1",
+ "normalize-path": "~3.0.0",
+ "readdirp": "~3.6.0"
+ },
+ "engines": {
+ "node": ">= 8.10.0"
+ },
+ "funding": {
+ "url": "https://paulmillr.com/funding/"
+ },
+ "optionalDependencies": {
+ "fsevents": "~2.3.2"
+ }
+ },
+ "node_modules/chokidar-cli": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/chokidar-cli/-/chokidar-cli-3.0.0.tgz",
+ "integrity": "sha512-xVW+Qeh7z15uZRxHOkP93Ux8A0xbPzwK4GaqD8dQOYc34TlkqUhVSS59fK36DOp5WdJlrRzlYSy02Ht99FjZqQ==",
+ "dependencies": {
+ "chokidar": "^3.5.2",
+ "lodash.debounce": "^4.0.8",
+ "lodash.throttle": "^4.1.1",
+ "yargs": "^13.3.0"
+ },
+ "bin": {
+ "chokidar": "index.js"
+ },
+ "engines": {
+ "node": ">= 8.10.0"
+ }
+ },
+ "node_modules/chokidar-cli/node_modules/ansi-regex": {
+ "version": "4.1.1",
+ "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.1.tgz",
+ "integrity": "sha512-ILlv4k/3f6vfQ4OoP2AGvirOktlQ98ZEL1k9FaQjxa3L1abBgbuTDAdPOpvbGncC0BTVQrl+OM8xZGK6tWXt7g==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/chokidar-cli/node_modules/ansi-styles": {
+ "version": "3.2.1",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz",
+ "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==",
+ "dependencies": {
+ "color-convert": "^1.9.0"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/chokidar-cli/node_modules/cliui": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/cliui/-/cliui-5.0.0.tgz",
+ "integrity": "sha512-PYeGSEmmHM6zvoef2w8TPzlrnNpXIjTipYK780YswmIP9vjxmd6Y2a3CB2Ks6/AU8NHjZugXvo8w3oWM2qnwXA==",
+ "dependencies": {
+ "string-width": "^3.1.0",
+ "strip-ansi": "^5.2.0",
+ "wrap-ansi": "^5.1.0"
+ }
+ },
+ "node_modules/chokidar-cli/node_modules/emoji-regex": {
+ "version": "7.0.3",
+ "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz",
+ "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA=="
+ },
+ "node_modules/chokidar-cli/node_modules/is-fullwidth-code-point": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz",
+ "integrity": "sha512-VHskAKYM8RfSFXwee5t5cbN5PZeq1Wrh6qd5bkyiXIf6UQcN6w/A0eXM9r6t8d+GYOh+o6ZhiEnb88LN/Y8m2w==",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/chokidar-cli/node_modules/string-width": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz",
+ "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==",
+ "dependencies": {
+ "emoji-regex": "^7.0.1",
+ "is-fullwidth-code-point": "^2.0.0",
+ "strip-ansi": "^5.1.0"
+ },
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/chokidar-cli/node_modules/strip-ansi": {
+ "version": "5.2.0",
+ "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz",
+ "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==",
+ "dependencies": {
+ "ansi-regex": "^4.1.0"
+ },
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/chokidar-cli/node_modules/wrap-ansi": {
+ "version": "5.1.0",
+ "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-5.1.0.tgz",
+ "integrity": "sha512-QC1/iN/2/RPVJ5jYK8BGttj5z83LmSKmvbvrXPNCLZSEb32KKVDJDl/MOt2N01qU2H/FkzEa9PKto1BqDjtd7Q==",
+ "dependencies": {
+ "ansi-styles": "^3.2.0",
+ "string-width": "^3.0.0",
+ "strip-ansi": "^5.0.0"
+ },
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/chokidar-cli/node_modules/y18n": {
+ "version": "4.0.3",
+ "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.3.tgz",
+ "integrity": "sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ=="
+ },
+ "node_modules/chokidar-cli/node_modules/yargs": {
+ "version": "13.3.2",
+ "resolved": "https://registry.npmjs.org/yargs/-/yargs-13.3.2.tgz",
+ "integrity": "sha512-AX3Zw5iPruN5ie6xGRIDgqkT+ZhnRlZMLMHAs8tg7nRruy2Nb+i5o9bwghAogtM08q1dpr2LVoS8KSTMYpWXUw==",
+ "dependencies": {
+ "cliui": "^5.0.0",
+ "find-up": "^3.0.0",
+ "get-caller-file": "^2.0.1",
+ "require-directory": "^2.1.1",
+ "require-main-filename": "^2.0.0",
+ "set-blocking": "^2.0.0",
+ "string-width": "^3.0.0",
+ "which-module": "^2.0.0",
+ "y18n": "^4.0.0",
+ "yargs-parser": "^13.1.2"
+ }
+ },
+ "node_modules/chokidar-cli/node_modules/yargs-parser": {
+ "version": "13.1.2",
+ "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-13.1.2.tgz",
+ "integrity": "sha512-3lbsNRf/j+A4QuSZfDRA7HRSfWrzO0YjqTJd5kjAq37Zep1CEgaYmrH9Q3GwPiB9cHyd1Y1UwggGhJGoxipbzg==",
+ "dependencies": {
+ "camelcase": "^5.0.0",
+ "decamelize": "^1.2.0"
+ }
+ },
+ "node_modules/cliui": {
+ "version": "8.0.1",
+ "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz",
+ "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==",
+ "dependencies": {
+ "string-width": "^4.2.0",
+ "strip-ansi": "^6.0.1",
+ "wrap-ansi": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/color-convert": {
+ "version": "1.9.3",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz",
+ "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==",
+ "dependencies": {
+ "color-name": "1.1.3"
+ }
+ },
+ "node_modules/color-name": {
+ "version": "1.1.3",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz",
+ "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw=="
+ },
+ "node_modules/confbox": {
+ "version": "0.1.7",
+ "resolved": "https://registry.npmjs.org/confbox/-/confbox-0.1.7.tgz",
+ "integrity": "sha512-uJcB/FKZtBMCJpK8MQji6bJHgu1tixKPxRLeGkNzBoOZzpnZUJm0jm2/sBDWcuBx1dYgxV4JU+g5hmNxCyAmdA=="
+ },
+ "node_modules/cross-fetch": {
+ "version": "3.1.8",
+ "resolved": "https://registry.npmjs.org/cross-fetch/-/cross-fetch-3.1.8.tgz",
+ "integrity": "sha512-cvA+JwZoU0Xq+h6WkMvAUqPEYy92Obet6UdKLfW60qn99ftItKjB5T+BkyWOFWe2pUyfQ+IJHmpOTznqk1M6Kg==",
+ "dependencies": {
+ "node-fetch": "^2.6.12"
+ }
+ },
+ "node_modules/cross-spawn": {
+ "version": "7.0.3",
+ "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz",
+ "integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==",
+ "dependencies": {
+ "path-key": "^3.1.0",
+ "shebang-command": "^2.0.0",
+ "which": "^2.0.1"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/debug": {
+ "version": "4.3.4",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz",
+ "integrity": "sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==",
+ "dependencies": {
+ "ms": "2.1.2"
+ },
+ "engines": {
+ "node": ">=6.0"
+ },
+ "peerDependenciesMeta": {
+ "supports-color": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/decamelize": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz",
+ "integrity": "sha512-z2S+W9X73hAUUki+N+9Za2lBlun89zigOyGrsax+KUQ6wKW4ZoWpEYBkGhQjwAjjDCkWxhY0VKEhk8wzY7F5cA==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/deep-eql": {
+ "version": "4.1.3",
+ "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-4.1.3.tgz",
+ "integrity": "sha512-WaEtAOpRA1MQ0eohqZjpGD8zdI0Ovsm8mmFhaDN8dvDZzyoUMcYDnf5Y6iu7HTXxf8JDS23qWa4a+hKCDyOPzw==",
+ "dependencies": {
+ "type-detect": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/diff-sequences": {
+ "version": "29.6.3",
+ "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-29.6.3.tgz",
+ "integrity": "sha512-EjePK1srD3P08o2j4f0ExnylqRs5B9tJjcp9t1krH2qRi8CCdsYfwe9JgSLurFBWwq4uOlipzfk5fHNvwFKr8Q==",
+ "engines": {
+ "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
+ }
+ },
+ "node_modules/emoji-regex": {
+ "version": "8.0.0",
+ "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
+ "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A=="
+ },
+ "node_modules/esbuild": {
+ "version": "0.20.2",
+ "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.20.2.tgz",
+ "integrity": "sha512-WdOOppmUNU+IbZ0PaDiTst80zjnrOkyJNHoKupIcVyU8Lvla3Ugx94VzkQ32Ijqd7UhHJy75gNWDMUekcrSJ6g==",
+ "hasInstallScript": true,
+ "bin": {
+ "esbuild": "bin/esbuild"
+ },
+ "engines": {
+ "node": ">=12"
+ },
+ "optionalDependencies": {
+ "@esbuild/aix-ppc64": "0.20.2",
+ "@esbuild/android-arm": "0.20.2",
+ "@esbuild/android-arm64": "0.20.2",
+ "@esbuild/android-x64": "0.20.2",
+ "@esbuild/darwin-arm64": "0.20.2",
+ "@esbuild/darwin-x64": "0.20.2",
+ "@esbuild/freebsd-arm64": "0.20.2",
+ "@esbuild/freebsd-x64": "0.20.2",
+ "@esbuild/linux-arm": "0.20.2",
+ "@esbuild/linux-arm64": "0.20.2",
+ "@esbuild/linux-ia32": "0.20.2",
+ "@esbuild/linux-loong64": "0.20.2",
+ "@esbuild/linux-mips64el": "0.20.2",
+ "@esbuild/linux-ppc64": "0.20.2",
+ "@esbuild/linux-riscv64": "0.20.2",
+ "@esbuild/linux-s390x": "0.20.2",
+ "@esbuild/linux-x64": "0.20.2",
+ "@esbuild/netbsd-x64": "0.20.2",
+ "@esbuild/openbsd-x64": "0.20.2",
+ "@esbuild/sunos-x64": "0.20.2",
+ "@esbuild/win32-arm64": "0.20.2",
+ "@esbuild/win32-ia32": "0.20.2",
+ "@esbuild/win32-x64": "0.20.2"
+ }
+ },
+ "node_modules/escalade": {
+ "version": "3.1.2",
+ "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.2.tgz",
+ "integrity": "sha512-ErCHMCae19vR8vQGe50xIsVomy19rg6gFu3+r3jkEO46suLMWBksvVyoGgQV+jOfl84ZSOSlmv6Gxa89PmTGmA==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/estree-walker": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz",
+ "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==",
+ "dependencies": {
+ "@types/estree": "^1.0.0"
+ }
+ },
+ "node_modules/execa": {
+ "version": "8.0.1",
+ "resolved": "https://registry.npmjs.org/execa/-/execa-8.0.1.tgz",
+ "integrity": "sha512-VyhnebXciFV2DESc+p6B+y0LjSm0krU4OgJN44qFAhBY0TJ+1V61tYD2+wHusZ6F9n5K+vl8k0sTy7PEfV4qpg==",
+ "dependencies": {
+ "cross-spawn": "^7.0.3",
+ "get-stream": "^8.0.1",
+ "human-signals": "^5.0.0",
+ "is-stream": "^3.0.0",
+ "merge-stream": "^2.0.0",
+ "npm-run-path": "^5.1.0",
+ "onetime": "^6.0.0",
+ "signal-exit": "^4.1.0",
+ "strip-final-newline": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=16.17"
+ },
+ "funding": {
+ "url": "https://github.com/sindresorhus/execa?sponsor=1"
+ }
+ },
+ "node_modules/fast-check": {
+ "version": "3.18.0",
+ "resolved": "https://registry.npmjs.org/fast-check/-/fast-check-3.18.0.tgz",
+ "integrity": "sha512-/951xaT0kA40w0GXRsZXEwSTE7LugjZtSA/8vPgFkiPQ8wNp8tRvqWuNDHBgLxJYXtsK11e/7Q4ObkKW5BdTFQ==",
+ "funding": [
+ {
+ "type": "individual",
+ "url": "https://github.com/sponsors/dubzzz"
+ },
+ {
+ "type": "opencollective",
+ "url": "https://opencollective.com/fast-check"
+ }
+ ],
+ "dependencies": {
+ "pure-rand": "^6.1.0"
+ },
+ "engines": {
+ "node": ">=8.0.0"
+ }
+ },
+ "node_modules/fill-range": {
+ "version": "7.0.1",
+ "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz",
+ "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==",
+ "dependencies": {
+ "to-regex-range": "^5.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/find-up": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz",
+ "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==",
+ "dependencies": {
+ "locate-path": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/fsevents": {
+ "version": "2.3.3",
+ "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz",
+ "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==",
+ "hasInstallScript": true,
+ "optional": true,
+ "os": [
+ "darwin"
+ ],
+ "engines": {
+ "node": "^8.16.0 || ^10.6.0 || >=11.0.0"
+ }
+ },
+ "node_modules/get-caller-file": {
+ "version": "2.0.5",
+ "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz",
+ "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==",
+ "engines": {
+ "node": "6.* || 8.* || >= 10.*"
+ }
+ },
+ "node_modules/get-func-name": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/get-func-name/-/get-func-name-2.0.2.tgz",
+ "integrity": "sha512-8vXOvuE167CtIc3OyItco7N/dpRtBbYOsPsXCz7X/PMnlGjYjSGuZJgM1Y7mmew7BKf9BqvLX2tnOVy1BBUsxQ==",
+ "engines": {
+ "node": "*"
+ }
+ },
+ "node_modules/get-stream": {
+ "version": "8.0.1",
+ "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-8.0.1.tgz",
+ "integrity": "sha512-VaUJspBffn/LMCJVoMvSAdmscJyS1auj5Zulnn5UoYcY531UWmdwhRWkcGKnGU93m5HSXP9LP2usOryrBtQowA==",
+ "engines": {
+ "node": ">=16"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/glob-parent": {
+ "version": "5.1.2",
+ "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz",
+ "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==",
+ "dependencies": {
+ "is-glob": "^4.0.1"
+ },
+ "engines": {
+ "node": ">= 6"
+ }
+ },
+ "node_modules/human-signals": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-5.0.0.tgz",
+ "integrity": "sha512-AXcZb6vzzrFAUE61HnN4mpLqd/cSIwNQjtNWR0euPm6y0iqx3G4gOXaIDdtdDwZmhwe82LA6+zinmW4UBWVePQ==",
+ "engines": {
+ "node": ">=16.17.0"
+ }
+ },
+ "node_modules/is-binary-path": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz",
+ "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==",
+ "dependencies": {
+ "binary-extensions": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/is-extglob": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz",
+ "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/is-fullwidth-code-point": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz",
+ "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/is-glob": {
+ "version": "4.0.3",
+ "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz",
+ "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==",
+ "dependencies": {
+ "is-extglob": "^2.1.1"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/is-number": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
+ "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==",
+ "engines": {
+ "node": ">=0.12.0"
+ }
+ },
+ "node_modules/is-stream": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-3.0.0.tgz",
+ "integrity": "sha512-LnQR4bZ9IADDRSkvpqMGvt/tEJWclzklNgSw48V5EAaAeDd6qGvN8ei6k5p0tvxSR171VmGyHuTiAOfxAbr8kA==",
+ "engines": {
+ "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/isexe": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz",
+ "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw=="
+ },
+ "node_modules/js-tokens": {
+ "version": "9.0.0",
+ "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-9.0.0.tgz",
+ "integrity": "sha512-WriZw1luRMlmV3LGJaR6QOJjWwgLUTf89OwT2lUOyjX2dJGBwgmIkbcz+7WFZjrZM635JOIR517++e/67CP9dQ=="
+ },
+ "node_modules/kleur": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz",
+ "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/kolorist": {
+ "version": "1.8.0",
+ "resolved": "https://registry.npmjs.org/kolorist/-/kolorist-1.8.0.tgz",
+ "integrity": "sha512-Y+60/zizpJ3HRH8DCss+q95yr6145JXZo46OTpFvDZWLfRCE4qChOyk1b26nMaNpfHHgxagk9dXT5OP0Tfe+dQ=="
+ },
+ "node_modules/local-pkg": {
+ "version": "0.5.0",
+ "resolved": "https://registry.npmjs.org/local-pkg/-/local-pkg-0.5.0.tgz",
+ "integrity": "sha512-ok6z3qlYyCDS4ZEU27HaU6x/xZa9Whf8jD4ptH5UZTQYZVYeb9bnZ3ojVhiJNLiXK1Hfc0GNbLXcmZ5plLDDBg==",
+ "dependencies": {
+ "mlly": "^1.4.2",
+ "pkg-types": "^1.0.3"
+ },
+ "engines": {
+ "node": ">=14"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/antfu"
+ }
+ },
+ "node_modules/locate-path": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz",
+ "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==",
+ "dependencies": {
+ "p-locate": "^3.0.0",
+ "path-exists": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/lodash.clonedeep": {
+ "version": "4.5.0",
+ "resolved": "https://registry.npmjs.org/lodash.clonedeep/-/lodash.clonedeep-4.5.0.tgz",
+ "integrity": "sha512-H5ZhCF25riFd9uB5UCkVKo61m3S/xZk1x4wA6yp/L3RFP6Z/eHH1ymQcGLo7J3GMPfm0V/7m1tryHuGVxpqEBQ=="
+ },
+ "node_modules/lodash.debounce": {
+ "version": "4.0.8",
+ "resolved": "https://registry.npmjs.org/lodash.debounce/-/lodash.debounce-4.0.8.tgz",
+ "integrity": "sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow=="
+ },
+ "node_modules/lodash.throttle": {
+ "version": "4.1.1",
+ "resolved": "https://registry.npmjs.org/lodash.throttle/-/lodash.throttle-4.1.1.tgz",
+ "integrity": "sha512-wIkUCfVKpVsWo3JSZlc+8MB5it+2AN5W8J7YVMST30UrvcQNZ1Okbj+rbVniijTWE6FGYy4XJq/rHkas8qJMLQ=="
+ },
+ "node_modules/loupe": {
+ "version": "2.3.7",
+ "resolved": "https://registry.npmjs.org/loupe/-/loupe-2.3.7.tgz",
+ "integrity": "sha512-zSMINGVYkdpYSOBmLi0D1Uo7JU9nVdQKrHxC8eYlV+9YKK9WePqAlL7lSlorG/U2Fw1w0hTBmaa/jrQ3UbPHtA==",
+ "dependencies": {
+ "get-func-name": "^2.0.1"
+ }
+ },
+ "node_modules/magic-string": {
+ "version": "0.30.10",
+ "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.10.tgz",
+ "integrity": "sha512-iIRwTIf0QKV3UAnYK4PU8uiEc4SRh5jX0mwpIwETPpHdhVM4f53RSwS/vXvN1JhGX+Cs7B8qIq3d6AH49O5fAQ==",
+ "dependencies": {
+ "@jridgewell/sourcemap-codec": "^1.4.15"
+ }
+ },
+ "node_modules/merge-stream": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz",
+ "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w=="
+ },
+ "node_modules/mimic-fn": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-4.0.0.tgz",
+ "integrity": "sha512-vqiC06CuhBTUdZH+RYl8sFrL096vA45Ok5ISO6sE/Mr1jRbGH4Csnhi8f3wKVl7x8mO4Au7Ir9D3Oyv1VYMFJw==",
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/mlly": {
+ "version": "1.6.1",
+ "resolved": "https://registry.npmjs.org/mlly/-/mlly-1.6.1.tgz",
+ "integrity": "sha512-vLgaHvaeunuOXHSmEbZ9izxPx3USsk8KCQ8iC+aTlp5sKRSoZvwhHh5L9VbKSaVC6sJDqbyohIS76E2VmHIPAA==",
+ "dependencies": {
+ "acorn": "^8.11.3",
+ "pathe": "^1.1.2",
+ "pkg-types": "^1.0.3",
+ "ufo": "^1.3.2"
+ }
+ },
+ "node_modules/ms": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz",
+ "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w=="
+ },
+ "node_modules/nanoid": {
+ "version": "3.3.7",
+ "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.7.tgz",
+ "integrity": "sha512-eSRppjcPIatRIMC1U6UngP8XFcz8MQWGQdt1MTBQ7NaAmvXDfvNxbvWV3x2y6CdEUciCSsDHDQZbhYaB8QEo2g==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/ai"
+ }
+ ],
+ "bin": {
+ "nanoid": "bin/nanoid.cjs"
+ },
+ "engines": {
+ "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1"
+ }
+ },
+ "node_modules/node-fetch": {
+ "version": "2.7.0",
+ "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz",
+ "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==",
+ "dependencies": {
+ "whatwg-url": "^5.0.0"
+ },
+ "engines": {
+ "node": "4.x || >=6.0.0"
+ },
+ "peerDependencies": {
+ "encoding": "^0.1.0"
+ },
+ "peerDependenciesMeta": {
+ "encoding": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/normalize-path": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz",
+ "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/npm-run-path": {
+ "version": "5.3.0",
+ "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.3.0.tgz",
+ "integrity": "sha512-ppwTtiJZq0O/ai0z7yfudtBpWIoxM8yE6nHi1X47eFR2EWORqfbu6CnPlNsjeN683eT0qG6H/Pyf9fCcvjnnnQ==",
+ "dependencies": {
+ "path-key": "^4.0.0"
+ },
+ "engines": {
+ "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/npm-run-path/node_modules/path-key": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/path-key/-/path-key-4.0.0.tgz",
+ "integrity": "sha512-haREypq7xkM7ErfgIyA0z+Bj4AGKlMSdlQE2jvJo6huWD1EdkKYV+G/T4nq0YEF2vgTT8kqMFKo1uHn950r4SQ==",
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/onetime": {
+ "version": "6.0.0",
+ "resolved": "https://registry.npmjs.org/onetime/-/onetime-6.0.0.tgz",
+ "integrity": "sha512-1FlR+gjXK7X+AsAHso35MnyN5KqGwJRi/31ft6x0M194ht7S+rWAvd7PHss9xSKMzE0asv1pyIHaJYq+BbacAQ==",
+ "dependencies": {
+ "mimic-fn": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/p-limit": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-5.0.0.tgz",
+ "integrity": "sha512-/Eaoq+QyLSiXQ4lyYV23f14mZRQcXnxfHrN0vCai+ak9G0pp9iEQukIIZq5NccEvwRB8PUnZT0KsOoDCINS1qQ==",
+ "dependencies": {
+ "yocto-queue": "^1.0.0"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/p-locate": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz",
+ "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==",
+ "dependencies": {
+ "p-limit": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/p-locate/node_modules/p-limit": {
+ "version": "2.3.0",
+ "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz",
+ "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==",
+ "dependencies": {
+ "p-try": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/p-try": {
+ "version": "2.2.0",
+ "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz",
+ "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/path-exists": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz",
+ "integrity": "sha512-bpC7GYwiDYQ4wYLe+FA8lhRjhQCMcQGuSgGGqDkg/QerRWw9CmGRT0iSOVRSZJ29NMLZgIzqaljJ63oaL4NIJQ==",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/path-key": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz",
+ "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/pathe": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/pathe/-/pathe-1.1.2.tgz",
+ "integrity": "sha512-whLdWMYL2TwI08hn8/ZqAbrVemu0LNaNNJZX73O6qaIdCTfXutsLhMkjdENX0qhsQ9uIimo4/aQOmXkoon2nDQ=="
+ },
+ "node_modules/pathval": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/pathval/-/pathval-1.1.1.tgz",
+ "integrity": "sha512-Dp6zGqpTdETdR63lehJYPeIOqpiNBNtc7BpWSLrOje7UaIsE5aY92r/AunQA7rsXvet3lrJ3JnZX29UPTKXyKQ==",
+ "engines": {
+ "node": "*"
+ }
+ },
+ "node_modules/picocolors": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz",
+ "integrity": "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ=="
+ },
+ "node_modules/picomatch": {
+ "version": "2.3.1",
+ "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz",
+ "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==",
+ "engines": {
+ "node": ">=8.6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/jonschlinkert"
+ }
+ },
+ "node_modules/pkg-types": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/pkg-types/-/pkg-types-1.1.0.tgz",
+ "integrity": "sha512-/RpmvKdxKf8uILTtoOhAgf30wYbP2Qw+L9p3Rvshx1JZVX+XQNZQFjlbmGHEGIm4CkVPlSn+NXmIM8+9oWQaSA==",
+ "dependencies": {
+ "confbox": "^0.1.7",
+ "mlly": "^1.6.1",
+ "pathe": "^1.1.2"
+ }
+ },
+ "node_modules/postcss": {
+ "version": "8.4.38",
+ "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.38.tgz",
+ "integrity": "sha512-Wglpdk03BSfXkHoQa3b/oulrotAkwrlLDRSOb9D0bN86FdRyE9lppSp33aHNPgBa0JKCoB+drFLZkQoRRYae5A==",
+ "funding": [
+ {
+ "type": "opencollective",
+ "url": "https://opencollective.com/postcss/"
+ },
+ {
+ "type": "tidelift",
+ "url": "https://tidelift.com/funding/github/npm/postcss"
+ },
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/ai"
+ }
+ ],
+ "dependencies": {
+ "nanoid": "^3.3.7",
+ "picocolors": "^1.0.0",
+ "source-map-js": "^1.2.0"
+ },
+ "engines": {
+ "node": "^10 || ^12 || >=14"
+ }
+ },
+ "node_modules/pretty-format": {
+ "version": "29.7.0",
+ "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-29.7.0.tgz",
+ "integrity": "sha512-Pdlw/oPxN+aXdmM9R00JVC9WVFoCLTKJvDVLgmJ+qAffBMxsV85l/Lu7sNx4zSzPyoL2euImuEwHhOXdEgNFZQ==",
+ "dependencies": {
+ "@jest/schemas": "^29.6.3",
+ "ansi-styles": "^5.0.0",
+ "react-is": "^18.0.0"
+ },
+ "engines": {
+ "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
+ }
+ },
+ "node_modules/prompts": {
+ "version": "2.4.2",
+ "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz",
+ "integrity": "sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==",
+ "dependencies": {
+ "kleur": "^3.0.3",
+ "sisteransi": "^1.0.5"
+ },
+ "engines": {
+ "node": ">= 6"
+ }
+ },
+ "node_modules/pure-rand": {
+ "version": "6.1.0",
+ "resolved": "https://registry.npmjs.org/pure-rand/-/pure-rand-6.1.0.tgz",
+ "integrity": "sha512-bVWawvoZoBYpp6yIoQtQXHZjmz35RSVHnUOTefl8Vcjr8snTPY1wnpSPMWekcFwbxI6gtmT7rSYPFvz71ldiOA==",
+ "funding": [
+ {
+ "type": "individual",
+ "url": "https://github.com/sponsors/dubzzz"
+ },
+ {
+ "type": "opencollective",
+ "url": "https://opencollective.com/fast-check"
+ }
+ ]
+ },
+ "node_modules/react-is": {
+ "version": "18.3.1",
+ "resolved": "https://registry.npmjs.org/react-is/-/react-is-18.3.1.tgz",
+ "integrity": "sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg=="
+ },
+ "node_modules/readdirp": {
+ "version": "3.6.0",
+ "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz",
+ "integrity": "sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==",
+ "dependencies": {
+ "picomatch": "^2.2.1"
+ },
+ "engines": {
+ "node": ">=8.10.0"
+ }
+ },
+ "node_modules/require-directory": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz",
+ "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/require-main-filename": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/require-main-filename/-/require-main-filename-2.0.0.tgz",
+ "integrity": "sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg=="
+ },
+ "node_modules/ripemd160-min": {
+ "version": "0.0.6",
+ "resolved": "https://registry.npmjs.org/ripemd160-min/-/ripemd160-min-0.0.6.tgz",
+ "integrity": "sha512-+GcJgQivhs6S9qvLogusiTcS9kQUfgR75whKuy5jIhuiOfQuJ8fjqxV6EGD5duH1Y/FawFUMtMhyeq3Fbnib8A==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/rollup": {
+ "version": "4.17.1",
+ "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.17.1.tgz",
+ "integrity": "sha512-0gG94inrUtg25sB2V/pApwiv1lUb0bQ25FPNuzO89Baa+B+c0ccaaBKM5zkZV/12pUUdH+lWCSm9wmHqyocuVQ==",
+ "dependencies": {
+ "@types/estree": "1.0.5"
+ },
+ "bin": {
+ "rollup": "dist/bin/rollup"
+ },
+ "engines": {
+ "node": ">=18.0.0",
+ "npm": ">=8.0.0"
+ },
+ "optionalDependencies": {
+ "@rollup/rollup-android-arm-eabi": "4.17.1",
+ "@rollup/rollup-android-arm64": "4.17.1",
+ "@rollup/rollup-darwin-arm64": "4.17.1",
+ "@rollup/rollup-darwin-x64": "4.17.1",
+ "@rollup/rollup-linux-arm-gnueabihf": "4.17.1",
+ "@rollup/rollup-linux-arm-musleabihf": "4.17.1",
+ "@rollup/rollup-linux-arm64-gnu": "4.17.1",
+ "@rollup/rollup-linux-arm64-musl": "4.17.1",
+ "@rollup/rollup-linux-powerpc64le-gnu": "4.17.1",
+ "@rollup/rollup-linux-riscv64-gnu": "4.17.1",
+ "@rollup/rollup-linux-s390x-gnu": "4.17.1",
+ "@rollup/rollup-linux-x64-gnu": "4.17.1",
+ "@rollup/rollup-linux-x64-musl": "4.17.1",
+ "@rollup/rollup-win32-arm64-msvc": "4.17.1",
+ "@rollup/rollup-win32-ia32-msvc": "4.17.1",
+ "@rollup/rollup-win32-x64-msvc": "4.17.1",
+ "fsevents": "~2.3.2"
+ }
+ },
+ "node_modules/safe-buffer": {
+ "version": "5.2.1",
+ "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz",
+ "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ]
+ },
+ "node_modules/set-blocking": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/set-blocking/-/set-blocking-2.0.0.tgz",
+ "integrity": "sha512-KiKBS8AnWGEyLzofFfmvKwpdPzqiy16LvQfK3yv/fVH7Bj13/wl3JSR1J+rfgRE9q7xUJK4qvgS8raSOeLUehw=="
+ },
+ "node_modules/shebang-command": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz",
+ "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==",
+ "dependencies": {
+ "shebang-regex": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/shebang-regex": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz",
+ "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/siginfo": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/siginfo/-/siginfo-2.0.0.tgz",
+ "integrity": "sha512-ybx0WO1/8bSBLEWXZvEd7gMW3Sn3JFlW3TvX1nREbDLRNQNaeNN8WK0meBwPdAaOI7TtRRRJn/Es1zhrrCHu7g=="
+ },
+ "node_modules/signal-exit": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz",
+ "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==",
+ "engines": {
+ "node": ">=14"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/isaacs"
+ }
+ },
+ "node_modules/sisteransi": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz",
+ "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg=="
+ },
+ "node_modules/source-map-js": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.0.tgz",
+ "integrity": "sha512-itJW8lvSA0TXEphiRoawsCksnlf8SyvmFzIhltqAHluXd88pkCd+cXJVHTDwdCr0IzwptSm035IHQktUu1QUMg==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/stackback": {
+ "version": "0.0.2",
+ "resolved": "https://registry.npmjs.org/stackback/-/stackback-0.0.2.tgz",
+ "integrity": "sha512-1XMJE5fQo1jGH6Y/7ebnwPOBEkIEnT4QF32d5R1+VXdXveM0IBMJt8zfaxX1P3QhVwrYe+576+jkANtSS2mBbw=="
+ },
+ "node_modules/std-env": {
+ "version": "3.7.0",
+ "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.7.0.tgz",
+ "integrity": "sha512-JPbdCEQLj1w5GilpiHAx3qJvFndqybBysA3qUOnznweH4QbNYUsW/ea8QzSrnh0vNsezMMw5bcVool8lM0gwzg=="
+ },
+ "node_modules/string-width": {
+ "version": "4.2.3",
+ "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
+ "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
+ "dependencies": {
+ "emoji-regex": "^8.0.0",
+ "is-fullwidth-code-point": "^3.0.0",
+ "strip-ansi": "^6.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/strip-ansi": {
+ "version": "6.0.1",
+ "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
+ "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
+ "dependencies": {
+ "ansi-regex": "^5.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/strip-final-newline": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-3.0.0.tgz",
+ "integrity": "sha512-dOESqjYr96iWYylGObzd39EuNTa5VJxyvVAEm5Jnh7KGo75V43Hk1odPQkNDyXNmUR6k+gEiDVXnjB8HJ3crXw==",
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/strip-literal": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/strip-literal/-/strip-literal-2.1.0.tgz",
+ "integrity": "sha512-Op+UycaUt/8FbN/Z2TWPBLge3jWrP3xj10f3fnYxf052bKuS3EKs1ZQcVGjnEMdsNVAM+plXRdmjrZ/KgG3Skw==",
+ "dependencies": {
+ "js-tokens": "^9.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/antfu"
+ }
+ },
+ "node_modules/tinybench": {
+ "version": "2.8.0",
+ "resolved": "https://registry.npmjs.org/tinybench/-/tinybench-2.8.0.tgz",
+ "integrity": "sha512-1/eK7zUnIklz4JUUlL+658n58XO2hHLQfSk1Zf2LKieUjxidN16eKFEoDEfjHc3ohofSSqK3X5yO6VGb6iW8Lw=="
+ },
+ "node_modules/tinypool": {
+ "version": "0.8.4",
+ "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-0.8.4.tgz",
+ "integrity": "sha512-i11VH5gS6IFeLY3gMBQ00/MmLncVP7JLXOw1vlgkytLmJK7QnEr7NXf0LBdxfmNPAeyetukOk0bOYrJrFGjYJQ==",
+ "engines": {
+ "node": ">=14.0.0"
+ }
+ },
+ "node_modules/tinyspy": {
+ "version": "2.2.1",
+ "resolved": "https://registry.npmjs.org/tinyspy/-/tinyspy-2.2.1.tgz",
+ "integrity": "sha512-KYad6Vy5VDWV4GH3fjpseMQ/XU2BhIYP7Vzd0LG44qRWm/Yt2WCOTicFdvmgo6gWaqooMQCawTtILVQJupKu7A==",
+ "engines": {
+ "node": ">=14.0.0"
+ }
+ },
+ "node_modules/to-regex-range": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz",
+ "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==",
+ "dependencies": {
+ "is-number": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=8.0"
+ }
+ },
+ "node_modules/tr46": {
+ "version": "0.0.3",
+ "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz",
+ "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw=="
+ },
+ "node_modules/type-detect": {
+ "version": "4.0.8",
+ "resolved": "https://registry.npmjs.org/type-detect/-/type-detect-4.0.8.tgz",
+ "integrity": "sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g==",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/typescript": {
+ "version": "5.4.5",
+ "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.5.tgz",
+ "integrity": "sha512-vcI4UpRgg81oIRUFwR0WSIHKt11nJ7SAVlYNIu+QpqeyXP+gpQJy/Z4+F0aGxSE4MqwjyXvW/TzgkLAx2AGHwQ==",
+ "bin": {
+ "tsc": "bin/tsc",
+ "tsserver": "bin/tsserver"
+ },
+ "engines": {
+ "node": ">=14.17"
+ }
+ },
+ "node_modules/ufo": {
+ "version": "1.5.3",
+ "resolved": "https://registry.npmjs.org/ufo/-/ufo-1.5.3.tgz",
+ "integrity": "sha512-Y7HYmWaFwPUmkoQCUIAYpKqkOf+SbVj/2fJJZ4RJMCfZp0rTGwRbzQD+HghfnhKOjL9E01okqz+ncJskGYfBNw=="
+ },
+ "node_modules/undici-types": {
+ "version": "5.26.5",
+ "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz",
+ "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA=="
+ },
+ "node_modules/varuint-bitcoin": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/varuint-bitcoin/-/varuint-bitcoin-1.1.2.tgz",
+ "integrity": "sha512-4EVb+w4rx+YfVM32HQX42AbbT7/1f5zwAYhIujKXKk8NQK+JfRVl3pqT3hjNn/L+RstigmGGKVwHA/P0wgITZw==",
+ "dependencies": {
+ "safe-buffer": "^5.1.1"
+ }
+ },
+ "node_modules/vite": {
+ "version": "5.2.10",
+ "resolved": "https://registry.npmjs.org/vite/-/vite-5.2.10.tgz",
+ "integrity": "sha512-PAzgUZbP7msvQvqdSD+ErD5qGnSFiGOoWmV5yAKUEI0kdhjbH6nMWVyZQC/hSc4aXwc0oJ9aEdIiF9Oje0JFCw==",
+ "dependencies": {
+ "esbuild": "^0.20.1",
+ "postcss": "^8.4.38",
+ "rollup": "^4.13.0"
+ },
+ "bin": {
+ "vite": "bin/vite.js"
+ },
+ "engines": {
+ "node": "^18.0.0 || >=20.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/vitejs/vite?sponsor=1"
+ },
+ "optionalDependencies": {
+ "fsevents": "~2.3.3"
+ },
+ "peerDependencies": {
+ "@types/node": "^18.0.0 || >=20.0.0",
+ "less": "*",
+ "lightningcss": "^1.21.0",
+ "sass": "*",
+ "stylus": "*",
+ "sugarss": "*",
+ "terser": "^5.4.0"
+ },
+ "peerDependenciesMeta": {
+ "@types/node": {
+ "optional": true
+ },
+ "less": {
+ "optional": true
+ },
+ "lightningcss": {
+ "optional": true
+ },
+ "sass": {
+ "optional": true
+ },
+ "stylus": {
+ "optional": true
+ },
+ "sugarss": {
+ "optional": true
+ },
+ "terser": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/vite-node": {
+ "version": "1.5.2",
+ "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-1.5.2.tgz",
+ "integrity": "sha512-Y8p91kz9zU+bWtF7HGt6DVw2JbhyuB2RlZix3FPYAYmUyZ3n7iTp8eSyLyY6sxtPegvxQtmlTMhfPhUfCUF93A==",
+ "dependencies": {
+ "cac": "^6.7.14",
+ "debug": "^4.3.4",
+ "pathe": "^1.1.1",
+ "picocolors": "^1.0.0",
+ "vite": "^5.0.0"
+ },
+ "bin": {
+ "vite-node": "vite-node.mjs"
+ },
+ "engines": {
+ "node": "^18.0.0 || >=20.0.0"
+ },
+ "funding": {
+ "url": "https://opencollective.com/vitest"
+ }
+ },
+ "node_modules/vitest": {
+ "version": "1.5.2",
+ "resolved": "https://registry.npmjs.org/vitest/-/vitest-1.5.2.tgz",
+ "integrity": "sha512-l9gwIkq16ug3xY7BxHwcBQovLZG75zZL0PlsiYQbf76Rz6QGs54416UWMtC0jXeihvHvcHrf2ROEjkQRVpoZYw==",
+ "dependencies": {
+ "@vitest/expect": "1.5.2",
+ "@vitest/runner": "1.5.2",
+ "@vitest/snapshot": "1.5.2",
+ "@vitest/spy": "1.5.2",
+ "@vitest/utils": "1.5.2",
+ "acorn-walk": "^8.3.2",
+ "chai": "^4.3.10",
+ "debug": "^4.3.4",
+ "execa": "^8.0.1",
+ "local-pkg": "^0.5.0",
+ "magic-string": "^0.30.5",
+ "pathe": "^1.1.1",
+ "picocolors": "^1.0.0",
+ "std-env": "^3.5.0",
+ "strip-literal": "^2.0.0",
+ "tinybench": "^2.5.1",
+ "tinypool": "^0.8.3",
+ "vite": "^5.0.0",
+ "vite-node": "1.5.2",
+ "why-is-node-running": "^2.2.2"
+ },
+ "bin": {
+ "vitest": "vitest.mjs"
+ },
+ "engines": {
+ "node": "^18.0.0 || >=20.0.0"
+ },
+ "funding": {
+ "url": "https://opencollective.com/vitest"
+ },
+ "peerDependencies": {
+ "@edge-runtime/vm": "*",
+ "@types/node": "^18.0.0 || >=20.0.0",
+ "@vitest/browser": "1.5.2",
+ "@vitest/ui": "1.5.2",
+ "happy-dom": "*",
+ "jsdom": "*"
+ },
+ "peerDependenciesMeta": {
+ "@edge-runtime/vm": {
+ "optional": true
+ },
+ "@types/node": {
+ "optional": true
+ },
+ "@vitest/browser": {
+ "optional": true
+ },
+ "@vitest/ui": {
+ "optional": true
+ },
+ "happy-dom": {
+ "optional": true
+ },
+ "jsdom": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/vitest-environment-clarinet": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/vitest-environment-clarinet/-/vitest-environment-clarinet-2.1.0.tgz",
+ "integrity": "sha512-1SA9XZh47qmbV724sGo2FyjVU+Ar3m5TOU4bLGSlWDb/x388IKUPrHbHWqIQNwY+gwEm9VBfXEAd1LOSUdemBw==",
+ "peerDependencies": {
+ "@hirosystems/clarinet-sdk": ">=2.6.0",
+ "vitest": "^1.5.2"
+ }
+ },
+ "node_modules/webidl-conversions": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz",
+ "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ=="
+ },
+ "node_modules/whatwg-url": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz",
+ "integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==",
+ "dependencies": {
+ "tr46": "~0.0.3",
+ "webidl-conversions": "^3.0.0"
+ }
+ },
+ "node_modules/which": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
+ "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==",
+ "dependencies": {
+ "isexe": "^2.0.0"
+ },
+ "bin": {
+ "node-which": "bin/node-which"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/which-module": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.1.tgz",
+ "integrity": "sha512-iBdZ57RDvnOR9AGBhML2vFZf7h8vmBjhoaZqODJBFWHVtKkDmKuHai3cx5PgVMrX5YDNp27AofYbAwctSS+vhQ=="
+ },
+ "node_modules/why-is-node-running": {
+ "version": "2.2.2",
+ "resolved": "https://registry.npmjs.org/why-is-node-running/-/why-is-node-running-2.2.2.tgz",
+ "integrity": "sha512-6tSwToZxTOcotxHeA+qGCq1mVzKR3CwcJGmVcY+QE8SHy6TnpFnh8PAvPNHYr7EcuVeG0QSMxtYCuO1ta/G/oA==",
+ "dependencies": {
+ "siginfo": "^2.0.0",
+ "stackback": "0.0.2"
+ },
+ "bin": {
+ "why-is-node-running": "cli.js"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/wrap-ansi": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz",
+ "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==",
+ "dependencies": {
+ "ansi-styles": "^4.0.0",
+ "string-width": "^4.1.0",
+ "strip-ansi": "^6.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/wrap-ansi?sponsor=1"
+ }
+ },
+ "node_modules/wrap-ansi/node_modules/ansi-styles": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
+ "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
+ "dependencies": {
+ "color-convert": "^2.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/ansi-styles?sponsor=1"
+ }
+ },
+ "node_modules/wrap-ansi/node_modules/color-convert": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
+ "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
+ "dependencies": {
+ "color-name": "~1.1.4"
+ },
+ "engines": {
+ "node": ">=7.0.0"
+ }
+ },
+ "node_modules/wrap-ansi/node_modules/color-name": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
+ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
+ },
+ "node_modules/y18n": {
+ "version": "5.0.8",
+ "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz",
+ "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==",
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/yargs": {
+ "version": "17.7.2",
+ "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.2.tgz",
+ "integrity": "sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==",
+ "dependencies": {
+ "cliui": "^8.0.1",
+ "escalade": "^3.1.1",
+ "get-caller-file": "^2.0.5",
+ "require-directory": "^2.1.1",
+ "string-width": "^4.2.3",
+ "y18n": "^5.0.5",
+ "yargs-parser": "^21.1.1"
+ },
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/yargs-parser": {
+ "version": "21.1.1",
+ "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz",
+ "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==",
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/yocto-queue": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.0.0.tgz",
+ "integrity": "sha512-9bnSc/HEW2uRy67wc+T8UwauLuPJVn28jb+GtJY16iiKWyvmYJRXVT4UamsAEGQfPohgr2q4Tq0sQbQlxTfi1g==",
+ "engines": {
+ "node": ">=12.20"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ }
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/package.json b/contrib/boot-contracts-stateful-prop-tests/package.json
new file mode 100644
index 00000000000..89e3da95b00
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/package.json
@@ -0,0 +1,23 @@
+{
+ "name": "boot-contracts-stateful-prop-tests",
+ "version": "1.0.0",
+ "description": "Run stateful property-based tests on this project.",
+ "private": true,
+ "type": "module",
+ "scripts": {
+ "test": "vitest run"
+ },
+ "author": "",
+ "license": "ISC",
+ "dependencies": {
+ "@hirosystems/clarinet-sdk": "^2.6.0",
+ "@stacks/stacking": "^6.14.0",
+ "@stacks/transactions": "^6.13.1",
+ "chokidar-cli": "^3.0.0",
+ "fast-check": "^3.18.0",
+ "typescript": "^5.4.5",
+ "vite": "^5.2.10",
+ "vitest": "^1.5.2",
+ "vitest-environment-clarinet": "^2.1.0"
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/settings/Devnet.toml b/contrib/boot-contracts-stateful-prop-tests/settings/Devnet.toml
new file mode 100644
index 00000000000..bb941fddc90
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/settings/Devnet.toml
@@ -0,0 +1,73 @@
+[network]
+name = "devnet"
+
+[accounts.deployer]
+mnemonic = "twice kind fence tip hidden tilt action fragile skin nothing glory cousin green tomorrow spring wrist shed math olympic multiply hip blue scout claw"
+balance = 100_000_000_000_000
+# secret_key: 753b7cc01a1a2e86221266a154af739463fce51219d97e4f856cd7200c3bd2a601
+# stx_address: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
+# btc_address: mqVnk6NPRdhntvfm4hh9vvjiRkFDUuSYsH
+
+[accounts.wallet_1]
+mnemonic = "sell invite acquire kitten bamboo drastic jelly vivid peace spawn twice guilt pave pen trash pretty park cube fragile unaware remain midnight betray rebuild"
+balance = 100_000_000_000_000
+# secret_key: 7287ba251d44a4d3fd9276c88ce34c5c52a038955511cccaf77e61068649c17801
+# stx_address: ST1SJ3DTE5DN7X54YDH5D64R3BCB6A2AG2ZQ8YPD5
+# btc_address: mr1iPkD9N3RJZZxXRk7xF9d36gffa6exNC
+
+[accounts.wallet_2]
+mnemonic = "hold excess usual excess ring elephant install account glad dry fragile donkey gaze humble truck breeze nation gasp vacuum limb head keep delay hospital"
+balance = 100_000_000_000_000
+# secret_key: 530d9f61984c888536871c6573073bdfc0058896dc1adfe9a6a10dfacadc209101
+# stx_address: ST2CY5V39NHDPWSXMW9QDT3HC3GD6Q6XX4CFRK9AG
+# btc_address: muYdXKmX9bByAueDe6KFfHd5Ff1gdN9ErG
+
+[accounts.wallet_3]
+mnemonic = "cycle puppy glare enroll cost improve round trend wrist mushroom scorpion tower claim oppose clever elephant dinosaur eight problem before frozen dune wagon high"
+balance = 100_000_000_000_000
+# secret_key: d655b2523bcd65e34889725c73064feb17ceb796831c0e111ba1a552b0f31b3901
+# stx_address: ST2JHG361ZXG51QTKY2NQCVBPPRRE2KZB1HR05NNC
+# btc_address: mvZtbibDAAA3WLpY7zXXFqRa3T4XSknBX7
+
+[accounts.wallet_4]
+mnemonic = "board list obtain sugar hour worth raven scout denial thunder horse logic fury scorpion fold genuine phrase wealth news aim below celery when cabin"
+balance = 100_000_000_000_000
+# secret_key: f9d7206a47f14d2870c163ebab4bf3e70d18f5d14ce1031f3902fbbc894fe4c701
+# stx_address: ST2NEB84ASENDXKYGJPQW86YXQCEFEX2ZQPG87ND
+# btc_address: mg1C76bNTutiCDV3t9nWhZs3Dc8LzUufj8
+
+[accounts.wallet_5]
+mnemonic = "hurry aunt blame peanut heavy update captain human rice crime juice adult scale device promote vast project quiz unit note reform update climb purchase"
+balance = 100_000_000_000_000
+# secret_key: 3eccc5dac8056590432db6a35d52b9896876a3d5cbdea53b72400bc9c2099fe801
+# stx_address: ST2REHHS5J3CERCRBEPMGH7921Q6PYKAADT7JP2VB
+# btc_address: mweN5WVqadScHdA81aATSdcVr4B6dNokqx
+
+[accounts.wallet_6]
+mnemonic = "area desk dutch sign gold cricket dawn toward giggle vibrant indoor bench warfare wagon number tiny universe sand talk dilemma pottery bone trap buddy"
+balance = 100_000_000_000_000
+# secret_key: 7036b29cb5e235e5fd9b09ae3e8eec4404e44906814d5d01cbca968a60ed4bfb01
+# stx_address: ST3AM1A56AK2C1XAFJ4115ZSV26EB49BVQ10MGCS0
+# btc_address: mzxXgV6e4BZSsz8zVHm3TmqbECt7mbuErt
+
+[accounts.wallet_7]
+mnemonic = "prevent gallery kind limb income control noise together echo rival record wedding sense uncover school version force bleak nuclear include danger skirt enact arrow"
+balance = 100_000_000_000_000
+# secret_key: b463f0df6c05d2f156393eee73f8016c5372caa0e9e29a901bb7171d90dc4f1401
+# stx_address: ST3PF13W7Z0RRM42A8VZRVFQ75SV1K26RXEP8YGKJ
+# btc_address: n37mwmru2oaVosgfuvzBwgV2ysCQRrLko7
+
+[accounts.wallet_8]
+mnemonic = "female adjust gallery certain visit token during great side clown fitness like hurt clip knife warm bench start reunion globe detail dream depend fortune"
+balance = 100_000_000_000_000
+# secret_key: 6a1a754ba863d7bab14adbbc3f8ebb090af9e871ace621d3e5ab634e1422885e01
+# stx_address: ST3NBRSFKX28FQ2ZJ1MAKX58HKHSDGNV5N7R21XCP
+# btc_address: n2v875jbJ4RjBnTjgbfikDfnwsDV5iUByw
+
+[accounts.wallet_9]
+mnemonic = "shadow private easily thought say logic fault paddle word top book during ignore notable orange flight clock image wealth health outside kitten belt reform"
+balance = 100_000_000_000_000
+# secret_key: de433bdfa14ec43aa1098d5be594c8ffb20a31485ff9de2923b2689471c401b801
+# stx_address: STNHKEPYEPJ8ET55ZZ0M5A34J0R3N5FM2CMMMAZ6
+# btc_address: mjSrB3wS4xab3kYqFktwBzfTdPg367ZJ2d
+
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/err_Commands.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/err_Commands.ts
new file mode 100644
index 00000000000..7e7a4f0e95b
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/err_Commands.ts
@@ -0,0 +1,2147 @@
+import fc from "fast-check";
+import { Simnet } from "@hirosystems/clarinet-sdk";
+import {
+ hasLockedStackers,
+ hasPoolMembers,
+ isAllowedContractCaller,
+ isAmountAboveThreshold,
+ isAmountLockedPositive,
+ isAmountWithinBalance,
+ isAmountWithinDelegationLimit,
+ isATCAboveThreshold,
+ isATCPositive,
+ isCallerAllowedByStacker,
+ isIncreaseByGTZero,
+ isIncreaseByWithinUnlockedBalance,
+ isPeriodWithinMax,
+ isStackerDelegatingToOperator,
+ isDelegating,
+ isStacking,
+ isStackingSolo,
+ isStackingMinimumCalculated,
+ isUBHWithinDelegationLimit,
+ isUnlockedWithinCurrentRC,
+ isStackerInOperatorPool,
+ isStackerLockedByOperator,
+ PoxCommand,
+ Stacker,
+ StxAddress,
+ Wallet,
+ isPositive,
+} from "./pox_CommandModel";
+import {
+ currentCycle,
+ currentCycleFirstBlock,
+ FIRST_BURNCHAIN_BLOCK_HEIGHT,
+ nextCycleFirstBlock,
+ REWARD_CYCLE_LENGTH,
+} from "./pox_Commands";
+import { DelegateStackExtendCommand_Err } from "./pox_DelegateStackExtendCommand_Err";
+import { DelegateStackIncreaseCommand_Err } from "./pox_DelegateStackIncreaseCommand_Err";
+import { DelegateStackStxCommand_Err } from "./pox_DelegateStackStxCommand_Err";
+import { DelegateStxCommand_Err } from "./pox_DelegateStxCommand_Err";
+import { RevokeDelegateStxCommand_Err } from "./pox_RevokeDelegateStxCommand_Err";
+import { StackAggregationCommitAuthCommand_Err } from "./pox_StackAggregationCommitAuthCommand_Err";
+import { StackAggregationCommitIndexedAuthCommand_Err } from "./pox_StackAggregationCommitIndexedAuthCommand_Err";
+import { StackAggregationCommitIndexedSigCommand_Err } from "./pox_StackAggregationCommitIndexedSigCommand_Err";
+import { StackAggregationCommitSigCommand_Err } from "./pox_StackAggregationCommitSigCommand_Err";
+import { StackAggregationIncreaseCommand_Err } from "./pox_StackAggregationIncreaseCommand_Err";
+import { StackExtendAuthCommand_Err } from "./pox_StackExtendAuthCommand_Err";
+import { StackExtendSigCommand_Err } from "./pox_StackExtendSigCommand_Err";
+import { StackIncreaseAuthCommand_Err } from "./pox_StackIncreaseAuthCommand_Err";
+import { StackIncreaseSigCommand_Err } from "./pox_StackIncreaseSigCommand_Err";
+import { StackStxAuthCommand_Err } from "./pox_StackStxAuthCommand_Err";
+import { StackStxSigCommand_Err } from "./pox_StackStxSigCommand_Err";
+import { DisallowContractCallerCommand_Err } from "./pox_DisallowContractCallerCommand_Err";
+
+const POX_4_ERRORS = {
+ ERR_STACKING_INSUFFICIENT_FUNDS: 1,
+ ERR_STACKING_INVALID_LOCK_PERIOD: 2,
+ ERR_STACKING_ALREADY_STACKED: 3,
+ ERR_STACKING_NO_SUCH_PRINCIPAL: 4,
+ ERR_STACKING_PERMISSION_DENIED: 9,
+ ERR_STACKING_THRESHOLD_NOT_MET: 11,
+ ERR_STACKING_INVALID_AMOUNT: 18,
+ ERR_STACKING_ALREADY_DELEGATED: 20,
+ ERR_DELEGATION_TOO_MUCH_LOCKED: 22,
+ ERR_STACK_EXTEND_NOT_LOCKED: 26,
+ ERR_STACKING_IS_DELEGATED: 30,
+ ERR_STACKING_NOT_DELEGATED: 31,
+ ERR_DELEGATION_ALREADY_REVOKED: 34,
+};
+
+export function ErrCommands(
+ wallets: Map,
+ stackers: Map,
+ network: Simnet,
+): fc.Arbitrary[] {
+ const cmds = [
+ // StackStxAuthCommand_Err_Stacking_Already_Stacked_1
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ period: fc.integer({ min: 1, max: 12 }),
+ margin: fc.integer({ min: 1, max: 9 }),
+ }).map((
+ r: {
+ wallet: Wallet;
+ authId: number;
+ period: number;
+ margin: number;
+ },
+ ) =>
+ new StackStxAuthCommand_Err(
+ r.wallet,
+ r.authId,
+ r.period,
+ r.margin,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ !isStacking(stacker) ||
+ isDelegating(stacker)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackStxAuthCommand_Err_Stacking_Already_Stacked_1",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_ALREADY_STACKED,
+ )
+ ),
+ // StackStxAuthCommand_Err_Stacking_Already_Stacked_2
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ period: fc.integer({ min: 1, max: 12 }),
+ margin: fc.integer({ min: 1, max: 9 }),
+ }).map((
+ r: {
+ wallet: Wallet;
+ authId: number;
+ period: number;
+ margin: number;
+ },
+ ) =>
+ new StackStxAuthCommand_Err(
+ r.wallet,
+ r.authId,
+ r.period,
+ r.margin,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ !isStacking(stacker) ||
+ !isDelegating(stacker)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackStxAuthCommand_Err_Stacking_Already_Stacked_2",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_ALREADY_STACKED,
+ )
+ ),
+ // StackStxAuthCommand_Err_Stacking_Already_Delegated
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ period: fc.integer({ min: 1, max: 12 }),
+ margin: fc.integer({ min: 1, max: 9 }),
+ }).map((
+ r: {
+ wallet: Wallet;
+ authId: number;
+ period: number;
+ margin: number;
+ },
+ ) =>
+ new StackStxAuthCommand_Err(
+ r.wallet,
+ r.authId,
+ r.period,
+ r.margin,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ isStacking(stacker) ||
+ !isDelegating(stacker)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackStxAuthCommand_Err_Stacking_Already_Delegated",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_ALREADY_DELEGATED,
+ )
+ ),
+ // StackStxSigCommand_Err_Stacking_Already_Stacked_1
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ period: fc.integer({ min: 1, max: 12 }),
+ margin: fc.integer({ min: 1, max: 9 }),
+ }).map((
+ r: {
+ wallet: Wallet;
+ authId: number;
+ period: number;
+ margin: number;
+ },
+ ) =>
+ new StackStxSigCommand_Err(
+ r.wallet,
+ r.authId,
+ r.period,
+ r.margin,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+ if (
+ !(isStackingMinimumCalculated(model)) ||
+ !isStacking(stacker) ||
+ isDelegating(stacker)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackStxSigCommand_Err_Stacking_Already_Stacked_1",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_ALREADY_STACKED,
+ )
+ ),
+ // StackStxSigCommand_Err_Stacking_Already_Stacked_2
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ period: fc.integer({ min: 1, max: 12 }),
+ margin: fc.integer({ min: 1, max: 9 }),
+ }).map((
+ r: {
+ wallet: Wallet;
+ authId: number;
+ period: number;
+ margin: number;
+ },
+ ) =>
+ new StackStxSigCommand_Err(
+ r.wallet,
+ r.authId,
+ r.period,
+ r.margin,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ !isStacking(stacker) ||
+ !isDelegating(stacker)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackStxSigCommand_Err_Stacking_Already_Stacked_2",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_ALREADY_STACKED,
+ )
+ ),
+ // StackStxSigCommand_Err_Stacking_Already_Delegated
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ period: fc.integer({ min: 1, max: 12 }),
+ margin: fc.integer({ min: 1, max: 9 }),
+ }).map((
+ r: {
+ wallet: Wallet;
+ authId: number;
+ period: number;
+ margin: number;
+ },
+ ) =>
+ new StackStxSigCommand_Err(
+ r.wallet,
+ r.authId,
+ r.period,
+ r.margin,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ isStacking(stacker) ||
+ !isDelegating(stacker)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackStxSigCommand_Err_Stacking_Already_Delegated",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_ALREADY_DELEGATED,
+ )
+ ),
+ // RevokeDelegateStxCommand_Err_Delegation_Already_Revoked
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ }).map((
+ r: {
+ wallet: Wallet;
+ },
+ ) =>
+ new RevokeDelegateStxCommand_Err(
+ r.wallet,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ isDelegating(stacker)
+ ) return false;
+
+ model.trackCommandRun(
+ "RevokeDelegateStxCommand_Err_Delegation_Already_Revoked",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_DELEGATION_ALREADY_REVOKED,
+ )
+ ),
+ // DelegateStxCommand_Err_Stacking_Already_Delegated
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ delegateTo: fc.constantFrom(...wallets.values()),
+ untilBurnHt: fc.integer({ min: 1 }),
+ amount: fc.bigInt({ min: 0n, max: 100_000_000_000_000n }),
+ })
+ .map((
+ r: {
+ wallet: Wallet;
+ delegateTo: Wallet;
+ untilBurnHt: number;
+ amount: bigint;
+ },
+ ) =>
+ new DelegateStxCommand_Err(
+ r.wallet,
+ r.delegateTo,
+ r.untilBurnHt,
+ r.amount,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ !isDelegating(stacker)
+ ) return false;
+
+ model.trackCommandRun(
+ "DelegateStxCommand_Err_Stacking_Already_Delegated",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_ALREADY_DELEGATED,
+ )
+ ),
+ // StackAggregationCommitSigCommand_Err_Stacking_Threshold_Not_Met
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ }).map(
+ (r: { wallet: Wallet; authId: number }) =>
+ new StackAggregationCommitSigCommand_Err(
+ r.wallet,
+ r.authId,
+ function (this, model) {
+ const operator = model.stackers.get(this.operator.stxAddress)!;
+
+ if (
+ !hasLockedStackers(operator) ||
+ isATCAboveThreshold(operator, model) ||
+ !isATCPositive(operator)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackAggregationCommitSigCommand_Err_Stacking_Threshold_Not_Met",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_THRESHOLD_NOT_MET,
+ ),
+ ),
+ // StackAggregationCommitSigCommand_Err_Stacking_No_Such_Principal_1
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ }).map(
+ (r: { wallet: Wallet; authId: number }) =>
+ new StackAggregationCommitSigCommand_Err(
+ r.wallet,
+ r.authId,
+ function (this, model) {
+ const operator = model.stackers.get(this.operator.stxAddress)!;
+
+ if (
+ !hasLockedStackers(operator) ||
+ isATCAboveThreshold(operator, model) ||
+ isATCPositive(operator)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackAggregationCommitSigCommand_Err_Stacking_No_Such_Principal_1",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_NO_SUCH_PRINCIPAL,
+ ),
+ ),
+ // StackAggregationCommitSigCommand_Err_Stacking_No_Such_Principal_2
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ }).map(
+ (r: { wallet: Wallet; authId: number }) =>
+ new StackAggregationCommitSigCommand_Err(
+ r.wallet,
+ r.authId,
+ function (this, model) {
+ const operator = model.stackers.get(this.operator.stxAddress)!;
+
+ if (
+ hasLockedStackers(operator) ||
+ isATCAboveThreshold(operator, model)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackAggregationCommitSigCommand_Err_Stacking_No_Such_Principal_2",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_NO_SUCH_PRINCIPAL,
+ ),
+ ),
+ // StackAggregationCommitAuthCommand_Err_Stacking_Threshold_Not_Met
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ }).map(
+ (r: { wallet: Wallet; authId: number }) =>
+ new StackAggregationCommitAuthCommand_Err(
+ r.wallet,
+ r.authId,
+ function (this, model) {
+ const operator = model.stackers.get(this.operator.stxAddress)!;
+
+ if (
+ !hasLockedStackers(operator) ||
+ isATCAboveThreshold(operator, model) ||
+ !isATCPositive(operator)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackAggregationCommitAuthCommand_Err_Stacking_Threshold_Not_Met",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_THRESHOLD_NOT_MET,
+ ),
+ ),
+ // StackAggregationCommitAuthCommand_Err_Stacking_No_Such_Principal_1
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ }).map(
+ (r: { wallet: Wallet; authId: number }) =>
+ new StackAggregationCommitAuthCommand_Err(
+ r.wallet,
+ r.authId,
+ function (this, model) {
+ const operator = model.stackers.get(this.operator.stxAddress)!;
+
+ if (
+ !hasLockedStackers(operator) ||
+ isATCAboveThreshold(operator, model) ||
+ isATCPositive(operator)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackAggregationCommitAuthCommand_Err_Stacking_No_Such_Principal_1",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_NO_SUCH_PRINCIPAL,
+ ),
+ ),
+ // StackAggregationCommitAuthCommand_Err_Stacking_No_Such_Principal_2
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ }).map(
+ (r: { wallet: Wallet; authId: number }) =>
+ new StackAggregationCommitAuthCommand_Err(
+ r.wallet,
+ r.authId,
+ function (this, model) {
+ const operator = model.stackers.get(this.operator.stxAddress)!;
+
+ if (
+ hasLockedStackers(operator) ||
+ isATCAboveThreshold(operator, model)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackAggregationCommitAuthCommand_Err_Stacking_No_Such_Principal_2",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_NO_SUCH_PRINCIPAL,
+ ),
+ ),
+ // StackAggregationCommitIndexedSigCommand_Err_Stacking_Threshold_Not_Met
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ }).map(
+ (r: { wallet: Wallet; authId: number }) =>
+ new StackAggregationCommitIndexedSigCommand_Err(
+ r.wallet,
+ r.authId,
+ function (this, model) {
+ const operator = model.stackers.get(this.operator.stxAddress)!;
+
+ if (
+ !hasLockedStackers(operator) ||
+ isATCAboveThreshold(operator, model) ||
+ !isATCPositive(operator)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackAggregationCommitIndexedSigCommand_Err_Stacking_Threshold_Not_Met",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_THRESHOLD_NOT_MET,
+ ),
+ ),
+ // StackAggregationCommitIndexedSigCommand_Err_Stacking_No_Such_Principal_1
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ }).map(
+ (r: { wallet: Wallet; authId: number }) =>
+ new StackAggregationCommitIndexedSigCommand_Err(
+ r.wallet,
+ r.authId,
+ function (this, model) {
+ const operator = model.stackers.get(this.operator.stxAddress)!;
+
+ if (
+ !hasLockedStackers(operator) ||
+ isATCAboveThreshold(operator, model) ||
+ isATCPositive(operator)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackAggregationCommitIndexedSigCommand_Err_Stacking_No_Such_Principal_1",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_NO_SUCH_PRINCIPAL,
+ ),
+ ),
+ // StackAggregationCommitIndexedSigCommand_Err_Stacking_No_Such_Principal_2
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ }).map(
+ (r: { wallet: Wallet; authId: number }) =>
+ new StackAggregationCommitIndexedSigCommand_Err(
+ r.wallet,
+ r.authId,
+ function (this, model) {
+ const operator = model.stackers.get(this.operator.stxAddress)!;
+
+ if (
+ hasLockedStackers(operator) ||
+ isATCAboveThreshold(operator, model)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackAggregationCommitIndexedSigCommand_Err_Stacking_No_Such_Principal_2",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_NO_SUCH_PRINCIPAL,
+ ),
+ ),
+ // StackAggregationCommitIndexedAuthCommand_Err_Stacking_No_Such_Principal_1
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ }).map(
+ (r: { wallet: Wallet; authId: number }) =>
+ new StackAggregationCommitIndexedAuthCommand_Err(
+ r.wallet,
+ r.authId,
+ function (this, model) {
+ const operator = model.stackers.get(this.operator.stxAddress)!;
+
+ if (
+ !hasLockedStackers(operator) ||
+ isATCAboveThreshold(operator, model) ||
+ isATCPositive(operator)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackAggregationCommitIndexedAuthCommand_Err_Stacking_No_Such_Principal_1",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_NO_SUCH_PRINCIPAL,
+ ),
+ ),
+ // StackAggregationCommitIndexedAuthCommand_Err_Stacking_No_Such_Principal_2
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ }).map(
+ (r: { wallet: Wallet; authId: number }) =>
+ new StackAggregationCommitIndexedAuthCommand_Err(
+ r.wallet,
+ r.authId,
+ function (this, model) {
+ const operator = model.stackers.get(this.operator.stxAddress)!;
+
+ if (
+ hasLockedStackers(operator) ||
+ isATCAboveThreshold(operator, model)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackAggregationCommitIndexedAuthCommand_Err_Stacking_No_Such_Principal_2",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_NO_SUCH_PRINCIPAL,
+ ),
+ ),
+ // StackAggregationCommitIndexedAuthCommand_Err_Stacking_Threshold_Not_Met
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ }).map(
+ (r: { wallet: Wallet; authId: number }) =>
+ new StackAggregationCommitIndexedAuthCommand_Err(
+ r.wallet,
+ r.authId,
+ function (this, model) {
+ const operator = model.stackers.get(this.operator.stxAddress)!;
+
+ if (
+ !hasLockedStackers(operator) ||
+ isATCAboveThreshold(operator, model) ||
+ !isATCPositive(operator)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackAggregationCommitIndexedAuthCommand_Err_Stacking_Threshold_Not_Met",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_THRESHOLD_NOT_MET,
+ ),
+ ),
+ // StackAggregationIncreaseCommand_Err_Stacking_No_Such_Principal
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ }).chain((r) => {
+ const operator = stackers.get(r.wallet.stxAddress)!;
+ const committedRewCycleIndexesOrFallback =
+ operator.committedRewCycleIndexes.length > 0
+ ? operator.committedRewCycleIndexes
+ : [-1];
+ return fc
+ .record({
+ rewardCycleIndex: fc.constantFrom(
+ ...committedRewCycleIndexesOrFallback,
+ ),
+ })
+ .map((cycleIndex) => ({ ...r, ...cycleIndex }));
+ }).map(
+ (r: { wallet: Wallet; rewardCycleIndex: number; authId: number }) =>
+ new StackAggregationIncreaseCommand_Err(
+ r.wallet,
+ r.rewardCycleIndex,
+ r.authId,
+ function (this, model) {
+ const operator = model.stackers.get(this.operator.stxAddress)!;
+ if (
+ !hasLockedStackers(operator) ||
+ !isPositive(this.rewardCycleIndex) ||
+ isATCPositive(operator)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackAggregationIncreaseCommand_Err_Stacking_No_Such_Principal",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_NO_SUCH_PRINCIPAL,
+ ),
+ ),
+ // DelegateStackStxCommand_Err_Delegation_Too_Much_Locked
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ startBurnHt: fc.integer({
+ min: currentCycleFirstBlock(network),
+ max: nextCycleFirstBlock(network),
+ }),
+ period: fc.integer({ min: 1, max: 12 }),
+ }).chain((r) => {
+ const operator = stackers.get(r.operator.stxAddress)!;
+ // Determine available stackers based on the operator
+ const availableStackers = operator.poolMembers.length > 0
+ ? operator.poolMembers
+ : [r.operator.stxAddress];
+
+ return fc.record({
+ stacker: fc.constantFrom(...availableStackers),
+ }).map((stacker) => ({
+ ...r,
+ stacker: wallets.get(stacker.stacker)!,
+ })).chain((resultWithStacker) => {
+ return fc.record({
+ unlockBurnHt: fc.constant(
+ currentCycleFirstBlock(network) +
+ 1050 * (resultWithStacker.period + 1),
+ ),
+ }).map((additionalProps) => ({
+ ...resultWithStacker,
+ ...additionalProps,
+ }));
+ }).chain((resultWithUnlockHeight) => {
+ return fc.record({
+ amount: fc.bigInt({
+ min: 0n,
+ max: 100_000_000_000_000n,
+ }),
+ }).map((amountProps) => ({
+ ...resultWithUnlockHeight,
+ ...amountProps,
+ }));
+ });
+ }).map((finalResult) => {
+ return new DelegateStackStxCommand_Err(
+ finalResult.operator,
+ finalResult.stacker,
+ finalResult.period,
+ finalResult.amount,
+ finalResult.unlockBurnHt,
+ function (this, model) {
+ const operatorWallet = model.stackers.get(this.operator.stxAddress)!;
+ const stackerWallet = model.stackers.get(this.stacker.stxAddress)!;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ isStacking(stackerWallet) ||
+ !isDelegating(stackerWallet) ||
+ isAmountWithinDelegationLimit(stackerWallet, this.amountUstx) ||
+ !isAmountWithinBalance(stackerWallet, this.amountUstx) ||
+ !isAmountAboveThreshold(model, this.amountUstx) ||
+ !isStackerInOperatorPool(operatorWallet, this.stacker) ||
+ !isUBHWithinDelegationLimit(stackerWallet, this.unlockBurnHt)
+ ) return false;
+
+ model.trackCommandRun(
+ "DelegateStackStxCommand_Err_Delegation_Too_Much_Locked",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_DELEGATION_TOO_MUCH_LOCKED,
+ );
+ }),
+ // DelegateStackStxCommand_Err_Stacking_Permission_Denied
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ startBurnHt: fc.integer({
+ min: currentCycleFirstBlock(network),
+ max: nextCycleFirstBlock(network),
+ }),
+ period: fc.integer({ min: 1, max: 12 }),
+ }).chain((r) => {
+ const operator = stackers.get(r.operator.stxAddress)!;
+ // Determine available stackers based on the operator
+ const availableStackers = operator.poolMembers.length > 0
+ ? operator.poolMembers
+ : [r.operator.stxAddress];
+
+ return fc.record({
+ stacker: fc.constantFrom(...availableStackers),
+ }).map((stacker) => ({
+ ...r,
+ stacker: wallets.get(stacker.stacker)!,
+ })).chain((resultWithStacker) => {
+ return fc.record({
+ unlockBurnHt: fc.constant(
+ currentCycleFirstBlock(network) +
+ 1050 * (resultWithStacker.period + 1),
+ ),
+ }).map((additionalProps) => ({
+ ...resultWithStacker,
+ ...additionalProps,
+ }));
+ }).chain((resultWithUnlockHeight) => {
+ return fc.record({
+ amount: fc.bigInt({
+ min: 0n,
+ max: BigInt(
+ stackers.get(resultWithUnlockHeight.stacker.stxAddress)!
+ .delegatedMaxAmount,
+ ),
+ }),
+ }).map((amountProps) => ({
+ ...resultWithUnlockHeight,
+ ...amountProps,
+ }));
+ });
+ }).map((finalResult) => {
+ return new DelegateStackStxCommand_Err(
+ finalResult.operator,
+ finalResult.stacker,
+ finalResult.period,
+ finalResult.amount,
+ finalResult.unlockBurnHt,
+ function (this, model) {
+ const operatorWallet = model.stackers.get(this.operator.stxAddress)!;
+ const stackerWallet = model.stackers.get(this.stacker.stxAddress)!;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ isStacking(stackerWallet) ||
+ !isDelegating(stackerWallet) ||
+ !isAmountWithinDelegationLimit(stackerWallet, this.amountUstx) ||
+ !isAmountWithinBalance(stackerWallet, this.amountUstx) ||
+ !isAmountAboveThreshold(model, this.amountUstx) ||
+ isStackerInOperatorPool(operatorWallet, this.stacker) ||
+ !isUBHWithinDelegationLimit(stackerWallet, this.unlockBurnHt)
+ ) return false;
+
+ model.trackCommandRun(
+ "DelegateStackStxCommand_Err_Stacking_Permission_Denied_1",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_PERMISSION_DENIED,
+ );
+ }),
+ // DelegateStackStxCommand_Err_Stacking_Permission_Denied_2
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ startBurnHt: fc.integer({
+ min: currentCycleFirstBlock(network),
+ max: nextCycleFirstBlock(network),
+ }),
+ period: fc.integer({ min: 1, max: 12 }),
+ }).chain((r) => {
+ const operator = stackers.get(r.operator.stxAddress)!;
+ // Determine available stackers based on the operator
+ const availableStackers = operator.poolMembers.length > 0
+ ? operator.poolMembers
+ : [r.operator.stxAddress];
+
+ return fc.record({
+ stacker: fc.constantFrom(...availableStackers),
+ }).map((stacker) => ({
+ ...r,
+ stacker: wallets.get(stacker.stacker)!,
+ })).chain((resultWithStacker) => {
+ return fc.record({
+ unlockBurnHt: fc.constant(
+ currentCycleFirstBlock(network) +
+ 1050 * (resultWithStacker.period + 1),
+ ),
+ }).map((additionalProps) => ({
+ ...resultWithStacker,
+ ...additionalProps,
+ }));
+ }).chain((resultWithUnlockHeight) => {
+ return fc.record({
+ amount: fc.bigInt({
+ min: 0n,
+ max: 100_000_000_000_000n,
+ }),
+ }).map((amountProps) => ({
+ ...resultWithUnlockHeight,
+ ...amountProps,
+ }));
+ });
+ }).map((finalResult) => {
+ return new DelegateStackStxCommand_Err(
+ finalResult.operator,
+ finalResult.stacker,
+ finalResult.period,
+ finalResult.amount,
+ finalResult.unlockBurnHt,
+ function (this, model) {
+ const operatorWallet = model.stackers.get(this.operator.stxAddress)!;
+ const stackerWallet = model.stackers.get(this.stacker.stxAddress)!;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ isStacking(stackerWallet) ||
+ isDelegating(stackerWallet) ||
+ isAmountWithinDelegationLimit(stackerWallet, this.amountUstx) ||
+ !isAmountWithinBalance(stackerWallet, this.amountUstx) ||
+ !isAmountAboveThreshold(model, this.amountUstx) ||
+ isStackerInOperatorPool(operatorWallet, this.stacker) ||
+ isUBHWithinDelegationLimit(stackerWallet, this.unlockBurnHt)
+ ) return false;
+
+ model.trackCommandRun(
+ "DelegateStackStxCommand_Err_Stacking_Permission_Denied_2",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_PERMISSION_DENIED,
+ );
+ }),
+ // StackIncreaseSigCommand_Err_Stacking_Is_Delegated
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ increaseBy: fc.nat(),
+ authId: fc.nat(),
+ }).map(
+ (r) =>
+ new StackIncreaseSigCommand_Err(
+ r.operator,
+ r.increaseBy,
+ r.authId,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ !isStacking(stacker) ||
+ isStackingSolo(stacker) ||
+ isDelegating(stacker) ||
+ !isAmountLockedPositive(stacker) ||
+ !isIncreaseByWithinUnlockedBalance(stacker, this.increaseBy) ||
+ !isIncreaseByGTZero(this.increaseBy)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackIncreaseSigCommand_Err_Stacking_Is_Delegated",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_IS_DELEGATED,
+ ),
+ ),
+ // StackIncreaseSigCommand_Err_Stacking_Insufficient_Funds
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ increaseBy: fc.constant(100_000_000_000_000),
+ authId: fc.nat(),
+ }).map(
+ (r) =>
+ new StackIncreaseSigCommand_Err(
+ r.operator,
+ r.increaseBy,
+ r.authId,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ !isStacking(stacker) ||
+ !isStackingSolo(stacker) ||
+ isDelegating(stacker) ||
+ !isAmountLockedPositive(stacker) ||
+ isIncreaseByWithinUnlockedBalance(stacker, this.increaseBy) ||
+ !isIncreaseByGTZero(this.increaseBy)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackIncreaseSigCommand_Err_Stacking_Insufficient_Funds",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_INSUFFICIENT_FUNDS,
+ ),
+ ),
+ // StackIncreaseSigCommand_Err_Stacking_Invalid_Amount
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ increaseBy: fc.constant(0),
+ authId: fc.nat(),
+ }).map(
+ (r) =>
+ new StackIncreaseSigCommand_Err(
+ r.operator,
+ r.increaseBy,
+ r.authId,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ !isStacking(stacker) ||
+ !isStackingSolo(stacker) ||
+ isDelegating(stacker) ||
+ !isAmountLockedPositive(stacker) ||
+ !isIncreaseByWithinUnlockedBalance(stacker, this.increaseBy) ||
+ isIncreaseByGTZero(this.increaseBy)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackIncreaseSigCommand_Err_Stacking_Invalid_Amount",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_INVALID_AMOUNT,
+ ),
+ ),
+ // StackIncreaseAuthCommand_Err_Stacking_Is_Delegated
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ increaseBy: fc.nat(),
+ authId: fc.nat(),
+ }).map(
+ (r) =>
+ new StackIncreaseAuthCommand_Err(
+ r.operator,
+ r.increaseBy,
+ r.authId,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ !isStacking(stacker) ||
+ isStackingSolo(stacker) ||
+ isDelegating(stacker) ||
+ !isAmountLockedPositive(stacker) ||
+ !isIncreaseByWithinUnlockedBalance(stacker, this.increaseBy) ||
+ !isIncreaseByGTZero(this.increaseBy)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackIncreaseAuthCommand_Err_Stacking_Is_Delegated",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_IS_DELEGATED,
+ ),
+ ),
+ // StackIncreaseAuthCommand_Err_Stacking_Insufficient_Funds
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ increaseBy: fc.constant(100_000_000_000_000),
+ authId: fc.nat(),
+ }).map(
+ (r) =>
+ new StackIncreaseAuthCommand_Err(
+ r.operator,
+ r.increaseBy,
+ r.authId,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ !isStacking(stacker) ||
+ !isStackingSolo(stacker) ||
+ isDelegating(stacker) ||
+ !isAmountLockedPositive(stacker) ||
+ isIncreaseByWithinUnlockedBalance(stacker, this.increaseBy) ||
+ !isIncreaseByGTZero(this.increaseBy)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackIncreaseAuthCommand_Err_Stacking_Insufficient_Funds",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_INSUFFICIENT_FUNDS,
+ ),
+ ),
+ // StackIncreaseAuthCommand_Err_Stacking_Invalid_Amount
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ increaseBy: fc.constant(0),
+ authId: fc.nat(),
+ }).map(
+ (r) =>
+ new StackIncreaseAuthCommand_Err(
+ r.operator,
+ r.increaseBy,
+ r.authId,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ !isStacking(stacker) ||
+ !isStackingSolo(stacker) ||
+ isDelegating(stacker) ||
+ !isAmountLockedPositive(stacker) ||
+ !isIncreaseByWithinUnlockedBalance(stacker, this.increaseBy) ||
+ isIncreaseByGTZero(this.increaseBy)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackIncreaseAuthCommand_Err_Stacking_Invalid_Amount",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_INVALID_AMOUNT,
+ ),
+ ),
+ // StackExtendSigCommand_Err_Stacking_Is_Delegated_1
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ extendCount: fc.integer({ min: 1, max: 12 }),
+ currentCycle: fc.constant(currentCycle(network)),
+ }).map(
+ (r: {
+ wallet: Wallet;
+ extendCount: number;
+ authId: number;
+ currentCycle: number;
+ }) =>
+ new StackExtendSigCommand_Err(
+ r.wallet,
+ r.extendCount,
+ r.authId,
+ r.currentCycle,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+
+ const firstRewardCycle = Math.max(
+ stacker.firstLockedRewardCycle,
+ this.currentCycle,
+ );
+ const firstExtendCycle = Math.floor(
+ (stacker.unlockHeight - FIRST_BURNCHAIN_BLOCK_HEIGHT) /
+ REWARD_CYCLE_LENGTH,
+ );
+ const lastExtendCycle = firstExtendCycle + this.extendCount - 1;
+ const totalPeriod = lastExtendCycle - firstRewardCycle + 1;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ !isStacking(stacker) ||
+ isStackingSolo(stacker) ||
+ isDelegating(stacker) ||
+ !isAmountLockedPositive(stacker) ||
+ hasLockedStackers(stacker) ||
+ !isPeriodWithinMax(totalPeriod)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackExtendSigCommand_Err_Stacking_Is_Delegated_1",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_IS_DELEGATED,
+ ),
+ ),
+ // StackExtendSigCommand_Err_Stacking_Is_Delegated_2
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ extendCount: fc.integer({ min: 1, max: 12 }),
+ currentCycle: fc.constant(currentCycle(network)),
+ }).map(
+ (r: {
+ wallet: Wallet;
+ extendCount: number;
+ authId: number;
+ currentCycle: number;
+ }) =>
+ new StackExtendSigCommand_Err(
+ r.wallet,
+ r.extendCount,
+ r.authId,
+ r.currentCycle,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+
+ const firstRewardCycle = Math.max(
+ stacker.firstLockedRewardCycle,
+ this.currentCycle,
+ );
+ const firstExtendCycle = Math.floor(
+ (stacker.unlockHeight - FIRST_BURNCHAIN_BLOCK_HEIGHT) /
+ REWARD_CYCLE_LENGTH,
+ );
+ const lastExtendCycle = firstExtendCycle + this.extendCount - 1;
+ const totalPeriod = lastExtendCycle - firstRewardCycle + 1;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ !isStacking(stacker) ||
+ isStackingSolo(stacker) ||
+ isDelegating(stacker) ||
+ !isAmountLockedPositive(stacker) ||
+ !hasPoolMembers(stacker) ||
+ !isPeriodWithinMax(totalPeriod)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackExtendSigCommand_Err_Stacking_Is_Delegated_2",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_IS_DELEGATED,
+ ),
+ ),
+ // StackExtendSigCommand_Err_Stacking_Already_Delegated
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ extendCount: fc.integer({ min: 1, max: 12 }),
+ currentCycle: fc.constant(currentCycle(network)),
+ }).map(
+ (r: {
+ wallet: Wallet;
+ extendCount: number;
+ authId: number;
+ currentCycle: number;
+ }) =>
+ new StackExtendSigCommand_Err(
+ r.wallet,
+ r.extendCount,
+ r.authId,
+ r.currentCycle,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+
+ const firstRewardCycle = Math.max(
+ stacker.firstLockedRewardCycle,
+ this.currentCycle,
+ );
+ const firstExtendCycle = Math.floor(
+ (stacker.unlockHeight - FIRST_BURNCHAIN_BLOCK_HEIGHT) /
+ REWARD_CYCLE_LENGTH,
+ );
+ const lastExtendCycle = firstExtendCycle + this.extendCount - 1;
+ const totalPeriod = lastExtendCycle - firstRewardCycle + 1;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ !isStacking(stacker) ||
+ !isStackingSolo(stacker) ||
+ !isDelegating(stacker) ||
+ !isAmountLockedPositive(stacker) ||
+ hasLockedStackers(stacker) ||
+ !isPeriodWithinMax(totalPeriod)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackExtendSigCommand_Err_Stacking_Already_Delegated",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_ALREADY_DELEGATED,
+ ),
+ ),
+ // StackExtendSigCommand_Err_Stacking_Invalid_Lock_Period
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ extendCount: fc.integer(),
+ currentCycle: fc.constant(currentCycle(network)),
+ }).map(
+ (r: {
+ wallet: Wallet;
+ extendCount: number;
+ authId: number;
+ currentCycle: number;
+ }) =>
+ new StackExtendSigCommand_Err(
+ r.wallet,
+ r.extendCount,
+ r.authId,
+ r.currentCycle,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+
+ const firstRewardCycle = Math.max(
+ stacker.firstLockedRewardCycle,
+ this.currentCycle,
+ );
+ const firstExtendCycle = Math.floor(
+ (stacker.unlockHeight - FIRST_BURNCHAIN_BLOCK_HEIGHT) /
+ REWARD_CYCLE_LENGTH,
+ );
+ const lastExtendCycle = firstExtendCycle + this.extendCount - 1;
+ const totalPeriod = lastExtendCycle - firstRewardCycle + 1;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ !isStacking(stacker) ||
+ !isStackingSolo(stacker) ||
+ isDelegating(stacker) ||
+ !isAmountLockedPositive(stacker) ||
+ hasLockedStackers(stacker) ||
+ isPeriodWithinMax(totalPeriod)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackExtendSigCommand_Err_Stacking_Invalid_Lock_Period",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_INVALID_LOCK_PERIOD,
+ ),
+ ),
+ // StackExtendSigCommand_Err_Stack_Extend_Not_Locked
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ extendCount: fc.integer({ min: 1, max: 12 }),
+ currentCycle: fc.constant(currentCycle(network)),
+ }).map(
+ (r: {
+ wallet: Wallet;
+ extendCount: number;
+ authId: number;
+ currentCycle: number;
+ }) =>
+ new StackExtendSigCommand_Err(
+ r.wallet,
+ r.extendCount,
+ r.authId,
+ r.currentCycle,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+
+ const firstRewardCycle = Math.max(
+ stacker.firstLockedRewardCycle,
+ this.currentCycle,
+ );
+ const firstExtendCycle = Math.floor(
+ (stacker.unlockHeight - FIRST_BURNCHAIN_BLOCK_HEIGHT) /
+ REWARD_CYCLE_LENGTH,
+ );
+ const lastExtendCycle = firstExtendCycle + this.extendCount - 1;
+ const totalPeriod = lastExtendCycle - firstRewardCycle + 1;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ isStacking(stacker) ||
+ isStackingSolo(stacker) ||
+ isDelegating(stacker) ||
+ isAmountLockedPositive(stacker) ||
+ hasLockedStackers(stacker) ||
+ !isPeriodWithinMax(totalPeriod)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackExtendSigCommand_Err_Stack_Extend_Not_Locked",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACK_EXTEND_NOT_LOCKED,
+ ),
+ ),
+ // StackExtendAuthCommand_Err_Stacking_Is_Delegated_1
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ extendCount: fc.integer({ min: 1, max: 12 }),
+ currentCycle: fc.constant(currentCycle(network)),
+ }).map(
+ (r: {
+ wallet: Wallet;
+ extendCount: number;
+ authId: number;
+ currentCycle: number;
+ }) =>
+ new StackExtendAuthCommand_Err(
+ r.wallet,
+ r.extendCount,
+ r.authId,
+ r.currentCycle,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+
+ const firstRewardCycle = Math.max(
+ stacker.firstLockedRewardCycle,
+ this.currentCycle,
+ );
+ const firstExtendCycle = Math.floor(
+ (stacker.unlockHeight - FIRST_BURNCHAIN_BLOCK_HEIGHT) /
+ REWARD_CYCLE_LENGTH,
+ );
+ const lastExtendCycle = firstExtendCycle + this.extendCount - 1;
+ const totalPeriod = lastExtendCycle - firstRewardCycle + 1;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ !isStacking(stacker) ||
+ isStackingSolo(stacker) ||
+ isDelegating(stacker) ||
+ !isAmountLockedPositive(stacker) ||
+ hasLockedStackers(stacker) ||
+ !isPeriodWithinMax(totalPeriod)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackExtendAuthCommand_Err_Stacking_Is_Delegated_1",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_IS_DELEGATED,
+ ),
+ ),
+ // StackExtendAuthCommand_Err_Stacking_Is_Delegated_2
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ extendCount: fc.integer({ min: 1, max: 12 }),
+ currentCycle: fc.constant(currentCycle(network)),
+ }).map(
+ (r: {
+ wallet: Wallet;
+ extendCount: number;
+ authId: number;
+ currentCycle: number;
+ }) =>
+ new StackExtendAuthCommand_Err(
+ r.wallet,
+ r.extendCount,
+ r.authId,
+ r.currentCycle,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+
+ const firstRewardCycle = Math.max(
+ stacker.firstLockedRewardCycle,
+ this.currentCycle,
+ );
+ const firstExtendCycle = Math.floor(
+ (stacker.unlockHeight - FIRST_BURNCHAIN_BLOCK_HEIGHT) /
+ REWARD_CYCLE_LENGTH,
+ );
+ const lastExtendCycle = firstExtendCycle + this.extendCount - 1;
+ const totalPeriod = lastExtendCycle - firstRewardCycle + 1;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ !isStacking(stacker) ||
+ isStackingSolo(stacker) ||
+ isDelegating(stacker) ||
+ !isAmountLockedPositive(stacker) ||
+ !hasPoolMembers(stacker) ||
+ !isPeriodWithinMax(totalPeriod)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackExtendAuthCommand_Err_Stacking_Is_Delegated_2",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_IS_DELEGATED,
+ ),
+ ),
+ // StackExtendAuthCommand_Err_Stacking_Already_Delegated
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ extendCount: fc.integer({ min: 1, max: 12 }),
+ currentCycle: fc.constant(currentCycle(network)),
+ }).map(
+ (r: {
+ wallet: Wallet;
+ extendCount: number;
+ authId: number;
+ currentCycle: number;
+ }) =>
+ new StackExtendAuthCommand_Err(
+ r.wallet,
+ r.extendCount,
+ r.authId,
+ r.currentCycle,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+
+ const firstRewardCycle = Math.max(
+ stacker.firstLockedRewardCycle,
+ this.currentCycle,
+ );
+ const firstExtendCycle = Math.floor(
+ (stacker.unlockHeight - FIRST_BURNCHAIN_BLOCK_HEIGHT) /
+ REWARD_CYCLE_LENGTH,
+ );
+ const lastExtendCycle = firstExtendCycle + this.extendCount - 1;
+ const totalPeriod = lastExtendCycle - firstRewardCycle + 1;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ !isStacking(stacker) ||
+ !isStackingSolo(stacker) ||
+ !isDelegating(stacker) ||
+ !isAmountLockedPositive(stacker) ||
+ hasLockedStackers(stacker) ||
+ !isPeriodWithinMax(totalPeriod)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackExtendAuthCommand_Err_Stacking_Already_Delegated",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_ALREADY_DELEGATED,
+ ),
+ ),
+ // StackExtendAuthCommand_Err_Stacking_Invalid_Lock_Period
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ extendCount: fc.integer(),
+ currentCycle: fc.constant(currentCycle(network)),
+ }).map(
+ (r: {
+ wallet: Wallet;
+ extendCount: number;
+ authId: number;
+ currentCycle: number;
+ }) =>
+ new StackExtendAuthCommand_Err(
+ r.wallet,
+ r.extendCount,
+ r.authId,
+ r.currentCycle,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+
+ const firstRewardCycle = Math.max(
+ stacker.firstLockedRewardCycle,
+ this.currentCycle,
+ );
+ const firstExtendCycle = Math.floor(
+ (stacker.unlockHeight - FIRST_BURNCHAIN_BLOCK_HEIGHT) /
+ REWARD_CYCLE_LENGTH,
+ );
+ const lastExtendCycle = firstExtendCycle + this.extendCount - 1;
+ const totalPeriod = lastExtendCycle - firstRewardCycle + 1;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ !isStacking(stacker) ||
+ !isStackingSolo(stacker) ||
+ isDelegating(stacker) ||
+ !isAmountLockedPositive(stacker) ||
+ hasLockedStackers(stacker) ||
+ isPeriodWithinMax(totalPeriod)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackExtendAuthCommand_Err_Stacking_Invalid_Lock_Period",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_INVALID_LOCK_PERIOD,
+ ),
+ ),
+ // StackExtendAuthCommand_Err_Stack_Extend_Not_Locked
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ extendCount: fc.integer({ min: 1, max: 12 }),
+ currentCycle: fc.constant(currentCycle(network)),
+ }).map(
+ (r: {
+ wallet: Wallet;
+ extendCount: number;
+ authId: number;
+ currentCycle: number;
+ }) =>
+ new StackExtendAuthCommand_Err(
+ r.wallet,
+ r.extendCount,
+ r.authId,
+ r.currentCycle,
+ function (this, model) {
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+
+ const firstRewardCycle = Math.max(
+ stacker.firstLockedRewardCycle,
+ this.currentCycle,
+ );
+ const firstExtendCycle = Math.floor(
+ (stacker.unlockHeight - FIRST_BURNCHAIN_BLOCK_HEIGHT) /
+ REWARD_CYCLE_LENGTH,
+ );
+ const lastExtendCycle = firstExtendCycle + this.extendCount - 1;
+ const totalPeriod = lastExtendCycle - firstRewardCycle + 1;
+ if (
+ !isStackingMinimumCalculated(model) ||
+ isStacking(stacker) ||
+ isStackingSolo(stacker) ||
+ isDelegating(stacker) ||
+ isAmountLockedPositive(stacker) ||
+ hasLockedStackers(stacker) ||
+ !isPeriodWithinMax(totalPeriod)
+ ) return false;
+
+ model.trackCommandRun(
+ "StackExtendAuthCommand_Err_Stack_Extend_Not_Locked",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACK_EXTEND_NOT_LOCKED,
+ ),
+ ),
+ // DelegateStackExtendCommand_Err_Stacking_Invalid_Lock_Period
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ extendCount: fc.constant(100000000000000),
+ }).chain((r) => {
+ const operator = stackers.get(r.operator.stxAddress)!;
+ const delegatorsList = operator.poolMembers;
+ const availableStackers = delegatorsList.filter((delegator) => {
+ const delegatorWallet = stackers.get(delegator)!;
+ return delegatorWallet.unlockHeight > nextCycleFirstBlock(network);
+ });
+
+ const availableStackersOrFallback = availableStackers.length === 0
+ ? [r.operator.stxAddress]
+ : availableStackers;
+
+ return fc.record({
+ stacker: fc.constantFrom(...availableStackersOrFallback),
+ currentCycle: fc.constant(currentCycle(network)),
+ }).map((additionalProps) => ({
+ ...r,
+ stacker: wallets.get(additionalProps.stacker)!,
+ currentCycle: additionalProps.currentCycle,
+ }));
+ }).map(
+ (final) =>
+ new DelegateStackExtendCommand_Err(
+ final.operator,
+ final.stacker,
+ final.extendCount,
+ final.currentCycle,
+ function (this, model) {
+ const operator = model.stackers.get(
+ this.operator.stxAddress,
+ )!;
+ const stacker = model.stackers.get(
+ this.stacker.stxAddress,
+ )!;
+
+ const firstRewardCycle = Math.max(
+ stacker.firstLockedRewardCycle,
+ this.currentCycle,
+ );
+ const firstExtendCycle = Math.floor(
+ (stacker.unlockHeight - FIRST_BURNCHAIN_BLOCK_HEIGHT) /
+ REWARD_CYCLE_LENGTH,
+ );
+ const lastExtendCycle = firstExtendCycle + this.extendCount - 1;
+ const totalPeriod = lastExtendCycle - firstRewardCycle + 1;
+ const newUnlockHeight =
+ REWARD_CYCLE_LENGTH * (firstRewardCycle + totalPeriod - 1) +
+ FIRST_BURNCHAIN_BLOCK_HEIGHT;
+ const stackedAmount = stacker.amountLocked;
+
+ if (
+ !isAmountLockedPositive(stacker) ||
+ !isDelegating(stacker) ||
+ !isStacking(stacker) ||
+ !isStackerDelegatingToOperator(stacker, this.operator) ||
+ isUBHWithinDelegationLimit(stacker, newUnlockHeight) ||
+ !isAmountWithinDelegationLimit(stacker, stackedAmount) ||
+ !isStackerInOperatorPool(operator, this.stacker) ||
+ !isStackerLockedByOperator(operator, this.stacker) ||
+ isPeriodWithinMax(totalPeriod)
+ ) return false;
+
+ model.trackCommandRun(
+ "DelegateStackExtendCommand_Err_Stacking_Invalid_Lock_Period",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_INVALID_LOCK_PERIOD,
+ ),
+ ),
+ // DelegateStackExtendCommand_Err_Stacking_Not_Delegated
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ extendCount: fc.integer({ min: 1, max: 11 }),
+ }).chain((r) => {
+ const operator = stackers.get(r.operator.stxAddress)!;
+ const delegatorsList = operator.poolMembers;
+ const availableStackers = delegatorsList.filter((delegator) => {
+ const delegatorWallet = stackers.get(delegator)!;
+ return delegatorWallet.unlockHeight > nextCycleFirstBlock(network);
+ });
+
+ const availableStackersOrFallback = availableStackers.length === 0
+ ? [r.operator.stxAddress]
+ : availableStackers;
+
+ return fc
+ .record({
+ stacker: fc.constantFrom(...availableStackersOrFallback),
+ currentCycle: fc.constant(currentCycle(network)),
+ })
+ .map((additionalProps) => ({
+ ...r,
+ stacker: wallets.get(additionalProps.stacker)!,
+ currentCycle: additionalProps.currentCycle,
+ }));
+ }).map(
+ (final) =>
+ new DelegateStackExtendCommand_Err(
+ final.operator,
+ final.stacker,
+ final.extendCount,
+ final.currentCycle,
+ function (this, model) {
+ const operator = model.stackers.get(
+ this.operator.stxAddress,
+ )!;
+ const stacker = model.stackers.get(
+ this.stacker.stxAddress,
+ )!;
+
+ const firstRewardCycle = Math.max(
+ stacker.firstLockedRewardCycle,
+ this.currentCycle,
+ );
+ const firstExtendCycle = Math.floor(
+ (stacker.unlockHeight - FIRST_BURNCHAIN_BLOCK_HEIGHT) /
+ REWARD_CYCLE_LENGTH,
+ );
+ const lastExtendCycle = firstExtendCycle + this.extendCount - 1;
+ const totalPeriod = lastExtendCycle - firstRewardCycle + 1;
+ const newUnlockHeight =
+ REWARD_CYCLE_LENGTH * (firstRewardCycle + totalPeriod - 1) +
+ FIRST_BURNCHAIN_BLOCK_HEIGHT;
+ const stackedAmount = stacker.amountLocked;
+
+ if (
+ !isAmountLockedPositive(stacker) ||
+ isDelegating(stacker) ||
+ !isStacking(stacker) ||
+ !isStackingSolo(stacker) ||
+ isStackerDelegatingToOperator(stacker, this.operator) ||
+ isUBHWithinDelegationLimit(stacker, newUnlockHeight) ||
+ isAmountWithinDelegationLimit(stacker, stackedAmount) ||
+ isStackerInOperatorPool(operator, this.stacker) ||
+ isStackerLockedByOperator(operator, this.stacker) ||
+ !isPeriodWithinMax(totalPeriod)
+ ) return false;
+
+ model.trackCommandRun(
+ "DelegateStackExtendCommand_Err_Stacking_Not_Delegated",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_NOT_DELEGATED,
+ ),
+ ),
+ // DelegateStackExtendCommand_Err_Stack_Extend_Not_Locked
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ extendCount: fc.integer({ min: 1, max: 11 }),
+ }).chain((r) => {
+ const operator = stackers.get(r.operator.stxAddress)!;
+ const delegatorsList = operator.poolMembers;
+ const availableStackers = delegatorsList.filter((delegator) => {
+ const delegatorWallet = stackers.get(delegator)!;
+ return delegatorWallet.unlockHeight > nextCycleFirstBlock(network);
+ });
+
+ const availableStackersOrFallback = availableStackers.length === 0
+ ? [r.operator.stxAddress]
+ : availableStackers;
+
+ return fc.record({
+ stacker: fc.constantFrom(...availableStackersOrFallback),
+ currentCycle: fc.constant(currentCycle(network)),
+ }).map((additionalProps) => ({
+ ...r,
+ stacker: wallets.get(additionalProps.stacker)!,
+ currentCycle: additionalProps.currentCycle,
+ }));
+ }).map(
+ (final) =>
+ new DelegateStackExtendCommand_Err(
+ final.operator,
+ final.stacker,
+ final.extendCount,
+ final.currentCycle,
+ function (this, model) {
+ const operator = model.stackers.get(
+ this.operator.stxAddress,
+ )!;
+ const stacker = model.stackers.get(
+ this.stacker.stxAddress,
+ )!;
+
+ const firstRewardCycle = Math.max(
+ stacker.firstLockedRewardCycle,
+ this.currentCycle,
+ );
+ const firstExtendCycle = Math.floor(
+ (stacker.unlockHeight - FIRST_BURNCHAIN_BLOCK_HEIGHT) /
+ REWARD_CYCLE_LENGTH,
+ );
+ const lastExtendCycle = firstExtendCycle + this.extendCount - 1;
+ const totalPeriod = lastExtendCycle - firstRewardCycle + 1;
+ const newUnlockHeight =
+ REWARD_CYCLE_LENGTH * (firstRewardCycle + totalPeriod - 1) +
+ FIRST_BURNCHAIN_BLOCK_HEIGHT;
+ const stackedAmount = stacker.amountLocked;
+ if (
+ isAmountLockedPositive(stacker) ||
+ !isDelegating(stacker) ||
+ isStacking(stacker) ||
+ isStackerDelegatingToOperator(stacker, this.operator) ||
+ !isUBHWithinDelegationLimit(stacker, newUnlockHeight) ||
+ isAmountWithinDelegationLimit(stacker, stackedAmount) ||
+ isStackerInOperatorPool(operator, this.stacker) ||
+ isStackerLockedByOperator(operator, this.stacker) ||
+ !isPeriodWithinMax(totalPeriod)
+ ) return false;
+
+ model.trackCommandRun(
+ "DelegateStackExtendCommand_Err_Stack_Extend_Not_Locked",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACK_EXTEND_NOT_LOCKED,
+ ),
+ ),
+ // DelegateStackExtendCommand_Err_Stacking_Permission_Denied
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ extendCount: fc.integer({ min: 1, max: 11 }),
+ stacker: fc.constantFrom(...wallets.values()),
+ currentCycle: fc.constant(currentCycle(network)),
+ }).map(
+ (final) =>
+ new DelegateStackExtendCommand_Err(
+ final.operator,
+ final.stacker,
+ final.extendCount,
+ final.currentCycle,
+ function (this, model) {
+ const operator = model.stackers.get(
+ this.operator.stxAddress,
+ )!;
+ const stacker = model.stackers.get(
+ this.stacker.stxAddress,
+ )!;
+
+ const firstRewardCycle = Math.max(
+ stacker.firstLockedRewardCycle,
+ this.currentCycle,
+ );
+ const firstExtendCycle = Math.floor(
+ (stacker.unlockHeight - FIRST_BURNCHAIN_BLOCK_HEIGHT) /
+ REWARD_CYCLE_LENGTH,
+ );
+ const lastExtendCycle = firstExtendCycle + this.extendCount - 1;
+ const totalPeriod = lastExtendCycle - firstRewardCycle + 1;
+ const newUnlockHeight =
+ REWARD_CYCLE_LENGTH * (firstRewardCycle + totalPeriod - 1) +
+ FIRST_BURNCHAIN_BLOCK_HEIGHT;
+ const stackedAmount = stacker.amountLocked;
+
+ if (
+ !isAmountLockedPositive(stacker) ||
+ isDelegating(stacker) ||
+ !isStacking(stacker) ||
+ isStackerDelegatingToOperator(stacker, this.operator) ||
+ isUBHWithinDelegationLimit(stacker, newUnlockHeight) ||
+ isAmountWithinDelegationLimit(stacker, stackedAmount) ||
+ isStackerInOperatorPool(operator, this.stacker) ||
+ !isStackerLockedByOperator(operator, this.stacker) ||
+ !isPeriodWithinMax(totalPeriod)
+ ) return false;
+
+ model.trackCommandRun(
+ "DelegateStackExtendCommand_Err_Stacking_Permission_Denied",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_PERMISSION_DENIED,
+ ),
+ ),
+ // DelegateStackIncreaseCommand_Err_Stacking_Insufficient_Funds
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ increaseBy: fc.constant(Number.MAX_SAFE_INTEGER),
+ }).chain((r) => {
+ const operator = stackers.get(r.operator.stxAddress)!;
+ const delegatorsList = operator.poolMembers;
+
+ const availableStackers = delegatorsList.filter((delegator) => {
+ const delegatorWallet = stackers.get(delegator)!;
+ return delegatorWallet.unlockHeight > nextCycleFirstBlock(network);
+ });
+
+ const availableStackersOrFallback = availableStackers.length === 0
+ ? [r.operator.stxAddress]
+ : availableStackers;
+
+ return fc.record({
+ stacker: fc.constantFrom(...availableStackersOrFallback),
+ }).map((stacker) => ({
+ ...r,
+ stacker: wallets.get(stacker.stacker)!,
+ }));
+ }).map(
+ (final) =>
+ new DelegateStackIncreaseCommand_Err(
+ final.operator,
+ final.stacker,
+ final.increaseBy,
+ function (this, model) {
+ const operatorWallet = model.stackers.get(
+ this.operator.stxAddress,
+ )!;
+ const stackerWallet = model.stackers.get(
+ this.stacker.stxAddress,
+ )!;
+
+ if (
+ !isAmountLockedPositive(stackerWallet) ||
+ !isDelegating(stackerWallet) ||
+ !isStacking(stackerWallet) ||
+ !isIncreaseByGTZero(this.increaseBy) ||
+ !isStackerInOperatorPool(operatorWallet, this.stacker) ||
+ isIncreaseByWithinUnlockedBalance(
+ stackerWallet,
+ this.increaseBy,
+ ) ||
+ isAmountWithinDelegationLimit(
+ stackerWallet,
+ this.increaseBy + stackerWallet.amountLocked,
+ ) ||
+ !isStackerLockedByOperator(operatorWallet, this.stacker) ||
+ isUnlockedWithinCurrentRC(stackerWallet, model)
+ ) return false;
+
+ model.trackCommandRun(
+ "DelegateStackIncreaseCommand_Err_Stacking_Insufficient_Funds",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_INSUFFICIENT_FUNDS,
+ ),
+ ),
+ // DelegateStackIncreaseCommand_Err_Stacking_Invalid_Amount
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ increaseBy: fc.constant(0),
+ }).chain((r) => {
+ const operator = stackers.get(r.operator.stxAddress)!;
+ const delegatorsList = operator.poolMembers;
+
+ const availableStackers = delegatorsList.filter((delegator) => {
+ const delegatorWallet = stackers.get(delegator)!;
+ return delegatorWallet.unlockHeight > nextCycleFirstBlock(network);
+ });
+
+ const availableStackersOrFallback = availableStackers.length === 0
+ ? [r.operator.stxAddress]
+ : availableStackers;
+
+ return fc.record({
+ stacker: fc.constantFrom(...availableStackersOrFallback),
+ }).map((stacker) => ({
+ ...r,
+ stacker: wallets.get(stacker.stacker)!,
+ }));
+ }).map(
+ (final) =>
+ new DelegateStackIncreaseCommand_Err(
+ final.operator,
+ final.stacker,
+ final.increaseBy,
+ function (this, model) {
+ const operatorWallet = model.stackers.get(
+ this.operator.stxAddress,
+ )!;
+ const stackerWallet = model.stackers.get(
+ this.stacker.stxAddress,
+ )!;
+
+ if (
+ !isAmountLockedPositive(stackerWallet) ||
+ !isDelegating(stackerWallet) ||
+ !isStacking(stackerWallet) ||
+ isIncreaseByGTZero(this.increaseBy) ||
+ !isStackerInOperatorPool(operatorWallet, this.stacker) ||
+ !isIncreaseByWithinUnlockedBalance(
+ stackerWallet,
+ this.increaseBy,
+ ) ||
+ !isAmountWithinDelegationLimit(
+ stackerWallet,
+ this.increaseBy + stackerWallet.amountLocked,
+ ) ||
+ !isStackerLockedByOperator(operatorWallet, this.stacker) ||
+ isUnlockedWithinCurrentRC(stackerWallet, model)
+ ) return false;
+
+ model.trackCommandRun(
+ "DelegateStackIncreaseCommand_Err_Stacking_Invalid_Amount",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_INVALID_AMOUNT,
+ ),
+ ),
+ // DelegateStackIncreaseCommand_Err_Stacking_Not_Delegated
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ increaseBy: fc.nat(),
+ }).chain((r) => {
+ const operator = stackers.get(r.operator.stxAddress)!;
+ const delegatorsList = operator.poolMembers;
+
+ const availableStackers = delegatorsList.filter((delegator) => {
+ const delegatorWallet = stackers.get(delegator)!;
+ return delegatorWallet.unlockHeight > nextCycleFirstBlock(network);
+ });
+
+ const availableStackersOrFallback = availableStackers.length === 0
+ ? [r.operator.stxAddress]
+ : availableStackers;
+
+ return fc.record({
+ stacker: fc.constantFrom(...availableStackersOrFallback),
+ }).map((stacker) => ({
+ ...r,
+ stacker: wallets.get(stacker.stacker)!,
+ }));
+ }).map(
+ (final) =>
+ new DelegateStackIncreaseCommand_Err(
+ final.operator,
+ final.stacker,
+ final.increaseBy,
+ function (this, model) {
+ const operatorWallet = model.stackers.get(
+ this.operator.stxAddress,
+ )!;
+ const stackerWallet = model.stackers.get(
+ this.stacker.stxAddress,
+ )!;
+
+ if (
+ !isAmountLockedPositive(stackerWallet) ||
+ isDelegating(stackerWallet) ||
+ !isStacking(stackerWallet) ||
+ !isStackingSolo(stackerWallet) ||
+ !isIncreaseByGTZero(this.increaseBy) ||
+ isStackerInOperatorPool(operatorWallet, this.stacker) ||
+ !isIncreaseByWithinUnlockedBalance(
+ stackerWallet,
+ this.increaseBy,
+ ) ||
+ isAmountWithinDelegationLimit(
+ stackerWallet,
+ this.increaseBy + stackerWallet.amountLocked,
+ ) ||
+ isStackerLockedByOperator(operatorWallet, this.stacker) ||
+ isUnlockedWithinCurrentRC(stackerWallet, model)
+ ) return false;
+
+ model.trackCommandRun(
+ "DelegateStackIncreaseCommand_Err_Stacking_Not_Delegated",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_NOT_DELEGATED,
+ ),
+ ),
+ // DelegateStackIncreaseCommand_Err_Stacking_Permission_Denied
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ increaseBy: fc.nat(),
+ }).chain((r) => {
+ const operator = stackers.get(r.operator.stxAddress)!;
+ const delegatorsList = operator.poolMembers;
+
+ const availableStackers = delegatorsList.filter((delegator) => {
+ const delegatorWallet = stackers.get(delegator)!;
+ return delegatorWallet.unlockHeight > nextCycleFirstBlock(network);
+ });
+
+ const availableStackersOrFallback = availableStackers.length === 0
+ ? [r.operator.stxAddress]
+ : availableStackers;
+
+ return fc.record({
+ stacker: fc.constantFrom(...availableStackersOrFallback),
+ }).map((stacker) => ({
+ ...r,
+ stacker: wallets.get(stacker.stacker)!,
+ }));
+ }).map(
+ (final) =>
+ new DelegateStackIncreaseCommand_Err(
+ final.operator,
+ final.stacker,
+ final.increaseBy,
+ function (this, model) {
+ const operatorWallet = model.stackers.get(
+ this.operator.stxAddress,
+ )!;
+ const stackerWallet = model.stackers.get(
+ this.stacker.stxAddress,
+ )!;
+
+ if (
+ !isAmountLockedPositive(stackerWallet) ||
+ isDelegating(stackerWallet) ||
+ !isStacking(stackerWallet) ||
+ !isIncreaseByGTZero(this.increaseBy) ||
+ isStackerInOperatorPool(operatorWallet, this.stacker) ||
+ !isIncreaseByWithinUnlockedBalance(
+ stackerWallet,
+ this.increaseBy,
+ ) ||
+ isAmountWithinDelegationLimit(
+ stackerWallet,
+ this.increaseBy + stackerWallet.amountLocked,
+ ) ||
+ !isStackerLockedByOperator(operatorWallet, this.stacker) ||
+ isUnlockedWithinCurrentRC(stackerWallet, model)
+ ) return false;
+
+ model.trackCommandRun(
+ "DelegateStackIncreaseCommand_Err_Stacking_Permission_Denied",
+ );
+ return true;
+ },
+ POX_4_ERRORS.ERR_STACKING_PERMISSION_DENIED,
+ ),
+ ),
+ // DisallowContractCallerCommand_Err
+ fc.record({
+ stacker: fc.constantFrom(...wallets.values()),
+ callerToDisallow: fc.constantFrom(...wallets.values()),
+ }).map(
+ (r: { stacker: Wallet; callerToDisallow: Wallet }) =>
+ new DisallowContractCallerCommand_Err(
+ r.stacker,
+ r.callerToDisallow,
+ function (this, model) {
+ const stacker = model.stackers.get(this.stacker.stxAddress)!;
+ const callerToDisallow = model.stackers.get(
+ this.callerToDisallow.stxAddress,
+ )!;
+ if (
+ isAllowedContractCaller(stacker, this.callerToDisallow) ||
+ isCallerAllowedByStacker(this.stacker, callerToDisallow)
+ ) return false;
+
+ model.trackCommandRun(
+ "DisallowContractCallerCommand_Err",
+ );
+ return true;
+ },
+ ),
+ ),
+ ];
+
+ return cmds;
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox-4.stateful-prop.test.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox-4.stateful-prop.test.ts
new file mode 100644
index 00000000000..31a9239a44a
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox-4.stateful-prop.test.ts
@@ -0,0 +1,173 @@
+import { it } from "vitest";
+import { initSimnet } from "@hirosystems/clarinet-sdk";
+import { Real, Stub } from "./pox_CommandModel.ts";
+
+import {
+ getPublicKeyFromPrivate,
+ publicKeyToBtcAddress,
+} from "@stacks/encryption";
+import { StacksDevnet } from "@stacks/network";
+import {
+ createStacksPrivateKey,
+ getAddressFromPrivateKey,
+ TransactionVersion,
+} from "@stacks/transactions";
+import { StackingClient } from "@stacks/stacking";
+
+import fc from "fast-check";
+import { PoxCommands } from "./pox_Commands.ts";
+import { ErrCommands } from "./err_Commands.ts";
+
+import fs from "fs";
+import path from "path";
+
+it("statefully interacts with PoX-4", async () => {
+ // SUT stands for "System Under Test".
+ const sut: Real = {
+ network: await initSimnet(),
+ };
+
+ const wallets = [
+ [
+ "wallet_1",
+ "7287ba251d44a4d3fd9276c88ce34c5c52a038955511cccaf77e61068649c17801",
+ ],
+ [
+ "wallet_2",
+ "530d9f61984c888536871c6573073bdfc0058896dc1adfe9a6a10dfacadc209101",
+ ],
+ [
+ "wallet_3",
+ "d655b2523bcd65e34889725c73064feb17ceb796831c0e111ba1a552b0f31b3901",
+ ],
+ [
+ "wallet_4",
+ "f9d7206a47f14d2870c163ebab4bf3e70d18f5d14ce1031f3902fbbc894fe4c701",
+ ],
+ [
+ "wallet_5",
+ "3eccc5dac8056590432db6a35d52b9896876a3d5cbdea53b72400bc9c2099fe801",
+ ],
+ [
+ "wallet_6",
+ "7036b29cb5e235e5fd9b09ae3e8eec4404e44906814d5d01cbca968a60ed4bfb01",
+ ],
+ [
+ "wallet_7",
+ "b463f0df6c05d2f156393eee73f8016c5372caa0e9e29a901bb7171d90dc4f1401",
+ ],
+ [
+ "wallet_8",
+ "6a1a754ba863d7bab14adbbc3f8ebb090af9e871ace621d3e5ab634e1422885e01",
+ ],
+ [
+ "wallet_9",
+ "de433bdfa14ec43aa1098d5be594c8ffb20a31485ff9de2923b2689471c401b801",
+ ],
+ ].map((wallet) => {
+ const label = wallet[0];
+ const prvKey = wallet[1];
+ const pubKey = getPublicKeyFromPrivate(prvKey);
+ const devnet = new StacksDevnet();
+ const initialUstxBalance = 100_000_000_000_000;
+ const signerPrvKey = createStacksPrivateKey(prvKey);
+ const signerPubKey = getPublicKeyFromPrivate(signerPrvKey.data);
+ const btcAddress = publicKeyToBtcAddress(pubKey);
+ const stxAddress = getAddressFromPrivateKey(
+ prvKey,
+ TransactionVersion.Testnet,
+ );
+
+ return {
+ label,
+ stxAddress,
+ btcAddress,
+ signerPrvKey,
+ signerPubKey,
+ stackingClient: new StackingClient(stxAddress, devnet),
+ ustxBalance: initialUstxBalance,
+ isStacking: false,
+ hasDelegated: false,
+ lockedAddresses: [],
+ amountToCommit: 0,
+ poolMembers: [],
+ delegatedTo: "",
+ delegatedMaxAmount: 0,
+ delegatedUntilBurnHt: 0,
+ delegatedPoxAddress: "",
+ amountLocked: 0,
+ amountUnlocked: initialUstxBalance,
+ unlockHeight: 0,
+ firstLockedRewardCycle: 0,
+ allowedContractCaller: "",
+ callerAllowedBy: [],
+ committedRewCycleIndexes: [],
+ };
+ });
+
+ // Track the number of times each command is run, so we can see if all the
+ // commands are run at least once.
+ const statistics = fs.readdirSync(path.join(__dirname)).filter((file) =>
+ file.startsWith("pox_") && file.endsWith(".ts") &&
+ file !== "pox_CommandModel.ts" && file !== "pox_Commands.ts" &&
+ !file.includes("_Err")
+ ).map((file) => file.slice(4, -3)); // Remove "pox_" prefix and ".ts" suffix.
+
+ // This is the initial state of the model.
+ const model = new Stub(
+ new Map(wallets.map((wallet) => [wallet.stxAddress, wallet])),
+ new Map(wallets.map((wallet) => [wallet.stxAddress, {
+ ustxBalance: 100_000_000_000_000,
+ isStacking: false,
+ isStackingSolo: false,
+ hasDelegated: false,
+ lockedAddresses: [],
+ amountToCommit: 0,
+ poolMembers: [],
+ delegatedTo: "",
+ delegatedMaxAmount: 0,
+ // We initialize delegatedUntilBurnHt to 0. It will be updated
+ // after successful delegate-stx calls. It's value will be either
+ // the unwrapped until-burn-ht uint passed to the delegate-stx,
+ // or undefined for indefinite delegations.
+ delegatedUntilBurnHt: 0,
+ delegatedPoxAddress: "",
+ amountLocked: 0,
+ amountUnlocked: 100_000_000_000_000,
+ unlockHeight: 0,
+ firstLockedRewardCycle: 0,
+ allowedContractCallers: [],
+ callerAllowedBy: [],
+ committedRewCycleIndexes: [],
+ }])),
+ new Map(statistics.map((commandName) => [commandName, 0])),
+ );
+
+ simnet.setEpoch("3.0");
+
+ const successPath = PoxCommands(model.wallets, model.stackers, sut.network);
+ const failurePath = ErrCommands(model.wallets, model.stackers, sut.network);
+
+ fc.assert(
+ fc.property(
+ // More on size: https://github.com/dubzzz/fast-check/discussions/2978
+ // More on cmds: https://github.com/dubzzz/fast-check/discussions/3026
+ fc.commands(successPath.concat(failurePath), { size: "xsmall" }),
+ (cmds) => {
+ const initialState = () => ({ model: model, real: sut });
+ fc.modelRun(initialState, cmds);
+ },
+ ),
+ {
+ // Defines the number of test iterations to run; default is 100.
+ numRuns: 20000,
+ // Adjusts the level of detail in test reports. Default is 0 (minimal).
+ // At level 2, reports include extensive details, helpful for deep
+ // debugging. This includes not just the failing case and its seed, but
+ // also a comprehensive log of all executed steps and their outcomes.
+ verbose: 2,
+ },
+ );
+
+ model.reportCommandRuns();
+});
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_AllowContractCallerCommand.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_AllowContractCallerCommand.ts
new file mode 100644
index 00000000000..931326ce1fc
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_AllowContractCallerCommand.ts
@@ -0,0 +1,116 @@
+import {
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { expect } from "vitest";
+import {
+ boolCV,
+ Cl,
+ ClarityType,
+ OptionalCV,
+ UIntCV,
+} from "@stacks/transactions";
+
+/**
+ * The `AllowContractCallerCommand` authorizes a `contract-caller` to call
+ * stacking methods. Normally, stacking methods can only be invoked by direct
+ * transactions (i.e., the tx-sender issues a direct contract-call to the
+ * stacking methods). By issuing an allowance, the tx-sender may call stacking
+ * methods through the allowed contract.
+ *
+ * There are no constraints for running this command.
+ */
+export class AllowContractCallerCommand implements PoxCommand {
+ readonly wallet: Wallet;
+ readonly allowanceTo: Wallet;
+ readonly allowUntilBurnHt: OptionalCV;
+
+ /**
+ * Constructs an `AllowContractCallerCommand` that authorizes a
+ * `contract-caller` to call stacking methods.
+ *
+ * @param wallet - Represents the Stacker's wallet.
+ * @param allowanceTo - Represents the authorized `contract-caller` (i.e., a
+ * stacking pool).
+ * @param allowUntilBurnHt - The burn block height until which the
+ * authorization is valid.
+ */
+ constructor(
+ wallet: Wallet,
+ allowanceTo: Wallet,
+ allowUntilBurnHt: OptionalCV,
+ ) {
+ this.wallet = wallet;
+ this.allowanceTo = allowanceTo;
+ this.allowUntilBurnHt = allowUntilBurnHt;
+ }
+
+ check(): boolean {
+ // There are no constraints for running this command.
+ return true;
+ }
+
+ run(model: Stub, real: Real): void {
+ model.trackCommandRun(this.constructor.name);
+
+ // Act
+ const allowContractCaller = real.network.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "allow-contract-caller",
+ [
+ // (caller principal)
+ Cl.principal(this.allowanceTo.stxAddress),
+ // (until-burn-ht (optional uint))
+ this.allowUntilBurnHt,
+ ],
+ this.wallet.stxAddress,
+ );
+
+ // Assert
+ expect(allowContractCaller.result).toBeOk(boolCV(true));
+
+ // Get the wallets involved from the model and update it with the new state.
+ const wallet = model.stackers.get(this.wallet.stxAddress)!;
+
+ const callerToAllow = model.stackers.get(this.allowanceTo.stxAddress)!;
+ // Update model so that we know this wallet has authorized a contract-caller.
+ const callerToAllowIndexInAllowedList = wallet.allowedContractCallers
+ .indexOf(this.allowanceTo.stxAddress);
+
+ if (callerToAllowIndexInAllowedList == -1) {
+ wallet.allowedContractCallers.push(this.allowanceTo.stxAddress);
+ callerToAllow.callerAllowedBy.push(this.wallet.stxAddress);
+ }
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✓ ${this.wallet.label}`,
+ "allow-contract-caller",
+ this.allowanceTo.label,
+ "until",
+ optionalCVToString(this.allowUntilBurnHt),
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.wallet.stxAddress} allow-contract-caller ${this.allowanceTo.stxAddress} until burn ht ${
+ optionalCVToString(this.allowUntilBurnHt)
+ }`;
+ }
+}
+
+const optionalCVToString = (optional: OptionalCV): string =>
+ optional.type === ClarityType.OptionalSome
+ ? (optional.value as UIntCV).value.toString()
+ : "none";
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_CommandModel.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_CommandModel.ts
new file mode 100644
index 00000000000..5b6cb95c272
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_CommandModel.ts
@@ -0,0 +1,512 @@
+import fc from "fast-check";
+
+import { Simnet } from "@hirosystems/clarinet-sdk";
+import {
+ ClarityValue,
+ cvToValue,
+ StacksPrivateKey,
+} from "@stacks/transactions";
+import { StackingClient } from "@stacks/stacking";
+import {
+ FIRST_BURNCHAIN_BLOCK_HEIGHT,
+ REWARD_CYCLE_LENGTH,
+} from "./pox_Commands";
+
+export type StxAddress = string;
+export type BtcAddress = string;
+export type CommandTag = string;
+
+export class Stub {
+ readonly wallets: Map;
+ readonly statistics: Map;
+ readonly stackers: Map;
+ stackingMinimum: number;
+ nextRewardSetIndex: number;
+ lastRefreshedCycle: number;
+ burnBlockHeight: number;
+
+ constructor(
+ wallets: Map,
+ stackers: Map,
+ statistics: Map,
+ ) {
+ this.wallets = wallets;
+ this.statistics = statistics;
+ this.stackers = stackers;
+ this.stackingMinimum = 0;
+ this.nextRewardSetIndex = 0;
+ this.lastRefreshedCycle = 0;
+ this.burnBlockHeight = 0;
+ }
+
+ trackCommandRun(commandName: string) {
+ const count = this.statistics.get(commandName) || 0;
+ this.statistics.set(commandName, count + 1);
+ }
+
+ reportCommandRuns() {
+ console.log("Command run method execution counts:");
+ const orderedStatistics = Array.from(this.statistics.entries()).sort(
+ ([keyA], [keyB]) => {
+ return keyA.localeCompare(keyB);
+ },
+ );
+
+ this.logAsTree(orderedStatistics);
+ }
+
+ private logAsTree(statistics: [string, number][]) {
+ const tree: { [key: string]: any } = {};
+
+ statistics.forEach(([commandName, count]) => {
+ const split = commandName.split("_");
+ let root: string = split[0],
+ rest: string = "base";
+
+ if (split.length > 1) {
+ rest = split.slice(1).join("_");
+ }
+ if (!tree[root]) {
+ tree[root] = {};
+ }
+ tree[root][rest] = count;
+ });
+
+ const printTree = (node: any, indent: string = "") => {
+ const keys = Object.keys(node);
+ keys.forEach((key, index) => {
+ const isLast = index === keys.length - 1;
+ const boxChar = isLast ? "└─ " : "├─ ";
+ if (key !== "base") {
+ if (typeof node[key] === "object") {
+ console.log(`${indent}${boxChar}${key}: ${node[key]["base"]}`);
+ printTree(node[key], indent + (isLast ? " " : "│ "));
+ } else {
+ console.log(`${indent}${boxChar}${key}: ${node[key]}`);
+ }
+ }
+ });
+ };
+
+ printTree(tree);
+ }
+
+ refreshStateForNextRewardCycle(real: Real) {
+ const burnBlockHeightResult = real.network.runSnippet("burn-block-height");
+ const burnBlockHeight = Number(
+ cvToValue(burnBlockHeightResult as ClarityValue),
+ );
+ const lastRefreshedCycle = this.lastRefreshedCycle;
+ const currentRewCycle = Math.floor(
+ (Number(burnBlockHeight) - FIRST_BURNCHAIN_BLOCK_HEIGHT) /
+ REWARD_CYCLE_LENGTH,
+ );
+
+ // The `this.burnBlockHeight` instance member is used for logging purposes.
+ // However, it's not used in the actual implementation of the model and all
+ // usages below use the `burnBlockHeight` local variable.
+ this.burnBlockHeight = burnBlockHeight;
+
+ if (lastRefreshedCycle < currentRewCycle) {
+ this.nextRewardSetIndex = 0;
+
+ this.wallets.forEach((w) => {
+ let updatedAmountToCommit = 0;
+ const wallet = this.stackers.get(w.stxAddress)!;
+
+ // Get the wallet's ex-delegators by comparing their delegatedUntilBurnHt
+ // to the current burn block height (only if the wallet is a delegatee).
+ // If the delegatedUntilBurnHt is undefined, the delegator is considered
+ // active for an indefinite period (until a revoke-delegate-stx call).
+ const expiredDelegators = wallet.poolMembers.filter(
+ (stackerAddress) =>
+ this.stackers.get(stackerAddress)!.delegatedUntilBurnHt !==
+ undefined &&
+ this.stackers.get(stackerAddress)!.delegatedUntilBurnHt as number <
+ burnBlockHeight,
+ );
+
+ // Get the operator's pool stackers that no longer have partially commited
+ // STX for the next reward cycle by comparing their unlock height to
+ // the next reward cycle's first block (only if the wallet is an operator).
+ const stackersToRemoveAmountToCommit = wallet.lockedAddresses.filter((
+ stackerAddress,
+ ) =>
+ this.stackers.get(stackerAddress)!.unlockHeight <=
+ burnBlockHeight + REWARD_CYCLE_LENGTH
+ );
+
+ // Get the operator's ex-pool stackers by comparing their unlockHeight to
+ // the current burn block height (only if the wallet is an operator).
+ const expiredStackers = wallet.lockedAddresses.filter(
+ (stackerAddress) =>
+ this.stackers.get(stackerAddress)!.unlockHeight <=
+ burnBlockHeight,
+ );
+
+ // For each remaining pool stacker (if any), increase the operator's
+ // amountToCommit (partial-stacked) for the next cycle by the
+ // stacker's amountLocked.
+ wallet.lockedAddresses.forEach((stacker) => {
+ const stackerWallet = this.stackers.get(stacker)!;
+ updatedAmountToCommit += stackerWallet?.amountLocked;
+ });
+
+ // Update the operator's amountToCommit (partial-stacked).
+ wallet.amountToCommit = updatedAmountToCommit;
+
+ // Remove the expired delegators from the delegatee's poolMembers list.
+ expiredDelegators.forEach((expDelegator) => {
+ const expDelegatorIndex = wallet.poolMembers.indexOf(expDelegator);
+ wallet.poolMembers.splice(expDelegatorIndex, 1);
+ });
+
+ // Remove the expired stackers from the operator's lockedAddresses list.
+ expiredStackers.forEach((expStacker) => {
+ const expStackerIndex = wallet.lockedAddresses.indexOf(expStacker);
+ wallet.lockedAddresses.splice(expStackerIndex, 1);
+ });
+
+ // For each pool stacker that no longer have partially commited STX for
+ // the next reward cycle, decrement the operator's amountToCommit
+ // (partial-stacked) by the stacker's amountLocked.
+ stackersToRemoveAmountToCommit.forEach((expStacker) => {
+ const expStackerWallet = this.stackers.get(expStacker)!;
+ wallet.amountToCommit -= expStackerWallet.amountLocked;
+ });
+
+ // Check the wallet's stack expiry and update the state accordingly.
+ if (
+ wallet.unlockHeight > 0 && wallet.unlockHeight <= burnBlockHeight
+ ) {
+ wallet.isStacking = false;
+ wallet.isStackingSolo = false;
+ wallet.amountUnlocked += wallet.amountLocked;
+ wallet.amountLocked = 0;
+ wallet.unlockHeight = 0;
+ wallet.firstLockedRewardCycle = 0;
+ } // If the wallet is solo stacking and its stack won't expire in the
+ // next reward cycle, increment the model's nextRewardSetIndex (the
+ // next empty reward slot)
+ else if (
+ wallet.unlockHeight > 0 &&
+ wallet.unlockHeight > burnBlockHeight + REWARD_CYCLE_LENGTH &&
+ wallet.isStackingSolo
+ ) {
+ this.nextRewardSetIndex++;
+ }
+ wallet.committedRewCycleIndexes = [];
+ });
+ this.lastRefreshedCycle = currentRewCycle;
+ }
+ }
+}
+
+export type Real = {
+ network: Simnet;
+};
+
+export type Wallet = {
+ label: string;
+ stxAddress: string;
+ btcAddress: string;
+ signerPrvKey: StacksPrivateKey;
+ signerPubKey: string;
+ stackingClient: StackingClient;
+};
+
+export type Stacker = {
+ ustxBalance: number;
+ isStacking: boolean;
+ isStackingSolo: boolean;
+ hasDelegated: boolean;
+ lockedAddresses: StxAddress[];
+ amountToCommit: number;
+ poolMembers: StxAddress[];
+ delegatedTo: StxAddress;
+ delegatedMaxAmount: number;
+ delegatedUntilBurnHt: number | undefined;
+ delegatedPoxAddress: BtcAddress;
+ amountLocked: number;
+ amountUnlocked: number;
+ unlockHeight: number;
+ firstLockedRewardCycle: number;
+ allowedContractCallers: StxAddress[];
+ callerAllowedBy: StxAddress[];
+ committedRewCycleIndexes: number[];
+};
+
+export type PoxCommand = fc.Command;
+
+export const logCommand = (...items: (string | undefined)[]) => {
+ // Ensure we only render up to the first 10 items for brevity.
+ const renderItems = items.slice(0, 10);
+ const columnWidth = 23; // Standard width for each column after the first two.
+ const halfColumns = Math.floor(columnWidth / 2);
+
+ // Pad columns to their widths: half for the first two, full for the rest.
+ const prettyPrint = renderItems.map((content, index) =>
+ // Check if the index is less than 2 (i.e., first two items).
+ content
+ ? (index < 2 ? content.padEnd(halfColumns) : content.padEnd(columnWidth))
+ : (index < 2 ? "".padEnd(halfColumns) : "".padEnd(columnWidth))
+ );
+ prettyPrint.push("\n");
+
+ process.stdout.write(prettyPrint.join(""));
+};
+
+/**
+ * Helper function that checks if the minimum uSTX threshold was set in the model.
+ * @param model - the model at a given moment in time.
+ * @returns boolean.
+ */
+export const isStackingMinimumCalculated = (model: Readonly): boolean =>
+ model.stackingMinimum > 0;
+
+/**
+ * Helper function that checks if a stacker is currently stacking.
+ * @param stacker - the stacker's state at a given moment in time.
+ * @returns boolean.
+ */
+export const isStacking = (stacker: Stacker): boolean =>
+ stacker.isStacking;
+
+/**
+ * Helper function that checks if a stacker has an active delegation.
+ * @param stacker - the stacker's state at a given moment in time.
+ * @returns boolean.
+ */
+export const isDelegating = (stacker: Stacker): boolean =>
+ stacker.hasDelegated;
+
+/**
+ * Helper function that checks if the stacker is stacking using solo
+ * stacking methods.
+ * @param stacker - the stacker's state at a given moment in time.
+ * @returns boolean.
+ */
+export const isStackingSolo = (stacker: Stacker): boolean =>
+ stacker.isStackingSolo;
+
+/**
+ * Helper function that checks if the stacker has locked uSTX.
+ * @param stacker - the stacker's state at a given moment in time.
+ * @returns boolean.
+ */
+export const isAmountLockedPositive = (stacker: Stacker): boolean =>
+ stacker.amountLocked > 0;
+
+/**
+ * Helper function that checks if an operator has locked uSTX on
+ * behalf of at least one stacker.
+ * @param operator - the operator's state at a given moment in time.
+ * @returns boolean.
+ */
+export const hasLockedStackers = (operator: Stacker): boolean =>
+ operator.lockedAddresses.length > 0;
+
+/**
+ * Helper function that checks if an operator has uSTX that was not
+ * yet committed.
+ * @param operator - the operator's state at a given moment in time.
+ * @returns boolean.
+ *
+ * NOTE: ATC is an abbreviation for "amount to commit".
+ */
+export const isATCPositive = (operator: Stacker): boolean =>
+ operator.amountToCommit > 0;
+
+/**
+ * Helper function that checks if an operator's not committed uSTX
+ * amount is above the minimum stacking threshold.
+ * @param operator - the operator's state at a given moment in time.
+ * @param model - the model at a given moment in time.
+ * @returns boolean.
+ *
+ * NOTE: ATC is an abbreviation for "amount to commit".
+ */ export const isATCAboveThreshold = (
+ operator: Stacker,
+ model: Readonly,
+): boolean => operator.amountToCommit >= model.stackingMinimum;
+
+/**
+ * Helper function that checks if a uSTX amount fits within a stacker's
+ * delegation limit.
+ * @param stacker - the stacker's state at a given moment in time.
+ * @param amountToCheck - the uSTX amount to check.
+ * @returns boolean.
+ */
+export const isAmountWithinDelegationLimit = (
+ stacker: Stacker,
+ amountToCheck: bigint | number,
+): boolean => stacker.delegatedMaxAmount >= Number(amountToCheck);
+
+/**
+ * Helper function that checks if a given unlock burn height is within
+ * a stacker's delegation limit.
+ * @param stacker - the stacker's state at a given moment in time.
+ * @param unlockBurnHt - the verified unlock burn height.
+ * @returns boolean.
+ *
+ * NOTE: UBH is an abbreviation for "unlock burn height".
+ */
+export const isUBHWithinDelegationLimit = (
+ stacker: Stacker,
+ unlockBurnHt: number,
+): boolean =>
+ stacker.delegatedUntilBurnHt === undefined ||
+ unlockBurnHt <= stacker.delegatedUntilBurnHt;
+
+/**
+ * Helper function that checks if a given amount is within a stacker's
+ * unlocked uSTX balance.
+ * @param stacker - the stacker's state at a given moment in time.
+ * @param amountToCheck - the amount to check.
+ * @returns boolean.
+ */
+export const isAmountWithinBalance = (
+ stacker: Stacker,
+ amountToCheck: bigint | number,
+): boolean => stacker.ustxBalance >= Number(amountToCheck);
+
+/**
+ * Helper function that checks if a given amount is above the minimum
+ * stacking threshold.
+ * @param model - the model at a given moment in time.
+ * @param amountToCheck - the amount to check.
+ * @returns boolean.
+ */
+export const isAmountAboveThreshold = (
+ model: Readonly,
+ amountToCheck: bigint | number,
+): boolean => Number(amountToCheck) >= model.stackingMinimum;
+
+/**
+ * Helper function that checks if an operator has at least one pool
+ * participant.
+ * @param operator - the operator's state at a given moment in time.
+ * @returns boolean.
+ */
+export const hasPoolMembers = (operator: Stacker): boolean =>
+ operator.poolMembers.length > 0;
+
+/**
+ * Helper function that checks if a stacker is a pool member of a
+ * given operator.
+ * @param operator - the operator's state at a given moment in time.
+ * @param stacker - the stacker's state at a given moment in time.
+ * @returns boolean
+ */
+export const isStackerInOperatorPool = (
+ operator: Stacker,
+ stacker: Wallet,
+): boolean => operator.poolMembers.includes(stacker.stxAddress);
+
+/**
+ * Helper function that checks if a given stacker's funds are locked
+ * by a given operator.
+ * @param stacker - the stacker's state at a given moment in time.
+ * @param operator - the operator's state at a given moment in time.
+ * @returns boolean.
+ */
+export const isStackerLockedByOperator = (
+ operator: Stacker,
+ stacker: Wallet,
+): boolean =>
+ operator.lockedAddresses.includes(
+ stacker.stxAddress,
+ );
+
+/**
+ * Helper function that checks if a given stacker's unlock height is
+ * within the current reward cycle.
+ * @param stacker - the stacker's state at a given moment in time.
+ * @param model - the model at a given moment in time.
+ * @returns boolean.
+ *
+ * NOTE: RC is an abbreviation for "reward cycle".
+ */
+export const isUnlockedWithinCurrentRC = (
+ stackerWallet: Stacker,
+ model: Readonly,
+): boolean => (stackerWallet.unlockHeight <=
+ model.burnBlockHeight + REWARD_CYCLE_LENGTH);
+
+/**
+ * Helper function that checks if the increase amount is within a given
+ * stacker's unlocked balance.
+ * @param stacker - the stacker's state at a given moment in time.
+ * @param increaseBy - the increase amount to check.
+ * @returns boolean.
+ */
+export const isIncreaseByWithinUnlockedBalance = (
+ stacker: Stacker,
+ increaseBy: number,
+): boolean => increaseBy <= stacker.amountUnlocked;
+
+/**
+ * Helper function that checks if the increase amount is greater than zero.
+ * @param increaseBy - the increase amount to check.
+ * @returns boolean.
+ */
+export const isIncreaseByGTZero = (increaseBy: number): boolean =>
+ increaseBy >= 1;
+
+/**
+ * Helper function that checks if the increase amount does not exceed the
+ * PoX-4 maximum lock period.
+ * @param period - the period to check.
+ * @returns boolean.
+ */
+export const isPeriodWithinMax = (period: number) => period <= 12;
+
+/**
+ * Helper function that checks if a given stacker is currently delegating
+ * to a given operator.
+ * @param stacker - the stacker's state at a given moment in time.
+ * @param operator - the operator's state at a given moment in time.
+ * @returns boolean.
+ */
+export const isStackerDelegatingToOperator = (
+ stacker: Stacker,
+ operator: Wallet,
+): boolean => stacker.delegatedTo === operator.stxAddress;
+
+/**
+ * Helper function that checks if a given increase amount is greater than
+ * zero.
+ * @param increaseAmount - the increase amount to check
+ * @returns boolean.
+ */
+export const isIncreaseAmountGTZero = (increaseAmount: number): boolean =>
+ increaseAmount > 0;
+
+/**
+ * Helper function that checks if a given stacker's has issued an allowance
+ * to a potential contract caller.
+ * @param stacker - the stacker's state at a given moment in time.
+ * @param potentialAllowedStacker - the potential contract caller's state.
+ * @returns boolean.
+ */
+export const isAllowedContractCaller = (
+ stacker: Stacker,
+ potentialAllowedStacker: Wallet,
+): boolean =>
+ stacker.allowedContractCallers.includes(
+ potentialAllowedStacker.stxAddress,
+ );
+
+/**
+ * Helper function that checks if a given contract caller has been allowed by
+ * a given stacker.
+ * @param stacker - the stacker's state at a given moment in time.
+ * @param caller - the contract caller's state.
+ * @returns boolean.
+ */
+export const isCallerAllowedByStacker = (
+ stacker: Wallet,
+ caller: Stacker,
+): boolean => caller.callerAllowedBy.includes(stacker.stxAddress);
+
+export const isPositive = (value: number): boolean => value >= 0;
\ No newline at end of file
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_Commands.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_Commands.ts
new file mode 100644
index 00000000000..a42cb6278ee
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_Commands.ts
@@ -0,0 +1,490 @@
+import fc from "fast-check";
+import { PoxCommand, Stacker, StxAddress, Wallet } from "./pox_CommandModel";
+import { GetStackingMinimumCommand } from "./pox_GetStackingMinimumCommand";
+import { GetStxAccountCommand } from "./pox_GetStxAccountCommand";
+import { StackStxSigCommand } from "./pox_StackStxSigCommand";
+import { StackStxAuthCommand } from "./pox_StackStxAuthCommand";
+import { DelegateStxCommand } from "./pox_DelegateStxCommand";
+import { DelegateStackStxCommand } from "./pox_DelegateStackStxCommand";
+import { Simnet } from "@hirosystems/clarinet-sdk";
+import { Cl, cvToValue, OptionalCV, UIntCV } from "@stacks/transactions";
+import { RevokeDelegateStxCommand } from "./pox_RevokeDelegateStxCommand";
+import { AllowContractCallerCommand } from "./pox_AllowContractCallerCommand";
+import { DelegateStackIncreaseCommand } from "./pox_DelegateStackIncreaseCommand";
+import { DelegateStackExtendCommand } from "./pox_DelegateStackExtendCommand";
+import { StackAggregationCommitAuthCommand } from "./pox_StackAggregationCommitAuthCommand";
+import { StackAggregationCommitSigCommand } from "./pox_StackAggregationCommitSigCommand";
+import { StackAggregationCommitIndexedSigCommand } from "./pox_StackAggregationCommitIndexedSigCommand";
+import { StackAggregationCommitIndexedAuthCommand } from "./pox_StackAggregationCommitIndexedAuthCommand";
+import { StackAggregationIncreaseCommand } from "./pox_StackAggregationIncreaseCommand";
+import { DisallowContractCallerCommand } from "./pox_DisallowContractCallerCommand";
+import { StackExtendAuthCommand } from "./pox_StackExtendAuthCommand";
+import { StackExtendSigCommand } from "./pox_StackExtendSigCommand";
+import { StackIncreaseAuthCommand } from "./pox_StackIncreaseAuthCommand";
+import { StackIncreaseSigCommand } from "./pox_StackIncreaseSigCommand";
+
+export function PoxCommands(
+ wallets: Map,
+ stackers: Map,
+ network: Simnet,
+): fc.Arbitrary[] {
+ const cmds = [
+ // GetStackingMinimumCommand
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ }).map((
+ r: {
+ wallet: Wallet;
+ },
+ ) =>
+ new GetStackingMinimumCommand(
+ r.wallet,
+ )
+ ),
+ // StackStxSigCommand
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ period: fc.integer({ min: 1, max: 12 }),
+ margin: fc.integer({ min: 1, max: 9 }),
+ }).map((
+ r: {
+ wallet: Wallet;
+ authId: number;
+ period: number;
+ margin: number;
+ },
+ ) =>
+ new StackStxSigCommand(
+ r.wallet,
+ r.authId,
+ r.period,
+ r.margin,
+ )
+ ),
+ // StackStxAuthCommand
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ period: fc.integer({ min: 1, max: 12 }),
+ margin: fc.integer({ min: 1, max: 9 }),
+ }).map((
+ r: {
+ wallet: Wallet;
+ authId: number;
+ period: number;
+ margin: number;
+ },
+ ) =>
+ new StackStxAuthCommand(
+ r.wallet,
+ r.authId,
+ r.period,
+ r.margin,
+ )
+ ),
+ // StackExtendAuthCommand
+ fc
+ .record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ extendCount: fc.integer({ min: 1, max: 12 }),
+ currentCycle: fc.constant(currentCycle(network)),
+ })
+ .map(
+ (r: {
+ wallet: Wallet;
+ extendCount: number;
+ authId: number;
+ currentCycle: number;
+ }) =>
+ new StackExtendAuthCommand(
+ r.wallet,
+ r.extendCount,
+ r.authId,
+ r.currentCycle,
+ ),
+ ),
+ // StackExtendSigCommand
+ fc
+ .record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ extendCount: fc.integer({ min: 1, max: 12 }),
+ currentCycle: fc.constant(currentCycle(network)),
+ })
+ .map(
+ (r: {
+ wallet: Wallet;
+ extendCount: number;
+ authId: number;
+ currentCycle: number;
+ }) =>
+ new StackExtendSigCommand(
+ r.wallet,
+ r.extendCount,
+ r.authId,
+ r.currentCycle,
+ ),
+ ),
+ // StackIncreaseAuthCommand
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ increaseBy: fc.nat(),
+ authId: fc.nat(),
+ })
+ .map((r) => {
+ return new StackIncreaseAuthCommand(
+ r.operator,
+ r.increaseBy,
+ r.authId,
+ );
+ }),
+ // StackIncreaseSigCommand
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ increaseBy: fc.nat(),
+ authId: fc.nat(),
+ })
+ .map((r) => {
+ return new StackIncreaseSigCommand(
+ r.operator,
+ r.increaseBy,
+ r.authId,
+ );
+ }),
+ // GetStackingMinimumCommand
+ fc
+ .record({
+ wallet: fc.constantFrom(...wallets.values()),
+ })
+ .map((r: { wallet: Wallet }) => new GetStackingMinimumCommand(r.wallet)),
+ // DelegateStxCommand
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ delegateTo: fc.constantFrom(...wallets.values()),
+ untilBurnHt: fc.oneof(
+ fc.constant(Cl.none()),
+ fc.integer({ min: 1 }).map((value) => Cl.some(Cl.uint(value))),
+ ),
+ amount: fc.bigInt({ min: 0n, max: 100_000_000_000_000n }),
+ }).map((
+ r: {
+ wallet: Wallet;
+ delegateTo: Wallet;
+ untilBurnHt: OptionalCV;
+ amount: bigint;
+ },
+ ) =>
+ new DelegateStxCommand(
+ r.wallet,
+ r.delegateTo,
+ r.untilBurnHt,
+ r.amount,
+ )
+ ),
+ // StackAggregationCommitAuthCommand
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ }).map((
+ r: {
+ wallet: Wallet;
+ authId: number;
+ },
+ ) =>
+ new StackAggregationCommitAuthCommand(
+ r.wallet,
+ r.authId,
+ )
+ ),
+ // StackAggregationCommitSigCommand
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ }).map((
+ r: {
+ wallet: Wallet;
+ authId: number;
+ },
+ ) =>
+ new StackAggregationCommitSigCommand(
+ r.wallet,
+ r.authId,
+ )
+ ),
+ // StackAggregationCommitIndexedAuthCommand
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ }).map((
+ r: {
+ wallet: Wallet;
+ authId: number;
+ },
+ ) =>
+ new StackAggregationCommitIndexedAuthCommand(
+ r.wallet,
+ r.authId,
+ )
+ ),
+ // StackAggregationCommitIndexedSigCommand
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ }).map((
+ r: {
+ wallet: Wallet;
+ authId: number;
+ },
+ ) =>
+ new StackAggregationCommitIndexedSigCommand(
+ r.wallet,
+ r.authId,
+ )
+ ),
+ // StackAggregationIncreaseCommand
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ authId: fc.nat(),
+ }).chain((r) => {
+ const operator = stackers.get(r.wallet.stxAddress)!;
+ const committedRewCycleIndexesOrFallback =
+ operator.committedRewCycleIndexes.length > 0
+ ? operator.committedRewCycleIndexes
+ : [-1];
+ return fc.record({
+ rewardCycleIndex: fc.constantFrom(
+ ...committedRewCycleIndexesOrFallback,
+ ),
+ }).map((cycleIndex) => ({ ...r, ...cycleIndex }));
+ }).map((
+ r: {
+ wallet: Wallet;
+ rewardCycleIndex: number;
+ authId: number;
+ },
+ ) =>
+ new StackAggregationIncreaseCommand(
+ r.wallet,
+ r.rewardCycleIndex,
+ r.authId,
+ )
+ ),
+ // RevokeDelegateStxCommand
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ }).map((
+ r: {
+ wallet: Wallet;
+ },
+ ) =>
+ new RevokeDelegateStxCommand(
+ r.wallet,
+ )
+ ),
+ // DelegateStackStxCommand
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ startBurnHt: fc.integer({
+ min: currentCycleFirstBlock(network),
+ max: nextCycleFirstBlock(network),
+ }),
+ period: fc.integer({ min: 1, max: 12 }),
+ }).chain((r) => {
+ const operator = stackers.get(r.operator.stxAddress)!;
+ // Determine available stackers based on the operator
+ const availableStackers = operator.poolMembers.length > 0
+ ? operator.poolMembers
+ : [r.operator.stxAddress];
+
+ return fc.record({
+ stacker: fc.constantFrom(...availableStackers),
+ }).map((stacker) => ({
+ ...r,
+ stacker: wallets.get(stacker.stacker)!,
+ })).chain((resultWithStacker) => {
+ return fc.record({
+ unlockBurnHt: fc.constant(
+ currentCycleFirstBlock(network) +
+ 1050 * (resultWithStacker.period + 1),
+ ),
+ }).map((additionalProps) => ({
+ ...resultWithStacker,
+ ...additionalProps,
+ }));
+ }).chain((resultWithUnlockHeight) => {
+ return fc.record({
+ amount: fc.bigInt({
+ min: 0n,
+ max: BigInt(
+ stackers.get(resultWithUnlockHeight.stacker.stxAddress)!
+ .delegatedMaxAmount,
+ ),
+ }),
+ }).map((amountProps) => ({
+ ...resultWithUnlockHeight,
+ ...amountProps,
+ }));
+ });
+ }).map((finalResult) => {
+ return new DelegateStackStxCommand(
+ finalResult.operator,
+ finalResult.stacker,
+ finalResult.period,
+ finalResult.amount,
+ finalResult.unlockBurnHt,
+ );
+ }),
+ // DelegateStackIncreaseCommand
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ increaseBy: fc.nat(),
+ })
+ .chain((r) => {
+ const operator = stackers.get(r.operator.stxAddress)!;
+ const delegatorsList = operator.poolMembers;
+
+ const availableStackers = delegatorsList.filter((delegator) => {
+ const delegatorWallet = stackers.get(delegator)!;
+ return delegatorWallet.unlockHeight > nextCycleFirstBlock(network);
+ });
+
+ const availableStackersOrFallback = availableStackers.length === 0
+ ? [r.operator.stxAddress]
+ : availableStackers;
+
+ return fc
+ .record({
+ stacker: fc.constantFrom(...availableStackersOrFallback),
+ })
+ .map((stacker) => ({
+ ...r,
+ stacker: wallets.get(stacker.stacker)!,
+ }));
+ })
+ .map((final) => {
+ return new DelegateStackIncreaseCommand(
+ final.operator,
+ final.stacker,
+ final.increaseBy,
+ );
+ }),
+ // DelegateStackExtendCommand
+ fc.record({
+ operator: fc.constantFrom(...wallets.values()),
+ extendCount: fc.integer({ min: 1, max: 11 }),
+ }).chain((r) => {
+ const operator = stackers.get(r.operator.stxAddress)!;
+ const delegatorsList = operator.poolMembers;
+ const availableStackers = delegatorsList.filter((delegator) => {
+ const delegatorWallet = stackers.get(delegator)!;
+ return delegatorWallet.unlockHeight > nextCycleFirstBlock(network);
+ });
+
+ const availableStackersOrFallback = availableStackers.length === 0
+ ? [r.operator.stxAddress]
+ : availableStackers;
+
+ return fc.record({
+ stacker: fc.constantFrom(...availableStackersOrFallback),
+ currentCycle: fc.constant(currentCycle(network)),
+ })
+ .map((additionalProps) => ({
+ ...r,
+ stacker: wallets.get(additionalProps.stacker)!,
+ currentCycle: additionalProps.currentCycle,
+ }));
+ }).map((final) =>
+ new DelegateStackExtendCommand(
+ final.operator,
+ final.stacker,
+ final.extendCount,
+ final.currentCycle,
+ )
+ ),
+ // AllowContractCallerCommand
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ allowanceTo: fc.constantFrom(...wallets.values()),
+ alllowUntilBurnHt: fc.oneof(
+ fc.constant(Cl.none()),
+ fc.integer({ min: 1 }).map((value) => Cl.some(Cl.uint(value))),
+ ),
+ })
+ .map(
+ (r: {
+ wallet: Wallet;
+ allowanceTo: Wallet;
+ alllowUntilBurnHt: OptionalCV;
+ }) =>
+ new AllowContractCallerCommand(
+ r.wallet,
+ r.allowanceTo,
+ r.alllowUntilBurnHt,
+ ),
+ ),
+ // DisallowContractCallerCommand
+ fc.record({
+ stacker: fc.constantFrom(...wallets.values()),
+ callerToDisallow: fc.constantFrom(...wallets.values()),
+ }).map(
+ (r: {
+ stacker: Wallet;
+ callerToDisallow: Wallet;
+ }) =>
+ new DisallowContractCallerCommand(
+ r.stacker,
+ r.callerToDisallow,
+ ),
+ ),
+ // GetStxAccountCommand
+ fc.record({
+ wallet: fc.constantFrom(...wallets.values()),
+ }).map((
+ r: {
+ wallet: Wallet;
+ },
+ ) =>
+ new GetStxAccountCommand(
+ r.wallet,
+ )
+ ),
+ ];
+
+ return cmds;
+}
+
+export const REWARD_CYCLE_LENGTH = 1050;
+
+export const FIRST_BURNCHAIN_BLOCK_HEIGHT = 0;
+
+export const currentCycle = (network: Simnet) =>
+ Number(cvToValue(
+ network.callReadOnlyFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "current-pox-reward-cycle",
+ [],
+ "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM",
+ ).result,
+ ));
+
+export const currentCycleFirstBlock = (network: Simnet) =>
+ Number(cvToValue(
+ network.callReadOnlyFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "reward-cycle-to-burn-height",
+ [Cl.uint(currentCycle(network))],
+ "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM",
+ ).result,
+ ));
+
+export const nextCycleFirstBlock = (network: Simnet) =>
+ Number(cvToValue(
+ network.callReadOnlyFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "reward-cycle-to-burn-height",
+ [Cl.uint(currentCycle(network) + 1)],
+ "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM",
+ ).result,
+ ));
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStackExtendCommand.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStackExtendCommand.ts
new file mode 100644
index 00000000000..a3fe2a5f1a2
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStackExtendCommand.ts
@@ -0,0 +1,178 @@
+import {
+ isAmountLockedPositive,
+ isAmountWithinDelegationLimit,
+ isPeriodWithinMax,
+ isStackerDelegatingToOperator,
+ isDelegating,
+ isStacking,
+ isUBHWithinDelegationLimit,
+ isStackerInOperatorPool,
+ isStackerLockedByOperator,
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { poxAddressToTuple } from "@stacks/stacking";
+import { assert, expect } from "vitest";
+import { Cl, ClarityType, isClarityType } from "@stacks/transactions";
+import {
+ FIRST_BURNCHAIN_BLOCK_HEIGHT,
+ REWARD_CYCLE_LENGTH,
+} from "./pox_Commands.ts";
+
+/**
+ * The `DelegateStackExtendCommand` allows a pool operator to
+ * extend an active stacking lock, issuing a "partial commitment"
+ * for the extended-to cycles.
+ *
+ * This method extends stacker's current lockup for an additional
+ * extend-count and partially commits those new cycles to `pox-addr`.
+ *
+ * Constraints for running this command include:
+ * - Stacker must have locked uSTX.
+ * - The Operator has to currently be delegated by the Stacker.
+ * - The new lock period must be less than or equal to 12.
+ */
+export class DelegateStackExtendCommand implements PoxCommand {
+ readonly operator: Wallet;
+ readonly stacker: Wallet;
+ readonly extendCount: number;
+ readonly currentCycle: number;
+
+ /**
+ * Constructs a `DelegateStackExtendCommand` to extend the unlock
+ * height as a Pool Operator on behalf of a Stacker.
+ *
+ * @param operator - Represents the Pool Operator's wallet.
+ * @param stacker - Represents the Stacker's wallet.
+ * @param extendCount - Represents the number of cycles to extend
+ * the stack for.
+ * @param currentCycle - Represents the current PoX reward cycle.
+ */
+ constructor(
+ operator: Wallet,
+ stacker: Wallet,
+ extendCount: number,
+ currentCycle: number,
+ ) {
+ this.operator = operator;
+ this.stacker = stacker;
+ this.extendCount = extendCount;
+ this.currentCycle = currentCycle;
+ }
+
+ check(model: Readonly): boolean {
+ // Constraints for running this command include:
+ // - Stacker must have locked uSTX.
+ // - The Stacker's uSTX must have been locked by the Operator.
+ // - The Operator has to currently be delegated by the Stacker.
+ // - The new lock period must be less than or equal to 12.
+
+ const operatorWallet = model.stackers.get(this.operator.stxAddress)!;
+ const stackerWallet = model.stackers.get(this.stacker.stxAddress)!;
+
+ const firstRewardCycle = Math.max(
+ stackerWallet.firstLockedRewardCycle,
+ this.currentCycle,
+ );
+ const firstExtendCycle = Math.floor(
+ (stackerWallet.unlockHeight - FIRST_BURNCHAIN_BLOCK_HEIGHT) /
+ REWARD_CYCLE_LENGTH,
+ );
+ const lastExtendCycle = firstExtendCycle + this.extendCount - 1;
+ const totalPeriod = lastExtendCycle - firstRewardCycle + 1;
+ const newUnlockHeight =
+ REWARD_CYCLE_LENGTH * (firstRewardCycle + totalPeriod - 1) +
+ FIRST_BURNCHAIN_BLOCK_HEIGHT;
+ const stackedAmount = stackerWallet.amountLocked;
+
+ return (
+ isAmountLockedPositive(stackerWallet) &&
+ isDelegating(stackerWallet) &&
+ isStacking(stackerWallet) &&
+ isStackerDelegatingToOperator(stackerWallet, this.operator) &&
+ isUBHWithinDelegationLimit(stackerWallet, newUnlockHeight) &&
+ isAmountWithinDelegationLimit(stackerWallet, stackedAmount) &&
+ isStackerInOperatorPool(operatorWallet, this.stacker) &&
+ isStackerLockedByOperator(operatorWallet, this.stacker) &&
+ isPeriodWithinMax(totalPeriod)
+ );
+ }
+
+ run(model: Stub, real: Real): void {
+ model.trackCommandRun(this.constructor.name);
+
+ const stackerWallet = model.stackers.get(this.stacker.stxAddress)!;
+
+ // Act
+ const delegateStackExtend = real.network.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "delegate-stack-extend",
+ [
+ // (stacker principal)
+ Cl.principal(this.stacker.stxAddress),
+ // (pox-addr { version: (buff 1), hashbytes: (buff 32) })
+ poxAddressToTuple(stackerWallet.delegatedPoxAddress),
+ // (extend-count uint)
+ Cl.uint(this.extendCount),
+ ],
+ this.operator.stxAddress,
+ );
+
+ const { result: firstExtendCycle } = real.network.callReadOnlyFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "burn-height-to-reward-cycle",
+ [Cl.uint(stackerWallet.unlockHeight)],
+ this.operator.stxAddress,
+ );
+ assert(isClarityType(firstExtendCycle, ClarityType.UInt));
+
+ const lastExtendCycle = Number(firstExtendCycle.value) + this.extendCount -
+ 1;
+
+ const { result: extendedUnlockHeight } = real.network.callReadOnlyFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "reward-cycle-to-burn-height",
+ [Cl.uint(lastExtendCycle + 1)],
+ this.operator.stxAddress,
+ );
+ assert(isClarityType(extendedUnlockHeight, ClarityType.UInt));
+ const newUnlockHeight = extendedUnlockHeight.value;
+
+ // Assert
+ expect(delegateStackExtend.result).toBeOk(
+ Cl.tuple({
+ stacker: Cl.principal(this.stacker.stxAddress),
+ "unlock-burn-height": Cl.uint(newUnlockHeight),
+ }),
+ );
+
+ // Get the Stacker's wallet from the model and update it with the new state.
+ // Update model so that we know this wallet's unlock height was extended.
+ stackerWallet.unlockHeight = Number(newUnlockHeight);
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✓ ${this.operator.label} Ӿ ${this.stacker.label}`,
+ "delegate-stack-extend",
+ "extend count",
+ this.extendCount.toString(),
+ "new unlock height",
+ stackerWallet.unlockHeight.toString(),
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.operator.label} delegate-stack-extend extend count ${this.extendCount}`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStackExtendCommand_Err.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStackExtendCommand_Err.ts
new file mode 100644
index 00000000000..680532bef64
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStackExtendCommand_Err.ts
@@ -0,0 +1,96 @@
+import {
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { poxAddressToTuple } from "@stacks/stacking";
+import { expect } from "vitest";
+import { Cl } from "@stacks/transactions";
+
+type CheckFunc = (
+ this: DelegateStackExtendCommand_Err,
+ model: Readonly,
+) => boolean;
+
+export class DelegateStackExtendCommand_Err implements PoxCommand {
+ readonly operator: Wallet;
+ readonly stacker: Wallet;
+ readonly extendCount: number;
+ readonly currentCycle: number;
+ readonly checkFunc: CheckFunc;
+ readonly errorCode: number;
+
+ /**
+ * Constructs a `DelegateStackExtendCommand_Err` to extend the unlock
+ * height as a Pool Operator on behalf of a Stacker.
+ *
+ * @param operator - Represents the Pool Operator's wallet.
+ * @param stacker - Represents the Stacker's wallet.
+ * @param extendCount - Represents the number of cycles to extend the stack for.
+ * @param currentCycle - Represents the current PoX reward cycle.
+ * @param checkFunc - A function to check constraints for running this command.
+ * @param errorCode - The expected error code when running this command.
+ */
+ constructor(
+ operator: Wallet,
+ stacker: Wallet,
+ extendCount: number,
+ currentCycle: number,
+ checkFunc: CheckFunc,
+ errorCode: number,
+ ) {
+ this.operator = operator;
+ this.stacker = stacker;
+ this.extendCount = extendCount;
+ this.currentCycle = currentCycle;
+ this.checkFunc = checkFunc;
+ this.errorCode = errorCode;
+ }
+
+ check = (model: Readonly): boolean => this.checkFunc.call(this, model);
+
+ run(model: Stub, real: Real): void {
+ const stackerWallet = model.stackers.get(this.stacker.stxAddress)!;
+
+ // Act
+ const delegateStackExtend = real.network.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "delegate-stack-extend",
+ [
+ // (stacker principal)
+ Cl.principal(this.stacker.stxAddress),
+ // (pox-addr { version: (buff 1), hashbytes: (buff 32) })
+ poxAddressToTuple(this.operator.btcAddress),
+ // (extend-count uint)
+ Cl.uint(this.extendCount),
+ ],
+ this.operator.stxAddress,
+ );
+
+ expect(delegateStackExtend.result).toBeErr(Cl.int(this.errorCode));
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✗ ${this.operator.label} Ӿ ${this.stacker.label}`,
+ "delegate-stack-extend",
+ "extend count",
+ this.extendCount.toString(),
+ "new unlock height",
+ stackerWallet.unlockHeight.toString(),
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.operator.label} Ó¾ ${this.stacker.label} delegate-stack-extend extend count ${this.extendCount}`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStackIncreaseCommand.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStackIncreaseCommand.ts
new file mode 100644
index 00000000000..43b6a0473af
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStackIncreaseCommand.ts
@@ -0,0 +1,150 @@
+import {
+ isAmountLockedPositive,
+ isAmountWithinDelegationLimit,
+ isIncreaseAmountGTZero,
+ isIncreaseByWithinUnlockedBalance,
+ isStackerDelegatingToOperator,
+ isDelegating,
+ isStacking,
+ isUnlockedWithinCurrentRC,
+ isStackerLockedByOperator,
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { poxAddressToTuple } from "@stacks/stacking";
+import { expect } from "vitest";
+import { Cl } from "@stacks/transactions";
+
+/**
+ * The `DelegateStackIncreaseCommand` allows a pool operator to
+ * increase an active stacking lock, issuing a "partial commitment"
+ * for the increased cycles.
+ *
+ * This method increases stacker's current lockup and partially
+ * commits the additional STX to `pox-addr`.
+ *
+ * Constraints for running this command include:
+ * - The Stacker must have locked uSTX.
+ * - The Operator has to currently be delegated by the Stacker.
+ * - The increase amount must be greater than 0.
+ * - Stacker's unlocked uSTX amount must be greater than or equal
+ * to the value of the increase amount.
+ * - Stacker's maximum delegated amount must be greater than or equal
+ * to the final locked amount.
+ * - The Operator must have locked the Stacker's previously locked funds.
+ */
+export class DelegateStackIncreaseCommand implements PoxCommand {
+ readonly operator: Wallet;
+ readonly stacker: Wallet;
+ readonly increaseBy: number;
+
+ /**
+ * Constructs a `DelegateStackIncreaseCommand` to increase the uSTX amount
+ * previously locked on behalf of a Stacker.
+ *
+ * @param operator - Represents the Pool Operator's wallet.
+ * @param stacker - Represents the Stacker's wallet.
+ * @param increaseBy - Represents the locked amount to be increased by.
+ */
+ constructor(operator: Wallet, stacker: Wallet, increaseBy: number) {
+ this.operator = operator;
+ this.stacker = stacker;
+ this.increaseBy = increaseBy;
+ }
+
+ check(model: Readonly): boolean {
+ // Constraints for running this command include:
+ // - The Stacker must have locked uSTX.
+ // - The Operator has to currently be delegated by the Stacker.
+ // - The increase amount must be greater than 0.
+ // - Stacker's unlocked uSTX amount must be greater than or equal
+ // to the value of the increase amount.
+ // - Stacker's maximum delegated amount must be greater than or equal
+ // to the final locked amount.
+ // - The Operator must have locked the Stacker's previously locked funds.
+
+ const operatorWallet = model.stackers.get(this.operator.stxAddress)!;
+ const stackerWallet = model.stackers.get(this.stacker.stxAddress)!;
+
+ return (
+ isAmountLockedPositive(stackerWallet) &&
+ isDelegating(stackerWallet) &&
+ isStacking(stackerWallet) &&
+ isIncreaseAmountGTZero(this.increaseBy) &&
+ isStackerDelegatingToOperator(stackerWallet, this.operator) &&
+ isIncreaseByWithinUnlockedBalance(stackerWallet, this.increaseBy) &&
+ isAmountWithinDelegationLimit(
+ stackerWallet,
+ this.increaseBy + stackerWallet.amountLocked,
+ ) &&
+ isStackerLockedByOperator(operatorWallet, this.stacker) &&
+ isUnlockedWithinCurrentRC(stackerWallet, model)
+ );
+ }
+
+ run(model: Stub, real: Real): void {
+ model.trackCommandRun(this.constructor.name);
+
+ const stackerWallet = model.stackers.get(this.stacker.stxAddress)!;
+ const prevLocked = stackerWallet.amountLocked;
+ const newTotalLocked = prevLocked + this.increaseBy;
+ // Act
+ const delegateStackIncrease = real.network.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "delegate-stack-increase",
+ [
+ // (stacker principal)
+ Cl.principal(this.stacker.stxAddress),
+ // (pox-addr { version: (buff 1), hashbytes: (buff 32) })
+ poxAddressToTuple(stackerWallet.delegatedPoxAddress),
+ // (increase-by uint)
+ Cl.uint(this.increaseBy),
+ ],
+ this.operator.stxAddress,
+ );
+
+ // Assert
+ expect(delegateStackIncrease.result).toBeOk(
+ Cl.tuple({
+ stacker: Cl.principal(this.stacker.stxAddress),
+ "total-locked": Cl.uint(newTotalLocked),
+ }),
+ );
+
+ // Get the Stacker's wallet from the model and update it with the new state.
+ const operatorWallet = model.stackers.get(this.operator.stxAddress)!;
+ // Update model so that we know this stacker has increased the stacked amount.
+ // Update locked and unlocked fields in the model.
+ stackerWallet.amountLocked = newTotalLocked;
+ stackerWallet.amountUnlocked = stackerWallet.amountUnlocked -
+ this.increaseBy;
+ operatorWallet.amountToCommit += this.increaseBy;
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✓ ${this.operator.label} Ӿ ${this.stacker.label}`,
+ "delegate-stack-increase",
+ "increased by",
+ this.increaseBy.toString(),
+ "previously locked",
+ prevLocked.toString(),
+ "total locked",
+ stackerWallet.amountLocked.toString(),
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.operator.label} delegate-stack-increase by ${this.increaseBy}`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStackIncreaseCommand_Err.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStackIncreaseCommand_Err.ts
new file mode 100644
index 00000000000..fe33805264f
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStackIncreaseCommand_Err.ts
@@ -0,0 +1,95 @@
+import {
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { poxAddressToTuple } from "@stacks/stacking";
+import { expect } from "vitest";
+import { Cl } from "@stacks/transactions";
+
+type CheckFunc = (
+ this: DelegateStackIncreaseCommand_Err,
+ model: Readonly,
+) => boolean;
+
+export class DelegateStackIncreaseCommand_Err implements PoxCommand {
+ readonly operator: Wallet;
+ readonly stacker: Wallet;
+ readonly increaseBy: number;
+ readonly checkFunc: CheckFunc;
+ readonly errorCode: number;
+
+ /**
+ * Constructs a `DelegateStackIncreaseCommand_Err` to increase the uSTX amount
+ * previously locked on behalf of a Stacker.
+ *
+ * @param operator - Represents the Pool Operator's wallet.
+ * @param stacker - Represents the Stacker's wallet.
+ * @param increaseBy - Represents the locked amount to be increased by.
+ * @param checkFunc - A function to check constraints for running this command.
+ * @param errorCode - The expected error code when running this command.
+ */
+ constructor(
+ operator: Wallet,
+ stacker: Wallet,
+ increaseBy: number,
+ checkFunc: CheckFunc,
+ errorCode: number,
+ ) {
+ this.operator = operator;
+ this.stacker = stacker;
+ this.increaseBy = increaseBy;
+ this.checkFunc = checkFunc;
+ this.errorCode = errorCode;
+ }
+
+ check = (model: Readonly): boolean => this.checkFunc.call(this, model);
+
+ run(model: Stub, real: Real): void {
+ const stackerWallet = model.stackers.get(this.stacker.stxAddress)!;
+ const prevLocked = stackerWallet.amountLocked;
+ // Act
+ const delegateStackIncrease = real.network.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "delegate-stack-increase",
+ [
+ // (stacker principal)
+ Cl.principal(this.stacker.stxAddress),
+ // (pox-addr { version: (buff 1), hashbytes: (buff 32) })
+ poxAddressToTuple(this.operator.btcAddress),
+ // (increase-by uint)
+ Cl.uint(this.increaseBy),
+ ],
+ this.operator.stxAddress,
+ );
+
+ // Assert
+ expect(delegateStackIncrease.result).toBeErr(Cl.int(this.errorCode));
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✗ ${this.operator.label} Ӿ ${this.stacker.label}`,
+ "delegate-stack-increase",
+ "increased by",
+ this.increaseBy.toString(),
+ "previously locked",
+ prevLocked.toString(),
+ "total locked",
+ stackerWallet.amountLocked.toString(),
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.operator.label} delegate-stack-increase by ${this.increaseBy}`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStackStxCommand.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStackStxCommand.ts
new file mode 100644
index 00000000000..70f56fc1914
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStackStxCommand.ts
@@ -0,0 +1,198 @@
+import {
+ isAmountAboveThreshold,
+ isAmountWithinBalance,
+ isAmountWithinDelegationLimit,
+ isStackerDelegatingToOperator,
+ isDelegating,
+ isStacking,
+ isStackingMinimumCalculated,
+ isUBHWithinDelegationLimit,
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { poxAddressToTuple } from "@stacks/stacking";
+import { assert, expect } from "vitest";
+import {
+ Cl,
+ ClarityType,
+ ClarityValue,
+ cvToValue,
+ isClarityType,
+} from "@stacks/transactions";
+import { currentCycle } from "./pox_Commands.ts";
+
+/**
+ * The `DelegateStackStxCommand` locks STX for stacking within PoX-4 on behalf
+ * of a delegator. This operation allows the `operator` to stack the `stacker`'s
+ * STX.
+ *
+ * Constraints for running this command include:
+ * - A minimum threshold of uSTX must be met, determined by the
+ * `get-stacking-minimum` function at the time of this call.
+ * - The Stacker cannot currently be engaged in another stacking operation.
+ * - The Stacker has to currently be delegating to the Operator.
+ * - The stacked uSTX amount should be less than or equal to the delegated
+ * amount.
+ * - The stacked uSTX amount should be less than or equal to the Stacker's
+ * balance.
+ * - The stacked uSTX amount should be greater than or equal to the minimum
+ * threshold of uSTX.
+ * - The Operator has to currently be delegated by the Stacker.
+ * - The Period has to fit the last delegation burn block height.
+ */
+export class DelegateStackStxCommand implements PoxCommand {
+ readonly operator: Wallet;
+ readonly stacker: Wallet;
+ readonly period: number;
+ readonly amountUstx: bigint;
+ readonly unlockBurnHt: number;
+
+ /**
+ * Constructs a `DelegateStackStxCommand` to lock uSTX as a Pool Operator
+ * on behalf of a Stacker.
+ *
+ * @param operator - Represents the Pool Operator's wallet.
+ * @param stacker - Represents the Stacker's wallet.
+ * @param period - Number of reward cycles to lock uSTX.
+ * @param amountUstx - The uSTX amount stacked by the Operator on behalf
+ * of the Stacker.
+ * @param unlockBurnHt - The burn height at which the uSTX is unlocked.
+ */
+ constructor(
+ operator: Wallet,
+ stacker: Wallet,
+ period: number,
+ amountUstx: bigint,
+ unlockBurnHt: number,
+ ) {
+ this.operator = operator;
+ this.stacker = stacker;
+ this.period = period;
+ this.amountUstx = amountUstx;
+ this.unlockBurnHt = unlockBurnHt;
+ }
+
+ check(model: Readonly): boolean {
+ // Constraints for running this command include:
+ // - A minimum threshold of uSTX must be met, determined by the
+ // `get-stacking-minimum` function at the time of this call.
+ // - The Stacker cannot currently be engaged in another stacking
+ // operation.
+ // - The Stacker has to currently be delegating to the Operator.
+ // - The stacked uSTX amount should be less than or equal to the
+ // delegated amount.
+ // - The stacked uSTX amount should be less than or equal to the
+ // Stacker's balance.
+ // - The stacked uSTX amount should be greater than or equal to the
+ // minimum threshold of uSTX.
+ // - The Operator has to currently be delegated by the Stacker.
+ // - The Period has to fit the last delegation burn block height.
+
+ const stackerWallet = model.stackers.get(this.stacker.stxAddress)!;
+
+ return (
+ isStackingMinimumCalculated(model) &&
+ !isStacking(stackerWallet) &&
+ isDelegating(stackerWallet) &&
+ isAmountWithinDelegationLimit(stackerWallet, this.amountUstx) &&
+ isAmountWithinBalance(stackerWallet, this.amountUstx) &&
+ isAmountAboveThreshold(model, this.amountUstx) &&
+ isStackerDelegatingToOperator(stackerWallet, this.operator) &&
+ isUBHWithinDelegationLimit(stackerWallet, this.unlockBurnHt)
+ );
+ }
+
+ run(model: Stub, real: Real): void {
+ model.trackCommandRun(this.constructor.name);
+ const burnBlockHeightCV = real.network.runSnippet("burn-block-height");
+ const burnBlockHeight = Number(
+ cvToValue(burnBlockHeightCV as ClarityValue),
+ );
+
+ // Act
+ const delegateStackStx = real.network.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "delegate-stack-stx",
+ [
+ // (stacker principal)
+ Cl.principal(this.stacker.stxAddress),
+ // (amount-ustx uint)
+ Cl.uint(this.amountUstx),
+ // (pox-addr { version: (buff 1), hashbytes: (buff 32) })
+ poxAddressToTuple(this.operator.btcAddress),
+ // (start-burn-ht uint)
+ Cl.uint(burnBlockHeight),
+ // (lock-period uint)
+ Cl.uint(this.period),
+ ],
+ this.operator.stxAddress,
+ );
+ const { result: rewardCycle } = real.network.callReadOnlyFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "burn-height-to-reward-cycle",
+ [Cl.uint(burnBlockHeight)],
+ this.operator.stxAddress,
+ );
+ assert(isClarityType(rewardCycle, ClarityType.UInt));
+
+ const { result: unlockBurnHeight } = real.network.callReadOnlyFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "reward-cycle-to-burn-height",
+ [Cl.uint(Number(rewardCycle.value) + this.period + 1)],
+ this.operator.stxAddress,
+ );
+ assert(isClarityType(unlockBurnHeight, ClarityType.UInt));
+
+ // Assert
+ expect(delegateStackStx.result).toBeOk(
+ Cl.tuple({
+ stacker: Cl.principal(this.stacker.stxAddress),
+ "lock-amount": Cl.uint(this.amountUstx),
+ "unlock-burn-height": Cl.uint(Number(unlockBurnHeight.value)),
+ }),
+ );
+
+ // Get the Stacker's wallet from the model and update it with the new state.
+ const stackerWallet = model.stackers.get(this.stacker.stxAddress)!;
+ const operatorWallet = model.stackers.get(this.operator.stxAddress)!;
+ // Update model so that we know this wallet is stacking. This is important
+ // in order to prevent the test from stacking multiple times with the same
+ // address.
+ stackerWallet.isStacking = true;
+ // Update locked, unlocked, and unlock-height fields in the model.
+ stackerWallet.amountLocked = Number(this.amountUstx);
+ stackerWallet.unlockHeight = Number(unlockBurnHeight.value);
+ stackerWallet.amountUnlocked -= Number(this.amountUstx);
+ stackerWallet.firstLockedRewardCycle = currentCycle(real.network) + 1;
+ // Add stacker to the operators lock list. This will help knowing that
+ // the stacker's funds are locked when calling delegate-stack-extend
+ // and delegate-stack-increase.
+ operatorWallet.lockedAddresses.push(this.stacker.stxAddress);
+ operatorWallet.amountToCommit += Number(this.amountUstx);
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✓ ${this.operator.label} Ӿ ${this.stacker.label}`,
+ "delegate-stack-stx",
+ "lock-amount",
+ this.amountUstx.toString(),
+ "until",
+ stackerWallet.unlockHeight.toString(),
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.operator.label} delegate-stack-stx stacker ${this.stacker.label} period ${this.period}`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStackStxCommand_Err.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStackStxCommand_Err.ts
new file mode 100644
index 00000000000..fdec28a3558
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStackStxCommand_Err.ts
@@ -0,0 +1,105 @@
+import {
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { poxAddressToTuple } from "@stacks/stacking";
+import { expect } from "vitest";
+import { Cl, ClarityValue, cvToValue } from "@stacks/transactions";
+
+type CheckFunc = (
+ this: DelegateStackStxCommand_Err,
+ model: Readonly,
+) => boolean;
+
+export class DelegateStackStxCommand_Err implements PoxCommand {
+ readonly operator: Wallet;
+ readonly stacker: Wallet;
+ readonly period: number;
+ readonly amountUstx: bigint;
+ readonly unlockBurnHt: number;
+ readonly checkFunc: CheckFunc;
+ readonly errorCode: number;
+
+ /**
+ * Constructs a `DelegateStackStxCommand` to lock uSTX as a Pool Operator
+ * on behalf of a Stacker.
+ *
+ * @param operator - Represents the Pool Operator's wallet.
+ * @param stacker - Represents the Stacker's wallet.
+ * @param period - Number of reward cycles to lock uSTX.
+ * @param amountUstx - The uSTX amount stacked by the Operator on behalf
+ * of the Stacker.
+ * @param unlockBurnHt - The burn height at which the uSTX is unlocked.
+ */
+ constructor(
+ operator: Wallet,
+ stacker: Wallet,
+ period: number,
+ amountUstx: bigint,
+ unlockBurnHt: number,
+ checkFunc: CheckFunc,
+ errorCode: number,
+ ) {
+ this.operator = operator;
+ this.stacker = stacker;
+ this.period = period;
+ this.amountUstx = amountUstx;
+ this.unlockBurnHt = unlockBurnHt;
+ this.checkFunc = checkFunc;
+ this.errorCode = errorCode;
+ }
+
+ check = (model: Readonly): boolean => this.checkFunc.call(this, model);
+
+ run(model: Stub, real: Real): void {
+ const burnBlockHeightCV = real.network.runSnippet("burn-block-height");
+ const burnBlockHeight = Number(
+ cvToValue(burnBlockHeightCV as ClarityValue),
+ );
+
+ // Act
+ const delegateStackStx = real.network.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "delegate-stack-stx",
+ [
+ // (stacker principal)
+ Cl.principal(this.stacker.stxAddress),
+ // (amount-ustx uint)
+ Cl.uint(this.amountUstx),
+ // (pox-addr { version: (buff 1), hashbytes: (buff 32) })
+ poxAddressToTuple(this.operator.btcAddress),
+ // (start-burn-ht uint)
+ Cl.uint(burnBlockHeight),
+ // (lock-period uint)
+ Cl.uint(this.period),
+ ],
+ this.operator.stxAddress,
+ );
+
+ // Assert
+ expect(delegateStackStx.result).toBeErr(Cl.int(this.errorCode));
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✗ ${this.operator.label} Ӿ ${this.stacker.label}`,
+ "delegate-stack-stx",
+ "lock-amount",
+ this.amountUstx.toString(),
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.operator.label} delegate-stack-stx stacker ${this.stacker.label} period ${this.period}`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStxCommand.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStxCommand.ts
new file mode 100644
index 00000000000..cd14c39ce30
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStxCommand.ts
@@ -0,0 +1,136 @@
+import {
+ isDelegating,
+ isStackingMinimumCalculated,
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { poxAddressToTuple } from "@stacks/stacking";
+import { expect } from "vitest";
+import {
+ boolCV,
+ Cl,
+ ClarityType,
+ cvToValue,
+ isClarityType,
+ OptionalCV,
+ UIntCV,
+} from "@stacks/transactions";
+
+/**
+ * The `DelegateStxCommand` delegates STX for stacking within PoX-4. This
+ * operation allows the `tx-sender` (the `wallet` in this case) to delegate
+ * stacking participation to a `delegatee`.
+ *
+ * Constraints for running this command include:
+ * - The Stacker cannot currently be a delegator in another delegation.
+ */
+export class DelegateStxCommand implements PoxCommand {
+ readonly wallet: Wallet;
+ readonly delegateTo: Wallet;
+ readonly untilBurnHt: OptionalCV;
+ readonly amount: bigint;
+
+ /**
+ * Constructs a `DelegateStxCommand` to delegate uSTX for stacking.
+ *
+ * @param wallet - Represents the Stacker's wallet.
+ * @param delegateTo - Represents the Delegatee's STX address.
+ * @param untilBurnHt - The burn block height until the delegation is valid.
+ * @param amount - The maximum amount the `Stacker` delegates the `Delegatee`
+ * to stack on his behalf.
+ */
+ constructor(
+ wallet: Wallet,
+ delegateTo: Wallet,
+ untilBurnHt: OptionalCV,
+ amount: bigint,
+ ) {
+ this.wallet = wallet;
+ this.delegateTo = delegateTo;
+ this.untilBurnHt = untilBurnHt;
+ this.amount = amount;
+ }
+
+ check(model: Readonly): boolean {
+ // Constraints for running this command include:
+ // - The Stacker cannot currently be a delegator in another delegation.
+ const stackerWallet = model.stackers.get(this.wallet.stxAddress)!;
+
+ return (
+ isStackingMinimumCalculated(model) &&
+ !isDelegating(stackerWallet)
+ );
+ }
+
+ run(model: Stub, real: Real): void {
+ model.trackCommandRun(this.constructor.name);
+
+ // The amount of uSTX delegated by the Stacker to the Delegatee.
+ // Even if there are no constraints about the delegated amount,
+ // it will be checked in the future, when calling delegate-stack-stx.
+ const amountUstx = Number(this.amount);
+
+ // Act
+ const delegateStx = real.network.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "delegate-stx",
+ [
+ // (amount-ustx uint)
+ Cl.uint(amountUstx),
+ // (delegate-to principal)
+ Cl.principal(this.delegateTo.stxAddress),
+ // (until-burn-ht (optional uint))
+ this.untilBurnHt,
+ // (pox-addr (optional { version: (buff 1), hashbytes: (buff 32) }))
+ Cl.some(poxAddressToTuple(this.delegateTo.btcAddress)),
+ ],
+ this.wallet.stxAddress,
+ );
+
+ // Assert
+ expect(delegateStx.result).toBeOk(boolCV(true));
+
+ // Get the wallet from the model and update it with the new state.
+ const wallet = model.stackers.get(this.wallet.stxAddress)!;
+ const delegatedWallet = model.stackers.get(this.delegateTo.stxAddress)!;
+ // Update model so that we know this wallet has delegated. This is important
+ // in order to prevent the test from delegating multiple times with the same
+ // address.
+ wallet.hasDelegated = true;
+ wallet.delegatedTo = this.delegateTo.stxAddress;
+ wallet.delegatedMaxAmount = amountUstx;
+ wallet.delegatedUntilBurnHt =
+ isClarityType(this.untilBurnHt, ClarityType.OptionalNone)
+ ? undefined
+ : Number(cvToValue(this.untilBurnHt).value);
+ wallet.delegatedPoxAddress = this.delegateTo.btcAddress;
+
+ delegatedWallet.poolMembers.push(this.wallet.stxAddress);
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✓ ${this.wallet.label}`,
+ "delegate-stx",
+ "amount",
+ amountUstx.toString(),
+ "delegated to",
+ this.delegateTo.label,
+ "until",
+ this.untilBurnHt.toString(),
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.wallet.label} delegate-stx to ${this.delegateTo.label} until burn ht ${this.untilBurnHt}`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStxCommand_Err.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStxCommand_Err.ts
new file mode 100644
index 00000000000..138d99265fa
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DelegateStxCommand_Err.ts
@@ -0,0 +1,104 @@
+import {
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { poxAddressToTuple } from "@stacks/stacking";
+import { expect } from "vitest";
+import { Cl } from "@stacks/transactions";
+
+type CheckFunc = (
+ this: DelegateStxCommand_Err,
+ model: Readonly,
+) => boolean;
+
+export class DelegateStxCommand_Err implements PoxCommand {
+ readonly wallet: Wallet;
+ readonly delegateTo: Wallet;
+ readonly untilBurnHt: number;
+ readonly amount: bigint;
+ readonly checkFunc: CheckFunc;
+ readonly errorCode: number;
+
+ /**
+ * Constructs a `DelegateStxCommand_Err` to delegate uSTX for stacking.
+ *
+ * @param wallet - Represents the Stacker's wallet.
+ * @param delegateTo - Represents the Delegatee's STX address.
+ * @param untilBurnHt - The burn block height until the delegation is valid.
+ * @param amount - The maximum amount the `Stacker` delegates the `Delegatee`
+ * to stack on his behalf.
+ * @param checkFunc - A function to check constraints for running this command.
+ * @param errorCode - The expected error code when running this command.
+ */
+ constructor(
+ wallet: Wallet,
+ delegateTo: Wallet,
+ untilBurnHt: number,
+ amount: bigint,
+ checkFunc: CheckFunc,
+ errorCode: number,
+ ) {
+ this.wallet = wallet;
+ this.delegateTo = delegateTo;
+ this.untilBurnHt = untilBurnHt;
+ this.amount = amount;
+ this.checkFunc = checkFunc;
+ this.errorCode = errorCode;
+ }
+
+ check = (model: Readonly): boolean => this.checkFunc.call(this, model);
+
+ run(model: Stub, real: Real): void {
+ // The amount of uSTX delegated by the Stacker to the Delegatee.
+ // Even if there are no constraints about the delegated amount,
+ // it will be checked in the future, when calling delegate-stack-stx.
+ const amountUstx = Number(this.amount);
+
+ // Act
+ const delegateStx = real.network.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "delegate-stx",
+ [
+ // (amount-ustx uint)
+ Cl.uint(amountUstx),
+ // (delegate-to principal)
+ Cl.principal(this.delegateTo.stxAddress),
+ // (until-burn-ht (optional uint))
+ Cl.some(Cl.uint(this.untilBurnHt)),
+ // (pox-addr (optional { version: (buff 1), hashbytes: (buff 32) }))
+ Cl.some(poxAddressToTuple(this.delegateTo.btcAddress)),
+ ],
+ this.wallet.stxAddress,
+ );
+
+ // Assert
+ expect(delegateStx.result).toBeErr(Cl.int(this.errorCode));
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✗ ${this.wallet.label}`,
+ "delegate-stx",
+ "amount",
+ amountUstx.toString(),
+ "delegated to",
+ this.delegateTo.label,
+ "until",
+ this.untilBurnHt.toString(),
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.wallet.label} delegate-stx to ${this.delegateTo.label} until burn ht ${this.untilBurnHt}`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DisallowContractCallerCommand.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DisallowContractCallerCommand.ts
new file mode 100644
index 00000000000..6108a5973f1
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DisallowContractCallerCommand.ts
@@ -0,0 +1,113 @@
+import {
+ isAllowedContractCaller,
+ isCallerAllowedByStacker,
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { expect } from "vitest";
+import { boolCV, Cl } from "@stacks/transactions";
+
+/**
+ * The `DisallowContractCallerComand` revokes a `contract-caller`'s
+ * authorization to call stacking methods.
+ *
+ * Constraints for running this command include:
+ * - The Caller to be disallowed must have been previously
+ * allowed by the Operator.
+ */
+export class DisallowContractCallerCommand implements PoxCommand {
+ readonly stacker: Wallet;
+ readonly callerToDisallow: Wallet;
+
+ /**
+ * Constructs a `DisallowContractCallerComand` to revoke authorization
+ * for calling stacking methods.
+ *
+ * @param stacker - Represents the `Stacker`'s wallet.
+ * @param callerToDisallow - The `contract-caller` to be revoked.
+ */
+ constructor(stacker: Wallet, callerToDisallow: Wallet) {
+ this.stacker = stacker;
+ this.callerToDisallow = callerToDisallow;
+ }
+
+ check(model: Readonly): boolean {
+ // Constraints for running this command include:
+ // - The Caller to be disallowed must have been previously allowed
+ // by the Operator.
+
+ const stacker = model.stackers.get(this.stacker.stxAddress)!;
+ const callerToDisallow = model.stackers.get(
+ this.callerToDisallow.stxAddress,
+ )!;
+
+ return (
+ isAllowedContractCaller(stacker, this.callerToDisallow) &&
+ isCallerAllowedByStacker(this.stacker, callerToDisallow)
+ );
+ }
+
+ run(model: Stub, real: Real): void {
+ model.trackCommandRun(this.constructor.name);
+
+ // Act
+ const disallowContractCaller = real.network.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "disallow-contract-caller",
+ [
+ // (caller principal)
+ Cl.principal(this.callerToDisallow.stxAddress),
+ ],
+ this.stacker.stxAddress,
+ );
+
+ // Assert
+ expect(disallowContractCaller.result).toBeOk(boolCV(true));
+
+ // Get the wallet to be revoked stacking rights from the model and
+ // update it with the new state.
+ const callerToDisallow = model.stackers.get(
+ this.callerToDisallow.stxAddress,
+ )!;
+
+ // Update model so that we know that the stacker has revoked stacking
+ // allowance.
+ const stacker = model.stackers.get(this.stacker.stxAddress)!;
+ const callerToDisallowIndex = stacker.allowedContractCallers.indexOf(
+ this.callerToDisallow.stxAddress,
+ );
+
+ expect(callerToDisallowIndex).toBeGreaterThan(-1);
+ stacker.allowedContractCallers.splice(callerToDisallowIndex, 1);
+
+ // Remove the operator from the caller to disallow's allowance list.
+ const walletIndexAllowedByList = callerToDisallow.callerAllowedBy.indexOf(
+ this.stacker.stxAddress,
+ );
+
+ expect(walletIndexAllowedByList).toBeGreaterThan(-1);
+ callerToDisallow.callerAllowedBy.splice(walletIndexAllowedByList, 1);
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✓ ${this.stacker.label}`,
+ "disallow-contract-caller",
+ this.callerToDisallow.label,
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.stacker.label} disallow-contract-caller ${this.callerToDisallow.label}`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DisallowContractCallerCommand_Err.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DisallowContractCallerCommand_Err.ts
new file mode 100644
index 00000000000..028457b41e4
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_DisallowContractCallerCommand_Err.ts
@@ -0,0 +1,73 @@
+import {
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { expect } from "vitest";
+import { Cl } from "@stacks/transactions";
+
+type CheckFunc = (
+ this: DisallowContractCallerCommand_Err,
+ model: Readonly,
+) => boolean;
+
+export class DisallowContractCallerCommand_Err implements PoxCommand {
+ readonly stacker: Wallet;
+ readonly callerToDisallow: Wallet;
+ readonly checkFunc: CheckFunc;
+
+ /**
+ * Constructs a `DisallowContractCallerComand` to revoke authorization
+ * for calling stacking methods.
+ *
+ * @param stacker - Represents the `Stacker`'s wallet.
+ * @param callerToDisallow - The `contract-caller` to be revoked.
+ * @param checkFunc - A function to check constraints for running this command.
+ */
+ constructor(stacker: Wallet, callerToDisallow: Wallet, checkFunc: CheckFunc) {
+ this.stacker = stacker;
+ this.callerToDisallow = callerToDisallow;
+ this.checkFunc = checkFunc;
+ }
+
+ check = (model: Readonly): boolean => this.checkFunc.call(this, model); // Constraints for running this command include:
+ // - The Caller to be disallowed must have been previously allowed
+ // by the Operator.
+
+ run(model: Stub, real: Real): void {
+ // Act
+ const disallowContractCaller = real.network.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "disallow-contract-caller",
+ [
+ // (caller principal)
+ Cl.principal(this.callerToDisallow.stxAddress),
+ ],
+ this.stacker.stxAddress,
+ );
+
+ // Assert
+ expect(disallowContractCaller.result).toBeOk(Cl.bool(false));
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✗ ${this.stacker.label}`,
+ "disallow-contract-caller",
+ this.callerToDisallow.label,
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.stacker.label} disallow-contract-caller ${this.callerToDisallow.label}`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_GetStackingMinimumCommand.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_GetStackingMinimumCommand.ts
new file mode 100644
index 00000000000..50dd7bf16c0
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_GetStackingMinimumCommand.ts
@@ -0,0 +1,70 @@
+import {
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { assert } from "vitest";
+import { ClarityType, isClarityType } from "@stacks/transactions";
+
+/**
+ * Implements the `PoxCommand` interface to get the minimum stacking amount
+ * required for a given reward cycle.
+ */
+export class GetStackingMinimumCommand implements PoxCommand {
+ readonly wallet: Wallet;
+
+ /**
+ * Constructs a new `GetStackingMinimumCommand`.
+ *
+ * @param wallet The wallet information, including the STX address used to
+ * query the stacking minimum requirement.
+ */
+ constructor(wallet: Wallet) {
+ this.wallet = wallet;
+ }
+
+ check(_model: Readonly): boolean {
+ // There are no constraints for running this command.
+ return true;
+ }
+
+ run(model: Stub, real: Real): void {
+ model.trackCommandRun(this.constructor.name);
+
+ // Act
+ const { result: stackingMinimum } = real.network.callReadOnlyFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "get-stacking-minimum",
+ [],
+ this.wallet.stxAddress,
+ );
+ assert(isClarityType(stackingMinimum, ClarityType.UInt));
+
+ // Update the model with the new stacking minimum. This is important for
+ // the `check` method of the `StackStxCommand` class to work correctly, as
+ // we as other tests that may depend on the stacking minimum.
+ model.stackingMinimum = Number(stackingMinimum.value);
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✓ ${this.wallet.label}`,
+ "get-stacking-minimum",
+ "pox-4",
+ stackingMinimum.value.toString(),
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.wallet.label} get-stacking-minimum`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_GetStxAccountCommand.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_GetStxAccountCommand.ts
new file mode 100644
index 00000000000..60d8ff38b28
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_GetStxAccountCommand.ts
@@ -0,0 +1,72 @@
+import {
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { expect } from "vitest";
+import { Cl } from "@stacks/transactions";
+
+/**
+ * Implements the `PoxCommand` interface to get the info returned from the
+ * `stx-account`.
+ */
+export class GetStxAccountCommand implements PoxCommand {
+ readonly wallet: Wallet;
+
+ /**
+ * Constructs a new `GetStxAccountCommand`.
+ *
+ * @param wallet The wallet information, including the STX address used to
+ * query the `stx-account`.
+ */
+ constructor(wallet: Wallet) {
+ this.wallet = wallet;
+ }
+
+ check(_model: Readonly): boolean {
+ // There are no constraints for running this command.
+ return true;
+ }
+
+ run(model: Stub, real: Real): void {
+ model.trackCommandRun(this.constructor.name);
+
+ const actual = model.stackers.get(this.wallet.stxAddress)!;
+ expect(real.network.runSnippet(`(stx-account '${this.wallet.stxAddress})`))
+ .toBeTuple({
+ "locked": Cl.uint(actual.amountLocked),
+ "unlocked": Cl.uint(actual.amountUnlocked),
+ "unlock-height": Cl.uint(actual.unlockHeight),
+ });
+
+ expect(actual.amountLocked + actual.amountUnlocked).toBe(
+ actual.ustxBalance,
+ );
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✓ ${this.wallet.label}`,
+ "stx-account",
+ "lock-amount",
+ actual.amountLocked.toString(),
+ "unlocked-amount",
+ actual.amountUnlocked.toString(),
+ "unlocked-height",
+ actual.unlockHeight.toString(),
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.wallet.label} stx-account`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_RevokeDelegateStxCommand.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_RevokeDelegateStxCommand.ts
new file mode 100644
index 00000000000..98e2349a1fe
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_RevokeDelegateStxCommand.ts
@@ -0,0 +1,119 @@
+import {
+ isDelegating,
+ isStackingMinimumCalculated,
+ isUBHWithinDelegationLimit,
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { poxAddressToTuple } from "@stacks/stacking";
+import { expect } from "vitest";
+import { Cl, someCV, tupleCV } from "@stacks/transactions";
+
+/**
+ * The `RevokeDelegateStxCommand` revokes the delegation for stacking within
+ * PoX-4.
+ *
+ * Constraints for running this command include:
+ * - The `Stacker` has to currently be delegating.
+ * - The `Stacker`'s delegation must not be expired.
+ */
+export class RevokeDelegateStxCommand implements PoxCommand {
+ readonly wallet: Wallet;
+
+ /**
+ * Constructs a `RevokeDelegateStxCommand` to revoke a stacking delegation.
+ *
+ * @param wallet - Represents the Stacker's wallet.
+ */
+ constructor(wallet: Wallet) {
+ this.wallet = wallet;
+ }
+
+ check(model: Readonly): boolean {
+ // Constraints for running this command include:
+ // - The Stacker has to currently be delegating.
+ // - The Stacker's delegation must not be expired.
+ const stacker = model.stackers.get(this.wallet.stxAddress)!;
+
+ return (
+ isStackingMinimumCalculated(model) &&
+ isDelegating(stacker) &&
+ isUBHWithinDelegationLimit(stacker, model.burnBlockHeight)
+ );
+ }
+
+ run(model: Stub, real: Real): void {
+ model.trackCommandRun(this.constructor.name);
+
+ const wallet = model.stackers.get(this.wallet.stxAddress)!;
+ const operatorWallet = model.stackers.get(wallet.delegatedTo)!;
+ const expectedUntilBurnHt = wallet.delegatedUntilBurnHt === undefined
+ ? Cl.none()
+ : Cl.some(Cl.uint(wallet.delegatedUntilBurnHt));
+
+ // Act
+ const revokeDelegateStx = real.network.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "revoke-delegate-stx",
+ [],
+ this.wallet.stxAddress,
+ );
+
+ // Assert
+ expect(revokeDelegateStx.result).toBeOk(
+ someCV(
+ tupleCV({
+ "amount-ustx": Cl.uint(wallet.delegatedMaxAmount),
+ "delegated-to": Cl.principal(
+ model.stackers.get(this.wallet.stxAddress)!.delegatedTo || "",
+ ),
+ "pox-addr": Cl.some(
+ poxAddressToTuple(wallet.delegatedPoxAddress || ""),
+ ),
+ "until-burn-ht": expectedUntilBurnHt,
+ }),
+ ),
+ );
+
+ // Get the Stacker's wallet from the model and update the two wallets
+ // involved with the new state.
+ // Update model so that we know this wallet is not delegating anymore.
+ // This is important in order to prevent the test from revoking the
+ // delegation multiple times with the same address.
+ // We update delegatedUntilBurnHt to 0, and not undefined. Undefined
+ // stands for indefinite delegation.
+ wallet.hasDelegated = false;
+ wallet.delegatedTo = "";
+ wallet.delegatedUntilBurnHt = 0;
+ wallet.delegatedMaxAmount = 0;
+ wallet.delegatedPoxAddress = "";
+
+ // Remove the Stacker from the Pool Operator's pool members list.
+ const walletIndexInDelegatorsList = operatorWallet.poolMembers.indexOf(
+ this.wallet.stxAddress,
+ );
+ expect(walletIndexInDelegatorsList).toBeGreaterThan(-1);
+ operatorWallet.poolMembers.splice(walletIndexInDelegatorsList, 1);
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✓ ${this.wallet.label}`,
+ "revoke-delegate-stx",
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.wallet.stxAddress} revoke-delegate-stx`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_RevokeDelegateStxCommand_Err.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_RevokeDelegateStxCommand_Err.ts
new file mode 100644
index 00000000000..a7a4cb0a6e5
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_RevokeDelegateStxCommand_Err.ts
@@ -0,0 +1,66 @@
+import {
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { expect } from "vitest";
+import { Cl } from "@stacks/transactions";
+
+type CheckFunc = (
+ this: RevokeDelegateStxCommand_Err,
+ model: Readonly,
+) => boolean;
+
+export class RevokeDelegateStxCommand_Err implements PoxCommand {
+ readonly wallet: Wallet;
+ readonly checkFunc: CheckFunc;
+ readonly errorCode: number;
+
+ /**
+ * Constructs a `RevokeDelegateStxCommand_Err` to revoke a stacking delegation.
+ *
+ * @param wallet - Represents the Stacker's wallet.
+ * @param checkFunc - A function to check constraints for running this command.
+ * @param errorCode - The expected error code when running this command.
+ */
+ constructor(wallet: Wallet, checkFunc: CheckFunc, errorCode: number) {
+ this.wallet = wallet;
+ this.checkFunc = checkFunc;
+ this.errorCode = errorCode;
+ }
+
+ check = (model: Readonly): boolean => this.checkFunc.call(this, model);
+
+ run(model: Stub, real: Real): void {
+ // Act
+ const revokeDelegateStx = real.network.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "revoke-delegate-stx",
+ [],
+ this.wallet.stxAddress,
+ );
+
+ // Assert
+ expect(revokeDelegateStx.result).toBeErr(Cl.int(this.errorCode));
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✗ ${this.wallet.label}`,
+ "revoke-delegate-stx",
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.wallet.stxAddress} revoke-delegate-stx`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitAuthCommand.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitAuthCommand.ts
new file mode 100644
index 00000000000..7145c673d41
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitAuthCommand.ts
@@ -0,0 +1,150 @@
+import {
+ hasLockedStackers,
+ isATCAboveThreshold,
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { poxAddressToTuple } from "@stacks/stacking";
+import { expect } from "vitest";
+import { Cl } from "@stacks/transactions";
+import { currentCycle } from "./pox_Commands.ts";
+import { tx } from "@hirosystems/clarinet-sdk";
+
+/**
+ * The `StackAggregationCommitAuthCommand` allows an operator to commit
+ * partially stacked STX & to allocate a new PoX reward address slot.
+ * This allows a stacker to lock fewer STX than the minimal threshold
+ * in multiple transactions, so long as:
+ * 1. The pox-addr is the same.
+ * 2. The "commit" transaction is called _before_ the PoX anchor block.
+ *
+ * This command calls stack-aggregation-commit using an `authorization`.
+ *
+ * Constraints for running this command include:
+ * - The Operator must have locked STX on behalf of at least one stacker.
+ * - The total amount previously locked by the Operator on behalf of the
+ * stackers has to be greater than the uSTX threshold.
+ */
+export class StackAggregationCommitAuthCommand implements PoxCommand {
+ readonly operator: Wallet;
+ readonly authId: number;
+
+ /**
+ * Constructs a `StackAggregationCommitAuthCommand` to commit partially
+ * locked uSTX.
+ *
+ * @param operator - Represents the `Operator`'s wallet.
+ * @param authId - Unique `auth-id` for the authorization.
+ */
+ constructor(
+ operator: Wallet,
+ authId: number,
+ ) {
+ this.operator = operator;
+ this.authId = authId;
+ }
+
+ check(model: Readonly): boolean {
+ // Constraints for running this command include:
+ // - The Operator must have locked STX on behalf of at least one stacker.
+ // - The total amount previously locked by the Operator on behalf of the
+ // stackers has to be greater than the uSTX threshold.
+
+ const operator = model.stackers.get(this.operator.stxAddress)!;
+ return (
+ hasLockedStackers(operator) &&
+ isATCAboveThreshold(operator, model)
+ );
+ }
+
+ run(model: Stub, real: Real): void {
+ model.trackCommandRun(this.constructor.name);
+ const currentRewCycle = currentCycle(real.network);
+ const operatorWallet = model.stackers.get(this.operator.stxAddress)!;
+ const committedAmount = operatorWallet.amountToCommit;
+
+ // Act
+
+ // Include the authorization and the `stack-aggregation-commit` transactions
+ // in a single block. This way we ensure both the authorization and the
+ // stack-aggregation-commit transactions are called during the same reward
+ // cycle, so the authorization currentRewCycle param is relevant for the
+ // upcoming stack-aggregation-commit call.
+ const block = real.network.mineBlock([
+ tx.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "set-signer-key-authorization",
+ [
+ // (pox-addr (tuple (version (buff 1)) (hashbytes (buff 32))))
+ poxAddressToTuple(this.operator.btcAddress),
+ // (period uint)
+ Cl.uint(1),
+ // (reward-cycle uint)
+ Cl.uint(currentRewCycle + 1),
+ // (topic (string-ascii 14))
+ Cl.stringAscii("agg-commit"),
+ // (signer-key (buff 33))
+ Cl.bufferFromHex(this.operator.signerPubKey),
+ // (allowed bool)
+ Cl.bool(true),
+ // (max-amount uint)
+ Cl.uint(committedAmount),
+ // (auth-id uint)
+ Cl.uint(this.authId),
+ ],
+ this.operator.stxAddress,
+ ),
+ tx.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "stack-aggregation-commit",
+ [
+ // (pox-addr (tuple (version (buff 1)) (hashbytes (buff 32))))
+ poxAddressToTuple(this.operator.btcAddress),
+ // (reward-cycle uint)
+ Cl.uint(currentRewCycle + 1),
+ // (signer-sig (optional (buff 65)))
+ Cl.none(),
+ // (signer-key (buff 33))
+ Cl.bufferFromHex(this.operator.signerPubKey),
+ // (max-amount uint)
+ Cl.uint(committedAmount),
+ // (auth-id uint)
+ Cl.uint(this.authId),
+ ],
+ this.operator.stxAddress,
+ ),
+ ]);
+
+ // Assert
+ expect(block[0].result).toBeOk(Cl.bool(true));
+ expect(block[1].result).toBeOk(Cl.bool(true));
+
+ operatorWallet.amountToCommit -= committedAmount;
+ operatorWallet.committedRewCycleIndexes.push(model.nextRewardSetIndex);
+ model.nextRewardSetIndex++;
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✓ ${this.operator.label}`,
+ "stack-agg-commit",
+ "amount committed",
+ committedAmount.toString(),
+ "authorization",
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.operator.label} stack-aggregation-commit auth-id ${this.authId}`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitAuthCommand_Err.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitAuthCommand_Err.ts
new file mode 100644
index 00000000000..ddc986f1a42
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitAuthCommand_Err.ts
@@ -0,0 +1,128 @@
+import {
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { poxAddressToTuple } from "@stacks/stacking";
+import { expect } from "vitest";
+import { Cl } from "@stacks/transactions";
+import { currentCycle } from "./pox_Commands.ts";
+import { tx } from "@hirosystems/clarinet-sdk";
+
+type CheckFunc = (
+ this: StackAggregationCommitAuthCommand_Err,
+ model: Readonly,
+) => boolean;
+
+export class StackAggregationCommitAuthCommand_Err implements PoxCommand {
+ readonly operator: Wallet;
+ readonly authId: number;
+ readonly checkFunc: CheckFunc;
+ readonly errorCode: number;
+
+ /**
+ * Constructs a `StackAggregationCommitAuthCommand_Err` to commit partially
+ * locked uSTX.
+ *
+ * @param operator - Represents the `Operator`'s wallet.
+ * @param authId - Unique `auth-id` for the authorization.
+ * @param checkFunc - A function to check constraints for running this command.
+ * @param errorCode - The expected error code when running this command.
+ */
+ constructor(
+ operator: Wallet,
+ authId: number,
+ checkFunc: CheckFunc,
+ errorCode: number,
+ ) {
+ this.operator = operator;
+ this.authId = authId;
+ this.checkFunc = checkFunc;
+ this.errorCode = errorCode;
+ }
+
+ check = (model: Readonly): boolean => this.checkFunc.call(this, model);
+
+ run(model: Stub, real: Real): void {
+ const currentRewCycle = currentCycle(real.network);
+ const operatorWallet = model.stackers.get(this.operator.stxAddress)!;
+ const committedAmount = operatorWallet.amountToCommit;
+
+ // Include the authorization and the `stack-aggregation-commit` transactions
+ // in a single block. This way we ensure both the authorization and the
+ // stack-aggregation-commit transactions are called during the same reward
+ // cycle, so the authorization currentRewCycle param is relevant for the
+ // upcoming stack-aggregation-commit call.
+ const block = real.network.mineBlock([
+ tx.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "set-signer-key-authorization",
+ [
+ // (pox-addr (tuple (version (buff 1)) (hashbytes (buff 32))))
+ poxAddressToTuple(this.operator.btcAddress),
+ // (period uint)
+ Cl.uint(1),
+ // (reward-cycle uint)
+ Cl.uint(currentRewCycle + 1),
+ // (topic (string-ascii 14))
+ Cl.stringAscii("agg-commit"),
+ // (signer-key (buff 33))
+ Cl.bufferFromHex(this.operator.signerPubKey),
+ // (allowed bool)
+ Cl.bool(true),
+ // (max-amount uint)
+ Cl.uint(committedAmount),
+ // (auth-id uint)
+ Cl.uint(this.authId),
+ ],
+ this.operator.stxAddress,
+ ),
+ tx.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "stack-aggregation-commit",
+ [
+ // (pox-addr (tuple (version (buff 1)) (hashbytes (buff 32))))
+ poxAddressToTuple(this.operator.btcAddress),
+ // (reward-cycle uint)
+ Cl.uint(currentRewCycle + 1),
+ // (signer-sig (optional (buff 65)))
+ Cl.none(),
+ // (signer-key (buff 33))
+ Cl.bufferFromHex(this.operator.signerPubKey),
+ // (max-amount uint)
+ Cl.uint(committedAmount),
+ // (auth-id uint)
+ Cl.uint(this.authId),
+ ],
+ this.operator.stxAddress,
+ ),
+ ]);
+
+ // Assert
+ expect(block[0].result).toBeOk(Cl.bool(true));
+ expect(block[1].result).toBeErr(Cl.int(this.errorCode));
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✗ ${this.operator.label}`,
+ "stack-agg-commit",
+ "amount committed",
+ committedAmount.toString(),
+ "authorization",
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.operator.label} stack-aggregation-commit auth-id ${this.authId}`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitIndexedAuthCommand.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitIndexedAuthCommand.ts
new file mode 100644
index 00000000000..ba9679e639f
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitIndexedAuthCommand.ts
@@ -0,0 +1,155 @@
+import {
+ hasLockedStackers,
+ isATCAboveThreshold,
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { poxAddressToTuple } from "@stacks/stacking";
+import { expect } from "vitest";
+import { Cl } from "@stacks/transactions";
+import { currentCycle } from "./pox_Commands.ts";
+import { tx } from "@hirosystems/clarinet-sdk";
+
+/**
+ * The `StackAggregationCommitIndexedAuthCommand` allows an operator to
+ * commit partially stacked STX & to allocate a new PoX reward address
+ * slot.
+ * This allows a stacker to lock fewer STX than the minimal threshold
+ * in multiple transactions, so long as:
+ * 1. The pox-addr is the same.
+ * 2. The "commit" transaction is called _before_ the PoX anchor block.
+ *
+ * This command calls `stack-aggregation-commit-indexed` using an
+ * `authorization`.
+ *
+ * Constraints for running this command include:
+ * - The Operator must have locked STX on behalf of at least one stacker.
+ * - The total amount previously locked by the Operator on behalf of the
+ * stackers has to be greater than the uSTX threshold.
+ */
+export class StackAggregationCommitIndexedAuthCommand implements PoxCommand {
+ readonly operator: Wallet;
+ readonly authId: number;
+
+ /**
+ * Constructs a `StackAggregationCommitIndexedAuthCommand` to commit partially
+ * locked uSTX.
+ *
+ * @param operator - Represents the `Operator`'s wallet.
+ * @param authId - Unique `auth-id` for the authorization.
+ */
+ constructor(
+ operator: Wallet,
+ authId: number,
+ ) {
+ this.operator = operator;
+ this.authId = authId;
+ }
+
+ check(model: Readonly): boolean {
+ // Constraints for running this command include:
+ // - The Operator must have locked STX on behalf of at least one stacker.
+ // - The total amount previously locked by the Operator on behalf of the
+ // stackers has to be greater than the uSTX threshold.
+
+ const operator = model.stackers.get(this.operator.stxAddress)!;
+ return (
+ hasLockedStackers(operator) &&
+ isATCAboveThreshold(operator, model)
+ );
+ }
+
+ run(model: Stub, real: Real): void {
+ model.trackCommandRun(this.constructor.name);
+ const currentRewCycle = currentCycle(real.network);
+ const operatorWallet = model.stackers.get(this.operator.stxAddress)!;
+ const committedAmount = operatorWallet.amountToCommit;
+
+ // Act
+
+ // Include the authorization and the `stack-aggregation-commit-indexed`
+ // transactions in a single block. This way we ensure both the authorization
+ // and the stack-aggregation-commit-indexed transactions are called during
+ // the same reward cycle, so the authorization currentRewCycle param is
+ // relevant for the upcoming stack-aggregation-commit-indexed call.
+ const block = real.network.mineBlock([
+ tx.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "set-signer-key-authorization",
+ [
+ // (pox-addr (tuple (version (buff 1)) (hashbytes (buff 32))))
+ poxAddressToTuple(this.operator.btcAddress),
+ // (period uint)
+ Cl.uint(1),
+ // (reward-cycle uint)
+ Cl.uint(currentRewCycle + 1),
+ // (topic (string-ascii 14))
+ Cl.stringAscii("agg-commit"),
+ // (signer-key (buff 33))
+ Cl.bufferFromHex(this.operator.signerPubKey),
+ // (allowed bool)
+ Cl.bool(true),
+ // (max-amount uint)
+ Cl.uint(committedAmount),
+ // (auth-id uint)
+ Cl.uint(this.authId),
+ ],
+ this.operator.stxAddress,
+ ),
+ tx.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "stack-aggregation-commit-indexed",
+ [
+ // (pox-addr (tuple (version (buff 1)) (hashbytes (buff 32))))
+ poxAddressToTuple(this.operator.btcAddress),
+ // (reward-cycle uint)
+ Cl.uint(currentRewCycle + 1),
+ // (signer-sig (optional (buff 65)))
+ Cl.none(),
+ // (signer-key (buff 33))
+ Cl.bufferFromHex(this.operator.signerPubKey),
+ // (max-amount uint)
+ Cl.uint(committedAmount),
+ // (auth-id uint)
+ Cl.uint(this.authId),
+ ],
+ this.operator.stxAddress,
+ ),
+ ]);
+
+ // Assert
+ expect(block[0].result).toBeOk(Cl.bool(true));
+ expect(block[1].result).toBeOk(
+ Cl.uint(model.nextRewardSetIndex),
+ );
+
+ // Update the model
+ operatorWallet.amountToCommit -= committedAmount;
+ operatorWallet.committedRewCycleIndexes.push(model.nextRewardSetIndex);
+ model.nextRewardSetIndex++;
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✓ ${this.operator.label}`,
+ "stack-agg-commit-indexed",
+ "amount committed",
+ committedAmount.toString(),
+ "authorization",
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.operator.label} stack-aggregation-commit-indexed auth-id ${this.authId}`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitIndexedAuthCommand_Err.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitIndexedAuthCommand_Err.ts
new file mode 100644
index 00000000000..1c891df2700
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitIndexedAuthCommand_Err.ts
@@ -0,0 +1,133 @@
+import {
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { poxAddressToTuple } from "@stacks/stacking";
+import { expect } from "vitest";
+import { Cl } from "@stacks/transactions";
+import { currentCycle } from "./pox_Commands.ts";
+import { tx } from "@hirosystems/clarinet-sdk";
+
+type CheckFunc = (
+ this: StackAggregationCommitIndexedAuthCommand_Err,
+ model: Readonly,
+) => boolean;
+
+export class StackAggregationCommitIndexedAuthCommand_Err
+ implements PoxCommand {
+ readonly operator: Wallet;
+ readonly authId: number;
+ readonly checkFunc: CheckFunc;
+ readonly errorCode: number;
+
+ /**
+ * Constructs a `StackAggregationCommitIndexedAuthCommand_Err` to commit partially
+ * locked uSTX.
+ *
+ * @param operator - Represents the `Operator`'s wallet.
+ * @param authId - Unique `auth-id` for the authorization.
+ * @param checkFunc - A function to check constraints for running this command.
+ * @param errorCode - The expected error code when running this command.
+ */
+ constructor(
+ operator: Wallet,
+ authId: number,
+ checkFunc: CheckFunc,
+ errorCode: number,
+ ) {
+ this.operator = operator;
+ this.authId = authId;
+ this.checkFunc = checkFunc;
+ this.errorCode = errorCode;
+ }
+
+ check = (model: Readonly): boolean => this.checkFunc.call(this, model);
+
+ run(model: Stub, real: Real): void {
+ const currentRewCycle = currentCycle(real.network);
+ const operatorWallet = model.stackers.get(this.operator.stxAddress)!;
+ const committedAmount = operatorWallet.amountToCommit;
+
+ // Act
+
+ // Include the authorization and the `stack-aggregation-commit-indexed`
+ // transactions in a single block. This way we ensure both the authorization
+ // and the stack-aggregation-commit-indexed transactions are called during
+ // the same reward cycle, so the authorization currentRewCycle param is
+ // relevant for the upcoming stack-aggregation-commit-indexed call.
+ const block = real.network.mineBlock([
+ tx.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "set-signer-key-authorization",
+ [
+ // (pox-addr (tuple (version (buff 1)) (hashbytes (buff 32))))
+ poxAddressToTuple(this.operator.btcAddress),
+ // (period uint)
+ Cl.uint(1),
+ // (reward-cycle uint)
+ Cl.uint(currentRewCycle + 1),
+ // (topic (string-ascii 14))
+ Cl.stringAscii("agg-commit"),
+ // (signer-key (buff 33))
+ Cl.bufferFromHex(this.operator.signerPubKey),
+ // (allowed bool)
+ Cl.bool(true),
+ // (max-amount uint)
+ Cl.uint(committedAmount),
+ // (auth-id uint)
+ Cl.uint(this.authId),
+ ],
+ this.operator.stxAddress,
+ ),
+ tx.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "stack-aggregation-commit-indexed",
+ [
+ // (pox-addr (tuple (version (buff 1)) (hashbytes (buff 32))))
+ poxAddressToTuple(this.operator.btcAddress),
+ // (reward-cycle uint)
+ Cl.uint(currentRewCycle + 1),
+ // (signer-sig (optional (buff 65)))
+ Cl.none(),
+ // (signer-key (buff 33))
+ Cl.bufferFromHex(this.operator.signerPubKey),
+ // (max-amount uint)
+ Cl.uint(committedAmount),
+ // (auth-id uint)
+ Cl.uint(this.authId),
+ ],
+ this.operator.stxAddress,
+ ),
+ ]);
+
+ // Assert
+ expect(block[0].result).toBeOk(Cl.bool(true));
+ expect(block[1].result).toBeErr(
+ Cl.int(this.errorCode),
+ );
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✗ ${this.operator.label}`,
+ "stack-agg-commit-indexed",
+ "amount committed",
+ committedAmount.toString(),
+ "authorization",
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.operator.label} stack-aggregation-commit-indexed auth-id ${this.authId}`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitIndexedSigCommand.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitIndexedSigCommand.ts
new file mode 100644
index 00000000000..beb91ea87f9
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitIndexedSigCommand.ts
@@ -0,0 +1,147 @@
+import {
+ hasLockedStackers,
+ isATCAboveThreshold,
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { Pox4SignatureTopic, poxAddressToTuple } from "@stacks/stacking";
+import { expect } from "vitest";
+import { Cl } from "@stacks/transactions";
+import { bufferFromHex } from "@stacks/transactions/dist/cl";
+import { currentCycle } from "./pox_Commands.ts";
+
+/**
+ * The `StackAggregationCommitIndexedSigCommand` allows an operator to
+ * commit partially stacked STX & to allocate a new PoX reward address
+ * slot.
+ * This allows a stacker to lock fewer STX than the minimal threshold
+ * in multiple transactions, so long as:
+ * 1. The pox-addr is the same.
+ * 2. The "commit" transaction is called _before_ the PoX anchor block.
+ *
+ * This command calls `stack-aggregation-commit-indexed` using a
+ * `signature`.
+ *
+ * Constraints for running this command include:
+ * - The Operator must have locked STX on behalf of at least one stacker.
+ * - The total amount previously locked by the Operator on behalf of the
+ * stackers has to be greater than the uSTX threshold.
+ */
+export class StackAggregationCommitIndexedSigCommand implements PoxCommand {
+ readonly operator: Wallet;
+ readonly authId: number;
+
+ /**
+ * Constructs a `StackAggregationCommitIndexedSigCommand` to commit partially
+ * locked uSTX.
+ *
+ * @param operator - Represents the `Operator`'s wallet.
+ * @param authId - Unique `auth-id` for the authorization.
+ */
+ constructor(
+ operator: Wallet,
+ authId: number,
+ ) {
+ this.operator = operator;
+ this.authId = authId;
+ }
+
+ check(model: Readonly): boolean {
+ // Constraints for running this command include:
+ // - The Operator must have locked STX on behalf of at least one stacker.
+ // - The total amount previously locked by the Operator on behalf of the
+ // stackers has to be greater than the uSTX threshold.
+
+ const operator = model.stackers.get(this.operator.stxAddress)!;
+ return (
+ hasLockedStackers(operator) &&
+ isATCAboveThreshold(operator, model)
+ );
+ }
+
+ run(model: Stub, real: Real): void {
+ model.trackCommandRun(this.constructor.name);
+ const currentRewCycle = currentCycle(real.network);
+ const operatorWallet = model.stackers.get(this.operator.stxAddress)!;
+ const committedAmount = operatorWallet.amountToCommit;
+
+ const signerSig = this.operator.stackingClient.signPoxSignature({
+ // The signer key being authorized.
+ signerPrivateKey: this.operator.signerPrvKey,
+ // The reward cycle for which the authorization is valid.
+ // For stack-stx and stack-extend, this refers to the reward cycle
+ // where the transaction is confirmed. For stack-aggregation-commit,
+ // this refers to the reward cycle argument in that function.
+ rewardCycle: currentRewCycle + 1,
+ // For stack-stx, this refers to lock-period. For stack-extend,
+ // this refers to extend-count. For stack-aggregation-commit, this is
+ // u1.
+ period: 1,
+ // A string representing the function where this authorization is valid.
+ // Either stack-stx, stack-extend, stack-increase or agg-commit.
+ topic: Pox4SignatureTopic.AggregateCommit,
+ // The PoX address that can be used with this signer key.
+ poxAddress: this.operator.btcAddress,
+ // The unique auth-id for this authorization.
+ authId: this.authId,
+ // The maximum amount of uSTX that can be used (per tx) with this signer
+ // key.
+ maxAmount: committedAmount,
+ });
+
+ // Act
+ const stackAggregationCommitIndexed = real.network.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "stack-aggregation-commit-indexed",
+ [
+ // (pox-addr (tuple (version (buff 1)) (hashbytes (buff 32))))
+ poxAddressToTuple(this.operator.btcAddress),
+ // (reward-cycle uint)
+ Cl.uint(currentRewCycle + 1),
+ // (signer-sig (optional (buff 65)))
+ Cl.some(bufferFromHex(signerSig)),
+ // (signer-key (buff 33))
+ Cl.bufferFromHex(this.operator.signerPubKey),
+ // (max-amount uint)
+ Cl.uint(committedAmount),
+ // (auth-id uint)
+ Cl.uint(this.authId),
+ ],
+ this.operator.stxAddress,
+ );
+
+ // Assert
+ expect(stackAggregationCommitIndexed.result).toBeOk(
+ Cl.uint(model.nextRewardSetIndex),
+ );
+
+ // Update the model
+ operatorWallet.amountToCommit -= committedAmount;
+ operatorWallet.committedRewCycleIndexes.push(model.nextRewardSetIndex);
+ model.nextRewardSetIndex++;
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✓ ${this.operator.label}`,
+ "stack-agg-commit-indexed",
+ "amount committed",
+ committedAmount.toString(),
+ "signature",
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.operator.label} stack-aggregation-commit-indexed auth-id ${this.authId}`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitIndexedSigCommand_Err.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitIndexedSigCommand_Err.ts
new file mode 100644
index 00000000000..045142f3b42
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitIndexedSigCommand_Err.ts
@@ -0,0 +1,124 @@
+import {
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { Pox4SignatureTopic, poxAddressToTuple } from "@stacks/stacking";
+import { expect } from "vitest";
+import { Cl } from "@stacks/transactions";
+import { bufferFromHex } from "@stacks/transactions/dist/cl";
+import { currentCycle } from "./pox_Commands.ts";
+
+type CheckFunc = (
+ this: StackAggregationCommitIndexedSigCommand_Err,
+ model: Readonly,
+) => boolean;
+
+export class StackAggregationCommitIndexedSigCommand_Err implements PoxCommand {
+ readonly operator: Wallet;
+ readonly authId: number;
+ readonly checkFunc: CheckFunc;
+ readonly errorCode: number;
+
+ /**
+ * Constructs a `StackAggregationCommitIndexedSigCommand_Err` to commit partially
+ * locked uSTX.
+ *
+ * @param operator - Represents the `Operator`'s wallet.
+ * @param authId - Unique `auth-id` for the authorization.
+ * @param checkFunc - A function to check constraints for running this command.
+ * @param errorCode - The expected error code when running this command.
+ */
+ constructor(
+ operator: Wallet,
+ authId: number,
+ checkFunc: CheckFunc,
+ errorCode: number,
+ ) {
+ this.operator = operator;
+ this.authId = authId;
+ this.checkFunc = checkFunc;
+ this.errorCode = errorCode;
+ }
+
+ check = (model: Readonly): boolean => this.checkFunc.call(this, model);
+
+ run(model: Stub, real: Real): void {
+ const currentRewCycle = currentCycle(real.network);
+ const operatorWallet = model.stackers.get(this.operator.stxAddress)!;
+ const committedAmount = operatorWallet.amountToCommit;
+
+ const signerSig = this.operator.stackingClient.signPoxSignature({
+ // The signer key being authorized.
+ signerPrivateKey: this.operator.signerPrvKey,
+ // The reward cycle for which the authorization is valid.
+ // For stack-stx and stack-extend, this refers to the reward cycle
+ // where the transaction is confirmed. For stack-aggregation-commit,
+ // this refers to the reward cycle argument in that function.
+ rewardCycle: currentRewCycle + 1,
+ // For stack-stx, this refers to lock-period. For stack-extend,
+ // this refers to extend-count. For stack-aggregation-commit, this is
+ // u1.
+ period: 1,
+ // A string representing the function where this authorization is valid.
+ // Either stack-stx, stack-extend, stack-increase or agg-commit.
+ topic: Pox4SignatureTopic.AggregateCommit,
+ // The PoX address that can be used with this signer key.
+ poxAddress: this.operator.btcAddress,
+ // The unique auth-id for this authorization.
+ authId: this.authId,
+ // The maximum amount of uSTX that can be used (per tx) with this signer
+ // key.
+ maxAmount: committedAmount,
+ });
+
+ // Act
+ const stackAggregationCommitIndexed = real.network.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "stack-aggregation-commit-indexed",
+ [
+ // (pox-addr (tuple (version (buff 1)) (hashbytes (buff 32))))
+ poxAddressToTuple(this.operator.btcAddress),
+ // (reward-cycle uint)
+ Cl.uint(currentRewCycle + 1),
+ // (signer-sig (optional (buff 65)))
+ Cl.some(bufferFromHex(signerSig)),
+ // (signer-key (buff 33))
+ Cl.bufferFromHex(this.operator.signerPubKey),
+ // (max-amount uint)
+ Cl.uint(committedAmount),
+ // (auth-id uint)
+ Cl.uint(this.authId),
+ ],
+ this.operator.stxAddress,
+ );
+
+ // Assert
+ expect(stackAggregationCommitIndexed.result).toBeErr(
+ Cl.int(this.errorCode),
+ );
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✗ ${this.operator.label}`,
+ "stack-agg-commit-indexed",
+ "amount committed",
+ committedAmount.toString(),
+ "authorization",
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.operator.label} stack-aggregation-commit-indexed auth-id ${this.authId}`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitSigCommand.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitSigCommand.ts
new file mode 100644
index 00000000000..9e6bfd1bde6
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitSigCommand.ts
@@ -0,0 +1,142 @@
+import {
+ hasLockedStackers,
+ isATCAboveThreshold,
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { Pox4SignatureTopic, poxAddressToTuple } from "@stacks/stacking";
+import { expect } from "vitest";
+import { Cl } from "@stacks/transactions";
+import { bufferFromHex } from "@stacks/transactions/dist/cl";
+import { currentCycle } from "./pox_Commands.ts";
+
+/**
+ * The `StackAggregationCommitSigCommand` allows an operator to commit
+ * partially stacked STX & to allocate a new PoX reward address slot.
+ * This allows a stacker to lock fewer STX than the minimal threshold
+ * in multiple transactions, so long as:
+ * 1. The pox-addr is the same.
+ * 2. This "commit" transaction is called _before_ the PoX anchor block.
+ *
+ * This command calls `stack-aggregation-commit` using a `signature`.
+ *
+ * Constraints for running this command include:
+ * - The Operator must have locked STX on behalf of at least one stacker.
+ * - The total amount previously locked by the Operator on behalf of the
+ * stackers has to be greater than the uSTX threshold.
+ */
+export class StackAggregationCommitSigCommand implements PoxCommand {
+ readonly operator: Wallet;
+ readonly authId: number;
+
+ /**
+ * Constructs a `StackAggregationCommitSigCommand` to commit partially
+ * locked uSTX.
+ *
+ * @param operator - Represents the `Operator`'s wallet.
+ * @param authId - Unique `auth-id` for the authorization.
+ */
+ constructor(
+ operator: Wallet,
+ authId: number,
+ ) {
+ this.operator = operator;
+ this.authId = authId;
+ }
+
+ check(model: Readonly): boolean {
+ // Constraints for running this command include:
+ // - The Operator must have locked STX on behalf of at least one stacker.
+ // - The total amount previously locked by the Operator on behalf of the
+ // stackers has to be greater than the uSTX threshold.
+
+ const operator = model.stackers.get(this.operator.stxAddress)!;
+ return (
+ hasLockedStackers(operator) &&
+ isATCAboveThreshold(operator, model)
+ );
+ }
+
+ run(model: Stub, real: Real): void {
+ model.trackCommandRun(this.constructor.name);
+ const currentRewCycle = currentCycle(real.network);
+ const operatorWallet = model.stackers.get(this.operator.stxAddress)!;
+ const committedAmount = operatorWallet.amountToCommit;
+
+ const signerSig = this.operator.stackingClient.signPoxSignature({
+ // The signer key being authorized.
+ signerPrivateKey: this.operator.signerPrvKey,
+ // The reward cycle for which the authorization is valid.
+ // For stack-stx and stack-extend, this refers to the reward cycle
+ // where the transaction is confirmed. For stack-aggregation-commit,
+ // this refers to the reward cycle argument in that function.
+ rewardCycle: currentRewCycle + 1,
+ // For stack-stx, this refers to lock-period. For stack-extend,
+ // this refers to extend-count. For stack-aggregation-commit, this is
+ // u1.
+ period: 1,
+ // A string representing the function where this authorization is valid.
+ // Either stack-stx, stack-extend, stack-increase or agg-commit.
+ topic: Pox4SignatureTopic.AggregateCommit,
+ // The PoX address that can be used with this signer key.
+ poxAddress: this.operator.btcAddress,
+ // The unique auth-id for this authorization.
+ authId: this.authId,
+ // The maximum amount of uSTX that can be used (per tx) with this signer
+ // key.
+ maxAmount: committedAmount,
+ });
+
+ // Act
+ const stackAggregationCommit = real.network.callPublicFn(
+ "ST000000000000000000002AMW42H.pox-4",
+ "stack-aggregation-commit",
+ [
+ // (pox-addr (tuple (version (buff 1)) (hashbytes (buff 32))))
+ poxAddressToTuple(this.operator.btcAddress),
+ // (reward-cycle uint)
+ Cl.uint(currentRewCycle + 1),
+ // (signer-sig (optional (buff 65)))
+ Cl.some(bufferFromHex(signerSig)),
+ // (signer-key (buff 33))
+ Cl.bufferFromHex(this.operator.signerPubKey),
+ // (max-amount uint)
+ Cl.uint(committedAmount),
+ // (auth-id uint)
+ Cl.uint(this.authId),
+ ],
+ this.operator.stxAddress,
+ );
+
+ // Assert
+ expect(stackAggregationCommit.result).toBeOk(Cl.bool(true));
+
+ operatorWallet.amountToCommit -= committedAmount;
+ operatorWallet.committedRewCycleIndexes.push(model.nextRewardSetIndex);
+ model.nextRewardSetIndex++;
+
+ // Log to console for debugging purposes. This is not necessary for the
+ // test to pass but it is useful for debugging and eyeballing the test.
+ logCommand(
+ `â‚¿ ${model.burnBlockHeight}`,
+ `✓ ${this.operator.label}`,
+ "stack-agg-commit",
+ "amount committed",
+ committedAmount.toString(),
+ "signature",
+ );
+
+ // Refresh the model's state if the network gets to the next reward cycle.
+ model.refreshStateForNextRewardCycle(real);
+ }
+
+ toString() {
+ // fast-check will call toString() in case of errors, e.g. property failed.
+ // It will then make a minimal counterexample, a process called 'shrinking'
+ // https://github.com/dubzzz/fast-check/issues/2864#issuecomment-1098002642
+ return `${this.operator.label} stack-aggregation-commit auth-id ${this.authId}`;
+ }
+}
diff --git a/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitSigCommand_Err.ts b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitSigCommand_Err.ts
new file mode 100644
index 00000000000..1238a4f32b9
--- /dev/null
+++ b/contrib/boot-contracts-stateful-prop-tests/tests/pox-4/pox_StackAggregationCommitSigCommand_Err.ts
@@ -0,0 +1,122 @@
+import {
+ logCommand,
+ PoxCommand,
+ Real,
+ Stub,
+ Wallet,
+} from "./pox_CommandModel.ts";
+import { Pox4SignatureTopic, poxAddressToTuple } from "@stacks/stacking";
+import { expect } from "vitest";
+import { Cl } from "@stacks/transactions";
+import { bufferFromHex } from "@stacks/transactions/dist/cl";
+import { currentCycle } from "./pox_Commands.ts";
+
+type CheckFunc = (
+ this: StackAggregationCommitSigCommand_Err,
+ model: Readonly,
+) => boolean;
+
+export class StackAggregationCommitSigCommand_Err implements PoxCommand {
+ readonly operator: Wallet;
+ readonly authId: number;
+ readonly checkFunc: CheckFunc;
+ readonly errorCode: number;
+
+ /**
+ * Constructs a `StackAggregationCommitAuthCommand_Err` to commit partially
+ * locked uSTX.
+ *
+ * @param operator - Represents the `Operator`'s wallet.
+ * @param authId - Unique `auth-id` for the authorization.
+ * @param checkFunc - A function to check constraints for running this command.
+ * @param errorCode - The expected error code when running this command.
+ */
+ constructor(
+ operator: Wallet,
+ authId: number,
+ checkFunc: CheckFunc,
+ errorCode: number,
+ ) {
+ this.operator = operator;
+ this.authId = authId;
+ this.checkFunc = checkFunc;
+ this.errorCode = errorCode;
+ }
+
+ check = (model: Readonly