@flaunch/sdk 0.3.1 → 0.4.0

package/dist/sdk/FlaunchSDK.d.ts

@@ -1,15 +1,21 @@
 import { Drift, HexString, ReadWriteAdapter, type Address } from "@delvtech/drift";
-import { ReadFlaunchPositionManager, ReadWriteFlaunchPositionManager, WatchPoolCreatedParams, FlaunchParams, FlaunchIPFSParams, WatchPoolSwapParams as WatchPoolSwapParamsPositionManager } from "../clients/FlaunchPositionManagerClient";
+import { ReadFlaunchPositionManager, WatchPoolCreatedParams, WatchPoolSwapParams as WatchPoolSwapParamsPositionManager } from "../clients/FlaunchPositionManagerClient";
 import { ReadPoolManager, PositionInfoParams } from "../clients/PoolManagerClient";
 import { ReadStateView } from "../clients/StateViewClient";
 import { ReadFairLaunch } from "../clients/FairLaunchClient";
 import { ReadBidWall } from "../clients/BidWallClient";
 import { ReadWriteFastFlaunchZap, FastFlaunchParams, FastFlaunchIPFSParams } from "../clients/FastFlaunchClient";
+import { ReadWriteFlaunchZap, FlaunchWithRevenueManagerParams, FlaunchWithRevenueManagerIPFSParams } from "../clients/FlaunchZapClient";
 import { ReadFlaunch } from "../clients/FlaunchClient";
 import { ReadQuoter } from "clients/QuoterClient";
+import { ReadPermit2 } from "clients/Permit2Client";
+import { ReadFlaunchPositionManagerV1_1, ReadWriteFlaunchPositionManagerV1_1, FlaunchParams, FlaunchIPFSParams } from "clients/FlaunchPositionManagerV1_1Client";
+import { ReadBidWallV1_1 } from "clients/BidWallV1_1Client";
+import { ReadFairLaunchV1_1 } from "clients/FairLaunchV1_1Client";
+import { ReadFlaunchV1_1 } from "clients/FlaunchV1_1Client";
+import { ReadWriteTreasuryManagerFactory } from "clients/TreasuryManagerFactoryClient";
 import { CoinMetadata } from "types";
 import { PermitSingle } from "utils/universalRouter";
-import { ReadPermit2 } from "clients/Permit2Client";
 type WatchPoolSwapParams = Omit<WatchPoolSwapParamsPositionManager<boolean>, "flETHIsCurrencyZero"> & {
     filterByCoin?: Address;
 };
@@ -38,33 +44,107 @@ type SellCoinParams = {
     permitSingle?: PermitSingle;
     signature?: HexString;
 };
