Enforce OCF reference integrity

OpenCapTable-v34/daml.yaml

@@ -1,7 +1,7 @@
 sdk-version: 3.4.10
 name: OpenCapTable-v34
 source: daml
-version: 0.0.5
+version: 0.0.6
 build-options:
   - -Wno-crypto-text-is-alpha
   - --typecheck-upgrades=no

Test/daml.yaml

@@ -7,6 +7,6 @@ dependencies:
   - daml-stdlib
   - daml-script
 data-dependencies:
-  - ../OpenCapTable-v34/.daml/dist/OpenCapTable-v34-0.0.5.dar
+  - ../OpenCapTable-v34/.daml/dist/OpenCapTable-v34-0.0.6.dar
 build-options:
   - -Wno-template-interface-depends-on-daml-script

Test/daml/OpenCapTable/TestBalanceSecurityReferences.daml

@@ -0,0 +1,152 @@
+module OpenCapTable.TestBalanceSecurityReferences where
+
+import qualified Fairmint.OpenCapTable.CapTable as CT
+import Fairmint.OpenCapTable.OCF.ConvertibleCancellation (ConvertibleCancellationOcfData(..))
+import Fairmint.OpenCapTable.OCF.EquityCompensationCancellation (EquityCompensationCancellationOcfData(..))
+import Fairmint.OpenCapTable.OCF.StockCancellation (StockCancellationOcfData(..))
+import Fairmint.OpenCapTable.OCF.WarrantCancellation (WarrantCancellationOcfData(..))
+import Fairmint.OpenCapTable.Types.Monetary (OcfMonetary(..))
+import OpenCapTable.Setup
+import OpenCapTable.TestHelpers
+  ( addDefaultConvertibleIssuance
+  , addDefaultEquityCompensationIssuance
+  , addDefaultStakeholder
+  , addDefaultStockIssuance
+  , addDefaultWarrantIssuance
+  , addPrerequisites
+  , defaultStockIssuance
+  , defaultTestDate
+  )
+import Daml.Script
+
+testBalanceSecurityReferences_MissingStockSuccessorFails = script do
+  TestOcp{issuer, cap_table} <- setupTestOcp
+  capTableCid <- addPrerequisites issuer cap_table
+  capTableCid <- addDefaultStockIssuance issuer capTableCid
+
+  submitMustFail issuer do
+    exerciseCmd capTableCid CT.UpdateCapTable with
+      creates = [CT.OcfCreateStockCancellation StockCancellationOcfData with
+        id = "TX-STOCK-MISSING-BALANCE"
+        date = defaultTestDate
+        quantity = 10.0
+        reason_text = "Partial cancellation"
+        security_id = "SEC-STOCK-1"
+        comments = []
+        balance_security_id = Some "SEC-STOCK-MISSING-BALANCE"]
+      edits = []
+      deletes = []
+
+testBalanceSecurityReferences_MissingWarrantSuccessorFails = script do
+  TestOcp{issuer, cap_table} <- setupTestOcp
+  capTableCid <- addDefaultStakeholder issuer cap_table
+  capTableCid <- addDefaultWarrantIssuance issuer capTableCid
+
+  submitMustFail issuer do
+    exerciseCmd capTableCid CT.UpdateCapTable with
+      creates = [CT.OcfCreateWarrantCancellation WarrantCancellationOcfData with
+        id = "TX-WARRANT-MISSING-BALANCE"
+        date = defaultTestDate
+        quantity = 10.0
+        reason_text = "Partial cancellation"
+        security_id = "SEC-WR-1"
+        comments = []
+        balance_security_id = Some "SEC-WARRANT-MISSING-BALANCE"]
+      edits = []
+      deletes = []
+
+testBalanceSecurityReferences_MissingConvertibleSuccessorFails = script do
+  TestOcp{issuer, cap_table} <- setupTestOcp
+  capTableCid <- addDefaultStakeholder issuer cap_table
+  capTableCid <- addDefaultConvertibleIssuance issuer capTableCid
+
+  submitMustFail issuer do
+    exerciseCmd capTableCid CT.UpdateCapTable with
+      creates = [CT.OcfCreateConvertibleCancellation ConvertibleCancellationOcfData with
+        id = "TX-CONVERTIBLE-MISSING-BALANCE"
+        amount = OcfMonetary with amount = 10.0, currency = "USD"
+        date = defaultTestDate
+        reason_text = "Partial cancellation"
+        security_id = "SEC-CV-1"
+        comments = []
+        balance_security_id = Some "SEC-CONVERTIBLE-MISSING-BALANCE"]
+      edits = []
+      deletes = []
+
+testBalanceSecurityReferences_MissingEquityCompensationSuccessorFails = script do
+  TestOcp{issuer, cap_table} <- setupTestOcp
+  capTableCid <- addPrerequisites issuer cap_table
+  capTableCid <- addDefaultEquityCompensationIssuance issuer capTableCid
+
+  submitMustFail issuer do
+    exerciseCmd capTableCid CT.UpdateCapTable with
+      creates = [CT.OcfCreateEquityCompensationCancellation EquityCompensationCancellationOcfData with
+        id = "TX-EC-MISSING-BALANCE"
+        date = defaultTestDate
+        quantity = 10.0
+        reason_text = "Partial cancellation"
+        security_id = "SEC-EC-1"
+        comments = []
+        balance_security_id = Some "SEC-EC-MISSING-BALANCE"]
+      edits = []
+      deletes = []
+
+testBalanceSecurityReferences_StockSuccessorCreatedInSameBatchSucceeds = script do
+  TestOcp{issuer, cap_table} <- setupTestOcp
+  capTableCid <- addPrerequisites issuer cap_table
+  capTableCid <- addDefaultStockIssuance issuer capTableCid
+  let balanceIssuance = (defaultStockIssuance
+        "TX-STOCK-BALANCE-SUCCESSOR"
+        "SEC-STOCK-BALANCE-SUCCESSOR"
+        "SH-1"
+        "SC_COMMON") with quantity = 90.0
+
+  _ <- submit issuer do
+    exerciseCmd capTableCid CT.UpdateCapTable with
+      creates =
+        [ CT.OcfCreateStockIssuance balanceIssuance
+        , CT.OcfCreateStockCancellation StockCancellationOcfData with
+            id = "TX-STOCK-CANCELLATION-BALANCE-SUCCESSOR"
+            date = defaultTestDate
+            quantity = 10.0
+            reason_text = "Partial cancellation"
+            security_id = "SEC-STOCK-1"
+            comments = []
+            balance_security_id = Some "SEC-STOCK-BALANCE-SUCCESSOR"
+        ]
+      edits = []
+      deletes = []
+  pure ()
+
+testBalanceSecurityReferences_EditCanCreateStockSuccessorInSameBatch = script do
+  TestOcp{issuer, cap_table} <- setupTestOcp
+  capTableCid <- addPrerequisites issuer cap_table
+  capTableCid <- addDefaultStockIssuance issuer capTableCid
+  let cancellation = StockCancellationOcfData with
+        id = "TX-STOCK-EDIT-BALANCE"
+        date = defaultTestDate
+        quantity = 10.0
+        reason_text = "Partial cancellation"
+        security_id = "SEC-STOCK-1"
+        comments = []
+        balance_security_id = None
+
+  created <- submit issuer do
+    exerciseCmd capTableCid CT.UpdateCapTable with
+      creates = [CT.OcfCreateStockCancellation cancellation]
+      edits = []
+      deletes = []
+
+  let balanceIssuance = (defaultStockIssuance
+        "TX-STOCK-EDIT-BALANCE-SUCCESSOR"
+        "SEC-STOCK-EDIT-BALANCE-SUCCESSOR"
+        "SH-1"
+        "SC_COMMON") with quantity = 90.0
+
+  _ <- submit issuer do
+    exerciseCmd created.updatedCapTableCid CT.UpdateCapTable with
+      creates = [CT.OcfCreateStockIssuance balanceIssuance]
+      edits = [CT.OcfEditStockCancellation (cancellation with
+        balance_security_id = Some "SEC-STOCK-EDIT-BALANCE-SUCCESSOR")]
+      deletes = []
+  pure ()

