@open-captable-protocol/canton 0.2.136 → 0.2.137
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/dist/OcpClient.d.ts +32 -195
- package/dist/OcpClient.d.ts.map +1 -1
- package/dist/OcpClient.js +18 -109
- package/dist/OcpClient.js.map +1 -1
- package/dist/functions/OpenCapTable/capTable/CapTableBatch.d.ts +140 -0
- package/dist/functions/OpenCapTable/capTable/CapTableBatch.d.ts.map +1 -0
- package/dist/functions/OpenCapTable/capTable/CapTableBatch.js +211 -0
- package/dist/functions/OpenCapTable/capTable/CapTableBatch.js.map +1 -0
- package/dist/functions/OpenCapTable/capTable/batchTypes.d.ts +71 -0
- package/dist/functions/OpenCapTable/capTable/batchTypes.d.ts.map +1 -0
- package/dist/functions/OpenCapTable/capTable/batchTypes.js +238 -0
- package/dist/functions/OpenCapTable/capTable/batchTypes.js.map +1 -0
- package/dist/functions/OpenCapTable/capTable/index.d.ts +3 -0
- package/dist/functions/OpenCapTable/capTable/index.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/capTable/index.js +8 -0
- package/dist/functions/OpenCapTable/capTable/index.js.map +1 -1
- package/dist/functions/OpenCapTable/capTable/ocfToDaml.d.ts +16 -0
- package/dist/functions/OpenCapTable/capTable/ocfToDaml.d.ts.map +1 -0
- package/dist/functions/OpenCapTable/capTable/ocfToDaml.js +456 -0
- package/dist/functions/OpenCapTable/capTable/ocfToDaml.js.map +1 -0
- package/dist/functions/OpenCapTable/convertibleIssuance/index.d.ts +0 -1
- package/dist/functions/OpenCapTable/convertibleIssuance/index.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/convertibleIssuance/index.js +0 -1
- package/dist/functions/OpenCapTable/convertibleIssuance/index.js.map +1 -1
- package/dist/functions/OpenCapTable/document/index.d.ts +0 -1
- package/dist/functions/OpenCapTable/document/index.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/document/index.js +0 -1
- package/dist/functions/OpenCapTable/document/index.js.map +1 -1
- package/dist/functions/OpenCapTable/equityCompensationIssuance/index.d.ts +0 -1
- package/dist/functions/OpenCapTable/equityCompensationIssuance/index.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/equityCompensationIssuance/index.js +0 -1
- package/dist/functions/OpenCapTable/equityCompensationIssuance/index.js.map +1 -1
- package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/index.d.ts +0 -1
- package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/index.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/index.js +0 -1
- package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/index.js.map +1 -1
- package/dist/functions/OpenCapTable/stakeholder/index.d.ts +1 -3
- package/dist/functions/OpenCapTable/stakeholder/index.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/stakeholder/index.js +1 -3
- package/dist/functions/OpenCapTable/stakeholder/index.js.map +1 -1
- package/dist/functions/OpenCapTable/stakeholder/stakeholderDataToDaml.d.ts +4 -0
- package/dist/functions/OpenCapTable/stakeholder/stakeholderDataToDaml.d.ts.map +1 -0
- package/dist/functions/OpenCapTable/stakeholder/{addStakeholder.js → stakeholderDataToDaml.js} +1 -18
- package/dist/functions/OpenCapTable/stakeholder/stakeholderDataToDaml.js.map +1 -0
- package/dist/functions/OpenCapTable/stockCancellation/index.d.ts +0 -1
- package/dist/functions/OpenCapTable/stockCancellation/index.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/stockCancellation/index.js +0 -1
- package/dist/functions/OpenCapTable/stockCancellation/index.js.map +1 -1
- package/dist/functions/OpenCapTable/stockClass/index.d.ts +0 -3
- package/dist/functions/OpenCapTable/stockClass/index.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/stockClass/index.js +0 -3
- package/dist/functions/OpenCapTable/stockClass/index.js.map +1 -1
- package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/index.d.ts +0 -1
- package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/index.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/index.js +0 -1
- package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/index.js.map +1 -1
- package/dist/functions/OpenCapTable/stockIssuance/index.d.ts +0 -1
- package/dist/functions/OpenCapTable/stockIssuance/index.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/stockIssuance/index.js +0 -1
- package/dist/functions/OpenCapTable/stockIssuance/index.js.map +1 -1
- package/dist/functions/OpenCapTable/stockLegendTemplate/index.d.ts +0 -1
- package/dist/functions/OpenCapTable/stockLegendTemplate/index.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/stockLegendTemplate/index.js +0 -1
- package/dist/functions/OpenCapTable/stockLegendTemplate/index.js.map +1 -1
- package/dist/functions/OpenCapTable/stockPlan/index.d.ts +0 -1
- package/dist/functions/OpenCapTable/stockPlan/index.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/stockPlan/index.js +0 -1
- package/dist/functions/OpenCapTable/stockPlan/index.js.map +1 -1
- package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/index.d.ts +0 -1
- package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/index.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/index.js +0 -1
- package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/index.js.map +1 -1
- package/dist/functions/OpenCapTable/stockRepurchase/index.d.ts +1 -2
- package/dist/functions/OpenCapTable/stockRepurchase/index.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/stockRepurchase/index.js +1 -2
- package/dist/functions/OpenCapTable/stockRepurchase/index.js.map +1 -1
- package/dist/functions/OpenCapTable/stockRepurchase/stockRepurchaseDataToDaml.d.ts +3 -0
- package/dist/functions/OpenCapTable/stockRepurchase/stockRepurchaseDataToDaml.d.ts.map +1 -0
- package/dist/functions/OpenCapTable/stockRepurchase/{createStockRepurchase.js → stockRepurchaseDataToDaml.js} +4 -20
- package/dist/functions/OpenCapTable/stockRepurchase/stockRepurchaseDataToDaml.js.map +1 -0
- package/dist/functions/OpenCapTable/stockTransfer/index.d.ts +0 -1
- package/dist/functions/OpenCapTable/stockTransfer/index.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/stockTransfer/index.js +0 -1
- package/dist/functions/OpenCapTable/stockTransfer/index.js.map +1 -1
- package/dist/functions/OpenCapTable/vestingTerms/index.d.ts +0 -1
- package/dist/functions/OpenCapTable/vestingTerms/index.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/vestingTerms/index.js +0 -1
- package/dist/functions/OpenCapTable/vestingTerms/index.js.map +1 -1
- package/dist/functions/OpenCapTable/warrantIssuance/index.d.ts +0 -1
- package/dist/functions/OpenCapTable/warrantIssuance/index.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/warrantIssuance/index.js +0 -1
- package/dist/functions/OpenCapTable/warrantIssuance/index.js.map +1 -1
- package/package.json +9 -9
- package/dist/functions/OpenCapTable/convertibleIssuance/deleteConvertibleIssuance.d.ts +0 -10
- package/dist/functions/OpenCapTable/convertibleIssuance/deleteConvertibleIssuance.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/convertibleIssuance/deleteConvertibleIssuance.js +0 -16
- package/dist/functions/OpenCapTable/convertibleIssuance/deleteConvertibleIssuance.js.map +0 -1
- package/dist/functions/OpenCapTable/document/deleteDocument.d.ts +0 -10
- package/dist/functions/OpenCapTable/document/deleteDocument.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/document/deleteDocument.js +0 -16
- package/dist/functions/OpenCapTable/document/deleteDocument.js.map +0 -1
- package/dist/functions/OpenCapTable/equityCompensationIssuance/deleteEquityCompensationIssuance.d.ts +0 -10
- package/dist/functions/OpenCapTable/equityCompensationIssuance/deleteEquityCompensationIssuance.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/equityCompensationIssuance/deleteEquityCompensationIssuance.js +0 -16
- package/dist/functions/OpenCapTable/equityCompensationIssuance/deleteEquityCompensationIssuance.js.map +0 -1
- package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/deleteIssuerAuthorizedSharesAdjustment.d.ts +0 -10
- package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/deleteIssuerAuthorizedSharesAdjustment.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/deleteIssuerAuthorizedSharesAdjustment.js +0 -16
- package/dist/functions/OpenCapTable/issuerAuthorizedSharesAdjustment/deleteIssuerAuthorizedSharesAdjustment.js.map +0 -1
- package/dist/functions/OpenCapTable/stakeholder/addStakeholder.d.ts +0 -12
- package/dist/functions/OpenCapTable/stakeholder/addStakeholder.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/stakeholder/addStakeholder.js.map +0 -1
- package/dist/functions/OpenCapTable/stakeholder/deleteStakeholder.d.ts +0 -10
- package/dist/functions/OpenCapTable/stakeholder/deleteStakeholder.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/stakeholder/deleteStakeholder.js +0 -16
- package/dist/functions/OpenCapTable/stakeholder/deleteStakeholder.js.map +0 -1
- package/dist/functions/OpenCapTable/stakeholder/editStakeholder.d.ts +0 -10
- package/dist/functions/OpenCapTable/stakeholder/editStakeholder.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/stakeholder/editStakeholder.js +0 -33
- package/dist/functions/OpenCapTable/stakeholder/editStakeholder.js.map +0 -1
- package/dist/functions/OpenCapTable/stockCancellation/deleteStockCancellation.d.ts +0 -10
- package/dist/functions/OpenCapTable/stockCancellation/deleteStockCancellation.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/stockCancellation/deleteStockCancellation.js +0 -16
- package/dist/functions/OpenCapTable/stockCancellation/deleteStockCancellation.js.map +0 -1
- package/dist/functions/OpenCapTable/stockClass/addStockClass.d.ts +0 -10
- package/dist/functions/OpenCapTable/stockClass/addStockClass.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/stockClass/addStockClass.js +0 -17
- package/dist/functions/OpenCapTable/stockClass/addStockClass.js.map +0 -1
- package/dist/functions/OpenCapTable/stockClass/deleteStockClass.d.ts +0 -10
- package/dist/functions/OpenCapTable/stockClass/deleteStockClass.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/stockClass/deleteStockClass.js +0 -16
- package/dist/functions/OpenCapTable/stockClass/deleteStockClass.js.map +0 -1
- package/dist/functions/OpenCapTable/stockClass/editStockClass.d.ts +0 -10
- package/dist/functions/OpenCapTable/stockClass/editStockClass.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/stockClass/editStockClass.js +0 -17
- package/dist/functions/OpenCapTable/stockClass/editStockClass.js.map +0 -1
- package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/deleteStockClassAuthorizedSharesAdjustment.d.ts +0 -10
- package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/deleteStockClassAuthorizedSharesAdjustment.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/deleteStockClassAuthorizedSharesAdjustment.js +0 -16
- package/dist/functions/OpenCapTable/stockClassAuthorizedSharesAdjustment/deleteStockClassAuthorizedSharesAdjustment.js.map +0 -1
- package/dist/functions/OpenCapTable/stockIssuance/deleteStockIssuance.d.ts +0 -10
- package/dist/functions/OpenCapTable/stockIssuance/deleteStockIssuance.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/stockIssuance/deleteStockIssuance.js +0 -16
- package/dist/functions/OpenCapTable/stockIssuance/deleteStockIssuance.js.map +0 -1
- package/dist/functions/OpenCapTable/stockLegendTemplate/deleteStockLegendTemplate.d.ts +0 -10
- package/dist/functions/OpenCapTable/stockLegendTemplate/deleteStockLegendTemplate.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/stockLegendTemplate/deleteStockLegendTemplate.js +0 -16
- package/dist/functions/OpenCapTable/stockLegendTemplate/deleteStockLegendTemplate.js.map +0 -1
- package/dist/functions/OpenCapTable/stockPlan/deleteStockPlan.d.ts +0 -10
- package/dist/functions/OpenCapTable/stockPlan/deleteStockPlan.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/stockPlan/deleteStockPlan.js +0 -16
- package/dist/functions/OpenCapTable/stockPlan/deleteStockPlan.js.map +0 -1
- package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/deleteStockPlanPoolAdjustment.d.ts +0 -10
- package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/deleteStockPlanPoolAdjustment.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/deleteStockPlanPoolAdjustment.js +0 -16
- package/dist/functions/OpenCapTable/stockPlanPoolAdjustment/deleteStockPlanPoolAdjustment.js.map +0 -1
- package/dist/functions/OpenCapTable/stockRepurchase/createStockRepurchase.d.ts +0 -10
- package/dist/functions/OpenCapTable/stockRepurchase/createStockRepurchase.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/stockRepurchase/createStockRepurchase.js.map +0 -1
- package/dist/functions/OpenCapTable/stockRepurchase/deleteStockRepurchase.d.ts +0 -10
- package/dist/functions/OpenCapTable/stockRepurchase/deleteStockRepurchase.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/stockRepurchase/deleteStockRepurchase.js +0 -16
- package/dist/functions/OpenCapTable/stockRepurchase/deleteStockRepurchase.js.map +0 -1
- package/dist/functions/OpenCapTable/stockTransfer/deleteStockTransfer.d.ts +0 -10
- package/dist/functions/OpenCapTable/stockTransfer/deleteStockTransfer.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/stockTransfer/deleteStockTransfer.js +0 -16
- package/dist/functions/OpenCapTable/stockTransfer/deleteStockTransfer.js.map +0 -1
- package/dist/functions/OpenCapTable/vestingTerms/deleteVestingTerms.d.ts +0 -10
- package/dist/functions/OpenCapTable/vestingTerms/deleteVestingTerms.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/vestingTerms/deleteVestingTerms.js +0 -16
- package/dist/functions/OpenCapTable/vestingTerms/deleteVestingTerms.js.map +0 -1
- package/dist/functions/OpenCapTable/warrantIssuance/deleteWarrantIssuance.d.ts +0 -10
- package/dist/functions/OpenCapTable/warrantIssuance/deleteWarrantIssuance.d.ts.map +0 -1
- package/dist/functions/OpenCapTable/warrantIssuance/deleteWarrantIssuance.js +0 -16
- package/dist/functions/OpenCapTable/warrantIssuance/deleteWarrantIssuance.js.map +0 -1
package/dist/OcpClient.d.ts
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import type { ClientConfig } from '@fairmint/canton-node-sdk';
|
|
2
2
|
import { LedgerJsonApiClient } from '@fairmint/canton-node-sdk/build/src/clients/ledger-json-api';
|
|
3
|
-
import type { Command } from '@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/schemas/api/commands';
|
|
3
|
+
import type { Command, DisclosedContract } from '@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/schemas/api/commands';
|
|
4
4
|
import { TransactionBatch } from '@fairmint/canton-node-sdk/build/src/utils/transactions';
|
|
5
5
|
import type { AuthorizeIssuerParams, AuthorizeIssuerResult, CreateCompanyValuationReportParams, CreateCompanyValuationReportResult, CreateIssuerParams, GetConvertibleCancellationEventAsOcfParams, GetConvertibleIssuanceAsOcfParams, GetDocumentAsOcfParams, GetEquityCompensationCancellationEventAsOcfParams, GetEquityCompensationExerciseEventAsOcfParams, GetEquityCompensationIssuanceEventAsOcfParams, GetIssuerAsOcfParams, GetIssuerAsOcfResult, GetIssuerAuthorizedSharesAdjustmentEventAsOcfParams, GetStakeholderAsOcfParams, GetStockCancellationEventAsOcfParams, GetStockClassAsOcfParams, GetStockClassAsOcfResult, GetStockClassAuthorizedSharesAdjustmentEventAsOcfParams, GetStockIssuanceAsOcfParams, GetStockLegendTemplateAsOcfParams, GetStockPlanAsOcfParams, GetStockPlanPoolAdjustmentEventAsOcfParams, GetStockRepurchaseAsOcfParams, GetStockTransferAsOcfParams, GetVestingTermsAsOcfParams, GetWarrantCancellationEventAsOcfParams, GetWarrantIssuanceAsOcfParams, UpdateCompanyValuationParams, UpdateCompanyValuationResult, WithdrawAuthorizationParams, WithdrawAuthorizationResult } from './functions';
|
|
6
|
+
import { CapTableBatch } from './functions/OpenCapTable/capTable';
|
|
6
7
|
import type { CommandWithDisclosedContracts } from './types';
|
|
7
8
|
/**
|
|
8
9
|
* High-level client for interacting with Open Cap Table Protocol (OCP) contracts on Canton.
|
|
@@ -15,14 +16,12 @@ import type { CommandWithDisclosedContracts } from './types';
|
|
|
15
16
|
* - **PaymentStreams**: Recurring payment stream management
|
|
16
17
|
*
|
|
17
18
|
* @example
|
|
18
|
-
*
|
|
19
|
+
* Creating an issuer
|
|
19
20
|
* ```typescript
|
|
20
21
|
* import { OcpClient } from '@open-captable-protocol/canton';
|
|
21
22
|
*
|
|
22
|
-
* // Create client (uses default LocalNet config)
|
|
23
23
|
* const ocp = new OcpClient({ network: 'localnet' });
|
|
24
24
|
*
|
|
25
|
-
* // Build a command (for use with batching)
|
|
26
25
|
* const cmd = ocp.OpenCapTable.issuer.buildCreateIssuerCommand({
|
|
27
26
|
* issuerAuthorizationContractDetails: authDetails,
|
|
28
27
|
* featuredAppRightContractDetails: featuredDetails,
|
|
@@ -35,84 +34,34 @@ import type { CommandWithDisclosedContracts } from './types';
|
|
|
35
34
|
* tax_ids: [],
|
|
36
35
|
* },
|
|
37
36
|
* });
|
|
38
|
-
*
|
|
39
|
-
* // Submit with a batch
|
|
40
|
-
* const batch = ocp.createBatch({ actAs: ['alice::...'] });
|
|
41
|
-
* batch.addCommand(cmd.command, cmd.disclosedContracts);
|
|
42
|
-
* const result = await batch.submitAndWait();
|
|
43
37
|
* ```
|
|
44
38
|
*
|
|
45
39
|
* @example
|
|
46
|
-
*
|
|
40
|
+
* Batch cap table updates
|
|
47
41
|
* ```typescript
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
* ```typescript
|
|
60
|
-
* const batch = ocp.createBatch({ actAs: [issuerParty] });
|
|
61
|
-
*
|
|
62
|
-
* // Add multiple commands to a single transaction
|
|
63
|
-
* const issuerCmd = ocp.OpenCapTable.issuer.buildCreateIssuerCommand({...});
|
|
64
|
-
* const stockClassCmd = ocp.OpenCapTable.stockClass.buildCreateStockClassCommand({...});
|
|
65
|
-
*
|
|
66
|
-
* batch.addCommand(issuerCmd.command, issuerCmd.disclosedContracts);
|
|
67
|
-
* batch.addCommand(stockClassCmd.command, stockClassCmd.disclosedContracts);
|
|
68
|
-
*
|
|
69
|
-
* // Submit all commands atomically
|
|
70
|
-
* const result = await batch.submitAndWait();
|
|
42
|
+
* const result = await ocp.OpenCapTable.capTable
|
|
43
|
+
* .update({
|
|
44
|
+
* capTableContractId,
|
|
45
|
+
* featuredAppRightContractDetails,
|
|
46
|
+
* actAs: [issuerParty],
|
|
47
|
+
* })
|
|
48
|
+
* .create('stakeholder', stakeholderData)
|
|
49
|
+
* .create('stockClass', stockClassData)
|
|
50
|
+
* .edit('stakeholder', updatedStakeholderData)
|
|
51
|
+
* .delete('document', documentId)
|
|
52
|
+
* .execute();
|
|
71
53
|
* ```
|
|
72
54
|
*
|
|
73
55
|
* @see https://ocp.canton.fairmint.com/ - Full SDK documentation
|
|
74
|
-
* @see https://schema.opencaptablecoalition.com/ - OCF schema documentation
|
|
75
56
|
*/
|
|
76
57
|
export declare class OcpClient {
|
|
77
|
-
/**
|
|
78
|
-
* The underlying LedgerJsonApiClient for direct ledger access. Use this for low-level operations not covered by the
|
|
79
|
-
* high-level API.
|
|
80
|
-
*/
|
|
58
|
+
/** The underlying LedgerJsonApiClient for direct ledger access. */
|
|
81
59
|
readonly client: LedgerJsonApiClient;
|
|
82
60
|
/**
|
|
83
61
|
* Core cap table operations.
|
|
84
62
|
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
* - **issuer**: Company/issuer records
|
|
88
|
-
* - **stakeholder**: Shareholders, employees, investors
|
|
89
|
-
* - **stockClass**: Common/preferred stock classes
|
|
90
|
-
* - **stockIssuance**: Stock grants and purchases
|
|
91
|
-
* - **stockTransfer**: Secondary transfers
|
|
92
|
-
* - **stockCancellation**: Stock cancellations
|
|
93
|
-
* - **equityCompensationIssuance**: Options, RSUs, SARs
|
|
94
|
-
* - **equityCompensationExercise**: Option exercises
|
|
95
|
-
* - **vestingTerms**: Vesting schedules
|
|
96
|
-
* - **stockPlan**: Equity incentive plans
|
|
97
|
-
* - **convertibleIssuance**: SAFEs, convertible notes
|
|
98
|
-
* - **warrantIssuance**: Warrants
|
|
99
|
-
* - **document**: Document references
|
|
100
|
-
* - **issuerAuthorization**: Authorization management
|
|
101
|
-
* - And more...
|
|
102
|
-
*
|
|
103
|
-
* @example
|
|
104
|
-
* ```typescript
|
|
105
|
-
* // Create a stakeholder
|
|
106
|
-
* const cmd = ocp.OpenCapTable.stakeholder.buildCreateStakeholderCommand({
|
|
107
|
-
* issuerContractId: 'issuer-cid',
|
|
108
|
-
* featuredAppRightContractDetails: featured,
|
|
109
|
-
* stakeholderData: {
|
|
110
|
-
* id: 'sh-1',
|
|
111
|
-
* name: { legal_name: 'John Doe' },
|
|
112
|
-
* stakeholder_type: 'INDIVIDUAL',
|
|
113
|
-
* },
|
|
114
|
-
* });
|
|
115
|
-
* ```;
|
|
63
|
+
* Use `capTable.update()` for all creates, edits, and deletes of OCF entities. Use entity-specific `get*AsOcf()`
|
|
64
|
+
* methods to read data.
|
|
116
65
|
*/
|
|
117
66
|
OpenCapTable: {
|
|
118
67
|
issuer: {
|
|
@@ -121,42 +70,33 @@ export declare class OcpClient {
|
|
|
121
70
|
};
|
|
122
71
|
stockClass: {
|
|
123
72
|
getStockClassAsOcf: (params: GetStockClassAsOcfParams) => Promise<GetStockClassAsOcfResult>;
|
|
124
|
-
buildDeleteStockClassCommand: (params: import('./functions').DeleteStockClassParams) => CommandWithDisclosedContracts;
|
|
125
73
|
};
|
|
126
74
|
stakeholder: {
|
|
127
75
|
getStakeholderAsOcf: (params: GetStakeholderAsOcfParams) => Promise<import('./functions').GetStakeholderAsOcfResult>;
|
|
128
|
-
buildDeleteStakeholderCommand: (params: import('./functions').DeleteStakeholderParams) => CommandWithDisclosedContracts;
|
|
129
76
|
};
|
|
130
77
|
stockLegendTemplate: {
|
|
131
78
|
getStockLegendTemplateAsOcf: (params: GetStockLegendTemplateAsOcfParams) => Promise<import('./functions').GetStockLegendTemplateAsOcfResult>;
|
|
132
|
-
buildDeleteStockLegendTemplateCommand: (params: import('./functions').DeleteStockLegendTemplateParams) => CommandWithDisclosedContracts;
|
|
133
79
|
};
|
|
134
80
|
vestingTerms: {
|
|
135
81
|
getVestingTermsAsOcf: (params: GetVestingTermsAsOcfParams) => Promise<import('./functions').GetVestingTermsAsOcfResult>;
|
|
136
|
-
buildDeleteVestingTermsCommand: (params: import('./functions').DeleteVestingTermsParams) => CommandWithDisclosedContracts;
|
|
137
82
|
};
|
|
138
83
|
stockPlan: {
|
|
139
84
|
getStockPlanAsOcf: (params: GetStockPlanAsOcfParams) => Promise<import('./functions').GetStockPlanAsOcfResult>;
|
|
140
|
-
buildDeleteStockPlanCommand: (params: import('./functions').DeleteStockPlanParams) => CommandWithDisclosedContracts;
|
|
141
85
|
};
|
|
142
86
|
equityCompensationIssuance: {
|
|
143
87
|
getEquityCompensationIssuanceEventAsOcf: (params: GetEquityCompensationIssuanceEventAsOcfParams) => Promise<import('./functions').GetEquityCompensationIssuanceEventAsOcfResult>;
|
|
144
|
-
buildDeleteEquityCompensationIssuanceCommand: (params: import('./functions').DeleteEquityCompensationIssuanceParams) => CommandWithDisclosedContracts;
|
|
145
88
|
};
|
|
146
89
|
equityCompensationExercise: {
|
|
147
90
|
getEquityCompensationExerciseEventAsOcf: (params: GetEquityCompensationExerciseEventAsOcfParams) => Promise<import('./functions').GetEquityCompensationExerciseEventAsOcfResult>;
|
|
148
91
|
};
|
|
149
92
|
warrantIssuance: {
|
|
150
93
|
getWarrantIssuanceAsOcf: (params: GetWarrantIssuanceAsOcfParams) => Promise<import('./functions').GetWarrantIssuanceAsOcfResult>;
|
|
151
|
-
buildDeleteWarrantIssuanceCommand: (params: import('./functions').DeleteWarrantIssuanceParams) => CommandWithDisclosedContracts;
|
|
152
94
|
};
|
|
153
95
|
convertibleIssuance: {
|
|
154
96
|
getConvertibleIssuanceAsOcf: (params: GetConvertibleIssuanceAsOcfParams) => Promise<import('./functions').GetConvertibleIssuanceAsOcfResult>;
|
|
155
|
-
buildDeleteConvertibleIssuanceCommand: (params: import('./functions').DeleteConvertibleIssuanceParams) => CommandWithDisclosedContracts;
|
|
156
97
|
};
|
|
157
98
|
stockCancellation: {
|
|
158
99
|
getStockCancellationEventAsOcf: (params: GetStockCancellationEventAsOcfParams) => Promise<import('./functions').GetStockCancellationEventAsOcfResult>;
|
|
159
|
-
buildDeleteStockCancellationCommand: (params: import('./functions').DeleteStockCancellationParams) => CommandWithDisclosedContracts;
|
|
160
100
|
};
|
|
161
101
|
warrantCancellation: {
|
|
162
102
|
getWarrantCancellationEventAsOcf: (params: GetWarrantCancellationEventAsOcfParams) => Promise<import('./functions').GetWarrantCancellationEventAsOcfResult>;
|
|
@@ -169,53 +109,41 @@ export declare class OcpClient {
|
|
|
169
109
|
};
|
|
170
110
|
stockTransfer: {
|
|
171
111
|
getStockTransferAsOcf: (params: GetStockTransferAsOcfParams) => Promise<import('./functions').GetStockTransferAsOcfResult>;
|
|
172
|
-
buildDeleteStockTransferCommand: (params: import('./functions').DeleteStockTransferParams) => CommandWithDisclosedContracts;
|
|
173
112
|
};
|
|
174
113
|
issuerAuthorizedSharesAdjustment: {
|
|
175
114
|
getIssuerAuthorizedSharesAdjustmentEventAsOcf: (params: GetIssuerAuthorizedSharesAdjustmentEventAsOcfParams) => Promise<import('./functions').GetIssuerAuthorizedSharesAdjustmentEventAsOcfResult>;
|
|
176
|
-
buildDeleteIssuerAuthorizedSharesAdjustmentCommand: (params: import('./functions').DeleteIssuerAuthorizedSharesAdjustmentParams) => CommandWithDisclosedContracts;
|
|
177
115
|
};
|
|
178
116
|
stockClassAuthorizedSharesAdjustment: {
|
|
179
117
|
getStockClassAuthorizedSharesAdjustmentEventAsOcf: (params: GetStockClassAuthorizedSharesAdjustmentEventAsOcfParams) => Promise<import('./functions').GetStockClassAuthorizedSharesAdjustmentEventAsOcfResult>;
|
|
180
|
-
buildDeleteStockClassAuthorizedSharesAdjustmentCommand: (params: import('./functions').DeleteStockClassAuthorizedSharesAdjustmentParams) => CommandWithDisclosedContracts;
|
|
181
118
|
};
|
|
182
119
|
stockPlanPoolAdjustment: {
|
|
183
120
|
getStockPlanPoolAdjustmentEventAsOcf: (params: GetStockPlanPoolAdjustmentEventAsOcfParams) => Promise<import('./functions').GetStockPlanPoolAdjustmentEventAsOcfResult>;
|
|
184
|
-
buildDeleteStockPlanPoolAdjustmentCommand: (params: import('./functions').DeleteStockPlanPoolAdjustmentParams) => CommandWithDisclosedContracts;
|
|
185
121
|
};
|
|
186
122
|
stockIssuance: {
|
|
187
123
|
getStockIssuanceAsOcf: (params: GetStockIssuanceAsOcfParams) => Promise<import('./functions').GetStockIssuanceAsOcfResult>;
|
|
188
|
-
buildDeleteStockIssuanceCommand: (params: import('./functions').DeleteStockIssuanceParams) => CommandWithDisclosedContracts;
|
|
189
124
|
};
|
|
190
125
|
stockRepurchase: {
|
|
191
126
|
getStockRepurchaseAsOcf: (params: GetStockRepurchaseAsOcfParams) => Promise<import('./functions').GetStockRepurchaseAsOcfResult>;
|
|
192
|
-
buildCreateStockRepurchaseCommand: (params: import('./functions').CreateStockRepurchaseParams) => CommandWithDisclosedContracts;
|
|
193
|
-
buildDeleteStockRepurchaseCommand: (params: import('./functions').DeleteStockRepurchaseParams) => CommandWithDisclosedContracts;
|
|
194
127
|
};
|
|
195
128
|
document: {
|
|
196
129
|
getDocumentAsOcf: (params: GetDocumentAsOcfParams) => Promise<import('./functions').GetDocumentAsOcfResult>;
|
|
197
|
-
buildDeleteDocumentCommand: (params: import('./functions').DeleteDocumentParams) => CommandWithDisclosedContracts;
|
|
198
130
|
};
|
|
199
131
|
issuerAuthorization: {
|
|
200
132
|
authorizeIssuer: (params: AuthorizeIssuerParams) => Promise<AuthorizeIssuerResult>;
|
|
201
133
|
withdrawAuthorization: (params: WithdrawAuthorizationParams) => Promise<WithdrawAuthorizationResult>;
|
|
202
134
|
};
|
|
135
|
+
/** Batch cap table update operations for atomic creates, edits, and deletes. */
|
|
136
|
+
capTable: {
|
|
137
|
+
update: (params: {
|
|
138
|
+
capTableContractId: string;
|
|
139
|
+
featuredAppRightContractDetails: DisclosedContract;
|
|
140
|
+
capTableContractDetails?: DisclosedContract;
|
|
141
|
+
actAs: string[];
|
|
142
|
+
readAs?: string[];
|
|
143
|
+
}) => CapTableBatch;
|
|
144
|
+
};
|
|
203
145
|
};
|
|
204
|
-
/**
|
|
205
|
-
* Reporting operations for cap table analytics.
|
|
206
|
-
*
|
|
207
|
-
* Currently supports:
|
|
208
|
-
*
|
|
209
|
-
* - **companyValuationReport**: Company valuation tracking and reporting
|
|
210
|
-
*
|
|
211
|
-
* @example
|
|
212
|
-
* ```typescript
|
|
213
|
-
* const result = await ocp.OpenCapTableReports.companyValuationReport.createCompanyValuationReport({
|
|
214
|
-
* issuerContractId: 'issuer-cid',
|
|
215
|
-
* // ... valuation data
|
|
216
|
-
* });
|
|
217
|
-
* ```;
|
|
218
|
-
*/
|
|
146
|
+
/** Reporting operations for cap table analytics. */
|
|
219
147
|
OpenCapTableReports: {
|
|
220
148
|
companyValuationReport: {
|
|
221
149
|
addObserversToCompanyValuationReport: (params: {
|
|
@@ -230,23 +158,7 @@ export declare class OcpClient {
|
|
|
230
158
|
buildCreateCompanyValuationReportCommand: (params: CreateCompanyValuationReportParams) => CommandWithDisclosedContracts;
|
|
231
159
|
};
|
|
232
160
|
};
|
|
233
|
-
/**
|
|
234
|
-
* Payment and airdrop operations using Canton's native token (Amulet/CC).
|
|
235
|
-
*
|
|
236
|
-
* Provides:
|
|
237
|
-
*
|
|
238
|
-
* - **airdrop**: Multi-recipient token airdrops with join mechanism
|
|
239
|
-
* - **simpleAirdrop**: Direct token distribution to recipients
|
|
240
|
-
*
|
|
241
|
-
* @example
|
|
242
|
-
* ```typescript
|
|
243
|
-
* const cmd = ocp.CantonPayments.simpleAirdrop.buildCreateSimpleAirdropCommand({
|
|
244
|
-
* sender: senderParty,
|
|
245
|
-
* recipients: [{ party: recipient1, amount: '100' }],
|
|
246
|
-
* // ...
|
|
247
|
-
* });
|
|
248
|
-
* ```;
|
|
249
|
-
*/
|
|
161
|
+
/** Payment and airdrop operations using Canton's native token. */
|
|
250
162
|
CantonPayments: {
|
|
251
163
|
airdrop: {
|
|
252
164
|
buildCreateAirdropCommand: (params: import('./functions').CreateAirdropParams) => Command;
|
|
@@ -261,28 +173,7 @@ export declare class OcpClient {
|
|
|
261
173
|
buildExecuteSimpleAirdropCommand: (params: import('./functions').ExecuteSimpleAirdropParams) => Command;
|
|
262
174
|
};
|
|
263
175
|
};
|
|
264
|
-
/**
|
|
265
|
-
* Recurring payment stream management.
|
|
266
|
-
*
|
|
267
|
-
* Enables subscription-style payments with:
|
|
268
|
-
*
|
|
269
|
-
* - **paymentStreamFactory**: Create new payment stream proposals
|
|
270
|
-
* - **proposedPaymentStream**: Approve/reject/start proposed streams
|
|
271
|
-
* - **activePaymentStream**: Process payments, cancel, modify active streams
|
|
272
|
-
* - **paymentStreamChangeProposal**: Handle stream modification proposals
|
|
273
|
-
* - **partyMigrationProposal**: Migrate streams between parties
|
|
274
|
-
* - **utils**: Helper functions for building payment contexts
|
|
275
|
-
*
|
|
276
|
-
* @example
|
|
277
|
-
* ```typescript
|
|
278
|
-
* // Create a payment stream proposal
|
|
279
|
-
* const cmd = ocp.PaymentStreams.paymentStreamFactory.buildCreatePaymentStreamProposalCommand({
|
|
280
|
-
* payer: payerParty,
|
|
281
|
-
* payee: payeeParty,
|
|
282
|
-
* // ... stream configuration
|
|
283
|
-
* });
|
|
284
|
-
* ```;
|
|
285
|
-
*/
|
|
176
|
+
/** Recurring payment stream management. */
|
|
286
177
|
PaymentStreams: {
|
|
287
178
|
paymentStreamFactory: {
|
|
288
179
|
buildCreatePaymentStreamProposalCommand: (params: import('./functions').CreatePaymentStreamProposalParams) => CommandWithDisclosedContracts;
|
|
@@ -331,62 +222,8 @@ export declare class OcpClient {
|
|
|
331
222
|
buildPaymentContextWithAmulets: (validatorClient: import('@fairmint/canton-node-sdk').ValidatorApiClient, payerParty: string, requestedAmount: string, provider: string) => Promise<import('./functions').PaymentContextWithAmuletsAndDisclosed>;
|
|
332
223
|
};
|
|
333
224
|
};
|
|
334
|
-
/**
|
|
335
|
-
* Create a new OcpClient instance.
|
|
336
|
-
*
|
|
337
|
-
* @example
|
|
338
|
-
* LocalNet(cn - quickstart)```typescript
|
|
339
|
-
* const ocp = new OcpClient({ network: 'localnet' });
|
|
340
|
-
* ```;
|
|
341
|
-
*
|
|
342
|
-
* @example
|
|
343
|
-
* DevNet with auth
|
|
344
|
-
* ```typescript
|
|
345
|
-
* const ocp = new OcpClient({
|
|
346
|
-
* network: 'devnet',
|
|
347
|
-
* authUrl: 'https://auth.example.com',
|
|
348
|
-
* apis: {
|
|
349
|
-
* LEDGER_JSON_API: {
|
|
350
|
-
* apiUrl: 'https://ledger.example.com',
|
|
351
|
-
* auth: {
|
|
352
|
-
* grantType: 'client_credentials',
|
|
353
|
-
* clientId: 'my-client',
|
|
354
|
-
* clientSecret: 'secret',
|
|
355
|
-
* },
|
|
356
|
-
* },
|
|
357
|
-
* },
|
|
358
|
-
* });
|
|
359
|
-
* ```
|
|
360
|
-
*
|
|
361
|
-
* @param config - Optional client configuration. If not provided, uses environment defaults.
|
|
362
|
-
*/
|
|
363
225
|
constructor(config?: ClientConfig);
|
|
364
|
-
/**
|
|
365
|
-
* Create a new transaction batch for submitting multiple commands atomically.
|
|
366
|
-
*
|
|
367
|
-
* Use batches when you need to execute multiple operations in a single transaction, ensuring all-or-nothing
|
|
368
|
-
* semantics.
|
|
369
|
-
*
|
|
370
|
-
* @example
|
|
371
|
-
* ```typescript
|
|
372
|
-
* const batch = ocp.createBatch({ actAs: [issuerParty] });
|
|
373
|
-
*
|
|
374
|
-
* // Add commands
|
|
375
|
-
* const cmd1 = ocp.OpenCapTable.stakeholder.buildCreateStakeholderCommand({...});
|
|
376
|
-
* const cmd2 = ocp.OpenCapTable.stockClass.buildCreateStockClassCommand({...});
|
|
377
|
-
*
|
|
378
|
-
* batch.addCommand(cmd1.command, cmd1.disclosedContracts);
|
|
379
|
-
* batch.addCommand(cmd2.command, cmd2.disclosedContracts);
|
|
380
|
-
*
|
|
381
|
-
* // Submit atomically
|
|
382
|
-
* const result = await batch.submitAndWait();
|
|
383
|
-
* ```;
|
|
384
|
-
*
|
|
385
|
-
* @param params - Batch parameters
|
|
386
|
-
* @param params.actAs - Party IDs to act as (signatories)
|
|
387
|
-
* @param params.readAs - Optional additional party IDs for read access
|
|
388
|
-
* @returns A TransactionBatch instance for adding commands
|
|
389
|
-
*/
|
|
226
|
+
/** Create a new transaction batch for submitting multiple commands atomically. */
|
|
390
227
|
createBatch(params: {
|
|
391
228
|
actAs: string[];
|
|
392
229
|
readAs?: string[];
|
package/dist/OcpClient.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OcpClient.d.ts","sourceRoot":"","sources":["../src/OcpClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,6DAA6D,CAAC;AAClG,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"OcpClient.d.ts","sourceRoot":"","sources":["../src/OcpClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,6DAA6D,CAAC;AAClG,OAAO,KAAK,EACV,OAAO,EACP,iBAAiB,EAClB,MAAM,kFAAkF,CAAC;AAC1F,OAAO,EAAE,gBAAgB,EAAE,MAAM,wDAAwD,CAAC;AAC1F,OAAO,KAAK,EACV,qBAAqB,EACrB,qBAAqB,EACrB,kCAAkC,EAClC,kCAAkC,EAClC,kBAAkB,EAClB,0CAA0C,EAC1C,iCAAiC,EACjC,sBAAsB,EACtB,iDAAiD,EACjD,6CAA6C,EAC7C,6CAA6C,EAC7C,oBAAoB,EACpB,oBAAoB,EACpB,mDAAmD,EACnD,yBAAyB,EACzB,oCAAoC,EACpC,wBAAwB,EACxB,wBAAwB,EACxB,uDAAuD,EACvD,2BAA2B,EAC3B,iCAAiC,EACjC,uBAAuB,EACvB,0CAA0C,EAC1C,6BAA6B,EAC7B,2BAA2B,EAC3B,0BAA0B,EAC1B,sCAAsC,EACtC,6BAA6B,EAC7B,4BAA4B,EAC5B,4BAA4B,EAC5B,2BAA2B,EAC3B,2BAA2B,EAC5B,MAAM,aAAa,CAAC;AA+BrB,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,SAAS,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,qBAAa,SAAS;IACpB,mEAAmE;IACnE,SAAgB,MAAM,EAAE,mBAAmB,CAAC;IAE5C;;;;;OAKG;IACI,YAAY,EAAE;QACnB,MAAM,EAAE;YACN,wBAAwB,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,6BAA6B,CAAC;YACxF,cAAc,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAC;SACjF,CAAC;QACF,UAAU,EAAE;YACV,kBAAkB,EAAE,CAAC,MAAM,EAAE,wBAAwB,KAAK,OAAO,CAAC,wBAAwB,CAAC,CAAC;SAC7F,CAAC;QACF,WAAW,EAAE;YACX,mBAAmB,EAAE,CACnB,MAAM,EAAE,yBAAyB,KAC9B,OAAO,CAAC,OAAO,aAAa,EAAE,yBAAyB,CAAC,CAAC;SAC/D,CAAC;QACF,mBAAmB,EAAE;YACnB,2BAA2B,EAAE,CAC3B,MAAM,EAAE,iCAAiC,KACtC,OAAO,CAAC,OAAO,aAAa,EAAE,iCAAiC,CAAC,CAAC;SACvE,CAAC;QACF,YAAY,EAAE;YACZ,oBAAoB,EAAE,CACpB,MAAM,EAAE,0BAA0B,KAC/B,OAAO,CAAC,OAAO,aAAa,EAAE,0BAA0B,CAAC,CAAC;SAChE,CAAC;QACF,SAAS,EAAE;YACT,iBAAiB,EAAE,CAAC,MAAM,EAAE,uBAAuB,KAAK,OAAO,CAAC,OAAO,aAAa,EAAE,uBAAuB,CAAC,CAAC;SAChH,CAAC;QACF,0BAA0B,EAAE;YAC1B,uCAAuC,EAAE,CACvC,MAAM,EAAE,6CAA6C,KAClD,OAAO,CAAC,OAAO,aAAa,EAAE,6CAA6C,CAAC,CAAC;SACnF,CAAC;QACF,0BAA0B,EAAE;YAC1B,uCAAuC,EAAE,CACvC,MAAM,EAAE,6CAA6C,KAClD,OAAO,CAAC,OAAO,aAAa,EAAE,6CAA6C,CAAC,CAAC;SACnF,CAAC;QACF,eAAe,EAAE;YACf,uBAAuB,EAAE,CACvB,MAAM,EAAE,6BAA6B,KAClC,OAAO,CAAC,OAAO,aAAa,EAAE,6BAA6B,CAAC,CAAC;SACnE,CAAC;QACF,mBAAmB,EAAE;YACnB,2BAA2B,EAAE,CAC3B,MAAM,EAAE,iCAAiC,KACtC,OAAO,CAAC,OAAO,aAAa,EAAE,iCAAiC,CAAC,CAAC;SACvE,CAAC;QACF,iBAAiB,EAAE;YACjB,8BAA8B,EAAE,CAC9B,MAAM,EAAE,oCAAoC,KACzC,OAAO,CAAC,OAAO,aAAa,EAAE,oCAAoC,CAAC,CAAC;SAC1E,CAAC;QACF,mBAAmB,EAAE;YACnB,gCAAgC,EAAE,CAChC,MAAM,EAAE,sCAAsC,KAC3C,OAAO,CAAC,OAAO,aAAa,EAAE,sCAAsC,CAAC,CAAC;SAC5E,CAAC;QACF,uBAAuB,EAAE;YACvB,oCAAoC,EAAE,CACpC,MAAM,EAAE,0CAA0C,KAC/C,OAAO,CAAC,OAAO,aAAa,EAAE,0CAA0C,CAAC,CAAC;SAChF,CAAC;QACF,8BAA8B,EAAE;YAC9B,2CAA2C,EAAE,CAC3C,MAAM,EAAE,iDAAiD,KACtD,OAAO,CAAC,OAAO,aAAa,EAAE,iDAAiD,CAAC,CAAC;SACvF,CAAC;QACF,aAAa,EAAE;YACb,qBAAqB,EAAE,CACrB,MAAM,EAAE,2BAA2B,KAChC,OAAO,CAAC,OAAO,aAAa,EAAE,2BAA2B,CAAC,CAAC;SACjE,CAAC;QACF,gCAAgC,EAAE;YAChC,6CAA6C,EAAE,CAC7C,MAAM,EAAE,mDAAmD,KACxD,OAAO,CAAC,OAAO,aAAa,EAAE,mDAAmD,CAAC,CAAC;SACzF,CAAC;QACF,oCAAoC,EAAE;YACpC,iDAAiD,EAAE,CACjD,MAAM,EAAE,uDAAuD,KAC5D,OAAO,CAAC,OAAO,aAAa,EAAE,uDAAuD,CAAC,CAAC;SAC7F,CAAC;QACF,uBAAuB,EAAE;YACvB,oCAAoC,EAAE,CACpC,MAAM,EAAE,0CAA0C,KAC/C,OAAO,CAAC,OAAO,aAAa,EAAE,0CAA0C,CAAC,CAAC;SAChF,CAAC;QACF,aAAa,EAAE;YACb,qBAAqB,EAAE,CACrB,MAAM,EAAE,2BAA2B,KAChC,OAAO,CAAC,OAAO,aAAa,EAAE,2BAA2B,CAAC,CAAC;SACjE,CAAC;QACF,eAAe,EAAE;YACf,uBAAuB,EAAE,CACvB,MAAM,EAAE,6BAA6B,KAClC,OAAO,CAAC,OAAO,aAAa,EAAE,6BAA6B,CAAC,CAAC;SACnE,CAAC;QACF,QAAQ,EAAE;YACR,gBAAgB,EAAE,CAAC,MAAM,EAAE,sBAAsB,KAAK,OAAO,CAAC,OAAO,aAAa,EAAE,sBAAsB,CAAC,CAAC;SAC7G,CAAC;QACF,mBAAmB,EAAE;YACnB,eAAe,EAAE,CAAC,MAAM,EAAE,qBAAqB,KAAK,OAAO,CAAC,qBAAqB,CAAC,CAAC;YACnF,qBAAqB,EAAE,CAAC,MAAM,EAAE,2BAA2B,KAAK,OAAO,CAAC,2BAA2B,CAAC,CAAC;SACtG,CAAC;QACF,gFAAgF;QAChF,QAAQ,EAAE;YACR,MAAM,EAAE,CAAC,MAAM,EAAE;gBACf,kBAAkB,EAAE,MAAM,CAAC;gBAC3B,+BAA+B,EAAE,iBAAiB,CAAC;gBACnD,uBAAuB,CAAC,EAAE,iBAAiB,CAAC;gBAC5C,KAAK,EAAE,MAAM,EAAE,CAAC;gBAChB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;aACnB,KAAK,aAAa,CAAC;SACrB,CAAC;KACH,CAAC;IAEF,oDAAoD;IAC7C,mBAAmB,EAAE;QAC1B,sBAAsB,EAAE;YACtB,oCAAoC,EAAE,CAAC,MAAM,EAAE;gBAC7C,gCAAgC,EAAE,MAAM,CAAC;gBACzC,KAAK,EAAE,MAAM,EAAE,CAAC;aACjB,KAAK,OAAO,CAAC;gBAAE,UAAU,EAAE,MAAM,CAAC;gBAAC,QAAQ,EAAE,MAAM,CAAA;aAAE,CAAC,CAAC;YACxD,4BAA4B,EAAE,CAC5B,MAAM,EAAE,kCAAkC,KACvC,OAAO,CAAC,kCAAkC,CAAC,CAAC;YACjD,4BAA4B,EAAE,CAAC,MAAM,EAAE,4BAA4B,KAAK,OAAO,CAAC,4BAA4B,CAAC,CAAC;YAC9G,wCAAwC,EAAE,CACxC,MAAM,EAAE,kCAAkC,KACvC,6BAA6B,CAAC;SACpC,CAAC;KACH,CAAC;IAEF,kEAAkE;IAC3D,cAAc,EAAE;QACrB,OAAO,EAAE;YACP,yBAAyB,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,mBAAmB,KAAK,OAAO,CAAC;YAC1F,+BAA+B,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,yBAAyB,KAAK,OAAO,CAAC;YACtG,iCAAiC,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,2BAA2B,KAAK,OAAO,CAAC;YAC1G,uBAAuB,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,iBAAiB,KAAK,6BAA6B,CAAC;YAC5G,0BAA0B,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,oBAAoB,KAAK,OAAO,CAAC;SAC7F,CAAC;QACF,aAAa,EAAE;YACb,+BAA+B,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,yBAAyB,KAAK,OAAO,CAAC;YACtG,gCAAgC,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,0BAA0B,KAAK,OAAO,CAAC;YACxG,gCAAgC,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,0BAA0B,KAAK,OAAO,CAAC;SACzG,CAAC;KACH,CAAC;IAEF,2CAA2C;IACpC,cAAc,EAAE;QACrB,oBAAoB,EAAE;YACpB,uCAAuC,EAAE,CACvC,MAAM,EAAE,OAAO,aAAa,EAAE,iCAAiC,KAC5D,6BAA6B,CAAC;SACpC,CAAC;QACF,qBAAqB,EAAE;YACrB,mBAAmB,EAAE,CACnB,MAAM,EAAE,OAAO,aAAa,EAAE,kCAAkC,KAC7D,6BAA6B,CAAC;YACnC,8BAA8B,EAAE,CAC9B,MAAM,EAAE,OAAO,aAAa,EAAE,gCAAgC,KAC3D,6BAA6B,CAAC;YACnC,qCAAqC,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,+BAA+B,KAAK,OAAO,CAAC;YAClH,oBAAoB,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,mCAAmC,KAAK,OAAO,CAAC;YACrG,uBAAuB,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,sCAAsC,KAAK,OAAO,CAAC;SAC5G,CAAC;QACF,mBAAmB,EAAE;YACnB,0BAA0B,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,oBAAoB,KAAK,6BAA6B,CAAC;YAClH,4BAA4B,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,sBAAsB,KAAK,OAAO,CAAC;YAChG,kBAAkB,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,yBAAyB,KAAK,OAAO,CAAC;YACzF,0BAA0B,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,oBAAoB,KAAK,OAAO,CAAC;YAC5F,kBAAkB,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,yBAAyB,KAAK,OAAO,CAAC;YACzF,wCAAwC,EAAE,CACxC,MAAM,EAAE,OAAO,aAAa,EAAE,kCAAkC,KAC7D,OAAO,CAAC;YACb,uBAAuB,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,oCAAoC,KAAK,OAAO,CAAC;SAC1G,CAAC;QACF,2BAA2B,EAAE;YAC3B,mBAAmB,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,wCAAwC,KAAK,OAAO,CAAC;YACzG,iBAAiB,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,sCAAsC,KAAK,OAAO,CAAC;YACrG,kBAAkB,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,uCAAuC,KAAK,OAAO,CAAC;SACxG,CAAC;QACF,sBAAsB,EAAE;YACtB,mBAAmB,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,mCAAmC,KAAK,OAAO,CAAC;YACpG,sCAAsC,EAAE,CACtC,MAAM,EAAE,OAAO,aAAa,EAAE,gCAAgC,KAC3D,OAAO,CAAC;YACb,wCAAwC,EAAE,CACxC,MAAM,EAAE,OAAO,aAAa,EAAE,kCAAkC,KAC7D,OAAO,CAAC;YACb,mBAAmB,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,mCAAmC,KAAK,OAAO,CAAC;SACrG,CAAC;QACF,KAAK,EAAE;YACL,4BAA4B,EAAE,MAAM,KAAK,CAAC;gBACxC,UAAU,EAAE,MAAM,CAAC;gBACnB,UAAU,EAAE,MAAM,CAAC;gBACnB,gBAAgB,EAAE,MAAM,CAAC;gBACzB,cAAc,EAAE,MAAM,CAAC;aACxB,CAAC,CAAC;YACH,0CAA0C,EAAE,CAC1C,+BAA+B,EAAE,MAAM,EACvC,MAAM,CAAC,EAAE,MAAM,EAAE,KACd,OAAO,CAAC,KAAK,CAAC;gBAAE,UAAU,EAAE,MAAM,CAAC;gBAAC,UAAU,EAAE,MAAM,CAAC;gBAAC,gBAAgB,EAAE,MAAM,CAAC;gBAAC,cAAc,EAAE,MAAM,CAAA;aAAE,CAAC,CAAC,CAAC;YAClH,mBAAmB,EAAE,CACnB,eAAe,EAAE,OAAO,2BAA2B,EAAE,kBAAkB,EACvE,QAAQ,CAAC,EAAE,MAAM,KACd,OAAO,CAAC,OAAO,aAAa,EAAE,oCAAoC,CAAC,CAAC;YACzE,8BAA8B,EAAE,CAC9B,eAAe,EAAE,OAAO,2BAA2B,EAAE,kBAAkB,EACvE,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,MAAM,KACb,OAAO,CAAC,OAAO,aAAa,EAAE,qCAAqC,CAAC,CAAC;SAC3E,CAAC;KACH,CAAC;gBAEU,MAAM,CAAC,EAAE,YAAY;IA+PjC,kFAAkF;IAC3E,WAAW,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,GAAG,gBAAgB;CAGrF"}
|
package/dist/OcpClient.js
CHANGED
|
@@ -4,6 +4,7 @@ exports.OcpClient = void 0;
|
|
|
4
4
|
const ledger_json_api_1 = require("@fairmint/canton-node-sdk/build/src/clients/ledger-json-api");
|
|
5
5
|
const transactions_1 = require("@fairmint/canton-node-sdk/build/src/utils/transactions");
|
|
6
6
|
const functions_1 = require("./functions");
|
|
7
|
+
const capTable_1 = require("./functions/OpenCapTable/capTable");
|
|
7
8
|
/**
|
|
8
9
|
* High-level client for interacting with Open Cap Table Protocol (OCP) contracts on Canton.
|
|
9
10
|
*
|
|
@@ -15,14 +16,12 @@ const functions_1 = require("./functions");
|
|
|
15
16
|
* - **PaymentStreams**: Recurring payment stream management
|
|
16
17
|
*
|
|
17
18
|
* @example
|
|
18
|
-
*
|
|
19
|
+
* Creating an issuer
|
|
19
20
|
* ```typescript
|
|
20
21
|
* import { OcpClient } from '@open-captable-protocol/canton';
|
|
21
22
|
*
|
|
22
|
-
* // Create client (uses default LocalNet config)
|
|
23
23
|
* const ocp = new OcpClient({ network: 'localnet' });
|
|
24
24
|
*
|
|
25
|
-
* // Build a command (for use with batching)
|
|
26
25
|
* const cmd = ocp.OpenCapTable.issuer.buildCreateIssuerCommand({
|
|
27
26
|
* issuerAuthorizationContractDetails: authDetails,
|
|
28
27
|
* featuredAppRightContractDetails: featuredDetails,
|
|
@@ -35,77 +34,29 @@ const functions_1 = require("./functions");
|
|
|
35
34
|
* tax_ids: [],
|
|
36
35
|
* },
|
|
37
36
|
* });
|
|
38
|
-
*
|
|
39
|
-
* // Submit with a batch
|
|
40
|
-
* const batch = ocp.createBatch({ actAs: ['alice::...'] });
|
|
41
|
-
* batch.addCommand(cmd.command, cmd.disclosedContracts);
|
|
42
|
-
* const result = await batch.submitAndWait();
|
|
43
37
|
* ```
|
|
44
38
|
*
|
|
45
39
|
* @example
|
|
46
|
-
*
|
|
40
|
+
* Batch cap table updates
|
|
47
41
|
* ```typescript
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
* ```typescript
|
|
60
|
-
* const batch = ocp.createBatch({ actAs: [issuerParty] });
|
|
61
|
-
*
|
|
62
|
-
* // Add multiple commands to a single transaction
|
|
63
|
-
* const issuerCmd = ocp.OpenCapTable.issuer.buildCreateIssuerCommand({...});
|
|
64
|
-
* const stockClassCmd = ocp.OpenCapTable.stockClass.buildCreateStockClassCommand({...});
|
|
65
|
-
*
|
|
66
|
-
* batch.addCommand(issuerCmd.command, issuerCmd.disclosedContracts);
|
|
67
|
-
* batch.addCommand(stockClassCmd.command, stockClassCmd.disclosedContracts);
|
|
68
|
-
*
|
|
69
|
-
* // Submit all commands atomically
|
|
70
|
-
* const result = await batch.submitAndWait();
|
|
42
|
+
* const result = await ocp.OpenCapTable.capTable
|
|
43
|
+
* .update({
|
|
44
|
+
* capTableContractId,
|
|
45
|
+
* featuredAppRightContractDetails,
|
|
46
|
+
* actAs: [issuerParty],
|
|
47
|
+
* })
|
|
48
|
+
* .create('stakeholder', stakeholderData)
|
|
49
|
+
* .create('stockClass', stockClassData)
|
|
50
|
+
* .edit('stakeholder', updatedStakeholderData)
|
|
51
|
+
* .delete('document', documentId)
|
|
52
|
+
* .execute();
|
|
71
53
|
* ```
|
|
72
54
|
*
|
|
73
55
|
* @see https://ocp.canton.fairmint.com/ - Full SDK documentation
|
|
74
|
-
* @see https://schema.opencaptablecoalition.com/ - OCF schema documentation
|
|
75
56
|
*/
|
|
76
57
|
class OcpClient {
|
|
77
|
-
/**
|
|
78
|
-
* Create a new OcpClient instance.
|
|
79
|
-
*
|
|
80
|
-
* @example
|
|
81
|
-
* LocalNet(cn - quickstart)```typescript
|
|
82
|
-
* const ocp = new OcpClient({ network: 'localnet' });
|
|
83
|
-
* ```;
|
|
84
|
-
*
|
|
85
|
-
* @example
|
|
86
|
-
* DevNet with auth
|
|
87
|
-
* ```typescript
|
|
88
|
-
* const ocp = new OcpClient({
|
|
89
|
-
* network: 'devnet',
|
|
90
|
-
* authUrl: 'https://auth.example.com',
|
|
91
|
-
* apis: {
|
|
92
|
-
* LEDGER_JSON_API: {
|
|
93
|
-
* apiUrl: 'https://ledger.example.com',
|
|
94
|
-
* auth: {
|
|
95
|
-
* grantType: 'client_credentials',
|
|
96
|
-
* clientId: 'my-client',
|
|
97
|
-
* clientSecret: 'secret',
|
|
98
|
-
* },
|
|
99
|
-
* },
|
|
100
|
-
* },
|
|
101
|
-
* });
|
|
102
|
-
* ```
|
|
103
|
-
*
|
|
104
|
-
* @param config - Optional client configuration. If not provided, uses environment defaults.
|
|
105
|
-
*/
|
|
106
58
|
constructor(config) {
|
|
107
59
|
this.client = new ledger_json_api_1.LedgerJsonApiClient(config);
|
|
108
|
-
// OpenCapTable namespace
|
|
109
60
|
this.OpenCapTable = {
|
|
110
61
|
issuer: {
|
|
111
62
|
buildCreateIssuerCommand: (params) => (0, functions_1.buildCreateIssuerCommand)(params),
|
|
@@ -113,42 +64,33 @@ class OcpClient {
|
|
|
113
64
|
},
|
|
114
65
|
stockClass: {
|
|
115
66
|
getStockClassAsOcf: async (params) => (0, functions_1.getStockClassAsOcf)(this.client, params),
|
|
116
|
-
buildDeleteStockClassCommand: (params) => (0, functions_1.buildDeleteStockClassCommand)(params),
|
|
117
67
|
},
|
|
118
68
|
stakeholder: {
|
|
119
69
|
getStakeholderAsOcf: async (params) => (0, functions_1.getStakeholderAsOcf)(this.client, params),
|
|
120
|
-
buildDeleteStakeholderCommand: (params) => (0, functions_1.buildDeleteStakeholderCommand)(params),
|
|
121
70
|
},
|
|
122
71
|
stockLegendTemplate: {
|
|
123
72
|
getStockLegendTemplateAsOcf: async (params) => (0, functions_1.getStockLegendTemplateAsOcf)(this.client, params),
|
|
124
|
-
buildDeleteStockLegendTemplateCommand: (params) => (0, functions_1.buildDeleteStockLegendTemplateCommand)(params),
|
|
125
73
|
},
|
|
126
74
|
vestingTerms: {
|
|
127
75
|
getVestingTermsAsOcf: async (params) => (0, functions_1.getVestingTermsAsOcf)(this.client, params),
|
|
128
|
-
buildDeleteVestingTermsCommand: (params) => (0, functions_1.buildDeleteVestingTermsCommand)(params),
|
|
129
76
|
},
|
|
130
77
|
stockPlan: {
|
|
131
78
|
getStockPlanAsOcf: async (params) => (0, functions_1.getStockPlanAsOcf)(this.client, params),
|
|
132
|
-
buildDeleteStockPlanCommand: (params) => (0, functions_1.buildDeleteStockPlanCommand)(params),
|
|
133
79
|
},
|
|
134
80
|
equityCompensationIssuance: {
|
|
135
81
|
getEquityCompensationIssuanceEventAsOcf: async (params) => (0, functions_1.getEquityCompensationIssuanceEventAsOcf)(this.client, params),
|
|
136
|
-
buildDeleteEquityCompensationIssuanceCommand: (params) => (0, functions_1.buildDeleteEquityCompensationIssuanceCommand)(params),
|
|
137
82
|
},
|
|
138
83
|
equityCompensationExercise: {
|
|
139
84
|
getEquityCompensationExerciseEventAsOcf: async (params) => (0, functions_1.getEquityCompensationExerciseEventAsOcf)(this.client, params),
|
|
140
85
|
},
|
|
141
86
|
warrantIssuance: {
|
|
142
87
|
getWarrantIssuanceAsOcf: async (params) => (0, functions_1.getWarrantIssuanceAsOcf)(this.client, params),
|
|
143
|
-
buildDeleteWarrantIssuanceCommand: (params) => (0, functions_1.buildDeleteWarrantIssuanceCommand)(params),
|
|
144
88
|
},
|
|
145
89
|
convertibleIssuance: {
|
|
146
90
|
getConvertibleIssuanceAsOcf: async (params) => (0, functions_1.getConvertibleIssuanceAsOcf)(this.client, params),
|
|
147
|
-
buildDeleteConvertibleIssuanceCommand: (params) => (0, functions_1.buildDeleteConvertibleIssuanceCommand)(params),
|
|
148
91
|
},
|
|
149
92
|
stockCancellation: {
|
|
150
93
|
getStockCancellationEventAsOcf: async (params) => (0, functions_1.getStockCancellationEventAsOcf)(this.client, params),
|
|
151
|
-
buildDeleteStockCancellationCommand: (params) => (0, functions_1.buildDeleteStockCancellationCommand)(params),
|
|
152
94
|
},
|
|
153
95
|
warrantCancellation: {
|
|
154
96
|
getWarrantCancellationEventAsOcf: async (params) => (0, functions_1.getWarrantCancellationEventAsOcf)(this.client, params),
|
|
@@ -161,39 +103,33 @@ class OcpClient {
|
|
|
161
103
|
},
|
|
162
104
|
stockTransfer: {
|
|
163
105
|
getStockTransferAsOcf: async (params) => (0, functions_1.getStockTransferAsOcf)(this.client, params),
|
|
164
|
-
buildDeleteStockTransferCommand: (params) => (0, functions_1.buildDeleteStockTransferCommand)(params),
|
|
165
106
|
},
|
|
166
107
|
issuerAuthorizedSharesAdjustment: {
|
|
167
108
|
getIssuerAuthorizedSharesAdjustmentEventAsOcf: async (params) => (0, functions_1.getIssuerAuthorizedSharesAdjustmentEventAsOcf)(this.client, params),
|
|
168
|
-
buildDeleteIssuerAuthorizedSharesAdjustmentCommand: (params) => (0, functions_1.buildDeleteIssuerAuthorizedSharesAdjustmentCommand)(params),
|
|
169
109
|
},
|
|
170
110
|
stockClassAuthorizedSharesAdjustment: {
|
|
171
111
|
getStockClassAuthorizedSharesAdjustmentEventAsOcf: async (params) => (0, functions_1.getStockClassAuthorizedSharesAdjustmentEventAsOcf)(this.client, params),
|
|
172
|
-
buildDeleteStockClassAuthorizedSharesAdjustmentCommand: (params) => (0, functions_1.buildDeleteStockClassAuthorizedSharesAdjustmentCommand)(params),
|
|
173
112
|
},
|
|
174
113
|
stockPlanPoolAdjustment: {
|
|
175
114
|
getStockPlanPoolAdjustmentEventAsOcf: async (params) => (0, functions_1.getStockPlanPoolAdjustmentEventAsOcf)(this.client, params),
|
|
176
|
-
buildDeleteStockPlanPoolAdjustmentCommand: (params) => (0, functions_1.buildDeleteStockPlanPoolAdjustmentCommand)(params),
|
|
177
115
|
},
|
|
178
116
|
document: {
|
|
179
117
|
getDocumentAsOcf: async (params) => (0, functions_1.getDocumentAsOcf)(this.client, params),
|
|
180
|
-
buildDeleteDocumentCommand: (params) => (0, functions_1.buildDeleteDocumentCommand)(params),
|
|
181
118
|
},
|
|
182
119
|
stockIssuance: {
|
|
183
120
|
getStockIssuanceAsOcf: async (params) => (0, functions_1.getStockIssuanceAsOcf)(this.client, params),
|
|
184
|
-
buildDeleteStockIssuanceCommand: (params) => (0, functions_1.buildDeleteStockIssuanceCommand)(params),
|
|
185
121
|
},
|
|
186
122
|
stockRepurchase: {
|
|
187
123
|
getStockRepurchaseAsOcf: async (params) => (0, functions_1.getStockRepurchaseAsOcf)(this.client, params),
|
|
188
|
-
buildCreateStockRepurchaseCommand: (params) => (0, functions_1.buildCreateStockRepurchaseCommand)(params),
|
|
189
|
-
buildDeleteStockRepurchaseCommand: (params) => (0, functions_1.buildDeleteStockRepurchaseCommand)(params),
|
|
190
124
|
},
|
|
191
125
|
issuerAuthorization: {
|
|
192
126
|
authorizeIssuer: async (params) => (0, functions_1.authorizeIssuer)(this.client, params),
|
|
193
127
|
withdrawAuthorization: async (params) => (0, functions_1.withdrawAuthorization)(this.client, params),
|
|
194
128
|
},
|
|
129
|
+
capTable: {
|
|
130
|
+
update: (params) => new capTable_1.CapTableBatch(params, this.client),
|
|
131
|
+
},
|
|
195
132
|
};
|
|
196
|
-
// OpenCapTableReports namespace
|
|
197
133
|
this.OpenCapTableReports = {
|
|
198
134
|
companyValuationReport: {
|
|
199
135
|
buildCreateCompanyValuationReportCommand: (params) => (0, functions_1.buildCreateCompanyValuationReportCommand)(this.client, params),
|
|
@@ -202,7 +138,6 @@ class OcpClient {
|
|
|
202
138
|
updateCompanyValuationReport: async (params) => (0, functions_1.updateCompanyValuationReport)(this.client, params),
|
|
203
139
|
},
|
|
204
140
|
};
|
|
205
|
-
// CantonPayments namespace - lazy import to avoid circular dependencies
|
|
206
141
|
/* eslint-disable @typescript-eslint/no-require-imports */
|
|
207
142
|
this.CantonPayments = {
|
|
208
143
|
airdrop: {
|
|
@@ -242,7 +177,6 @@ class OcpClient {
|
|
|
242
177
|
},
|
|
243
178
|
},
|
|
244
179
|
};
|
|
245
|
-
// PaymentStreams namespace - lazy import to avoid circular dependencies
|
|
246
180
|
this.PaymentStreams = {
|
|
247
181
|
paymentStreamFactory: {
|
|
248
182
|
buildCreatePaymentStreamProposalCommand: (params) => {
|
|
@@ -355,32 +289,7 @@ class OcpClient {
|
|
|
355
289
|
};
|
|
356
290
|
/* eslint-enable @typescript-eslint/no-require-imports */
|
|
357
291
|
}
|
|
358
|
-
/**
|
|
359
|
-
* Create a new transaction batch for submitting multiple commands atomically.
|
|
360
|
-
*
|
|
361
|
-
* Use batches when you need to execute multiple operations in a single transaction, ensuring all-or-nothing
|
|
362
|
-
* semantics.
|
|
363
|
-
*
|
|
364
|
-
* @example
|
|
365
|
-
* ```typescript
|
|
366
|
-
* const batch = ocp.createBatch({ actAs: [issuerParty] });
|
|
367
|
-
*
|
|
368
|
-
* // Add commands
|
|
369
|
-
* const cmd1 = ocp.OpenCapTable.stakeholder.buildCreateStakeholderCommand({...});
|
|
370
|
-
* const cmd2 = ocp.OpenCapTable.stockClass.buildCreateStockClassCommand({...});
|
|
371
|
-
*
|
|
372
|
-
* batch.addCommand(cmd1.command, cmd1.disclosedContracts);
|
|
373
|
-
* batch.addCommand(cmd2.command, cmd2.disclosedContracts);
|
|
374
|
-
*
|
|
375
|
-
* // Submit atomically
|
|
376
|
-
* const result = await batch.submitAndWait();
|
|
377
|
-
* ```;
|
|
378
|
-
*
|
|
379
|
-
* @param params - Batch parameters
|
|
380
|
-
* @param params.actAs - Party IDs to act as (signatories)
|
|
381
|
-
* @param params.readAs - Optional additional party IDs for read access
|
|
382
|
-
* @returns A TransactionBatch instance for adding commands
|
|
383
|
-
*/
|
|
292
|
+
/** Create a new transaction batch for submitting multiple commands atomically. */
|
|
384
293
|
createBatch(params) {
|
|
385
294
|
return new transactions_1.TransactionBatch(this.client, params.actAs, params.readAs);
|
|
386
295
|
}
|