+/**
+ * Base class for interacting with Flaunch protocol in read-only mode
+ */
 export declare class ReadFlaunchSDK {
     readonly drift: Drift;
     readonly chainId: number;
     readonly TICK_SPACING = 60;
     readonly readPositionManager: ReadFlaunchPositionManager;
+    readonly readPositionManagerV1_1: ReadFlaunchPositionManagerV1_1;
     readonly readPoolManager: ReadPoolManager;
     readonly readStateView: ReadStateView;
     readonly readFairLaunch: ReadFairLaunch;
+    readonly readFairLaunchV1_1: ReadFairLaunchV1_1;
     readonly readBidWall: ReadBidWall;
+    readonly readBidWallV1_1: ReadBidWallV1_1;
     readonly readFlaunch: ReadFlaunch;
+    readonly readFlaunchV1_1: ReadFlaunchV1_1;
     readonly readQuoter: ReadQuoter;
     readonly readPermit2: ReadPermit2;
     constructor(chainId: number, drift?: Drift);
+    /**
+     * Checks if a given coin address is a valid Flaunch coin (either V1 or V1.1)
+     * @param coinAddress - The address of the coin to check
+     * @returns Promise<boolean> - True if the coin is valid, false otherwise
+     */
     isValidCoin(coinAddress: Address): Promise<boolean>;
+    /**
+     * Checks if a given coin address is a V1 Flaunch coin
+     * @param coinAddress - The address of the coin to check
+     * @returns Promise<boolean> - True if the coin is V1, false if V1.1
+     */
+    isV1Coin(coinAddress: Address): Promise<boolean>;
+    /**
+     * Retrieves metadata for a given Flaunch coin
+     * @param coinAddress - The address of the coin
+     * @returns Promise<CoinMetadata & { symbol: string }> - The coin's metadata including name, symbol, description, and social links
+     */
     getCoinMetadata(coinAddress: Address): Promise<CoinMetadata & {
         symbol: string;
     }>;
+    /**
+     * Watches for pool creation events on V1 contracts
+     * @param params - Parameters for watching pool creation
+     * @returns Subscription to pool creation events
+     */
+    watchPoolCreatedV1(params: WatchPoolCreatedParams): Promise<{
+        cleanup: () => void;
+        pollPoolCreatedNow: () => Promise<void>;
+    }>;
+    /**
+     * Watches for pool creation events on V1.1 contracts
+     * @param params - Parameters for watching pool creation
+     * @returns Subscription to pool creation events
+     */
     watchPoolCreated(params: WatchPoolCreatedParams): Promise<{
         cleanup: () => void;
         pollPoolCreatedNow: () => Promise<void>;
     }>;
+    /**
+     * Polls for current pool creation events on V1 contracts
+     * @returns Current pool creation events or undefined if polling is not available
+     */
+    pollPoolCreatedNowV1(): Promise<void>;
+    /**
+     * Polls for current pool creation events on V1.1 contracts
+     * @returns Current pool creation events or undefined if polling is not available
+     */
     pollPoolCreatedNow(): Promise<void>;
+    /**
+     * Watches for pool swap events on V1 contracts
+     * @param params - Parameters for watching pool swaps including optional coin filter
+     * @returns Subscription to pool swap events
+     */
+    watchPoolSwapV1(params: WatchPoolSwapParams): Promise<{
+        cleanup: () => void;
+        pollPoolSwapNow: () => Promise<void>;
+    }>;
+    /**
+     * Watches for pool swap events on V1.1 contracts
+     * @param params - Parameters for watching pool swaps including optional coin filter
+     * @returns Subscription to pool swap events
+     */
     watchPoolSwap(params: WatchPoolSwapParams): Promise<{
         cleanup: () => void;
         pollPoolSwapNow: () => Promise<void>;
     }>;
+    /**
+     * Polls for current pool swap events on V1 contracts
+     * @returns Current pool swap events or undefined if polling is not available
+     */
+    pollPoolSwapNowV1(): Promise<void>;
+    /**
+     * Polls for current pool swap events on V1.1 contracts
+     * @returns Current pool swap events or undefined if polling is not available
+     */
     pollPoolSwapNow(): Promise<void>;
+    /**
+     * Gets information about a liquidity position
+     * @param params - Parameters for querying position info
+     * @returns Position information from the state view contract
+     */
     positionInfo(params: PositionInfoParams): Promise<{
         liquidity: bigint;
         feeGrowthInside0LastX128: bigint;
@@ -74,10 +154,33 @@ export declare class ReadFlaunchSDK {
         feeGrowthInside0LastX128: bigint;
         feeGrowthInside1LastX128: bigint;
     }>;
-    currentTick(coinAddress: Address): Promise<number>;
-    coinPriceInETH(coinAddress: Address): Promise<string>;
+    /**
+     * Gets the current tick for a given coin's pool
+     * @param coinAddress - The address of the coin
+     * @param isV1Coin - Optional flag to specify if coin is V1. If not provided, will be determined automatically
+     * @returns Promise<number> - The current tick of the pool
+     */
+    currentTick(coinAddress: Address, isV1Coin?: boolean): Promise<number>;
+    /**
+     * Calculates the coin price in ETH based on the current tick
+     * @param coinAddress - The address of the coin
+     * @param isV1Coin - Optional flag to specify if coin is V1. If not provided, will be determined automatically
+     * @returns Promise<string> - The price of the coin in ETH with 18 decimals precision
+     */
+    coinPriceInETH(coinAddress: Address, isV1Coin?: boolean): Promise<string>;
+    /**
+     * Gets the current ETH/USDC price
+     * @param drift - Optional drift instance to get price from Base Mainnet
+     * @returns Promise<number> - The current ETH/USDC price
+     */
     getETHUSDCPrice(drift?: Drift): Promise<number>;
-    fairLaunchInfo(coinAddress: Address): Promise<{
+    /**
+     * Gets information about a fair launch for a given coin
+     * @param coinAddress - The address of the coin
+     * @param isV1Coin - Optional flag to specify if coin is V1. If not provided, will be determined automatically
+     * @returns Fair launch information from the appropriate contract version
+     */
+    fairLaunchInfo(coinAddress: Address, isV1Coin?: boolean): Promise<{
         startsAt: bigint;
         endsAt: bigint;
         initialTick: number;
@@ -85,42 +188,179 @@ export declare class ReadFlaunchSDK {
         supply: bigint;
         closed: boolean;
     }>;
-    isFairLaunchActive(coinAddress: Address): Promise<boolean>;
-    fairLaunchDuration(): number;
-    initialTick(coinAddress: Address): Promise<number>;
-    fairLaunchETHOnlyPosition(coinAddress: Address): Promise<{
+    /**
+     * Checks if a fair launch is currently active for a given coin
+     * @param coinAddress - The address of the coin
+     * @param isV1Coin - Optional flag to specify if coin is V1. If not provided, will be determined automatically
+     * @returns Promise<boolean> - True if fair launch is active, false otherwise
+     */
+    isFairLaunchActive(coinAddress: Address, isV1Coin?: boolean): Promise<boolean>;
+    /**
+     * Gets the duration of a fair launch for a given coin
+     * @param coinAddress - The address of the coin
+     * @param isV1Coin - Optional flag to specify if coin is V1. If not provided, will be determined automatically
+     * @returns Promise<number> - The duration in seconds (30 minutes for V1, variable for V1.1)
+     */
+    fairLaunchDuration(coinAddress: Address, isV1Coin?: boolean): Promise<number | bigint>;
+    /**
+     * Gets the initial tick for a fair launch
+     * @param coinAddress - The address of the coin
+     * @param isV1Coin - Optional flag to specify if coin is V1. If not provided, will be determined automatically
+     * @returns Promise<number> - The initial tick value
+     */
+    initialTick(coinAddress: Address, isV1Coin?: boolean): Promise<number>;
+    /**
+     * Gets information about the ETH-only position in a fair launch
+     * @param coinAddress - The address of the coin
+     * @param isV1Coin - Optional flag to specify if coin is V1. If not provided, will be determined automatically
+     * @returns Promise<{flETHAmount: bigint, coinAmount: bigint, tickLower: number, tickUpper: number}> - Position details
+     */
+    fairLaunchETHOnlyPosition(coinAddress: Address, isV1Coin?: boolean): Promise<{
         flETHAmount: bigint;
         coinAmount: bigint;
         tickLower: number;
         tickUpper: number;
     }>;
-    fairLaunchCoinOnlyPosition(coinAddress: Address): Promise<{
+    /**
+     * Gets information about the coin-only position in a fair launch
+     * @param coinAddress - The address of the coin
+     * @param isV1Coin - Optional flag to specify if coin is V1. If not provided, will be determined automatically
+     * @returns Promise<{flETHAmount: bigint, coinAmount: bigint, tickLower: number, tickUpper: number}> - Position details
+     */
+    fairLaunchCoinOnlyPosition(coinAddress: Address, isV1Coin?: boolean): Promise<{
         flETHAmount: bigint;
         coinAmount: bigint;
         tickLower: number;
         tickUpper: number;
     }>;
-    bidWallPosition(coinAddress: Address): Promise<{
+    /**
+     * Gets information about the bid wall position for a coin
+     * @param coinAddress - The address of the coin
+     * @param isV1Coin - Optional flag to specify if coin is V1. If not provided, will be determined automatically
+     * @returns Promise<{flETHAmount: bigint, coinAmount: bigint, pendingEth: bigint, tickLower: number, tickUpper: number}> - Bid wall position details
+     */
+    bidWallPosition(coinAddress: Address, isV1Coin?: boolean): Promise<{
         flETHAmount: bigint;
         coinAmount: bigint;
         pendingEth: bigint;
         tickLower: number;
         tickUpper: number;
     }>;
-    poolId(coinAddress: Address): `0x${string}`;
+    /**
+     * Gets the claimable balance of ETH for the recipient from a revenue manager
+     * @param params - Parameters for checking the balance
+     * @param params.revenueManagerAddress - The address of the revenue manager
+     * @param params.recipient - The address of the recipient to check
+     * @returns Promise<bigint> - The claimable balance of ETH
+     */
+    revenueManagerBalance(params: {
+        revenueManagerAddress: Address;
+        recipient: Address;
+    }): Promise<bigint>;
+    /**
+     * Gets the claimable balance of ETH for the protocol from a revenue manager
+     * @param revenueManagerAddress - The address of the revenue manager
+     * @returns Promise<bigint> - The claimable balance of ETH
+     */
+    revenueManagerProtocolBalance(revenueManagerAddress: Address): Promise<bigint>;
+    /**
+     * Gets the pool ID for a given coin
+     * @param coinAddress - The address of the coin
+     * @param isV1Coin - Optional flag to specify if coin is V1. If not provided, will be determined automatically
+     * @returns Promise<string> - The pool ID
+     */
+    poolId(coinAddress: Address, isV1Coin?: boolean): Promise<`0x${string}`>;
+    /**
+     * Determines if flETH is currency0 in the pool
+     * @param coinAddress - The address of the coin
+     * @returns boolean - True if flETH is currency0, false otherwise
+     */
     flETHIsCurrencyZero(coinAddress: Address): boolean;
 }
 export declare class ReadWriteFlaunchSDK extends ReadFlaunchSDK {
-    readonly readWritePositionManager: ReadWriteFlaunchPositionManager;
+    drift: Drift<ReadWriteAdapter>;
+    readonly readWritePositionManagerV1_1: ReadWriteFlaunchPositionManagerV1_1;
     readonly readWriteFastFlaunchZap: ReadWriteFastFlaunchZap;
+    readonly readWriteFlaunchZap: ReadWriteFlaunchZap;
+    readonly readWriteTreasuryManagerFactory: ReadWriteTreasuryManagerFactory;
     constructor(chainId: number, drift?: Drift<ReadWriteAdapter>);
+    /**
+     * Deploys a new revenue manager
+     * @param params - Parameters for deploying the revenue manager
+     * @param params.protocolRecipient - The address of the protocol recipient
+     * @param params.protocolFeePercent - The percentage of the protocol fee
+     * @returns Address of the deployed revenue manager
+     */
+    deployRevenueManager(params: {
+        protocolRecipient: Address;
+        protocolFeePercent: number;
+    }): Promise<Address>;
+    /**
+     * Creates a new Flaunch on V1.1
+     * @param params - Parameters for creating the Flaunch
+     * @returns Transaction response
+     */
     flaunch(params: FlaunchParams): Promise<`0x${string}`>;
+    /**
+     * Creates a new Flaunch on V1.1 with IPFS metadata
+     * @param params - Parameters for creating the Flaunch with IPFS data
+     * @returns Transaction response
+     */
     flaunchIPFS(params: FlaunchIPFSParams): Promise<`0x${string}`>;
+    /**
+     * Creates a new fast Flaunch on V1.1
+     * @param params - Parameters for creating the fast Flaunch
+     * @throws Error if FastFlaunchZap is not deployed on the current chain
+     * @returns Transaction response
+     */
     fastFlaunch(params: FastFlaunchParams): Promise<`0x${string}`>;
+    /**
+     * Creates a new fast Flaunch on V1.1 with IPFS metadata
+     * @param params - Parameters for creating the fast Flaunch with IPFS data
+     * @throws Error if FastFlaunchZap is not deployed on the current chain
+     * @returns Transaction response
+     */
     fastFlaunchIPFS(params: FastFlaunchIPFSParams): Promise<`0x${string}`>;
+    /**
+     * Creates a new Flaunch with revenue manager configuration
+     * @param params - Parameters for creating the Flaunch with revenue manager
+     * @throws Error if FlaunchZap is not deployed on the current chain
+     * @returns Transaction response
+     */
+    flaunchWithRevenueManager(params: FlaunchWithRevenueManagerParams): Promise<`0x${string}`>;
+    /**
+     * Creates a new Flaunch with revenue manager configuration and IPFS metadata
+     * @param params - Parameters for creating the Flaunch with revenue manager and IPFS data
+     * @throws Error if FlaunchZap is not deployed on the current chain
+     * @returns Transaction response
+     */
+    flaunchIPFSWithRevenueManager(params: FlaunchWithRevenueManagerIPFSParams): Promise<`0x${string}`>;
+    /**
+     * Gets the balance of a specific coin for the connected wallet
+     * @param coinAddress - The address of the coin to check
+     * @returns Promise<bigint> - The balance of the coin
+     */
     coinBalance(coinAddress: Address): Promise<bigint>;
-    buyCoin(params: BuyCoinParams): Promise<`0x${string}`>;
-    sellCoin(params: SellCoinParams): Promise<`0x${string}`>;
+    /**
+     * Buys a coin with ETH
+     * @param params - Parameters for buying the coin including amount, slippage, and referrer
+     * @param isV1Coin - Optional flag to specify if coin is V1. If not provided, will be determined automatically
+     * @returns Transaction response for the buy operation
+     */
+    buyCoin(params: BuyCoinParams, isV1Coin?: boolean): Promise<`0x${string}`>;
+    /**
+     * Sells a coin for ETH
+     * @param params - Parameters for selling the coin including amount, slippage, permit data, and referrer
+     * @param isV1Coin - Optional flag to specify if coin is V1. If not provided, will be determined automatically
+     * @returns Transaction response for the sell operation
+     */
+    sellCoin(params: SellCoinParams, isV1Coin?: boolean): Promise<`0x${string}`>;
+    /**
+     * Gets the typed data for a Permit2 signature
+     * @param coinAddress - The address of the coin to permit
+     * @param deadline - Optional deadline for the permit (defaults to 10 years)
+     * @returns The typed data object for signing
+     */
     getPermit2TypedData(coinAddress: Address, deadline?: bigint): Promise<{
         typedData: {
             primaryType: string;
@@ -134,10 +374,43 @@ export declare class ReadWriteFlaunchSDK extends ReadFlaunchSDK {
         };
         permitSingle: PermitSingle;
     }>;
+    /**
+     * Gets the current Permit2 allowance and nonce for a coin
+     * @param coinAddress - The address of the coin to check
+     * @returns Promise<{allowance: bigint, nonce: bigint}> - Current allowance and nonce
+     */
     getPermit2AllowanceAndNonce(coinAddress: Address): Promise<{
         allowance: bigint;
         nonce: number;
     }>;
+    /**
+     * Claims the protocol's share of the revenue
+     * @param params - Parameters for claiming the protocol's share of the revenue
+     * @returns Transaction response
+     */
+    revenueManagerProtocolClaim(params: {
+        revenueManagerAddress: Address;
+    }): Promise<`0x${string}`>;
+    /**
+     * Claims the total creator's share of the revenue from a revenue manager
+     * @param params - Parameters for claiming the creator's share of the revenue
+     * @returns Transaction response
+     */
+    revenueManagerCreatorClaim(params: {
+        revenueManagerAddress: Address;
+    }): Promise<`0x${string}`>;
+    /**
+     * Claims the creator's share of the revenue from specific flaunch tokens
+     * @param params - Parameters for claiming the creator's share of the revenue
+     * @returns Transaction response
+     */
+    revenueManagerCreatorClaimForTokens(params: {
+        revenueManagerAddress: Address;
+        flaunchTokens: {
+            flaunch: Address;
+            tokenId: bigint;
+        }[];
+    }): Promise<`0x${string}`>;
 }
 export {};
 //# sourceMappingURL=FlaunchSDK.d.ts.map

package/dist/sdk/FlaunchSDK.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FlaunchSDK.d.ts","sourceRoot":"","sources":["../../src/sdk/FlaunchSDK.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,EACL,SAAS,EACT,gBAAgB,EAChB,KAAK,OAAO,EACb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,0BAA0B,EAC1B,+BAA+B,EAC/B,sBAAsB,EACtB,aAAa,EACb,iBAAiB,EACjB,mBAAmB,IAAI,kCAAkC,EAC1D,MAAM,yCAAyC,CAAC;AACjD,OAAO,EACL,eAAe,EACf,kBAAkB,EACnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EACL,uBAAuB,EACvB,iBAAiB,EACjB,qBAAqB,EACtB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAsBlD,OAAO,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAGrC,OAAO,EAIL,YAAY,EAEb,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAGpD,KAAK,mBAAmB,GAAG,IAAI,CAC7B,kCAAkC,CAAC,OAAO,CAAC,EAC3C,qBAAqB,CACtB,GAAG;IACF,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,KAAK,WAAW,GAAG;IACjB,WAAW,EAAE,OAAO,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,KAAK,oBAAoB,GAAG,WAAW,GAAG;IACxC,QAAQ,EAAE,UAAU,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,KAAK,qBAAqB,GAAG,WAAW,GAAG;IACzC,QAAQ,EAAE,WAAW,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,KAAK,aAAa,GAAG,oBAAoB,GAAG,qBAAqB,CAAC;AAElE,KAAK,cAAc,GAAG;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF,qBAAa,cAAc;IACzB,SAAgB,KAAK,EAAE,KAAK,CAAC;IAC7B,SAAgB,OAAO,EAAE,MAAM,CAAC;IAChC,SAAgB,YAAY,MAAgB;IAC5C,SAAgB,mBAAmB,EAAE,0BAA0B,CAAC;IAChE,SAAgB,eAAe,EAAE,eAAe,CAAC;IACjD,SAAgB,aAAa,EAAE,aAAa,CAAC;IAC7C,SAAgB,cAAc,EAAE,cAAc,CAAC;IAC/C,SAAgB,WAAW,EAAE,WAAW,CAAC;IACzC,SAAgB,WAAW,EAAE,WAAW,CAAC;IACzC,SAAgB,UAAU,EAAE,UAAU,CAAC;IACvC,SAAgB,WAAW,EAAE,WAAW,CAAC;gBAE7B,OAAO,EAAE,MAAM,EAAE,KAAK,GAAE,KAAqB;IA6BzD,WAAW,CAAC,WAAW,EAAE,OAAO;IAI1B,eAAe,CACnB,WAAW,EAAE,OAAO,GACnB,OAAO,CAAC,YAAY,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAsB7C,gBAAgB,CAAC,MAAM,EAAE,sBAAsB;;;;IAI/C,kBAAkB;IASlB,aAAa,CAAC,MAAM,EAAE,mBAAmB;;;;IAUzC,eAAe;IASf,YAAY,CAAC,MAAM,EAAE,kBAAkB;;;;;;;;;IAIjC,WAAW,CAAC,WAAW,EAAE,OAAO;IAOhC,cAAc,CAAC,WAAW,EAAE,OAAO;IAiBnC,eAAe,CAAC,KAAK,CAAC,EAAE,KAAK;IAU7B,cAAc,CAAC,WAAW,EAAE,OAAO;;;;;;;;IAKzC,kBAAkB,CAAC,WAAW,EAAE,OAAO;IAKvC,kBAAkB;IAIZ,WAAW,CAAC,WAAW,EAAE,OAAO;IAOhC,yBAAyB,CAAC,WAAW,EAAE,OAAO;;;;;;IAoD9C,0BAA0B,CAAC,WAAW,EAAE,OAAO;;;;;;IAoD/C,eAAe,CAAC,WAAW,EAAE,OAAO;;;;;;;IA0B1C,MAAM,CAAC,WAAW,EAAE,OAAO;IAY3B,mBAAmB,CAAC,WAAW,EAAE,OAAO;CAGzC;AAED,qBAAa,mBAAoB,SAAQ,cAAc;IACrD,SAAgB,wBAAwB,EAAE,+BAA+B,CAAC;IAC1E,SAAgB,uBAAuB,EAAE,uBAAuB,CAAC;gBAErD,OAAO,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,gBAAgB,CAAiB;IAY3E,OAAO,CAAC,MAAM,EAAE,aAAa;IAI7B,WAAW,CAAC,MAAM,EAAE,iBAAiB;IAIrC,WAAW,CAAC,MAAM,EAAE,iBAAiB;IAUrC,eAAe,CAAC,MAAM,EAAE,qBAAqB;IAUvC,WAAW,CAAC,WAAW,EAAE,OAAO;IAOhC,OAAO,CAAC,MAAM,EAAE,aAAa;IAgE7B,QAAQ,CAAC,MAAM,EAAE,cAAc;IAyC/B,mBAAmB,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM;;;;;;;;;;;;;IAgB3D,2BAA2B,CAAC,WAAW,EAAE,OAAO;;;;CAYvD"}
+{"version":3,"file":"FlaunchSDK.d.ts","sourceRoot":"","sources":["../../src/sdk/FlaunchSDK.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,EACL,SAAS,EACT,gBAAgB,EAChB,KAAK,OAAO,EACb,MAAM,iBAAiB,CAAC;AA+BzB,OAAO,EACL,0BAA0B,EAC1B,sBAAsB,EACtB,mBAAmB,IAAI,kCAAkC,EAC1D,MAAM,yCAAyC,CAAC;AACjD,OAAO,EACL,eAAe,EACf,kBAAkB,EACnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EACL,uBAAuB,EACvB,iBAAiB,EACjB,qBAAqB,EACtB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,mBAAmB,EACnB,+BAA+B,EAC/B,mCAAmC,EACpC,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EACL,8BAA8B,EAC9B,mCAAmC,EACnC,aAAa,EACb,iBAAiB,EAClB,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,+BAA+B,EAAE,MAAM,sCAAsC,CAAC;AAMvF,OAAO,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AASrC,OAAO,EAIL,YAAY,EAEb,MAAM,uBAAuB,CAAC;AAK/B,KAAK,mBAAmB,GAAG,IAAI,CAC7B,kCAAkC,CAAC,OAAO,CAAC,EAC3C,qBAAqB,CACtB,GAAG;IACF,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,KAAK,WAAW,GAAG;IACjB,WAAW,EAAE,OAAO,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,KAAK,oBAAoB,GAAG,WAAW,GAAG;IACxC,QAAQ,EAAE,UAAU,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,KAAK,qBAAqB,GAAG,WAAW,GAAG;IACzC,QAAQ,EAAE,WAAW,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,KAAK,aAAa,GAAG,oBAAoB,GAAG,qBAAqB,CAAC;AAElE,KAAK,cAAc,GAAG;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,qBAAa,cAAc;IACzB,SAAgB,KAAK,EAAE,KAAK,CAAC;IAC7B,SAAgB,OAAO,EAAE,MAAM,CAAC;IAChC,SAAgB,YAAY,MAAgB;IAC5C,SAAgB,mBAAmB,EAAE,0BAA0B,CAAC;IAChE,SAAgB,uBAAuB,EAAE,8BAA8B,CAAC;IACxE,SAAgB,eAAe,EAAE,eAAe,CAAC;IACjD,SAAgB,aAAa,EAAE,aAAa,CAAC;IAC7C,SAAgB,cAAc,EAAE,cAAc,CAAC;IAC/C,SAAgB,kBAAkB,EAAE,kBAAkB,CAAC;IACvD,SAAgB,WAAW,EAAE,WAAW,CAAC;IACzC,SAAgB,eAAe,EAAE,eAAe,CAAC;IACjD,SAAgB,WAAW,EAAE,WAAW,CAAC;IACzC,SAAgB,eAAe,EAAE,eAAe,CAAC;IACjD,SAAgB,UAAU,EAAE,UAAU,CAAC;IACvC,SAAgB,WAAW,EAAE,WAAW,CAAC;gBAE7B,OAAO,EAAE,MAAM,EAAE,KAAK,GAAE,KAAqB;IA6CzD;;;;OAIG;IACG,WAAW,CAAC,WAAW,EAAE,OAAO;IAOtC;;;;OAIG;IACG,QAAQ,CAAC,WAAW,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAItD;;;;OAIG;IACG,eAAe,CACnB,WAAW,EAAE,OAAO,GACnB,OAAO,CAAC,YAAY,GAAG;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAsB7C;;;;OAIG;IACH,kBAAkB,CAAC,MAAM,EAAE,sBAAsB;;;;IAIjD;;;;OAIG;IACH,gBAAgB,CAAC,MAAM,EAAE,sBAAsB;;;;IAI/C;;;OAGG;IACH,oBAAoB;IASpB;;;OAGG;IACH,kBAAkB;IASlB;;;;OAIG;IACG,eAAe,CAAC,MAAM,EAAE,mBAAmB;;;;IAUjD;;;;OAIG;IACG,aAAa,CAAC,MAAM,EAAE,mBAAmB;;;;IAU/C;;;OAGG;IACH,iBAAiB;IASjB;;;OAGG;IACH,eAAe;IASf;;;;OAIG;IACH,YAAY,CAAC,MAAM,EAAE,kBAAkB;;;;;;;;;IAIvC;;;;;OAKG;IACG,WAAW,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO;IAU1D;;;;;OAKG;IACG,cAAc,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO;IAmB7D;;;;OAIG;IACG,eAAe,CAAC,KAAK,CAAC,EAAE,KAAK;IAUnC;;;;;OAKG;IACG,cAAc,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO;;;;;;;;IAU7D;;;;;OAKG;IACG,kBAAkB,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO;IAUjE;;;;;OAKG;IACG,kBAAkB,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO;IAYjE;;;;;OAKG;IACG,WAAW,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO;IAY1D;;;;;OAKG;IACG,yBAAyB,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO;;;;;;IAyDxE;;;;;OAKG;IACG,0BAA0B,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO;;;;;;IAyDzE;;;;;OAKG;IACG,eAAe,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO;;;;;;;IA+B9D;;;;;;OAMG;IACH,qBAAqB,CAAC,MAAM,EAAE;QAC5B,qBAAqB,EAAE,OAAO,CAAC;QAC/B,SAAS,EAAE,OAAO,CAAC;KACpB;IAQD;;;;OAIG;IACG,6BAA6B,CAAC,qBAAqB,EAAE,OAAO;IASlE;;;;;OAKG;IACG,MAAM,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO;IAiBrD;;;;OAIG;IACH,mBAAmB,CAAC,WAAW,EAAE,OAAO;CAGzC;AAED,qBAAa,mBAAoB,SAAQ,cAAc;IAC7C,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACvC,SAAgB,4BAA4B,EAAE,mCAAmC,CAAC;IAClF,SAAgB,uBAAuB,EAAE,uBAAuB,CAAC;IACjE,SAAgB,mBAAmB,EAAE,mBAAmB,CAAC;IACzD,SAAgB,+BAA+B,EAAE,+BAA+B,CAAC;gBAErE,OAAO,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,gBAAgB,CAAiB;IAsB3E;;;;;;OAMG;IACG,oBAAoB,CAAC,MAAM,EAAE;QACjC,iBAAiB,EAAE,OAAO,CAAC;QAC3B,kBAAkB,EAAE,MAAM,CAAC;KAC5B,GAAG,OAAO,CAAC,OAAO,CAAC;IA+BpB;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,aAAa;IAI7B;;;;OAIG;IACH,WAAW,CAAC,MAAM,EAAE,iBAAiB;IAIrC;;;;;OAKG;IACH,WAAW,CAAC,MAAM,EAAE,iBAAiB;IAUrC;;;;;OAKG;IACH,eAAe,CAAC,MAAM,EAAE,qBAAqB;IAU7C;;;;;OAKG;IACH,yBAAyB,CAAC,MAAM,EAAE,+BAA+B;IAQjE;;;;;OAKG;IACG,6BAA6B,CACjC,MAAM,EAAE,mCAAmC;IAS7C;;;;OAIG;IACG,WAAW,CAAC,WAAW,EAAE,OAAO;IAOtC;;;;;OAKG;IACG,OAAO,CAAC,MAAM,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,OAAO;IAsEvD;;;;;OAKG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc,EAAE,QAAQ,CAAC,EAAE,OAAO;IA8CzD;;;;;OAKG;IACG,mBAAmB,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM;;;;;;;;;;;;;IAgBjE;;;;OAIG;IACG,2BAA2B,CAAC,WAAW,EAAE,OAAO;;;;IAatD;;;;OAIG;IACH,2BAA2B,CAAC,MAAM,EAAE;QAAE,qBAAqB,EAAE,OAAO,CAAA;KAAE;IAQtE;;;;OAIG;IACH,0BAA0B,CAAC,MAAM,EAAE;QAAE,qBAAqB,EAAE,OAAO,CAAA;KAAE;IAQrE;;;;OAIG;IACH,mCAAmC,CAAC,MAAM,EAAE;QAC1C,qBAAqB,EAAE,OAAO,CAAC;QAC/B,aAAa,EAAE;YAAE,OAAO,EAAE,OAAO,CAAC;YAAC,OAAO,EAAE,MAAM,CAAA;SAAE,EAAE,CAAC;KACxD;CAOF"}

package/dist/utils/universalRouter.d.ts

@@ -21,6 +21,7 @@ export declare const ethToMemecoin: (params: {
     amountOutMin?: bigint;
     amountOut?: bigint;
     amountInMax?: bigint;
+    isV1Coin?: boolean;
 }) => {
     calldata: `0x${string}`;
     commands: `0x${string}`;
@@ -34,6 +35,7 @@ export declare const memecoinToEthWithPermit2: (params: {
     permitSingle: PermitSingle | undefined;
     signature: Hex | undefined;
     referrer: Address | null;
+    isV1Coin?: boolean;
 }) => {
     calldata: `0x${string}`;
     commands: `0x${string}`;

package/dist/utils/universalRouter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"universalRouter.d.ts","sourceRoot":"","sources":["../../src/utils/universalRouter.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAGP,GAAG,EAMJ,MAAM,MAAM,CAAC;AAUd,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,aAAa,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AA2DF,eAAO,MAAM,qBAAqB,GAChC,QAAQ,MAAM,GAAG,SAAS,EAC1B,UAAU,MAAM,EAChB,UAAU,UAAU,GAAG,WAAW,WAanC,CAAC;AAIF,eAAO,MAAM,aAAa,GAAI,QAAQ;IACpC,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,UAAU,GAAG,WAAW,CAAC;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;;;;CAsKA,CAAC;AAIF,eAAO,MAAM,wBAAwB,GAAI,QAAQ;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,YAAY,GAAG,SAAS,CAAC;IACvC,SAAS,EAAE,GAAG,GAAG,SAAS,CAAC;IAC3B,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;CAC1B;;;;CAuIA,CAAC;AAEF,eAAO,MAAM,cAAc;;;GAK1B,CAAC;AAEF,eAAO,MAAM,YAAY;;;;;;;;;CAOxB,CAAC;AAEF,eAAO,MAAM,mBAAmB,GAAI,4CAKjC;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,KAAG;IACF,SAAS,EAAE;QACT,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE;YACN,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;YAChB,iBAAiB,EAAE,OAAO,CAAC;SAC5B,CAAC;QACF,KAAK,EAAE,OAAO,YAAY,CAAC;QAC3B,OAAO,EAAE,YAAY,CAAC;KACvB,CAAC;IACF,YAAY,EAAE,YAAY,CAAC;CA8B5B,CAAC"}
+{"version":3,"file":"universalRouter.d.ts","sourceRoot":"","sources":["../../src/utils/universalRouter.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAGP,GAAG,EAMJ,MAAM,MAAM,CAAC;AAWd,MAAM,MAAM,aAAa,GAAG;IAC1B,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,aAAa,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AA2DF,eAAO,MAAM,qBAAqB,GAChC,QAAQ,MAAM,GAAG,SAAS,EAC1B,UAAU,MAAM,EAChB,UAAU,UAAU,GAAG,WAAW,WAanC,CAAC;AAIF,eAAO,MAAM,aAAa,GAAI,QAAQ;IACpC,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,UAAU,GAAG,WAAW,CAAC;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;;;;CAwKA,CAAC;AAIF,eAAO,MAAM,wBAAwB,GAAI,QAAQ;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,YAAY,GAAG,SAAS,CAAC;IACvC,SAAS,EAAE,GAAG,GAAG,SAAS,CAAC;IAC3B,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;IACzB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;;;;CAyIA,CAAC;AAEF,eAAO,MAAM,cAAc;;;GAK1B,CAAC;AAEF,eAAO,MAAM,YAAY;;;;;;;;;CAOxB,CAAC;AAEF,eAAO,MAAM,mBAAmB,GAAI,4CAKjC;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,KAAG;IACF,SAAS,EAAE;QACT,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE;YACN,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;YAChB,iBAAiB,EAAE,OAAO,CAAC;SAC5B,CAAC;QACF,KAAK,EAAE,OAAO,YAAY,CAAC;QAC3B,OAAO,EAAE,YAAY,CAAC;KACvB,CAAC;IACF,YAAY,EAAE,YAAY,CAAC;CA8B5B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flaunch/sdk",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Flaunch SDK to easily interact with the Flaunch protocol",
   "license": "MIT",
   "author": "Apoorv Lathey <apoorv@flayer.io>",
@@ -57,6 +57,7 @@
   "files": [
     "dist"
   ],
+  "packageManager": "pnpm@8.15.4",
   "devDependencies": {
     "@rollup/plugin-commonjs": "^22.0.0",
     "@rollup/plugin-json": "^4.1.0",
@@ -67,7 +68,9 @@
     "rimraf": "^6.0.1",
     "rollup": "^2.75.6",
     "tslib": "^2.4.0",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "typedoc": "^0.25.12",
+    "typedoc-plugin-markdown": "^3.17.1"
   },
   "dependencies": {
     "@uniswap/v3-sdk": "^3.24.1",
@@ -83,6 +86,8 @@
     "dev": "rollup -c -w",
     "clean": "rimraf dist",
     "prebuild": "npm run clean",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "docs:generate": "typedoc --plugin typedoc-plugin-markdown --out docs src/index.ts --excludeExternals --exclude '**/abi/**' --includeVersion",
+    "docs:llms": "node scripts/generate-llms-doc.js"
   }
 }