Test/daml/OpenCapTable/TestConversionMechanisms.daml

@@ -13,7 +13,7 @@ import Fairmint.OpenCapTable.Types.Monetary (OcfMonetary(..))
 import Fairmint.OpenCapTable.Types.Stock (OcfInitialSharesAuthorized(..), OcfQuantitySourceType(..), OcfRatio(..), OcfStockClassType(..))
 import OpenCapTable.HelpersTriggers (ocfTriggerElectiveAtWill)
 import OpenCapTable.Setup
-import OpenCapTable.TestHelpers (addDefaultStakeholder)
+import OpenCapTable.TestHelpers (addDefaultStakeholder, defaultStockClass)
 
 testTime : Time
 testTime = DT.time (DA.date 2024 Jan 1) 0 0 0
@@ -392,22 +392,25 @@ testConversionMechanismRights_AllValidVariantsCreate = script do
   capTableCid <- addDefaultStakeholder issuer cap_table
   result1 <- submit issuer do
     exerciseCmd capTableCid CT.UpdateCapTable with
-      creates = [CT.OcfCreateStockClass StockClassOcfData with
-        id = "SC_PREFERRED_ALL_CONVERSION_MECHANISMS"
-        name = "Preferred All Conversion Mechanisms"
-        class_type = OcfStockClassTypePreferred
-        default_id_prefix = "PAM-"
-        initial_shares_authorized = OcfInitialSharesNumeric 1_000_000.0
-        votes_per_share = 1.0
-        seniority = 2.0
-        board_approval_date = None
-        stockholder_approval_date = None
-        par_value = None
-        price_per_share = None
-        liquidation_preference_multiple = None
-        participation_cap_multiple = None
-        conversion_rights = validStockClassRights
-        comments = []]
+      creates =
+        [ CT.OcfCreateStockClass (defaultStockClass "SC_COMMON")
+        , CT.OcfCreateStockClass (StockClassOcfData with
+            id = "SC_PREFERRED_ALL_CONVERSION_MECHANISMS"
+            name = "Preferred All Conversion Mechanisms"
+            class_type = OcfStockClassTypePreferred
+            default_id_prefix = "PAM-"
+            initial_shares_authorized = OcfInitialSharesNumeric 1_000_000.0
+            votes_per_share = 1.0
+            seniority = 2.0
+            board_approval_date = None
+            stockholder_approval_date = None
+            par_value = None
+            price_per_share = None
+            liquidation_preference_multiple = None
+            participation_cap_multiple = None
+            conversion_rights = validStockClassRights
+            comments = [])
+        ]
       edits = []
       deletes = []
   result2 <- submit issuer do
