amm.watchMint

Watches for liquidity mint events on the Fee AMM.

Usage

import { client } from './viem.config'
 
const unwatch = client.amm.watchMint({
  onMint: (args, log) => {
    console.log('Liquidity minted:', args.liquidity)
    console.log('Sender:', args.sender)
    console.log('User token amount:', args.amountValidatorToken)
  },
})
 
// Later, stop watching
unwatch()

Return Type

type ReturnType = () => void

Returns a function to unsubscribe from the event.

Parameters

onMint

• Type:

declare function onMint(args: Args, log: Log): void
 
type Args = {
  /** Amount of LP tokens minted */
  liquidity: bigint
  /** Address that added liquidity */
  sender: Address
  /** User token details */
  userToken: {
    /** Address of the user token */
    address: Address
    /** Amount of user token added */
    amount: bigint
  }
  /** Validator token details */
  validatorToken: {
    /** Address of the validator token */
    address: Address
    /** Amount of validator token added */
    amount: bigint
  }
}

Callback to invoke when liquidity is added.

sender (optional)

• Type: Address | bigint

Address or ID of the sender to filter events.

userToken (optional)

• Type: Address | bigint

Address or ID of the user token to filter events.

validatorToken (optional)

• Type: Address | bigint

Address or ID of the validator token to filter events.

fromBlock (optional)

• Type: bigint

Block to start listening from.

onError (optional)

• Type: (error: Error) => void

The callback to call when an error occurred when trying to get for a new block.

poll (optional)

• Type: true

Enable polling mode for watching events.

pollingInterval (optional)

• Type: number

Polling frequency (in ms). Defaults to Client's pollingInterval config.