@fairmint/open-captable-protocol-daml-js 0.0.41 → 0.1.0

package/lib/Fairmint/OpenCapTable/StockPlan/index.d.ts

@@ -0,0 +1 @@
+export * from './module';

package/lib/Fairmint/OpenCapTable/StockPlan/index.js

@@ -0,0 +1,8 @@
+"use strict";
+/* eslint-disable-next-line no-unused-vars */
+function __export(m) {
+/* eslint-disable-next-line no-prototype-builtins */
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+__export(require('./module'));

package/lib/Fairmint/OpenCapTable/StockPlan/module.d.ts

@@ -0,0 +1,332 @@
+// Generated from Fairmint/OpenCapTable/StockPlan.daml
+/* eslint-disable @typescript-eslint/camelcase */
+/* eslint-disable @typescript-eslint/no-namespace */
+/* eslint-disable @typescript-eslint/no-use-before-define */
+import * as jtv from '@mojotech/json-type-validation';
+import * as damlTypes from '@daml/types';
+/* eslint-disable-next-line @typescript-eslint/no-unused-vars */
+import * as damlLedger from '@daml/ledger';
+
+import * as pkg7804375fe5e4c6d5afe067bd314c42fe0b7d005a1300019c73154dd939da4dda from '../../../Splice/Api/FeaturedAppRightV1';
+import * as pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69 from '../../../DA/Internal/Template';
+
+import * as Fairmint_OpenCapTable_StockClass from '../../../Fairmint/OpenCapTable/StockClass/module';
+import * as Fairmint_OpenCapTable_Types from '../../../Fairmint/OpenCapTable/Types/module';
+import * as Fairmint_OpenCapTable_VestingTerms from '../../../Fairmint/OpenCapTable/VestingTerms/module';
+
+export declare type PlanSecurityExerciseEvent = {
+  issuer: damlTypes.Party;
+  system_operator: damlTypes.Party;
+  featured_app_right: damlTypes.ContractId<pkg7804375fe5e4c6d5afe067bd314c42fe0b7d005a1300019c73154dd939da4dda.Splice.Api.FeaturedAppRightV1.FeaturedAppRight>;
+  plan_security: damlTypes.ContractId<PlanSecurityGrant>;
+  stakeholder: damlTypes.Party;
+  stock_class: damlTypes.ContractId<Fairmint_OpenCapTable_StockClass.StockClass>;
+  quantity: damlTypes.Numeric;
+  date: damlTypes.Time;
+};
+
+export declare interface PlanSecurityExerciseEventInterface {
+  Archive: damlTypes.Choice<PlanSecurityExerciseEvent, pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69.DA.Internal.Template.Archive, {}, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<PlanSecurityExerciseEvent, undefined>>;
+}
+export declare const PlanSecurityExerciseEvent:
+  damlTypes.Template<PlanSecurityExerciseEvent, undefined, '#OpenCapTable-v12:Fairmint.OpenCapTable.StockPlan:PlanSecurityExerciseEvent'> &
+  damlTypes.ToInterface<PlanSecurityExerciseEvent, never> &
+  PlanSecurityExerciseEventInterface;
+
+export declare namespace PlanSecurityExerciseEvent {
+  export type CreateEvent = damlLedger.CreateEvent<PlanSecurityExerciseEvent, undefined, typeof PlanSecurityExerciseEvent.templateId>
+  export type ArchiveEvent = damlLedger.ArchiveEvent<PlanSecurityExerciseEvent, typeof PlanSecurityExerciseEvent.templateId>
+  export type Event = damlLedger.Event<PlanSecurityExerciseEvent, undefined, typeof PlanSecurityExerciseEvent.templateId>
+  export type QueryResult = damlLedger.QueryResult<PlanSecurityExerciseEvent, undefined, typeof PlanSecurityExerciseEvent.templateId>
+}
+
+
+
+export declare type PlanSecurityRetraction = {
+  issuer: damlTypes.Party;
+  system_operator: damlTypes.Party;
+  featured_app_right: damlTypes.ContractId<pkg7804375fe5e4c6d5afe067bd314c42fe0b7d005a1300019c73154dd939da4dda.Splice.Api.FeaturedAppRightV1.FeaturedAppRight>;
+  plan_security: damlTypes.ContractId<PlanSecurityGrant>;
+  stakeholder: damlTypes.Party;
+  date: damlTypes.Time;
+};
+
+export declare interface PlanSecurityRetractionInterface {
+  Archive: damlTypes.Choice<PlanSecurityRetraction, pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69.DA.Internal.Template.Archive, {}, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<PlanSecurityRetraction, undefined>>;
+}
+export declare const PlanSecurityRetraction:
+  damlTypes.Template<PlanSecurityRetraction, undefined, '#OpenCapTable-v12:Fairmint.OpenCapTable.StockPlan:PlanSecurityRetraction'> &
+  damlTypes.ToInterface<PlanSecurityRetraction, never> &
+  PlanSecurityRetractionInterface;
+
+export declare namespace PlanSecurityRetraction {
+  export type CreateEvent = damlLedger.CreateEvent<PlanSecurityRetraction, undefined, typeof PlanSecurityRetraction.templateId>
+  export type ArchiveEvent = damlLedger.ArchiveEvent<PlanSecurityRetraction, typeof PlanSecurityRetraction.templateId>
+  export type Event = damlLedger.Event<PlanSecurityRetraction, undefined, typeof PlanSecurityRetraction.templateId>
+  export type QueryResult = damlLedger.QueryResult<PlanSecurityRetraction, undefined, typeof PlanSecurityRetraction.templateId>
+}
+
+
+
+export declare type PlanSecurityRelease = {
+  issuer: damlTypes.Party;
+  system_operator: damlTypes.Party;
+  featured_app_right: damlTypes.ContractId<pkg7804375fe5e4c6d5afe067bd314c42fe0b7d005a1300019c73154dd939da4dda.Splice.Api.FeaturedAppRightV1.FeaturedAppRight>;
+  plan_security: damlTypes.ContractId<PlanSecurityGrant>;
+  stakeholder: damlTypes.Party;
+  date: damlTypes.Time;
+};
+
+export declare interface PlanSecurityReleaseInterface {
+  Archive: damlTypes.Choice<PlanSecurityRelease, pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69.DA.Internal.Template.Archive, {}, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<PlanSecurityRelease, undefined>>;
+}
+export declare const PlanSecurityRelease:
+  damlTypes.Template<PlanSecurityRelease, undefined, '#OpenCapTable-v12:Fairmint.OpenCapTable.StockPlan:PlanSecurityRelease'> &
+  damlTypes.ToInterface<PlanSecurityRelease, never> &
+  PlanSecurityReleaseInterface;
+
+export declare namespace PlanSecurityRelease {
+  export type CreateEvent = damlLedger.CreateEvent<PlanSecurityRelease, undefined, typeof PlanSecurityRelease.templateId>
+  export type ArchiveEvent = damlLedger.ArchiveEvent<PlanSecurityRelease, typeof PlanSecurityRelease.templateId>
+  export type Event = damlLedger.Event<PlanSecurityRelease, undefined, typeof PlanSecurityRelease.templateId>
+  export type QueryResult = damlLedger.QueryResult<PlanSecurityRelease, undefined, typeof PlanSecurityRelease.templateId>
+}
+
+
+
+export declare type PlanSecurityCancellation = {
+  issuer: damlTypes.Party;
+  system_operator: damlTypes.Party;
+  featured_app_right: damlTypes.ContractId<pkg7804375fe5e4c6d5afe067bd314c42fe0b7d005a1300019c73154dd939da4dda.Splice.Api.FeaturedAppRightV1.FeaturedAppRight>;
+  plan_security: damlTypes.ContractId<PlanSecurityGrant>;
+  stakeholder: damlTypes.Party;
+  date: damlTypes.Time;
+};
+
+export declare interface PlanSecurityCancellationInterface {
+  Archive: damlTypes.Choice<PlanSecurityCancellation, pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69.DA.Internal.Template.Archive, {}, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<PlanSecurityCancellation, undefined>>;
+}
+export declare const PlanSecurityCancellation:
+  damlTypes.Template<PlanSecurityCancellation, undefined, '#OpenCapTable-v12:Fairmint.OpenCapTable.StockPlan:PlanSecurityCancellation'> &
+  damlTypes.ToInterface<PlanSecurityCancellation, never> &
+  PlanSecurityCancellationInterface;
+
+export declare namespace PlanSecurityCancellation {
+  export type CreateEvent = damlLedger.CreateEvent<PlanSecurityCancellation, undefined, typeof PlanSecurityCancellation.templateId>
+  export type ArchiveEvent = damlLedger.ArchiveEvent<PlanSecurityCancellation, typeof PlanSecurityCancellation.templateId>
+  export type Event = damlLedger.Event<PlanSecurityCancellation, undefined, typeof PlanSecurityCancellation.templateId>
+  export type QueryResult = damlLedger.QueryResult<PlanSecurityCancellation, undefined, typeof PlanSecurityCancellation.templateId>
+}
+
+
+
+export declare type PlanSecurityAcceptance = {
+  issuer: damlTypes.Party;
+  system_operator: damlTypes.Party;
+  featured_app_right: damlTypes.ContractId<pkg7804375fe5e4c6d5afe067bd314c42fe0b7d005a1300019c73154dd939da4dda.Splice.Api.FeaturedAppRightV1.FeaturedAppRight>;
+  plan_security: damlTypes.ContractId<PlanSecurityGrant>;
+  stakeholder: damlTypes.Party;
+  date: damlTypes.Time;
+};
+
+export declare interface PlanSecurityAcceptanceInterface {
+  Archive: damlTypes.Choice<PlanSecurityAcceptance, pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69.DA.Internal.Template.Archive, {}, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<PlanSecurityAcceptance, undefined>>;
+}
+export declare const PlanSecurityAcceptance:
+  damlTypes.Template<PlanSecurityAcceptance, undefined, '#OpenCapTable-v12:Fairmint.OpenCapTable.StockPlan:PlanSecurityAcceptance'> &
+  damlTypes.ToInterface<PlanSecurityAcceptance, never> &
+  PlanSecurityAcceptanceInterface;
+
+export declare namespace PlanSecurityAcceptance {
+  export type CreateEvent = damlLedger.CreateEvent<PlanSecurityAcceptance, undefined, typeof PlanSecurityAcceptance.templateId>
+  export type ArchiveEvent = damlLedger.ArchiveEvent<PlanSecurityAcceptance, typeof PlanSecurityAcceptance.templateId>
+  export type Event = damlLedger.Event<PlanSecurityAcceptance, undefined, typeof PlanSecurityAcceptance.templateId>
+  export type QueryResult = damlLedger.QueryResult<PlanSecurityAcceptance, undefined, typeof PlanSecurityAcceptance.templateId>
+}
+
+
+
+export declare type PlanSecurityVestingStart = {
+  issuer: damlTypes.Party;
+  system_operator: damlTypes.Party;
+  featured_app_right: damlTypes.ContractId<pkg7804375fe5e4c6d5afe067bd314c42fe0b7d005a1300019c73154dd939da4dda.Splice.Api.FeaturedAppRightV1.FeaturedAppRight>;
+  plan_security: damlTypes.ContractId<PlanSecurityGrant>;
+  vesting_condition_id: string;
+  date: damlTypes.Time;
+};
+
+export declare interface PlanSecurityVestingStartInterface {
+  Archive: damlTypes.Choice<PlanSecurityVestingStart, pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69.DA.Internal.Template.Archive, {}, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<PlanSecurityVestingStart, undefined>>;
+}
+export declare const PlanSecurityVestingStart:
+  damlTypes.Template<PlanSecurityVestingStart, undefined, '#OpenCapTable-v12:Fairmint.OpenCapTable.StockPlan:PlanSecurityVestingStart'> &
+  damlTypes.ToInterface<PlanSecurityVestingStart, never> &
+  PlanSecurityVestingStartInterface;
+
+export declare namespace PlanSecurityVestingStart {
+  export type CreateEvent = damlLedger.CreateEvent<PlanSecurityVestingStart, undefined, typeof PlanSecurityVestingStart.templateId>
+  export type ArchiveEvent = damlLedger.ArchiveEvent<PlanSecurityVestingStart, typeof PlanSecurityVestingStart.templateId>
+  export type Event = damlLedger.Event<PlanSecurityVestingStart, undefined, typeof PlanSecurityVestingStart.templateId>
+  export type QueryResult = damlLedger.QueryResult<PlanSecurityVestingStart, undefined, typeof PlanSecurityVestingStart.templateId>
+}
+
+
+
+export declare type IssuePlanSecurity = {
+  stakeholder: damlTypes.Party;
+  issuance_data: Fairmint_OpenCapTable_Types.OcfEquityCompensationIssuanceData;
+  stock_class: damlTypes.ContractId<Fairmint_OpenCapTable_StockClass.StockClass>;
+  vesting_terms: damlTypes.Optional<damlTypes.ContractId<Fairmint_OpenCapTable_VestingTerms.VestingTerms>>;
+};
+
+export declare const IssuePlanSecurity:
+  damlTypes.Serializable<IssuePlanSecurity> & {
+  }
+;
+
+
+export declare type UpdateStockPlan = {
+  new_plan_data: Fairmint_OpenCapTable_Types.OcfStockPlanData;
+  new_stock_classes: damlTypes.ContractId<Fairmint_OpenCapTable_StockClass.StockClass>[];
+};
+
+export declare const UpdateStockPlan:
+  damlTypes.Serializable<UpdateStockPlan> & {
+  }
+;
+
+
+export declare type StockPlan = {
+  issuer: damlTypes.Party;
+  system_operator: damlTypes.Party;
+  featured_app_right: damlTypes.ContractId<pkg7804375fe5e4c6d5afe067bd314c42fe0b7d005a1300019c73154dd939da4dda.Splice.Api.FeaturedAppRightV1.FeaturedAppRight>;
+  stock_classes: damlTypes.ContractId<Fairmint_OpenCapTable_StockClass.StockClass>[];
+  plan_data: Fairmint_OpenCapTable_Types.OcfStockPlanData;
+};
+
+export declare interface StockPlanInterface {
+  Archive: damlTypes.Choice<StockPlan, pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69.DA.Internal.Template.Archive, {}, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<StockPlan, undefined>>;
+  UpdateStockPlan: damlTypes.Choice<StockPlan, UpdateStockPlan, damlTypes.ContractId<StockPlan>, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<StockPlan, undefined>>;
+  IssuePlanSecurity: damlTypes.Choice<StockPlan, IssuePlanSecurity, damlTypes.ContractId<PlanSecurityGrant>, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<StockPlan, undefined>>;
+}
+export declare const StockPlan:
+  damlTypes.Template<StockPlan, undefined, '#OpenCapTable-v12:Fairmint.OpenCapTable.StockPlan:StockPlan'> &
+  damlTypes.ToInterface<StockPlan, never> &
+  StockPlanInterface;
+
+export declare namespace StockPlan {
+  export type CreateEvent = damlLedger.CreateEvent<StockPlan, undefined, typeof StockPlan.templateId>
+  export type ArchiveEvent = damlLedger.ArchiveEvent<StockPlan, typeof StockPlan.templateId>
+  export type Event = damlLedger.Event<StockPlan, undefined, typeof StockPlan.templateId>
+  export type QueryResult = damlLedger.QueryResult<StockPlan, undefined, typeof StockPlan.templateId>
+}
+
+
+
+export declare type ExerciseGrant = {
+  stock_class: damlTypes.ContractId<Fairmint_OpenCapTable_StockClass.StockClass>;
+  quantity: damlTypes.Numeric;
+  date: damlTypes.Time;
+};
+
+export declare const ExerciseGrant:
+  damlTypes.Serializable<ExerciseGrant> & {
+  }
+;
+
+
+export declare type RetractGrant = {
+  date: damlTypes.Time;
+};
+
+export declare const RetractGrant:
+  damlTypes.Serializable<RetractGrant> & {
+  }
+;
+
+
+export declare type ReleaseGrant = {
+  date: damlTypes.Time;
+};
+
+export declare const ReleaseGrant:
+  damlTypes.Serializable<ReleaseGrant> & {
+  }
+;
+
+
+export declare type CancelGrant = {
+  date: damlTypes.Time;
+};
+
+export declare const CancelGrant:
+  damlTypes.Serializable<CancelGrant> & {
+  }
+;
+
+
+export declare type AcceptGrant = {
+  date: damlTypes.Time;
+};
+
+export declare const AcceptGrant:
+  damlTypes.Serializable<AcceptGrant> & {
+  }
+;
+
+
+export declare type StartVesting = {
+  vesting_condition_id: string;
+  date: damlTypes.Time;
+};
+
+export declare const StartVesting:
+  damlTypes.Serializable<StartVesting> & {
+  }
+;
+
+
+export declare type UpdateIssuanceData = {
+  new_issuance_data: Fairmint_OpenCapTable_Types.OcfEquityCompensationIssuanceData;
+};
+
+export declare const UpdateIssuanceData:
+  damlTypes.Serializable<UpdateIssuanceData> & {
+  }
+;
+
+
+export declare type PlanSecurityGrant = {
+  issuer: damlTypes.Party;
+  system_operator: damlTypes.Party;
+  featured_app_right: damlTypes.ContractId<pkg7804375fe5e4c6d5afe067bd314c42fe0b7d005a1300019c73154dd939da4dda.Splice.Api.FeaturedAppRightV1.FeaturedAppRight>;
+  stock_plan: damlTypes.Optional<damlTypes.ContractId<StockPlan>>;
+  stock_class: damlTypes.ContractId<Fairmint_OpenCapTable_StockClass.StockClass>;
+  stakeholder: damlTypes.Party;
+  vesting_terms: damlTypes.Optional<damlTypes.ContractId<Fairmint_OpenCapTable_VestingTerms.VestingTerms>>;
+  issuance_data: Fairmint_OpenCapTable_Types.OcfEquityCompensationIssuanceData;
+};
+
+export declare interface PlanSecurityGrantInterface {
+  StartVesting: damlTypes.Choice<PlanSecurityGrant, StartVesting, damlTypes.ContractId<PlanSecurityVestingStart>, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<PlanSecurityGrant, undefined>>;
+  Archive: damlTypes.Choice<PlanSecurityGrant, pkg9e70a8b3510d617f8a136213f33d6a903a10ca0eeec76bb06ba55d1ed9680f69.DA.Internal.Template.Archive, {}, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<PlanSecurityGrant, undefined>>;
+  ExerciseGrant: damlTypes.Choice<PlanSecurityGrant, ExerciseGrant, damlTypes.ContractId<Fairmint_OpenCapTable_StockClass.StockPosition>, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<PlanSecurityGrant, undefined>>;
+  UpdateIssuanceData: damlTypes.Choice<PlanSecurityGrant, UpdateIssuanceData, damlTypes.ContractId<PlanSecurityGrant>, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<PlanSecurityGrant, undefined>>;
+  AcceptGrant: damlTypes.Choice<PlanSecurityGrant, AcceptGrant, damlTypes.ContractId<PlanSecurityAcceptance>, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<PlanSecurityGrant, undefined>>;
+  CancelGrant: damlTypes.Choice<PlanSecurityGrant, CancelGrant, damlTypes.ContractId<PlanSecurityCancellation>, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<PlanSecurityGrant, undefined>>;
+  ReleaseGrant: damlTypes.Choice<PlanSecurityGrant, ReleaseGrant, damlTypes.ContractId<PlanSecurityRelease>, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<PlanSecurityGrant, undefined>>;
+  RetractGrant: damlTypes.Choice<PlanSecurityGrant, RetractGrant, damlTypes.ContractId<PlanSecurityRetraction>, undefined> & damlTypes.ChoiceFrom<damlTypes.Template<PlanSecurityGrant, undefined>>;
+}
+export declare const PlanSecurityGrant:
+  damlTypes.Template<PlanSecurityGrant, undefined, '#OpenCapTable-v12:Fairmint.OpenCapTable.StockPlan:PlanSecurityGrant'> &
+  damlTypes.ToInterface<PlanSecurityGrant, never> &
+  PlanSecurityGrantInterface;
+
+export declare namespace PlanSecurityGrant {
+  export type CreateEvent = damlLedger.CreateEvent<PlanSecurityGrant, undefined, typeof PlanSecurityGrant.templateId>
+  export type ArchiveEvent = damlLedger.ArchiveEvent<PlanSecurityGrant, typeof PlanSecurityGrant.templateId>
+  export type Event = damlLedger.Event<PlanSecurityGrant, undefined, typeof PlanSecurityGrant.templateId>
+  export type QueryResult = damlLedger.QueryResult<PlanSecurityGrant, undefined, typeof PlanSecurityGrant.templateId>
+}
+
+