Expose property-based testing helpers as public API#249
Open
BowTiedRadone wants to merge 1 commit intomasterfrom
Open
Expose property-based testing helpers as public API#249BowTiedRadone wants to merge 1 commit intomasterfrom
BowTiedRadone wants to merge 1 commit intomasterfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarity smart contracts benefit from property-based testing, but setting up
fast-checkarbitraries that produce valid Clarity values for every parameter type (uint, principal, buffers, lists, tuples, optionals, responses, trait references) is tedious and error-prone. Rendezvous already solves this internally; this PR exposes that capability as a library API so the community can use it off-the-shelf.Two new exports:
getContractFunction(simnet, contract, fn, deployer?): extracts a function interface from a deployed contract, enriched with trait datagenerateArgs(fn, simnet)— returnsfc.Arbitrary<ClarityValue[]>, handling all Clarity types including recursive structures (list of tuples, optional of response, etc.) and trait reference resolutionThe package now works as both a CLI (
npx rv) and a library (import { generateArgs } from "@stacks/rendezvous"). TypeScript declarations are included.Fixes #168.