@flaunch/sdk 0.3.1 → 0.4.0

package/dist/clients/QuoterClient.d.ts

@@ -1,13 +1,49 @@
 import { type ReadContract, type Address, type Drift } from "@delvtech/drift";
 import { QuoterAbi } from "../abi/Quoter";
 export type QuoterABI = typeof QuoterAbi;
+/**
+ * Client for interacting with the Quoter contract to get price quotes for swaps
+ * Provides methods to simulate trades and get expected output amounts
+ */
 export declare class ReadQuoter {
     chainId: number;
     readonly contract: ReadContract<QuoterABI>;
+    /**
+     * Creates a new ReadQuoter instance
+     * @param chainId - The chain ID where the Quoter contract is deployed
+     * @param address - The address of the Quoter contract
+     * @param drift - Optional drift instance for contract interactions (creates new instance if not provided)
+     * @throws Error if address is not provided
+     */
     constructor(chainId: number, address: Address, drift?: Drift);
-    getSellQuoteExactInput(coinAddress: Address, amountIn: bigint): Promise<bigint>;
-    getBuyQuoteExactInput(coinAddress: Address, ethIn: bigint): Promise<bigint>;
-    getBuyQuoteExactOutput(coinAddress: Address, coinOut: bigint): Promise<bigint>;
+    /**
+     * Gets a quote for selling an exact amount of tokens for ETH
+     * @param coinAddress - The address of the token to sell
+     * @param amountIn - The exact amount of tokens to sell
+     * @param isV1Coin - Optional flag to specify if token is V1. If not provided, V1.1 is assumed
+     * @returns Promise<bigint> - The expected amount of ETH to receive
+     */
+    getSellQuoteExactInput(coinAddress: Address, amountIn: bigint, isV1Coin?: boolean): Promise<bigint>;
+    /**
+     * Gets a quote for buying tokens with an exact amount of ETH
+     * @param coinAddress - The address of the token to buy
+     * @param ethIn - The exact amount of ETH to spend
+     * @param isV1Coin - Optional flag to specify if token is V1. If not provided, V1.1 is assumed
+     * @returns Promise<bigint> - The expected amount of tokens to receive
+     */
+    getBuyQuoteExactInput(coinAddress: Address, ethIn: bigint, isV1Coin?: boolean): Promise<bigint>;
+    /**
+     * Gets a quote for buying an exact amount of tokens with ETH
+     * @param coinAddress - The address of the token to buy
+     * @param coinOut - The exact amount of tokens to receive
+     * @param isV1Coin - Optional flag to specify if token is V1. If not provided, V1.1 is assumed
+     * @returns Promise<bigint> - The required amount of ETH to spend
+     */
+    getBuyQuoteExactOutput(coinAddress: Address, coinOut: bigint, isV1Coin?: boolean): Promise<bigint>;
+    /**
+     * Gets the current ETH/USDC price from the pool
+     * @returns Promise<number> - The price of 1 ETH in USDC, formatted with 2 decimal places
+     */
     getETHUSDCPrice(): Promise<number>;
 }
 //# sourceMappingURL=QuoterClient.d.ts.map

