Merge pull request #133 from zkFold/124-extra-addresses

Support for extra addresses in smart wallet

Author: vlasin

.github/workflows/main-pull.yml

@@ -131,7 +131,7 @@ jobs:
 
     - name: Lint Haskell
       run: |
-        find . -name '*.hs' -exec sh -c 'for file do stylish-haskell --inplace "$file"; done' sh {} +
+        find zkfold* -name '*.hs' -exec sh -c 'for file do stylish-haskell --inplace "$file"; done' sh {} +
 
     - name: Auto-commit lint
       uses: stefanzweifel/git-auto-commit-action@v4
@@ -160,6 +160,17 @@ jobs:
       run: |
         cabal build all -f Pedantic
 
+    - name: Check compiled scripts
+      run: |
+        cabal run zkfold-cardano-scripts-compiler
+        diff=$(git diff | wc -l)
+        if [ "$diff" -gt "0" ]; then
+          echo "Compiled scripts in the commit do not correspond to the code in zkfold-cardano-scripts. Did you forget to run cabal run zkfold-cardano-scripts-compiler?"
+          exit 1
+        fi
+
+
+
     # - name: Test
     #   run: cabal test all
 
@@ -170,4 +181,4 @@ jobs:
     #   run: cabal haddock all
 
     # - name: Prepare package for publishing
-    #   run: cabal sdist all
+    #   run: cabal sdist all

zkfold-cardano-scripts-common/data/compiled-scripts/rollup-simple.blueprint

@@ -54,6 +54,13 @@
         }
       },
       "parameters": [
+        {
+          "title": "CurrencySymbol",
+          "purpose": "spend",
+          "schema": {
+            "$ref": "#/definitions/CurrencySymbol"
+          }
+        },
         {
           "title": "ScriptHash",
           "purpose": "spend",
@@ -65,6 +72,49 @@
       "compiledCode": "59011b0101003232232322232323255333573466e1d200000111300633300700a00a357426ae88d5d11aba235744004226012aa666ae68cdc3a4004002226464664600200244b200318014886400a44aa666ae68cdd780100388c00044cc01801800c0023374a900119aba037526eb80192f5c066600e0140146ae84d5d11aba2357446ae88d5d11aba2002118011bad357426ae88008d55cf1baa357420026aae78dd5000991800800912c800c4c0160052219002912a999ab9a3375e0040102260130001133006006003088c88d4008dd5800999180080091092999aab9f001180009991400e002600e6aae7400a600c6aae780093533005005120010011aba100135744002240024b2003149a264c66ae712401035054350080008005",
       "hash": "40c54280c732450bbf835d17687d05aaa7f332720f9d91eeed152fc8"
     },
+    {
+      "title": "wallet'",
+      "description": "Smart wallet spending validator",
+      "redeemer": {
+        "title": "Unit",
+        "purpose": "spend",
+        "schema": {
+          "$ref": "#/definitions/Unit"
+        }
+      },
+      "datum": {
+        "purpose": "spend",
+        "schema": {
+          "$ref": "#/definitions/BuiltinData"
+        }
+      },
+      "parameters": [
+        {
+          "title": "Script index",
+          "description": "Dummy parameter to generate extra addresses for the same wallet",
+          "purpose": "spend",
+          "schema": {
+            "$ref": "#/definitions/Integer"
+          }
+        },
+        {
+          "title": "CurrencySymbol",
+          "purpose": "spend",
+          "schema": {
+            "$ref": "#/definitions/CurrencySymbol"
+          }
+        },
+        {
+          "title": "ScriptHash",
+          "purpose": "spend",
+          "schema": {
+            "$ref": "#/definitions/ScriptHash"
+          }
+        }
+      ],
+      "compiledCode": "59011b01010032322232322232323255333573466e1d200000111300633300700b00b357426ae88d5d11aba235744004226014aa666ae68cdc3a4004002226464664600200244b200318014886400a44aa666ae68cdd780100388c00044cc01801800c0023374a900119aba037526eb80192f5c066600e0160166ae84d5d11aba2357446ae88d5d11aba2002118011bad357426ae88008d55cf1baa357420026aae78dd5000991800800912c800c4c01a0052219002912a999ab9a3375e0040102260150001133006006003088c88d4008dd5800999180080091092999aab9f001180009991400e002600e6aae7400a600c6aae780093533005005120010011aba100135744002240024b2003149a264c66ae71241035054350080008005",
+      "hash": "70253571744c6c83a1155bd363dd363a5e495208747cfbdfa7e49f60"
+    },
     {
       "title": "web2Auth",
       "description": "Smart wallet web2 authentication minting policy",

zkfold-cardano-scripts-common/data/compiled-scripts/smart-wallet.blueprint

@@ -10,6 +10,7 @@ module ZkFold.Cardano.UPLC.Wallet (
   module ZkFold.Cardano.UPLC.Wallet.Types,
   web2Auth,
   checkSig,
+  wallet',
   wallet,
 ) where
 
@@ -143,6 +144,19 @@ checkSig (unsafeFromBuiltinData -> (symb :: CurrencySymbol)) sc =
       & BI.head
       & unsafeFromBuiltinData
 
+{-# INLINEABLE wallet' #-}
+wallet' ::
+  -- | Dummy parameter for extra addresses
+  BuiltinData ->
+  -- | Currency symbol of user's minting script.
+  BuiltinData ->
+  -- | Script hash of stake validator.
+  BuiltinData ->
+  -- | Script context.
+  BuiltinData ->
+  BuiltinUnit
+wallet' _ = wallet
+
 {-# INLINEABLE wallet #-}
 wallet ::
   -- | Currency symbol of user's minting script.

zkfold-cardano-scripts/src/ZkFold/Cardano/UPLC/Wallet.hs

@@ -2,6 +2,8 @@ module ZkFold.Cardano.UPLC.Wallet.Compile (
   writeSmartWalletBP,
   web2AuthSerialisedScript,
   web2AuthCompiledCode,
+  wallet'SerialisedScript,
+  wallet'CompiledCode,
   walletSerialisedScript,
   walletCompiledCode,
   checkSigSerialisedScript,
@@ -62,6 +64,46 @@ smartWalletBP =
               , validatorDatum = Nothing
               , validatorCompiled = Just $ compiledValidator commonPlutusVersion web2AuthSerialisedScript
               }
+          , MkValidatorBlueprint
+              { validatorTitle = "wallet'"
+              , validatorRedeemer =
+                  MkArgumentBlueprint
+                    { argumentTitle = Just "Unit"
+                    , argumentSchema = definitionRef @()
+                    , argumentPurpose = Set.singleton Spend
+                    , argumentDescription = Nothing
+                    }
+              , validatorParameters =
+                  [ MkParameterBlueprint
+                      { parameterTitle = Just "Script index"
+                      , parameterSchema = definitionRef @PlutusTx.Integer
+                      , parameterPurpose = Set.singleton Spend
+                      , parameterDescription = Just "Dummy parameter to generate extra addresses for the same wallet"
+                      }
+                  , MkParameterBlueprint
+                      { parameterTitle = Just "CurrencySymbol"
+                      , parameterSchema = definitionRef @CurrencySymbol
+                      , parameterPurpose = Set.singleton Spend 
+                      , parameterDescription = Nothing
+                      }
+                  , MkParameterBlueprint
+                      { parameterTitle = Just "ScriptHash"
+                      , parameterSchema = definitionRef @ScriptHash
+                      , parameterPurpose = Set.singleton Spend
+                      , parameterDescription = Nothing
+                      }
+                  ]
+              , validatorDescription = Just "Smart wallet spending validator"
+              , validatorDatum =
+                  Just $
+                    MkArgumentBlueprint
+                      { argumentTitle = Nothing
+                      , argumentSchema = definitionRef @PlutusTx.BuiltinData
+                      , argumentPurpose = Set.singleton Spend
+                      , argumentDescription = Nothing
+                      }
+              , validatorCompiled = Just $ compiledValidator commonPlutusVersion wallet'SerialisedScript
+              }
           , MkValidatorBlueprint
               { validatorTitle = "wallet"
               , validatorRedeemer =
@@ -73,6 +115,12 @@ smartWalletBP =
                     }
               , validatorParameters =
                   [ MkParameterBlueprint
+                      { parameterTitle = Just "CurrencySymbol"
+                      , parameterSchema = definitionRef @CurrencySymbol
+                      , parameterPurpose = Set.singleton Spend 
+                      , parameterDescription = Nothing
+                      }
+                  , MkParameterBlueprint
                       { parameterTitle = Just "ScriptHash"
                       , parameterSchema = definitionRef @ScriptHash
                       , parameterPurpose = Set.singleton Spend
@@ -112,7 +160,7 @@ smartWalletBP =
               , validatorCompiled = Just $ compiledValidator commonPlutusVersion checkSigSerialisedScript
               }
           ]
-    , contractDefinitions = deriveDefinitions @'[Web2Auth, OnChainWalletConfig, PlutusTx.BuiltinByteString, (), ScriptHash, PlutusTx.BuiltinData, Signature, CurrencySymbol]
+    , contractDefinitions = deriveDefinitions @'[PlutusTx.Integer, Web2Auth, OnChainWalletConfig, PlutusTx.BuiltinByteString, (), ScriptHash, PlutusTx.BuiltinData, Signature, CurrencySymbol]
     }
  where
   commonPlutusVersion = PlutusV3
@@ -126,6 +174,12 @@ web2AuthSerialisedScript = serialiseCompiledCode web2AuthCompiledCode & fromShor
 web2AuthCompiledCode :: PlutusTx.CompiledCode (PlutusTx.BuiltinData -> PlutusTx.BuiltinData -> PlutusTx.BuiltinData -> PlutusTx.BuiltinUnit)
 web2AuthCompiledCode = $$(PlutusTx.compile [||web2Auth||])
 
+wallet'SerialisedScript :: ByteString
+wallet'SerialisedScript = serialiseCompiledCode wallet'CompiledCode & fromShort
+
+wallet'CompiledCode :: PlutusTx.CompiledCode (PlutusTx.BuiltinData -> PlutusTx.BuiltinData -> PlutusTx.BuiltinData -> PlutusTx.BuiltinData -> PlutusTx.BuiltinUnit)
+wallet'CompiledCode = $$(PlutusTx.compile [||wallet'||])
+
 walletSerialisedScript :: ByteString
 walletSerialisedScript = serialiseCompiledCode walletCompiledCode & fromShort
 

zkfold-cardano-scripts/src/ZkFold/Cardano/UPLC/Wallet/Compile.hs

@@ -36,6 +36,7 @@ common lang
     RecordWildCards
     ScopedTypeVariables
     StandaloneDeriving
+    Strict
     TemplateHaskell
     TypeApplications
     ViewPatterns
@@ -180,6 +181,7 @@ executable zkfold-cardano-scripts-compiler
     zkfold-cardano-scripts,
 
 test-suite buildCrosschainHash-test
+  import: lang
   type: exitcode-stdio-1.0
   main-is: Main.hs
   hs-source-dirs: test/asterizm