PlutusTx.Data.List & PlutusTx.BuiltinList - Feature Parity #7055

zeme-wana · 2025-04-22T16:44:16Z

Expand the BuiltinList API, bringing near feature parity between PlutusTx.Data.List and PlutusTx.BuiltinList.
Add 1 test case for each new API function
Add mayMaybe function to PlutusTx.List
Add new "PT23", "PT24", "PT25" error codes

Unisay · 2025-05-27T14:46:22Z

plutus-tx-plugin/test/BuiltinList/Budget/Spec.hs

 import PlutusTx.Code (CompiledCode, unsafeApplyCode)
 import PlutusTx.Lift (liftCodeDef)
+import PlutusTx.Prelude qualified as P
 import PlutusTx.Test (goldenBundle)


please avoid wildcard imports except for the Prelude ones.

effectfully · 2025-05-27T22:21:10Z

plutus-tx-plugin/test/BuiltinList/Budget/9.6/(++).eval.golden

Not asking to change this, but you're really brave introducing that symbolic name haha.

effectfully · 2025-05-27T22:50:47Z

plutus-tx/src/PlutusTx/BuiltinList.hs

+
+-- | Plutus Tx version of 'Data.List.zip' for 'BuiltinList'.
+_zip
+  :: forall a b. (MkNil a, MkNil b)


You need to make it MkNil (BuiltinPair a b), right?

I thought this was implied by

instance (MkNil a, MkNil b) => MkNil (BuiltinPair a b)

effectfully · 2025-05-27T22:51:30Z

plutus-tx/src/PlutusTx/BuiltinList.hs

