@open-captable-protocol/canton 0.2.142 → 0.2.144
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 +13 -39
- package/dist/OcpClient.d.ts.map +1 -1
- package/dist/OcpClient.js +5 -38
- package/dist/OcpClient.js.map +1 -1
- package/dist/functions/CouponMinter/canMintCouponsNow.d.ts +56 -0
- package/dist/functions/CouponMinter/canMintCouponsNow.d.ts.map +1 -0
- package/dist/functions/CouponMinter/canMintCouponsNow.js +76 -0
- package/dist/functions/CouponMinter/canMintCouponsNow.js.map +1 -0
- package/dist/functions/CouponMinter/index.d.ts +2 -0
- package/dist/functions/CouponMinter/index.d.ts.map +1 -0
- package/dist/functions/CouponMinter/index.js +6 -0
- package/dist/functions/CouponMinter/index.js.map +1 -0
- package/dist/functions/OpenCapTable/capTable/CapTableBatch.d.ts +2 -39
- package/dist/functions/OpenCapTable/capTable/CapTableBatch.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/capTable/CapTableBatch.js +2 -39
- package/dist/functions/OpenCapTable/capTable/CapTableBatch.js.map +1 -1
- package/dist/functions/OpenCapTable/stockClass/getStockClassAsOcf.d.ts +0 -19
- package/dist/functions/OpenCapTable/stockClass/getStockClassAsOcf.d.ts.map +1 -1
- package/dist/functions/OpenCapTable/stockClass/getStockClassAsOcf.js +0 -19
- package/dist/functions/OpenCapTable/stockClass/getStockClassAsOcf.js.map +1 -1
- package/dist/functions/OpenCapTableReports/companyValuationReport/createCompanyValuationReport.d.ts +0 -17
- package/dist/functions/OpenCapTableReports/companyValuationReport/createCompanyValuationReport.d.ts.map +1 -1
- package/dist/functions/OpenCapTableReports/companyValuationReport/createCompanyValuationReport.js +0 -17
- package/dist/functions/OpenCapTableReports/companyValuationReport/createCompanyValuationReport.js.map +1 -1
- package/dist/functions/index.d.ts +1 -0
- package/dist/functions/index.d.ts.map +1 -1
- package/dist/functions/index.js +1 -0
- package/dist/functions/index.js.map +1 -1
- package/dist/utils/ocfComparison.d.ts +0 -7
- package/dist/utils/ocfComparison.d.ts.map +1 -1
- package/dist/utils/ocfComparison.js +0 -7
- package/dist/utils/ocfComparison.js.map +1 -1
- package/dist/utils/ocfHelpers.d.ts +1 -21
- package/dist/utils/ocfHelpers.d.ts.map +1 -1
- package/dist/utils/ocfHelpers.js +1 -21
- package/dist/utils/ocfHelpers.js.map +1 -1
- package/package.json +1 -1
package/dist/OcpClient.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ import type { ClientConfig } from '@fairmint/canton-node-sdk';
|
|
|
2
2
|
import { LedgerJsonApiClient } from '@fairmint/canton-node-sdk/build/src/clients/ledger-json-api';
|
|
3
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
|
-
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';
|
|
5
|
+
import type { AuthorizeIssuerParams, AuthorizeIssuerResult, CanMintResult, CouponMinterPayload, 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
6
|
import { CapTableBatch } from './functions/OpenCapTable/capTable';
|
|
7
7
|
import type { CommandWithDisclosedContracts } from './types';
|
|
8
8
|
/**
|
|
@@ -15,44 +15,7 @@ import type { CommandWithDisclosedContracts } from './types';
|
|
|
15
15
|
* - **CantonPayments**: Payment and airdrop operations
|
|
16
16
|
* - **PaymentStreams**: Recurring payment stream management
|
|
17
17
|
*
|
|
18
|
-
* @
|
|
19
|
-
* Creating an issuer
|
|
20
|
-
* ```typescript
|
|
21
|
-
* import { OcpClient } from '@open-captable-protocol/canton';
|
|
22
|
-
*
|
|
23
|
-
* const ocp = new OcpClient({ network: 'localnet' });
|
|
24
|
-
*
|
|
25
|
-
* const cmd = ocp.OpenCapTable.issuer.buildCreateIssuerCommand({
|
|
26
|
-
* issuerAuthorizationContractDetails: authDetails,
|
|
27
|
-
* featuredAppRightContractDetails: featuredDetails,
|
|
28
|
-
* issuerParty: 'alice::...',
|
|
29
|
-
* issuerData: {
|
|
30
|
-
* id: 'issuer-1',
|
|
31
|
-
* legal_name: 'Acme Corp',
|
|
32
|
-
* formation_date: '2024-01-01',
|
|
33
|
-
* country_of_formation: 'US',
|
|
34
|
-
* tax_ids: [],
|
|
35
|
-
* },
|
|
36
|
-
* });
|
|
37
|
-
* ```
|
|
38
|
-
*
|
|
39
|
-
* @example
|
|
40
|
-
* Batch cap table updates
|
|
41
|
-
* ```typescript
|
|
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();
|
|
53
|
-
* ```
|
|
54
|
-
*
|
|
55
|
-
* @see https://ocp.canton.fairmint.com/ - Full SDK documentation
|
|
18
|
+
* @see https://ocp.canton.fairmint.com/ - Full SDK documentation with usage examples
|
|
56
19
|
*/
|
|
57
20
|
export declare class OcpClient {
|
|
58
21
|
/** The underlying LedgerJsonApiClient for direct ledger access. */
|
|
@@ -158,6 +121,17 @@ export declare class OcpClient {
|
|
|
158
121
|
buildCreateCompanyValuationReportCommand: (params: CreateCompanyValuationReportParams) => CommandWithDisclosedContracts;
|
|
159
122
|
};
|
|
160
123
|
};
|
|
124
|
+
/** CouponMinter utilities for TPS rate limit checking. */
|
|
125
|
+
CouponMinter: {
|
|
126
|
+
/**
|
|
127
|
+
* Checks if minting coupons is currently allowed based on TPS rate limits.
|
|
128
|
+
*
|
|
129
|
+
* @param payload - The CouponMinter contract payload
|
|
130
|
+
* @param now - Optional current time for testing
|
|
131
|
+
* @returns {canMint: true} Or { canMint: false, waitMs: number }
|
|
132
|
+
*/
|
|
133
|
+
canMintCouponsNow: (payload: CouponMinterPayload, now?: Date) => CanMintResult;
|
|
134
|
+
};
|
|
161
135
|
/** Payment and airdrop operations using Canton's native token. */
|
|
162
136
|
CantonPayments: {
|
|
163
137
|
airdrop: {
|
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,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;
|
|
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,aAAa,EACb,mBAAmB,EACnB,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;AAgCrB,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAClE,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,SAAS,CAAC;AAE7D;;;;;;;;;;;GAWG;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,0DAA0D;IACnD,YAAY,EAAE;QACnB;;;;;;WAMG;QACH,iBAAiB,EAAE,CAAC,OAAO,EAAE,mBAAmB,EAAE,GAAG,CAAC,EAAE,IAAI,KAAK,aAAa,CAAC;KAChF,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;IAmQjC,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 CouponMinter_1 = require("./functions/CouponMinter");
|
|
7
8
|
const capTable_1 = require("./functions/OpenCapTable/capTable");
|
|
8
9
|
/**
|
|
9
10
|
* High-level client for interacting with Open Cap Table Protocol (OCP) contracts on Canton.
|
|
@@ -15,44 +16,7 @@ const capTable_1 = require("./functions/OpenCapTable/capTable");
|
|
|
15
16
|
* - **CantonPayments**: Payment and airdrop operations
|
|
16
17
|
* - **PaymentStreams**: Recurring payment stream management
|
|
17
18
|
*
|
|
18
|
-
* @
|
|
19
|
-
* Creating an issuer
|
|
20
|
-
* ```typescript
|
|
21
|
-
* import { OcpClient } from '@open-captable-protocol/canton';
|
|
22
|
-
*
|
|
23
|
-
* const ocp = new OcpClient({ network: 'localnet' });
|
|
24
|
-
*
|
|
25
|
-
* const cmd = ocp.OpenCapTable.issuer.buildCreateIssuerCommand({
|
|
26
|
-
* issuerAuthorizationContractDetails: authDetails,
|
|
27
|
-
* featuredAppRightContractDetails: featuredDetails,
|
|
28
|
-
* issuerParty: 'alice::...',
|
|
29
|
-
* issuerData: {
|
|
30
|
-
* id: 'issuer-1',
|
|
31
|
-
* legal_name: 'Acme Corp',
|
|
32
|
-
* formation_date: '2024-01-01',
|
|
33
|
-
* country_of_formation: 'US',
|
|
34
|
-
* tax_ids: [],
|
|
35
|
-
* },
|
|
36
|
-
* });
|
|
37
|
-
* ```
|
|
38
|
-
*
|
|
39
|
-
* @example
|
|
40
|
-
* Batch cap table updates
|
|
41
|
-
* ```typescript
|
|
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();
|
|
53
|
-
* ```
|
|
54
|
-
*
|
|
55
|
-
* @see https://ocp.canton.fairmint.com/ - Full SDK documentation
|
|
19
|
+
* @see https://ocp.canton.fairmint.com/ - Full SDK documentation with usage examples
|
|
56
20
|
*/
|
|
57
21
|
class OcpClient {
|
|
58
22
|
constructor(config) {
|
|
@@ -138,6 +102,9 @@ class OcpClient {
|
|
|
138
102
|
updateCompanyValuationReport: async (params) => (0, functions_1.updateCompanyValuationReport)(this.client, params),
|
|
139
103
|
},
|
|
140
104
|
};
|
|
105
|
+
this.CouponMinter = {
|
|
106
|
+
canMintCouponsNow: (payload, now) => (0, CouponMinter_1.canMintCouponsNow)(payload, now),
|
|
107
|
+
};
|
|
141
108
|
/* eslint-disable @typescript-eslint/no-require-imports */
|
|
142
109
|
this.CantonPayments = {
|
|
143
110
|
airdrop: {
|
package/dist/OcpClient.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OcpClient.js","sourceRoot":"","sources":["../src/OcpClient.ts"],"names":[],"mappings":";;;AACA,iGAAkG;AAKlG,yFAA0F;
|
|
1
|
+
{"version":3,"file":"OcpClient.js","sourceRoot":"","sources":["../src/OcpClient.ts"],"names":[],"mappings":";;;AACA,iGAAkG;AAKlG,yFAA0F;AAqC1F,2CA6BqB;AACrB,2DAA6D;AAC7D,gEAAkE;AAGlE;;;;;;;;;;;GAWG;AACH,MAAa,SAAS;IA8OpB,YAAY,MAAqB;QAC/B,IAAI,CAAC,MAAM,GAAG,IAAI,qCAAmB,CAAC,MAAM,CAAC,CAAC;QAE9C,IAAI,CAAC,YAAY,GAAG;YAClB,MAAM,EAAE;gBACN,wBAAwB,EAAE,CAAC,MAA0B,EAAE,EAAE,CAAC,IAAA,oCAAwB,EAAC,MAAM,CAAC;gBAC1F,cAAc,EAAE,KAAK,EAAE,MAA4B,EAAE,EAAE,CAAC,IAAA,0BAAc,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aAC5F;YACD,UAAU,EAAE;gBACV,kBAAkB,EAAE,KAAK,EAAE,MAAgC,EAAE,EAAE,CAAC,IAAA,8BAAkB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aACxG;YACD,WAAW,EAAE;gBACX,mBAAmB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,IAAA,+BAAmB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aAChF;YACD,mBAAmB,EAAE;gBACnB,2BAA2B,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,IAAA,uCAA2B,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aAChG;YACD,YAAY,EAAE;gBACZ,oBAAoB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,IAAA,gCAAoB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aAClF;YACD,SAAS,EAAE;gBACT,iBAAiB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,IAAA,6BAAiB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aAC5E;YACD,0BAA0B,EAAE;gBAC1B,uCAAuC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CACxD,IAAA,mDAAuC,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aAC/D;YACD,0BAA0B,EAAE;gBAC1B,uCAAuC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CACxD,IAAA,mDAAuC,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aAC/D;YACD,eAAe,EAAE;gBACf,uBAAuB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,IAAA,mCAAuB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aACxF;YACD,mBAAmB,EAAE;gBACnB,2BAA2B,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,IAAA,uCAA2B,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aAChG;YACD,iBAAiB,EAAE;gBACjB,8BAA8B,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,IAAA,0CAA8B,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aACtG;YACD,mBAAmB,EAAE;gBACnB,gCAAgC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,IAAA,4CAAgC,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aAC1G;YACD,uBAAuB,EAAE;gBACvB,oCAAoC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CACrD,IAAA,gDAAoC,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aAC5D;YACD,8BAA8B,EAAE;gBAC9B,2CAA2C,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAC5D,IAAA,uDAA2C,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aACnE;YACD,aAAa,EAAE;gBACb,qBAAqB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,IAAA,iCAAqB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aACpF;YACD,gCAAgC,EAAE;gBAChC,6CAA6C,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAC9D,IAAA,yDAA6C,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aACrE;YACD,oCAAoC,EAAE;gBACpC,iDAAiD,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAClE,IAAA,6DAAiD,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aACzE;YACD,uBAAuB,EAAE;gBACvB,oCAAoC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CACrD,IAAA,gDAAoC,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aAC5D;YACD,QAAQ,EAAE;gBACR,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,IAAA,4BAAgB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aAC1E;YACD,aAAa,EAAE;gBACb,qBAAqB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,IAAA,iCAAqB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aACpF;YACD,eAAe,EAAE;gBACf,uBAAuB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,IAAA,mCAAuB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aACxF;YACD,mBAAmB,EAAE;gBACnB,eAAe,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,IAAA,2BAAe,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;gBACvE,qBAAqB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,IAAA,iCAAqB,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aACpF;YACD,QAAQ,EAAE;gBACR,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,wBAAa,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;aAC3D;SACF,CAAC;QAEF,IAAI,CAAC,mBAAmB,GAAG;YACzB,sBAAsB,EAAE;gBACtB,wCAAwC,EAAE,CAAC,MAA0C,EAAE,EAAE,CACvF,IAAA,oDAAwC,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;gBAC/D,oCAAoC,EAAE,KAAK,EAAE,MAG5C,EAAE,EAAE,CAAC,IAAA,gDAAoC,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;gBAC/D,4BAA4B,EAAE,KAAK,EAAE,MAA0C,EAAE,EAAE,CACjF,IAAA,wCAA4B,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;gBACnD,4BAA4B,EAAE,KAAK,EAAE,MAAoC,EAAE,EAAE,CAC3E,IAAA,wCAA4B,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;aACpD;SACF,CAAC;QAEF,IAAI,CAAC,YAAY,GAAG;YAClB,iBAAiB,EAAE,CAAC,OAA4B,EAAE,GAAU,EAAE,EAAE,CAAC,IAAA,gCAAiB,EAAC,OAAO,EAAE,GAAG,CAAC;SACjG,CAAC;QAEF,0DAA0D;QAC1D,IAAI,CAAC,cAAc,GAAG;YACpB,OAAO,EAAE;gBACP,yBAAyB,EAAE,CAAC,MAAM,EAAE,EAAE;oBACpC,MAAM,EAAE,yBAAyB,EAAE,GAAG,OAAO,CAAC,oCAAoC,CAAC,CAAC;oBACpF,OAAO,yBAAyB,CAAC,MAAM,CAAC,CAAC;gBAC3C,CAAC;gBACD,+BAA+B,EAAE,CAAC,MAAM,EAAE,EAAE;oBAC1C,MAAM,EAAE,+BAA+B,EAAE,GAAG,OAAO,CAAC,oCAAoC,CAAC,CAAC;oBAC1F,OAAO,+BAA+B,CAAC,MAAM,CAAC,CAAC;gBACjD,CAAC;gBACD,iCAAiC,EAAE,CAAC,MAAM,EAAE,EAAE;oBAC5C,MAAM,EAAE,iCAAiC,EAAE,GAAG,OAAO,CAAC,oCAAoC,CAAC,CAAC;oBAC5F,OAAO,iCAAiC,CAAC,MAAM,CAAC,CAAC;gBACnD,CAAC;gBACD,uBAAuB,EAAE,CAAC,MAAM,EAAE,EAAE;oBAClC,MAAM,EAAE,uBAAuB,EAAE,GAAG,OAAO,CAAC,oCAAoC,CAAC,CAAC;oBAClF,OAAO,uBAAuB,CAAC,MAAM,CAAC,CAAC;gBACzC,CAAC;gBACD,0BAA0B,EAAE,CAAC,MAAM,EAAE,EAAE;oBACrC,MAAM,EAAE,0BAA0B,EAAE,GAAG,OAAO,CAAC,oCAAoC,CAAC,CAAC;oBACrF,OAAO,0BAA0B,CAAC,MAAM,CAAC,CAAC;gBAC5C,CAAC;aACF;YACD,aAAa,EAAE;gBACb,+BAA+B,EAAE,CAAC,MAAM,EAAE,EAAE;oBAC1C,MAAM,EAAE,+BAA+B,EAAE,GAAG,OAAO,CAAC,0CAA0C,CAAC,CAAC;oBAChG,OAAO,+BAA+B,CAAC,MAAM,CAAC,CAAC;gBACjD,CAAC;gBACD,gCAAgC,EAAE,CAAC,MAAM,EAAE,EAAE;oBAC3C,MAAM,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC,0CAA0C,CAAC,CAAC;oBACjG,OAAO,gCAAgC,CAAC,MAAM,CAAC,CAAC;gBAClD,CAAC;gBACD,gCAAgC,EAAE,CAAC,MAAM,EAAE,EAAE;oBAC3C,MAAM,EAAE,gCAAgC,EAAE,GAAG,OAAO,CAAC,0CAA0C,CAAC,CAAC;oBACjG,OAAO,gCAAgC,CAAC,MAAM,CAAC,CAAC;gBAClD,CAAC;aACF;SACF,CAAC;QAEF,IAAI,CAAC,cAAc,GAAG;YACpB,oBAAoB,EAAE;gBACpB,uCAAuC,EAAE,CAAC,MAAM,EAAE,EAAE;oBAClD,MAAM,EAAE,uCAAuC,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBAC1F,OAAO,uCAAuC,CAAC,MAAM,CAAC,CAAC;gBACzD,CAAC;aACF;YACD,qBAAqB,EAAE;gBACrB,mBAAmB,EAAE,CAAC,MAAM,EAAE,EAAE;oBAC9B,MAAM,EAAE,wCAAwC,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBAC3F,OAAO,wCAAwC,CAAC,MAAM,CAAC,CAAC;gBAC1D,CAAC;gBACD,8BAA8B,EAAE,CAAC,MAAM,EAAE,EAAE;oBACzC,MAAM,EAAE,sCAAsC,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBACzF,OAAO,sCAAsC,CAAC,MAAM,CAAC,CAAC;gBACxD,CAAC;gBACD,qCAAqC,EAAE,CAAC,MAAM,EAAE,EAAE;oBAChD,MAAM,EAAE,qCAAqC,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBACxF,OAAO,qCAAqC,CAAC,MAAM,CAAC,CAAC;gBACvD,CAAC;gBACD,oBAAoB,EAAE,CAAC,MAAM,EAAE,EAAE;oBAC/B,MAAM,EAAE,yCAAyC,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBAC5F,OAAO,yCAAyC,CAAC,MAAM,CAAC,CAAC;gBAC3D,CAAC;gBACD,uBAAuB,EAAE,CAAC,MAAM,EAAE,EAAE;oBAClC,MAAM,EAAE,4CAA4C,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBAC/F,OAAO,4CAA4C,CAAC,MAAM,CAAC,CAAC;gBAC9D,CAAC;aACF;YACD,mBAAmB,EAAE;gBACnB,0BAA0B,EAAE,CAAC,MAAM,EAAE,EAAE;oBACrC,MAAM,EAAE,0BAA0B,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBAC7E,OAAO,0BAA0B,CAAC,MAAM,CAAC,CAAC;gBAC5C,CAAC;gBACD,4BAA4B,EAAE,CAAC,MAAM,EAAE,EAAE;oBACvC,MAAM,EAAE,4BAA4B,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBAC/E,OAAO,4BAA4B,CAAC,MAAM,CAAC,CAAC;gBAC9C,CAAC;gBACD,kBAAkB,EAAE,CAAC,MAAM,EAAE,EAAE;oBAC7B,MAAM,EAAE,+BAA+B,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBAClF,OAAO,+BAA+B,CAAC,MAAM,CAAC,CAAC;gBACjD,CAAC;gBACD,0BAA0B,EAAE,CAAC,MAAM,EAAE,EAAE;oBACrC,MAAM,EAAE,0BAA0B,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBAC7E,OAAO,0BAA0B,CAAC,MAAM,CAAC,CAAC;gBAC5C,CAAC;gBACD,kBAAkB,EAAE,CAAC,MAAM,EAAE,EAAE;oBAC7B,MAAM,EAAE,+BAA+B,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBAClF,OAAO,+BAA+B,CAAC,MAAM,CAAC,CAAC;gBACjD,CAAC;gBACD,wCAAwC,EAAE,CAAC,MAAM,EAAE,EAAE;oBACnD,MAAM,EAAE,wCAAwC,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBAC3F,OAAO,wCAAwC,CAAC,MAAM,CAAC,CAAC;gBAC1D,CAAC;gBACD,uBAAuB,EAAE,CAAC,MAAM,EAAE,EAAE;oBAClC,MAAM,EAAE,0CAA0C,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBAC7F,OAAO,0CAA0C,CAAC,MAAM,CAAC,CAAC;gBAC5D,CAAC;aACF;YACD,2BAA2B,EAAE;gBAC3B,mBAAmB,EAAE,CAAC,MAAM,EAAE,EAAE;oBAC9B,MAAM,EAAE,8CAA8C,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBACjG,OAAO,8CAA8C,CAAC,MAAM,CAAC,CAAC;gBAChE,CAAC;gBACD,iBAAiB,EAAE,CAAC,MAAM,EAAE,EAAE;oBAC5B,MAAM,EAAE,4CAA4C,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBAC/F,OAAO,4CAA4C,CAAC,MAAM,CAAC,CAAC;gBAC9D,CAAC;gBACD,kBAAkB,EAAE,CAAC,MAAM,EAAE,EAAE;oBAC7B,MAAM,EAAE,6CAA6C,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBAChG,OAAO,6CAA6C,CAAC,MAAM,CAAC,CAAC;gBAC/D,CAAC;aACF;YACD,sBAAsB,EAAE;gBACtB,mBAAmB,EAAE,CAAC,MAAM,EAAE,EAAE;oBAC9B,MAAM,EAAE,yCAAyC,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBAC5F,OAAO,yCAAyC,CAAC,MAAM,CAAC,CAAC;gBAC3D,CAAC;gBACD,sCAAsC,EAAE,CAAC,MAAM,EAAE,EAAE;oBACjD,MAAM,EAAE,sCAAsC,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBACzF,OAAO,sCAAsC,CAAC,MAAM,CAAC,CAAC;gBACxD,CAAC;gBACD,wCAAwC,EAAE,CAAC,MAAM,EAAE,EAAE;oBACnD,MAAM,EAAE,wCAAwC,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBAC3F,OAAO,wCAAwC,CAAC,MAAM,CAAC,CAAC;gBAC1D,CAAC;gBACD,mBAAmB,EAAE,CAAC,MAAM,EAAE,EAAE;oBAC9B,MAAM,EAAE,yCAAyC,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBAC5F,OAAO,yCAAyC,CAAC,MAAM,CAAC,CAAC;gBAC3D,CAAC;aACF;YACD,KAAK,EAAE;gBACL,4BAA4B,EAAE,GAAG,EAAE;oBACjC,MAAM,EAAE,4BAA4B,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBAC/E,OAAO,4BAA4B,CAAC,IAAI,CAAC,CAAC;gBAC5C,CAAC;gBACD,0CAA0C,EAAE,KAAK,EAC/C,+BAAuC,EACvC,MAAiB,EACjB,EAAE;oBACF,MAAM,EAAE,0CAA0C,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBAC7F,OAAO,MAAM,0CAA0C,CAAC,IAAI,EAAE,+BAA+B,EAAE,MAAM,CAAC,CAAC;gBACzG,CAAC;gBACD,mBAAmB,EAAE,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE;oBACvD,MAAM,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBACtE,OAAO,MAAM,mBAAmB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;gBAC9D,CAAC;gBACD,8BAA8B,EAAE,KAAK,EAAE,eAAe,EAAE,UAAU,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE;oBAC/F,MAAM,EAAE,8BAA8B,EAAE,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;oBACjF,OAAO,MAAM,8BAA8B,CAAC,eAAe,EAAE,UAAU,EAAE,eAAe,EAAE,QAAQ,CAAC,CAAC;gBACtG,CAAC;aACF;SACF,CAAC;QACF,yDAAyD;IAC3D,CAAC;IAED,kFAAkF;IAC3E,WAAW,CAAC,MAA8C;QAC/D,OAAO,IAAI,+BAAgB,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IACxE,CAAC;CACF;AArfD,8BAqfC"}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Client-side helper to check if coupon minting is allowed based on TPS rate limits.
|
|
3
|
+
*
|
|
4
|
+
* This utility allows callers to check rate limits before submitting a MintCoupons transaction to the ledger, avoiding
|
|
5
|
+
* unnecessary transaction failures.
|
|
6
|
+
*/
|
|
7
|
+
/** Result of checking if minting is allowed. */
|
|
8
|
+
export type CanMintResult = {
|
|
9
|
+
canMint: true;
|
|
10
|
+
} | {
|
|
11
|
+
canMint: false;
|
|
12
|
+
waitMs: number;
|
|
13
|
+
};
|
|
14
|
+
/** Last mint information from the CouponMinter contract. */
|
|
15
|
+
export interface LastMint {
|
|
16
|
+
/** DAML timestamp in ISO 8601 format (e.g., "2026-01-13T12:00:00.000000Z") */
|
|
17
|
+
time: string;
|
|
18
|
+
/** Number of coupons minted in the last transaction */
|
|
19
|
+
count: number;
|
|
20
|
+
}
|
|
21
|
+
/** Relevant fields from the CouponMinter contract payload. */
|
|
22
|
+
export interface CouponMinterPayload {
|
|
23
|
+
/** The operator party controlling this minter */
|
|
24
|
+
operator: string;
|
|
25
|
+
/** Maximum transactions per second, or null if rate limiting is disabled */
|
|
26
|
+
maxTps: string | null;
|
|
27
|
+
/** Information about the last mint operation, or null if no mints have occurred */
|
|
28
|
+
lastMint: LastMint | null;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Checks if minting coupons is currently allowed based on the TPS rate limit configuration.
|
|
32
|
+
*
|
|
33
|
+
* The rate limit formula from the DAML contract is:
|
|
34
|
+
*
|
|
35
|
+
* minIntervalMicros = (lastMint.count * 1_000_000) / maxTps;
|
|
36
|
+
*
|
|
37
|
+
* If enough time has elapsed since the last mint, minting is allowed. Otherwise, returns the number of milliseconds to
|
|
38
|
+
* wait before minting is allowed.
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```typescript
|
|
42
|
+
* const result = canMintCouponsNow(couponMinterPayload);
|
|
43
|
+
* if (result.canMint) {
|
|
44
|
+
* await mintCoupons(...);
|
|
45
|
+
* } else {
|
|
46
|
+
* console.log(`Rate limited. Waiting ${result.waitMs}ms...`);
|
|
47
|
+
* await sleep(result.waitMs);
|
|
48
|
+
* }
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param payload - The CouponMinter contract payload
|
|
52
|
+
* @param now - Optional current time for testing (defaults to new Date())
|
|
53
|
+
* @returns {canMint: true} If minting is allowed, or { canMint: false, waitMs: number } with the wait time
|
|
54
|
+
*/
|
|
55
|
+
export declare function canMintCouponsNow(payload: CouponMinterPayload, now?: Date): CanMintResult;
|
|
56
|
+
//# sourceMappingURL=canMintCouponsNow.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"canMintCouponsNow.d.ts","sourceRoot":"","sources":["../../../src/functions/CouponMinter/canMintCouponsNow.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,gDAAgD;AAChD,MAAM,MAAM,aAAa,GAAG;IAAE,OAAO,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnF,4DAA4D;AAC5D,MAAM,WAAW,QAAQ;IACvB,8EAA8E;IAC9E,IAAI,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,KAAK,EAAE,MAAM,CAAC;CACf;AAED,8DAA8D;AAC9D,MAAM,WAAW,mBAAmB;IAClC,iDAAiD;IACjD,QAAQ,EAAE,MAAM,CAAC;IACjB,4EAA4E;IAC5E,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,mFAAmF;IACnF,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,mBAAmB,EAAE,GAAG,CAAC,EAAE,IAAI,GAAG,aAAa,CAkDzF"}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Client-side helper to check if coupon minting is allowed based on TPS rate limits.
|
|
4
|
+
*
|
|
5
|
+
* This utility allows callers to check rate limits before submitting a MintCoupons transaction to the ledger, avoiding
|
|
6
|
+
* unnecessary transaction failures.
|
|
7
|
+
*/
|
|
8
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
exports.canMintCouponsNow = canMintCouponsNow;
|
|
10
|
+
/**
|
|
11
|
+
* Checks if minting coupons is currently allowed based on the TPS rate limit configuration.
|
|
12
|
+
*
|
|
13
|
+
* The rate limit formula from the DAML contract is:
|
|
14
|
+
*
|
|
15
|
+
* minIntervalMicros = (lastMint.count * 1_000_000) / maxTps;
|
|
16
|
+
*
|
|
17
|
+
* If enough time has elapsed since the last mint, minting is allowed. Otherwise, returns the number of milliseconds to
|
|
18
|
+
* wait before minting is allowed.
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```typescript
|
|
22
|
+
* const result = canMintCouponsNow(couponMinterPayload);
|
|
23
|
+
* if (result.canMint) {
|
|
24
|
+
* await mintCoupons(...);
|
|
25
|
+
* } else {
|
|
26
|
+
* console.log(`Rate limited. Waiting ${result.waitMs}ms...`);
|
|
27
|
+
* await sleep(result.waitMs);
|
|
28
|
+
* }
|
|
29
|
+
* ```
|
|
30
|
+
*
|
|
31
|
+
* @param payload - The CouponMinter contract payload
|
|
32
|
+
* @param now - Optional current time for testing (defaults to new Date())
|
|
33
|
+
* @returns {canMint: true} If minting is allowed, or { canMint: false, waitMs: number } with the wait time
|
|
34
|
+
*/
|
|
35
|
+
function canMintCouponsNow(payload, now) {
|
|
36
|
+
// No rate limit configured - always allow minting
|
|
37
|
+
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- defensive runtime check
|
|
38
|
+
if (payload.maxTps === null || payload.maxTps === undefined) {
|
|
39
|
+
return { canMint: true };
|
|
40
|
+
}
|
|
41
|
+
// No previous mint - always allow minting
|
|
42
|
+
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- defensive runtime check
|
|
43
|
+
if (payload.lastMint === null || payload.lastMint === undefined) {
|
|
44
|
+
return { canMint: true };
|
|
45
|
+
}
|
|
46
|
+
// Parse maxTps
|
|
47
|
+
const maxTps = parseFloat(payload.maxTps);
|
|
48
|
+
if (isNaN(maxTps) || maxTps <= 0) {
|
|
49
|
+
throw new Error(`Invalid maxTps value: "${payload.maxTps}". Expected a positive number.`);
|
|
50
|
+
}
|
|
51
|
+
const { time: lastMintTime, count: lastMintCount } = payload.lastMint;
|
|
52
|
+
// Zero count means no effective rate limit from last mint
|
|
53
|
+
if (lastMintCount <= 0) {
|
|
54
|
+
return { canMint: true };
|
|
55
|
+
}
|
|
56
|
+
// Calculate required wait time in microseconds
|
|
57
|
+
// Formula: minIntervalMicros = lastMint.count * 1_000_000 / maxTps
|
|
58
|
+
const minIntervalMicros = (lastMintCount * 1000000) / maxTps;
|
|
59
|
+
// Parse the DAML timestamp
|
|
60
|
+
const lastMintDate = new Date(lastMintTime);
|
|
61
|
+
if (isNaN(lastMintDate.getTime())) {
|
|
62
|
+
throw new Error(`Invalid lastMint.time format: "${lastMintTime}". Expected ISO 8601 timestamp.`);
|
|
63
|
+
}
|
|
64
|
+
// Calculate elapsed time in microseconds
|
|
65
|
+
const currentTime = now ?? new Date();
|
|
66
|
+
const elapsedMicros = (currentTime.getTime() - lastMintDate.getTime()) * 1000;
|
|
67
|
+
// Check if enough time has elapsed
|
|
68
|
+
if (elapsedMicros >= minIntervalMicros) {
|
|
69
|
+
return { canMint: true };
|
|
70
|
+
}
|
|
71
|
+
// Calculate remaining wait time in milliseconds
|
|
72
|
+
const remainingMicros = minIntervalMicros - elapsedMicros;
|
|
73
|
+
const waitMs = Math.ceil(remainingMicros / 1000);
|
|
74
|
+
return { canMint: false, waitMs };
|
|
75
|
+
}
|
|
76
|
+
//# sourceMappingURL=canMintCouponsNow.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"canMintCouponsNow.js","sourceRoot":"","sources":["../../../src/functions/CouponMinter/canMintCouponsNow.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAgDH,8CAkDC;AA3ED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAgB,iBAAiB,CAAC,OAA4B,EAAE,GAAU;IACxE,kDAAkD;IAClD,kGAAkG;IAClG,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC5D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC3B,CAAC;IAED,0CAA0C;IAC1C,kGAAkG;IAClG,IAAI,OAAO,CAAC,QAAQ,KAAK,IAAI,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAChE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC3B,CAAC;IAED,eAAe;IACf,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1C,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,MAAM,IAAI,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,0BAA0B,OAAO,CAAC,MAAM,gCAAgC,CAAC,CAAC;IAC5F,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;IAEtE,0DAA0D;IAC1D,IAAI,aAAa,IAAI,CAAC,EAAE,CAAC;QACvB,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC3B,CAAC;IAED,+CAA+C;IAC/C,mEAAmE;IACnE,MAAM,iBAAiB,GAAG,CAAC,aAAa,GAAG,OAAS,CAAC,GAAG,MAAM,CAAC;IAE/D,2BAA2B;IAC3B,MAAM,YAAY,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC;IAC5C,IAAI,KAAK,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,kCAAkC,YAAY,iCAAiC,CAAC,CAAC;IACnG,CAAC;IAED,yCAAyC;IACzC,MAAM,WAAW,GAAG,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC;IACtC,MAAM,aAAa,GAAG,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,YAAY,CAAC,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC;IAE9E,mCAAmC;IACnC,IAAI,aAAa,IAAI,iBAAiB,EAAE,CAAC;QACvC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC3B,CAAC;IAED,gDAAgD;IAChD,MAAM,eAAe,GAAG,iBAAiB,GAAG,aAAa,CAAC;IAC1D,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,CAAC;IAEjD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AACpC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/functions/CouponMinter/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,KAAK,aAAa,EAAE,KAAK,mBAAmB,EAAE,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.canMintCouponsNow = void 0;
|
|
4
|
+
var canMintCouponsNow_1 = require("./canMintCouponsNow");
|
|
5
|
+
Object.defineProperty(exports, "canMintCouponsNow", { enumerable: true, get: function () { return canMintCouponsNow_1.canMintCouponsNow; } });
|
|
6
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/functions/CouponMinter/index.ts"],"names":[],"mappings":";;;AAAA,yDAAqH;AAA5G,sHAAA,iBAAiB,OAAA"}
|
|
@@ -2,21 +2,7 @@
|
|
|
2
2
|
* Fluent batch builder for cap table updates.
|
|
3
3
|
*
|
|
4
4
|
* Provides a type-safe API for building batch UpdateCapTable commands that support atomic creates, edits, and deletes
|
|
5
|
-
* of multiple OCF entities.
|
|
6
|
-
*
|
|
7
|
-
* @example
|
|
8
|
-
* ```typescript
|
|
9
|
-
* const result = await ocp.capTable
|
|
10
|
-
* .update({
|
|
11
|
-
* capTableContractId,
|
|
12
|
-
* featuredAppRightContractDetails,
|
|
13
|
-
* })
|
|
14
|
-
* .create('stakeholder', stakeholderData)
|
|
15
|
-
* .create('stockClass', stockClassData)
|
|
16
|
-
* .edit('stakeholder', updatedStakeholderData)
|
|
17
|
-
* .delete('document', documentId)
|
|
18
|
-
* .execute();
|
|
19
|
-
* ```;
|
|
5
|
+
* of multiple OCF entities. Chain .create(), .edit(), and .delete() calls, then call .execute() to submit.
|
|
20
6
|
*/
|
|
21
7
|
import type { LedgerJsonApiClient } from '@fairmint/canton-node-sdk/build/src/clients/ledger-json-api';
|
|
22
8
|
import type { DisclosedContract } from '@fairmint/canton-node-sdk/build/src/clients/ledger-json-api/schemas/api/commands';
|
|
@@ -50,16 +36,7 @@ export declare class CapTableBatch {
|
|
|
50
36
|
/**
|
|
51
37
|
* Add a create operation to the batch.
|
|
52
38
|
*
|
|
53
|
-
* @
|
|
54
|
-
* ```typescript
|
|
55
|
-
* batch.create('stakeholder', {
|
|
56
|
-
* id: 'sh-123',
|
|
57
|
-
* name: { legal_name: 'John Doe' },
|
|
58
|
-
* stakeholder_type: 'INDIVIDUAL',
|
|
59
|
-
* });
|
|
60
|
-
* ```;
|
|
61
|
-
*
|
|
62
|
-
* @param type - The OCF entity type to create
|
|
39
|
+
* @param type - The OCF entity type to create (e.g., 'stakeholder', 'stockClass')
|
|
63
40
|
* @param data - The native OCF data for the entity
|
|
64
41
|
* @returns This for chaining
|
|
65
42
|
*/
|
|
@@ -67,15 +44,6 @@ export declare class CapTableBatch {
|
|
|
67
44
|
/**
|
|
68
45
|
* Add an edit operation to the batch.
|
|
69
46
|
*
|
|
70
|
-
* @example
|
|
71
|
-
* ```typescript
|
|
72
|
-
* batch.edit('stakeholder', {
|
|
73
|
-
* id: 'sh-123',
|
|
74
|
-
* name: { legal_name: 'Jane Doe' },
|
|
75
|
-
* stakeholder_type: 'INDIVIDUAL',
|
|
76
|
-
* });
|
|
77
|
-
* ```;
|
|
78
|
-
*
|
|
79
47
|
* @param type - The OCF entity type to edit
|
|
80
48
|
* @param data - The updated native OCF data (must include the entity's id)
|
|
81
49
|
* @returns This for chaining
|
|
@@ -84,11 +52,6 @@ export declare class CapTableBatch {
|
|
|
84
52
|
/**
|
|
85
53
|
* Add a delete operation to the batch.
|
|
86
54
|
*
|
|
87
|
-
* @example
|
|
88
|
-
* ```typescript
|
|
89
|
-
* batch.delete('document', 'doc-123');
|
|
90
|
-
* ```;
|
|
91
|
-
*
|
|
92
55
|
* @param type - The OCF entity type to delete
|
|
93
56
|
* @param id - The OCF object ID to delete
|
|
94
57
|
* @returns This for chaining
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CapTableBatch.d.ts","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/capTable/CapTableBatch.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"CapTableBatch.d.ts","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/capTable/CapTableBatch.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,6DAA6D,CAAC;AACvG,OAAO,KAAK,EAEV,iBAAiB,EAClB,MAAM,kFAAkF,CAAC;AAE1F,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AACpE,OAAO,EAGL,KAAK,cAAc,EAGnB,KAAK,aAAa,EAClB,KAAK,oBAAoB,EAC1B,MAAM,cAAc,CAAC;AAGtB,kDAAkD;AAClD,MAAM,WAAW,mBAAmB;IAClC,gDAAgD;IAChD,kBAAkB,EAAE,MAAM,CAAC;IAC3B,0DAA0D;IAC1D,+BAA+B,EAAE,iBAAiB,CAAC;IACnD,oFAAoF;IACpF,uBAAuB,CAAC,EAAE,iBAAiB,CAAC;IAC5C,wCAAwC;IACxC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,oDAAoD;IACpD,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;;;GAIG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAsB;IAC7C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA6B;IACpD,OAAO,CAAC,OAAO,CAAuB;IACtC,OAAO,CAAC,KAAK,CAAqB;IAClC,OAAO,CAAC,OAAO,CAAuB;gBAE1B,MAAM,EAAE,mBAAmB,EAAE,MAAM,GAAE,mBAAmB,GAAG,IAAW;IAKlF;;;;;;OAMG;IACH,MAAM,CAAC,CAAC,SAAS,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,IAAI;IAOvE;;;;;;OAMG;IACH,IAAI,CAAC,CAAC,SAAS,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,IAAI;IAOrE;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,aAAa,EAAE,EAAE,EAAE,MAAM,GAAG,IAAI;IAM7C,iDAAiD;IACjD,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,mCAAmC;IACnC,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;;;OAIG;IACH,KAAK,IAAI,6BAA6B;IAmCtC;;;;;OAKG;IACG,OAAO,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAsC9C,2CAA2C;IAC3C,KAAK,IAAI,IAAI;CAMd;AAED;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CACxC,MAAM,EAAE,IAAI,CAAC,mBAAmB,EAAE,OAAO,GAAG,QAAQ,CAAC,EACrD,UAAU,EAAE;IACV,OAAO,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,aAAa,CAAC;QAAC,IAAI,EAAE,cAAc,CAAC,aAAa,CAAC,CAAA;KAAE,CAAC,CAAC;IAC9E,KAAK,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,aAAa,CAAC;QAAC,IAAI,EAAE,cAAc,CAAC,aAAa,CAAC,CAAA;KAAE,CAAC,CAAC;IAC5E,OAAO,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,aAAa,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACtD,GACA,6BAA6B,CAc/B"}
|
|
@@ -3,21 +3,7 @@
|
|
|
3
3
|
* Fluent batch builder for cap table updates.
|
|
4
4
|
*
|
|
5
5
|
* Provides a type-safe API for building batch UpdateCapTable commands that support atomic creates, edits, and deletes
|
|
6
|
-
* of multiple OCF entities.
|
|
7
|
-
*
|
|
8
|
-
* @example
|
|
9
|
-
* ```typescript
|
|
10
|
-
* const result = await ocp.capTable
|
|
11
|
-
* .update({
|
|
12
|
-
* capTableContractId,
|
|
13
|
-
* featuredAppRightContractDetails,
|
|
14
|
-
* })
|
|
15
|
-
* .create('stakeholder', stakeholderData)
|
|
16
|
-
* .create('stockClass', stockClassData)
|
|
17
|
-
* .edit('stakeholder', updatedStakeholderData)
|
|
18
|
-
* .delete('document', documentId)
|
|
19
|
-
* .execute();
|
|
20
|
-
* ```;
|
|
6
|
+
* of multiple OCF entities. Chain .create(), .edit(), and .delete() calls, then call .execute() to submit.
|
|
21
7
|
*/
|
|
22
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
23
9
|
exports.CapTableBatch = void 0;
|
|
@@ -41,16 +27,7 @@ class CapTableBatch {
|
|
|
41
27
|
/**
|
|
42
28
|
* Add a create operation to the batch.
|
|
43
29
|
*
|
|
44
|
-
* @
|
|
45
|
-
* ```typescript
|
|
46
|
-
* batch.create('stakeholder', {
|
|
47
|
-
* id: 'sh-123',
|
|
48
|
-
* name: { legal_name: 'John Doe' },
|
|
49
|
-
* stakeholder_type: 'INDIVIDUAL',
|
|
50
|
-
* });
|
|
51
|
-
* ```;
|
|
52
|
-
*
|
|
53
|
-
* @param type - The OCF entity type to create
|
|
30
|
+
* @param type - The OCF entity type to create (e.g., 'stakeholder', 'stockClass')
|
|
54
31
|
* @param data - The native OCF data for the entity
|
|
55
32
|
* @returns This for chaining
|
|
56
33
|
*/
|
|
@@ -63,15 +40,6 @@ class CapTableBatch {
|
|
|
63
40
|
/**
|
|
64
41
|
* Add an edit operation to the batch.
|
|
65
42
|
*
|
|
66
|
-
* @example
|
|
67
|
-
* ```typescript
|
|
68
|
-
* batch.edit('stakeholder', {
|
|
69
|
-
* id: 'sh-123',
|
|
70
|
-
* name: { legal_name: 'Jane Doe' },
|
|
71
|
-
* stakeholder_type: 'INDIVIDUAL',
|
|
72
|
-
* });
|
|
73
|
-
* ```;
|
|
74
|
-
*
|
|
75
43
|
* @param type - The OCF entity type to edit
|
|
76
44
|
* @param data - The updated native OCF data (must include the entity's id)
|
|
77
45
|
* @returns This for chaining
|
|
@@ -85,11 +53,6 @@ class CapTableBatch {
|
|
|
85
53
|
/**
|
|
86
54
|
* Add a delete operation to the batch.
|
|
87
55
|
*
|
|
88
|
-
* @example
|
|
89
|
-
* ```typescript
|
|
90
|
-
* batch.delete('document', 'doc-123');
|
|
91
|
-
* ```;
|
|
92
|
-
*
|
|
93
56
|
* @param type - The OCF entity type to delete
|
|
94
57
|
* @param id - The OCF object ID to delete
|
|
95
58
|
* @returns This for chaining
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CapTableBatch.js","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/capTable/CapTableBatch.ts"],"names":[],"mappings":";AAAA
|
|
1
|
+
{"version":3,"file":"CapTableBatch.js","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/capTable/CapTableBatch.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AA4MH,gEAqBC;AA1ND,6FAAoE;AAEpE,6CAQsB;AACtB,2CAA4C;AAgB5C;;;;GAIG;AACH,MAAa,aAAa;IAOxB,YAAY,MAA2B,EAAE,SAAqC,IAAI;QAJ1E,YAAO,GAAoB,EAAE,CAAC;QAC9B,UAAK,GAAkB,EAAE,CAAC;QAC1B,YAAO,GAAoB,EAAE,CAAC;QAGpC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAA0B,IAAO,EAAE,IAAuB;QAC9D,MAAM,QAAQ,GAAG,IAAA,yBAAa,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3C,MAAM,GAAG,GAAG,2BAAc,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;QACxC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,EAA8B,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CAA0B,IAAO,EAAE,IAAuB;QAC5D,MAAM,QAAQ,GAAG,IAAA,yBAAa,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3C,MAAM,GAAG,GAAG,2BAAc,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;QACtC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,EAA4B,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAmB,EAAE,EAAU;QACpC,MAAM,GAAG,GAAG,2BAAc,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;QACxC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,EAA8B,CAAC,CAAC;QAClE,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iDAAiD;IACjD,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IACvE,CAAC;IAED,mCAAmC;IACnC,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,+EAA+E,CAAC,CAAC;QACnG,CAAC;QAED,sFAAsF;QACtF,qEAAqE;QACrE,MAAM,kBAAkB,GACtB,IAAI,CAAC,MAAM,CAAC,uBAAuB,EAAE,UAAU,IAAI,yCAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC;QAExG,MAAM,OAAO,GAAY;YACvB,eAAe,EAAE;gBACf,UAAU,EAAE,kBAAkB;gBAC9B,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,kBAAkB;gBAC1C,MAAM,EAAE,gBAAgB;gBACxB,cAAc,EAAE;oBACd,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,OAAO,EAAE,IAAI,CAAC,OAAO;iBACtB;aACF;SACF,CAAC;QAEF,MAAM,kBAAkB,GAAwB;YAC9C;gBACE,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,+BAA+B,CAAC,UAAU;gBAClE,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,+BAA+B,CAAC,UAAU;gBAClE,gBAAgB,EAAE,IAAI,CAAC,MAAM,CAAC,+BAA+B,CAAC,gBAAgB;gBAC9E,cAAc,EAAE,IAAI,CAAC,MAAM,CAAC,+BAA+B,CAAC,cAAc;aAC3E;SACF,CAAC;QAEF,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,iFAAiF,CAAC,CAAC;QACrG,CAAC;QAED,MAAM,EAAE,OAAO,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAErD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,+BAA+B,CAAC;YACjE,QAAQ,EAAE,CAAC,OAAO,CAAC;YACnB,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;YACxB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;YAC1B,kBAAkB;SACnB,CAAC,CAAC;QAEH,+CAA+C;QAC/C,MAAM,IAAI,GAAG,QAAQ,CAAC,eAAe,CAAC;QACtC,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QAE5B,8CAA8C;QAC9C,uFAAuF;QACvF,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9C,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAwC,CAAC;YACzE,IAAI,KAAK,IAAI,oBAAoB,IAAI,KAAK,EAAE,CAAC;gBAC3C,MAAM,SAAS,GAAG,KAAK,CAAC,kBAAyD,CAAC;gBAClF,IAAI,CAAC,SAAS,CAAC,KAAK;oBAAE,SAAS;gBAC/B,MAAM,SAAS,GAAG,SAAS,CAAC,KAG3B,CAAC;gBACF,IAAI,SAAS,CAAC,MAAM,KAAK,gBAAgB,IAAI,SAAS,CAAC,cAAc,EAAE,CAAC;oBACtE,OAAO,SAAS,CAAC,cAAc,CAAC;gBAClC,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;IACzE,CAAC;IAED,2CAA2C;IAC3C,KAAK;QACH,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA1JD,sCA0JC;AAED;;;;;;;;GAQG;AACH,SAAgB,0BAA0B,CACxC,MAAqD,EACrD,UAIC;IAED,MAAM,KAAK,GAAG,IAAI,aAAa,CAAC,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;IAE1D,KAAK,MAAM,EAAE,IAAI,UAAU,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;QAC1C,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IACD,KAAK,MAAM,EAAE,IAAI,UAAU,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC;QACxC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IACD,KAAK,MAAM,EAAE,IAAI,UAAU,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;QAC1C,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,KAAK,CAAC,KAAK,EAAE,CAAC;AACvB,CAAC"}
|
|
@@ -82,25 +82,6 @@ export interface GetStockClassAsOcfResult {
|
|
|
82
82
|
* This function fetches the stock class contract data from the ledger and transforms it into the Open Cap Table
|
|
83
83
|
* Coalition (OCF) format according to the official schema.
|
|
84
84
|
*
|
|
85
|
-
* @example
|
|
86
|
-
* ```typescript
|
|
87
|
-
* const result = await getStockClassAsOcf(client, {
|
|
88
|
-
* contractId: "1234567890abcdef"
|
|
89
|
-
* });
|
|
90
|
-
*
|
|
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
|
-
* ```;
|
|
103
|
-
*
|
|
104
85
|
* @param client - The ledger JSON API client
|
|
105
86
|
* @param params - Parameters for retrieving the stock class
|
|
106
87
|
* @returns Promise resolving to the OCF StockClass object
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getStockClassAsOcf.d.ts","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/stockClass/getStockClassAsOcf.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAuOrE;;;;;GAKG;AACH,UAAU,mBAAmB;IAC3B,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,mBAAmB,CAAC;IAChC,+BAA+B;IAC/B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED
|
|
1
|
+
{"version":3,"file":"getStockClassAsOcf.d.ts","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/stockClass/getStockClassAsOcf.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAuOrE;;;;;GAKG;AACH,UAAU,mBAAmB;IAC3B,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,mBAAmB,CAAC;IAChC,+BAA+B;IAC/B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,wBAAwB,GAC/B,OAAO,CAAC,wBAAwB,CAAC,CA+FnC"}
|
|
@@ -196,25 +196,6 @@ function damlStockClassDataToNative(damlData) {
|
|
|
196
196
|
* This function fetches the stock class contract data from the ledger and transforms it into the Open Cap Table
|
|
197
197
|
* Coalition (OCF) format according to the official schema.
|
|
198
198
|
*
|
|
199
|
-
* @example
|
|
200
|
-
* ```typescript
|
|
201
|
-
* const result = await getStockClassAsOcf(client, {
|
|
202
|
-
* contractId: "1234567890abcdef"
|
|
203
|
-
* });
|
|
204
|
-
*
|
|
205
|
-
* console.log(result.stockClass);
|
|
206
|
-
* // {
|
|
207
|
-
* // object_type: "STOCK_CLASS",
|
|
208
|
-
* // name: "Series A Preferred",
|
|
209
|
-
* // class_type: "PREFERRED",
|
|
210
|
-
* // default_id_prefix: "SA-",
|
|
211
|
-
* // initial_shares_authorized: "1000000",
|
|
212
|
-
* // votes_per_share: "1",
|
|
213
|
-
* // seniority: "1",
|
|
214
|
-
* // // ... other fields
|
|
215
|
-
* // }
|
|
216
|
-
* ```;
|
|
217
|
-
*
|
|
218
199
|
* @param client - The ledger JSON API client
|
|
219
200
|
* @param params - Parameters for retrieving the stock class
|
|
220
201
|
* @returns Promise resolving to the OCF StockClass object
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getStockClassAsOcf.js","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/stockClass/getStockClassAsOcf.ts"],"names":[],"mappings":";;
|
|
1
|
+
{"version":3,"file":"getStockClassAsOcf.js","sourceRoot":"","sources":["../../../../src/functions/OpenCapTable/stockClass/getStockClassAsOcf.ts"],"names":[],"mappings":";;AAiVA,gDAkGC;AA3aD,oEAAoH;AAEpH,SAAS,0BAA0B,CAAC,QAAgB;IAClD,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,4BAA4B;YAC/B,OAAO,WAAW,CAAC;QACrB,KAAK,yBAAyB;YAC5B,OAAO,QAAQ,CAAC;QAClB;YACE,MAAM,IAAI,KAAK,CAAC,kCAAkC,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;AACH,CAAC;AAED,8DAA8D;AAC9D,SAAS,0BAA0B,CAAC,QAAgE;IAClG,MAAM,IAAI,GAAG,QAA8C,CAAC;IAC5D,IAAI,aAAa,GAAG,GAAG,CAAC;IACxB,MAAM,GAAG,GAAG,IAAI,CAAC,yBAAyB,CAAC;IAC3C,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QACvD,aAAa,GAAG,IAAA,wCAAsB,EAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IACtD,CAAC;SAAM,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,KAAK,IAAI,GAAG,EAAE,CAAC;QAC1D,MAAM,MAAM,GAAG,GAAuC,CAAC;QACvD,IAAI,MAAM,CAAC,GAAG,KAAK,yBAAyB,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YACjF,aAAa,GAAG,IAAA,wCAAsB,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACvD,CAAC;aAAM,IAAI,MAAM,CAAC,GAAG,KAAK,sBAAsB,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YACrF,aAAa,GAAG,MAAM,CAAC,KAAK,KAAK,8BAA8B,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC;QACxF,CAAC;IACH,CAAC;IAED,MAAM,UAAU,GAAG,IAAuB,CAAC;IAC3C,OAAO;QACL,EAAE,EAAE,OAAO,UAAU,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;QAC1D,IAAI,EAAE,QAAQ,CAAC,IAAI,IAAI,EAAE;QACzB,UAAU,EAAE,0BAA0B,CAAC,QAAQ,CAAC,UAAU,CAAC;QAC3D,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB,IAAI,EAAE;QACnD,yBAAyB,EAAE,aAAa;QACxC,eAAe,EAAE,IAAA,wCAAsB,EAAC,QAAQ,CAAC,eAAe,IAAI,GAAG,CAAC;QACxE,SAAS,EAAE,IAAA,wCAAsB,EAAC,QAAQ,CAAC,SAAS,IAAI,GAAG,CAAC;QAC5D,iBAAiB,EAAE,EAAE;QACrB,QAAQ,EAAE,EAAE;QACZ,GAAG,CAAC,QAAQ,CAAC,mBAAmB,IAAI;YAClC,mBAAmB,EAAE,IAAA,sCAAoB,EAAC,QAAQ,CAAC,mBAAmB,CAAC;SACxE,CAAC;QACF,GAAG,CAAC,QAAQ,CAAC,yBAAyB,IAAI;YACxC,yBAAyB,EAAE,IAAA,sCAAoB,EAAC,QAAQ,CAAC,yBAAyB,CAAC;SACpF,CAAC;QACF,GAAG,CAAC,QAAQ,CAAC,SAAS,IAAI,EAAE,SAAS,EAAE,IAAA,sCAAoB,EAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QAClF,GAAG,CAAC,QAAQ,CAAC,eAAe,IAAI;YAC9B,eAAe,EAAE,IAAA,sCAAoB,EAAC,QAAQ,CAAC,eAAe,CAAC;SAChE,CAAC;QACF,GAAG,CAAC,QAAQ,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,IAAI;YAC3C,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC1D,MAAM,SAAS,GACb,KAAK,CAAC,oBAAoB,KAAK,uCAAuC;oBACpE,CAAC,CAAC,kBAAkB;oBACpB,CAAC,CAAC,KAAK,CAAC,oBAAoB,KAAK,uDAAuD;wBACtF,CAAC,CAAC,oBAAoB;wBACtB,CAAC,CAAC,yBAAyB,CAAC;gBAClC,MAAM,EAAE,GAAG,KAAK,CAAC,kBAA6B,CAAC;gBAC/C,IAAI,GAAuB,CAAC;gBAC5B,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;oBAC3B,GAAG,GAAG,EAAE,CAAC;gBACX,CAAC;qBAAM,IAAI,EAAE,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;oBACvD,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAqB,CAAC;oBAChD,GAAG,GAAG,QAAQ,CAAC;gBACjB,CAAC;gBACD,MAAM,OAAO,GACX,GAAG,KAAK,+BAA+B;oBACrC,CAAC,CAAC,mBAAmB;oBACrB,CAAC,CAAC,GAAG,KAAK,8BAA8B;wBACtC,CAAC,CAAC,kBAAkB;wBACpB,CAAC,CAAC,GAAG,KAAK,mCAAmC;4BAC3C,CAAC,CAAC,uBAAuB;4BACzB,CAAC,CAAC,GAAG,KAAK,+BAA+B;gCACvC,CAAC,CAAC,uBAAuB;gCACzB,CAAC,CAAC,GAAG,KAAK,2BAA2B;oCACnC,CAAC,CAAC,kBAAkB;oCACpB,CAAC,CAAC,wBAAwB,CAAC;gBAEvC,IAAI,UAA8B,CAAC;gBACnC,MAAM,QAAQ,GAAI,KAAwC,CAAC,KAAK,CAAC;gBACjE,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;oBAC7C,IAAI,KAAK,IAAI,QAAQ,IAAK,QAA6B,CAAC,GAAG,KAAK,MAAM,IAAI,OAAO,IAAI,QAAQ,EAAE,CAAC;wBAC9F,MAAM,CAAC,GAAI,QAAoE,CAAC,KAAK,CAAC;wBACtF,MAAM,GAAG,GAAG,UAAU,CAAE,CAAC,CAAC,SAAoB,IAAI,GAAG,CAAC,CAAC;wBACvD,MAAM,GAAG,GAAG,UAAU,CAAE,CAAC,CAAC,WAAsB,IAAI,GAAG,CAAC,CAAC;wBACzD,UAAU,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;oBACjD,CAAC;yBAAM,IAAI,WAAW,IAAI,QAAQ,IAAI,aAAa,IAAI,QAAQ,EAAE,CAAC;wBAChE,MAAM,CAAC,GAAG,QAAwD,CAAC;wBACnE,MAAM,GAAG,GAAG,UAAU,CAAE,CAAC,CAAC,SAAoB,IAAI,GAAG,CAAC,CAAC;wBACvD,MAAM,GAAG,GAAG,UAAU,CAAE,CAAC,CAAC,WAAsB,IAAI,GAAG,CAAC,CAAC;wBACzD,UAAU,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;oBACjD,CAAC;gBACH,CAAC;gBAED,OAAO;oBACL,IAAI,EAAE,KAAK,CAAC,KAAK;oBACjB,oBAAoB,EAAE,SAAS;oBAC/B,kBAAkB,EAAE,OAAO;oBAC3B,0BAA0B,EAAE,KAAK,CAAC,0BAA0B;oBAC5D,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC1D,GAAG,CAAC,GAA4B,EAAE;wBAChC,MAAM,GAAG,GAA4B,EAAE,CAAC;wBACxC,MAAM,EAAE,GAAI,KAA4C,CAAC,gBAAgB,CAAC;wBAC1E,IACE,EAAE;4BACF,OAAO,EAAE,KAAK,QAAQ;4BACtB,KAAK,IAAI,EAAE;4BACV,EAAuB,CAAC,GAAG,KAAK,MAAM;4BACvC,OAAO,IAAI,EAAE,EACb,CAAC;4BACD,GAAG,CAAC,gBAAgB,GAAG,IAAA,sCAAoB,EACxC,EAAyD,CAAC,KAAK,CACjE,CAAC;wBACJ,CAAC;wBACD,MAAM,GAAG,GAAI,KAA4C,CAAC,qBAAqB,CAAC;wBAChF,IACE,GAAG;4BACH,OAAO,GAAG,KAAK,QAAQ;4BACvB,KAAK,IAAI,GAAG;4BACX,GAAwB,CAAC,GAAG,KAAK,MAAM;4BACxC,OAAO,IAAI,GAAG,EACd,CAAC;4BACD,GAAG,CAAC,qBAAqB,GAAG,IAAA,sCAAoB,EAC7C,GAA0D,CAAC,KAAK,CAClE,CAAC;wBACJ,CAAC;wBACD,MAAM,IAAI,GAAI,KAA4C,CAAC,mCAAmC,CAAC;wBAC/F,IACE,IAAI;4BACJ,OAAO,IAAI,KAAK,QAAQ;4BACxB,KAAK,IAAI,IAAI;4BACZ,IAAyB,CAAC,GAAG,KAAK,MAAM;4BACzC,OAAO,IAAI,IAAI,EACf,CAAC;4BACD,GAAG,CAAC,mCAAmC,GAAG,IAAA,sCAAoB,EAC3D,IAA2D,CAAC,KAAK,CACnE,CAAC;wBACJ,CAAC;wBACD,MAAM,GAAG,GAAI,KAA4C,CAAC,yBAAyB,CAAC;wBACpF,IACE,GAAG;4BACH,OAAO,GAAG,KAAK,QAAQ;4BACvB,KAAK,IAAI,GAAG;4BACX,GAAwB,CAAC,GAAG,KAAK,MAAM;4BACxC,OAAO,IAAI,GAAG,EACd,CAAC;4BACD,GAAG,CAAC,yBAAyB,GAAG,UAAU,CAAE,GAAyB,CAAC,KAAK,CAAC,CAAC;wBAC/E,CAAC;wBACD,MAAM,EAAE,GAAI,KAA4C,CAAC,aAAa,CAAC;wBACvE,IACE,EAAE;4BACF,OAAO,EAAE,KAAK,QAAQ;4BACtB,KAAK,IAAI,EAAE;4BACV,EAAuB,CAAC,GAAG,KAAK,MAAM;4BACvC,OAAO,IAAI,EAAE,EACb,CAAC;4BACD,GAAG,CAAC,aAAa,GAAG,UAAU,CAAE,EAAwB,CAAC,KAAK,CAAC,CAAC;wBAClE,CAAC;wBACD,MAAM,EAAE,GAAI,KAA4C,CAAC,aAAa,CAAC;wBACvE,IACE,EAAE;4BACF,OAAO,EAAE,KAAK,QAAQ;4BACtB,KAAK,IAAI,EAAE;4BACV,EAAuB,CAAC,GAAG,KAAK,MAAM;4BACvC,OAAO,IAAI,EAAE,EACb,CAAC;4BACD,GAAG,CAAC,aAAa,GAAG,IAAA,sCAAoB,EACrC,EAAyD,CAAC,KAAK,CACjE,CAAC;wBACJ,CAAC;wBACD,MAAM,GAAG,GAAI,KAA4C,CAAC,qBAAqB,CAAC;wBAChF,IACE,GAAG;4BACH,OAAO,GAAG,KAAK,QAAQ;4BACvB,KAAK,IAAI,GAAG;4BACX,GAAwB,CAAC,GAAG,KAAK,MAAM;4BACxC,OAAO,IAAI,GAAG,EACd,CAAC;4BACD,GAAG,CAAC,qBAAqB,GAAG,IAAA,sCAAoB,EAC7C,GAA0D,CAAC,KAAK,CAClE,CAAC;wBACJ,CAAC;wBACD,MAAM,GAAG,GAAI,KAA4C,CAAC,uBAAuB,CAAC;wBAClF,IACE,GAAG;4BACH,OAAO,GAAG,KAAK,QAAQ;4BACvB,KAAK,IAAI,GAAG;4BACX,GAAwB,CAAC,GAAG,KAAK,MAAM;4BACxC,OAAO,IAAI,GAAG,EACd,CAAC;4BACD,GAAG,CAAC,uBAAuB,GAAG,IAAA,sCAAoB,EAC/C,GAA0D,CAAC,KAAK,CAClE,CAAC;wBACJ,CAAC;wBACD,MAAM,EAAE,GAAI,KAA4C,CAAC,kBAAkB,CAAC;wBAC5E,IACE,EAAE;4BACF,OAAO,EAAE,KAAK,QAAQ;4BACtB,KAAK,IAAI,EAAE;4BACV,EAAuB,CAAC,GAAG,KAAK,MAAM;4BACvC,OAAO,IAAI,EAAE,EACb,CAAC;4BACD,GAAG,CAAC,kBAAkB,GAAI,EAAwB,CAAC,KAAK,CAAC;wBAC3D,CAAC;wBACD,OAAO,GAAG,CAAC;oBACb,CAAC,CAAC,EAAE;oBACJ,GAAG,CAAC,KAAK,CAAC,UAAU,IAAI,EAAE,UAAU,EAAE,IAAA,sCAAoB,EAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;iBACnD,CAAC;YACjC,CAAC,CAAC;SACH,CAAC;QACF,GAAG,CAAC,QAAQ,CAAC,+BAA+B,IAAI;YAC9C,+BAA+B,EAAE,IAAA,wCAAsB,EAAC,QAAQ,CAAC,+BAA+B,CAAC;SAClG,CAAC;QACF,GAAG,CAAC,QAAQ,CAAC,0BAA0B,IAAI;YACzC,0BAA0B,EAAE,IAAA,wCAAsB,EAAC,QAAQ,CAAC,0BAA0B,CAAC;SACxF,CAAC;QACF,GAAG,CAAC,KAAK,CAAC,OAAO,CAAE,IAA+B,CAAC,QAAQ,CAAC;YAC1D,CAAC,CAAC,EAAE,QAAQ,EAAG,IAA+B,CAAC,QAAQ,EAAE;YACzD,CAAC,CAAC,EAAE,CAAC;KACR,CAAC;AACJ,CAAC;AAiGD;;;;;;;;;;GAUG;AACI,KAAK,UAAU,kBAAkB,CACtC,MAA2B,EAC3B,MAAgC;IAEhC,6CAA6C;IAC7C,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC,qBAAqB,CAAC;QACxD,UAAU,EAAE,MAAM,CAAC,UAAU;KAC9B,CAAC,CAAC;IAEH,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,YAAY,CAAC,cAAc,EAAE,CAAC;QACzD,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;IAChG,CAAC;IAED,MAAM,EAAE,cAAc,EAAE,GAAG,cAAc,CAAC,OAAO,CAAC,YAAY,CAAC;IAE/D,uEAAuE;IACvE,SAAS,iBAAiB,CACxB,GAAY;QAEZ,MAAM,MAAM,GAAG,GAA8B,CAAC;QAC9C,OAAO,CACL,OAAO,GAAG,KAAK,QAAQ;YACvB,GAAG,KAAK,IAAI;YACZ,kBAAkB,IAAI,MAAM;YAC5B,OAAO,MAAM,CAAC,gBAAgB,KAAK,QAAQ,CAC5C,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,EAAE,CAAC;QACvC,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC5E,CAAC;IAED,MAAM,cAAc,GAAG,cAAc,CAAC,gBAAgB,CAAC;IAEvD,6DAA6D;IAC7D,MAAM,oBAAoB,GAAG,0BAA0B,CAAC,cAAc,CAAC,CAAC;IAExE,yDAAyD;IACzD,MAAM,kBAAkB,GAAG,CAAC,QAAuD,EAAE,EAAE,CAAC,CAAC;QACvF,MAAM,EAAE,OAAO,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM;QAC1F,QAAQ,EAAE,QAAQ,CAAC,QAAQ;KAC5B,CAAC,CAAC;IAEH,sEAAsE;IACtE,MAAM,EACJ,EAAE,EACF,SAAS,EACT,eAAe,EACf,yBAAyB,EACzB,eAAe,EACf,SAAS,EACT,+BAA+B,EAC/B,0BAA0B,EAC1B,iBAAiB,EACjB,QAAQ,EACR,GAAG,kBAAkB,EACtB,GAAG,oBAAoB,CAAC;IAEzB,8EAA8E;IAC9E,MAAM,mBAAmB,GAAwB;QAC/C,WAAW,EAAE,aAAa;QAC1B,EAAE;QACF,GAAG,kBAAkB;QACrB,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;QACjD,0DAA0D;QAC1D,yBAAyB,EACvB,OAAO,yBAAyB,KAAK,QAAQ,CAAC,CAAC,CAAC,yBAAyB,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,yBAAyB;QAClH,eAAe,EAAE,OAAO,eAAe,KAAK,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,eAAe;QACnG,SAAS,EAAE,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;QAC3E,6DAA6D;QAC7D,GAAG,CAAC,SAAS,IAAI,EAAE,SAAS,EAAE,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAAC;QAC9D,GAAG,CAAC,eAAe,IAAI,EAAE,eAAe,EAAE,kBAAkB,CAAC,eAAe,CAAC,EAAE,CAAC;QAChF,GAAG,CAAC,+BAA+B,IAAI;YACrC,+BAA+B,EAC7B,OAAO,+BAA+B,KAAK,QAAQ;gBACjD,CAAC,CAAC,+BAA+B,CAAC,QAAQ,EAAE;gBAC5C,CAAC,CAAC,+BAA+B;SACtC,CAAC;QACF,GAAG,CAAC,0BAA0B,IAAI;YAChC,0BAA0B,EACxB,OAAO,0BAA0B,KAAK,QAAQ;gBAC5C,CAAC,CAAC,0BAA0B,CAAC,QAAQ,EAAE;gBACvC,CAAC,CAAC,0BAA0B;SACjC,CAAC;QACF,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC;YAClE,CAAC,CAAC;gBACE,iBAAiB,EAAE,iBAGjB;aACH;YACH,CAAC,CAAC,EAAE,CAAC;KACR,CAAC;IAEF,OAAO;QACL,UAAU,EAAE,mBAAmB;QAC/B,UAAU,EAAE,MAAM,CAAC,UAAU;KAC9B,CAAC;AACJ,CAAC"}
|
package/dist/functions/OpenCapTableReports/companyValuationReport/createCompanyValuationReport.d.ts
CHANGED
|
@@ -19,23 +19,6 @@ export interface CreateCompanyValuationReportResult {
|
|
|
19
19
|
*
|
|
20
20
|
* This function requires the FeaturedAppRight contract details to be provided for disclosed contracts, which is
|
|
21
21
|
* necessary for cross-domain contract interactions in Canton.
|
|
22
|
-
*
|
|
23
|
-
* @example
|
|
24
|
-
* ```typescript
|
|
25
|
-
* const featuredAppRightContractDetails = {
|
|
26
|
-
* contractId: "1234567890abcdef",
|
|
27
|
-
* createdEventBlob: "serialized_contract_blob_here",
|
|
28
|
-
* synchronizerId: "sync_id_here",
|
|
29
|
-
* templateId: "FeaturedAppRight:template:id:here"
|
|
30
|
-
* };
|
|
31
|
-
*
|
|
32
|
-
* const result = await createCompanyValuationReport(client, {
|
|
33
|
-
* companyId: "company123",
|
|
34
|
-
* companyValuation: "1000000",
|
|
35
|
-
* observers: ["observer1", "observer2"],
|
|
36
|
-
* featuredAppRightContractDetails
|
|
37
|
-
* });
|
|
38
|
-
* ```;
|
|
39
22
|
*/
|
|
40
23
|
export declare function createCompanyValuationReport(client: LedgerJsonApiClient, params: CreateCompanyValuationReportParams): Promise<CreateCompanyValuationReportResult>;
|
|
41
24
|
export declare function buildCreateCompanyValuationReportCommand(client: LedgerJsonApiClient, params: CreateCompanyValuationReportParams): CommandWithDisclosedContracts;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createCompanyValuationReport.d.ts","sourceRoot":"","sources":["../../../../src/functions/OpenCapTableReports/companyValuationReport/createCompanyValuationReport.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,KAAK,EAAE,uCAAuC,EAAE,MAAM,wEAAwE,CAAC;AACtI,OAAO,KAAK,EAAW,iBAAiB,EAAE,MAAM,qEAAqE,CAAC;AAItH,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAGpE,MAAM,WAAW,kCAAkC;IACjD,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,MAAM,GAAG,MAAM,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,uEAAuE;IACvE,+BAA+B,EAAE,iBAAiB,CAAC;CACpD;AAED,MAAM,WAAW,kCAAkC;IACjD,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,uCAAuC,CAAC;CACnD;AAED
|
|
1
|
+
{"version":3,"file":"createCompanyValuationReport.d.ts","sourceRoot":"","sources":["../../../../src/functions/OpenCapTableReports/companyValuationReport/createCompanyValuationReport.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,KAAK,EAAE,uCAAuC,EAAE,MAAM,wEAAwE,CAAC;AACtI,OAAO,KAAK,EAAW,iBAAiB,EAAE,MAAM,qEAAqE,CAAC;AAItH,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAGpE,MAAM,WAAW,kCAAkC;IACjD,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,MAAM,GAAG,MAAM,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,uEAAuE;IACvE,+BAA+B,EAAE,iBAAiB,CAAC;CACpD;AAED,MAAM,WAAW,kCAAkC;IACjD,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,uCAAuC,CAAC;CACnD;AAED;;;;;GAKG;AACH,wBAAsB,4BAA4B,CAChD,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,kCAAkC,GACzC,OAAO,CAAC,kCAAkC,CAAC,CAqB7C;AAED,wBAAgB,wCAAwC,CACtD,MAAM,EAAE,mBAAmB,EAC3B,MAAM,EAAE,kCAAkC,GACzC,6BAA6B,CAmC/B"}
|
package/dist/functions/OpenCapTableReports/companyValuationReport/createCompanyValuationReport.js
CHANGED
|
@@ -14,23 +14,6 @@ const typeConversions_1 = require("../../../utils/typeConversions");
|
|
|
14
14
|
*
|
|
15
15
|
* This function requires the FeaturedAppRight contract details to be provided for disclosed contracts, which is
|
|
16
16
|
* necessary for cross-domain contract interactions in Canton.
|
|
17
|
-
*
|
|
18
|
-
* @example
|
|
19
|
-
* ```typescript
|
|
20
|
-
* const featuredAppRightContractDetails = {
|
|
21
|
-
* contractId: "1234567890abcdef",
|
|
22
|
-
* createdEventBlob: "serialized_contract_blob_here",
|
|
23
|
-
* synchronizerId: "sync_id_here",
|
|
24
|
-
* templateId: "FeaturedAppRight:template:id:here"
|
|
25
|
-
* };
|
|
26
|
-
*
|
|
27
|
-
* const result = await createCompanyValuationReport(client, {
|
|
28
|
-
* companyId: "company123",
|
|
29
|
-
* companyValuation: "1000000",
|
|
30
|
-
* observers: ["observer1", "observer2"],
|
|
31
|
-
* featuredAppRightContractDetails
|
|
32
|
-
* });
|
|
33
|
-
* ```;
|
|
34
17
|
*/
|
|
35
18
|
async function createCompanyValuationReport(client, params) {
|
|
36
19
|
const { command, disclosedContracts } = buildCreateCompanyValuationReportCommand(client, params);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createCompanyValuationReport.js","sourceRoot":"","sources":["../../../../src/functions/OpenCapTableReports/companyValuationReport/createCompanyValuationReport.ts"],"names":[],"mappings":";;;;;
|
|
1
|
+
{"version":3,"file":"createCompanyValuationReport.js","sourceRoot":"","sources":["../../../../src/functions/OpenCapTableReports/companyValuationReport/createCompanyValuationReport.ts"],"names":[],"mappings":";;;;;AA6BA,oEAwBC;AAED,4FAsCC;AA1FD,2GAAoH;AACpH,sEAAwE;AACxE,iJAA8G;AAE9G,oEAAiE;AAgBjE;;;;;GAKG;AACI,KAAK,UAAU,4BAA4B,CAChD,MAA2B,EAC3B,MAA0C;IAE1C,MAAM,EAAE,OAAO,EAAE,kBAAkB,EAAE,GAAG,wCAAwC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjG,MAAM,QAAQ,GAAG,CAAC,MAAM,MAAM,CAAC,+BAA+B,CAAC;QAC7D,QAAQ,EAAE,CAAC,OAAO,CAAC;QACnB,kBAAkB;KACnB,CAAC,CAA4C,CAAC;IAE/C,MAAM,OAAO,GAAG,IAAA,+CAA4B,EAC1C,QAAQ,EACR,cAAQ,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,sBAAsB,CAAC,UAAU,CACtF,CAAC;IACF,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACzD,CAAC;IAED,OAAO;QACL,UAAU,EAAE,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,UAAU;QACrD,QAAQ,EAAE,IAAA,iCAAe,EAAC,QAAQ,CAAC;QACnC,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,SAAgB,wCAAwC,CACtD,MAA2B,EAC3B,MAA0C;IAE1C,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;IACpC,MAAM,WAAW,GAAG,0CAAqB,CAAC,OAA6C,CAE1E,CAAC;IACd,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,wBAAwB,OAAO,EAAE,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,eAAe,GAA6E;QAChG,UAAU,EAAE,MAAM,CAAC,SAAS;QAC5B,iBAAiB,EACf,OAAO,MAAM,CAAC,gBAAgB,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,gBAAgB;QAC5G,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,EAAE;KAClC,CAAC;IAEF,MAAM,OAAO,GAAY;QACvB,eAAe,EAAE;YACf,UAAU,EAAE,WAAW,CAAC,UAAU;YAClC,UAAU,EAAE,WAAW,CAAC,wBAAwB;YAChD,MAAM,EAAE,8BAA8B;YACtC,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 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/functions/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/functions/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,kBAAkB,CAAC"}
|
package/dist/functions/index.js
CHANGED
|
@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
__exportStar(require("./CantonPayments"), exports);
|
|
18
|
+
__exportStar(require("./CouponMinter"), exports);
|
|
18
19
|
__exportStar(require("./OpenCapTable"), exports);
|
|
19
20
|
__exportStar(require("./OpenCapTableReports"), exports);
|
|
20
21
|
__exportStar(require("./PaymentStreams"), exports);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/functions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,iDAA+B;AAC/B,wDAAsC;AACtC,mDAAiC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/functions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,iDAA+B;AAC/B,iDAA+B;AAC/B,wDAAsC;AACtC,mDAAiC"}
|
|
@@ -16,13 +16,6 @@
|
|
|
16
16
|
* - Trims string whitespace
|
|
17
17
|
* - Recursively compares nested objects
|
|
18
18
|
*
|
|
19
|
-
* @example
|
|
20
|
-
* ```typescript
|
|
21
|
-
* const obj1 = { quantity: '100.0000000000', name: 'Test' };
|
|
22
|
-
* const obj2 = { quantity: '100', name: 'Test' };
|
|
23
|
-
* ocfDeepEqual(obj1, obj2); // true - normalized numbers match
|
|
24
|
-
* ```;
|
|
25
|
-
*
|
|
26
19
|
* @param a - First OCF object
|
|
27
20
|
* @param b - Second OCF object
|
|
28
21
|
* @returns True if objects are semantically equal
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ocfComparison.d.ts","sourceRoot":"","sources":["../../src/utils/ocfComparison.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AA8FH
|
|
1
|
+
{"version":3,"file":"ocfComparison.d.ts","sourceRoot":"","sources":["../../src/utils/ocfComparison.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AA8FH;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO,CA4C5D"}
|
|
@@ -112,13 +112,6 @@ function isUndefinedLike(value) {
|
|
|
112
112
|
* - Trims string whitespace
|
|
113
113
|
* - Recursively compares nested objects
|
|
114
114
|
*
|
|
115
|
-
* @example
|
|
116
|
-
* ```typescript
|
|
117
|
-
* const obj1 = { quantity: '100.0000000000', name: 'Test' };
|
|
118
|
-
* const obj2 = { quantity: '100', name: 'Test' };
|
|
119
|
-
* ocfDeepEqual(obj1, obj2); // true - normalized numbers match
|
|
120
|
-
* ```;
|
|
121
|
-
*
|
|
122
115
|
* @param a - First OCF object
|
|
123
116
|
* @param b - Second OCF object
|
|
124
117
|
* @returns True if objects are semantically equal
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ocfComparison.js","sourceRoot":"","sources":["../../src/utils/ocfComparison.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;
|
|
1
|
+
{"version":3,"file":"ocfComparison.js","sourceRoot":"","sources":["../../src/utils/ocfComparison.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;AA4GH,oCA4CC;AAtJD;;;;;;;;;;GAUG;AACH,SAAS,iBAAiB,CAAC,KAAc;IACvC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,qEAAqE;QACrE,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAE7B,0CAA0C;QAC1C,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACjC,uDAAuD;YACvD,OAAO,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACzB,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAS,eAAe,CAAC,KAAc;IACrC,oBAAoB;IACpB,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAEvD,2CAA2C;IAC3C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE;QAAE,OAAO,IAAI,CAAC;IAElE,6EAA6E;IAC7E,MAAM,gBAAgB,GAAG,CAAC,CAAU,EAAW,EAAE;QAC/C,IAAI,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC9C,MAAM,GAAG,GAAG,CAA4B,CAAC;QACzC,MAAM,QAAQ,GAAG,GAAG,CAAC,uBAAuB,CAAC,CAAC;QAC9C,MAAM,MAAM,GAAG,GAAG,CAAC,qBAAqB,CAAC,CAAC;QAC1C,uBAAuB;QACvB,IAAI,QAAQ,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,KAAK,CAAC;QACjE,MAAM,aAAa,GAAG,CAAC,CAAU,EAAU,EAAE;YAC3C,IAAI,OAAO,CAAC,KAAK,QAAQ;gBAAE,OAAO,CAAC,CAAC;YACpC,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;gBAC1B,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC3B,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5B,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC,CAAC;QACF,MAAM,KAAK,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;QACtC,MAAM,GAAG,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;QAClC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC;IAClE,CAAC,CAAC;IAEF,8EAA8E;IAC9E,gGAAgG;IAChG,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QACpC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACxD,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;YAAE,OAAO,IAAI,CAAC;QACzD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gFAAgF;IAChF,gFAAgF;IAChF,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,GAAG,GAAG,KAAgC,CAAC;QAC7C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QACnC,IAAI,gBAAgB,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QACzC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACpD,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,YAAY,CAAC,CAAU,EAAE,CAAU;IACjD,gDAAgD;IAChD,IAAI,eAAe,CAAC,CAAC,CAAC,IAAI,eAAe,CAAC,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IAE1D,wBAAwB;IACxB,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACzB,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI;QAAE,OAAO,KAAK,CAAC;IAEzC,yBAAyB;IACzB,IAAI,OAAO,CAAC,KAAK,OAAO,CAAC;QAAE,OAAO,KAAK,CAAC;IAExC,4BAA4B;IAC5B,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;QACnD,MAAM,IAAI,GAAG,CAA4B,CAAC;QAC1C,MAAM,IAAI,GAAG,CAA4B,CAAC;QAE1C,eAAe;QACf,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,KAAK,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAE1D,0BAA0B;QAC1B,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;YAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;YACvB,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;YAEvB,2EAA2E;YAC3E,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC;gBAAE,SAAS;YAE7D,iEAAiE;YACjE,IAAI,eAAe,CAAC,IAAI,CAAC,KAAK,eAAe,CAAC,IAAI,CAAC;gBAAE,OAAO,KAAK,CAAC;YAElE,6BAA6B;YAC7B,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC;gBAAE,OAAO,KAAK,CAAC;QAC9C,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,6CAA6C;IAC7C,MAAM,WAAW,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;IACzC,MAAM,WAAW,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAEzC,OAAO,WAAW,KAAK,WAAW,CAAC;AACrC,CAAC"}
|
|
@@ -15,13 +15,6 @@ import { getAllOcfTypes, getOcfMetadata, isValidOcfType, OCF_METADATA, type OcfO
|
|
|
15
15
|
* This is the field name where OCF data is stored in the contract's create arguments. Useful for extracting OCF data
|
|
16
16
|
* from transaction trees.
|
|
17
17
|
*
|
|
18
|
-
* @example
|
|
19
|
-
* ```typescript
|
|
20
|
-
* getOcfDataFieldName('STAKEHOLDER'); // 'stakeholder_data'
|
|
21
|
-
* getOcfDataFieldName('TX_STOCK_ISSUANCE'); // 'issuance_data'
|
|
22
|
-
* getOcfDataFieldName('STOCK_CLASS'); // 'stock_class_data'
|
|
23
|
-
* ```;
|
|
24
|
-
*
|
|
25
18
|
* @param type - The OCF object type
|
|
26
19
|
* @returns The data field name (e.g., 'stakeholder_data', 'issuance_data')
|
|
27
20
|
*/
|
|
@@ -31,12 +24,6 @@ export declare function getOcfDataFieldName(type: OcfObjectType): string;
|
|
|
31
24
|
*
|
|
32
25
|
* Uses the type's metadata to navigate to the ID field.
|
|
33
26
|
*
|
|
34
|
-
* @example
|
|
35
|
-
* ```typescript
|
|
36
|
-
* const args = { stakeholder_data: { id: 'sh-123', name: { legal_name: 'John' } } };
|
|
37
|
-
* extractOcfIdFromCreateArgs('STAKEHOLDER', args); // 'sh-123'
|
|
38
|
-
* ```;
|
|
39
|
-
*
|
|
40
27
|
* @param type - The OCF object type
|
|
41
28
|
* @param createArgs - The contract's create arguments from a transaction tree
|
|
42
29
|
* @returns The OCF ID string, or undefined if not found
|
|
@@ -47,16 +34,9 @@ export declare function extractOcfIdFromCreateArgs(type: OcfObjectType, createAr
|
|
|
47
34
|
*
|
|
48
35
|
* Useful for logging, notifications, and UI display.
|
|
49
36
|
*
|
|
50
|
-
* @example
|
|
51
|
-
* ```typescript
|
|
52
|
-
* getOcfTypeLabel('STAKEHOLDER', 1); // '1 Stakeholder'
|
|
53
|
-
* getOcfTypeLabel('STAKEHOLDER', 5); // '5 Stakeholders'
|
|
54
|
-
* getOcfTypeLabel('TX_STOCK_ISSUANCE', 1); // '1 Stock Issuance'
|
|
55
|
-
* ```;
|
|
56
|
-
*
|
|
57
37
|
* @param type - The OCF object type
|
|
58
38
|
* @param count - Number of items (for pluralization)
|
|
59
|
-
* @returns Human-readable label
|
|
39
|
+
* @returns Human-readable label (e.g., '1 Stakeholder', '5 Stakeholders')
|
|
60
40
|
*/
|
|
61
41
|
export declare function getOcfTypeLabel(type: OcfObjectType, count: number): string;
|
|
62
42
|
export { getAllOcfTypes, getOcfMetadata, isValidOcfType, OCF_METADATA, type OcfObjectType };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ocfHelpers.d.ts","sourceRoot":"","sources":["../../src/utils/ocfHelpers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,cAAc,EAAE,YAAY,EAAE,KAAK,aAAa,EAAE,MAAM,eAAe,CAAC;AAEjH
|
|
1
|
+
{"version":3,"file":"ocfHelpers.d.ts","sourceRoot":"","sources":["../../src/utils/ocfHelpers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,cAAc,EAAE,YAAY,EAAE,KAAK,aAAa,EAAE,MAAM,eAAe,CAAC;AAEjH;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CAI/D;AAED;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,aAAa,EAAE,UAAU,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAgBvG;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAoD1E;AAGD,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,cAAc,EAAE,YAAY,EAAE,KAAK,aAAa,EAAE,CAAC"}
|
package/dist/utils/ocfHelpers.js
CHANGED
|
@@ -25,13 +25,6 @@ Object.defineProperty(exports, "OCF_METADATA", { enumerable: true, get: function
|
|
|
25
25
|
* This is the field name where OCF data is stored in the contract's create arguments. Useful for extracting OCF data
|
|
26
26
|
* from transaction trees.
|
|
27
27
|
*
|
|
28
|
-
* @example
|
|
29
|
-
* ```typescript
|
|
30
|
-
* getOcfDataFieldName('STAKEHOLDER'); // 'stakeholder_data'
|
|
31
|
-
* getOcfDataFieldName('TX_STOCK_ISSUANCE'); // 'issuance_data'
|
|
32
|
-
* getOcfDataFieldName('STOCK_CLASS'); // 'stock_class_data'
|
|
33
|
-
* ```;
|
|
34
|
-
*
|
|
35
28
|
* @param type - The OCF object type
|
|
36
29
|
* @returns The data field name (e.g., 'stakeholder_data', 'issuance_data')
|
|
37
30
|
*/
|
|
@@ -45,12 +38,6 @@ function getOcfDataFieldName(type) {
|
|
|
45
38
|
*
|
|
46
39
|
* Uses the type's metadata to navigate to the ID field.
|
|
47
40
|
*
|
|
48
|
-
* @example
|
|
49
|
-
* ```typescript
|
|
50
|
-
* const args = { stakeholder_data: { id: 'sh-123', name: { legal_name: 'John' } } };
|
|
51
|
-
* extractOcfIdFromCreateArgs('STAKEHOLDER', args); // 'sh-123'
|
|
52
|
-
* ```;
|
|
53
|
-
*
|
|
54
41
|
* @param type - The OCF object type
|
|
55
42
|
* @param createArgs - The contract's create arguments from a transaction tree
|
|
56
43
|
* @returns The OCF ID string, or undefined if not found
|
|
@@ -74,16 +61,9 @@ function extractOcfIdFromCreateArgs(type, createArgs) {
|
|
|
74
61
|
*
|
|
75
62
|
* Useful for logging, notifications, and UI display.
|
|
76
63
|
*
|
|
77
|
-
* @example
|
|
78
|
-
* ```typescript
|
|
79
|
-
* getOcfTypeLabel('STAKEHOLDER', 1); // '1 Stakeholder'
|
|
80
|
-
* getOcfTypeLabel('STAKEHOLDER', 5); // '5 Stakeholders'
|
|
81
|
-
* getOcfTypeLabel('TX_STOCK_ISSUANCE', 1); // '1 Stock Issuance'
|
|
82
|
-
* ```;
|
|
83
|
-
*
|
|
84
64
|
* @param type - The OCF object type
|
|
85
65
|
* @param count - Number of items (for pluralization)
|
|
86
|
-
* @returns Human-readable label
|
|
66
|
+
* @returns Human-readable label (e.g., '1 Stakeholder', '5 Stakeholders')
|
|
87
67
|
*/
|
|
88
68
|
function getOcfTypeLabel(type, count) {
|
|
89
69
|
// Convert type to title case and handle special cases
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ocfHelpers.js","sourceRoot":"","sources":["../../src/utils/ocfHelpers.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;
|
|
1
|
+
{"version":3,"file":"ocfHelpers.js","sourceRoot":"","sources":["../../src/utils/ocfHelpers.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;AAaH,kDAIC;AAWD,gEAgBC;AAWD,0CAoDC;AAzGD,+CAAiH;AA4GxG,+FA5GA,4BAAc,OA4GA;AAAE,+FA5GA,4BAAc,OA4GA;AAAE,+FA5GA,4BAAc,OA4GA;AAAE,6FA5GA,0BAAY,OA4GA;AA1GrE;;;;;;;;GAQG;AACH,SAAgB,mBAAmB,CAAC,IAAmB;IACrD,MAAM,QAAQ,GAAG,IAAA,4BAAc,EAAC,IAAI,CAAC,CAAC;IACtC,wDAAwD;IACxD,OAAO,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,0BAA0B,CAAC,IAAmB,EAAE,UAAmB;IACjF,IAAI,CAAC,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QAClD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,QAAQ,GAAG,IAAA,4BAAc,EAAC,IAAI,CAAC,CAAC;IACtC,IAAI,OAAO,GAAY,UAAU,CAAC;IAElC,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;QACrC,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC7E,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,GAAI,OAAmC,CAAC,GAAG,CAAC,CAAC;IACtD,CAAC;IAED,OAAO,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AAC3D,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAAC,IAAmB,EAAE,KAAa;IAChE,sDAAsD;IACtD,MAAM,QAAQ,GAAyE;QACrF,WAAW,EAAE,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,EAAE,eAAe,EAAE;QACjE,WAAW,EAAE,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,EAAE,cAAc,EAAE;QAChE,UAAU,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE;QAC7D,qBAAqB,EAAE,EAAE,QAAQ,EAAE,uBAAuB,EAAE,MAAM,EAAE,wBAAwB,EAAE;QAC9F,QAAQ,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE;QACvD,aAAa,EAAE,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,EAAE,eAAe,EAAE;QACrE,iBAAiB,EAAE,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,iBAAiB,EAAE;QAC5E,mBAAmB,EAAE,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,EAAE,mBAAmB,EAAE;QAClF,uBAAuB,EAAE,EAAE,QAAQ,EAAE,sBAAsB,EAAE,MAAM,EAAE,uBAAuB,EAAE;QAC9F,6BAA6B,EAAE,EAAE,QAAQ,EAAE,4BAA4B,EAAE,MAAM,EAAE,6BAA6B,EAAE;QAChH,2CAA2C,EAAE;YAC3C,QAAQ,EAAE,0CAA0C;YACpD,MAAM,EAAE,2CAA2C;SACpD;QACD,qBAAqB,EAAE,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,EAAE,qBAAqB,EAAE;QACxF,uBAAuB,EAAE,EAAE,QAAQ,EAAE,sBAAsB,EAAE,MAAM,EAAE,uBAAuB,EAAE;QAC9F,2BAA2B,EAAE,EAAE,QAAQ,EAAE,0BAA0B,EAAE,MAAM,EAAE,2BAA2B,EAAE;QAC1G,mCAAmC,EAAE;YACnC,QAAQ,EAAE,kCAAkC;YAC5C,MAAM,EAAE,mCAAmC;SAC5C;QACD,sCAAsC,EAAE;YACtC,QAAQ,EAAE,qCAAqC;YAC/C,MAAM,EAAE,sCAAsC;SAC/C;QACD,+BAA+B,EAAE;YAC/B,QAAQ,EAAE,8BAA8B;YACxC,MAAM,EAAE,+BAA+B;SACxC;QACD,+BAA+B,EAAE;YAC/B,QAAQ,EAAE,8BAA8B;YACxC,MAAM,EAAE,+BAA+B;SACxC;KACF,CAAC;IAEF,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC9B,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,KAAK,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;QAC5D,OAAO,GAAG,KAAK,IAAI,KAAK,EAAE,CAAC;IAC7B,CAAC;IAED,uCAAuC;IACvC,MAAM,QAAQ,GAAG,IAAI;SAClB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;SACnB,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;SACzE,IAAI,CAAC,GAAG,CAAC,CAAC;IAEb,OAAO,GAAG,KAAK,IAAI,QAAQ,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;AACzD,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@open-captable-protocol/canton",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.144",
|
|
4
4
|
"description": "A TypeScript SDK for interacting with the Open CapTable Protocol (OCP) Factory contract on Canton blockchain",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"main": "dist/index.js",
|