@open-captable-protocol/canton 0.2.76 → 0.2.78
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.docs.md +2 -3
- package/README.md +29 -9
- package/dist/OcpClient.d.ts +19 -18
- package/dist/OcpClient.d.ts.map +1 -1
- package/dist/OcpClient.js +30 -30
- package/dist/OcpClient.js.map +1 -1
- package/dist/functions/companyValuationReport/addObserversToCompanyValuationReport.d.ts +3 -5
- package/dist/functions/companyValuationReport/addObserversToCompanyValuationReport.d.ts.map +1 -1
- package/dist/functions/companyValuationReport/addObserversToCompanyValuationReport.js +19 -17
- package/dist/functions/companyValuationReport/addObserversToCompanyValuationReport.js.map +1 -1
- package/dist/functions/companyValuationReport/createCompanyValuationReport.d.ts +21 -22
- package/dist/functions/companyValuationReport/createCompanyValuationReport.d.ts.map +1 -1
- package/dist/functions/companyValuationReport/createCompanyValuationReport.js +30 -32
- package/dist/functions/companyValuationReport/createCompanyValuationReport.js.map +1 -1
- package/dist/functions/companyValuationReport/updateCompanyValuationReport.d.ts +3 -5
- package/dist/functions/companyValuationReport/updateCompanyValuationReport.d.ts.map +1 -1
- package/dist/functions/companyValuationReport/updateCompanyValuationReport.js +19 -17
- package/dist/functions/companyValuationReport/updateCompanyValuationReport.js.map +1 -1
- package/dist/functions/convertibleIssuance/archiveConvertibleIssuanceByIssuer.d.ts +1 -1
- package/dist/functions/convertibleIssuance/archiveConvertibleIssuanceByIssuer.d.ts.map +1 -1
- package/dist/functions/convertibleIssuance/archiveConvertibleIssuanceByIssuer.js +2 -2
- package/dist/functions/convertibleIssuance/archiveConvertibleIssuanceByIssuer.js.map +1 -1
- package/dist/functions/convertibleIssuance/createConvertibleIssuance.d.ts +2 -2
- package/dist/functions/convertibleIssuance/createConvertibleIssuance.d.ts.map +1 -1
- package/dist/functions/convertibleIssuance/createConvertibleIssuance.js +109 -82
- package/dist/functions/convertibleIssuance/createConvertibleIssuance.js.map +1 -1
- package/dist/functions/convertibleIssuance/getConvertibleIssuanceAsOcf.d.ts +28 -26
- package/dist/functions/convertibleIssuance/getConvertibleIssuanceAsOcf.d.ts.map +1 -1
- package/dist/functions/convertibleIssuance/getConvertibleIssuanceAsOcf.js +167 -71
- package/dist/functions/convertibleIssuance/getConvertibleIssuanceAsOcf.js.map +1 -1
- package/dist/functions/convertibleIssuance/index.d.ts +1 -1
- package/dist/functions/convertibleIssuance/index.d.ts.map +1 -1
- package/dist/functions/convertibleIssuance/index.js +1 -1
- package/dist/functions/convertibleIssuance/index.js.map +1 -1
- package/dist/functions/document/archiveDocumentByIssuer.d.ts +1 -1
- package/dist/functions/document/archiveDocumentByIssuer.d.ts.map +1 -1
- package/dist/functions/document/archiveDocumentByIssuer.js +2 -2
- package/dist/functions/document/archiveDocumentByIssuer.js.map +1 -1
- package/dist/functions/document/createDocument.d.ts +4 -4
- package/dist/functions/document/createDocument.d.ts.map +1 -1
- package/dist/functions/document/createDocument.js +132 -71
- package/dist/functions/document/createDocument.js.map +1 -1
- package/dist/functions/document/getDocumentAsOcf.d.ts +4 -4
- package/dist/functions/document/getDocumentAsOcf.d.ts.map +1 -1
- package/dist/functions/document/getDocumentAsOcf.js +127 -66
- package/dist/functions/document/getDocumentAsOcf.js.map +1 -1
- package/dist/functions/document/index.d.ts +1 -1
- package/dist/functions/document/index.d.ts.map +1 -1
- package/dist/functions/document/index.js +1 -1
- package/dist/functions/document/index.js.map +1 -1
- package/dist/functions/equityCompensationExercise/archiveEquityCompensationExerciseByIssuer.d.ts +1 -1
- package/dist/functions/equityCompensationExercise/archiveEquityCompensationExerciseByIssuer.d.ts.map +1 -1
- package/dist/functions/equityCompensationExercise/archiveEquityCompensationExerciseByIssuer.js +2 -2
- package/dist/functions/equityCompensationExercise/archiveEquityCompensationExerciseByIssuer.js.map +1 -1
- package/dist/functions/equityCompensationExercise/createEquityCompensationExercise.d.ts +3 -11
- package/dist/functions/equityCompensationExercise/createEquityCompensationExercise.d.ts.map +1 -1
- package/dist/functions/equityCompensationExercise/createEquityCompensationExercise.js +20 -12
- package/dist/functions/equityCompensationExercise/createEquityCompensationExercise.js.map +1 -1
- package/dist/functions/equityCompensationExercise/getEquityCompensationExerciseEventAsOcf.d.ts +3 -3
- package/dist/functions/equityCompensationExercise/getEquityCompensationExerciseEventAsOcf.d.ts.map +1 -1
- package/dist/functions/equityCompensationExercise/getEquityCompensationExerciseEventAsOcf.js +7 -5
- package/dist/functions/equityCompensationExercise/getEquityCompensationExerciseEventAsOcf.js.map +1 -1
- package/dist/functions/equityCompensationExercise/index.d.ts +1 -1
- package/dist/functions/equityCompensationExercise/index.d.ts.map +1 -1
- package/dist/functions/equityCompensationExercise/index.js +1 -1
- package/dist/functions/equityCompensationExercise/index.js.map +1 -1
- package/dist/functions/equityCompensationIssuance/archiveEquityCompensationIssuanceByIssuer.d.ts +1 -1
- package/dist/functions/equityCompensationIssuance/archiveEquityCompensationIssuanceByIssuer.d.ts.map +1 -1
- package/dist/functions/equityCompensationIssuance/archiveEquityCompensationIssuanceByIssuer.js +2 -2
- package/dist/functions/equityCompensationIssuance/archiveEquityCompensationIssuanceByIssuer.js.map +1 -1
- package/dist/functions/equityCompensationIssuance/createEquityCompensationIssuance.d.ts +2 -2
- package/dist/functions/equityCompensationIssuance/createEquityCompensationIssuance.d.ts.map +1 -1
- package/dist/functions/equityCompensationIssuance/createEquityCompensationIssuance.js +71 -59
- package/dist/functions/equityCompensationIssuance/createEquityCompensationIssuance.js.map +1 -1
- package/dist/functions/equityCompensationIssuance/getEquityCompensationIssuanceEventAsOcf.d.ts +1 -1
- package/dist/functions/equityCompensationIssuance/getEquityCompensationIssuanceEventAsOcf.d.ts.map +1 -1
- package/dist/functions/equityCompensationIssuance/getEquityCompensationIssuanceEventAsOcf.js +53 -31
- package/dist/functions/equityCompensationIssuance/getEquityCompensationIssuanceEventAsOcf.js.map +1 -1
- package/dist/functions/equityCompensationIssuance/index.d.ts +1 -1
- package/dist/functions/equityCompensationIssuance/index.d.ts.map +1 -1
- package/dist/functions/equityCompensationIssuance/index.js +1 -1
- package/dist/functions/equityCompensationIssuance/index.js.map +1 -1
- package/dist/functions/index.d.ts +13 -13
- package/dist/functions/index.d.ts.map +1 -1
- package/dist/functions/index.js +13 -13
- package/dist/functions/index.js.map +1 -1
- package/dist/functions/issuer/archiveIssuerByIssuer.d.ts +1 -1
- package/dist/functions/issuer/archiveIssuerByIssuer.d.ts.map +1 -1
- package/dist/functions/issuer/archiveIssuerByIssuer.js +2 -2
- package/dist/functions/issuer/archiveIssuerByIssuer.js.map +1 -1
- package/dist/functions/issuer/createIssuer.d.ts +15 -14
- package/dist/functions/issuer/createIssuer.d.ts.map +1 -1
- package/dist/functions/issuer/createIssuer.js +40 -24
- package/dist/functions/issuer/createIssuer.js.map +1 -1
- package/dist/functions/issuer/getIssuerAsOcf.d.ts +5 -4
- package/dist/functions/issuer/getIssuerAsOcf.d.ts.map +1 -1
- package/dist/functions/issuer/getIssuerAsOcf.js +36 -19
- package/dist/functions/issuer/getIssuerAsOcf.js.map +1 -1
- package/dist/functions/issuer/index.d.ts +1 -1
- package/dist/functions/issuer/index.d.ts.map +1 -1
- package/dist/functions/issuer/index.js +1 -1
- package/dist/functions/issuer/index.js.map +1 -1
- package/dist/functions/issuerAuthorization/authorizeIssuer.d.ts +4 -3
- package/dist/functions/issuerAuthorization/authorizeIssuer.d.ts.map +1 -1
- package/dist/functions/issuerAuthorization/authorizeIssuer.js +14 -12
- package/dist/functions/issuerAuthorization/authorizeIssuer.js.map +1 -1
- package/dist/functions/issuerAuthorization/withdrawAuthorization.d.ts +2 -2
- package/dist/functions/issuerAuthorization/withdrawAuthorization.d.ts.map +1 -1
- package/dist/functions/issuerAuthorization/withdrawAuthorization.js +11 -7
- package/dist/functions/issuerAuthorization/withdrawAuthorization.js.map +1 -1
- package/dist/functions/issuerAuthorizedSharesAdjustment/archiveIssuerAuthorizedSharesAdjustmentByIssuer.d.ts +1 -1
- package/dist/functions/issuerAuthorizedSharesAdjustment/archiveIssuerAuthorizedSharesAdjustmentByIssuer.d.ts.map +1 -1
- package/dist/functions/issuerAuthorizedSharesAdjustment/archiveIssuerAuthorizedSharesAdjustmentByIssuer.js +2 -2
- package/dist/functions/issuerAuthorizedSharesAdjustment/archiveIssuerAuthorizedSharesAdjustmentByIssuer.js.map +1 -1
- package/dist/functions/issuerAuthorizedSharesAdjustment/createIssuerAuthorizedSharesAdjustment.d.ts +3 -11
- package/dist/functions/issuerAuthorizedSharesAdjustment/createIssuerAuthorizedSharesAdjustment.d.ts.map +1 -1
- package/dist/functions/issuerAuthorizedSharesAdjustment/createIssuerAuthorizedSharesAdjustment.js +20 -12
- package/dist/functions/issuerAuthorizedSharesAdjustment/createIssuerAuthorizedSharesAdjustment.js.map +1 -1
- package/dist/functions/issuerAuthorizedSharesAdjustment/getIssuerAuthorizedSharesAdjustmentEventAsOcf.d.ts +1 -1
- package/dist/functions/issuerAuthorizedSharesAdjustment/getIssuerAuthorizedSharesAdjustmentEventAsOcf.d.ts.map +1 -1
- package/dist/functions/issuerAuthorizedSharesAdjustment/getIssuerAuthorizedSharesAdjustmentEventAsOcf.js +17 -5
- package/dist/functions/issuerAuthorizedSharesAdjustment/getIssuerAuthorizedSharesAdjustmentEventAsOcf.js.map +1 -1
- package/dist/functions/issuerAuthorizedSharesAdjustment/index.d.ts +1 -1
- package/dist/functions/issuerAuthorizedSharesAdjustment/index.d.ts.map +1 -1
- package/dist/functions/issuerAuthorizedSharesAdjustment/index.js +1 -1
- package/dist/functions/issuerAuthorizedSharesAdjustment/index.js.map +1 -1
- package/dist/functions/stakeholder/archiveStakeholderByIssuer.d.ts +1 -1
- package/dist/functions/stakeholder/archiveStakeholderByIssuer.d.ts.map +1 -1
- package/dist/functions/stakeholder/archiveStakeholderByIssuer.js +2 -2
- package/dist/functions/stakeholder/archiveStakeholderByIssuer.js.map +1 -1
- package/dist/functions/stakeholder/createStakeholder.d.ts +2 -2
- package/dist/functions/stakeholder/createStakeholder.d.ts.map +1 -1
- package/dist/functions/stakeholder/createStakeholder.js +90 -63
- package/dist/functions/stakeholder/createStakeholder.js.map +1 -1
- package/dist/functions/stakeholder/getStakeholderAsOcf.d.ts +2 -4
- package/dist/functions/stakeholder/getStakeholderAsOcf.d.ts.map +1 -1
- package/dist/functions/stakeholder/getStakeholderAsOcf.js +111 -76
- package/dist/functions/stakeholder/getStakeholderAsOcf.js.map +1 -1
- package/dist/functions/stakeholder/index.d.ts +1 -1
- package/dist/functions/stakeholder/index.d.ts.map +1 -1
- package/dist/functions/stakeholder/index.js +1 -1
- package/dist/functions/stakeholder/index.js.map +1 -1
- package/dist/functions/stockCancellation/archiveStockCancellationByIssuer.d.ts +1 -1
- package/dist/functions/stockCancellation/archiveStockCancellationByIssuer.d.ts.map +1 -1
- package/dist/functions/stockCancellation/archiveStockCancellationByIssuer.js +2 -2
- package/dist/functions/stockCancellation/archiveStockCancellationByIssuer.js.map +1 -1
- package/dist/functions/stockCancellation/createStockCancellation.d.ts +3 -11
- package/dist/functions/stockCancellation/createStockCancellation.d.ts.map +1 -1
- package/dist/functions/stockCancellation/createStockCancellation.js +20 -12
- package/dist/functions/stockCancellation/createStockCancellation.js.map +1 -1
- package/dist/functions/stockCancellation/getStockCancellationEventAsOcf.d.ts +1 -1
- package/dist/functions/stockCancellation/getStockCancellationEventAsOcf.d.ts.map +1 -1
- package/dist/functions/stockCancellation/getStockCancellationEventAsOcf.js +16 -4
- package/dist/functions/stockCancellation/getStockCancellationEventAsOcf.js.map +1 -1
- package/dist/functions/stockCancellation/index.d.ts +1 -1
- package/dist/functions/stockCancellation/index.d.ts.map +1 -1
- package/dist/functions/stockCancellation/index.js +1 -1
- package/dist/functions/stockCancellation/index.js.map +1 -1
- package/dist/functions/stockClass/archiveStockClassByIssuer.d.ts +1 -1
- package/dist/functions/stockClass/archiveStockClassByIssuer.d.ts.map +1 -1
- package/dist/functions/stockClass/archiveStockClassByIssuer.js +2 -2
- package/dist/functions/stockClass/archiveStockClassByIssuer.js.map +1 -1
- package/dist/functions/stockClass/createStockClass.d.ts +20 -16
- package/dist/functions/stockClass/createStockClass.d.ts.map +1 -1
- package/dist/functions/stockClass/createStockClass.js +73 -41
- package/dist/functions/stockClass/createStockClass.js.map +1 -1
- package/dist/functions/stockClass/getStockClassAsOcf.d.ts +36 -29
- package/dist/functions/stockClass/getStockClassAsOcf.d.ts.map +1 -1
- package/dist/functions/stockClass/getStockClassAsOcf.js +122 -67
- package/dist/functions/stockClass/getStockClassAsOcf.js.map +1 -1
- package/dist/functions/stockClass/index.d.ts +1 -1
- package/dist/functions/stockClass/index.d.ts.map +1 -1
- package/dist/functions/stockClass/index.js +1 -1
- package/dist/functions/stockClass/index.js.map +1 -1
- package/dist/functions/stockClassAuthorizedSharesAdjustment/archiveStockClassAuthorizedSharesAdjustmentByIssuer.d.ts +1 -1
- package/dist/functions/stockClassAuthorizedSharesAdjustment/archiveStockClassAuthorizedSharesAdjustmentByIssuer.d.ts.map +1 -1
- package/dist/functions/stockClassAuthorizedSharesAdjustment/archiveStockClassAuthorizedSharesAdjustmentByIssuer.js +2 -2
- package/dist/functions/stockClassAuthorizedSharesAdjustment/archiveStockClassAuthorizedSharesAdjustmentByIssuer.js.map +1 -1
- package/dist/functions/stockClassAuthorizedSharesAdjustment/createStockClassAuthorizedSharesAdjustment.d.ts +3 -11
- package/dist/functions/stockClassAuthorizedSharesAdjustment/createStockClassAuthorizedSharesAdjustment.d.ts.map +1 -1
- package/dist/functions/stockClassAuthorizedSharesAdjustment/createStockClassAuthorizedSharesAdjustment.js +20 -12
- package/dist/functions/stockClassAuthorizedSharesAdjustment/createStockClassAuthorizedSharesAdjustment.js.map +1 -1
- package/dist/functions/stockClassAuthorizedSharesAdjustment/getStockClassAuthorizedSharesAdjustmentEventAsOcf.d.ts +1 -1
- package/dist/functions/stockClassAuthorizedSharesAdjustment/getStockClassAuthorizedSharesAdjustmentEventAsOcf.d.ts.map +1 -1
- package/dist/functions/stockClassAuthorizedSharesAdjustment/getStockClassAuthorizedSharesAdjustmentEventAsOcf.js +11 -3
- package/dist/functions/stockClassAuthorizedSharesAdjustment/getStockClassAuthorizedSharesAdjustmentEventAsOcf.js.map +1 -1
- package/dist/functions/stockClassAuthorizedSharesAdjustment/index.d.ts +1 -1
- package/dist/functions/stockClassAuthorizedSharesAdjustment/index.d.ts.map +1 -1
- package/dist/functions/stockClassAuthorizedSharesAdjustment/index.js +1 -1
- package/dist/functions/stockClassAuthorizedSharesAdjustment/index.js.map +1 -1
- package/dist/functions/stockIssuance/archiveStockIssuanceByIssuer.d.ts +1 -1
- package/dist/functions/stockIssuance/archiveStockIssuanceByIssuer.d.ts.map +1 -1
- package/dist/functions/stockIssuance/archiveStockIssuanceByIssuer.js +2 -2
- package/dist/functions/stockIssuance/archiveStockIssuanceByIssuer.js.map +1 -1
- package/dist/functions/stockIssuance/createStockIssuance.d.ts +2 -2
- package/dist/functions/stockIssuance/createStockIssuance.d.ts.map +1 -1
- package/dist/functions/stockIssuance/createStockIssuance.js +49 -58
- package/dist/functions/stockIssuance/createStockIssuance.js.map +1 -1
- package/dist/functions/stockIssuance/getStockIssuanceAsOcf.d.ts +13 -5
- package/dist/functions/stockIssuance/getStockIssuanceAsOcf.d.ts.map +1 -1
- package/dist/functions/stockIssuance/getStockIssuanceAsOcf.js +44 -30
- package/dist/functions/stockIssuance/getStockIssuanceAsOcf.js.map +1 -1
- package/dist/functions/stockIssuance/index.d.ts +1 -1
- package/dist/functions/stockIssuance/index.d.ts.map +1 -1
- package/dist/functions/stockIssuance/index.js +1 -1
- package/dist/functions/stockIssuance/index.js.map +1 -1
- package/dist/functions/stockLegendTemplate/archiveStockLegendTemplateByIssuer.d.ts +1 -1
- package/dist/functions/stockLegendTemplate/archiveStockLegendTemplateByIssuer.d.ts.map +1 -1
- package/dist/functions/stockLegendTemplate/archiveStockLegendTemplateByIssuer.js +2 -2
- package/dist/functions/stockLegendTemplate/archiveStockLegendTemplateByIssuer.js.map +1 -1
- package/dist/functions/stockLegendTemplate/createStockLegendTemplate.d.ts +2 -2
- package/dist/functions/stockLegendTemplate/createStockLegendTemplate.d.ts.map +1 -1
- package/dist/functions/stockLegendTemplate/createStockLegendTemplate.js +7 -6
- package/dist/functions/stockLegendTemplate/createStockLegendTemplate.js.map +1 -1
- package/dist/functions/stockLegendTemplate/getStockLegendTemplateAsOcf.d.ts +1 -1
- package/dist/functions/stockLegendTemplate/getStockLegendTemplateAsOcf.d.ts.map +1 -1
- package/dist/functions/stockLegendTemplate/getStockLegendTemplateAsOcf.js +11 -9
- package/dist/functions/stockLegendTemplate/getStockLegendTemplateAsOcf.js.map +1 -1
- package/dist/functions/stockLegendTemplate/index.d.ts +1 -1
- package/dist/functions/stockLegendTemplate/index.d.ts.map +1 -1
- package/dist/functions/stockLegendTemplate/index.js +1 -1
- package/dist/functions/stockLegendTemplate/index.js.map +1 -1
- package/dist/functions/stockPlan/archiveStockPlanByIssuer.d.ts +1 -1
- package/dist/functions/stockPlan/archiveStockPlanByIssuer.d.ts.map +1 -1
- package/dist/functions/stockPlan/archiveStockPlanByIssuer.js +2 -2
- package/dist/functions/stockPlan/archiveStockPlanByIssuer.js.map +1 -1
- package/dist/functions/stockPlan/createStockPlan.d.ts +2 -2
- package/dist/functions/stockPlan/createStockPlan.d.ts.map +1 -1
- package/dist/functions/stockPlan/createStockPlan.js +16 -11
- package/dist/functions/stockPlan/createStockPlan.js.map +1 -1
- package/dist/functions/stockPlan/getStockPlanAsOcf.d.ts +2 -1
- package/dist/functions/stockPlan/getStockPlanAsOcf.d.ts.map +1 -1
- package/dist/functions/stockPlan/getStockPlanAsOcf.js +29 -18
- package/dist/functions/stockPlan/getStockPlanAsOcf.js.map +1 -1
- package/dist/functions/stockPlan/index.d.ts +1 -1
- package/dist/functions/stockPlan/index.d.ts.map +1 -1
- package/dist/functions/stockPlan/index.js +1 -1
- package/dist/functions/stockPlan/index.js.map +1 -1
- package/dist/functions/stockPlanPoolAdjustment/archiveStockPlanPoolAdjustmentByIssuer.d.ts +1 -1
- package/dist/functions/stockPlanPoolAdjustment/archiveStockPlanPoolAdjustmentByIssuer.d.ts.map +1 -1
- package/dist/functions/stockPlanPoolAdjustment/archiveStockPlanPoolAdjustmentByIssuer.js +2 -2
- package/dist/functions/stockPlanPoolAdjustment/archiveStockPlanPoolAdjustmentByIssuer.js.map +1 -1
- package/dist/functions/stockPlanPoolAdjustment/createStockPlanPoolAdjustment.d.ts +3 -11
- package/dist/functions/stockPlanPoolAdjustment/createStockPlanPoolAdjustment.d.ts.map +1 -1
- package/dist/functions/stockPlanPoolAdjustment/createStockPlanPoolAdjustment.js +20 -12
- package/dist/functions/stockPlanPoolAdjustment/createStockPlanPoolAdjustment.js.map +1 -1
- package/dist/functions/stockPlanPoolAdjustment/getStockPlanPoolAdjustmentEventAsOcf.d.ts +1 -1
- package/dist/functions/stockPlanPoolAdjustment/getStockPlanPoolAdjustmentEventAsOcf.d.ts.map +1 -1
- package/dist/functions/stockPlanPoolAdjustment/getStockPlanPoolAdjustmentEventAsOcf.js +11 -3
- package/dist/functions/stockPlanPoolAdjustment/getStockPlanPoolAdjustmentEventAsOcf.js.map +1 -1
- package/dist/functions/stockPlanPoolAdjustment/index.d.ts +1 -1
- package/dist/functions/stockPlanPoolAdjustment/index.d.ts.map +1 -1
- package/dist/functions/stockPlanPoolAdjustment/index.js +1 -1
- package/dist/functions/stockPlanPoolAdjustment/index.js.map +1 -1
- package/dist/functions/vestingTerms/archiveVestingTermsByIssuer.d.ts +1 -1
- package/dist/functions/vestingTerms/archiveVestingTermsByIssuer.d.ts.map +1 -1
- package/dist/functions/vestingTerms/archiveVestingTermsByIssuer.js +2 -2
- package/dist/functions/vestingTerms/archiveVestingTermsByIssuer.js.map +1 -1
- package/dist/functions/vestingTerms/createVestingTerms.d.ts +3 -2
- package/dist/functions/vestingTerms/createVestingTerms.d.ts.map +1 -1
- package/dist/functions/vestingTerms/createVestingTerms.js +137 -50
- package/dist/functions/vestingTerms/createVestingTerms.js.map +1 -1
- package/dist/functions/vestingTerms/getVestingTermsAsOcf.d.ts +4 -2
- package/dist/functions/vestingTerms/getVestingTermsAsOcf.d.ts.map +1 -1
- package/dist/functions/vestingTerms/getVestingTermsAsOcf.js +98 -45
- package/dist/functions/vestingTerms/getVestingTermsAsOcf.js.map +1 -1
- package/dist/functions/vestingTerms/index.d.ts +1 -1
- package/dist/functions/vestingTerms/index.d.ts.map +1 -1
- package/dist/functions/vestingTerms/index.js +1 -1
- package/dist/functions/vestingTerms/index.js.map +1 -1
- package/dist/functions/warrantIssuance/archiveWarrantIssuanceByIssuer.d.ts +1 -1
- package/dist/functions/warrantIssuance/archiveWarrantIssuanceByIssuer.d.ts.map +1 -1
- package/dist/functions/warrantIssuance/archiveWarrantIssuanceByIssuer.js +2 -2
- package/dist/functions/warrantIssuance/archiveWarrantIssuanceByIssuer.js.map +1 -1
- package/dist/functions/warrantIssuance/createWarrantIssuance.d.ts +2 -2
- package/dist/functions/warrantIssuance/createWarrantIssuance.d.ts.map +1 -1
- package/dist/functions/warrantIssuance/createWarrantIssuance.js +56 -43
- package/dist/functions/warrantIssuance/createWarrantIssuance.js.map +1 -1
- package/dist/functions/warrantIssuance/getWarrantIssuanceAsOcf.d.ts +17 -17
- package/dist/functions/warrantIssuance/getWarrantIssuanceAsOcf.d.ts.map +1 -1
- package/dist/functions/warrantIssuance/getWarrantIssuanceAsOcf.js +100 -48
- package/dist/functions/warrantIssuance/getWarrantIssuanceAsOcf.js.map +1 -1
- package/dist/functions/warrantIssuance/index.d.ts +1 -1
- package/dist/functions/warrantIssuance/index.d.ts.map +1 -1
- package/dist/functions/warrantIssuance/index.js +1 -1
- package/dist/functions/warrantIssuance/index.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/types/index.d.ts +3 -3
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/native.d.ts +214 -135
- package/dist/types/native.d.ts.map +1 -1
- package/dist/types/native.js +2 -3
- package/dist/types/native.js.map +1 -1
- package/dist/utils/createOcfObject.d.ts +30 -32
- package/dist/utils/createOcfObject.d.ts.map +1 -1
- package/dist/utils/createOcfObject.js +53 -41
- package/dist/utils/createOcfObject.js.map +1 -1
- package/dist/utils/index.d.ts +4 -1
- package/dist/utils/index.d.ts.map +1 -1
- package/dist/utils/index.js +5 -0
- package/dist/utils/index.js.map +1 -1
- package/dist/utils/ocfMetadata.d.ts +19 -0
- package/dist/utils/ocfMetadata.d.ts.map +1 -0
- package/dist/utils/ocfMetadata.js +83 -0
- package/dist/utils/ocfMetadata.js.map +1 -0
- package/dist/utils/transactionHelpers.d.ts +58 -0
- package/dist/utils/transactionHelpers.d.ts.map +1 -0
- package/dist/utils/transactionHelpers.js +121 -0
- package/dist/utils/transactionHelpers.js.map +1 -0
- package/dist/utils/typeConversions.d.ts +32 -11
- package/dist/utils/typeConversions.d.ts.map +1 -1
- package/dist/utils/typeConversions.js +97 -22
- package/dist/utils/typeConversions.js.map +1 -1
- package/package.json +27 -12
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { DisclosedContract } from '@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/schemas/api/commands';
|
|
2
|
-
import {
|
|
1
|
+
import type { DisclosedContract } from '@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/schemas/api/commands';
|
|
2
|
+
import type { CommandWithDisclosedContracts, OcfStockClassData } from '../../types';
|
|
3
3
|
export interface CreateStockClassParams {
|
|
4
4
|
/** Contract ID of the Issuer contract */
|
|
5
5
|
issuerContractId: string;
|
|
@@ -11,20 +11,24 @@ export interface CreateStockClassParams {
|
|
|
11
11
|
* Stock class data to create
|
|
12
12
|
*
|
|
13
13
|
* Schema: https://schema.opencaptablecoalition.com/v/1.2.0/objects/StockClass.schema.json
|
|
14
|
-
*
|
|
15
|
-
* -
|
|
16
|
-
* -
|
|
17
|
-
* -
|
|
18
|
-
*
|
|
19
|
-
* -
|
|
20
|
-
* -
|
|
21
|
-
* -
|
|
22
|
-
* -
|
|
23
|
-
* -
|
|
24
|
-
* -
|
|
25
|
-
* -
|
|
26
|
-
*
|
|
27
|
-
*
|
|
14
|
+
*
|
|
15
|
+
* - Name: Name for the stock type (e.g. Series A Preferred or Class A Common)
|
|
16
|
+
* - Class_type: The type of this stock class (e.g. Preferred or Common)
|
|
17
|
+
* - Default_id_prefix: Default prefix for certificate numbers in certificated shares (e.g. CS- in CS-1). If certificate
|
|
18
|
+
* IDs have a dash, the prefix should end in the dash like CS-
|
|
19
|
+
* - Initial_shares_authorized: The initial number of shares authorized for this stock class
|
|
20
|
+
* - Board_approval_date (optional): Date on which the board approved the stock class (YYYY-MM-DD)
|
|
21
|
+
* - Stockholder_approval_date (optional): Date on which the stockholders approved the stock class (YYYY-MM-DD)
|
|
22
|
+
* - Votes_per_share: The number of votes each share of this stock class gets
|
|
23
|
+
* - Par_value (optional): Per-share par value of this stock class
|
|
24
|
+
* - Price_per_share (optional): Per-share price this stock class was issued for
|
|
25
|
+
* - Seniority: Seniority of the stock - determines repayment priority. Seniority is ordered by increasing number so
|
|
26
|
+
* that stock classes with a higher seniority have higher repayment priority. Multiple stock classes can share the
|
|
27
|
+
* same seniority.
|
|
28
|
+
* - Conversion_rights (optional): List of stock class conversion rights possible for this stock class
|
|
29
|
+
* - Liquidation_preference_multiple (optional): The liquidation preference per share for this stock class
|
|
30
|
+
* - Participation_cap_multiple (optional): The participation cap multiple per share for this stock class
|
|
31
|
+
* - Comments (optional): Additional comments or notes about the stock class
|
|
28
32
|
*/
|
|
29
33
|
stockClassData: OcfStockClassData;
|
|
30
34
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createStockClass.d.ts","sourceRoot":"","sources":["../../../src/functions/stockClass/createStockClass.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"createStockClass.d.ts","sourceRoot":"","sources":["../../../src/functions/stockClass/createStockClass.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,iBAAiB,EAClB,MAAM,kFAAkF,CAAC;AAE1F,OAAO,KAAK,EAAE,6BAA6B,EAAE,iBAAiB,EAAkB,MAAM,aAAa,CAAC;AA0IpG,MAAM,WAAW,sBAAsB;IACrC,yCAAyC;IACzC,gBAAgB,EAAE,MAAM,CAAC;IACzB,uEAAuE;IACvE,+BAA+B,EAAE,iBAAiB,CAAC;IACnD,4CAA4C;IAC5C,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,cAAc,EAAE,iBAAiB,CAAC;CACnC;AAED,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,sBAAsB,GAAG,6BAA6B,CAwB1G"}
|
|
@@ -9,30 +9,31 @@ function stockClassTypeToDaml(stockClassType) {
|
|
|
9
9
|
return 'OcfStockClassTypePreferred';
|
|
10
10
|
case 'COMMON':
|
|
11
11
|
return 'OcfStockClassTypeCommon';
|
|
12
|
-
default:
|
|
13
|
-
|
|
12
|
+
default: {
|
|
13
|
+
const exhaustiveCheck = stockClassType;
|
|
14
|
+
throw new Error(`Unknown stock class type: ${String(exhaustiveCheck)}`);
|
|
15
|
+
}
|
|
14
16
|
}
|
|
15
17
|
}
|
|
16
18
|
function stockClassDataToDaml(stockClassData) {
|
|
17
|
-
|
|
19
|
+
const d = stockClassData;
|
|
20
|
+
if (!d.id)
|
|
18
21
|
throw new Error('stockClassData.id is required');
|
|
19
22
|
return {
|
|
20
|
-
id:
|
|
21
|
-
name:
|
|
22
|
-
class_type: stockClassTypeToDaml(
|
|
23
|
-
default_id_prefix:
|
|
24
|
-
initial_shares_authorized: typeof
|
|
25
|
-
?
|
|
26
|
-
:
|
|
27
|
-
votes_per_share: typeof
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
price_per_share: stockClassData.price_per_share ? (0, typeConversions_1.monetaryToDaml)(stockClassData.price_per_share) : null,
|
|
35
|
-
conversion_rights: (stockClassData.conversion_rights || []).map((right) => {
|
|
23
|
+
id: d.id,
|
|
24
|
+
name: d.name,
|
|
25
|
+
class_type: stockClassTypeToDaml(d.class_type),
|
|
26
|
+
default_id_prefix: d.default_id_prefix,
|
|
27
|
+
initial_shares_authorized: typeof d.initial_shares_authorized === 'number'
|
|
28
|
+
? d.initial_shares_authorized.toString()
|
|
29
|
+
: d.initial_shares_authorized,
|
|
30
|
+
votes_per_share: typeof d.votes_per_share === 'number' ? d.votes_per_share.toString() : d.votes_per_share,
|
|
31
|
+
seniority: typeof d.seniority === 'number' ? d.seniority.toString() : d.seniority,
|
|
32
|
+
board_approval_date: d.board_approval_date ? (0, typeConversions_1.dateStringToDAMLTime)(d.board_approval_date) : null,
|
|
33
|
+
stockholder_approval_date: d.stockholder_approval_date ? (0, typeConversions_1.dateStringToDAMLTime)(d.stockholder_approval_date) : null,
|
|
34
|
+
par_value: d.par_value ? (0, typeConversions_1.monetaryToDaml)(d.par_value) : null,
|
|
35
|
+
price_per_share: d.price_per_share ? (0, typeConversions_1.monetaryToDaml)(d.price_per_share) : null,
|
|
36
|
+
conversion_rights: (d.conversion_rights ?? []).map((right) => {
|
|
36
37
|
const mechanism = right.conversion_mechanism === 'RATIO_CONVERSION'
|
|
37
38
|
? 'OcfConversionMechanismRatioConversion'
|
|
38
39
|
: right.conversion_mechanism === 'PERCENT_CONVERSION'
|
|
@@ -55,10 +56,13 @@ function stockClassDataToDaml(stockClassData) {
|
|
|
55
56
|
}
|
|
56
57
|
})();
|
|
57
58
|
let ratio = null;
|
|
58
|
-
const numerator = right.ratio_numerator ??
|
|
59
|
+
const numerator = right.ratio_numerator ?? right.ratio;
|
|
59
60
|
const denominator = right.ratio_denominator ?? (right.ratio !== undefined ? 1 : undefined);
|
|
60
61
|
if (numerator !== undefined && denominator !== undefined) {
|
|
61
|
-
ratio = {
|
|
62
|
+
ratio = {
|
|
63
|
+
numerator: typeof numerator === 'number' ? numerator.toString() : String(numerator),
|
|
64
|
+
denominator: typeof denominator === 'number' ? denominator.toString() : String(denominator),
|
|
65
|
+
};
|
|
62
66
|
}
|
|
63
67
|
return {
|
|
64
68
|
type_: right.type,
|
|
@@ -66,46 +70,74 @@ function stockClassDataToDaml(stockClassData) {
|
|
|
66
70
|
conversion_trigger: trigger,
|
|
67
71
|
converts_to_stock_class_id: right.converts_to_stock_class_id,
|
|
68
72
|
ratio: ratio ? { tag: 'Some', value: ratio } : null,
|
|
69
|
-
percent_of_capitalization: right.percent_of_capitalization !== undefined
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
73
|
+
percent_of_capitalization: right.percent_of_capitalization !== undefined
|
|
74
|
+
? {
|
|
75
|
+
tag: 'Some',
|
|
76
|
+
value: typeof right.percent_of_capitalization === 'number'
|
|
77
|
+
? right.percent_of_capitalization.toString()
|
|
78
|
+
: String(right.percent_of_capitalization),
|
|
79
|
+
}
|
|
80
|
+
: null,
|
|
81
|
+
conversion_price: right.conversion_price
|
|
82
|
+
? { tag: 'Some', value: (0, typeConversions_1.monetaryToDaml)(right.conversion_price) }
|
|
83
|
+
: null,
|
|
84
|
+
reference_share_price: right.reference_share_price
|
|
85
|
+
? { tag: 'Some', value: (0, typeConversions_1.monetaryToDaml)(right.reference_share_price) }
|
|
86
|
+
: null,
|
|
87
|
+
reference_valuation_price_per_share: right.reference_valuation_price_per_share
|
|
88
|
+
? { tag: 'Some', value: (0, typeConversions_1.monetaryToDaml)(right.reference_valuation_price_per_share) }
|
|
89
|
+
: null,
|
|
90
|
+
discount_rate: right.discount_rate !== undefined
|
|
91
|
+
? {
|
|
92
|
+
tag: 'Some',
|
|
93
|
+
value: typeof right.discount_rate === 'number'
|
|
94
|
+
? right.discount_rate.toString()
|
|
95
|
+
: String(right.discount_rate),
|
|
96
|
+
}
|
|
97
|
+
: null,
|
|
74
98
|
valuation_cap: right.valuation_cap ? { tag: 'Some', value: (0, typeConversions_1.monetaryToDaml)(right.valuation_cap) } : null,
|
|
75
|
-
floor_price_per_share: right.floor_price_per_share
|
|
76
|
-
|
|
99
|
+
floor_price_per_share: right.floor_price_per_share
|
|
100
|
+
? { tag: 'Some', value: (0, typeConversions_1.monetaryToDaml)(right.floor_price_per_share) }
|
|
101
|
+
: null,
|
|
102
|
+
ceiling_price_per_share: right.ceiling_price_per_share
|
|
103
|
+
? { tag: 'Some', value: (0, typeConversions_1.monetaryToDaml)(right.ceiling_price_per_share) }
|
|
104
|
+
: null,
|
|
77
105
|
custom_description: right.custom_description ? { tag: 'Some', value: right.custom_description } : null,
|
|
78
|
-
expires_at: right.expires_at ? (0, typeConversions_1.dateStringToDAMLTime)(right.expires_at) : null
|
|
106
|
+
expires_at: right.expires_at ? (0, typeConversions_1.dateStringToDAMLTime)(right.expires_at) : null,
|
|
79
107
|
};
|
|
80
108
|
}),
|
|
81
|
-
liquidation_preference_multiple:
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
109
|
+
liquidation_preference_multiple: d.liquidation_preference_multiple
|
|
110
|
+
? typeof d.liquidation_preference_multiple === 'number'
|
|
111
|
+
? d.liquidation_preference_multiple.toString()
|
|
112
|
+
: d.liquidation_preference_multiple
|
|
113
|
+
: null,
|
|
114
|
+
participation_cap_multiple: d.participation_cap_multiple
|
|
115
|
+
? typeof d.participation_cap_multiple === 'number'
|
|
116
|
+
? d.participation_cap_multiple.toString()
|
|
117
|
+
: d.participation_cap_multiple
|
|
118
|
+
: null,
|
|
119
|
+
comments: (0, typeConversions_1.cleanComments)(d.comments),
|
|
88
120
|
};
|
|
89
121
|
}
|
|
90
122
|
function buildCreateStockClassCommand(params) {
|
|
91
123
|
const choiceArguments = {
|
|
92
|
-
stock_class_data: stockClassDataToDaml(params.stockClassData)
|
|
124
|
+
stock_class_data: stockClassDataToDaml(params.stockClassData),
|
|
93
125
|
};
|
|
94
126
|
const command = {
|
|
95
127
|
ExerciseCommand: {
|
|
96
128
|
templateId: open_captable_protocol_daml_js_1.Fairmint.OpenCapTable.Issuer.Issuer.templateId,
|
|
97
129
|
contractId: params.issuerContractId,
|
|
98
130
|
choice: 'CreateStockClass',
|
|
99
|
-
choiceArgument: choiceArguments
|
|
100
|
-
}
|
|
131
|
+
choiceArgument: choiceArguments,
|
|
132
|
+
},
|
|
101
133
|
};
|
|
102
134
|
const disclosedContracts = [
|
|
103
135
|
{
|
|
104
136
|
templateId: params.featuredAppRightContractDetails.templateId,
|
|
105
137
|
contractId: params.featuredAppRightContractDetails.contractId,
|
|
106
138
|
createdEventBlob: params.featuredAppRightContractDetails.createdEventBlob,
|
|
107
|
-
synchronizerId: params.featuredAppRightContractDetails.synchronizerId
|
|
108
|
-
}
|
|
139
|
+
synchronizerId: params.featuredAppRightContractDetails.synchronizerId,
|
|
140
|
+
},
|
|
109
141
|
];
|
|
110
142
|
return { command, disclosedContracts };
|
|
111
143
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createStockClass.js","sourceRoot":"","sources":["../../../src/functions/stockClass/createStockClass.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"createStockClass.js","sourceRoot":"","sources":["../../../src/functions/stockClass/createStockClass.ts"],"names":[],"mappings":";;AAgLA,oEAwBC;AApMD,6FAAoE;AAEpE,iEAAkG;AAElG,SAAS,oBAAoB,CAC3B,cAA8B;IAE9B,QAAQ,cAAc,EAAE,CAAC;QACvB,KAAK,WAAW;YACd,OAAO,4BAA4B,CAAC;QACtC,KAAK,QAAQ;YACX,OAAO,yBAAyB,CAAC;QACnC,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,eAAe,GAAU,cAAc,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,6BAA6B,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QAC1E,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,oBAAoB,CAAC,cAAiC;IAC7D,MAAM,CAAC,GAAG,cAAc,CAAC;IACzB,IAAI,CAAC,CAAC,CAAC,EAAE;QAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAC5D,OAAO;QACL,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,UAAU,EAAE,oBAAoB,CAAC,CAAC,CAAC,UAAU,CAAC;QAC9C,iBAAiB,EAAE,CAAC,CAAC,iBAAiB;QACtC,yBAAyB,EACvB,OAAO,CAAC,CAAC,yBAAyB,KAAK,QAAQ;YAC7C,CAAC,CAAC,CAAC,CAAC,yBAAyB,CAAC,QAAQ,EAAE;YACxC,CAAC,CAAC,CAAC,CAAC,yBAAyB;QACjC,eAAe,EAAE,OAAO,CAAC,CAAC,eAAe,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe;QACzG,SAAS,EAAE,OAAO,CAAC,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;QACjF,mBAAmB,EAAE,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAA,sCAAoB,EAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,IAAI;QAC/F,yBAAyB,EAAE,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,IAAA,sCAAoB,EAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,IAAI;QACjH,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,gCAAc,EAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI;QAC3D,eAAe,EAAE,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,IAAA,gCAAc,EAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI;QAC7E,iBAAiB,EAAE,CAAC,CAAC,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3D,MAAM,SAAS,GAIb,KAAK,CAAC,oBAAoB,KAAK,kBAAkB;gBAC/C,CAAC,CAAC,uCAAuC;gBACzC,CAAC,CAAC,KAAK,CAAC,oBAAoB,KAAK,oBAAoB;oBACnD,CAAC,CAAC,uDAAuD;oBACzD,CAAC,CAAC,6CAA6C,CAAC;YAEtD,MAAM,OAAO,GAI6B,CAAC,GAAG,EAAE;gBAC9C,QAAQ,KAAK,CAAC,kBAAkB,EAAE,CAAC;oBACjC,KAAK,wBAAwB;wBAC3B,OAAO,oCAAoC,CAAC;oBAC9C,KAAK,mBAAmB;wBACtB,OAAO,+BAA+B,CAAC;oBACzC,KAAK,kBAAkB;wBACrB,OAAO,8BAA8B,CAAC;oBACxC,KAAK,uBAAuB;wBAC1B,OAAO,mCAAmC,CAAC;oBAC7C,KAAK,kBAAkB;wBACrB,OAAO,8BAA8B,CAAC;oBACxC;wBACE,OAAO,oCAAoC,CAAC;gBAChD,CAAC;YACH,CAAC,CAAC,EAAE,CAAC;YAEL,IAAI,KAAK,GAAsD,IAAI,CAAC;YACpE,MAAM,SAAS,GAAG,KAAK,CAAC,eAAe,IAAI,KAAK,CAAC,KAAK,CAAC;YACvD,MAAM,WAAW,GAAG,KAAK,CAAC,iBAAiB,IAAI,CAAC,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;YAC3F,IAAI,SAAS,KAAK,SAAS,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBACzD,KAAK,GAAG;oBACN,SAAS,EAAE,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC;oBACnF,WAAW,EAAE,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC;iBAC5F,CAAC;YACJ,CAAC;YAED,OAAO;gBACL,KAAK,EAAE,KAAK,CAAC,IAAI;gBACjB,oBAAoB,EAAE,SAAS;gBAC/B,kBAAkB,EAAE,OAAO;gBAC3B,0BAA0B,EAAE,KAAK,CAAC,0BAA0B;gBAC5D,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI;gBACnD,yBAAyB,EACvB,KAAK,CAAC,yBAAyB,KAAK,SAAS;oBAC3C,CAAC,CAAC;wBACE,GAAG,EAAE,MAAM;wBACX,KAAK,EACH,OAAO,KAAK,CAAC,yBAAyB,KAAK,QAAQ;4BACjD,CAAC,CAAC,KAAK,CAAC,yBAAyB,CAAC,QAAQ,EAAE;4BAC5C,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC;qBAC9C;oBACH,CAAC,CAAC,IAAI;gBACV,gBAAgB,EAAE,KAAK,CAAC,gBAAgB;oBACtC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,gCAAc,EAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE;oBAChE,CAAC,CAAC,IAAI;gBACR,qBAAqB,EAAE,KAAK,CAAC,qBAAqB;oBAChD,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,gCAAc,EAAC,KAAK,CAAC,qBAAqB,CAAC,EAAE;oBACrE,CAAC,CAAC,IAAI;gBACR,mCAAmC,EAAE,KAAK,CAAC,mCAAmC;oBAC5E,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,gCAAc,EAAC,KAAK,CAAC,mCAAmC,CAAC,EAAE;oBACnF,CAAC,CAAC,IAAI;gBACR,aAAa,EACX,KAAK,CAAC,aAAa,KAAK,SAAS;oBAC/B,CAAC,CAAC;wBACE,GAAG,EAAE,MAAM;wBACX,KAAK,EACH,OAAO,KAAK,CAAC,aAAa,KAAK,QAAQ;4BACrC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,EAAE;4BAChC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC;qBAClC;oBACH,CAAC,CAAC,IAAI;gBACV,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,gCAAc,EAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI;gBACvG,qBAAqB,EAAE,KAAK,CAAC,qBAAqB;oBAChD,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,gCAAc,EAAC,KAAK,CAAC,qBAAqB,CAAC,EAAE;oBACrE,CAAC,CAAC,IAAI;gBACR,uBAAuB,EAAE,KAAK,CAAC,uBAAuB;oBACpD,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,IAAA,gCAAc,EAAC,KAAK,CAAC,uBAAuB,CAAC,EAAE;oBACvE,CAAC,CAAC,IAAI;gBACR,kBAAkB,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC,IAAI;gBACtG,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,IAAA,sCAAoB,EAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI;aAC7E,CAAC;QACJ,CAAC,CAAC;QACF,+BAA+B,EAAE,CAAC,CAAC,+BAA+B;YAChE,CAAC,CAAC,OAAO,CAAC,CAAC,+BAA+B,KAAK,QAAQ;gBACrD,CAAC,CAAC,CAAC,CAAC,+BAA+B,CAAC,QAAQ,EAAE;gBAC9C,CAAC,CAAC,CAAC,CAAC,+BAA+B;YACrC,CAAC,CAAC,IAAI;QACR,0BAA0B,EAAE,CAAC,CAAC,0BAA0B;YACtD,CAAC,CAAC,OAAO,CAAC,CAAC,0BAA0B,KAAK,QAAQ;gBAChD,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC,QAAQ,EAAE;gBACzC,CAAC,CAAC,CAAC,CAAC,0BAA0B;YAChC,CAAC,CAAC,IAAI;QACR,QAAQ,EAAE,IAAA,+BAAa,EAAC,CAAC,CAAC,QAAQ,CAAC;KACpC,CAAC;AACJ,CAAC;AAmCD,SAAgB,4BAA4B,CAAC,MAA8B;IACzE,MAAM,eAAe,GAAG;QACtB,gBAAgB,EAAE,oBAAoB,CAAC,MAAM,CAAC,cAAc,CAAC;KAC9D,CAAC;IAEF,MAAM,OAAO,GAAY;QACvB,eAAe,EAAE;YACf,UAAU,EAAE,yCAAQ,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU;YAC1D,UAAU,EAAE,MAAM,CAAC,gBAAgB;YACnC,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,eAAe;SAChC;KACF,CAAC;IAEF,MAAM,kBAAkB,GAAwB;QAC9C;YACE,UAAU,EAAE,MAAM,CAAC,+BAA+B,CAAC,UAAU;YAC7D,UAAU,EAAE,MAAM,CAAC,+BAA+B,CAAC,UAAU;YAC7D,gBAAgB,EAAE,MAAM,CAAC,+BAA+B,CAAC,gBAAgB;YACzE,cAAc,EAAE,MAAM,CAAC,+BAA+B,CAAC,cAAc;SACtE;KACF,CAAC;IAEF,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC;AACzC,CAAC"}
|
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
import { LedgerJsonApiClient } from '@fairmint/canton-node-sdk';
|
|
1
|
+
import type { LedgerJsonApiClient } from '@fairmint/canton-node-sdk';
|
|
2
2
|
/**
|
|
3
|
-
* OCF Stock Class object according to the Open Cap Table Coalition schema
|
|
4
|
-
*
|
|
3
|
+
* OCF Stock Class object according to the Open Cap Table Coalition schema Object describing a class of stock issued by
|
|
4
|
+
* the issuer
|
|
5
|
+
*
|
|
5
6
|
* @see https://schema.opencaptablecoalition.com/v/1.2.0/objects/StockClass.schema.json
|
|
6
7
|
*/
|
|
7
8
|
export interface OcfStockClass {
|
|
@@ -11,7 +12,10 @@ export interface OcfStockClass {
|
|
|
11
12
|
name: string;
|
|
12
13
|
/** The type of this stock class (e.g. Preferred or Common) */
|
|
13
14
|
class_type: 'PREFERRED' | 'COMMON';
|
|
14
|
-
/**
|
|
15
|
+
/**
|
|
16
|
+
* Default prefix for certificate numbers in certificated shares (e.g. CS- in CS-1). If certificate IDs have a dash,
|
|
17
|
+
* the prefix should end in the dash like CS-
|
|
18
|
+
*/
|
|
15
19
|
default_id_prefix: string;
|
|
16
20
|
/** The initial number of shares authorized for this stock class */
|
|
17
21
|
initial_shares_authorized: string | number;
|
|
@@ -36,10 +40,14 @@ export interface OcfStockClass {
|
|
|
36
40
|
currency: string;
|
|
37
41
|
};
|
|
38
42
|
/**
|
|
39
|
-
* Seniority of the stock - determines repayment priority. Seniority is ordered by increasing number so that stock
|
|
40
|
-
* a
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
+
* Seniority of the stock - determines repayment priority. Seniority is ordered by increasing number so that stock
|
|
44
|
+
* classes with a higher seniority have higher repayment priority. The following properties hold for all stock classes
|
|
45
|
+
* for a given company: a) transitivity: stock classes are absolutely stackable by seniority and in increasing
|
|
46
|
+
* numerical order, b) non-uniqueness: multiple stock classes can have the same Seniority number and therefore have
|
|
47
|
+
* the same liquidation/repayment order. In practice, stock classes with same seniority may be created at different
|
|
48
|
+
* points in time and (for example, an extension of an existing preferred financing round), and also a new stock class
|
|
49
|
+
* can be created with seniority between two existing stock classes, in which case it is assigned some decimal number
|
|
50
|
+
* between the numbers representing seniority of the respective classes.
|
|
43
51
|
*/
|
|
44
52
|
seniority: string | number;
|
|
45
53
|
/** List of stock class conversion rights possible for this stock class */
|
|
@@ -47,7 +55,7 @@ export interface OcfStockClass {
|
|
|
47
55
|
/** The type of conversion right */
|
|
48
56
|
conversion_mechanism: string;
|
|
49
57
|
/** Additional conversion right details */
|
|
50
|
-
[key: string]:
|
|
58
|
+
[key: string]: unknown;
|
|
51
59
|
}>;
|
|
52
60
|
/** The liquidation preference per share for this stock class */
|
|
53
61
|
liquidation_preference_multiple?: string | number;
|
|
@@ -71,33 +79,32 @@ export interface GetStockClassAsOcfResult {
|
|
|
71
79
|
/**
|
|
72
80
|
* Retrieve a stock class contract by ID and return it as an OCF JSON object
|
|
73
81
|
*
|
|
74
|
-
* This function fetches the stock class contract data from the ledger and transforms it
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
* @see https://schema.opencaptablecoalition.com/v/1.2.0/objects/StockClass.schema.json
|
|
82
|
+
* This function fetches the stock class contract data from the ledger and transforms it into the Open Cap Table
|
|
83
|
+
* Coalition (OCF) format according to the official schema.
|
|
78
84
|
*
|
|
79
85
|
* @example
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
*
|
|
83
|
-
*
|
|
86
|
+
* ```typescript
|
|
87
|
+
* const result = await getStockClassAsOcf(client, {
|
|
88
|
+
* contractId: "1234567890abcdef"
|
|
89
|
+
* });
|
|
84
90
|
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
*
|
|
91
|
+
* console.log(result.stockClass);
|
|
92
|
+
* // {
|
|
93
|
+
* // object_type: "STOCK_CLASS",
|
|
94
|
+
* // name: "Series A Preferred",
|
|
95
|
+
* // class_type: "PREFERRED",
|
|
96
|
+
* // default_id_prefix: "SA-",
|
|
97
|
+
* // initial_shares_authorized: "1000000",
|
|
98
|
+
* // votes_per_share: "1",
|
|
99
|
+
* // seniority: "1",
|
|
100
|
+
* // // ... other fields
|
|
101
|
+
* // }
|
|
102
|
+
* ```;
|
|
97
103
|
*
|
|
98
104
|
* @param client - The ledger JSON API client
|
|
99
105
|
* @param params - Parameters for retrieving the stock class
|
|
100
106
|
* @returns Promise resolving to the OCF StockClass object
|
|
107
|
+
* @see https://schema.opencaptablecoalition.com/v/1.2.0/objects/StockClass.schema.json
|
|
101
108
|
*/
|
|
102
109
|
export declare function getStockClassAsOcf(client: LedgerJsonApiClient, params: GetStockClassAsOcfParams): Promise<GetStockClassAsOcfResult>;
|
|
103
110
|
//# sourceMappingURL=getStockClassAsOcf.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getStockClassAsOcf.d.ts","sourceRoot":"","sources":["../../../src/functions/stockClass/getStockClassAsOcf.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"getStockClassAsOcf.d.ts","sourceRoot":"","sources":["../../../src/functions/stockClass/getStockClassAsOcf.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAuOrE;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,qDAAqD;IACrD,WAAW,EAAE,aAAa,CAAC;IAE3B,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAC;IAEb,8DAA8D;IAC9D,UAAU,EAAE,WAAW,GAAG,QAAQ,CAAC;IAEnC;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B,mEAAmE;IACnE,yBAAyB,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3C,2EAA2E;IAC3E,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B,kFAAkF;IAClF,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC,8DAA8D;IAC9D,eAAe,EAAE,MAAM,GAAG,MAAM,CAAC;IAEjC,8CAA8C;IAC9C,SAAS,CAAC,EAAE;QACV,uCAAuC;QACvC,MAAM,EAAE,MAAM,CAAC;QACf,0DAA0D;QAC1D,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IAEF,sDAAsD;IACtD,eAAe,CAAC,EAAE;QAChB,uCAAuC;QACvC,MAAM,EAAE,MAAM,CAAC;QACf,0DAA0D;QAC1D,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IAEF;;;;;;;;;OASG;IACH,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3B,0EAA0E;IAC1E,iBAAiB,CAAC,EAAE,KAAK,CAAC;QACxB,mCAAmC;QACnC,oBAAoB,EAAE,MAAM,CAAC;QAC7B,0CAA0C;QAC1C,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC,CAAC;IAEH,gEAAgE;IAChE,+BAA+B,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAElD,oEAAoE;IACpE,0BAA0B,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAE7C,mDAAmD;IACnD,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,yDAAyD;IACzD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC,gCAAgC;IAChC,UAAU,EAAE,aAAa,CAAC;IAC1B,+BAA+B;IAC/B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,wBAAwB,GAC/B,OAAO,CAAC,wBAAwB,CAAC,CA+FnC"}
|