+  -> BuiltinPair (BuiltinList a) (BuiltinList b)
+_unzip = caseList' emptyPair
+  ( \p l -> do
+      let BI.BuiltinPair (x, y) = p


Yeah, this isn't gonna work, you can't match on BuiltinPair in Plinth.

effectfully · 2025-05-27T22:54:07Z

plutus-tx/src/PlutusTx/BuiltinList.hs

+
+-- | Plutus Tx version of 'Data.List.splitAt' for 'BuiltinList'.
+_splitAt
+  :: forall a. (MkNil a)


It would have to be MkPair (BuiltinList a) (BuiltinList a), but we don't have MkPair at all and so this function is hopeless right now, we can't define it without a MkPair type class or a mkPair builtin.

plutus-tx/src/PlutusTx/BuiltinList.hs

effectfully · 2025-05-27T22:57:33Z

plutus-tx/src/PlutusTx/BuiltinList.hs

+{-# INLINABLE replicate #-}
+
+-- | Plutus Tx version of 'Data.List.partition' for 'BuiltinList'.
+_partition


Also hopeless without MkPair.

effectfully · 2025-05-27T23:00:27Z

plutus-tx/src/PlutusTx/BuiltinList.hs

+
+-- | Plutus Tx version of 'Data.List.sortBy' for 'BuiltinList'.
+_sortBy :: MkNil a => (a -> a -> Ordering) -> BuiltinList a -> BuiltinList a
+_sortBy cmp = mergeAll . sequences


It looks like for this one you can perform the same trick of reusing the empty list as with dropWhile to get rid of the MkNil constraint.

Not quite unfortunately... It doesn't typecheck, and we need the call to singleton anyway, which requires MkNil

effectfully · 2025-05-27T23:08:02Z

plutus-tx/src/PlutusTx/Builtins/HasOpaque.hs

+-- They require changes to PlutusTx.Compiler.Expr.compileExpr
+-- See https://github.com/IntersectMBO/plutus-private/issues/1604
+instance (MkNil a) => MkNil (BuiltinList a)
+instance (MkNil a, MkNil b) => MkNil (BuiltinPair a b)


Can we remove them if they aren't gonna work anyway? If that requires removing broken code as well, I'm OK with that.

@zliu41 what do you think?

We can't remove them otherwise lots of the functions in BuiltinList.hs won't typecheck, they require the MkNil a constraint.

Remove those functions then too, they're broken anyway. Note that if you address the other comments such as introducing MkNil (BuiltinPair a b) constraints, fewer of the functions will remain broken.

effectfully · 2025-05-27T23:09:02Z

plutus-tx/src/PlutusTx/ErrorCodes.hs

+  , ("PT21", "PlutusTx.BuiltinList.!!: negative index")
+  , ("PT22", "PlutusTx.BuiltinList.!!: index too large")
+  , ("PT23", "PlutusTx.BuiltinList.head: empty list")
+  , ("PT24", "PlutusTx.BuiltinList.tail: empty list")
+  , ("PT25", "PlutusTx.BuiltinList.last: empty list")


Maybe we don't need to, but it looks helpful, doesn't cost us much in terms of maintenance and it's already done. So I think let's keep them.

Co-authored-by: effectfully <[email protected]>

plutus-tx/src/PlutusTx/BuiltinList.hs

Unisay · 2025-05-28T13:36:13Z

plutus-tx/src/PlutusTx/BuiltinList.hs

Please reformat all file with fourmolu making sure that proper fourmolu.yaml config is applied. I tried to format the file and there were a lot of changes (like 50% of it).
And other new files too.

plutus-tx-plugin/test/BuiltinList/Budget/Spec.hs

Unisay

Looks good, a few concerns remain:

fourmolu
dead code.

Co-authored-by: Yura <[email protected]>

Unisay · 2025-05-29T12:49:46Z

plutus-tx-plugin/test/BuiltinList/Budget/9.6/indexNegative.pir.golden

+  let
+    !x : Unit = trace {Unit} "PT21" Unit
+  in
+  error {integer}


What an optimisation!

However, you might want to switch optimisations off, as they go too far reducing this test to the form where its not testing what you want in runtime, instead eliminating the whole problem (test setup) in compile time.

Unisay · 2025-05-29T12:51:38Z

plutus-tx-plugin/test/BuiltinList/Budget/9.6/indexNegative.uplc.golden

Same here: the aspect you're trying to test (how are negative indexes handled) got optimised away.

Unisay · 2025-05-29T12:52:46Z

plutus-tx-plugin/test/BuiltinList/Budget/9.6/indexTooLarge.pir.golden

+         !x : Unit = trace {Unit} "PT22" Unit
+       in
+       error {Unit -> integer})


Looks like error here is unconditional too...

Unisay · 2025-05-29T12:54:40Z

plutus-tx-plugin/test/BuiltinList/Budget/9.6/indexTooLarge.uplc.golden

+           (constr 0 [])
+           (constr 0 []))
+        (force dropList 10 xs)))


ifThenElse got eliminated...

zeme-wana temporarily deployed to github-pages April 22, 2025 16:44 — with GitHub Actions Inactive

zeme-wana force-pushed the list-api branch from cd26347 to 0af2db6 Compare May 12, 2025 09:43

zeme-wana temporarily deployed to github-pages May 12, 2025 09:43 — with GitHub Actions Inactive

zeme-wana force-pushed the list-api branch from 0af2db6 to a032835 Compare May 20, 2025 12:37

zeme-wana temporarily deployed to github-pages May 20, 2025 12:38 — with GitHub Actions Inactive

zeme-wana temporarily deployed to github-pages May 20, 2025 12:42 — with GitHub Actions Inactive

zeme-wana temporarily deployed to github-pages May 21, 2025 10:03 — with GitHub Actions Inactive

zeme-wana temporarily deployed to github-pages May 21, 2025 10:52 — with GitHub Actions Inactive

zeme-wana temporarily deployed to github-pages May 21, 2025 13:05 — with GitHub Actions Inactive

zeme-wana force-pushed the list-api branch from 44c64ae to db76c16 Compare May 22, 2025 12:51

zeme-wana temporarily deployed to github-pages May 22, 2025 12:51 — with GitHub Actions Inactive

zeme-wana temporarily deployed to github-pages May 22, 2025 12:58 — with GitHub Actions Inactive

zeme-wana requested a review from a team May 22, 2025 13:12

zeme-wana added 12 commits May 26, 2025 16:53

PlutusTx.Data.List & PlutusTx.BuiltinList - Feature Parity

b2a8ebc

wip

c4a0cc6

wip

efef2d2

wip

266026a

wip

bf89cd9

wip

7cc06cb

wip

eb452fd

wip

4e938f4

wip

51d349d

wip

33617a9

wip

5a2b342

donw

8b12c98

zeme-wana force-pushed the list-api branch from acb4710 to 8b12c98 Compare May 26, 2025 15:09

zeme-wana temporarily deployed to github-pages May 26, 2025 15:10 — with GitHub Actions Inactive

wip

25a5c91

zeme-wana temporarily deployed to github-pages May 27, 2025 08:07 — with GitHub Actions Inactive

zeme-wana marked this pull request as ready for review May 27, 2025 08:12

Merge branch 'master' into list-api

43acb29

zeme-wana temporarily deployed to github-pages May 27, 2025 11:52 — with GitHub Actions Inactive

wip

3e3e2fc

zeme-wana temporarily deployed to github-pages May 27, 2025 12:35 — with GitHub Actions Inactive

Unisay reviewed May 27, 2025

View reviewed changes

effectfully approved these changes May 27, 2025

View reviewed changes

Update plutus-tx/src/PlutusTx/BuiltinList.hs

4809d1b

Co-authored-by: effectfully <[email protected]>

zeme-wana temporarily deployed to github-pages May 28, 2025 10:15 — with GitHub Actions Inactive

done

3e75024

zeme-wana temporarily deployed to github-pages May 28, 2025 10:56 — with GitHub Actions Inactive

wip

72c30ee

zeme-wana temporarily deployed to github-pages May 28, 2025 13:28 — with GitHub Actions Inactive

Unisay reviewed May 28, 2025

View reviewed changes

plutus-tx/src/PlutusTx/BuiltinList.hs Outdated Show resolved Hide resolved

Unisay reviewed May 28, 2025

View reviewed changes

plutus-tx/src/PlutusTx/BuiltinList.hs Outdated Show resolved Hide resolved

Unisay reviewed May 28, 2025

View reviewed changes

plutus-tx-plugin/test/BuiltinList/Budget/Spec.hs Outdated Show resolved Hide resolved

Unisay requested changes May 28, 2025

View reviewed changes

Update plutus-tx/src/PlutusTx/BuiltinList.hs

b686a05

Co-authored-by: Yura <[email protected]>

zeme-wana temporarily deployed to github-pages May 28, 2025 14:03 — with GitHub Actions Inactive

Removed dead code and appiled fourmolu

eff07e6

zeme-wana temporarily deployed to github-pages May 28, 2025 14:55 — with GitHub Actions Inactive

done

090d021

zeme-wana temporarily deployed to github-pages May 28, 2025 15:05 — with GitHub Actions Inactive

wip

037c27b

zeme-wana temporarily deployed to github-pages May 28, 2025 16:40 — with GitHub Actions Inactive

zeme-wana requested a review from Unisay May 29, 2025 10:35

Unisay reviewed May 29, 2025

View reviewed changes

PlutusTx.Data.List & PlutusTx.BuiltinList - Feature Parity #7055

Are you sure you want to change the base?

PlutusTx.Data.List & PlutusTx.BuiltinList - Feature Parity #7055

Uh oh!

Conversation

zeme-wana commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Unisay left a comment

Choose a reason for hiding this comment

Uh oh!

Unisay May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zeme-wana commented Apr 22, 2025 •

edited

Loading

Unisay May 29, 2025 •

edited

Loading