@sun-protocol/sun-sdk-protocols 0.1.0-beta.0

package/dist/positions/index.d.ts

@@ -0,0 +1,159 @@
+import { S as SlippageInput, C as ContractOverrides, P as ProtocolsContext, T as TransactionPlan, a as TransactionPlanExecutionResult, b as TransactionPlanExecutor } from '../common-8VQQ0FSU.js';
+export { A as ApprovalMode } from '../common-8VQQ0FSU.js';
+import { BigintIsh, Percent, ContractCallAction } from '@sun-protocol/sun-sdk-core';
+import { V4PoolKey } from '@sun-protocol/sun-sdk-sunswap-v4';
+import { a as LiquidityPlanOptions, e as V3PoolStateInput, k as V4ExecutionOptions } from '../types-BfrouFmO.js';
+import '@sun-protocol/sun-sdk-api';
+import '@sun-protocol/sun-sdk-chains';
+import '@sun-protocol/sun-sdk-runtime';
+
+type PositionLiquidityInput = {
+    readonly liquidity: BigintIsh;
+    readonly percentage?: never;
+} | {
+    readonly liquidity?: never;
+    readonly percentage: SlippageInput | Percent;
+};
+interface PositionActionOptions extends LiquidityPlanOptions {
+    readonly tokenId: BigintIsh;
+    readonly receiveNative?: boolean;
+    /** Keep strict SDK guards by default; legacy defers authorization/stale-state failures to the contract. */
+    readonly validationMode?: 'strict' | 'legacy';
+}
+type PositionRemoveInput = PositionActionOptions & PositionLiquidityInput;
+type PositionCollectInput = PositionActionOptions;
+interface V3PositionSnapshot {
+    readonly protocol: 'sunswap-v3';
+    readonly tokenId: string;
+    readonly owner: string;
+    readonly approved?: string;
+    readonly operatorApproved?: boolean;
+    readonly token0: string;
+    readonly token1: string;
+    readonly fee: number;
+    readonly tickLower: number;
+    readonly tickUpper: number;
+    readonly liquidity: string;
+    readonly tokensOwed0: string;
+    readonly tokensOwed1: string;
+}
+interface V3PositionReadInput {
+    readonly tokenId: BigintIsh;
+    readonly operator?: string;
+    readonly contracts?: ContractOverrides;
+}
+type V3PositionRemoveInput = PositionActionOptions & PositionLiquidityInput & {
+    readonly pool?: V3PoolStateInput;
+    readonly receiveNative?: boolean;
+    readonly burnToken?: boolean;
+    readonly expectedCurrencyOwed0?: BigintIsh;
+    readonly expectedCurrencyOwed1?: BigintIsh;
+};
+interface V3PositionCollectInput extends PositionActionOptions {
+    readonly receiveNative?: boolean;
+    readonly expectedCurrencyOwed0?: BigintIsh;
+    readonly expectedCurrencyOwed1?: BigintIsh;
+}
+interface V4PositionSnapshot {
+    readonly protocol: 'sunswap-v4';
+    readonly tokenId: string;
+    readonly owner: string;
+    readonly approved?: string;
+    readonly operatorApproved?: boolean;
+    readonly poolKey?: V4PoolKey;
+    readonly tickLower?: number;
+    readonly tickUpper?: number;
+    readonly liquidity: string;
+}
+interface V4PositionReadInput {
+    readonly tokenId: BigintIsh;
+    readonly operator?: string;
+    readonly contracts?: ContractOverrides;
+}
+interface V4PositionFeesSnapshot {
+    readonly protocol: 'sunswap-v4';
+    readonly tokenId: string;
+    readonly feesOwed0: string;
+    readonly feesOwed1: string;
+}
+type V4PositionRemoveInput = PositionActionOptions & PositionLiquidityInput & V4ExecutionOptions & {
+    readonly poolKey?: V4PoolKey;
+    readonly amount0Min?: BigintIsh;
+    readonly amount1Min?: BigintIsh;
+    /** Optional stale-state guard that must equal the latest on-chain position liquidity. */
+    readonly currentLiquidity?: BigintIsh;
+    readonly hookData?: string;
+    readonly settlementMode?: 'take-pair' | 'close-currency';
+};
+interface V4PositionCollectInput extends PositionActionOptions, V4ExecutionOptions {
+    readonly poolKey?: V4PoolKey;
+    readonly hookData?: string;
+    readonly settlementMode?: 'take-pair' | 'close-currency';
+}
+
+declare class V3PositionsClient {
+    private readonly context;
+    constructor(context: ProtocolsContext);
+    read(input: V3PositionReadInput): Promise<V3PositionSnapshot>;
+    readonly remove: {
+        plan: (input: V3PositionRemoveInput) => Promise<TransactionPlan>;
+        execute: (input: V3PositionRemoveInput) => Promise<TransactionPlanExecutionResult>;
+    };
+    readonly collect: {
+        plan: (input: V3PositionCollectInput) => Promise<TransactionPlan>;
+        execute: (input: V3PositionCollectInput) => Promise<TransactionPlanExecutionResult>;
+    };
+    private usdtTransferContext;
+    private readAuthorizedPosition;
+    private planRemove;
+    private planCollect;
+}
+
+type OptionalV4PoolKey<T> = T extends unknown ? Omit<T, 'poolKey'> & {
+    readonly poolKey?: V4PoolKey;
+} : never;
+type V4PositionRemovePlanInput = OptionalV4PoolKey<V4PositionRemoveInput>;
+type V4PositionCollectPlanInput = OptionalV4PoolKey<V4PositionCollectInput>;
+declare class V4PositionsClient {
+    private readonly context;
+    constructor(context: ProtocolsContext);
+    read(input: V4PositionReadInput): Promise<V4PositionSnapshot>;
+    fees(input: V4PositionReadInput): Promise<V4PositionFeesSnapshot>;
+    readonly remove: {
+        plan: (input: V4PositionRemovePlanInput) => Promise<TransactionPlan>;
+        execute: (input: V4PositionRemovePlanInput) => Promise<TransactionPlanExecutionResult>;
+    };
+    readonly collect: {
+        plan: (input: V4PositionCollectPlanInput) => Promise<TransactionPlan>;
+        execute: (input: V4PositionCollectPlanInput) => Promise<TransactionPlanExecutionResult>;
+    };
+    private readAuthorizedPosition;
+    private planRemove;
+    private planCollect;
+}
+
+declare class PositionsClient {
+    readonly v3: {
+        readonly read: V3PositionsClient['read'];
+        readonly remove: V3PositionsClient['remove'];
+        readonly collect: V3PositionsClient['collect'];
+    };
+    readonly v4: {
+        readonly read: V4PositionsClient['read'];
+        readonly fees: V4PositionsClient['fees'];
+        readonly remove: V4PositionsClient['remove'];
+        readonly collect: V4PositionsClient['collect'];
+    };
+    constructor(context: ProtocolsContext);
+}
+declare function createPositionsClient(context: ProtocolsContext): PositionsClient;
+
+declare const SUNSWAP_V3_POSITION_PROTOCOL_ID = "sunswap-v3";
+declare const SUNSWAP_V4_POSITION_PROTOCOL_ID = "sunswap-v4";
+
+/** Check an SDK-built V3 remove/collect action immediately before its final send. */
+declare function assertV3PositionUsdtTransfer(context: ProtocolsContext, action: ContractCallAction): Promise<void>;
+/** Use this executor for V3 position plans, including staged execution and retries. */
+declare function createV3PositionsExecutor(context: ProtocolsContext): TransactionPlanExecutor;
+
+export { type PositionActionOptions, type PositionCollectInput, type PositionLiquidityInput, type PositionRemoveInput, PositionsClient, SUNSWAP_V3_POSITION_PROTOCOL_ID, SUNSWAP_V4_POSITION_PROTOCOL_ID, TransactionPlan, type V3PositionCollectInput, type V3PositionReadInput, type V3PositionRemoveInput, type V3PositionSnapshot, V3PositionsClient, type V4PositionCollectInput, type V4PositionFeesSnapshot, type V4PositionReadInput, type V4PositionRemoveInput, type V4PositionSnapshot, V4PositionsClient, assertV3PositionUsdtTransfer, createPositionsClient, createV3PositionsExecutor };

package/dist/positions/index.js

@@ -0,0 +1,25 @@
+import {
+  PositionsClient,
+  SUNSWAP_V3_POSITION_PROTOCOL_ID,
+  SUNSWAP_V4_POSITION_PROTOCOL_ID,
+  V3PositionsClient,
+  V4PositionsClient,
+  assertV3PositionUsdtTransfer,
+  createPositionsClient,
+  createV3PositionsExecutor
+} from "../chunk-PEGREDLT.js";
+import "../chunk-L5TZCDPH.js";
+import "../chunk-5XDX5563.js";
+import "../chunk-C2YCVBPI.js";
+import "../chunk-VFVKMC4H.js";
+export {
+  PositionsClient,
+  SUNSWAP_V3_POSITION_PROTOCOL_ID,
+  SUNSWAP_V4_POSITION_PROTOCOL_ID,
+  V3PositionsClient,
+  V4PositionsClient,
+  assertV3PositionUsdtTransfer,
+  createPositionsClient,
+  createV3PositionsExecutor
+};
+//# sourceMappingURL=index.js.map

package/dist/positions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}