amm.watchBurn
Watches for liquidity burn events on the Fee AMM.
Usage
import { } from './viem.config'
const = .amm.watchBurn({
: (, ) => {
.('User token amount:', .amountUserToken)
.('Validator token amount:', .amountValidatorToken)
.('Liquidity burned:', .liquidity)
.('Sender:', .sender)
.('Recipient:', .to)
.('User token:', .userToken)
.('Validator token:', .validatorToken)
},
})
// Later, stop watching
()Return Type
type ReturnType = () => voidReturns a function to unsubscribe from the event.
Parameters
onBurn
- Type:
function
declare function onBurn(args: Args, log: Log): void
type Args = {
/** Amount of user token received */
amountUserToken: bigint
/** Amount of validator token received */
amountValidatorToken: bigint
/** Amount of LP tokens burned */
liquidity: bigint
/** Address that removed liquidity */
sender: Address
/** Address that received the tokens */
to: Address
/** Address of the user token */
userToken: Address
/** Address of the validator token */
validatorToken: Address
}Callback to invoke when liquidity is removed.
args (optional)
- Type:
object
type Args = {
/** Filter by sender address */
sender?: Address | Address[] | null
/** Filter by user token address */
userToken?: Address | Address[] | null
/** Filter by validator token address */
validatorToken?: Address | Address[] | null
}Filter events by indexed parameters.
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:
function
declare function onError(error: Error): voidThe callback to call when an error occurred when trying to get for a new block.
poll (optional)
- Type:
true
Enable polling mode.
pollingInterval (optional)
- Type:
number
Polling frequency (in ms). Defaults to Client's pollingInterval config.