@open-captable-protocol/canton 0.2.142 → 0.2.143
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 +12 -1
- package/dist/OcpClient.d.ts.map +1 -1
- package/dist/OcpClient.js +4 -0
- 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/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/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
|
/**
|
|
@@ -158,6 +158,17 @@ export declare class OcpClient {
|
|
|
158
158
|
buildCreateCompanyValuationReportCommand: (params: CreateCompanyValuationReportParams) => CommandWithDisclosedContracts;
|
|
159
159
|
};
|
|
160
160
|
};
|
|
161
|
+
/** CouponMinter utilities for TPS rate limit checking. */
|
|
162
|
+
CouponMinter: {
|
|
163
|
+
/**
|
|
164
|
+
* Checks if minting coupons is currently allowed based on TPS rate limits.
|
|
165
|
+
*
|
|
166
|
+
* @param payload - The CouponMinter contract payload
|
|
167
|
+
* @param now - Optional current time for testing
|
|
168
|
+
* @returns {canMint: true} Or { canMint: false, waitMs: number }
|
|
169
|
+
*/
|
|
170
|
+
canMintCouponsNow: (payload: CouponMinterPayload, now?: Date) => CanMintResult;
|
|
171
|
+
};
|
|
161
172
|
/** Payment and airdrop operations using Canton's native token. */
|
|
162
173
|
CantonPayments: {
|
|
163
174
|
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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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,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.
|
|
@@ -138,6 +139,9 @@ class OcpClient {
|
|
|
138
139
|
updateCompanyValuationReport: async (params) => (0, functions_1.updateCompanyValuationReport)(this.client, params),
|
|
139
140
|
},
|
|
140
141
|
};
|
|
142
|
+
this.CouponMinter = {
|
|
143
|
+
canMintCouponsNow: (payload, now) => (0, CouponMinter_1.canMintCouponsNow)(payload, now),
|
|
144
|
+
};
|
|
141
145
|
/* eslint-disable @typescript-eslint/no-require-imports */
|
|
142
146
|
this.CantonPayments = {
|
|
143
147
|
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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;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"}
|
|
@@ -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"}
|
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.143",
|
|
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",
|