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

package/dist/types-BTPdCC7k.d.cts

@@ -0,0 +1,160 @@
+import { BigintIsh, Percent, TronAddress } from '@sun-protocol/sun-sdk-core';
+import { V4PoolId, V4PoolKey, V4Permit2Signature } from '@sun-protocol/sun-sdk-sunswap-v4';
+import { S as SlippageInput, C as ContractOverrides, A as ApprovalMode } from './common-8VQQ0FSU.cjs';
+
+interface LiquidityPlanOptions {
+    readonly contracts?: ContractOverrides;
+    readonly recipient?: string;
+    readonly slippage?: SlippageInput;
+    readonly approval?: ApprovalMode;
+    readonly ttlSeconds?: number;
+    readonly deadline?: BigintIsh;
+    readonly feeLimit?: number;
+}
+interface V4ExecutionOptions {
+    /** Wrap position-manager calls in multicall(bytes[]), matching the legacy SUN.io path. */
+    readonly transactionMode?: 'direct' | 'multicall';
+    /** Use the user-entered native amount instead of the slippage-adjusted maximum as callValue. */
+    readonly nativeCallValueMode?: 'maximum' | 'desired';
+    /** Select directional floor/ceil or legacy ROUND_HALF_UP amount bounds. */
+    readonly roundingMode?: 'directional' | 'half-up';
+    /** Trust the caller's createPool state instead of rechecking slot0 immediately before planning. */
+    readonly poolInitializationMode?: 'verify-on-chain' | 'trust-input';
+}
+type V4LiquidityPlanOptions = Omit<LiquidityPlanOptions, 'recipient'> & V4ExecutionOptions;
+type LiquidityAmountInput = {
+    readonly liquidity: BigintIsh;
+    readonly percentage?: never;
+} | {
+    readonly liquidity?: never;
+    readonly percentage: SlippageInput | Percent;
+};
+interface V2AddLiquidityInput extends LiquidityPlanOptions {
+    readonly tokenA: string;
+    readonly tokenB: string;
+    readonly amountADesired: BigintIsh;
+    readonly amountBDesired: BigintIsh;
+    readonly amountAMin?: BigintIsh;
+    readonly amountBMin?: BigintIsh;
+}
+type V2RemoveLiquidityInput = LiquidityPlanOptions & {
+    readonly tokenA: string;
+    readonly tokenB: string;
+} & LiquidityAmountInput;
+interface V4PoolSnapshot {
+    readonly protocol: 'sunswap-v4';
+    readonly poolId: string;
+    readonly sqrtPriceX96: string;
+    readonly tick: number;
+    readonly liquidity: string;
+}
+interface V4PoolReadInput {
+    readonly poolId: V4PoolId | string;
+    readonly contracts?: ContractOverrides;
+}
+interface V4PoolKeyCompatInput {
+    readonly poolKey?: never;
+    readonly token0: string;
+    readonly token1: string;
+    readonly fee: number;
+    readonly tickSpacing: number;
+    readonly hooks?: TronAddress | string;
+    /** Set the V4 dynamic-fee flag (0x800000) instead of the static fee value. */
+    readonly dynamicFee?: boolean;
+    /** Optional known hook registration bitmap. When omitted, non-zero hooks are queried on-chain. */
+    readonly hooksRegistration?: number;
+}
+interface V4ExplicitPoolKeyInput {
+    readonly poolKey: V4PoolKey;
+    readonly token0?: never;
+    readonly token1?: never;
+    readonly fee?: never;
+    readonly tickSpacing?: never;
+    readonly hooks?: never;
+    readonly dynamicFee?: never;
+    readonly hooksRegistration?: never;
+}
+type V4PoolKeyInput = V4ExplicitPoolKeyInput | V4PoolKeyCompatInput;
+interface V4ResolvedLiquidityAmounts {
+    readonly liquidity: BigintIsh;
+    readonly amount0Max: BigintIsh;
+    readonly amount1Max: BigintIsh;
+    readonly amount0?: never;
+    readonly amount1?: never;
+}
+interface V4AmountCompatInput {
+    readonly liquidity?: never;
+    readonly amount0Max?: never;
+    readonly amount1Max?: never;
+    readonly amount0?: BigintIsh;
+    readonly amount1?: BigintIsh;
+}
+interface V4PositionDerivedPoolInput {
+    readonly poolKey?: never;
+    readonly token0?: never;
+    readonly token1?: never;
+    readonly fee?: never;
+    readonly tickSpacing?: never;
+    readonly hooks?: never;
+    readonly dynamicFee?: never;
+    readonly hooksRegistration?: never;
+}
+type V4InitializePoolInput = LiquidityPlanOptions & V4PoolKeyInput & {
+    readonly sqrtPriceX96: BigintIsh;
+};
+type V4MintPositionInput = V4LiquidityPlanOptions & V4PoolKeyInput & {
+    readonly tickLower: number;
+    readonly tickUpper: number;
+    readonly sqrtPriceX96?: BigintIsh;
+    readonly createPool?: boolean;
+    /** NFT owner. Defaults to the execution wallet. */
+    readonly owner?: TronAddress | string;
+    /** Native-currency refund recipient. Defaults to owner. */
+    readonly sweepRecipient?: TronAddress | string;
+    readonly hookData?: string;
+    /** Signed Permit2 allowances forwarded through the final PositionManager multicall. */
+    readonly permit2Signatures?: readonly V4Permit2Signature[];
+} & (V4ResolvedLiquidityAmounts | V4AmountCompatInput);
+type V4IncreaseLiquidityInput = V4LiquidityPlanOptions & {
+    readonly tokenId: BigintIsh;
+    /** Native-currency refund recipient. Defaults to the execution wallet. */
+    readonly sweepRecipient?: TronAddress | string;
+    readonly hookData?: string;
+    /** Signed Permit2 allowances forwarded through the final PositionManager multicall. */
+    readonly permit2Signatures?: readonly V4Permit2Signature[];
+} & ((V4PoolKeyInput & V4ResolvedLiquidityAmounts) | (V4PoolKeyInput & V4AmountCompatInput) | (V4PositionDerivedPoolInput & V4AmountCompatInput));
+interface V3PoolStateInput {
+    readonly sqrtRatioX96: BigintIsh;
+    readonly liquidity: BigintIsh;
+    readonly tickCurrent: number;
+    readonly tickSpacing?: number;
+}
+interface V3AddLiquidityInput extends LiquidityPlanOptions {
+    readonly tokenA: string;
+    readonly tokenB: string;
+    readonly fee: number;
+    readonly pool?: V3PoolStateInput;
+    readonly tickLower?: number;
+    readonly tickUpper?: number;
+    readonly tickRangeWidth?: number;
+    readonly amount0?: BigintIsh;
+    readonly amount1?: BigintIsh;
+    readonly amount0Min?: BigintIsh;
+    readonly amount1Min?: BigintIsh;
+    readonly createPool?: boolean;
+    readonly useFullPrecision?: boolean;
+}
+interface V3IncreaseLiquidityInput extends Omit<LiquidityPlanOptions, 'recipient'> {
+    readonly tokenA?: string;
+    readonly tokenB?: string;
+    readonly fee?: number;
+    readonly pool?: V3PoolStateInput;
+    readonly tokenId: BigintIsh;
+    readonly tickLower?: number;
+    readonly tickUpper?: number;
+    readonly amount0?: BigintIsh;
+    readonly amount1?: BigintIsh;
+    readonly useFullPrecision?: boolean;
+}
+
+export type { LiquidityAmountInput as L, V2AddLiquidityInput as V, LiquidityPlanOptions as a, V2RemoveLiquidityInput as b, V3AddLiquidityInput as c, V3IncreaseLiquidityInput as d, V3PoolStateInput as e, V4IncreaseLiquidityInput as f, V4InitializePoolInput as g, V4MintPositionInput as h, V4PoolReadInput as i, V4PoolSnapshot as j, V4ExecutionOptions as k };

