UniDevKit - v1.0.12
    Preparing search index...

    Class UniDevKitV4

    Main class for interacting with Uniswap V4 contracts. Provides a flexible and scalable way to interact with different chains and contracts without requiring multiple instances.

    Index

    Constructors

    constructor

    Methods

    buildAddLiquidityCallData buildRemoveLiquidityCallData buildSwapCallData getChainId getClient getContractAbi getContractAddress getContracts getPool getPoolKeyFromPoolId getPosition getQuote getTokens preparePermit2BatchData preparePermit2Data

    Constructors

    Methods

    • Builds a add liquidity call data for a given add liquidity parameters.

      Parameters

      • params: BaseAddLiquidityParams

      Returns Promise<BuildAddLiquidityCallDataResult>

      Promise resolving to add liquidity call data including calldata and value

      Error if SDK instance is not found or if add liquidity call data is invalid

    • Builds a remove liquidity call data for a given remove liquidity parameters.

      Parameters

      • params: BuildRemoveLiquidityCallDataParams

      Returns Promise<{ calldata: string; value: string }>

      Promise resolving to remove liquidity call data including calldata and value

      Error if SDK instance is not found or if remove liquidity call data is invalid

    • Builds a swap call data for a given swap parameters.

      Parameters

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

      Promise resolving to swap call data including calldata and value

      Error if SDK instance is not found or if swap call data is invalid

    • Returns the current chain ID.

      Returns number

      The chain ID currently configured.

    • Returns the current PublicClient instance.

      Returns {}

      The current PublicClient.

    • Retrieves the ABI for a specific contract. This method uses dynamic imports to load ABIs on demand, reducing the initial bundle size.

      Parameters

      Returns Promise<Abi>

      Promise resolving to the contract's ABI

      Will throw an error if the contract ABI is not found

      const poolManagerAbi = await uniDevKit.getContractAbi('poolManager');

    • Returns the address of a specific contract.

      Parameters

      Returns `0x${string}`

      The address of the specified contract.

      Will throw an error if the contract address is not found.

    • Retrieves a Uniswap V4 pool instance for a given token pair.

      Parameters

      Returns Promise<Pool>

      Promise resolving to pool data

      Error if pool data cannot be fetched

    • Retrieves token information for a given array of token addresses.

      Parameters

      • params: GetTokensParams

      Returns Promise<Currency[]>

      Promise resolving to Token instances for each token address.

      Error if token data cannot be fetched

    • Prepares the permit2 batch data for multiple tokens. (Used to add liquidity) Use toSign.values to sign the permit2 batch data.

      Parameters

      • params: PreparePermit2BatchDataParams

      Returns Promise<PreparePermit2BatchDataResult>

      Promise resolving to permit2 batch data

      Error if SDK instance is not found or if permit2 batch data is invalid

    • Prepares the permit2 simple data for a single token. (Used to swap) Use toSign.values to sign the permit2 simple data.

      Parameters

      • params: PreparePermit2DataParams

      Returns Promise<PreparePermit2DataResult>

      Promise resolving to permit2 simple data

      Error if SDK instance is not found or if permit2 simple data is invalid

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods