@sun-protocol/sun-sdk-sunswap-v4 0.1.0-beta.0

package/dist/index.d.ts

@@ -0,0 +1,327 @@
+import { TronAddress, Network, BigintIsh, TokenRequirement, ContractCallAction, ContractParameter } from '@sun-protocol/sun-sdk-core';
+
+declare function tronAddressToEvmHex(address: TronAddress | string): `0x${string}`;
+
+type V4PoolParameters = string & {
+    readonly __v4PoolParameters: unique symbol;
+};
+type V4PoolId = string & {
+    readonly __v4PoolId: unique symbol;
+};
+interface V4HooksRegistration {
+    readonly beforeInitialize?: boolean;
+    readonly afterInitialize?: boolean;
+    readonly beforeAddLiquidity?: boolean;
+    readonly afterAddLiquidity?: boolean;
+    readonly beforeRemoveLiquidity?: boolean;
+    readonly afterRemoveLiquidity?: boolean;
+    readonly beforeSwap?: boolean;
+    readonly afterSwap?: boolean;
+    readonly beforeDonate?: boolean;
+    readonly afterDonate?: boolean;
+    readonly beforeSwapReturnsDelta?: boolean;
+    readonly afterSwapReturnsDelta?: boolean;
+    readonly afterAddLiquidityReturnsDelta?: boolean;
+    readonly afterRemoveLiquidityReturnsDelta?: boolean;
+}
+interface V4PoolParameterConfig {
+    readonly tickSpacing: number;
+    readonly hooksRegistration?: V4HooksRegistration;
+}
+interface V4PoolKey {
+    readonly network: Network;
+    readonly currency0: TronAddress;
+    readonly currency1: TronAddress;
+    readonly hooks: TronAddress;
+    readonly fee: number;
+    readonly parameters: V4PoolParameters;
+}
+interface V4PoolState {
+    readonly poolKey: V4PoolKey;
+    readonly sqrtPriceX96: BigintIsh;
+    readonly tick: number;
+    readonly liquidity: BigintIsh;
+}
+interface V4TickRange {
+    readonly tickLower: number;
+    readonly tickUpper: number;
+}
+interface V4PositionKey extends V4TickRange {
+    readonly poolKey: V4PoolKey;
+    readonly salt?: string;
+}
+interface V4Position extends V4PositionKey {
+    readonly tokenId?: BigintIsh;
+    readonly liquidity: BigintIsh;
+    readonly tokensOwed0?: BigintIsh;
+    readonly tokensOwed1?: BigintIsh;
+}
+
+declare const V4_ACTIONS: {
+    readonly CL_INCREASE_LIQUIDITY: 0;
+    readonly CL_DECREASE_LIQUIDITY: 1;
+    readonly CL_MINT_POSITION: 2;
+    readonly SETTLE: 11;
+    readonly SETTLE_PAIR: 13;
+    readonly TAKE_PAIR: 17;
+    readonly CLOSE_CURRENCY: 18;
+    readonly SWEEP: 20;
+};
+declare const V4_ACTION_CONSTANTS: {
+    readonly OPEN_DELTA: 0n;
+    readonly MSG_SENDER: "0x0000000000000000000000000000000000000001";
+    readonly ADDRESS_THIS: "0x0000000000000000000000000000000000000002";
+};
+type V4Action = (typeof V4_ACTIONS)[keyof typeof V4_ACTIONS];
+type V4BigintIsh = BigintIsh | bigint;
+interface V4PositionConfig {
+    readonly poolKey: V4PoolKey;
+    readonly tickLower: number;
+    readonly tickUpper: number;
+}
+interface V4PlannerPlan {
+    readonly action: V4Action;
+    readonly params: readonly V4PlannerParam[];
+}
+type V4PlannerParam = V4PositionConfig | TronAddress | `0x${string}` | V4BigintIsh | number | boolean;
+interface EncodeV4MintPositionPayloadParams {
+    readonly positionConfig: V4PositionConfig;
+    readonly liquidity: V4BigintIsh;
+    readonly amount0Max: V4BigintIsh;
+    readonly amount1Max: V4BigintIsh;
+    readonly owner: TronAddress;
+    readonly sweepRecipient?: TronAddress;
+    readonly hookData?: string;
+}
+interface EncodeV4IncreaseLiquidityPayloadParams {
+    readonly poolKey: V4PoolKey;
+    readonly tokenId: V4BigintIsh;
+    readonly liquidity: V4BigintIsh;
+    readonly amount0Max: V4BigintIsh;
+    readonly amount1Max: V4BigintIsh;
+    readonly sweepRecipient?: TronAddress;
+    readonly hookData?: string;
+}
+interface EncodeV4DecreaseLiquidityPayloadParams {
+    readonly poolKey: V4PoolKey;
+    readonly tokenId: V4BigintIsh;
+    readonly liquidity: V4BigintIsh;
+    readonly amount0Min: V4BigintIsh;
+    readonly amount1Min: V4BigintIsh;
+    readonly recipient: TronAddress;
+    readonly hookData?: string;
+    readonly settlementMode?: 'take-pair' | 'close-currency';
+}
+interface EncodeV4CollectPayloadParams {
+    readonly poolKey: V4PoolKey;
+    readonly recipient: TronAddress;
+}
+declare function encodeV4Actions(plans: readonly V4PlannerPlan[]): `0x${string}`;
+declare function encodeV4ActionParams(plans: readonly V4PlannerPlan[]): readonly `0x${string}`[];
+declare function encodeV4ActionsPlanner(plans: readonly V4PlannerPlan[]): `0x${string}`;
+declare function encodeV4MintPositionPlannerPayload(params: EncodeV4MintPositionPayloadParams): `0x${string}`;
+declare function encodeV4IncreaseLiquidityPlannerPayload(params: EncodeV4IncreaseLiquidityPayloadParams): `0x${string}`;
+declare function encodeV4DecreaseLiquidityPlannerPayload(params: EncodeV4DecreaseLiquidityPayloadParams): `0x${string}`;
+declare function encodeV4CollectPlannerPayload(params: EncodeV4CollectPayloadParams): `0x${string}`;
+
+declare const V4_POSITION_MANAGER_SELECTORS: {
+    readonly initializePool: "initializePool((address,address,address,uint24,bytes32),uint160)";
+    readonly modifyLiquidities: "modifyLiquidities(bytes,uint256)";
+    readonly multicall: "multicall(bytes[])";
+};
+interface V4ActionOptions {
+    readonly network: Network;
+    readonly positionManager?: TronAddress;
+    readonly feeLimit?: number;
+    readonly callValue?: bigint;
+    readonly id?: string;
+    readonly metadata?: Record<string, unknown>;
+    readonly tokenRequirements?: readonly TokenRequirement[];
+}
+interface BuildV4InitializePoolActionParams extends V4ActionOptions {
+    readonly poolKey: V4PoolKey;
+    readonly sqrtPriceX96: BigintIsh;
+}
+interface BuildV4ModifyLiquiditiesActionParams extends V4ActionOptions {
+    readonly payload: string;
+    readonly deadline: V4BigintIsh;
+}
+interface BuildV4MulticallActionParams extends V4ActionOptions {
+    readonly calls: readonly string[];
+}
+/** A signed Permit2 allowance to be forwarded by the V4 PositionManager multicall. */
+interface V4Permit2Signature {
+    readonly details: {
+        readonly token: TronAddress | string;
+        readonly amount: BigintIsh;
+        readonly expiration: BigintIsh;
+        readonly nonce: BigintIsh;
+    };
+    readonly spender: TronAddress | string;
+    readonly sigDeadline: BigintIsh;
+    readonly signature: string;
+}
+interface BuildV4MintPositionActionParams extends V4ActionOptions {
+    readonly positionConfig: V4PositionConfig;
+    readonly liquidity: V4BigintIsh;
+    readonly amount0Max: V4BigintIsh;
+    readonly amount1Max: V4BigintIsh;
+    readonly owner: TronAddress;
+    readonly deadline: V4BigintIsh;
+    readonly sweepRecipient?: TronAddress;
+    readonly hookData?: string;
+}
+interface BuildV4IncreaseLiquidityActionParams extends V4ActionOptions {
+    readonly poolKey: V4PoolKey;
+    readonly tokenId: V4BigintIsh;
+    readonly liquidity: V4BigintIsh;
+    readonly amount0Max: V4BigintIsh;
+    readonly amount1Max: V4BigintIsh;
+    readonly deadline: V4BigintIsh;
+    readonly sweepRecipient?: TronAddress;
+    readonly hookData?: string;
+}
+interface BuildV4DecreaseLiquidityActionParams extends V4ActionOptions {
+    readonly poolKey: V4PoolKey;
+    readonly tokenId: V4BigintIsh;
+    readonly liquidity: V4BigintIsh;
+    readonly amount0Min: V4BigintIsh;
+    readonly amount1Min: V4BigintIsh;
+    readonly recipient: TronAddress;
+    readonly deadline: V4BigintIsh;
+    readonly hookData?: string;
+    readonly settlementMode?: 'take-pair' | 'close-currency';
+}
+interface BuildV4CollectActionParams extends V4ActionOptions {
+    readonly poolKey: V4PoolKey;
+    readonly tokenId: V4BigintIsh;
+    readonly recipient: TronAddress;
+    readonly deadline: V4BigintIsh;
+    readonly hookData?: string;
+    readonly settlementMode?: 'take-pair' | 'close-currency';
+}
+type V4TokenRequirement = TokenRequirement;
+/**
+ * Encodes the PositionManager's Permit2Forward.permit call for use as one item
+ * in PositionManager.multicall(bytes[]). This matches the legacy V4 add flow:
+ * typed-data signing happens off-chain, then the signed permit is forwarded in
+ * the final liquidity transaction.
+ */
+declare function encodeV4Permit2ForwardCall(input: {
+    readonly owner: TronAddress | string;
+    readonly permit: V4Permit2Signature;
+}): `0x${string}`;
+/** Encodes the two V4 position-manager actions that may be nested in multicall(bytes[]). */
+declare function encodeV4ContractCallAction(action: ContractCallAction): `0x${string}`;
+declare function buildV4InitializePoolAction(params: BuildV4InitializePoolActionParams): ContractCallAction;
+declare function buildV4ModifyLiquiditiesAction(params: BuildV4ModifyLiquiditiesActionParams): ContractCallAction;
+declare function buildV4MulticallAction(params: BuildV4MulticallActionParams): ContractCallAction;
+declare function buildV4MintPositionAction(params: BuildV4MintPositionActionParams): ContractCallAction;
+declare function buildV4IncreaseLiquidityAction(params: BuildV4IncreaseLiquidityActionParams): ContractCallAction;
+declare function buildV4DecreaseLiquidityAction(params: BuildV4DecreaseLiquidityActionParams): ContractCallAction;
+declare function buildV4CollectAction(params: BuildV4CollectActionParams): ContractCallAction;
+
+declare const V4_HOOKS_REGISTRATION_OFFSET: Record<keyof V4HooksRegistration, number>;
+declare function encodeV4HooksRegistration(hooksRegistration?: V4HooksRegistration): number;
+declare function decodeV4HooksRegistration(registration: number): V4HooksRegistration;
+declare function encodeV4PoolParameters(params: V4PoolParameterConfig): V4PoolParameters;
+declare function decodeV4PoolParameters(encoded: V4PoolParameters | string): V4PoolParameterConfig;
+
+declare function encodeV4PoolKey(poolKey: V4PoolKey): `0x${string}`;
+declare function computeV4PoolId(poolKey: V4PoolKey): V4PoolId;
+
+declare const V4_DYNAMIC_FEE_FLAG = 8388608;
+declare const V4_UINT24_MAX = 16777215;
+declare const V4_MAX_STATIC_FEE = 1000000;
+declare const V4_EMPTY_PARAMETERS: V4PoolParameters;
+interface CreateV4PoolKeyInput {
+    readonly network: Network;
+    readonly currencyA: TronAddress | string;
+    readonly currencyB: TronAddress | string;
+    readonly hooks?: TronAddress | string;
+    readonly fee: number;
+    readonly parameters?: V4PoolParameters | string;
+}
+declare function isV4DynamicFee(fee: number): boolean;
+declare function getV4StaticFee(fee: number): number;
+declare function assertV4PoolParameters(value: string, label?: string): V4PoolParameters;
+declare function assertV4PoolId(value: string, label?: string): V4PoolId;
+declare function assertV4Fee(fee: number): number;
+declare function assertV4HookFeeCombination(hooks: TronAddress, fee: number): void;
+declare function normalizeV4PoolKey(input: V4PoolKey): V4PoolKey;
+declare function createV4PoolKey(input: CreateV4PoolKeyInput): V4PoolKey;
+declare function toV4PoolKeyTuple(poolKey: V4PoolKey): ContractParameter;
+
+interface V4ContractReadSpec {
+    readonly target: TronAddress;
+    readonly functionSelector: string;
+    readonly parameters?: readonly ContractParameter[];
+    readonly abiFunction?: V4ReadAbiFunction;
+    readonly metadata?: Record<string, unknown>;
+}
+interface V4ReadAbiParameter {
+    readonly name?: string;
+    readonly type: string;
+    readonly components?: readonly V4ReadAbiParameter[];
+}
+interface V4ReadAbiFunction {
+    readonly type: 'function';
+    readonly name: string;
+    readonly stateMutability: 'view';
+    readonly inputs: readonly V4ReadAbiParameter[];
+    readonly outputs: readonly V4ReadAbiParameter[];
+}
+declare const V4_POSITION_MANAGER_READ_SELECTORS: {
+    readonly ownerOf: "ownerOf(uint256)";
+    readonly getApproved: "getApproved(uint256)";
+    readonly isApprovedForAll: "isApprovedForAll(address,address)";
+    readonly getPoolAndPositionInfo: "getPoolAndPositionInfo(uint256)";
+    readonly getPositionLiquidity: "getPositionLiquidity(uint256)";
+};
+declare const V4_POOL_MANAGER_READ_SELECTORS: {
+    readonly getSlot0: "getSlot0(bytes32)";
+    readonly getLiquidity: "getLiquidity(bytes32)";
+    readonly poolIdToPoolKey: "poolIdToPoolKey(bytes32)";
+    readonly getFeeGrowthGlobals: "getFeeGrowthGlobals(bytes32)";
+};
+interface V4ReadOptions {
+    readonly network: Network;
+    readonly positionManager?: TronAddress;
+    readonly poolManager?: TronAddress;
+}
+interface BuildV4PositionReadParams extends V4ReadOptions {
+    readonly tokenId: BigintIsh;
+}
+interface BuildV4PoolReadParams extends V4ReadOptions {
+    readonly poolId: V4PoolId | string;
+}
+interface BuildV4PositionFeesReadParams extends V4ReadOptions {
+    readonly tokenId: BigintIsh;
+    readonly poolId: V4PoolId | string;
+    readonly tickLower: number;
+    readonly tickUpper: number;
+    readonly lpFeeHelper?: TronAddress;
+}
+interface BuildV4PositionApprovalReadParams extends V4ReadOptions {
+    readonly owner: TronAddress;
+    readonly operator: TronAddress;
+}
+interface BuildV4HookRegistrationBitmapReadParams {
+    readonly network: Network;
+    readonly hooks: TronAddress;
+}
+declare function buildV4PoolSlot0Read(params: BuildV4PoolReadParams): V4ContractReadSpec;
+declare function buildV4PoolLiquidityRead(params: BuildV4PoolReadParams): V4ContractReadSpec;
+declare function buildV4PoolKeyRead(params: BuildV4PoolReadParams): V4ContractReadSpec;
+declare function buildV4PoolFeeGrowthGlobalsRead(params: BuildV4PoolReadParams): V4ContractReadSpec;
+declare function buildV4HookRegistrationBitmapRead(params: BuildV4HookRegistrationBitmapReadParams): V4ContractReadSpec;
+declare function buildV4PoolStateReads(params: BuildV4PoolReadParams): readonly V4ContractReadSpec[];
+declare function buildV4PositionOwnerRead(params: BuildV4PositionReadParams): V4ContractReadSpec;
+declare function buildV4PositionApprovedRead(params: BuildV4PositionReadParams): V4ContractReadSpec;
+declare function buildV4PoolAndPositionInfoRead(params: BuildV4PositionReadParams): V4ContractReadSpec;
+declare function buildV4PositionLiquidityRead(params: BuildV4PositionReadParams): V4ContractReadSpec;
+declare function buildV4PositionApprovalForAllRead(params: BuildV4PositionApprovalReadParams): V4ContractReadSpec;
+declare function buildV4PositionFeesRead(params: BuildV4PositionFeesReadParams): V4ContractReadSpec;
+declare function buildV4PositionReads(params: BuildV4PositionReadParams): readonly V4ContractReadSpec[];
+
+export { type BuildV4CollectActionParams, type BuildV4DecreaseLiquidityActionParams, type BuildV4HookRegistrationBitmapReadParams, type BuildV4IncreaseLiquidityActionParams, type BuildV4InitializePoolActionParams, type BuildV4MintPositionActionParams, type BuildV4ModifyLiquiditiesActionParams, type BuildV4MulticallActionParams, type BuildV4PoolReadParams, type BuildV4PositionApprovalReadParams, type BuildV4PositionFeesReadParams, type BuildV4PositionReadParams, type CreateV4PoolKeyInput, type EncodeV4CollectPayloadParams, type EncodeV4DecreaseLiquidityPayloadParams, type EncodeV4IncreaseLiquidityPayloadParams, type EncodeV4MintPositionPayloadParams, type V4Action, type V4ActionOptions, type V4BigintIsh, type V4ContractReadSpec, type V4HooksRegistration, type V4Permit2Signature, type V4PlannerParam, type V4PlannerPlan, type V4PoolId, type V4PoolKey, type V4PoolParameterConfig, type V4PoolParameters, type V4PoolState, type V4Position, type V4PositionConfig, type V4PositionKey, type V4ReadOptions, type V4TickRange, type V4TokenRequirement, V4_ACTIONS, V4_ACTION_CONSTANTS, V4_DYNAMIC_FEE_FLAG, V4_EMPTY_PARAMETERS, V4_HOOKS_REGISTRATION_OFFSET, V4_MAX_STATIC_FEE, V4_POOL_MANAGER_READ_SELECTORS, V4_POSITION_MANAGER_READ_SELECTORS, V4_POSITION_MANAGER_SELECTORS, V4_UINT24_MAX, assertV4Fee, assertV4HookFeeCombination, assertV4PoolId, assertV4PoolParameters, buildV4CollectAction, buildV4DecreaseLiquidityAction, buildV4HookRegistrationBitmapRead, buildV4IncreaseLiquidityAction, buildV4InitializePoolAction, buildV4MintPositionAction, buildV4ModifyLiquiditiesAction, buildV4MulticallAction, buildV4PoolAndPositionInfoRead, buildV4PoolFeeGrowthGlobalsRead, buildV4PoolKeyRead, buildV4PoolLiquidityRead, buildV4PoolSlot0Read, buildV4PoolStateReads, buildV4PositionApprovalForAllRead, buildV4PositionApprovedRead, buildV4PositionFeesRead, buildV4PositionLiquidityRead, buildV4PositionOwnerRead, buildV4PositionReads, computeV4PoolId, createV4PoolKey, decodeV4HooksRegistration, decodeV4PoolParameters, encodeV4ActionParams, encodeV4Actions, encodeV4ActionsPlanner, encodeV4CollectPlannerPayload, encodeV4ContractCallAction, encodeV4DecreaseLiquidityPlannerPayload, encodeV4HooksRegistration, encodeV4IncreaseLiquidityPlannerPayload, encodeV4MintPositionPlannerPayload, encodeV4Permit2ForwardCall, encodeV4PoolKey, encodeV4PoolParameters, getV4StaticFee, isV4DynamicFee, normalizeV4PoolKey, toV4PoolKeyTuple, tronAddressToEvmHex };