# Flaunch SDK

[![npm version](https://img.shields.io/npm/v/@flaunch/sdk.svg)](https://npmjs.com/package/@flaunch/sdk)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A TypeScript SDK for seamless interaction with the Flaunch protocol and Uniswap V4.

![Flaunch Header](https://raw.githubusercontent.com/flayerlabs/flaunch-sdk/refs/heads/master/.github/flaunch-header.png)

_Note: Add this `llms-full.txt` file into Cursor IDE / LLMs to provide context about using the Flaunch SDK: [llms-full.txt](https://raw.githubusercontent.com/flayerlabs/flaunch-sdk/refs/heads/master/llms-full.txt)_

## Features

- 🚀 Flaunch new memecoins
- 💱 Buy and sell memecoins via Uniswap V4 hooks
- 🏗️ Build your own token launchpads on top of the flaunch protocol
- 📊 Read functions for token and pool data
- 🔒 Built-in Permit2 support for gasless approvals
- 🔵 Works on Base and Base Sepolia networks

## Table of Contents

- [Installation](#installation)
- [Quick Start](#quick-start)
- [Usage](#usage)
  - [Read Operations](#read-operations-with-viem)
  - [Write Operations](#write-operations-with-viem--wagmi)
  - [Selling with Permit2](#selling-with-permit2)
  - [Flaunching a Memecoin](#flaunching-a-memecoin)
    - [How to generate Base64Image from file upload](#how-to-generate-base64image-from-user-uploaded-file)
  - [Advanced Integration: Revenue Sharing with RevenueManager](#advanced-integration-revenue-sharing-with-revenuemanager)
  - [All SDK functions](#all-sdk-functions)
  - [React Hooks](#react-hooks)
- [Flaunch Docs](#flaunch-reference)

## Installation

Using pnpm (recommended):

```bash
pnpm add @flaunch/sdk
```

Using npm:

```bash
npm install @flaunch/sdk
```

Using yarn:

```bash
yarn add @flaunch/sdk
```

## Quick Start

Here's a simple example to get started with reading token metadata:

```ts
import { createFlaunch } from "@flaunch/sdk";
import { createPublicClient, http } from "viem";
import { base } from "viem/chains";

const publicClient = createPublicClient({
  chain: base,
  transport: http(),
});

const flaunchRead = createFlaunch({ publicClient });
const { symbol, name, image } = await flaunchRead.getCoinMetadata(coinAddress);
// returns: {symbol: "TEST", name: "Test", image: "https://<IMAGE_URL>"}
```

## Usage

The SDK provides two types of operations:

1. Read operations: Only require a `publicClient`
2. Write operations: Require both `publicClient` and `walletClient`

### Read Operations (with Viem)

```ts
import { createFlaunch } from "@flaunch/sdk";
import { createPublicClient, http } from "viem";
import { base } from "viem/chains";

const publicClient = createPublicClient({
  chain: base,
  transport: http("<RPC_URL>"), // "<RPC_URL>" is optional, defaults to public RPC
});

const flaunchRead = createFlaunch({ publicClient });

// Read token metadata
const { symbol, name, image } = await flaunchRead.getCoinMetadata(coinAddress);
// returns: {symbol: "TEST", name: "Test", image: "https://<IMAGE_URL>"}
```

### Write Operations (with Viem + Wagmi)

For write operations, you'll need both Viem and Wagmi. Here's how to set it up in a React component:

```ts
import { createFlaunch } from "@flaunch/sdk";
import { base } from "viem/chains";
import { useWalletClient } from "wagmi";
import { useMemo } from "react";

// ... your React component ...

const publicClient = createPublicClient({
  chain: base,
  transport: http("<RPC_URL>"), // "<RPC_URL>" is optional, defaults to public RPC
});
const { data: walletClient } = useWalletClient();

const flaunchWrite = useMemo(() => {
  if (!publicClient && !walletClient) return null;

  return createFlaunch({
    publicClient,
    walletClient,
  }) as ReadWriteFlaunchSDK;
}, [publicClient, walletClient]);

// Execute a buy transaction
const buyTokens = async () => {
  const hash = await flaunchWrite.buyCoin({
    coinAddress,
    slippagePercent: 5,
    swapType: "EXACT_IN",
    amountIn: parseEther("0.1"),
  });

  // Wait for confirmation
  const receipt = await flaunchWrite.drift.waitForTransaction({ hash });
  console.log(receipt.status === "success" ? "Success" : "Failed");
};
```

### Selling with Permit2

Permit2 enables gasless token approvals. Here's how to implement token selling with Permit2:

```ts
import { useSignTypedData } from "wagmi";
import { parseEther, Hex } from "viem";

const {
  signTypedData,
  status: sigStatus,
  error: sigError,
  data: signature,
} = useSignTypedData();

// Check allowance and permit if needed
const { allowance } = await flaunchWrite.getPermit2AllowanceAndNonce(
  coinAddress
);

if (allowance < parseEther(coinAmount)) {
  const { typedData, permitSingle } = await flaunchWrite.getPermit2TypedData(
    coinAddress
  );
  signTypedData(typedData);

  // then call this when signature is not undefined
  const hash = await flaunchWrite.sellCoin({
    coinAddress,
    amountIn: parseEther(coinAmount),
    slippagePercent: 5,
    permitSingle,
    signature,
  });
} else {
  // if already approved
  const hash = await flaunchWrite.sellCoin({
    coinAddress,
    amountIn: parseEther(coinAmount),
    slippagePercent: 5,
  });
}
```

### Flaunching a Memecoin

"Fast" Flaunch your own memecoin with default parameters:

- $10k starting market cap
- 60% of the total supply goes to the fair launch
- 80% dev / 20% community split

_**Fast Flaunch doesn't incur any protocol fees!**_

```ts
const hash = await flaunchWrite.fastFlaunchIPFS({
  name: "Test",
  symbol: "TEST",
  creator: address,
  metadata: {
    base64Image: imageData, // refer to the code below, on how to generate this base64Image
    description: "Your memecoin description",
    // optional:
    websiteUrl: "https://example.com/",
    discordUrl: "https://discord.gg/example",
    twitterUrl: "https://x.com/example",
    telegramUrl: "https://t.me/example",
  },
  pinataConfig: {
    // Use one-time JWT for client-side uploads
    // Refer: https://www.pinata.cloud/blog/how-to-upload-to-ipfs-from-the-frontend-with-signed-jwts/
    jwt: pinataJWT,
  },
});
```

#### How to generate `base64Image` from User uploaded file

```tsx
// handle image file input and convert into base64
const handleImageChange = useCallback(
  (e: ChangeEvent<HTMLInputElement>) => {
    if (e.target.files && e.target.files[0]) {
      const file = e.target.files[0];

      // read the file as base64
      const reader = new FileReader();
      reader.onloadend = () => {
        const base64String = reader.result as string;

        // this can be passed to the flaunch function call
        handleFlaunch({ imageData: base64String });

        // use `storedImagePreview` to display the uploaded image with <image src={storedImagePreview} />
        setStoredImagePreview(base64String);
      };
      reader.readAsDataURL(file);
    }
  },
  [setStoredImagePreview]
);

// File upload input
<input
  type="file"
  accept="image/*"
  onchange="handleImageChange(event)"
  id="image-upload"
/>;
```

### Advanced Integration: Revenue Sharing with RevenueManager

For platforms building on top of Flaunch, the `RevenueManager` contract enables sophisticated revenue-sharing models. It allows platforms to automatically take a protocol fee from the trading fees generated by memecoins launched through their integration.

**Key Concepts:**

1.  **Deployment & Initialization**: Before flaunching tokens via your platform, deploy an instance of your `RevenueManager` with your protocol fee and recipient address.

```ts
const revenueManagerInstanceAddress = await flaunchWrite.deployRevenueManager({
  protocolRecipient: "0xabc...",
  protocolFeePercent: 20, // 20% revenue share between protocol and 80% to coin creators (of the 1% swap fees)
});
```

2.  **Flaunching Directly to Manager**: Instead of the creator receiving the Flaunch NFT, you'd flaunch the token directly into the `RevenueManager`. This automatically sets up the fee split.

```ts
await flaunchWrite.flaunchIPFSWithRevenueManager({
  name: "...",
  symbol: "...",
  metadata: {
    base64Image: "...",
  },
  pinataConfig: {
    jwt: "...",
  },
  fairLaunchPercent: 40,
  fairLaunchDuration: 30 * 60, // 30 mins
  initialMarketCapUSD: 1_000,
  creator: "0x...",
  creatorFeeAllocationPercent: 100,
  // **Note:** Specify your instance of the RevenueManager here
  revenueManagerInstanceAddress: "...",
});
```

3.  **Claiming Fees**: Creators can claim their share of earned fees, and the protocol can claim its share via the `RevenueManager` contract.

```ts
// check address' balance
const balance = await flaunchRead.revenueManagerBalance({
  revenueManagerAddress: revenueManagerInstanceAddress,
  recipient: "0xabc...",
});

// protocol claim: the connected wallet must be the protocol recipient for the revenue manager
await flaunchWrite.revenueManagerProtocolClaim({
  revenueManagerAddress: revenueManagerInstanceAddress,
});

// creator claim: the connected wallet must be the coin's creator for them to claim their share
await flaunchWrite.revenueManagerCreatorClaim({
  revenueManagerAddress: revenueManagerInstanceAddress,
});

// creator claim: for specific flaunch token ids:
await flaunchWrite.revenueManagerCreatorClaimForTokens({
  revenueManagerAddress: revenueManagerInstanceAddress,
  flaunchTokens: [
    {
      flaunch: FlaunchAddress[base.id],
      tokenId: 5,
    },
    {
      flaunch: FlaunchV1_1Address[base.id],
      tokenId: 10,
    },
  ],
});
```

Refer to the [RevenueManager Docs](https://docs.flaunch.gg/manager-types/revenuemanager) for detailed implementation guides and function references.

### All SDK functions

For a list of all the functions in the SDK, refer to: [FlaunchSDK.ts](./src/sdk/FlaunchSDK.ts)

### React Hooks

The package also has hooks to listen for new Flaunches and new Coin Swaps. Refer to: [hooks](./src/hooks/FlaunchPositionManagerHooks.ts)

```tsx
import { usePoolCreatedEvents, usePoolSwapEvents } from "@flaunch/sdk/hooks";

const { logs: poolCreatedLogs } = usePoolCreatedEvents(flaunchRead);
const { logs: poolSwapLogs } = usePoolSwapEvents(flaunchRead, coinAddress);

/**
 * The `poolSwapLogs` calculates & returns the net swapped amount:
 *
 * type BuySwapLog = {
 *  ...eventLog,
 *  timestamp: number;
 *  type: "BUY";
 *   delta: {
 *     coinsBought: bigint;
 *     flETHSold: bigint;
 *     fees: {
 *       isInFLETH: boolean;
 *       amount: bigint;
 *     };
 *   };
 * };
 *
 * type SellSwapLog = {
 *  ...eventLog,
 *  timestamp: number;
 *  type: "SELL";
 *   delta: {
 *     coinsSold: bigint;
 *     flETHBought: bigint;
 *     fees: {
 *       isInFLETH: boolean;
 *       amount: bigint;
 *     };
 *   };
 * };
 */
```

## Flaunch Reference

For detailed protocol documentation, visit our [Docs](https://docs.flaunch.gg/).


# API Documentation

@flaunch/sdk - v0.7.0 / Exports / ReadFlaunchSDK

# Class: ReadFlaunchSDK

Base class for interacting with Flaunch protocol in read-only mode

## Hierarchy

- **`ReadFlaunchSDK`**

  ↳ `ReadWriteFlaunchSDK`

## Table of contents

### Constructors

- constructor

### Properties

- TICK\_SPACING
- chainId
- drift
- readBidWall
- readBidWallV1\_1
- readFairLaunch
- readFairLaunchV1\_1
- readFlaunch
- readFlaunchV1\_1
- readFlaunchZap
- readPermit2
- readPoolManager
- readPositionManager
- readPositionManagerV1\_1
- readQuoter
- readStateView
- resolveIPFS

### Methods

- bidWallPosition
- coinPriceInETH
- currentTick
- ethRequiredToFlaunch
- fairLaunchCoinOnlyPosition
- fairLaunchDuration
- fairLaunchETHOnlyPosition
- fairLaunchInfo
- flETHIsCurrencyZero
- getBuyQuoteExactInput
- getBuyQuoteExactOutput
- getCoinMetadata
- getCoinMetadataFromTokenId
- getCoinMetadataFromTokenIds
- getETHUSDCPrice
- getFlaunchingFee
- getSellQuoteExactInput
- initialTick
- isFairLaunchActive
- isV1Coin
- isValidCoin
- pollPoolCreatedNow
- pollPoolCreatedNowV1
- pollPoolSwapNow
- pollPoolSwapNowV1
- poolId
- positionInfo
- revenueManagerAllTokensByCreator
- revenueManagerAllTokensInManager
- revenueManagerBalance
- revenueManagerProtocolBalance
- revenueManagerTokensCount
- setIPFSResolver
- watchPoolCreated
- watchPoolCreatedV1
- watchPoolSwap
- watchPoolSwapV1

## Constructors

### constructor

• **new ReadFlaunchSDK**(`chainId`, `drift?`): `ReadFlaunchSDK`

Parameters

| Name | Type |
| :------ | :------ |
| `chainId` | `number` |
| `drift` | `Drift` |

Returns

`ReadFlaunchSDK`

## Properties

### TICK\_SPACING

• `Readonly` **TICK\_SPACING**: ``60``

___

### chainId

• `Readonly` **chainId**: `number`

___

### drift

• `Readonly` **drift**: `Drift`

___

### readBidWall

• `Readonly` **readBidWall**: `ReadBidWall`

___

### readBidWallV1\_1

• `Readonly` **readBidWallV1\_1**: `ReadBidWallV1_1`

___

### readFairLaunch

• `Readonly` **readFairLaunch**: `ReadFairLaunch`

___

### readFairLaunchV1\_1

• `Readonly` **readFairLaunchV1\_1**: `ReadFairLaunchV1_1`

___

### readFlaunch

• `Readonly` **readFlaunch**: `ReadFlaunch`

___

### readFlaunchV1\_1

• `Readonly` **readFlaunchV1\_1**: `ReadFlaunchV1_1`

___

### readFlaunchZap

• `Readonly` **readFlaunchZap**: `ReadFlaunchZap`

___

### readPermit2

• `Readonly` **readPermit2**: `ReadPermit2`

___

### readPoolManager

• `Readonly` **readPoolManager**: `ReadPoolManager`

___

### readPositionManager

• `Readonly` **readPositionManager**: `ReadFlaunchPositionManager`

___

### readPositionManagerV1\_1

• `Readonly` **readPositionManagerV1\_1**: `ReadFlaunchPositionManagerV1_1`

___

### readQuoter

• `Readonly` **readQuoter**: `ReadQuoter`

___

### readStateView

• `Readonly` **readStateView**: `ReadStateView`

___

### resolveIPFS

• **resolveIPFS**: (`value`: `string`) => `string`

Type declaration

▸ (`value`): `string`

#Parameters

| Name | Type |
| :------ | :------ |
| `value` | `string` |

#Returns

`string`

## Methods

### bidWallPosition

▸ **bidWallPosition**(`coinAddress`, `isV1Coin?`): `Promise`\<\{ `coinAmount`: `bigint` ; `flETHAmount`: `bigint` ; `pendingEth`: `bigint` ; `tickLower`: `number` ; `tickUpper`: `number`  }\>

Gets information about the bid wall position for a coin

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<\{ `coinAmount`: `bigint` ; `flETHAmount`: `bigint` ; `pendingEth`: `bigint` ; `tickLower`: `number` ; `tickUpper`: `number`  }\>

Promise<{flETHAmount: bigint, coinAmount: bigint, pendingEth: bigint, tickLower: number, tickUpper: number}> - Bid wall position details

___

### coinPriceInETH

▸ **coinPriceInETH**(`coinAddress`, `isV1Coin?`): `Promise`\<`string`\>

Calculates the coin price in ETH based on the current tick

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<`string`\>

Promise<string> - The price of the coin in ETH with 18 decimals precision

___

### currentTick

▸ **currentTick**(`coinAddress`, `isV1Coin?`): `Promise`\<`number`\>

Gets the current tick for a given coin's pool

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<`number`\>

Promise<number> - The current tick of the pool

___

### ethRequiredToFlaunch

▸ **ethRequiredToFlaunch**(`params`): `Promise`\<`bigint`\>

Calculates the ETH required to flaunch a token, takes into account the ETH for premine and the flaunching fee

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Object` | - |
| `params.initialMarketCapUSD` | `number` | The initial market cap in USD |
| `params.premineAmount` | `bigint` | The amount of coins to be premined |
| `params.slippagePercent?` | `number` | The slippage percent |

Returns

`Promise`\<`bigint`\>

Promise<bigint> - The ETH required to flaunch

___

### fairLaunchCoinOnlyPosition

▸ **fairLaunchCoinOnlyPosition**(`coinAddress`, `isV1Coin?`): `Promise`\<\{ `coinAmount`: `bigint` ; `flETHAmount`: `bigint` ; `tickLower`: `number` ; `tickUpper`: `number`  }\>

Gets information about the coin-only position in a fair launch

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<\{ `coinAmount`: `bigint` ; `flETHAmount`: `bigint` ; `tickLower`: `number` ; `tickUpper`: `number`  }\>

Promise<{flETHAmount: bigint, coinAmount: bigint, tickLower: number, tickUpper: number}> - Position details

___

### fairLaunchDuration

▸ **fairLaunchDuration**(`coinAddress`, `isV1Coin?`): `Promise`\<`number` \| `bigint`\>

Gets the duration of a fair launch for a given coin

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<`number` \| `bigint`\>

Promise<number> - The duration in seconds (30 minutes for V1, variable for V1.1)

___

### fairLaunchETHOnlyPosition

▸ **fairLaunchETHOnlyPosition**(`coinAddress`, `isV1Coin?`): `Promise`\<\{ `coinAmount`: `bigint` ; `flETHAmount`: `bigint` ; `tickLower`: `number` ; `tickUpper`: `number`  }\>

Gets information about the ETH-only position in a fair launch

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<\{ `coinAmount`: `bigint` ; `flETHAmount`: `bigint` ; `tickLower`: `number` ; `tickUpper`: `number`  }\>

Promise<{flETHAmount: bigint, coinAmount: bigint, tickLower: number, tickUpper: number}> - Position details

___

### fairLaunchInfo

▸ **fairLaunchInfo**(`coinAddress`, `isV1Coin?`): `Promise`\<\{ `closed`: `boolean` ; `endsAt`: `bigint` ; `initialTick`: `number` ; `revenue`: `bigint` ; `startsAt`: `bigint` ; `supply`: `bigint`  }\>

Gets information about a fair launch for a given coin

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<\{ `closed`: `boolean` ; `endsAt`: `bigint` ; `initialTick`: `number` ; `revenue`: `bigint` ; `startsAt`: `bigint` ; `supply`: `bigint`  }\>

Fair launch information from the appropriate contract version

___

### flETHIsCurrencyZero

▸ **flETHIsCurrencyZero**(`coinAddress`): `boolean`

Determines if flETH is currency0 in the pool

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |

Returns

`boolean`

boolean - True if flETH is currency0, false otherwise

___

### getBuyQuoteExactInput

▸ **getBuyQuoteExactInput**(`coinAddress`, `amountIn`, `isV1Coin?`): `Promise`\<`bigint`\>

Gets a quote for buying tokens with an exact amount of ETH

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the token to buy |
| `amountIn` | `bigint` | - |
| `isV1Coin?` | `boolean` | Optional flag to specify if token is V1. If not provided, V1.1 is assumed |

Returns

`Promise`\<`bigint`\>

Promise<bigint> - The expected amount of tokens to receive

___

### getBuyQuoteExactOutput

▸ **getBuyQuoteExactOutput**(`coinAddress`, `amountOut`, `isV1Coin?`): `Promise`\<`bigint`\>

Gets a quote for buying an exact amount of tokens with ETH

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the token to buy |
| `amountOut` | `bigint` | - |
| `isV1Coin?` | `boolean` | Optional flag to specify if token is V1. If not provided, V1.1 is assumed |

Returns

`Promise`\<`bigint`\>

Promise<bigint> - The required amount of ETH to spend

___

### getCoinMetadata

▸ **getCoinMetadata**(`coinAddress`): `Promise`\<`CoinMetadata` & \{ `symbol`: `string`  }\>

Retrieves metadata for a given Flaunch coin

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |

Returns

`Promise`\<`CoinMetadata` & \{ `symbol`: `string`  }\>

Promise<CoinMetadata & { symbol: string }> - The coin's metadata including name, symbol, description, and social links

___

### getCoinMetadataFromTokenId

▸ **getCoinMetadataFromTokenId**(`flaunch`, `tokenId`): `Promise`\<`CoinMetadata` & \{ `symbol`: `string`  }\>

Retrieves metadata for a given Flaunch coin using its token ID & Flaunch contract address

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `flaunch` | \`0x$\{string}\` | The address of the Flaunch contract |
| `tokenId` | `bigint` | The token ID of the coin |

Returns

`Promise`\<`CoinMetadata` & \{ `symbol`: `string`  }\>

The coin's metadata including name, symbol, description, and social links

___

### getCoinMetadataFromTokenIds

▸ **getCoinMetadataFromTokenIds**(`params`, `batchSize?`, `batchDelay?`): `Promise`\<\{ `coinAddress`: \`0x$\{string}\` ; `collaborators`: `any` ; `description`: `any` ; `discordUrl`: `any` ; `external_link`: `any` ; `image`: `string` ; `name`: `string` ; `symbol`: `string` ; `telegramUrl`: `any` ; `twitterUrl`: `any`  }[]\>

Retrieves metadata for multiple Flaunch coins using their token IDs & Flaunch contract addresses

Parameters

| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `params` | \{ `flaunch`: \`0x$\{string}\` ; `tokenId`: `bigint`  }[] | `undefined` | An array of objects containing flaunch contract address and token ID |
| `batchSize` | `number` | `9` | Optional, the number of ipfs requests to process in each batch |
| `batchDelay` | `number` | `500` | Optional, the delay in milliseconds between batches |

Returns

`Promise`\<\{ `coinAddress`: \`0x$\{string}\` ; `collaborators`: `any` ; `description`: `any` ; `discordUrl`: `any` ; `external_link`: `any` ; `image`: `string` ; `name`: `string` ; `symbol`: `string` ; `telegramUrl`: `any` ; `twitterUrl`: `any`  }[]\>

An array of objects containing coin address, name, symbol, description, and social links

___

### getETHUSDCPrice

▸ **getETHUSDCPrice**(`drift?`): `Promise`\<`number`\>

Gets the current ETH/USDC price

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `drift?` | `Drift` | Optional drift instance to get price from Base Mainnet |

Returns

`Promise`\<`number`\>

Promise<number> - The current ETH/USDC price

___

### getFlaunchingFee

▸ **getFlaunchingFee**(`params`): `Promise`\<`bigint`\>

Gets the flaunching fee for a given initial price and slippage percent

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Object` | - |
| `params.initialMarketCapUSD` | `number` | The initial market cap in USD |
| `params.sender` | \`0x$\{string}\` | The address of the sender |
| `params.slippagePercent?` | `number` | The slippage percent |

Returns

`Promise`\<`bigint`\>

Promise<bigint> - The flaunching fee

___

### getSellQuoteExactInput

▸ **getSellQuoteExactInput**(`coinAddress`, `amountIn`, `isV1Coin?`): `Promise`\<`bigint`\>

Gets a quote for selling an exact amount of tokens for ETH

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the token to sell |
| `amountIn` | `bigint` | The exact amount of tokens to sell |
| `isV1Coin?` | `boolean` | Optional flag to specify if token is V1. If not provided, V1.1 is assumed |

Returns

`Promise`\<`bigint`\>

Promise<bigint> - The expected amount of ETH to receive

___

### initialTick

▸ **initialTick**(`coinAddress`, `isV1Coin?`): `Promise`\<`number`\>

Gets the initial tick for a fair launch

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<`number`\>

Promise<number> - The initial tick value

___

### isFairLaunchActive

▸ **isFairLaunchActive**(`coinAddress`, `isV1Coin?`): `Promise`\<`boolean`\>

Checks if a fair launch is currently active for a given coin

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<`boolean`\>

Promise<boolean> - True if fair launch is active, false otherwise

___

### isV1Coin

▸ **isV1Coin**(`coinAddress`): `Promise`\<`boolean`\>

Checks if a given coin address is a V1 Flaunch coin

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin to check |

Returns

`Promise`\<`boolean`\>

Promise<boolean> - True if the coin is V1, false if V1.1

___

### isValidCoin

▸ **isValidCoin**(`coinAddress`): `Promise`\<`boolean`\>

Checks if a given coin address is a valid Flaunch coin (either V1 or V1.1)

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin to check |

Returns

`Promise`\<`boolean`\>

Promise<boolean> - True if the coin is valid, false otherwise

___

### pollPoolCreatedNow

▸ **pollPoolCreatedNow**(): `undefined` \| `Promise`\<`void`\>

Polls for current pool creation events on V1.1 contracts

Returns

`undefined` \| `Promise`\<`void`\>

Current pool creation events or undefined if polling is not available

___

### pollPoolCreatedNowV1

▸ **pollPoolCreatedNowV1**(): `undefined` \| `Promise`\<`void`\>

Polls for current pool creation events on V1 contracts

Returns

`undefined` \| `Promise`\<`void`\>

Current pool creation events or undefined if polling is not available

___

### pollPoolSwapNow

▸ **pollPoolSwapNow**(): `undefined` \| `Promise`\<`void`\>

Polls for current pool swap events on V1.1 contracts

Returns

`undefined` \| `Promise`\<`void`\>

Current pool swap events or undefined if polling is not available

___

### pollPoolSwapNowV1

▸ **pollPoolSwapNowV1**(): `undefined` \| `Promise`\<`void`\>

Polls for current pool swap events on V1 contracts

Returns

`undefined` \| `Promise`\<`void`\>

Current pool swap events or undefined if polling is not available

___

### poolId

▸ **poolId**(`coinAddress`, `isV1Coin?`): `Promise`\<\`0x$\{string}\`\>

Gets the pool ID for a given coin

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<\`0x$\{string}\`\>

Promise<string> - The pool ID

___

### positionInfo

▸ **positionInfo**(`params`): `Promise`\<\{ `feeGrowthInside0LastX128`: `bigint` ; `feeGrowthInside1LastX128`: `bigint` ; `liquidity`: `bigint`  } \| \{ `feeGrowthInside0LastX128`: `bigint` ; `feeGrowthInside1LastX128`: `bigint` ; `liquidity`: `bigint`  }\>

Gets information about a liquidity position

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `PositionInfoParams` | Parameters for querying position info |

Returns

`Promise`\<\{ `feeGrowthInside0LastX128`: `bigint` ; `feeGrowthInside1LastX128`: `bigint` ; `liquidity`: `bigint`  } \| \{ `feeGrowthInside0LastX128`: `bigint` ; `feeGrowthInside1LastX128`: `bigint` ; `liquidity`: `bigint`  }\>

Position information from the state view contract

___

### revenueManagerAllTokensByCreator

▸ **revenueManagerAllTokensByCreator**(`params`): `Promise`\<readonly \{ `flaunch`: \`0x$\{string}\` ; `tokenId`: `bigint`  }[]\>

Gets all tokens created by a specific creator address

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Object` | Parameters for querying tokens by creator |
| `params.creator` | \`0x$\{string}\` | The address of the creator to query tokens for |
| `params.revenueManagerAddress` | \`0x$\{string}\` | The address of the revenue manager |
| `params.sortByDesc?` | `boolean` | Whether to sort the tokens by descending order |

Returns

`Promise`\<readonly \{ `flaunch`: \`0x$\{string}\` ; `tokenId`: `bigint`  }[]\>

Promise<Array<{flaunch: Address, tokenId: bigint}>> - Array of token objects containing flaunch address and token ID

___

### revenueManagerAllTokensInManager

▸ **revenueManagerAllTokensInManager**(`params`): `Promise`\<\{ `flaunch`: \`0x$\{string}\` ; `tokenId`: `bigint`  }[]\>

Gets all tokens currently managed by a revenue manager

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Object` | Parameters for querying tokens in manager |
| `params.revenueManagerAddress` | \`0x$\{string}\` | The address of the revenue manager |
| `params.sortByDesc?` | `boolean` | Optional boolean to sort tokens in descending order (default: false) |

Returns

`Promise`\<\{ `flaunch`: \`0x$\{string}\` ; `tokenId`: `bigint`  }[]\>

Promise<Array<{flaunch: Address, tokenId: bigint}>> - Array of token objects containing flaunch address and token ID

___

### revenueManagerBalance

▸ **revenueManagerBalance**(`params`): `Promise`\<`bigint`\>

Gets the claimable balance of ETH for the recipient from a revenue manager

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Object` | Parameters for checking the balance |
| `params.recipient` | \`0x$\{string}\` | The address of the recipient to check |
| `params.revenueManagerAddress` | \`0x$\{string}\` | The address of the revenue manager |

Returns

`Promise`\<`bigint`\>

Promise<bigint> - The claimable balance of ETH

___

### revenueManagerProtocolBalance

▸ **revenueManagerProtocolBalance**(`revenueManagerAddress`): `Promise`\<`bigint`\>

Gets the claimable balance of ETH for the protocol from a revenue manager

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `revenueManagerAddress` | \`0x$\{string}\` | The address of the revenue manager |

Returns

`Promise`\<`bigint`\>

Promise<bigint> - The claimable balance of ETH

___

### revenueManagerTokensCount

▸ **revenueManagerTokensCount**(`revenueManagerAddress`): `Promise`\<`bigint`\>

Gets the total number of tokens managed by a revenue manager

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `revenueManagerAddress` | \`0x$\{string}\` | The address of the revenue manager |

Returns

`Promise`\<`bigint`\>

Promise<bigint> - The total count of tokens

___

### setIPFSResolver

▸ **setIPFSResolver**(`resolverFn`): `void`

Sets a custom IPFS resolver function

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `resolverFn` | (`ipfsHash`: `string`) => `string` | Custom function to resolve IPFS URIs |

Returns

`void`

**`Dev`**

this is used to resolve IPFS hash to a gateway URL
eg: input: Qabc, output: https://ipfs.io/ipfs/Qabc

___

### watchPoolCreated

▸ **watchPoolCreated**(`params`): `Promise`\<\{ `cleanup`: () => `void` ; `pollPoolCreatedNow`: () => `Promise`\<`void`\> = pollEvents }\>

Watches for pool creation events on V1.1 contracts

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `WatchPoolCreatedParams` | Parameters for watching pool creation |

Returns

`Promise`\<\{ `cleanup`: () => `void` ; `pollPoolCreatedNow`: () => `Promise`\<`void`\> = pollEvents }\>

Subscription to pool creation events

___

### watchPoolCreatedV1

▸ **watchPoolCreatedV1**(`params`): `Promise`\<\{ `cleanup`: () => `void` ; `pollPoolCreatedNow`: () => `Promise`\<`void`\> = pollEvents }\>

Watches for pool creation events on V1 contracts

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `WatchPoolCreatedParams` | Parameters for watching pool creation |

Returns

`Promise`\<\{ `cleanup`: () => `void` ; `pollPoolCreatedNow`: () => `Promise`\<`void`\> = pollEvents }\>

Subscription to pool creation events

___

### watchPoolSwap

▸ **watchPoolSwap**(`params`): `Promise`\<\{ `cleanup`: () => `void` ; `pollPoolSwapNow`: () => `Promise`\<`void`\> = pollEvents }\>

Watches for pool swap events on V1.1 contracts

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `WatchPoolSwapParams` | Parameters for watching pool swaps including optional coin filter |

Returns

`Promise`\<\{ `cleanup`: () => `void` ; `pollPoolSwapNow`: () => `Promise`\<`void`\> = pollEvents }\>

Subscription to pool swap events

___

### watchPoolSwapV1

▸ **watchPoolSwapV1**(`params`): `Promise`\<\{ `cleanup`: () => `void` ; `pollPoolSwapNow`: () => `Promise`\<`void`\> = pollEvents }\>

Watches for pool swap events on V1 contracts

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `WatchPoolSwapParams` | Parameters for watching pool swaps including optional coin filter |

Returns

`Promise`\<\{ `cleanup`: () => `void` ; `pollPoolSwapNow`: () => `Promise`\<`void`\> = pollEvents }\>

Subscription to pool swap events



---

@flaunch/sdk - v0.7.0 / Exports / ReadWriteFlaunchSDK

# Class: ReadWriteFlaunchSDK

Base class for interacting with Flaunch protocol in read-only mode

## Hierarchy

- `ReadFlaunchSDK`

  ↳ **`ReadWriteFlaunchSDK`**

## Table of contents

### Constructors

- constructor

### Properties

- TICK\_SPACING
- chainId
- drift
- readBidWall
- readBidWallV1\_1
- readFairLaunch
- readFairLaunchV1\_1
- readFlaunch
- readFlaunchV1\_1
- readFlaunchZap
- readPermit2
- readPoolManager
- readPositionManager
- readPositionManagerV1\_1
- readQuoter
- readStateView
- readWriteFastFlaunchZap
- readWriteFlaunchZap
- readWritePermit2
- readWritePositionManagerV1\_1
- readWriteTreasuryManagerFactory
- resolveIPFS

### Methods

- bidWallPosition
- buyCoin
- coinBalance
- coinPriceInETH
- currentTick
- deployRevenueManager
- ethRequiredToFlaunch
- fairLaunchCoinOnlyPosition
- fairLaunchDuration
- fairLaunchETHOnlyPosition
- fairLaunchInfo
- fastFlaunch
- fastFlaunchIPFS
- flETHIsCurrencyZero
- flaunch
- flaunchIPFS
- flaunchIPFSWithRevenueManager
- flaunchWithRevenueManager
- getBuyQuoteExactInput
- getBuyQuoteExactOutput
- getCoinMetadata
- getCoinMetadataFromTokenId
- getCoinMetadataFromTokenIds
- getETHUSDCPrice
- getFlaunchingFee
- getPermit2AllowanceAndNonce
- getPermit2TypedData
- getSellQuoteExactInput
- initialTick
- isFairLaunchActive
- isV1Coin
- isValidCoin
- pollPoolCreatedNow
- pollPoolCreatedNowV1
- pollPoolSwapNow
- pollPoolSwapNowV1
- poolId
- positionInfo
- revenueManagerAllTokensByCreator
- revenueManagerAllTokensInManager
- revenueManagerBalance
- revenueManagerCreatorClaim
- revenueManagerCreatorClaimForTokens
- revenueManagerProtocolBalance
- revenueManagerProtocolClaim
- revenueManagerTokensCount
- sellCoin
- setIPFSResolver
- watchPoolCreated
- watchPoolCreatedV1
- watchPoolSwap
- watchPoolSwapV1

## Constructors

### constructor

• **new ReadWriteFlaunchSDK**(`chainId`, `drift?`): `ReadWriteFlaunchSDK`

Parameters

| Name | Type |
| :------ | :------ |
| `chainId` | `number` |
| `drift` | `Drift`\<`ReadWriteAdapter`\> |

Returns

`ReadWriteFlaunchSDK`

Overrides

ReadFlaunchSDK.constructor

## Properties

### TICK\_SPACING

• `Readonly` **TICK\_SPACING**: ``60``

Inherited from

ReadFlaunchSDK.TICK_SPACING

___

### chainId

• `Readonly` **chainId**: `number`

Inherited from

ReadFlaunchSDK.chainId

___

### drift

• **drift**: `Drift`\<`ReadWriteAdapter`\>

Overrides

ReadFlaunchSDK.drift

___

### readBidWall

• `Readonly` **readBidWall**: `ReadBidWall`

Inherited from

ReadFlaunchSDK.readBidWall

___

### readBidWallV1\_1

• `Readonly` **readBidWallV1\_1**: `ReadBidWallV1_1`

Inherited from

ReadFlaunchSDK.readBidWallV1_1

___

### readFairLaunch

• `Readonly` **readFairLaunch**: `ReadFairLaunch`

Inherited from

ReadFlaunchSDK.readFairLaunch

___

### readFairLaunchV1\_1

• `Readonly` **readFairLaunchV1\_1**: `ReadFairLaunchV1_1`

Inherited from

ReadFlaunchSDK.readFairLaunchV1_1

___

### readFlaunch

• `Readonly` **readFlaunch**: `ReadFlaunch`

Inherited from

ReadFlaunchSDK.readFlaunch

___

### readFlaunchV1\_1

• `Readonly` **readFlaunchV1\_1**: `ReadFlaunchV1_1`

Inherited from

ReadFlaunchSDK.readFlaunchV1_1

___

### readFlaunchZap

• `Readonly` **readFlaunchZap**: `ReadFlaunchZap`

Inherited from

ReadFlaunchSDK.readFlaunchZap

___

### readPermit2

• `Readonly` **readPermit2**: `ReadPermit2`

Inherited from

ReadFlaunchSDK.readPermit2

___

### readPoolManager

• `Readonly` **readPoolManager**: `ReadPoolManager`

Inherited from

ReadFlaunchSDK.readPoolManager

___

### readPositionManager

• `Readonly` **readPositionManager**: `ReadFlaunchPositionManager`

Inherited from

ReadFlaunchSDK.readPositionManager

___

### readPositionManagerV1\_1

• `Readonly` **readPositionManagerV1\_1**: `ReadFlaunchPositionManagerV1_1`

Inherited from

ReadFlaunchSDK.readPositionManagerV1_1

___

### readQuoter

• `Readonly` **readQuoter**: `ReadQuoter`

Inherited from

ReadFlaunchSDK.readQuoter

___

### readStateView

• `Readonly` **readStateView**: `ReadStateView`

Inherited from

ReadFlaunchSDK.readStateView

___

### readWriteFastFlaunchZap

• `Readonly` **readWriteFastFlaunchZap**: `ReadWriteFastFlaunchZap`

___

### readWriteFlaunchZap

• `Readonly` **readWriteFlaunchZap**: `ReadWriteFlaunchZap`

___

### readWritePermit2

• `Readonly` **readWritePermit2**: `ReadWritePermit2`

___

### readWritePositionManagerV1\_1

• `Readonly` **readWritePositionManagerV1\_1**: `ReadWriteFlaunchPositionManagerV1_1`

___

### readWriteTreasuryManagerFactory

• `Readonly` **readWriteTreasuryManagerFactory**: `ReadWriteTreasuryManagerFactory`

___

### resolveIPFS

• **resolveIPFS**: (`value`: `string`) => `string`

Type declaration

▸ (`value`): `string`

#Parameters

| Name | Type |
| :------ | :------ |
| `value` | `string` |

#Returns

`string`

Inherited from

ReadFlaunchSDK.resolveIPFS

## Methods

### bidWallPosition

▸ **bidWallPosition**(`coinAddress`, `isV1Coin?`): `Promise`\<\{ `coinAmount`: `bigint` ; `flETHAmount`: `bigint` ; `pendingEth`: `bigint` ; `tickLower`: `number` ; `tickUpper`: `number`  }\>

Gets information about the bid wall position for a coin

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<\{ `coinAmount`: `bigint` ; `flETHAmount`: `bigint` ; `pendingEth`: `bigint` ; `tickLower`: `number` ; `tickUpper`: `number`  }\>

Promise<{flETHAmount: bigint, coinAmount: bigint, pendingEth: bigint, tickLower: number, tickUpper: number}> - Bid wall position details

Inherited from

ReadFlaunchSDK.bidWallPosition

___

### buyCoin

▸ **buyCoin**(`params`, `isV1Coin?`): `Promise`\<\`0x$\{string}\`\>

Buys a coin with ETH

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `BuyCoinParams` | Parameters for buying the coin including amount, slippage, and referrer |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<\`0x$\{string}\`\>

Transaction response for the buy operation

___

### coinBalance

▸ **coinBalance**(`coinAddress`): `Promise`\<`bigint`\>

Gets the balance of a specific coin for the connected wallet

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin to check |

Returns

`Promise`\<`bigint`\>

Promise<bigint> - The balance of the coin

___

### coinPriceInETH

▸ **coinPriceInETH**(`coinAddress`, `isV1Coin?`): `Promise`\<`string`\>

Calculates the coin price in ETH based on the current tick

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<`string`\>

Promise<string> - The price of the coin in ETH with 18 decimals precision

Inherited from

ReadFlaunchSDK.coinPriceInETH

___

### currentTick

▸ **currentTick**(`coinAddress`, `isV1Coin?`): `Promise`\<`number`\>

Gets the current tick for a given coin's pool

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<`number`\>

Promise<number> - The current tick of the pool

Inherited from

ReadFlaunchSDK.currentTick

___

### deployRevenueManager

▸ **deployRevenueManager**(`params`): `Promise`\<\`0x$\{string}\`\>

Deploys a new revenue manager

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Object` | Parameters for deploying the revenue manager |
| `params.protocolFeePercent` | `number` | The percentage of the protocol fee |
| `params.protocolRecipient` | \`0x$\{string}\` | The address of the protocol recipient |

Returns

`Promise`\<\`0x$\{string}\`\>

Address of the deployed revenue manager

___

### ethRequiredToFlaunch

▸ **ethRequiredToFlaunch**(`params`): `Promise`\<`bigint`\>

Calculates the ETH required to flaunch a token, takes into account the ETH for premine and the flaunching fee

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Object` | - |
| `params.initialMarketCapUSD` | `number` | The initial market cap in USD |
| `params.premineAmount` | `bigint` | The amount of coins to be premined |
| `params.slippagePercent?` | `number` | The slippage percent |

Returns

`Promise`\<`bigint`\>

Promise<bigint> - The ETH required to flaunch

Inherited from

ReadFlaunchSDK.ethRequiredToFlaunch

___

### fairLaunchCoinOnlyPosition

▸ **fairLaunchCoinOnlyPosition**(`coinAddress`, `isV1Coin?`): `Promise`\<\{ `coinAmount`: `bigint` ; `flETHAmount`: `bigint` ; `tickLower`: `number` ; `tickUpper`: `number`  }\>

Gets information about the coin-only position in a fair launch

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<\{ `coinAmount`: `bigint` ; `flETHAmount`: `bigint` ; `tickLower`: `number` ; `tickUpper`: `number`  }\>

Promise<{flETHAmount: bigint, coinAmount: bigint, tickLower: number, tickUpper: number}> - Position details

Inherited from

ReadFlaunchSDK.fairLaunchCoinOnlyPosition

___

### fairLaunchDuration

▸ **fairLaunchDuration**(`coinAddress`, `isV1Coin?`): `Promise`\<`number` \| `bigint`\>

Gets the duration of a fair launch for a given coin

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<`number` \| `bigint`\>

Promise<number> - The duration in seconds (30 minutes for V1, variable for V1.1)

Inherited from

ReadFlaunchSDK.fairLaunchDuration

___

### fairLaunchETHOnlyPosition

▸ **fairLaunchETHOnlyPosition**(`coinAddress`, `isV1Coin?`): `Promise`\<\{ `coinAmount`: `bigint` ; `flETHAmount`: `bigint` ; `tickLower`: `number` ; `tickUpper`: `number`  }\>

Gets information about the ETH-only position in a fair launch

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<\{ `coinAmount`: `bigint` ; `flETHAmount`: `bigint` ; `tickLower`: `number` ; `tickUpper`: `number`  }\>

Promise<{flETHAmount: bigint, coinAmount: bigint, tickLower: number, tickUpper: number}> - Position details

Inherited from

ReadFlaunchSDK.fairLaunchETHOnlyPosition

___

### fairLaunchInfo

▸ **fairLaunchInfo**(`coinAddress`, `isV1Coin?`): `Promise`\<\{ `closed`: `boolean` ; `endsAt`: `bigint` ; `initialTick`: `number` ; `revenue`: `bigint` ; `startsAt`: `bigint` ; `supply`: `bigint`  }\>

Gets information about a fair launch for a given coin

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<\{ `closed`: `boolean` ; `endsAt`: `bigint` ; `initialTick`: `number` ; `revenue`: `bigint` ; `startsAt`: `bigint` ; `supply`: `bigint`  }\>

Fair launch information from the appropriate contract version

Inherited from

ReadFlaunchSDK.fairLaunchInfo

___

### fastFlaunch

▸ **fastFlaunch**(`params`): `Promise`\<\`0x$\{string}\`\>

Creates a new fast Flaunch on V1.1

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `FastFlaunchParams` | Parameters for creating the fast Flaunch |

Returns

`Promise`\<\`0x$\{string}\`\>

Transaction response

**`Throws`**

Error if FastFlaunchZap is not deployed on the current chain

___

### fastFlaunchIPFS

▸ **fastFlaunchIPFS**(`params`): `Promise`\<\`0x$\{string}\`\>

Creates a new fast Flaunch on V1.1 with IPFS metadata

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `FastFlaunchIPFSParams` | Parameters for creating the fast Flaunch with IPFS data |

Returns

`Promise`\<\`0x$\{string}\`\>

Transaction response

**`Throws`**

Error if FastFlaunchZap is not deployed on the current chain

___

### flETHIsCurrencyZero

▸ **flETHIsCurrencyZero**(`coinAddress`): `boolean`

Determines if flETH is currency0 in the pool

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |

Returns

`boolean`

boolean - True if flETH is currency0, false otherwise

Inherited from

ReadFlaunchSDK.flETHIsCurrencyZero

___

### flaunch

▸ **flaunch**(`params`): `Promise`\<\`0x$\{string}\`\>

Creates a new Flaunch on V1.1

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `FlaunchParams` | Parameters for creating the Flaunch |

Returns

`Promise`\<\`0x$\{string}\`\>

Transaction response

___

### flaunchIPFS

▸ **flaunchIPFS**(`params`): `Promise`\<\`0x$\{string}\`\>

Creates a new Flaunch on V1.1 with IPFS metadata

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `FlaunchIPFSParams` | Parameters for creating the Flaunch with IPFS data |

Returns

`Promise`\<\`0x$\{string}\`\>

Transaction response

___

### flaunchIPFSWithRevenueManager

▸ **flaunchIPFSWithRevenueManager**(`params`): `Promise`\<\`0x$\{string}\`\>

Creates a new Flaunch with revenue manager configuration and IPFS metadata

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `FlaunchWithRevenueManagerIPFSParams` | Parameters for creating the Flaunch with revenue manager and IPFS data |

Returns

`Promise`\<\`0x$\{string}\`\>

Transaction response

**`Throws`**

Error if FlaunchZap is not deployed on the current chain

___

### flaunchWithRevenueManager

▸ **flaunchWithRevenueManager**(`params`): `Promise`\<\`0x$\{string}\`\>

Creates a new Flaunch with revenue manager configuration

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `FlaunchWithRevenueManagerParams` | Parameters for creating the Flaunch with revenue manager |

Returns

`Promise`\<\`0x$\{string}\`\>

Transaction response

**`Throws`**

Error if FlaunchZap is not deployed on the current chain

___

### getBuyQuoteExactInput

▸ **getBuyQuoteExactInput**(`coinAddress`, `amountIn`, `isV1Coin?`): `Promise`\<`bigint`\>

Gets a quote for buying tokens with an exact amount of ETH

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the token to buy |
| `amountIn` | `bigint` | - |
| `isV1Coin?` | `boolean` | Optional flag to specify if token is V1. If not provided, V1.1 is assumed |

Returns

`Promise`\<`bigint`\>

Promise<bigint> - The expected amount of tokens to receive

Inherited from

ReadFlaunchSDK.getBuyQuoteExactInput

___

### getBuyQuoteExactOutput

▸ **getBuyQuoteExactOutput**(`coinAddress`, `amountOut`, `isV1Coin?`): `Promise`\<`bigint`\>

Gets a quote for buying an exact amount of tokens with ETH

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the token to buy |
| `amountOut` | `bigint` | - |
| `isV1Coin?` | `boolean` | Optional flag to specify if token is V1. If not provided, V1.1 is assumed |

Returns

`Promise`\<`bigint`\>

Promise<bigint> - The required amount of ETH to spend

Inherited from

ReadFlaunchSDK.getBuyQuoteExactOutput

___

### getCoinMetadata

▸ **getCoinMetadata**(`coinAddress`): `Promise`\<`CoinMetadata` & \{ `symbol`: `string`  }\>

Retrieves metadata for a given Flaunch coin

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |

Returns

`Promise`\<`CoinMetadata` & \{ `symbol`: `string`  }\>

Promise<CoinMetadata & { symbol: string }> - The coin's metadata including name, symbol, description, and social links

Inherited from

ReadFlaunchSDK.getCoinMetadata

___

### getCoinMetadataFromTokenId

▸ **getCoinMetadataFromTokenId**(`flaunch`, `tokenId`): `Promise`\<`CoinMetadata` & \{ `symbol`: `string`  }\>

Retrieves metadata for a given Flaunch coin using its token ID & Flaunch contract address

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `flaunch` | \`0x$\{string}\` | The address of the Flaunch contract |
| `tokenId` | `bigint` | The token ID of the coin |

Returns

`Promise`\<`CoinMetadata` & \{ `symbol`: `string`  }\>

The coin's metadata including name, symbol, description, and social links

Inherited from

ReadFlaunchSDK.getCoinMetadataFromTokenId

___

### getCoinMetadataFromTokenIds

▸ **getCoinMetadataFromTokenIds**(`params`, `batchSize?`, `batchDelay?`): `Promise`\<\{ `coinAddress`: \`0x$\{string}\` ; `collaborators`: `any` ; `description`: `any` ; `discordUrl`: `any` ; `external_link`: `any` ; `image`: `string` ; `name`: `string` ; `symbol`: `string` ; `telegramUrl`: `any` ; `twitterUrl`: `any`  }[]\>

Retrieves metadata for multiple Flaunch coins using their token IDs & Flaunch contract addresses

Parameters

| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `params` | \{ `flaunch`: \`0x$\{string}\` ; `tokenId`: `bigint`  }[] | `undefined` | An array of objects containing flaunch contract address and token ID |
| `batchSize` | `number` | `9` | Optional, the number of ipfs requests to process in each batch |
| `batchDelay` | `number` | `500` | Optional, the delay in milliseconds between batches |

Returns

`Promise`\<\{ `coinAddress`: \`0x$\{string}\` ; `collaborators`: `any` ; `description`: `any` ; `discordUrl`: `any` ; `external_link`: `any` ; `image`: `string` ; `name`: `string` ; `symbol`: `string` ; `telegramUrl`: `any` ; `twitterUrl`: `any`  }[]\>

An array of objects containing coin address, name, symbol, description, and social links

Inherited from

ReadFlaunchSDK.getCoinMetadataFromTokenIds

___

### getETHUSDCPrice

▸ **getETHUSDCPrice**(`drift?`): `Promise`\<`number`\>

Gets the current ETH/USDC price

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `drift?` | `Drift` | Optional drift instance to get price from Base Mainnet |

Returns

`Promise`\<`number`\>

Promise<number> - The current ETH/USDC price

Inherited from

ReadFlaunchSDK.getETHUSDCPrice

___

### getFlaunchingFee

▸ **getFlaunchingFee**(`params`): `Promise`\<`bigint`\>

Gets the flaunching fee for a given initial price and slippage percent

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Object` | - |
| `params.initialMarketCapUSD` | `number` | The initial market cap in USD |
| `params.sender` | \`0x$\{string}\` | The address of the sender |
| `params.slippagePercent?` | `number` | The slippage percent |

Returns

`Promise`\<`bigint`\>

Promise<bigint> - The flaunching fee

Inherited from

ReadFlaunchSDK.getFlaunchingFee

___

### getPermit2AllowanceAndNonce

▸ **getPermit2AllowanceAndNonce**(`coinAddress`): `Promise`\<\{ `allowance`: `bigint` = amount; `nonce`: `number`  }\>

Gets the current Permit2 allowance and nonce for a coin

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin to check |

Returns

`Promise`\<\{ `allowance`: `bigint` = amount; `nonce`: `number`  }\>

Promise<{allowance: bigint, nonce: bigint}> - Current allowance and nonce

___

### getPermit2TypedData

▸ **getPermit2TypedData**(`coinAddress`, `deadline?`): `Promise`\<\{ `permitSingle`: `PermitSingle` ; `typedData`: \{ `domain`: \{ `chainId`: `number` ; `name`: `string` ; `verifyingContract`: \`0x$\{string}\`  } ; `message`: `PermitSingle` ; `primaryType`: `string` ; `types`: \{ `PermitDetails`: \{ `name`: `string` = "token"; `type`: `string` = "address" }[] = PERMIT\_DETAILS; `PermitSingle`: \{ `name`: `string` = "details"; `type`: `string` = "PermitDetails" }[]  }  }  }\>

Gets the typed data for a Permit2 signature

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin to permit |
| `deadline?` | `bigint` | Optional deadline for the permit (defaults to 10 years) |

Returns

`Promise`\<\{ `permitSingle`: `PermitSingle` ; `typedData`: \{ `domain`: \{ `chainId`: `number` ; `name`: `string` ; `verifyingContract`: \`0x$\{string}\`  } ; `message`: `PermitSingle` ; `primaryType`: `string` ; `types`: \{ `PermitDetails`: \{ `name`: `string` = "token"; `type`: `string` = "address" }[] = PERMIT\_DETAILS; `PermitSingle`: \{ `name`: `string` = "details"; `type`: `string` = "PermitDetails" }[]  }  }  }\>

The typed data object for signing

___

### getSellQuoteExactInput

▸ **getSellQuoteExactInput**(`coinAddress`, `amountIn`, `isV1Coin?`): `Promise`\<`bigint`\>

Gets a quote for selling an exact amount of tokens for ETH

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the token to sell |
| `amountIn` | `bigint` | The exact amount of tokens to sell |
| `isV1Coin?` | `boolean` | Optional flag to specify if token is V1. If not provided, V1.1 is assumed |

Returns

`Promise`\<`bigint`\>

Promise<bigint> - The expected amount of ETH to receive

Inherited from

ReadFlaunchSDK.getSellQuoteExactInput

___

### initialTick

▸ **initialTick**(`coinAddress`, `isV1Coin?`): `Promise`\<`number`\>

Gets the initial tick for a fair launch

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<`number`\>

Promise<number> - The initial tick value

Inherited from

ReadFlaunchSDK.initialTick

___

### isFairLaunchActive

▸ **isFairLaunchActive**(`coinAddress`, `isV1Coin?`): `Promise`\<`boolean`\>

Checks if a fair launch is currently active for a given coin

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<`boolean`\>

Promise<boolean> - True if fair launch is active, false otherwise

Inherited from

ReadFlaunchSDK.isFairLaunchActive

___

### isV1Coin

▸ **isV1Coin**(`coinAddress`): `Promise`\<`boolean`\>

Checks if a given coin address is a V1 Flaunch coin

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin to check |

Returns

`Promise`\<`boolean`\>

Promise<boolean> - True if the coin is V1, false if V1.1

Inherited from

ReadFlaunchSDK.isV1Coin

___

### isValidCoin

▸ **isValidCoin**(`coinAddress`): `Promise`\<`boolean`\>

Checks if a given coin address is a valid Flaunch coin (either V1 or V1.1)

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin to check |

Returns

`Promise`\<`boolean`\>

Promise<boolean> - True if the coin is valid, false otherwise

Inherited from

ReadFlaunchSDK.isValidCoin

___

### pollPoolCreatedNow

▸ **pollPoolCreatedNow**(): `undefined` \| `Promise`\<`void`\>

Polls for current pool creation events on V1.1 contracts

Returns

`undefined` \| `Promise`\<`void`\>

Current pool creation events or undefined if polling is not available

Inherited from

ReadFlaunchSDK.pollPoolCreatedNow

___

### pollPoolCreatedNowV1

▸ **pollPoolCreatedNowV1**(): `undefined` \| `Promise`\<`void`\>

Polls for current pool creation events on V1 contracts

Returns

`undefined` \| `Promise`\<`void`\>

Current pool creation events or undefined if polling is not available

Inherited from

ReadFlaunchSDK.pollPoolCreatedNowV1

___

### pollPoolSwapNow

▸ **pollPoolSwapNow**(): `undefined` \| `Promise`\<`void`\>

Polls for current pool swap events on V1.1 contracts

Returns

`undefined` \| `Promise`\<`void`\>

Current pool swap events or undefined if polling is not available

Inherited from

ReadFlaunchSDK.pollPoolSwapNow

___

### pollPoolSwapNowV1

▸ **pollPoolSwapNowV1**(): `undefined` \| `Promise`\<`void`\>

Polls for current pool swap events on V1 contracts

Returns

`undefined` \| `Promise`\<`void`\>

Current pool swap events or undefined if polling is not available

Inherited from

ReadFlaunchSDK.pollPoolSwapNowV1

___

### poolId

▸ **poolId**(`coinAddress`, `isV1Coin?`): `Promise`\<\`0x$\{string}\`\>

Gets the pool ID for a given coin

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `coinAddress` | \`0x$\{string}\` | The address of the coin |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<\`0x$\{string}\`\>

Promise<string> - The pool ID

Inherited from

ReadFlaunchSDK.poolId

___

### positionInfo

▸ **positionInfo**(`params`): `Promise`\<\{ `feeGrowthInside0LastX128`: `bigint` ; `feeGrowthInside1LastX128`: `bigint` ; `liquidity`: `bigint`  } \| \{ `feeGrowthInside0LastX128`: `bigint` ; `feeGrowthInside1LastX128`: `bigint` ; `liquidity`: `bigint`  }\>

Gets information about a liquidity position

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `PositionInfoParams` | Parameters for querying position info |

Returns

`Promise`\<\{ `feeGrowthInside0LastX128`: `bigint` ; `feeGrowthInside1LastX128`: `bigint` ; `liquidity`: `bigint`  } \| \{ `feeGrowthInside0LastX128`: `bigint` ; `feeGrowthInside1LastX128`: `bigint` ; `liquidity`: `bigint`  }\>

Position information from the state view contract

Inherited from

ReadFlaunchSDK.positionInfo

___

### revenueManagerAllTokensByCreator

▸ **revenueManagerAllTokensByCreator**(`params`): `Promise`\<readonly \{ `flaunch`: \`0x$\{string}\` ; `tokenId`: `bigint`  }[]\>

Gets all tokens created by a specific creator address

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Object` | Parameters for querying tokens by creator |
| `params.creator` | \`0x$\{string}\` | The address of the creator to query tokens for |
| `params.revenueManagerAddress` | \`0x$\{string}\` | The address of the revenue manager |
| `params.sortByDesc?` | `boolean` | Whether to sort the tokens by descending order |

Returns

`Promise`\<readonly \{ `flaunch`: \`0x$\{string}\` ; `tokenId`: `bigint`  }[]\>

Promise<Array<{flaunch: Address, tokenId: bigint}>> - Array of token objects containing flaunch address and token ID

Inherited from

ReadFlaunchSDK.revenueManagerAllTokensByCreator

___

### revenueManagerAllTokensInManager

▸ **revenueManagerAllTokensInManager**(`params`): `Promise`\<\{ `flaunch`: \`0x$\{string}\` ; `tokenId`: `bigint`  }[]\>

Gets all tokens currently managed by a revenue manager

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Object` | Parameters for querying tokens in manager |
| `params.revenueManagerAddress` | \`0x$\{string}\` | The address of the revenue manager |
| `params.sortByDesc?` | `boolean` | Optional boolean to sort tokens in descending order (default: false) |

Returns

`Promise`\<\{ `flaunch`: \`0x$\{string}\` ; `tokenId`: `bigint`  }[]\>

Promise<Array<{flaunch: Address, tokenId: bigint}>> - Array of token objects containing flaunch address and token ID

Inherited from

ReadFlaunchSDK.revenueManagerAllTokensInManager

___

### revenueManagerBalance

▸ **revenueManagerBalance**(`params`): `Promise`\<`bigint`\>

Gets the claimable balance of ETH for the recipient from a revenue manager

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Object` | Parameters for checking the balance |
| `params.recipient` | \`0x$\{string}\` | The address of the recipient to check |
| `params.revenueManagerAddress` | \`0x$\{string}\` | The address of the revenue manager |

Returns

`Promise`\<`bigint`\>

Promise<bigint> - The claimable balance of ETH

Inherited from

ReadFlaunchSDK.revenueManagerBalance

___

### revenueManagerCreatorClaim

▸ **revenueManagerCreatorClaim**(`params`): `Promise`\<\`0x$\{string}\`\>

Claims the total creator's share of the revenue from a revenue manager

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Object` | Parameters for claiming the creator's share of the revenue |
| `params.revenueManagerAddress` | \`0x$\{string}\` | - |

Returns

`Promise`\<\`0x$\{string}\`\>

Transaction response

___

### revenueManagerCreatorClaimForTokens

▸ **revenueManagerCreatorClaimForTokens**(`params`): `Promise`\<\`0x$\{string}\`\>

Claims the creator's share of the revenue from specific flaunch tokens

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Object` | Parameters for claiming the creator's share of the revenue |
| `params.flaunchTokens` | \{ `flaunch`: \`0x$\{string}\` ; `tokenId`: `bigint`  }[] | - |
| `params.revenueManagerAddress` | \`0x$\{string}\` | - |

Returns

`Promise`\<\`0x$\{string}\`\>

Transaction response

___

### revenueManagerProtocolBalance

▸ **revenueManagerProtocolBalance**(`revenueManagerAddress`): `Promise`\<`bigint`\>

Gets the claimable balance of ETH for the protocol from a revenue manager

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `revenueManagerAddress` | \`0x$\{string}\` | The address of the revenue manager |

Returns

`Promise`\<`bigint`\>

Promise<bigint> - The claimable balance of ETH

Inherited from

ReadFlaunchSDK.revenueManagerProtocolBalance

___

### revenueManagerProtocolClaim

▸ **revenueManagerProtocolClaim**(`params`): `Promise`\<\`0x$\{string}\`\>

Claims the protocol's share of the revenue

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Object` | Parameters for claiming the protocol's share of the revenue |
| `params.revenueManagerAddress` | \`0x$\{string}\` | - |

Returns

`Promise`\<\`0x$\{string}\`\>

Transaction response

___

### revenueManagerTokensCount

▸ **revenueManagerTokensCount**(`revenueManagerAddress`): `Promise`\<`bigint`\>

Gets the total number of tokens managed by a revenue manager

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `revenueManagerAddress` | \`0x$\{string}\` | The address of the revenue manager |

Returns

`Promise`\<`bigint`\>

Promise<bigint> - The total count of tokens

Inherited from

ReadFlaunchSDK.revenueManagerTokensCount

___

### sellCoin

▸ **sellCoin**(`params`, `isV1Coin?`): `Promise`\<\`0x$\{string}\`\>

Sells a coin for ETH

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `SellCoinParams` | Parameters for selling the coin including amount, slippage, permit data, and referrer |
| `isV1Coin?` | `boolean` | Optional flag to specify if coin is V1. If not provided, will be determined automatically |

Returns

`Promise`\<\`0x$\{string}\`\>

Transaction response for the sell operation

___

### setIPFSResolver

▸ **setIPFSResolver**(`resolverFn`): `void`

Sets a custom IPFS resolver function

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `resolverFn` | (`ipfsHash`: `string`) => `string` | Custom function to resolve IPFS URIs |

Returns

`void`

**`Dev`**

this is used to resolve IPFS hash to a gateway URL
eg: input: Qabc, output: https://ipfs.io/ipfs/Qabc

Inherited from

ReadFlaunchSDK.setIPFSResolver

___

### watchPoolCreated

▸ **watchPoolCreated**(`params`): `Promise`\<\{ `cleanup`: () => `void` ; `pollPoolCreatedNow`: () => `Promise`\<`void`\> = pollEvents }\>

Watches for pool creation events on V1.1 contracts

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `WatchPoolCreatedParams` | Parameters for watching pool creation |

Returns

`Promise`\<\{ `cleanup`: () => `void` ; `pollPoolCreatedNow`: () => `Promise`\<`void`\> = pollEvents }\>

Subscription to pool creation events

Inherited from

ReadFlaunchSDK.watchPoolCreated

___

### watchPoolCreatedV1

▸ **watchPoolCreatedV1**(`params`): `Promise`\<\{ `cleanup`: () => `void` ; `pollPoolCreatedNow`: () => `Promise`\<`void`\> = pollEvents }\>

Watches for pool creation events on V1 contracts

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `WatchPoolCreatedParams` | Parameters for watching pool creation |

Returns

`Promise`\<\{ `cleanup`: () => `void` ; `pollPoolCreatedNow`: () => `Promise`\<`void`\> = pollEvents }\>

Subscription to pool creation events

Inherited from

ReadFlaunchSDK.watchPoolCreatedV1

___

### watchPoolSwap

▸ **watchPoolSwap**(`params`): `Promise`\<\{ `cleanup`: () => `void` ; `pollPoolSwapNow`: () => `Promise`\<`void`\> = pollEvents }\>

Watches for pool swap events on V1.1 contracts

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `WatchPoolSwapParams` | Parameters for watching pool swaps including optional coin filter |

Returns

`Promise`\<\{ `cleanup`: () => `void` ; `pollPoolSwapNow`: () => `Promise`\<`void`\> = pollEvents }\>

Subscription to pool swap events

Inherited from

ReadFlaunchSDK.watchPoolSwap

___

### watchPoolSwapV1

▸ **watchPoolSwapV1**(`params`): `Promise`\<\{ `cleanup`: () => `void` ; `pollPoolSwapNow`: () => `Promise`\<`void`\> = pollEvents }\>

Watches for pool swap events on V1 contracts

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `WatchPoolSwapParams` | Parameters for watching pool swaps including optional coin filter |

Returns

`Promise`\<\{ `cleanup`: () => `void` ; `pollPoolSwapNow`: () => `Promise`\<`void`\> = pollEvents }\>

Subscription to pool swap events

Inherited from

ReadFlaunchSDK.watchPoolSwapV1



---

@flaunch/sdk - v0.7.0 / Exports / PinataConfig

# Interface: PinataConfig

## Table of contents

### Properties

- jwt

## Properties

### jwt

• **jwt**: `string`



---

@flaunch/sdk - v0.7.0 / Exports

# @flaunch/sdk - v0.7.0

## Table of contents

### Classes

- ReadFlaunchSDK
- ReadWriteFlaunchSDK

### Interfaces

- PinataConfig

### Type Aliases

- BuySwapLog
- CreateFlaunchParams
- PoolCreatedLogs
- SellSwapLog

### Variables

- BidWallAddress
- BidWallV1\_1Address
- FLETHAddress
- FLETHHooksAddress
- FairLaunchAddress
- FairLaunchV1\_1Address
- FastFlaunchZapAddress
- FlaunchAddress
- FlaunchPositionManagerAddress
- FlaunchPositionManagerV1\_1Address
- FlaunchSDK
- FlaunchV1\_1Address
- FlaunchZapAddress
- Permit2Address
- PoolManagerAddress
- QuoterAddress
- RevenueManagerAddress
- StateViewAddress
- TICK\_SPACING
- TickFinder
- TreasuryManagerFactoryAddress
- USDCETHPoolKeys
- UniversalRouterAddress
- chainIdToChain

### Functions

- bytes32ToUint256
- calculateUnderlyingTokenBalances
- createFlaunch
- generateTokenUri
- getPoolId
- getSqrtPriceX96FromTick
- getValidTick
- orderPoolKey
- resolveIPFS
- uint256ToBytes32
- uploadFileToIPFS
- uploadImageToIPFS
- uploadJsonToIPFS

## Type Aliases

### BuySwapLog

Ƭ **BuySwapLog**: `BaseSwapLog` & \{ `delta`: \{ `coinsBought`: `bigint` ; `fees`: \{ `amount`: `bigint` ; `isInFLETH`: `boolean`  } ; `flETHSold`: `bigint`  } ; `type`: ``"BUY"``  }

___

### CreateFlaunchParams

Ƭ **CreateFlaunchParams**: `Object`

Type declaration

| Name | Type |
| :------ | :------ |
| `publicClient` | `PublicClient` |
| `walletClient?` | `WalletClient` |

___

### PoolCreatedLogs

Ƭ **PoolCreatedLogs**: `PoolCreatedLog`[]

___

### SellSwapLog

Ƭ **SellSwapLog**: `BaseSwapLog` & \{ `delta`: \{ `coinsSold`: `bigint` ; `fees`: \{ `amount`: `bigint` ; `isInFLETH`: `boolean`  } ; `flETHBought`: `bigint`  } ; `type`: ``"SELL"``  }

## Variables

### BidWallAddress

• `Const` **BidWallAddress**: `Addresses`

___

### BidWallV1\_1Address

• `Const` **BidWallV1\_1Address**: `Addresses`

___

### FLETHAddress

• `Const` **FLETHAddress**: `Addresses`

___

### FLETHHooksAddress

• `Const` **FLETHHooksAddress**: `Addresses`

___

### FairLaunchAddress

• `Const` **FairLaunchAddress**: `Addresses`

___

### FairLaunchV1\_1Address

• `Const` **FairLaunchV1\_1Address**: `Addresses`

___

### FastFlaunchZapAddress

• `Const` **FastFlaunchZapAddress**: `Addresses`

___

### FlaunchAddress

• `Const` **FlaunchAddress**: `Addresses`

___

### FlaunchPositionManagerAddress

• `Const` **FlaunchPositionManagerAddress**: `Addresses`

___

### FlaunchPositionManagerV1\_1Address

• `Const` **FlaunchPositionManagerV1\_1Address**: `Addresses`

___

### FlaunchSDK

• `Const` **FlaunchSDK**: `Object`

Type declaration

| Name | Type |
| :------ | :------ |
| `ReadFlaunchSDK` | typeof `ReadFlaunchSDK` |
| `ReadWriteFlaunchSDK` | typeof `ReadWriteFlaunchSDK` |

___

### FlaunchV1\_1Address

• `Const` **FlaunchV1\_1Address**: `Addresses`

___

### FlaunchZapAddress

• `Const` **FlaunchZapAddress**: `Addresses`

___

### Permit2Address

• `Const` **Permit2Address**: `Addresses`

___

### PoolManagerAddress

• `Const` **PoolManagerAddress**: `Addresses`

___

### QuoterAddress

• `Const` **QuoterAddress**: `Addresses`

___

### RevenueManagerAddress

• `Const` **RevenueManagerAddress**: `Addresses`

___

### StateViewAddress

• `Const` **StateViewAddress**: `Addresses`

___

### TICK\_SPACING

• `Const` **TICK\_SPACING**: ``60``

___

### TickFinder

• `Const` **TickFinder**: `Object`

Type declaration

| Name | Type |
| :------ | :------ |
| `MAX_TICK` | `number` |
| `MIN_TICK` | `number` |

___

### TreasuryManagerFactoryAddress

• `Const` **TreasuryManagerFactoryAddress**: `Addresses`

___

### USDCETHPoolKeys

• `Const` **USDCETHPoolKeys**: `Object`

Index signature

▪ [chainId: `number`]: `PoolKey`

___

### UniversalRouterAddress

• `Const` **UniversalRouterAddress**: `Addresses`

___

### chainIdToChain

• `Const` **chainIdToChain**: `Object`

Index signature

▪ [key: `number`]: `Chain`

## Functions

### bytes32ToUint256

▸ **bytes32ToUint256**(`value`): `bigint`

Parameters

| Name | Type |
| :------ | :------ |
| `value` | \`0x$\{string}\` |

Returns

`bigint`

___

### calculateUnderlyingTokenBalances

▸ **calculateUnderlyingTokenBalances**(`liquidity`, `tickLower`, `tickUpper`, `tickCurrent`): `Object`

Parameters

| Name | Type |
| :------ | :------ |
| `liquidity` | `bigint` |
| `tickLower` | `number` |
| `tickUpper` | `number` |
| `tickCurrent` | `number` |

Returns

`Object`

| Name | Type |
| :------ | :------ |
| `amount0` | `bigint` |
| `amount1` | `bigint` |

___

### createFlaunch

▸ **createFlaunch**(`params`): `ReadFlaunchSDK`

Creates a read-only Flaunch SDK instance with only public client

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Omit`\<`CreateFlaunchParams`, ``"walletClient"``\> | Parameters with only publicClient |

Returns

`ReadFlaunchSDK`

ReadFlaunchSDK for read-only operations

**`Throws`**

Error if publicClient.chain is not configured

▸ **createFlaunch**(`params`): `ReadWriteFlaunchSDK`

Creates a read-write Flaunch SDK instance with both public and wallet clients

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Required`\<`CreateFlaunchParams`\> | Parameters with both publicClient and walletClient |

Returns

`ReadWriteFlaunchSDK`

ReadWriteFlaunchSDK for read and write operations

**`Throws`**

Error if publicClient.chain is not configured

___

### generateTokenUri

▸ **generateTokenUri**(`name`, `params`): `Promise`\<`string`\>

Parameters

| Name | Type |
| :------ | :------ |
| `name` | `string` |
| `params` | `IPFSParams` |

Returns

`Promise`\<`string`\>

___

### getPoolId

▸ **getPoolId**(`poolKey`): \`0x$\{string}\`

Parameters

| Name | Type |
| :------ | :------ |
| `poolKey` | `PoolKey` |

Returns

\`0x$\{string}\`

___

### getSqrtPriceX96FromTick

▸ **getSqrtPriceX96FromTick**(`tick`): `bigint`

Parameters

| Name | Type |
| :------ | :------ |
| `tick` | `number` |

Returns

`bigint`

___

### getValidTick

▸ **getValidTick**(`«destructured»`): `number`

Parameters

| Name | Type |
| :------ | :------ |
| `«destructured»` | `Object` |
| › `roundDown` | `boolean` |
| › `tick` | `number` |
| › `tickSpacing` | `number` |

Returns

`number`

___

### orderPoolKey

▸ **orderPoolKey**(`poolKey`): `Object`

Parameters

| Name | Type |
| :------ | :------ |
| `poolKey` | `PoolKey` |

Returns

`Object`

| Name | Type |
| :------ | :------ |
| `currency0` | \`0x$\{string}\` |
| `currency1` | \`0x$\{string}\` |
| `fee` | `number` |
| `hooks` | \`0x$\{string}\` |
| `tickSpacing` | `number` |

___

### resolveIPFS

▸ **resolveIPFS**(`value`): `string`

Parameters

| Name | Type |
| :------ | :------ |
| `value` | `string` |

Returns

`string`

___

### uint256ToBytes32

▸ **uint256ToBytes32**(`value`): \`0x$\{string}\`

Parameters

| Name | Type |
| :------ | :------ |
| `value` | `bigint` |

Returns

\`0x$\{string}\`

___

### uploadFileToIPFS

▸ **uploadFileToIPFS**(`params`): `Promise`\<`UploadResponse`\>

Uploads a file to IPFS using Pinata

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Object` | Configuration and file data |
| `params.file` | `File` | - |
| `params.metadata?` | `Record`\<`string`, `string`\> | - |
| `params.name?` | `string` | - |
| `params.pinataConfig` | `PinataConfig` | - |

Returns

`Promise`\<`UploadResponse`\>

Upload response with CID and other details

___

### uploadImageToIPFS

▸ **uploadImageToIPFS**(`params`): `Promise`\<`UploadResponse`\>

Uploads a base64 image to IPFS using Pinata

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Object` | Configuration and base64 image data |
| `params.base64Image` | `string` | - |
| `params.metadata?` | `Record`\<`string`, `string`\> | - |
| `params.name?` | `string` | - |
| `params.pinataConfig` | `PinataConfig` | - |

Returns

`Promise`\<`UploadResponse`\>

Upload response with CID and other details

___

### uploadJsonToIPFS

▸ **uploadJsonToIPFS**(`params`): `Promise`\<`UploadResponse`\>

Uploads JSON data to IPFS using Pinata

Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `params` | `Object` | Configuration and JSON data |
| `params.json` | `Record`\<`string`, `any`\> | - |
| `params.metadata?` | `Record`\<`string`, `string`\> | - |
| `params.name?` | `string` | - |
| `params.pinataConfig` | `PinataConfig` | - |

Returns

`Promise`\<`UploadResponse`\>

Upload response with CID and other details



---