s/lengthArray/lengthOfArray/ (#6853)

* s/lengthArray/lengthOfArray/ * Update plutus-core/cost-model/create-cost-model/BuiltinMemoryModels.hs * Update plutus-core/cost-model/create-cost-model/CreateBuiltinCostModel.hs * Update plutus-core/cost-model/create-cost-model/CreateBuiltinCostModel.hs * Update plutus-core/plutus-core/src/PlutusCore/Default/Builtins.hs * Update plutus-core/plutus-core/src/PlutusCore/Evaluation/Machine/ExBudgetingDefaults.hs * Update plutus-core/plutus-ir/src/PlutusIR/Transform/RewriteRules/CommuteFnWithConst.hs --------- Co-authored-by: Kenneth MacKenzie <[email protected]>
IntersectMBO · Feb 17, 2025 · 3242b1b · 3242b1b
1 parent 566a319
commit 3242b1b
Show file tree

Hide file tree

Showing 22 changed files with 43 additions and 43 deletions.
diff --git a/plutus-core/changelog.d/20250207_120412_Yuriy.Lazaryev_cip_0138_builtin_array.md b/plutus-core/changelog.d/20250207_120412_Yuriy.Lazaryev_cip_0138_builtin_array.md
@@ -4,4 +4,4 @@
 - Three functions for working with `BuiltinArray` values:
   - `listToArray` (converts a list to a `BuiltinArray`)
   - `indexArray` (returns an element of a `BuiltinArray` by index)
-  - `lengthArray` (returns the length of a `BuiltinArray`)
+  - `lengthOfArray` (returns the length of a `BuiltinArray`)
diff --git a/plutus-core/cost-model/create-cost-model/BuiltinMemoryModels.hs b/plutus-core/cost-model/create-cost-model/BuiltinMemoryModels.hs
@@ -110,7 +110,7 @@ builtinMemoryModels = BuiltinCostModelBase
   , paramHeadList                        = Id $ ModelOneArgumentConstantCost    32
   , paramTailList                        = Id $ ModelOneArgumentConstantCost    32
   , paramNullList                        = Id $ ModelOneArgumentConstantCost    32
-  , paramLengthArray                     = Id $ ModelOneArgumentConstantCost    99
+  , paramLengthOfArray                   = Id $ ModelOneArgumentConstantCost    99
   , paramListToArray                     = Id $ ModelOneArgumentConstantCost    99
   , paramIndexArray                      = Id $ ModelTwoArgumentsConstantCost   99
   , paramChooseData                      = Id $ ModelSixArgumentsConstantCost   32

diff --git a/plutus-core/cost-model/create-cost-model/CreateBuiltinCostModel.hs b/plutus-core/cost-model/create-cost-model/CreateBuiltinCostModel.hs
@@ -76,7 +76,7 @@ builtinCostModelNames = BuiltinCostModelBase
   , paramTailList                        = "tailListModel"
   , paramNullList                        = "nullListModel"
   , paramDropList                        = "dropListModel"
-  , paramLengthArray                     = "lengthArrayModel"
+  , paramLengthOfArray                   = "lengthOfArrayModel"
   , paramListToArray                     = "listToArrayModel"
   , paramIndexArray                      = "indexArrayModel"
   , paramChooseData                      = "chooseDataModel"
@@ -214,7 +214,7 @@ createBuiltinCostModel bmfile rfile = do
   paramTailList                        <- getParams readCF1 paramTailList
   paramNullList                        <- getParams readCF1 paramNullList
   -- Arrays
-  paramLengthArray                     <- getParams readCF1 paramLengthArray
+  paramLengthOfArray                   <- getParams readCF1 paramLengthOfArray
   paramListToArray                     <- getParams readCF1 paramListToArray
   paramIndexArray                      <- getParams readCF2 paramIndexArray
   -- Data

diff --git a/plutus-core/cost-model/data/builtinCostModelA.json b/plutus-core/cost-model/data/builtinCostModelA.json
@@ -698,7 +698,7 @@
             "type": "constant_cost"
         }
     },
-    "lengthArray" : {
+    "lengthOfArray" : {
         "cpu": {
             "arguments": 99999999999999,
             "type": "constant_cost"

diff --git a/plutus-core/cost-model/data/builtinCostModelB.json b/plutus-core/cost-model/data/builtinCostModelB.json
@@ -698,7 +698,7 @@
             "type": "constant_cost"
         }
     },
-    "lengthArray" : {
+    "lengthOfArray" : {
         "cpu": {
             "arguments": 99999999999999,
             "type": "constant_cost"

diff --git a/plutus-core/cost-model/data/builtinCostModelC.json b/plutus-core/cost-model/data/builtinCostModelC.json
@@ -707,7 +707,7 @@
             "type": "constant_cost"
         }
     },
-    "lengthArray" : {
+    "lengthOfArray" : {
         "cpu": {
             "arguments": 99999999999999,
             "type": "constant_cost"

diff --git a/plutus-core/plutus-core/src/PlutusCore/Default/Builtins.hs b/plutus-core/plutus-core/src/PlutusCore/Default/Builtins.hs
@@ -184,7 +184,7 @@ data DefaultFun
     | CaseData
     | DropList
     -- Arrays
-    | LengthArray
+    | LengthOfArray
     | ListToArray
     | IndexArray
     deriving stock (Show, Eq, Ord, Enum, Bounded, Generic, Ix)
@@ -2078,14 +2078,14 @@ instance uni ~ DefaultUni => ToBuiltinMeaning uni DefaultFun where
             dropListDenotation
             (runCostingFunTwoArguments . paramDropList)
 
-    toBuiltinMeaning _semvar LengthArray =
-      let lengthArrayDenotation :: SomeConstant uni (Vector a) -> BuiltinResult Int
-          lengthArrayDenotation (SomeConstant (Some (ValueOf uni vec))) =
+    toBuiltinMeaning _semvar LengthOfArray =
+      let lengthOfArrayDenotation :: SomeConstant uni (Vector a) -> BuiltinResult Int
+          lengthOfArrayDenotation (SomeConstant (Some (ValueOf uni vec))) =
             case uni of
               DefaultUniArray _uniA -> pure $ Vector.length vec
               _ -> throwing _StructuralUnliftingError "Expected an array but got something else"
-          {-# INLINE lengthArrayDenotation #-}
-        in makeBuiltinMeaning lengthArrayDenotation (runCostingFunOneArgument . unimplementedCostingFun)
+          {-# INLINE lengthOfArrayDenotation #-}
+        in makeBuiltinMeaning lengthOfArrayDenotation (runCostingFunOneArgument . unimplementedCostingFun)
 
     toBuiltinMeaning _semvar ListToArray =
       let listToArrayDenotation :: SomeConstant uni [a] -> BuiltinResult (Opaque val (Vector a))
@@ -2259,7 +2259,7 @@ instance Flat DefaultFun where
 
               DropList                        -> 90
 
-              LengthArray                     -> 91
+              LengthOfArray                   -> 91
               ListToArray                     -> 92
               IndexArray                      -> 93
 
@@ -2355,7 +2355,7 @@ instance Flat DefaultFun where
               go 88 = pure CaseList
               go 89 = pure CaseData
               go 90 = pure DropList
-              go 91 = pure LengthArray
+              go 91 = pure LengthOfArray
               go 92 = pure ListToArray
               go 93 = pure IndexArray
               go t  = fail $ "Failed to decode builtin tag, got: " ++ show t

diff --git a/plutus-core/plutus-core/src/PlutusCore/Evaluation/Machine/BuiltinCostModel.hs b/plutus-core/plutus-core/src/PlutusCore/Evaluation/Machine/BuiltinCostModel.hs
@@ -128,7 +128,7 @@ data BuiltinCostModelBase f =
     , paramTailList                        :: f ModelOneArgument
     , paramNullList                        :: f ModelOneArgument
     -- Arrays
-    , paramLengthArray                     :: f ModelOneArgument
+    , paramLengthOfArray                   :: f ModelOneArgument
     , paramListToArray                     :: f ModelOneArgument
     , paramIndexArray                      :: f ModelTwoArguments
     -- Data

diff --git a/plutus-core/plutus-core/src/PlutusCore/Evaluation/Machine/ExBudgetingDefaults.hs b/plutus-core/plutus-core/src/PlutusCore/Evaluation/Machine/ExBudgetingDefaults.hs
@@ -289,7 +289,7 @@ unitCostBuiltinCostModel = BuiltinCostModelBase
     , paramTailList                        = unitCostOneArgument
     , paramNullList                        = unitCostOneArgument
     -- Arrays
-    , paramLengthArray                     = unitCostOneArgument
+    , paramLengthOfArray                   = unitCostOneArgument
     , paramListToArray                     = unitCostOneArgument
     , paramIndexArray                      = unitCostTwoArguments
     -- Data

diff --git a/plutus-core/plutus-ir/src/PlutusIR/Transform/RewriteRules/CommuteFnWithConst.hs b/plutus-core/plutus-ir/src/PlutusIR/Transform/RewriteRules/CommuteFnWithConst.hs
@@ -114,7 +114,7 @@ isCommutative = \case
   HeadList                        -> False
   TailList                        -> False
   NullList                        -> False
-  LengthArray                     -> False
+  LengthOfArray                   -> False
   ListToArray                     -> False
   IndexArray                      -> False
   ChooseData                      -> False

diff --git a/plutus-core/untyped-plutus-core/test/Evaluation/Builtins/Definition.hs b/plutus-core/untyped-plutus-core/test/Evaluation/Builtins/Definition.hs
@@ -379,10 +379,10 @@ test_BuiltinArray =
       let term = apply () (tyInst () (builtin () ListToArray) integer) listOfInts
       typecheckEvaluateCekNoEmit def defaultBuiltinCostModelForTesting term @?=
           Right (EvaluationSuccess arrayOfInts)
-    , testCase "lengthArray" do
+    , testCase "lengthOfArray" do
       let arrayOfInts = mkConstant @(Vector Integer) @DefaultUni () (Vector.fromList [1..10])
       let expectedLength = mkConstant @Integer @DefaultUni () 10
-          term = apply () (tyInst () (builtin () LengthArray) integer) arrayOfInts
+          term = apply () (tyInst () (builtin () LengthOfArray) integer) arrayOfInts
       typecheckEvaluateCekNoEmit def defaultBuiltinCostModelForTesting term @?=
           Right (EvaluationSuccess expectedLength)
     , testCase "indexArray" do

diff --git a/plutus-ledger-api/CostModel/Data/Params/CostModelParams/costModelParamNames.txt.golden b/plutus-ledger-api/CostModel/Data/Params/CostModelParams/costModelParamNames.txt.golden
@@ -295,8 +295,8 @@ findFirstSetBit-memory-arguments
 ripemd_160-cpu-arguments-intercept
 ripemd_160-cpu-arguments-slope
 ripemd_160-memory-arguments
-lengthArray-cpu-arguments
-lengthArray-memory-arguments
+lengthOfArray-cpu-arguments
+lengthOfArray-memory-arguments
 listToArray-cpu-arguments
 listToArray-memory-arguments
 indexArray-cpu-arguments

diff --git a/plutus-ledger-api/src/PlutusLedgerApi/Common/Versions.hs b/plutus-ledger-api/src/PlutusLedgerApi/Common/Versions.hs
@@ -102,7 +102,7 @@ builtinsIntroducedIn = Map.fromList [
           MkPairData, MkNilData, MkNilPairData
           ]),
   ((PlutusV1, futurePV), Set.fromList [
-          ListToArray, IndexArray, LengthArray
+          ListToArray, IndexArray, LengthOfArray
           ]),
   ((PlutusV2, vasilPV), Set.fromList [
           SerialiseData
@@ -114,7 +114,7 @@ builtinsIntroducedIn = Map.fromList [
           IntegerToByteString, ByteStringToInteger
           ]),
   ((PlutusV2, futurePV), Set.fromList [
-          ListToArray, IndexArray, LengthArray
+          ListToArray, IndexArray, LengthOfArray
           ]),
   ((PlutusV3, changPV), Set.fromList [
           Bls12_381_G1_add, Bls12_381_G1_neg, Bls12_381_G1_scalarMul,
@@ -135,7 +135,7 @@ builtinsIntroducedIn = Map.fromList [
   ((PlutusV3, futurePV), Set.fromList [
           ExpModInteger,
           CaseList, CaseData, DropList,
-          ListToArray, IndexArray, LengthArray
+          ListToArray, IndexArray, LengthOfArray
           ])
   ]
 

diff --git a/plutus-ledger-api/src/PlutusLedgerApi/V1/ParamName.hs b/plutus-ledger-api/src/PlutusLedgerApi/V1/ParamName.hs
@@ -181,8 +181,8 @@ data ParamName =
   | VerifyEd25519Signature'cpu'arguments'intercept
   | VerifyEd25519Signature'cpu'arguments'slope
   | VerifyEd25519Signature'memory'arguments
-  | LengthArray'cpu'arguments
-  | LengthArray'memory'arguments
+  | LengthOfArray'cpu'arguments
+  | LengthOfArray'memory'arguments
   | ListToArray'cpu'arguments
   | ListToArray'memory'arguments
   | IndexArray'cpu'arguments

diff --git a/plutus-ledger-api/src/PlutusLedgerApi/V2/ParamName.hs b/plutus-ledger-api/src/PlutusLedgerApi/V2/ParamName.hs
@@ -200,8 +200,8 @@ data ParamName =
   | ByteStringToInteger'cpu'arguments'c2
   | ByteStringToInteger'memory'arguments'intercept
   | ByteStringToInteger'memory'arguments'slope
-  | LengthArray'cpu'arguments
-  | LengthArray'memory'arguments
+  | LengthOfArray'cpu'arguments
+  | LengthOfArray'memory'arguments
   | ListToArray'cpu'arguments
   | ListToArray'memory'arguments
   | IndexArray'cpu'arguments

diff --git a/plutus-ledger-api/src/PlutusLedgerApi/V3/ParamName.hs b/plutus-ledger-api/src/PlutusLedgerApi/V3/ParamName.hs
@@ -313,8 +313,8 @@ data ParamName =
   | Ripemd_160'cpu'arguments'intercept
   | Ripemd_160'cpu'arguments'slope
   | Ripemd_160'memory'arguments
-  | LengthArray'cpu'arguments
-  | LengthArray'memory'arguments
+  | LengthOfArray'cpu'arguments
+  | LengthOfArray'memory'arguments
   | ListToArray'cpu'arguments
   | ListToArray'memory'arguments
   | IndexArray'cpu'arguments

diff --git a/plutus-ledger-api/testlib/PlutusLedgerApi/Test/V3/Data/EvaluationContext.hs b/plutus-ledger-api/testlib/PlutusLedgerApi/Test/V3/Data/EvaluationContext.hs
@@ -85,7 +85,7 @@ clearBuiltinCostModel r = r
                , paramFindFirstSetBit = mempty
                , paramRipemd_160 = mempty
                , paramExpModInteger = mempty
-               , paramLengthArray = mempty
+               , paramLengthOfArray = mempty
                , paramListToArray = mempty
                , paramIndexArray = mempty
                }

diff --git a/plutus-ledger-api/testlib/PlutusLedgerApi/Test/V3/EvaluationContext.hs b/plutus-ledger-api/testlib/PlutusLedgerApi/Test/V3/EvaluationContext.hs
@@ -87,7 +87,7 @@ clearBuiltinCostModel r = r
                , paramRipemd_160 = mempty
                , paramExpModInteger = mempty
                , paramDropList = mempty
-               , paramLengthArray = mempty
+               , paramLengthOfArray = mempty
                , paramListToArray = mempty
                , paramIndexArray = mempty
                }

diff --git a/plutus-tx-plugin/src/PlutusTx/Compiler/Builtins.hs b/plutus-tx-plugin/src/PlutusTx/Compiler/Builtins.hs
@@ -468,7 +468,7 @@ defineBuiltinTerms = do
             PLC.DropList -> defineBuiltinInl 'Builtins.drop
 
             -- Arrays
-            PLC.LengthArray -> defineBuiltinInl 'Builtins.lengthOfArray
+            PLC.LengthOfArray -> defineBuiltinInl 'Builtins.lengthOfArray
             PLC.ListToArray -> defineBuiltinInl 'Builtins.listToArray
             PLC.IndexArray -> defineBuiltinInl 'Builtins.indexArray
 

diff --git a/plutus-tx-plugin/test/Array/9.6/compiledLengthArray.pir.golden b/plutus-tx-plugin/test/Array/9.6/compiledLengthArray.pir.golden
@@ -1,5 +1,5 @@
 (let
-    !lengthOfArray : all a. array a -> integer = lengthArray
+    !lengthOfArray : all a. array a -> integer = lengthOfArray
   in
   lengthOfArray {data})
   (let
@@ -22,4 +22,4 @@
     (mkCons
        {data}
        (mkI 1)
-       (mkCons {data} (mkI 2) (mkCons {data} (mkI 3) (mkNilData unitval)))))
+       (mkCons {data} (mkI 2) (mkCons {data} (mkI 3) (mkNilData unitval)))))
diff --git a/plutus-tx-plugin/test/Array/9.6/compiledLengthArray.uplc.golden b/plutus-tx-plugin/test/Array/9.6/compiledLengthArray.uplc.golden
@@ -1,7 +1,7 @@
 (program
    1.1.0
    ((\lengthOfArray -> force lengthOfArray)
-      lengthArray
+      lengthOfArray
       ((\unitval ->
           (\mkNilData ->
              (\mkI ->
@@ -17,4 +17,4 @@
                   mkCons)
                iData)
             mkNilData)
-         ())))
+         ())))
diff --git a/plutus-tx-plugin/test/Array/Spec.hs b/plutus-tx-plugin/test/Array/Spec.hs
@@ -27,9 +27,9 @@ smokeTests =
         [ goldenPirReadable "compiledListToArray" compiledListToArray
         , goldenUPlcReadable "compiledListToArray" compiledListToArray
         , goldenUEval "compiledListToArray" [compiledListToArray]
-        , goldenPirReadable "compiledLengthArray" compiledLengthArray
-        , goldenUPlcReadable "compiledLengthArray" compiledLengthArray
-        , goldenUEval "compiledLengthArray" [compiledLengthArray]
+        , goldenPirReadable "compiledLengthOfArray" compiledLengthOfArray
+        , goldenUPlcReadable "compiledLengthOfArray" compiledLengthOfArray
+        , goldenUEval "compiledLengthOfArray" [compiledLengthOfArray]
         , goldenPirReadable "compiledIndexArray" compiledIndexArray
         , goldenUPlcReadable "compiledIndexArray" compiledIndexArray
         , goldenUEval "compiledIndexArray" [compiledIndexArray]
@@ -54,8 +54,8 @@ compiledListToArray =
         ||]
     )
 
-compiledLengthArray :: CompiledCode BuiltinInteger
-compiledLengthArray =
+compiledLengthOfArray :: CompiledCode BuiltinInteger
+compiledLengthOfArray =
   $$(compile [||lengthOfArray||]) `unsafeApplyCode` compiledListToArray
 
 compiledIndexArray :: CompiledCode BuiltinData