Open Cap Table Protocol Canton SDK - v0.2.125
    Preparing search index...

    Open Cap Table Protocol Canton SDK - v0.2.125

    Classes

    OcpClient

    Interfaces

    ActivePaymentStreamChangePartyParams
    ActivePaymentStreamContract
    ActivePaymentStreamPayload
    AddFundsParams
    AddObserversToAirdropParams
    AddObserversToCompanyValuationReportParams
    AddObserversToCompanyValuationReportResult
    Address
    AddToCapTableParams
    AirdropConfig
    AirdropContractDetails
    AppRewardBeneficiary
    Approvals
    ArchiveInactivePaymentStreamParams
    ArchiveSimpleAirdropParams
    AuthorizeIssuerParams
    AuthorizeIssuerResult
    CancelPaymentStreamParams
    CapitalizationDefinitionRules
    CapTableOperationParams
    CommandWithDisclosedContracts
    ContactInfo
    ContactInfoWithoutName
    ConvertibleConversionRight
    ConvertibleConversionTrigger
    ConvertibleInterestRate
    ConvertibleMechanismCustom
    ConvertibleMechanismFixedAmount
    ConvertibleMechanismNote
    ConvertibleMechanismPercentCapitalization
    ConvertibleMechanismSafe
    ConvertibleMechanismSharePriceBased
    ConvertibleMechanismValuationBased
    CreateAirdropParams
    CreateCompanyValuationReportParams
    CreateCompanyValuationReportResult
    CreatedTreeEvent
    CreateIssuerParams
    CreatePaymentStreamProposalParams
    CreateSimpleAirdropParams
    CreateStakeholderParams
    CreateStockClassParams
    CreateStockRepurchaseParams
    DeleteFromCapTableParams
    DeleteStakeholderParams
    DeleteStockClassParams
    DeleteStockRepurchaseParams
    EditInCapTableParams
    EditPaymentStreamProposalParams
    EditStakeholderParams
    EditStockClassParams
    Email
    ExecuteAirdropParams
    ExecuteSimpleAirdropParams
    ExitMultiple
    FactoryContractInfo
    GetConvertibleCancellationEventAsOcfParams
    GetConvertibleCancellationEventAsOcfResult
    GetConvertibleIssuanceAsOcfParams
    GetConvertibleIssuanceAsOcfResult
    GetDocumentAsOcfParams
    GetDocumentAsOcfResult
    GetEquityCompensationCancellationEventAsOcfParams
    GetEquityCompensationCancellationEventAsOcfResult
    GetEquityCompensationExerciseEventAsOcfParams
    GetEquityCompensationExerciseEventAsOcfResult
    GetEquityCompensationIssuanceEventAsOcfParams
    GetEquityCompensationIssuanceEventAsOcfResult
    GetIssuerAsOcfParams
    GetIssuerAsOcfResult
    GetIssuerAuthorizedSharesAdjustmentEventAsOcfParams
    GetIssuerAuthorizedSharesAdjustmentEventAsOcfResult
    GetStakeholderAsOcfParams
    GetStakeholderAsOcfResult
    GetStockCancellationEventAsOcfParams
    GetStockCancellationEventAsOcfResult
    GetStockClassAsOcfParams
    GetStockClassAsOcfResult
    GetStockClassAuthorizedSharesAdjustmentEventAsOcfParams
    GetStockClassAuthorizedSharesAdjustmentEventAsOcfResult
    GetStockIssuanceAsOcfParams
    GetStockIssuanceAsOcfResult
    GetStockLegendTemplateAsOcfParams
    GetStockLegendTemplateAsOcfResult
    GetStockPlanAsOcfParams
    GetStockPlanAsOcfResult
    GetStockPlanPoolAdjustmentEventAsOcfParams
    GetStockPlanPoolAdjustmentEventAsOcfResult
    GetStockRepurchaseAsOcfParams
    GetStockRepurchaseAsOcfResult
    GetStockTransferAsOcfParams
    GetStockTransferAsOcfResult
    GetVestingTermsAsOcfParams
    GetVestingTermsAsOcfResult
    GetWarrantCancellationEventAsOcfParams
    GetWarrantCancellationEventAsOcfResult
    GetWarrantIssuanceAsOcfParams
    GetWarrantIssuanceAsOcfResult
    JoinAirdropParams
    LockFundsInput
    MigrateActivePaymentStreamParams
    MigrateProposedPaymentStreamParams
    Monetary
    Name
    OcfConvertibleAcceptance
    OcfConvertibleCancellation
    OcfConvertibleCancellationEvent
    OcfConvertibleConversion
    OcfConvertibleIssuance
    OcfConvertibleIssuanceEvent
    OcfConvertibleRetraction
    OcfConvertibleTransfer
    OcfDocument
    OcfEquityCompensationAcceptance
    OcfEquityCompensationCancellation
    OcfEquityCompensationCancellationEvent
    OcfEquityCompensationExercise
    OcfEquityCompensationIssuance
    OcfEquityCompensationIssuanceEvent
    OcfEquityCompensationRelease
    OcfEquityCompensationRepricing
    OcfEquityCompensationRetraction
    OcfEquityCompensationTransfer
    OcfFinancing
    OcfIssuer
    OcfIssuerAuthorizedSharesAdjustment
    OcfIssuerAuthorizedSharesAdjustmentEvent
    OcfObjectReference
    OcfPlanSecurityAcceptance
    OcfPlanSecurityCancellation
    OcfPlanSecurityExercise
    OcfPlanSecurityIssuance
    OcfPlanSecurityRelease
    OcfPlanSecurityRetraction
    OcfPlanSecurityTransfer
    OcfStakeholder
    OcfStockAcceptance
    OcfStockCancellation
    OcfStockCancellationEvent
    OcfStockClass
    OcfStockClassAuthorizedSharesAdjustment
    OcfStockClassAuthorizedSharesAdjustmentEvent
    OcfStockClassConversionRatioAdjustment
    OcfStockClassSplit
    OcfStockConsolidation
    OcfStockConversion
    OcfStockIssuance
    OcfStockLegendTemplate
    OcfStockPlan
    OcfStockPlanPoolAdjustment
    OcfStockPlanPoolAdjustmentEvent
    OcfStockPlanReturnToPool
    OcfStockReissuance
    OcfStockRepurchase
    OcfStockRepurchaseEvent
    OcfStockRetraction
    OcfStockTransfer
    OcfStockTransferEvent
    OcfValuation
    OcfVestingAcceleration
    OcfVestingEvent
    OcfVestingStart
    OcfVestingTerms
    OcfWarrantAcceptance
    OcfWarrantCancellation
    OcfWarrantCancellationEvent
    OcfWarrantExercise
    OcfWarrantIssuance
    OcfWarrantIssuanceEvent
    OcfWarrantRetraction
    OcfWarrantTransfer
    PartyMigrationProposalApproveParams
    PartyMigrationProposalArchiveParams
    PaymentContext
    PaymentContextWithAmulets
    PaymentContextWithAmuletsAndDisclosed
    PaymentContextWithDisclosedContracts
    PaymentStreamAmount
    PaymentStreamAmountInput
    PaymentStreamChangeProposalApplyParams
    PaymentStreamChangeProposalApproveParams
    PaymentStreamChangeProposalRejectParams
    PaymentStreamChanges
    PaymentStreamDetails
    PaymentStreamProposal
    PaymentStreamProposalChanges
    PaymentStreamProposalInput
    PaymentStreamStats
    PaymentStreamTimeInput
    Phone
    ProcessFreeTrialParams
    ProcessorContext
    ProcessPaymentParams
    ProposeChangesParams
    ProposedPaymentStreamApproveParams
    ProposedPaymentStreamChangePartyParams
    ProposedPaymentStreamContract
    ProposedPaymentStreamPayload
    ProposedPaymentStreamStartParams
    ProposedPaymentStreamWithdrawParams
    RecipientSpec
    RecipientTransferSpec
    RefundPaymentStreamParams
    ReplaceLockedAmuletParams
    SecurityExemption
    ShareNumberRange
    SimpleAirdropConfig
    SimpleVesting
    StockClassConversionRight
    TaxId
    TerminationWindow
    UpdateAirdropConfigParams
    UpdateCompanyValuationParams
    UpdateCompanyValuationResult
    Vesting
    VestingCondition
    VestingConditionPortion
    VestingPeriod
    VestingSimple
    WarrantConversionRight
    WarrantExerciseTrigger
    WarrantMechanismCustom
    WarrantMechanismFixedAmount
    WarrantMechanismPercentCapitalization
    WarrantMechanismSharePriceBased
    WarrantMechanismValuationBased
    WithdrawAuthorizationParams
    WithdrawAuthorizationResult
    WithdrawFundsParams

    Type Aliases

    AddressType
    AllocationType
    AuthorizedShares
    CompensationType
    ConversionMechanism
    ConversionTrigger
    ConversionTriggerInput
    ConversionTriggerType
    ConvertibleConversionMechanism
    ConvertibleType
    EmailType
    InitialSharesAuthorized
    Network
    OcfObjectType
    PeriodType
    PhoneType
    ProposedPaymentStreamPartyRole
    RoundingType
    SimpleTrigger
    StakeholderType
    StockClassType
    StockIssuanceType
    StockPlanCancellationBehavior
    TerminationWindowReason
    ValuationType
    VestingTrigger
    WarrantConversionMechanism
    WarrantExerciseTriggerInput

    Variables

    OCF_METADATA

    Functions

    addObserversToCompanyValuationReport
    addressToDaml
    areAllNonPayerPartiesApproved
    authorizeIssuer
    buildActivePaymentStreamChangePartyCommand
    buildAddFundsCommand
    buildAddObserversToAirdropCommand
    buildAllOcfEventArrays
    buildAllOcfIdMaps
    buildArchiveInactivePaymentStreamCommand
    buildArchiveSimpleAirdropCommand
    buildCancelPaymentStreamCommand
    buildCapTableCommand
    buildCreateAirdropCommand
    buildCreateCompanyValuationReportCommand
    buildCreateIssuerCommand
    buildCreatePaymentStreamProposalCommand
    buildCreateSimpleAirdropCommand
    buildCreateStakeholderCommand
    buildCreateStockClassCommand
    buildCreateStockRepurchaseCommand
    buildDeleteStakeholderCommand
    buildDeleteStockClassCommand
    buildDeleteStockRepurchaseCommand
    buildEditPaymentStreamProposalCommand
    buildEditStakeholderCommand
    buildEditStockClassCommand
    buildExecuteAirdropCommand
    buildExecuteSimpleAirdropCommand
    buildJoinAirdropCommand
    buildMigrateActivePaymentStreamCommand
    buildMigrateProposedPaymentStreamCommand
    buildOcfIdToContractIdMap
    buildPartyMigrationProposalApproveCommand
    buildPartyMigrationProposalArchiveCommand
    buildPaymentContext
    buildPaymentContextWithAmulets
    buildPaymentStreamChangeProposalApplyCommand
    buildPaymentStreamChangeProposalApproveCommand
    buildPaymentStreamChangeProposalRejectCommand
    buildProcessFreeTrialCommand
    buildProcessPaymentCommand
    buildProposeChangesCommand
    buildProposedPaymentStreamApproveCommand
    buildProposedPaymentStreamChangePartyCommand
    buildProposedPaymentStreamStartCommand
    buildProposedPaymentStreamWithdrawCommand
    buildRefundPaymentStreamCommand
    buildReplaceLockedAmuletCommand
    buildUpdateAirdropConfigCommand
    buildWithdrawFundsCommand
    cleanComments
    convertibleCancellationDataToDaml
    convertibleIssuanceDataToDaml
    createCompanyValuationReport
    damlAddressToNative
    damlMonetaryToNative
    damlTimeToDateString
    dateStringToDAMLTime
    documentDataToDaml
    equityCompensationCancellationDataToDaml
    equityCompensationExerciseDataToDaml
    equityCompensationIssuanceDataToDaml
    extractOcfIdFromCreateArgs
    extractOcfIdFromEvent
    extractUpdateId
    findCreatedEventsByTemplateId
    getAllOcfTypes
    getConvertibleCancellationEventAsOcf
    getConvertibleIssuanceAsOcf
    getDocumentAsOcf
    getEquityCompensationCancellationEventAsOcf
    getEquityCompensationExerciseEventAsOcf
    getEquityCompensationIssuanceEventAsOcf
    getFactoryContractId
    getFactoryDisclosedContracts
    getIssuerAsOcf
    getIssuerAuthorizedSharesAdjustmentEventAsOcf
    getOcfDataFieldName
    getOcfMetadata
    getOcfTypeLabel
    getProposedPaymentStreamDisclosedContracts
    getStakeholderAsOcf
    getStockCancellationEventAsOcf
    getStockClassAsOcf
    getStockClassAuthorizedSharesAdjustmentEventAsOcf
    getStockIssuanceAsOcf
    getStockLegendTemplateAsOcf
    getStockPlanAsOcf
    getStockPlanPoolAdjustmentEventAsOcf
    getStockRepurchaseAsOcf
    getStockTransferAsOcf
    getVestingTermsAsOcf
    getWarrantCancellationEventAsOcf
    getWarrantIssuanceAsOcf
    isPaymentStreamReadyForProcessing
    isProposalPendingPayerApproval
    isProposalPendingProcessorApproval
    isProposalPendingRecipientApproval
    issuerAuthorizedSharesAdjustmentDataToDaml
    isValidOcfType
    monetaryToDaml
    normalizeNumericString
    numberToString
    ocfDeepEqual
    optionalNumberToString
    optionalString
    relTimeToDAML
    safeGet
    safeString
    secondsToMicroseconds
    stakeholderDataToDaml
    stockCancellationDataToDaml
    stockClassAuthorizedSharesAdjustmentDataToDaml
    stockClassDataToDaml
    stockIssuanceDataToDaml
    stockLegendTemplateDataToDaml
    stockPlanDataToDaml
    stockPlanPoolAdjustmentDataToDaml
    stockRepurchaseDataToDaml
    stockTransferDataToDaml
    updateCompanyValuationReport
    vestingTermsDataToDaml
    warrantCancellationDataToDaml
    warrantIssuanceDataToDaml
    withdrawAuthorization