package/dist/types-BfrouFmO.d.ts

@@ -0,0 +1,160 @@
+import { BigintIsh, Percent, TronAddress } from '@sun-protocol/sun-sdk-core';
+import { V4PoolId, V4PoolKey, V4Permit2Signature } from '@sun-protocol/sun-sdk-sunswap-v4';
+import { S as SlippageInput, C as ContractOverrides, A as ApprovalMode } from './common-8VQQ0FSU.js';
+
+interface LiquidityPlanOptions {
+    readonly contracts?: ContractOverrides;
+    readonly recipient?: string;
+    readonly slippage?: SlippageInput;
+    readonly approval?: ApprovalMode;
+    readonly ttlSeconds?: number;
+    readonly deadline?: BigintIsh;
+    readonly feeLimit?: number;
+}
+interface V4ExecutionOptions {
+    /** Wrap position-manager calls in multicall(bytes[]), matching the legacy SUN.io path. */
+    readonly transactionMode?: 'direct' | 'multicall';
+    /** Use the user-entered native amount instead of the slippage-adjusted maximum as callValue. */
+    readonly nativeCallValueMode?: 'maximum' | 'desired';
+    /** Select directional floor/ceil or legacy ROUND_HALF_UP amount bounds. */
+    readonly roundingMode?: 'directional' | 'half-up';
+    /** Trust the caller's createPool state instead of rechecking slot0 immediately before planning. */
+    readonly poolInitializationMode?: 'verify-on-chain' | 'trust-input';
+}
+type V4LiquidityPlanOptions = Omit<LiquidityPlanOptions, 'recipient'> & V4ExecutionOptions;
+type LiquidityAmountInput = {
+    readonly liquidity: BigintIsh;
+    readonly percentage?: never;
+} | {
+    readonly liquidity?: never;
+    readonly percentage: SlippageInput | Percent;
+};
+interface V2AddLiquidityInput extends LiquidityPlanOptions {
+    readonly tokenA: string;
+    readonly tokenB: string;
+    readonly amountADesired: BigintIsh;
+    readonly amountBDesired: BigintIsh;
+    readonly amountAMin?: BigintIsh;
+    readonly amountBMin?: BigintIsh;
+}
+type V2RemoveLiquidityInput = LiquidityPlanOptions & {
+    readonly tokenA: string;
+    readonly tokenB: string;
+} & LiquidityAmountInput;
+interface V4PoolSnapshot {
+    readonly protocol: 'sunswap-v4';
+    readonly poolId: string;
+    readonly sqrtPriceX96: string;
+    readonly tick: number;
+    readonly liquidity: string;
+}
+interface V4PoolReadInput {
+    readonly poolId: V4PoolId | string;
+    readonly contracts?: ContractOverrides;
+}
+interface V4PoolKeyCompatInput {
+    readonly poolKey?: never;
+    readonly token0: string;
+    readonly token1: string;
+    readonly fee: number;
+    readonly tickSpacing: number;
+    readonly hooks?: TronAddress | string;
+    /** Set the V4 dynamic-fee flag (0x800000) instead of the static fee value. */
+    readonly dynamicFee?: boolean;
+    /** Optional known hook registration bitmap. When omitted, non-zero hooks are queried on-chain. */
+    readonly hooksRegistration?: number;
+}
+interface V4ExplicitPoolKeyInput {
+    readonly poolKey: V4PoolKey;
+    readonly token0?: never;
+    readonly token1?: never;
+    readonly fee?: never;
+    readonly tickSpacing?: never;
+    readonly hooks?: never;
+    readonly dynamicFee?: never;
+    readonly hooksRegistration?: never;
+}
+type V4PoolKeyInput = V4ExplicitPoolKeyInput | V4PoolKeyCompatInput;
+interface V4ResolvedLiquidityAmounts {
+    readonly liquidity: BigintIsh;
+    readonly amount0Max: BigintIsh;
+    readonly amount1Max: BigintIsh;
+    readonly amount0?: never;
+    readonly amount1?: never;
+}
+interface V4AmountCompatInput {
+    readonly liquidity?: never;
+    readonly amount0Max?: never;
+    readonly amount1Max?: never;
+    readonly amount0?: BigintIsh;
+    readonly amount1?: BigintIsh;
+}
+interface V4PositionDerivedPoolInput {
+    readonly poolKey?: never;
+    readonly token0?: never;
+    readonly token1?: never;
+    readonly fee?: never;
+    readonly tickSpacing?: never;
+    readonly hooks?: never;
+    readonly dynamicFee?: never;
+    readonly hooksRegistration?: never;
+}
+type V4InitializePoolInput = LiquidityPlanOptions & V4PoolKeyInput & {
+    readonly sqrtPriceX96: BigintIsh;
+};
+type V4MintPositionInput = V4LiquidityPlanOptions & V4PoolKeyInput & {
+    readonly tickLower: number;
+    readonly tickUpper: number;
+    readonly sqrtPriceX96?: BigintIsh;
+    readonly createPool?: boolean;
+    /** NFT owner. Defaults to the execution wallet. */
+    readonly owner?: TronAddress | string;
+    /** Native-currency refund recipient. Defaults to owner. */
+    readonly sweepRecipient?: TronAddress | string;
+    readonly hookData?: string;
+    /** Signed Permit2 allowances forwarded through the final PositionManager multicall. */
+    readonly permit2Signatures?: readonly V4Permit2Signature[];
+} & (V4ResolvedLiquidityAmounts | V4AmountCompatInput);
+type V4IncreaseLiquidityInput = V4LiquidityPlanOptions & {
+    readonly tokenId: BigintIsh;
+    /** Native-currency refund recipient. Defaults to the execution wallet. */
+    readonly sweepRecipient?: TronAddress | string;
+    readonly hookData?: string;
+    /** Signed Permit2 allowances forwarded through the final PositionManager multicall. */
+    readonly permit2Signatures?: readonly V4Permit2Signature[];
+} & ((V4PoolKeyInput & V4ResolvedLiquidityAmounts) | (V4PoolKeyInput & V4AmountCompatInput) | (V4PositionDerivedPoolInput & V4AmountCompatInput));
+interface V3PoolStateInput {
+    readonly sqrtRatioX96: BigintIsh;
+    readonly liquidity: BigintIsh;
+    readonly tickCurrent: number;
+    readonly tickSpacing?: number;
+}
+interface V3AddLiquidityInput extends LiquidityPlanOptions {
+    readonly tokenA: string;
+    readonly tokenB: string;
+    readonly fee: number;
+    readonly pool?: V3PoolStateInput;
+    readonly tickLower?: number;
+    readonly tickUpper?: number;
+    readonly tickRangeWidth?: number;
+    readonly amount0?: BigintIsh;
+    readonly amount1?: BigintIsh;
+    readonly amount0Min?: BigintIsh;
+    readonly amount1Min?: BigintIsh;
+    readonly createPool?: boolean;
+    readonly useFullPrecision?: boolean;
+}
+interface V3IncreaseLiquidityInput extends Omit<LiquidityPlanOptions, 'recipient'> {
+    readonly tokenA?: string;
+    readonly tokenB?: string;
+    readonly fee?: number;
+    readonly pool?: V3PoolStateInput;
+    readonly tokenId: BigintIsh;
+    readonly tickLower?: number;
+    readonly tickUpper?: number;
+    readonly amount0?: BigintIsh;
+    readonly amount1?: BigintIsh;
+    readonly useFullPrecision?: boolean;
+}
+
+export type { LiquidityAmountInput as L, V2AddLiquidityInput as V, LiquidityPlanOptions as a, V2RemoveLiquidityInput as b, V3AddLiquidityInput as c, V3IncreaseLiquidityInput as d, V3PoolStateInput as e, V4IncreaseLiquidityInput as f, V4InitializePoolInput as g, V4MintPositionInput as h, V4PoolReadInput as i, V4PoolSnapshot as j, V4ExecutionOptions as k };

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@sun-protocol/sun-sdk-protocols",
+  "version": "0.1.0-beta.0",
+  "description": "High-level SUN SDK workflows for swaps, liquidity, positions, PSM, and SunPump.",
+  "keywords": [
+    "sun",
+    "tron",
+    "defi",
+    "swap",
+    "typescript"
+  ],
+  "homepage": "https://github.com/sun-protocol/sun-sdk#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sun-protocol/sun-sdk.git",
+    "directory": "packages/protocols"
+  },
+  "private": false,
+  "type": "module",
+  "engines": {
+    "node": ">=20"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "swap": [
+        "./dist/swap/index.d.ts"
+      ],
+      "liquidity": [
+        "./dist/liquidity/index.d.ts"
+      ],
+      "positions": [
+        "./dist/positions/index.d.ts"
+      ],
+      "pump": [
+        "./dist/pump/index.d.ts"
+      ],
+      "*": [
+        "./dist/index.d.ts"
+      ]
+    }
+  },
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./swap": {
+      "types": "./dist/swap/index.d.ts",
+      "import": "./dist/swap/index.js",
+      "require": "./dist/swap/index.cjs"
+    },
+    "./liquidity": {
+      "types": "./dist/liquidity/index.d.ts",
+      "import": "./dist/liquidity/index.js",
+      "require": "./dist/liquidity/index.cjs"
+    },
+    "./positions": {
+      "types": "./dist/positions/index.d.ts",
+      "import": "./dist/positions/index.js",
+      "require": "./dist/positions/index.cjs"
+    },
+    "./pump": {
+      "types": "./dist/pump/index.d.ts",
+      "import": "./dist/pump/index.js",
+      "require": "./dist/pump/index.cjs"
+    }
+  },
+  "dependencies": {
+    "@sun-protocol/permit2-sdk": "^1.0.0",
+    "@sun-protocol/universal-router-sdk": "^1.1.1",
+    "@sun-protocol/sun-sdk-chains": "0.1.0-beta.0",
+    "@sun-protocol/sun-sdk-launchpad": "0.1.0-beta.0",
+    "@sun-protocol/sun-sdk-core": "0.1.0-beta.0",
+    "@sun-protocol/sun-sdk-runtime": "0.1.0-beta.0",
+    "@sun-protocol/sun-sdk-api": "0.1.0-beta.0",
+    "@sun-protocol/sun-sdk-sunswap-v2": "0.1.0-beta.0",
+    "@sun-protocol/sun-sdk-sunswap-v3": "0.1.0-beta.0",
+    "@sun-protocol/sun-sdk-sunswap-v4": "0.1.0-beta.0",
+    "@sun-protocol/sun-sdk-psm": "0.1.0-beta.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts src/swap/index.ts src/liquidity/index.ts src/positions/index.ts src/pump/index.ts --format esm,cjs --dts --sourcemap --clean --tsconfig ../../tsconfig.base.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run"
+  }
+}