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

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

This PR is still a draft. Related issue: #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

moodmosaic · 2025-01-20T21:22:46Z

invariant.ts

+                ...functionToArbitrary(
+                  r.selectedFunction,
+                  simnetAddresses,
+                  simnet


Do we need multiple stuff from the simnet object? Or just one?

Currently we need to get any project contract's AST.

Couldn't we pass just that function then from the simnet? E.g. pass simnet.getContractAST as a delegate.

moodmosaic · 2025-01-20T21:22:55Z

invariant.ts

+                ...functionToArbitrary(
+                  r.selectedInvariant,
+                  simnetAddresses,
+                  simnet


Do we need multiple stuff from the simnet object? Or just one?

Currently, matching traits are selected during argument generation. This approach is WIP and inefficient, but it works for now. Ideally, once all trait reference nesting types are handled, we’ll pre-populate a map that links stringified trait data to the contracts implementing it. This will eliminate the need to pass simnet, but the pre-populated map.

Couldn't we pass just that function then from the simnet? E.g. pass simnet.getContractAST as a delegate.

Passing a data structure (than a bag of functions) would be the most efficient way, agreed.

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.

moodmosaic · 2025-01-21T16:42:03Z

invariant.ts

+                ...functionToArbitrary(
+                  r.selectedFunction,
+                  simnetAddresses,
+                  simnet


Couldn't we pass just that function then from the simnet? E.g. pass simnet.getContractAST as a delegate.

moodmosaic · 2025-01-21T16:48:12Z

invariant.ts

+                ...functionToArbitrary(
+                  r.selectedInvariant,
+                  simnetAddresses,
+                  simnet


Couldn't we pass just that function then from the simnet? E.g. pass simnet.getContractAST as a delegate.

property.ts

moodmosaic · 2025-01-21T16:51:48Z

property.ts

+                ...functionToArbitrary(
+                  r.selectedTestFunction,
+                  simnetAddresses,
+                  simnet


Same comment about passing something more specific from the simnet here instead of the whole instance.

moodmosaic · 2025-01-21T16:52:36Z

shared.ts

@@ -1,12 +1,14 @@
 import fc from "fast-check";
 import {
-  BaseType,
+  BaseTypeAfterEnrich,


Could be at least EnrichedType? or EnrichedBaseType? In case we go with "enriched".

moodmosaic · 2025-01-21T16:53:09Z

shared.ts

@@ -54,20 +58,25 @@ export const getFunctionsFromContractInterfaces = (
  );

 export const getFunctionsListForContract = (
-  functionsMap: Map<string, ContractInterfaceFunction[]>,
+  functionsMap: Map<string, any[]>,


Shouldn't any be EnrichedXyz?

traits.ts

moodmosaic · 2025-01-21T16:54:51Z

traits.ts

+  ast: IContractAST,
+  functionName: string,
+  paramPath: string[]
+): [string, any] | [undefined, undefined] => {


Is it documented?

moodmosaic

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

moodmosaic · 2025-01-21T22:01:33Z

example/contracts/trait.clar

@@ -0,0 +1,3 @@
+(define-public (function)


This contract is named trait but has just a function in it?

ast1737030528990.json

moodmosaic · 2025-01-22T04:33:20Z

example/Clarinet.toml

@@ -3,6 +3,9 @@ name = "example"
 telemetry = false
 cache_dir = "./.cache"

+[[project.requirements]]
+contract_id = 'SP4SZE494VC2YC5JYG7AYFQ44F5Q4PYV7DVMDPBG.ststx-token'


I take it that adding this as requirement adds also dao and sip-010-trait-ft-standard, right?

moodmosaic · 2025-01-22T04:34:23Z

example/contracts/trait.tests.clar

@@ -0,0 +1,9 @@
+(use-trait ft-trait 'SP4SZE494VC2YC5JYG7AYFQ44F5Q4PYV7DVMDPBG.sip-010-trait-ft-standard.sip-010-trait)


If we use this trait in the examples, why do we require ststx-token after all?

moodmosaic · 2025-01-22T04:37:10Z

invariant.ts

+                ...functionToArbitrary(
+                  r.selectedInvariant,
+                  simnetAddresses,
+                  simnet


Passing a data structure (than a bag of functions) would be the most efficient way, agreed.

moodmosaic · 2025-01-22T04:52:14Z

traits.tests.ts

+
+  it("correctly enriches interface with trait reference data for a direct trait that is the first parameter", () => {
+    // Arrange
+    const targetContractId = "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.trait";


Same here. This could be moved just before the expected.

moodmosaic · 2025-01-22T04:52:31Z

traits.tests.ts

+
+  it("correctly enriches interface with trait reference data for a direct trait that is the second parameter", () => {
+    // Arrange
+    const targetContractId = "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.trait";


moodmosaic · 2025-01-22T04:52:50Z

traits.tests.ts

+
+  it("correctly enriches interface with trait reference data for a direct trait that is the fifth parameter", () => {
+    // Arrange
+    const targetContractId = "ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.trait";


Same here and for the rest of the occurrences.

moodmosaic · 2025-01-22T04:55:12Z

traits.tests.ts

+                                      "ft-trait",
+                                      {
+                                        Imported: {
+                                          n


Made it to the end 🏁 As discussed, I think this is still way better than searching through pesky text files (and also relying on filesystem to do its thing during CI). Happy to see this 🎉

moodmosaic · 2025-01-22T04:56:13Z

traits.ts

+  functionInterfaceList: ContractInterfaceFunction[],
+  targetContractId: string
+): Map<string, EnrichedContractInterfaceFunction[]> => {
+  const enriched = new Map<string, EnrichedContractInterfaceFunction[]>();


At this point I feel so enriched. 🌟

Add contract referencing a trait to the example

c7871e0

moodmosaic reviewed Jan 16, 2025

View reviewed changes

citizen.tests.ts Outdated Show resolved Hide resolved

property.ts Outdated Show resolved Hide resolved

property.ts Outdated Show resolved Hide resolved

shared.types.ts Show resolved Hide resolved

shared.types.ts Outdated Show resolved Hide resolved

BowTiedRadone force-pushed the feat/project-trait-selection branch from fbbb156 to 74a086b Compare January 17, 2025 21:47

moodmosaic reviewed Jan 20, 2025

View reviewed changes

ast1737030528990.json Outdated Show resolved Hide resolved

example/contracts/trait.clar Outdated Show resolved Hide resolved

property.ts Show resolved Hide resolved

property.ts Outdated Show resolved Hide resolved

BowTiedRadone force-pushed the feat/project-trait-selection branch from 74a086b to e92b62a Compare January 20, 2025 18:16

WIP: Add support for direct and tuple-nested traits in property testing

ae0d20c

BowTiedRadone force-pushed the feat/project-trait-selection branch from e92b62a to ae0d20c Compare January 20, 2025 21:25

moodmosaic reviewed Jan 20, 2025

View reviewed changes

BowTiedRadone added 5 commits January 20, 2025 23:59

Add test for list-nested traits

a10e0a5

Add support for list-nested trait references

47a4da4

Remove comments and no longer used imports in property

3e8743c

Add support for response-nested trait references

c189840

BowTiedRadone force-pushed the feat/project-trait-selection branch from c65fc8a to c189840 Compare January 21, 2025 14:13

Add support for optional nested trait references

1d76720

BowTiedRadone force-pushed the feat/project-trait-selection branch from 85dce3b to 1d76720 Compare January 21, 2025 14:26

Stick to general actual and expected in trait tests

bef6767

BowTiedRadone force-pushed the feat/project-trait-selection branch from 2b837d9 to bef6767 Compare January 21, 2025 14:35

moodmosaic reviewed Jan 21, 2025

View reviewed changes

Add support for trait references in invariant testing

47a425b

moodmosaic reviewed Jan 22, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

BowTiedRadone commented Jan 13, 2025

moodmosaic left a comment

moodmosaic left a comment

moodmosaic Jan 20, 2025

BowTiedRadone Jan 21, 2025

moodmosaic Jan 21, 2025

moodmosaic Jan 20, 2025

BowTiedRadone Jan 21, 2025

moodmosaic Jan 21, 2025

moodmosaic Jan 22, 2025

moodmosaic Jan 21, 2025

moodmosaic Jan 21, 2025

moodmosaic Jan 21, 2025

moodmosaic Jan 21, 2025

moodmosaic Jan 21, 2025

moodmosaic Jan 21, 2025

moodmosaic left a comment

moodmosaic Jan 21, 2025

moodmosaic Jan 22, 2025

moodmosaic Jan 22, 2025

moodmosaic Jan 22, 2025

moodmosaic Jan 22, 2025

moodmosaic Jan 22, 2025

moodmosaic Jan 22, 2025

moodmosaic Jan 22, 2025

moodmosaic Jan 22, 2025

		@@ -0,0 +1,9 @@
		(use-trait ft-trait 'SP4SZE494VC2YC5JYG7AYFQ44F5Q4PYV7DVMDPBG.sip-010-trait-ft-standard.sip-010-trait)

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

Are you sure you want to change the base?

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

Conversation

BowTiedRadone commented Jan 13, 2025

moodmosaic left a comment

Choose a reason for hiding this comment

moodmosaic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moodmosaic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment