Enforce security quantity balance invariants

OpenCapTable-v34/daml.yaml

@@ -1,7 +1,7 @@
 sdk-version: 3.4.10
 name: OpenCapTable-v34
 source: daml
-version: 0.0.11
+version: 0.0.12
 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.11.dar
+  - ../OpenCapTable-v34/.daml/dist/OpenCapTable-v34-0.0.12.dar
 build-options:
   - -Wno-template-interface-depends-on-daml-script

Test/daml/OpenCapTable/TestEquityCompensationCancellation.daml

@@ -12,12 +12,12 @@ import qualified DA.Time as DT
 import Daml.Script
 
 -- Create an equity compensation issuance to cancel (follows real workflow)
-createEquityCompensationIssuance issuer capTableCid securityId quantity =
+createEquityCompensationIssuance issuer capTableCid securityId quantity issuanceDate =
   submit issuer do
     exerciseCmd capTableCid CT.UpdateCapTable with
       creates = [CT.OcfCreateEquityCompensationIssuance EquityCompensationIssuanceOcfData with
-        id = "TX_EC_ISS_1"
-        date = DT.time (DA.date 2020 Jan 15) 0 0 0
+        id = "TX_EC_ISS_" <> securityId
+        date = issuanceDate
         security_id = securityId
         custom_id = "GRANT-001"
         stakeholder_id = "SH-1"
@@ -61,7 +61,7 @@ testEquityCompensationCancellation_CreateAndArchiveByIssuer = script do
   TestOcp{system_operator, issuer, ctx, cap_table} <- setupTestOcp
   capTableCid <- addPrerequisites issuer cap_table
   let securityId = "db5a26d6-3912-4400-87b0-bda74de361af"
-  result <- createEquityCompensationIssuance issuer capTableCid securityId 250000.0
+  result <- createEquityCompensationIssuance issuer capTableCid securityId 250000.0 (DT.time (DA.date 2020 Jan 15) 0 0 0)
   _ <- createEquityCompensationCancellation issuer result.updatedCapTableCid securityId 214200.0
   pure ()
 
@@ -70,7 +70,7 @@ testEquityCompensationCancellation_CreateAndArchiveBuiltIn = script do
   TestOcp{system_operator, issuer, ctx, cap_table} <- setupTestOcp
   capTableCid <- addPrerequisites issuer cap_table
   let securityId = "SEC-EC-002"
-  result <- createEquityCompensationIssuance issuer capTableCid securityId 100000.0
+  result <- createEquityCompensationIssuance issuer capTableCid securityId 100000.0 (DT.time (DA.date 2020 Jan 15) 0 0 0)
   _ <- submit issuer do
     exerciseCmd result.updatedCapTableCid CT.UpdateCapTable with
       creates = [CT.OcfCreateEquityCompensationCancellation EquityCompensationCancellationOcfData with
@@ -92,41 +92,18 @@ testEquityCompensationCancellation_PartialWithOptionals = script do
   let securityId = "SEC-EC-PARTIAL"
   let balanceSecurityId = "SEC-EC-PARTIAL-BAL"
   let cancellationDate = DT.time (DA.date 2024 Jun 30) 0 0 0
-  result <- createEquityCompensationIssuance issuer capTableCid securityId 500000.0
+  result <- createEquityCompensationIssuance issuer capTableCid securityId 500000.0 (DT.time (DA.date 2020 Jan 15) 0 0 0)
+  balanceResult <- createEquityCompensationIssuance issuer result.updatedCapTableCid balanceSecurityId 350000.0 cancellationDate
   _ <- submit issuer do
-    exerciseCmd result.updatedCapTableCid CT.UpdateCapTable with
-      creates =
-        [ CT.OcfCreateEquityCompensationCancellation EquityCompensationCancellationOcfData with
-            id = "TX_EC_CANCEL_PARTIAL"
-            date = cancellationDate
-            security_id = securityId
-            quantity = 150000.0
-            reason_text = "Partial forfeiture due to early departure"
-            balance_security_id = Some balanceSecurityId
-            comments = ["Partial cancellation per separation agreement", "Remaining vested options: 350,000"]
-        , CT.OcfCreateEquityCompensationIssuance EquityCompensationIssuanceOcfData with
-            id = "TX_EC_CANCEL_PARTIAL_BALANCE"
-            date = cancellationDate
-            security_id = balanceSecurityId
-            custom_id = "GRANT-001-BALANCE"
-            stakeholder_id = "SH-1"
-            board_approval_date = None
-            stockholder_approval_date = None
-            consideration_text = None
-            security_law_exemptions = []
-            stock_plan_id = None
-            stock_class_id = Some "SC_COMMON"
-            compensation_type = OcfCompensationTypeOptionNSO
-            quantity = 350000.0
-            exercise_price = Some (OcfMonetary with amount = 0.10, currency = "USD")
-            base_price = None
-            early_exercisable = Some False
-            vesting_terms_id = None
-            vestings = []
-            expiration_date = None
-            termination_exercise_windows = []
-            comments = []
-        ]
+    exerciseCmd balanceResult.updatedCapTableCid CT.UpdateCapTable with
+      creates = [CT.OcfCreateEquityCompensationCancellation EquityCompensationCancellationOcfData with
+        id = "TX_EC_CANCEL_PARTIAL"
+        date = cancellationDate
+        security_id = securityId
+        quantity = 150000.0
+        reason_text = "Partial forfeiture due to early departure"
+        balance_security_id = Some balanceSecurityId
+        comments = ["Partial cancellation per separation agreement", "Remaining vested options: 350,000"]]
       edits = []
       deletes = []
   pure ()

Test/daml/OpenCapTable/TestEquityCompensationTransfer.daml

@@ -49,13 +49,14 @@ testEquityCompensationTransfer_NSOToFamilyTrust = script do
   capTableCid <- addDefaultStakeholder issuer cap_table
   let securityId = "ESEC-NSO-001"
   result <- createEquityCompensationIssuance issuer capTableCid securityId 10000.0 (DT.time (DA.date 2022 Jan 15) 0 0 0)
-  balanceResult <- createEquityCompensationIssuance issuer result.updatedCapTableCid "ESEC-NSO-REMAIN" 5000.0 (DT.time (DA.date 2025 Jun 01) 0 0 0)
+  let transferDate = DT.time (DA.date 2025 Jun 01) 0 0 0
+  balanceResult <- createEquityCompensationIssuance issuer result.updatedCapTableCid "ESEC-NSO-REMAIN" 5000.0 transferDate
   _ <- submit issuer do
     exerciseCmd balanceResult.updatedCapTableCid CT.UpdateCapTable with
-      creates = [equityCompensationSuccessorIssuance "EC-ISS-TRANSFERRED-001" "ESEC-NSO-TRANSFERRED-001" "SH-1" (DT.time (DA.date 2025 Jun 01) 0 0 0) 5000.0
+      creates = [equityCompensationSuccessorIssuance "EC-ISS-TRANSFERRED-001" "ESEC-NSO-TRANSFERRED-001" "SH-1" transferDate 5000.0
         , CT.OcfCreateEquityCompensationTransfer EquityCompensationTransferOcfData with
         id = "TX_EQUITY_COMP_TRANSFER_1"
-        date = DT.time (DA.date 2025 Jun 01) 0 0 0
+        date = transferDate
         quantity = 5000.0
         security_id = securityId
         resulting_security_ids = ["ESEC-NSO-TRANSFERRED-001"]
@@ -94,13 +95,14 @@ testEquityCompensationTransfer_WithApprovalComments = script do
   capTableCid <- addDefaultStakeholder issuer cap_table
   let securityId = "ESEC-NSO-APPROVAL"
   result <- createEquityCompensationIssuance issuer capTableCid securityId 15000.0 (DT.time (DA.date 2022 Jan 15) 0 0 0)
-  balanceResult <- createEquityCompensationIssuance issuer result.updatedCapTableCid "ESEC-NSO-REMAINING" 7000.0 (DT.time (DA.date 2025 Nov 01) 0 0 0)
+  let transferDate = DT.time (DA.date 2025 Nov 01) 0 0 0
+  balanceResult <- createEquityCompensationIssuance issuer result.updatedCapTableCid "ESEC-NSO-REMAINING" 7000.0 transferDate
   _ <- submit issuer do
     exerciseCmd balanceResult.updatedCapTableCid CT.UpdateCapTable with
-      creates = [equityCompensationSuccessorIssuance "EC-ISS-TRUST" "ESEC-NSO-TRUST" "SH-1" (DT.time (DA.date 2025 Nov 01) 0 0 0) 8000.0
+      creates = [equityCompensationSuccessorIssuance "EC-ISS-TRUST" "ESEC-NSO-TRUST" "SH-1" transferDate 8000.0
         , CT.OcfCreateEquityCompensationTransfer EquityCompensationTransferOcfData with
         id = "TX_EQUITY_COMP_TRANSFER_APPROVED"
-        date = DT.time (DA.date 2025 Nov 01) 0 0 0
+        date = transferDate
         quantity = 8000.0
         security_id = securityId
         resulting_security_ids = ["ESEC-NSO-TRUST"]

Test/daml/OpenCapTable/TestFinalReferenceValidation.daml

@@ -82,18 +82,18 @@ testFinalReferenceValidation_DeleteReferencedStockIssuanceFails = script do
   TestOcp{issuer, cap_table} <- setupTestOcp
   capTable <- addPrerequisites issuer cap_table
   capTable <- addStockIssuance issuer capTable "TX-STOCK-FINAL-REF" "SEC-FINAL-REF" "SH-1" "SC_COMMON"
-  let balanceIssuance = (defaultStockIssuance "TX-STOCK-TRANSFER-BALANCE" "SEC-TRANSFER-BALANCE" "SH-1" "SC_COMMON") with
-        date = defaultReferenceTestTime
-        quantity = 90.0
-  let resultIssuance = (defaultStockIssuance "TX-STOCK-TRANSFER-RESULT" "SEC-TRANSFER-RESULT" "SH-1" "SC_COMMON") with
+  let resultIssuance = (defaultStockIssuance "TX-STOCK-TRANSFER-FINAL-RESULT" "SEC-TRANSFER-RESULT" "SH-1" "SC_COMMON") with
         date = defaultReferenceTestTime
         quantity = 10.0
+  let balanceIssuance = (defaultStockIssuance "TX-STOCK-TRANSFER-FINAL-BALANCE" "SEC-TRANSFER-BALANCE" "SH-1" "SC_COMMON") with
+        date = defaultReferenceTestTime
+        quantity = 90.0
   result <- submit issuer do
     exerciseCmd capTable CT.UpdateCapTable with
       creates =
         [ CT.OcfCreateStockTransfer (stockTransferData "TX-STOCK-TRANSFER-FINAL-REF" "SEC-FINAL-REF")
-        , CT.OcfCreateStockIssuance balanceIssuance
         , CT.OcfCreateStockIssuance resultIssuance
+        , CT.OcfCreateStockIssuance balanceIssuance
         ]
       edits = []
       deletes = []

Test/daml/OpenCapTable/TestHelpers.daml

@@ -13,11 +13,13 @@ import Fairmint.OpenCapTable.OCF.VestingTerms (VestingTermsOcfData(..), OcfAlloc
 import Fairmint.OpenCapTable.OCF.WarrantIssuance (WarrantIssuanceOcfData(..))
 import Fairmint.OpenCapTable.OCF.ConvertibleIssuance (ConvertibleIssuanceOcfData(..), OcfConvertibleConversionTrigger(..))
 import Fairmint.OpenCapTable.OCF.EquityCompensationIssuance (EquityCompensationIssuanceOcfData(..))
+import Fairmint.OpenCapTable.OCF.EquityCompensationRelease (EquityCompensationReleaseOcfData(..))
 import Fairmint.OpenCapTable.Types.Monetary (OcfMonetary(..))
 import Fairmint.OpenCapTable.Types.Stock (OcfStockClassType(..), OcfInitialSharesAuthorized(..), OcfRatio(..))
 import Fairmint.OpenCapTable.Types.Vesting (OcfCompensationType(..))
 import Fairmint.OpenCapTable.Types.Conversion (OcfConvertibleType(..), OcfConversionTriggerType(..), OcfConvertibleConversionRight(..), OcfConvertibleConversionMechanism(..), OcfSAFEConversionMechanism(..))
 import qualified Fairmint.OpenCapTable.CapTable as CT
+import OpenCapTable.HelpersTriggers (ocfTriggerElectiveAtWill)
 import qualified DA.Date as DA
 import DA.Date (Month(..))
 import qualified DA.Time as DT
@@ -92,24 +94,32 @@ stockClassAuthorizedSharesAdjustment adjustmentId stockClassId authorizedShares
     stockholder_approval_date = None
     comments = []
 
-stockCancellation : Text -> Text -> Decimal -> StockCancellationOcfData
-stockCancellation cancellationId securityId quantity = StockCancellationOcfData with
+stockCancellationOn : Text -> Text -> Decimal -> Time -> StockCancellationOcfData
+stockCancellationOn cancellationId securityId quantity date = StockCancellationOcfData with
   id = cancellationId
-  date = defaultTestDate
+  date = date
   security_id = securityId
   quantity = quantity
   balance_security_id = None
   reason_text = "Cancelled shares"
   comments = []
 
-stockClassSplit : Text -> Text -> Decimal -> Decimal -> StockClassSplitOcfData
-stockClassSplit splitId stockClassId numerator denominator = StockClassSplitOcfData with
+stockCancellation : Text -> Text -> Decimal -> StockCancellationOcfData
+stockCancellation cancellationId securityId quantity =
+  stockCancellationOn cancellationId securityId quantity defaultTestDate
+
+stockClassSplitOn : Text -> Text -> Decimal -> Decimal -> Time -> StockClassSplitOcfData
+stockClassSplitOn splitId stockClassId numerator denominator date = StockClassSplitOcfData with
   id = splitId
-  date = defaultTestDate
+  date = date
   stock_class_id = stockClassId
   split_ratio = OcfRatio with numerator = numerator, denominator = denominator
   comments = []
 
+stockClassSplit : Text -> Text -> Decimal -> Decimal -> StockClassSplitOcfData
+stockClassSplit splitId stockClassId numerator denominator =
+  stockClassSplitOn splitId stockClassId numerator denominator defaultTestDate
+
 stockPlanEquityCompensationIssuance : Text -> Text -> Text -> Text -> Text -> Decimal -> EquityCompensationIssuanceOcfData
 stockPlanEquityCompensationIssuance issuanceId securityId stakeholderId stockClassId stockPlanId quantity = EquityCompensationIssuanceOcfData with
   id = issuanceId
@@ -134,6 +144,18 @@ stockPlanEquityCompensationIssuance issuanceId securityId stakeholderId stockCla
   quantity = quantity
   comments = []
 
+equityCompensationRelease : Text -> Text -> Time -> Time -> Decimal -> EquityCompensationReleaseOcfData
+equityCompensationRelease releaseId securityId releaseDate settlementDate quantity = EquityCompensationReleaseOcfData with
+  id = releaseId
+  date = releaseDate
+  security_id = securityId
+  settlement_date = settlementDate
+  release_price = OcfMonetary with amount = 1.0, currency = "USD"
+  quantity = quantity
+  resulting_security_ids = [releaseId <> "_RESULT"]
+  consideration_text = None
+  comments = []
+
 -- | Returns valid StakeholderOcfData with sensible defaults.
 -- Provide ID and name; all other fields use reasonable test values.
 --
@@ -221,6 +243,32 @@ warrantSuccessorIssuance issuanceId securityId stakeholderId date quantity =
     vesting_terms_id = None
     warrant_expiration_date = None
 
+createWarrantIssuance : Party -> ContractId CT.CapTable -> Text -> Decimal -> Time -> Script CT.UpdateCapTableResult
+createWarrantIssuance issuer capTableCid securityId quantity issuanceDate =
+  submit issuer do
+    exerciseCmd capTableCid CT.UpdateCapTable with
+      creates = [CT.OcfCreateWarrantIssuance WarrantIssuanceOcfData with
+        id = "TX_WARRANT_ISS_" <> securityId
+        date = issuanceDate
+        security_id = securityId
+        custom_id = "W-1"
+        stakeholder_id = "SH-1"
+        board_approval_date = None
+        stockholder_approval_date = None
+        consideration_text = None
+        security_law_exemptions = []
+        quantity = Some quantity
+        quantity_source = None
+        exercise_price = Some (OcfMonetary with amount = 1.0, currency = "USD")
+        purchase_price = OcfMonetary with amount = 0.0, currency = "USD"
+        exercise_triggers = [ocfTriggerElectiveAtWill]
+        warrant_expiration_date = None
+        vesting_terms_id = None
+        vestings = []
+        comments = []]
+      edits = []
+      deletes = []
+
 convertibleSuccessorIssuance : Text -> Text -> Text -> Time -> Decimal -> CT.OcfCreateData
 convertibleSuccessorIssuance issuanceId securityId stakeholderId date investmentAmount =
   CT.OcfCreateConvertibleIssuance ConvertibleIssuanceOcfData with