@invisible-labs/sdk 0.8.0-devnet → 0.10.0-devnet

package/dist/lp.d.ts

@@ -19,6 +19,12 @@ declare function bytesToHex(bytes: Uint8Array): string;
 declare function signLpCommandBytes(auth: LpPositionCodeAuth, bytes: Uint8Array): Promise<Uint8Array>;
 
 type SourceLiquidityUse = "not_materialized" | "available" | "locked_for_payout" | "pending_finality" | "spent" | "released";
+type LpFeePolicy = {
+    readonly version: 1;
+    readonly profile: "internal" | "partner";
+    readonly commission_bps: 0 | 6000;
+    readonly policy_hash: string;
+};
 type LpWithdrawalMode = "exact" | "max_available";
 type LpInventoryShard = {
     kind: "lp";
@@ -34,6 +40,8 @@ type LpInventoryShard = {
     coolingUntilMs?: number;
 };
 type LpPositionView = {
+    feePolicy?: LpFeePolicy;
+    lpFeePolicyVersion?: 1;
     id: string;
     status: "dkg_pending" | "active" | "withdrawing" | "closed";
     targetShardCount: number;
@@ -41,6 +49,7 @@ type LpPositionView = {
     refillPublicKey: string;
     withdrawalCommitment: string;
     committedLamports: number;
+    /** Historical gross fees. With feePolicy, use actorSync.lifetimeEarnedLamports for the LP net entitlement. */
     earnedLamports: number;
     refillThreshold: number;
     shards: LpInventoryShard[];
@@ -53,11 +62,29 @@ type LpRedemptionPermission = {
     grantRevision: number;
     observedAtMs: number;
 };
+type LpEconomicReturnSummary = {
+    providerRewardLamports: string;
+    sourceExpenseCompensationLamports: string;
+    chargedReimbursementLossLamports: string;
+    /** Provider reward minus charged losses and policy commission; nominal expense repayments are excluded. */
+    netEconomicReturnLamports: string;
+};
 type LpActorSyncView = {
+    feePolicy?: LpFeePolicy;
+    feeBasisRevision?: number;
+    /** Cumulative assessed plus unassessed surviving confirmed provider-fee basis. */
+    grossFeeLamports?: number;
+    /** Cumulative assessed commission plus the projected commission on unassessed fees. */
+    protocolCommissionLamports?: number;
+    /** Cumulative sub-rent commission paid to this LP on full drains instead of the protocol. */
+    waivedProtocolCommissionLamports?: number;
+    economicReturn?: LpEconomicReturnSummary;
     lpPositionId: string;
     status: "idle" | "settling" | "reimbursement_due";
     sourceLiquidityUse: SourceLiquidityUse;
     redeemableProjectionAvailable: boolean;
+    /** Net LP-owned principal and confirmed fees, including temporarily engaged capital. */
+    totalNetFundsLamports?: number;
     redeemablePrincipalLamports: number;
     redeemableFeeLamports: number;
     lifetimeEarnedLamports: number;
@@ -85,6 +112,8 @@ type LpActorSyncView = {
     updatedAtMs: number;
 };
 type LpRedemptionHistoryView = {
+    feePolicyHash?: string;
+    feeBasisRevision?: number;
     redemptionId: string;
     state: "requested" | "match_requested" | "reserved" | "pending" | "confirmed" | "rejected";
     withdrawalMode?: LpWithdrawalMode;
@@ -122,10 +151,12 @@ type LpPositionCreationIntent = {
 };
 type LpCreationAuthorization = {
     readonly authorizationId: string;
+    readonly feePolicy?: LpFeePolicy;
 };
 type OpenLpPositionInput = {
     lpPositionId: string;
     creationAuthorizationId: string;
+    feePolicy?: LpFeePolicy;
     authPublicKey: number[];
     refillPublicKey: number[];
     withdrawalCommitment: number[];
@@ -163,6 +194,8 @@ type FinalizeLpDkgBatchInput = {
     finalizedAtMs: number;
 };
 type LpWithdrawalExecutionView = {
+    feePolicyHash?: string;
+    feeBasisRevision?: number;
     withdrawalId: string;
     txSignatures: string[];
     acceptedLamports: number;
@@ -226,6 +259,8 @@ type LpCoordinatorClient = LpDkgClient & {
         earnedFeeLamports: number;
         withdrawalMode: LpWithdrawalMode;
         requestedAtMs: number;
+        feePolicyHash?: string;
+        feeBasisRevision?: number;
         allowManyToOne?: boolean;
     }, auth: LpPositionCodeAuth): Promise<LpWithdrawalExecutionView>;
 };
@@ -235,6 +270,11 @@ interface LpPositionRequestOptions {
     readonly timeoutMs?: number;
 }
 
+/** Invalid optional totals must not discard the position or its authorities. */
+declare function normalizeLpActorSync(sync: LpActorSyncView): LpActorSyncView;
+/** Keep one coherent actor projection when concurrent reads arrive out of order. */
+declare function mergeLpActorSync(previous: LpActorSyncView | undefined, next: LpActorSyncView | undefined): LpActorSyncView | undefined;
+
 declare const LP_REDEMPTION_RECONCILING_MESSAGE = "LP redemption is still settling on the coordinator; it will reconcile from sync";
 declare const LP_MISSING_POSITION_CODE_MESSAGE = "Save or recover the LP Position Code before using LP funds";
 declare const LP_FEE_SOURCE_COUNT_UNAVAILABLE_MESSAGE = "LP earned-fee source count is not available; pass allowManyToOne: true to acknowledge many-to-one withdrawal risk";
@@ -302,6 +342,8 @@ interface RefillArgs {
     readonly workerFactory?: () => Worker;
 }
 interface WithdrawalExecution {
+    readonly feePolicyHash?: string;
+    readonly feeBasisRevision?: number;
     readonly withdrawalId: string;
     readonly txSignatures: string[];
     readonly acceptedLamports?: number;
@@ -309,6 +351,8 @@ interface WithdrawalExecution {
     readonly acceptedEarnedFeeLamports?: number;
 }
 interface LpWithdrawalRecord {
+    readonly feePolicyHash?: string;
+    readonly feeBasisRevision?: number;
     readonly redemptionId: string;
     readonly lpPositionId: string;
     readonly requestedAt: number;
@@ -322,6 +366,7 @@ interface LpWithdrawalRecord {
     readonly landedBaselineLamports: number;
     readonly landedFeeBaselineLamports?: number;
     readonly redeemedLamports: number;
+    readonly networkFeeLossLamports?: number;
     readonly txSignatures: string[];
     readonly txSignatureBaseline: string[];
     readonly coordinatorStateVersion?: number;
@@ -429,6 +474,8 @@ declare const LP_DKG_WORKER_REQUEST_TIMEOUT_MESSAGE = "LP DKG worker request tim
 declare const LP_DKG_ABORT_CLEANUP_TIMEOUT_MS = 10000;
 declare function createLpDkgBatch(input: CreateLpDkgBatchInput): Promise<string[]>;
 
+declare function validateLpPositionFeePolicy(position: LpPositionView, previous?: LpPositionView): void;
+
 declare function createPosition(session: Session, args: CreatePositionArgs): Promise<CreatePositionResult>;
 declare function recoverPosition(session: Session, args: RecoverPositionArgs): Promise<LpPositionView>;
 declare function confirmPositionCodeSaved(session: Session, positionId: string): void;
@@ -450,4 +497,4 @@ declare function withdrawFees(session: Session, positionId: string, args: {
 }): Promise<never>;
 declare function listPositions(session: Session): Promise<LpPositionView[]>;
 
-export { type CompleteDkgBatchOptions, type CreateLpDkgBatchInput, type CreatePositionArgs, type CreatePositionResult, type FinalizeLpDkgBatchInput, type FundingConfirmationInput, type InitialFundingPlan, LP_COMMAND_REQUEST_TIMEOUT_MS, LP_DKG_ABORT_CLEANUP_TIMEOUT_MS, LP_DKG_ABORT_REQUEST_TIMEOUT_MS, LP_DKG_WORKER_REQUEST_TIMEOUT_MESSAGE, LP_DKG_WORKER_REQUEST_TIMEOUT_MS, LP_FEE_SOURCE_COUNT_UNAVAILABLE_MESSAGE, LP_MISSING_POSITION_CODE_MESSAGE, LP_REDEMPTION_RECONCILING_MESSAGE, type LpActorSyncView, type LpCoordinatorClient, type LpCoordinatorClientOptions, type LpCreationAuthorization, type LpCreationSigner, type LpDkgClient, type LpDkgProgress, type LpInventoryShard, type LpLifecycleClient, type LpLifecycleDkgProgress, type LpLifecycleRuntime, type LpPositionCode, type LpPositionCodeAuth, type LpPositionCreationIntent, type LpPositionRequestOptions, type LpPositionView, type LpRedemptionHistoryView, type LpRedemptionPermission, type LpTopUpRequest, type LpWithdrawalExecutionView, type LpWithdrawalMode, type LpWithdrawalPlanPreview, type LpWithdrawalPlanPreviewArgs, type LpWithdrawalRecord, type OpenLpPositionInput, type RecoverPositionArgs, type RefillArgs, type RefillLpPositionInput, type SourceLiquidityUse, type WaitForTopUpOptions, type WaitForWithdrawalConfirmationOptions, type WithdrawPositionArgs, type WithdrawPositionResult, type WithdrawalConfirmation, type WithdrawalExecution, bytesToHex, completeDkgBatch, confirmPositionCodeSaved, createLpCoordinatorClient, createLpDkgBatch, createLpLifecycleClient, createPosition, defaultLpLifecycleClient, deriveLpPositionCodeAuth, generateLpPositionCode, isLpPositionAuthMissingError, isLpRedemptionReconcilingError, listPositions, normalizeLpPositionCode, prepareInitialFunding, prepareTopUp, previewLpWithdrawalPlan, reconcileFunding, recoverPosition, refill, refreshPosition, signLpCommandBytes, waitForTopUp, waitForWithdrawalConfirmation, withdrawFees, withdrawPosition };
+export { type CompleteDkgBatchOptions, type CreateLpDkgBatchInput, type CreatePositionArgs, type CreatePositionResult, type FinalizeLpDkgBatchInput, type FundingConfirmationInput, type InitialFundingPlan, LP_COMMAND_REQUEST_TIMEOUT_MS, LP_DKG_ABORT_CLEANUP_TIMEOUT_MS, LP_DKG_ABORT_REQUEST_TIMEOUT_MS, LP_DKG_WORKER_REQUEST_TIMEOUT_MESSAGE, LP_DKG_WORKER_REQUEST_TIMEOUT_MS, LP_FEE_SOURCE_COUNT_UNAVAILABLE_MESSAGE, LP_MISSING_POSITION_CODE_MESSAGE, LP_REDEMPTION_RECONCILING_MESSAGE, type LpActorSyncView, type LpCoordinatorClient, type LpCoordinatorClientOptions, type LpCreationAuthorization, type LpCreationSigner, type LpDkgClient, type LpDkgProgress, type LpEconomicReturnSummary, type LpFeePolicy, type LpInventoryShard, type LpLifecycleClient, type LpLifecycleDkgProgress, type LpLifecycleRuntime, type LpPositionCode, type LpPositionCodeAuth, type LpPositionCreationIntent, type LpPositionRequestOptions, type LpPositionView, type LpRedemptionHistoryView, type LpRedemptionPermission, type LpTopUpRequest, type LpWithdrawalExecutionView, type LpWithdrawalMode, type LpWithdrawalPlanPreview, type LpWithdrawalPlanPreviewArgs, type LpWithdrawalRecord, type OpenLpPositionInput, type RecoverPositionArgs, type RefillArgs, type RefillLpPositionInput, type SourceLiquidityUse, type WaitForTopUpOptions, type WaitForWithdrawalConfirmationOptions, type WithdrawPositionArgs, type WithdrawPositionResult, type WithdrawalConfirmation, type WithdrawalExecution, bytesToHex, completeDkgBatch, confirmPositionCodeSaved, createLpCoordinatorClient, createLpDkgBatch, createLpLifecycleClient, createPosition, defaultLpLifecycleClient, deriveLpPositionCodeAuth, generateLpPositionCode, isLpPositionAuthMissingError, isLpRedemptionReconcilingError, listPositions, mergeLpActorSync, normalizeLpActorSync, normalizeLpPositionCode, prepareInitialFunding, prepareTopUp, previewLpWithdrawalPlan, reconcileFunding, recoverPosition, refill, refreshPosition, signLpCommandBytes, validateLpPositionFeePolicy, waitForTopUp, waitForWithdrawalConfirmation, withdrawFees, withdrawPosition };