ulysses-actions-sdk/dist/entities/ulyssesActions/vMaia/actions/forfeitWeight.d.ts

An sdk for interacting with contracts using Ulysses Protocol

import { SupportedChainId } from 'maia-core-sdk';
import { TForfeitParams } from 'maia-v2-sdk';
import { IAction, IActionResult } from '../../../../utils/action';
/**
 * @title ForfeitWeightAction class
 * @notice Provides a set of functions to encode calldata to forfeit an amount of weight utility tokens back into the VoteMaia contract.
 * @author MaiaDAO
 */
export declare class ForfeitWeightAction implements IAction<TForfeitParams, IActionResult<void>> {
    params: TForfeitParams;
    chainId?: SupportedChainId;
    /**
     * Constructor for the ForfeitWeightAction class.
     * @param params the parameters for the forfeit weight action in the VoteMaia contract.
     * @returns a new instance of ForfeitWeightAction.
     * @notice the constructor is used to set the parameters for the forfeit weight action.
     */
    constructor(params: TForfeitParams, chainId?: SupportedChainId);
    /**
     * Encodes the contract interaction calldata to forfeit weight utility tokens into the VoteMaia contract.
     * @param params the parameters for the forfeit weight action.
     * @returns the target contract, encoded calldata and message value to send onchain for the forfeit weight action.
     */
    encode(params: TForfeitParams): IActionResult<IActionResult<void>>;
}