@@ -460,22 +463,25 @@ testConversionMechanismRights_InvalidVariantsReject = script do
   capTableCid <- addDefaultStakeholder issuer cap_table
   stockControl <- submit issuer do
     exerciseCmd capTableCid CT.UpdateCapTable with
-      creates = [CT.OcfCreateStockClass StockClassOcfData with
-        id = "SC_VALID_CONVERSION_MECHANISM_CONTROL"
-        name = "Valid Conversion Mechanism Control"
-        class_type = OcfStockClassTypePreferred
-        default_id_prefix = "VCM-"
-        initial_shares_authorized = OcfInitialSharesNumeric 1_000_000.0
-        votes_per_share = 1.0
-        seniority = 2.0
-        board_approval_date = None
-        stockholder_approval_date = None
-        par_value = None
-        price_per_share = None
-        liquidation_preference_multiple = None
-        participation_cap_multiple = None
-        conversion_rights = [stockClassRightWith OcfConversionMechanismRatioConversion None None (Some validRatio) None None None None None]
-        comments = []]
+      creates =
+        [ CT.OcfCreateStockClass (defaultStockClass "SC_COMMON")
+        , CT.OcfCreateStockClass (StockClassOcfData with
+            id = "SC_VALID_CONVERSION_MECHANISM_CONTROL"
+            name = "Valid Conversion Mechanism Control"
+            class_type = OcfStockClassTypePreferred
+            default_id_prefix = "VCM-"
+            initial_shares_authorized = OcfInitialSharesNumeric 1_000_000.0
+            votes_per_share = 1.0
+            seniority = 2.0
+            board_approval_date = None
+            stockholder_approval_date = None
+            par_value = None
+            price_per_share = None
+            liquidation_preference_multiple = None
+            participation_cap_multiple = None
+            conversion_rights = [stockClassRightWith OcfConversionMechanismRatioConversion None None (Some validRatio) None None None None None]
+            comments = [])
+        ]
       edits = []
       deletes = []
   submitMustFail issuer do

Test/daml/OpenCapTable/TestConvertibleCancellation.daml

@@ -13,12 +13,12 @@ import qualified DA.Time as DT
 import Daml.Script
 
 -- Create a convertible issuance to cancel
-createConvertibleIssuance issuer capTableCid securityId amount =
+createConvertibleIssuance issuer capTableCid securityId amount issuanceDate =
   submit issuer do
     exerciseCmd capTableCid CT.UpdateCapTable with
       creates = [CT.OcfCreateConvertibleIssuance ConvertibleIssuanceOcfData with
         id = "TX_CONV_ISS_" <> securityId
-        date = DT.time (DA.date 2022 Jun 01) 0 0 0
+        date = issuanceDate
         security_id = securityId
         custom_id = "SAFE-1"
         stakeholder_id = "SH-1"
@@ -38,7 +38,7 @@ createConvertibleIssuance issuer capTableCid securityId amount =
 testConvertibleCancellation_Create = script do
   TestOcp{system_operator, issuer, ctx, cap_table} <- setupTestOcp
   capTableCid <- addDefaultStakeholder issuer cap_table
-  result <- createConvertibleIssuance issuer capTableCid "SEC-1" 25000.0
+  result <- createConvertibleIssuance issuer capTableCid "SEC-1" 25000.0 (DT.time (DA.date 2022 Jun 01) 0 0 0)
   _ <- submit issuer do
     exerciseCmd result.updatedCapTableCid CT.UpdateCapTable with
       creates = [CT.OcfCreateConvertibleCancellation ConvertibleCancellationOcfData with
@@ -56,9 +56,10 @@ testConvertibleCancellation_Create = script do
 testConvertibleCancellation_PartialWithOptionals = script do
   TestOcp{system_operator, issuer, ctx, cap_table} <- setupTestOcp
   capTableCid <- addDefaultStakeholder issuer cap_table
-  result <- createConvertibleIssuance issuer capTableCid "SEC-2" 100000.0
+  result <- createConvertibleIssuance issuer capTableCid "SEC-2" 100000.0 (DT.time (DA.date 2022 Jun 01) 0 0 0)
+  balanceResult <- createConvertibleIssuance issuer result.updatedCapTableCid "SEC-CONV-PARTIAL-BAL" 75000.0 (DT.time (DA.date 2024 Jun 15) 0 0 0)
   _ <- submit issuer do
-    exerciseCmd result.updatedCapTableCid CT.UpdateCapTable with
+    exerciseCmd balanceResult.updatedCapTableCid CT.UpdateCapTable with
       creates = [CT.OcfCreateConvertibleCancellation ConvertibleCancellationOcfData with
         id = "TX_CONV_CANCEL_PARTIAL"
         date = DT.time (DA.date 2024 Jun 15) 0 0 0