Select contracts implementing the correct trait from the Clarinet project for argument generation #88

BowTiedRadone · 2025-01-13T21:59:16Z

This PR adds support for arbitrary selection of trait reference parameters. The new logic for handling trait implementations in trait reference parameters is as follows:

If a trait reference parameter is found in public functions or invariants during invariant testing, or in test functions during property testing, Rendezvous will scan the user's Clarinet project for a contract that implements the referenced trait.
If trait implementations are found for that specific trait reference, they will be added to a selection pool. Rendezvous uses fast-check to randomly select one of them for each run, ensuring seed-based randomness.

To test contracts with trait reference parameters, users must select at least one trait implementation for the referenced trait and add it to their Clarinet project, either as a direct contract or a project requirement.

This PR resolves #65.

moodmosaic

Interesting work on the draft implementation so far! Left some comments.

The next steps I see are:

Create (perhaps parameterized?) test(s) based on the draft/example in property.ts.
Add as many more test cases as possible to expand coverage.
Tweak the draft implementation to ensure all tests pass.
(Once tests provide decent coverage, we'll consider refactoring with a
parsec-style library.)

citizen.tests.ts

property.ts

shared.types.ts

moodmosaic

Left questions and comments at the abstraction level. Let's make sure we get those right before proceeding.

ast1737030528990.json

example/contracts/trait.clar

property.ts

invariant.ts

property.ts

traits.tests.ts

This commit moves the trait test inputs from the fixtures floder directly to `traits.tests.ts` in a `testInputs` object. This is done to make it easier to navigate the test inputs and to make it easier to add new test inputs in the future.

invariant.ts

property.ts

shared.ts

traits.ts

moodmosaic

This is massive 🥇 After refactoring simnet and coming up with candidate alternatives for "enrich" this should be ready for review.

example/contracts/trait.clar

ast1737030528990.json

example/Clarinet.toml

example/contracts/trait.tests.clar

invariant.ts

traits.tests.ts

traits.ts

This commit adds a utility function called `extractProjectTraitImplementations`. It creates a pre-defined record that maps all the contracts in the simnet instance to their implemented traits. With this change, Rendezvous no longer needs to iterate through all contracts during argument generation. Instead, the pre-defined record is passed to all utilities that return arbitraries.

This commit restricts EnrichedContractInterfaceFunction type alias usage to relevant methods and adds a JSDoc comment to the definition.

This commit refines the `traits` file by adding suggestive comments and fixing types.

This commit addresses #88 (comment).

BowTiedRadone · 2025-01-23T22:49:40Z

Gigantic cleaning session happened here. At least a couple things to decide on before merging:

Which contract that imports traits should be added to the example folder? It could be a handmade contract, but it should showcase the functionality clearly.
Which contract that implements traits do we want to use? This can either be a handmade contract added to the project or specified as a requirement.

Ideally, we should have two trait implementations for the same trait, so Rendezvous can randomly pick one of them for any trait reference parameter.

The bug was introduced in ae0d20c. This commit fixes it.

moodmosaic · 2025-01-24T07:15:33Z

Which contract that imports traits should be added to the example folder? It could be a handmade contract, but it should showcase the functionality clearly.

Any contract that shows a real-world use case and stays under 100 lines.

Which contract that implements traits do we want to use? This can either be a handmade contract added to the project or specified as a requirement.

I'd say both: a local handmade one and one added as a requirement.

moodmosaic

This is a massive and tricky-to-implement PR. It's been carefully crafted, and I want to leave an approval noting that it's one of the most well-crafted PRs (of this size) I've reviewed in over a decade.

I've left a few comments, but they aren't blockers. It would be nice to address them, but we could merge and handle those separately if needed.

One thing to consider for this PR is whether to keep the full commit history or squash it into a single commit. Keeping the history preserves individual commit context, which can be helpful for debugging and provides a detailed timeline of changes. On the other hand, it can make the history noisier with too many intermediate commits.

Squashing into a single commit results in a cleaner, more concise history, making it easier to track high-level changes. It also simplifies git revert if we need to roll back due to blockers, which is especially useful since we're still < v1 and can afford breaking changes. However, squashing does lose the detailed commit trail, which can sometimes be useful for debugging.

As Linus Torvalds put it: "I want clean history, but that really means (a) clean and (b) history." (Source: https://www.mail-archive.com/[email protected]/msg39091.html)

citizen.tests.ts

citizen.ts

.../.cache/requirements/SP4SZE494VC2YC5JYG7AYFQ44F5Q4PYV7DVMDPBG.sip-010-trait-ft-standard.clar

example/contracts/trait.clar

invariant.ts

moodmosaic · 2025-01-24T07:35:47Z

shared.types.ts

+
+/**
+ * The type of the function interface, after the contract interface is
+ * "enriched" with additional information about trait references.


I’ve thought about this and can’t find a better name. Enriched seems fine in this PR.

Why don't we expand the comment to help readers and contributors:

I would explain what a contract interface looks like, how the enriched version differs, and why. Use something similar to the comments in enrichInterfaceWithTraitData.

We could also point to tests like:
correctly enriches interface with trait reference data for a direct trait that is the first parameter.

I'd keep it simple and focused on readability for future maintainers or anyone continuing the project after us.

traits.types.ts

traits.ts

traits.tests.ts

This commit adds the following to the example project: - `ft-transfer-many`: A contract that imports a trait and references it in a function parameter. - `rendezvous-token`: A contract that implements the referenced trait. Additionally, it includes an invariant and a property test for the ft-transfer-many contract to demonstrate the random selection of trait implementations in action.

moodmosaic · 2025-01-24T22:27:26Z

example/Clarinet.toml

+[contracts.rendezvous-token]
+path = 'contracts/rendezvous-token.clar'
+clarity_version = 2
+epoch = 2.5


To make it easier for future contributors, could we add a comment here explaining why this contract has epoch 2.5?

moodmosaic · 2025-01-24T22:27:50Z

example/Clarinet.toml

-[contracts.trait]
-path = 'contracts/trait.clar'
+[contracts.ft-transfer-many]
+path = 'contracts/ft-transfer-many.clar'


Some paths in this file use double quotes and some others use single quotes. Let's stick with one?

moodmosaic · 2025-01-24T22:31:36Z