package/dist/clients/QuoterClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"QuoterClient.d.ts","sourceRoot":"","sources":["../../src/clients/QuoterClient.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,OAAO,EACZ,KAAK,KAAK,EAMX,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAU1C,MAAM,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC;AAEzC,qBAAa,UAAU;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAgB,QAAQ,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;gBAEtC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,GAAE,KAAqB;IAYrE,sBAAsB,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM;IA2B7D,qBAAqB,CAAC,WAAW,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM;IA2BzD,sBAAsB,CAAC,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM;IA2B5D,eAAe;CAqBtB"}
+{"version":3,"file":"QuoterClient.d.ts","sourceRoot":"","sources":["../../src/clients/QuoterClient.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,OAAO,EACZ,KAAK,KAAK,EAMX,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAU1C,MAAM,MAAM,SAAS,GAAG,OAAO,SAAS,CAAC;AAEzC;;;GAGG;AACH,qBAAa,UAAU;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAgB,QAAQ,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;IAElD;;;;;;OAMG;gBACS,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,GAAE,KAAqB;IAY3E;;;;;;OAMG;IACG,sBAAsB,CAC1B,WAAW,EAAE,OAAO,EACpB,QAAQ,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,OAAO;IA8BpB;;;;;;OAMG;IACG,qBAAqB,CACzB,WAAW,EAAE,OAAO,EACpB,KAAK,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,OAAO;IA8BpB;;;;;;OAMG;IACG,sBAAsB,CAC1B,WAAW,EAAE,OAAO,EACpB,OAAO,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,OAAO;IA8BpB;;;OAGG;IACG,eAAe;CAqBtB"}

package/dist/clients/RevenueManagerClient.d.ts

@@ -0,0 +1,42 @@
+import { type ReadContract, type Address, type Drift, type ReadWriteContract, type ReadWriteAdapter } from "@delvtech/drift";
+import { RevenueManagerAbi } from "../abi/RevenueManager";
+export type RevenueManagerABI = typeof RevenueManagerAbi;
+export declare class ReadRevenueManager {
+    readonly contract: ReadContract<RevenueManagerABI>;
+    constructor(address: Address, drift?: Drift);
+    /**
+     * Gets the claimable balance of ETH for the recipient
+     * @param recipient - The address of the recipient to check
+     * @returns Promise<bigint> - The claimable balance of ETH
+     */
+    balances(address: Address): Promise<bigint>;
+    /**
+     * Gets the protocol recipient address
+     * @returns Promise<Address> - The protocol recipient address
+     */
+    protocolRecipient(): Promise<`0x${string}`>;
+}
+export declare class ReadWriteRevenueManager extends ReadRevenueManager {
+    contract: ReadWriteContract<RevenueManagerABI>;
+    constructor(address: Address, drift?: Drift<ReadWriteAdapter>);
+    /**
+     * Allows the protocol recipient to claim the protocol's share of the revenue
+     * @returns Promise<TransactionResponse> - The transaction response
+     */
+    protocolClaim(): Promise<`0x${string}`>;
+    /**
+     * Allows the creator to claim their total share of the revenue from a revenue manager
+     * @returns Promise<TransactionResponse> - The transaction response
+     */
+    creatorClaim(): Promise<`0x${string}`>;
+    /**
+     * Allows the creator to claim their share of the revenue from specific flaunch tokens
+     * @param flaunchTokens - The flaunch token ids to claim the revenue for
+     * @returns Promise<TransactionResponse> - The transaction response
+     */
+    creatorClaimForTokens(flaunchTokens: {
+        flaunch: Address;
+        tokenId: bigint;
+    }[]): Promise<`0x${string}`>;
+}
+//# sourceMappingURL=RevenueManagerClient.d.ts.map

package/dist/clients/RevenueManagerClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RevenueManagerClient.d.ts","sourceRoot":"","sources":["../../src/clients/RevenueManagerClient.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,OAAO,EACZ,KAAK,KAAK,EAEV,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EAGtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE1D,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAC;AAEzD,qBAAa,kBAAkB;IAC7B,SAAgB,QAAQ,EAAE,YAAY,CAAC,iBAAiB,CAAC,CAAC;gBAE9C,OAAO,EAAE,OAAO,EAAE,KAAK,GAAE,KAAqB;IAO1D;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO;IAMzB;;;OAGG;IACH,iBAAiB;CAGlB;AAED,qBAAa,uBAAwB,SAAQ,kBAAkB;IACrD,QAAQ,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;gBAGrD,OAAO,EAAE,OAAO,EAChB,KAAK,GAAE,KAAK,CAAC,gBAAgB,CAAiB;IAKhD;;;OAGG;IACH,aAAa;IAIb;;;OAGG;IACH,YAAY;IAIZ;;;;OAIG;IACH,qBAAqB,CACnB,aAAa,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE;CAMzD"}

package/dist/clients/StateViewClient.d.ts

@@ -2,9 +2,24 @@ import { type ReadContract, type Address, type Drift, type HexString } from "@de
 import { StateViewAbi } from "../abi/StateView";
 import { PositionInfoParams } from "./PoolManagerClient";
 export type StateViewABI = typeof StateViewAbi;
+/**
+ * Client for reading state information from Uniswap V4 pools
+ * Provides methods to query pool states, positions, and tick liquidity
+ */
 export declare class ReadStateView {
     readonly contract: ReadContract<StateViewABI>;
+    /**
+     * Creates a new ReadStateView instance
+     * @param address - The address of the StateView contract
+     * @param drift - Optional drift instance for contract interactions (creates new instance if not provided)
+     * @throws Error if address is not provided
+     */
     constructor(address: Address, drift?: Drift);
+    /**
+     * Gets the Slot0 data for a pool
+     * @param poolId - The ID of the pool to query
+     * @returns Promise<{tick: number, sqrtPriceX96: bigint, protocolFees: bigint}> - Current pool state
+     */
     poolSlot0({ poolId }: {
         poolId: HexString;
     }): Promise<{
@@ -13,6 +28,15 @@ export declare class ReadStateView {
         protocolFee: number;
         lpFee: number;
     }>;
+    /**
+     * Gets information about a liquidity position
+     * @param poolId - The ID of the pool
+     * @param owner - The address of the position owner
+     * @param tickLower - The lower tick of the position
+     * @param tickUpper - The upper tick of the position
+     * @param salt - The salt used to identify the position
+     * @returns Promise<{liquidity: bigint, feeGrowthInside0LastX128: bigint, feeGrowthInside1LastX128: bigint, tokensOwed0: bigint, tokensOwed1: bigint}> - Position details
+     */
     positionInfo({ poolId, owner, tickLower, tickUpper, salt, }: PositionInfoParams): Promise<{
         liquidity: bigint;
         feeGrowthInside0LastX128: bigint;
@@ -22,6 +46,12 @@ export declare class ReadStateView {
         feeGrowthInside0LastX128: bigint;
         feeGrowthInside1LastX128: bigint;
     }>;
+    /**
+     * Gets the liquidity at a specific tick
+     * @param poolId - The ID of the pool
+     * @param tick - The tick to query
+     * @returns Promise<{liquidityGross: bigint, liquidityNet: bigint, feeGrowthOutside0X128: bigint, feeGrowthOutside1X128: bigint}> - Tick liquidity information
+     */
     getTickLiquidity({ poolId, tick }: {
         poolId: HexString;
         tick: number;

package/dist/clients/StateViewClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StateViewClient.d.ts","sourceRoot":"","sources":["../../src/clients/StateViewClient.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,OAAO,EACZ,KAAK,KAAK,EAIV,KAAK,SAAS,EAEf,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAIzD,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAC;AAE/C,qBAAa,aAAa;IACxB,SAAgB,QAAQ,EAAE,YAAY,CAAC,YAAY,CAAC,CAAC;gBAEzC,OAAO,EAAE,OAAO,EAAE,KAAK,GAAE,KAAqB;IAW1D,SAAS,CAAC,EAAE,MAAM,EAAE,EAAE;QAAE,MAAM,EAAE,SAAS,CAAA;KAAE;;;;;;IAM3C,YAAY,CAAC,EACX,MAAM,EACN,KAAK,EACL,SAAS,EACT,SAAS,EACT,IAAI,GACL,EAAE,kBAAkB;;;;;;;;;IAYrB,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;QAAE,MAAM,EAAE,SAAS,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;;;;CAMvE"}
+{"version":3,"file":"StateViewClient.d.ts","sourceRoot":"","sources":["../../src/clients/StateViewClient.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,OAAO,EACZ,KAAK,KAAK,EAIV,KAAK,SAAS,EAEf,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAIzD,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAC;AAE/C;;;GAGG;AACH,qBAAa,aAAa;IACxB,SAAgB,QAAQ,EAAE,YAAY,CAAC,YAAY,CAAC,CAAC;IAErD;;;;;OAKG;gBACS,OAAO,EAAE,OAAO,EAAE,KAAK,GAAE,KAAqB;IAW1D;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,EAAE;QAAE,MAAM,EAAE,SAAS,CAAA;KAAE;;;;;;IAM3C;;;;;;;;OAQG;IACH,YAAY,CAAC,EACX,MAAM,EACN,KAAK,EACL,SAAS,EACT,SAAS,EACT,IAAI,GACL,EAAE,kBAAkB;;;;;;;;;IAYrB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;QAAE,MAAM,EAAE,SAAS,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;;;;CAMvE"}

package/dist/clients/TreasuryManagerFactoryClient.d.ts

@@ -0,0 +1,24 @@
+import { type ReadContract, type Address, type Drift, type ReadWriteContract } from "@delvtech/drift";
+import { TreasuryManagerFactoryAbi } from "../abi/TreasuryManagerFactory";
+export type TreasuryManagerFactoryABI = typeof TreasuryManagerFactoryAbi;
+export declare class ReadTreasuryManagerFactory {
+    readonly contract: ReadContract<TreasuryManagerFactoryABI>;
+    constructor(address: Address, drift?: Drift);
+}
+export declare class ReadWriteTreasuryManagerFactory extends ReadTreasuryManagerFactory {
+    chainId: number;
+    contract: ReadWriteContract<TreasuryManagerFactoryABI>;
+    constructor(chainId: number, address: Address, drift?: Drift);
+    /**
+     * 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 Transaction response
+     */
+    deployRevenueManager(params: {
+        protocolRecipient: Address;
+        protocolFeePercent: number;
+    }): Promise<`0x${string}`>;
+}
+//# sourceMappingURL=TreasuryManagerFactoryClient.d.ts.map

package/dist/clients/TreasuryManagerFactoryClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TreasuryManagerFactoryClient.d.ts","sourceRoot":"","sources":["../../src/clients/TreasuryManagerFactoryClient.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,OAAO,EACZ,KAAK,KAAK,EAEV,KAAK,iBAAiB,EAIvB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAI1E,MAAM,MAAM,yBAAyB,GAAG,OAAO,yBAAyB,CAAC;AAEzE,qBAAa,0BAA0B;IACrC,SAAgB,QAAQ,EAAE,YAAY,CAAC,yBAAyB,CAAC,CAAC;gBAEtD,OAAO,EAAE,OAAO,EAAE,KAAK,GAAE,KAAqB;CAS3D;AAED,qBAAa,+BAAgC,SAAQ,0BAA0B;IAC7E,OAAO,EAAE,MAAM,CAAC;IACR,QAAQ,EAAE,iBAAiB,CAAC,yBAAyB,CAAC,CAAC;gBAEnD,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,GAAE,KAAqB;IAK3E;;;;;;OAMG;IACH,oBAAoB,CAAC,MAAM,EAAE;QAC3B,iBAAiB,EAAE,OAAO,CAAC;QAC3B,kBAAkB,EAAE,MAAM,CAAC;KAC5B;CAuBF"}

package/dist/helpers/chainIdToChain.d.ts

@@ -0,0 +1,5 @@
+import { Chain } from "viem";
+export declare const chainIdToChain: {
+    [key: number]: Chain;
+};
+//# sourceMappingURL=chainIdToChain.d.ts.map

package/dist/helpers/chainIdToChain.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chainIdToChain.d.ts","sourceRoot":"","sources":["../../src/helpers/chainIdToChain.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAG7B,eAAO,MAAM,cAAc,EAAE;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC;CAItB,CAAC"}