Merge pull request tweag#288 from tweag/joaosreis/entities-accounts

Add entities/accounts/v0 namespace

Author: joaosreis

scls-cardano/cddl-src/Cardano/SCLS/CDDL.hs

@@ -9,6 +9,7 @@ module Cardano.SCLS.CDDL (
 ) where
 
 import Cardano.SCLS.Namespace.Blocks qualified as Blocks
+import Cardano.SCLS.Namespace.EntitiesAccounts qualified as EntitiesAccounts
 import Cardano.SCLS.Namespace.EntitiesCommittee qualified as EntitiesCommittee
 import Cardano.SCLS.Namespace.EntitiesDReps qualified as EntitiesDReps
 import Cardano.SCLS.Namespace.EntitiesStakePools qualified as EntitiesStakePools
@@ -56,6 +57,9 @@ instance KnownSpec "snapshots/go/v0" where
 instance KnownSpec "nonces/v0" where
   namespaceSpec _ = mkDefinition Nonces.record_entry
 
+instance KnownSpec "entities/accounts/v0" where
+  namespaceSpec _ = mkDefinition EntitiesAccounts.record_entry
+
 instance KnownSpec "entities/committee/v0" where
   namespaceSpec _ = mkDefinition EntitiesCommittee.record_entry
 
@@ -98,6 +102,7 @@ knownNamespaces =
   , mkNamespaceSymbol @"snapshots/set/v0"
   , mkNamespaceSymbol @"snapshots/go/v0"
   , mkNamespaceSymbol @"nonces/v0"
+  , mkNamespaceSymbol @"entities/accounts/v0"
   , mkNamespaceSymbol @"entities/committee/v0"
   , mkNamespaceSymbol @"entities/dreps/v0"
   , mkNamespaceSymbol @"entities/stake_pools/v0"
@@ -115,6 +120,7 @@ type instance Spec.NamespaceKeySize "nonces/v0" = 1 -- Just zero
 type instance Spec.NamespaceKeySize "snapshots/mark/v0" = 31 -- 1 byte for hash type, 29 bytes for key hash (including 1-byte discriminator/padding; cred 29, key 28+1), 1 byte for value type
 type instance Spec.NamespaceKeySize "snapshots/set/v0" = 31 -- 1 byte for hash type, 29 bytes for key hash (including 1-byte discriminator/padding; cred 29, key 28+1), 1 byte for value type
 type instance Spec.NamespaceKeySize "snapshots/go/v0" = 31 -- 1 byte for hash type, 29 bytes for key hash (including 1-byte discriminator/padding; cred 29, key 28+1), 1 byte for value type
+type instance Spec.NamespaceKeySize "entities/accounts/v0" = 29 -- 1 byte for tag, 28 bytes for hash
 type instance Spec.NamespaceKeySize "entities/committee/v0" = 1 -- One-byte zero, as it's a singleton key
 type instance Spec.NamespaceKeySize "entities/dreps/v0" = 29 -- 1 byte for tag, 28 bytes for hash
 type instance Spec.NamespaceKeySize "entities/stake_pools/v0" = 28

scls-cardano/cddl-src/Cardano/SCLS/Namespace/EntitiesAccounts.hs

@@ -0,0 +1,63 @@
+{-# LANGUAGE ImportQualifiedPost #-}
+{-# LANGUAGE OverloadedLists #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE QuasiQuotes #-}
+{-# LANGUAGE TypeApplications #-}
+{-# LANGUAGE NoImplicitPrelude #-}
+{-# OPTIONS_GHC -Wno-unrecognised-pragmas #-}
+
+{-# HLINT ignore "Use camelCase" #-}
+module Cardano.SCLS.Namespace.EntitiesAccounts where
+
+import Cardano.SCLS.Common
+import Codec.CBOR.Cuddle.Huddle
+import Data.Function (($))
+import Text.Heredoc (str)
+
+record_entry :: Rule
+record_entry =
+  comment
+    [str| The key for the namespace
+        |
+        | ```
+        | meta:
+        |   endian: be
+        |
+        | seq:
+        |   - id: key
+        |     type: credential
+        |
+        | types:
+        |   credential:
+        |     seq:
+        |       - id: tag
+        |         size: 1
+        |       - id: hash
+        |         size: 28
+        | ```
+        |]
+    $ "record_entry" =:= account_state
+
+account_state :: Rule
+account_state =
+  "account_state"
+    =:= mp
+      [ "balance" ==> coin
+      , "deposit" ==> coin
+      , "drep_delegation" ==> drep / VNil
+      , "stake_pool_delegation" ==> pool_keyhash / VNil
+      ]
+
+drep :: Rule
+drep =
+  comment
+    [str| 0 - key hash
+              | 1 - script hash
+              | 2 - always abstain
+              | 3 - always no confidence
+        |]
+    $ "drep"
+      =:= arr [0, a keyhash28]
+      / arr [1, a script_hash]
+      / arr [2]
+      / arr [3]

scls-cardano/scls-cardano.cabal

@@ -31,6 +31,7 @@ library
   other-modules:
     Cardano.SCLS.Common
     Cardano.SCLS.Namespace.Blocks
+    Cardano.SCLS.Namespace.EntitiesAccounts
     Cardano.SCLS.Namespace.EntitiesCommittee
     Cardano.SCLS.Namespace.EntitiesDReps
     Cardano.SCLS.Namespace.EntitiesStakePools

scls-cardano/test/Reference.hs

@@ -69,6 +69,7 @@ allReferenceCDDLs =
   , ("snapshots/set/v0", "snapshots_set_v0.cddl")
   , ("snapshots/go/v0", "snapshots_go_v0.cddl")
   , ("nonces/v0", "nonces_v0.cddl")
+  , ("entities/accounts/v0", "entities_accounts_v0.cddl")
   , ("entities/committee/v0", "entities_committee_v0.cddl")
   , ("entities/dreps/v0", "entities_dreps_v0.cddl")
   , ("entities/stake_pools/v0", "entities_stake_pools_v0.cddl")

scls-cardano/testlib/Cardano/SCLS/Testlib.hs

@@ -55,6 +55,7 @@ testAllNS ::
   , ConstrNS "snapshots/go/v0"
   , ConstrNS "snapshots/mark/v0"
   , ConstrNS "snapshots/set/v0"
+  , ConstrNS "entities/accounts/v0"
   , ConstrNS "entities/committee/v0"
   , ConstrNS "entities/dreps/v0"
   , ConstrNS "entities/stake_pools/v0"
@@ -72,6 +73,7 @@ testAllNS = describe "scls/conformance" $ do
   testNS @"snapshots/go/v0"
   testNS @"snapshots/mark/v0"
   testNS @"snapshots/set/v0"
+  testNS @"entities/accounts/v0"
   testNS @"entities/committee/v0"
   testNS @"entities/dreps/v0"
   testNS @"entities/stake_pools/v0"