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

An sdk for interacting with contracts using Ulysses Protocol

import { SupportedChainId } from 'maia-core-sdk';
import { TRedeemParams } from 'maia-v2-sdk';
import { IAction, IActionResult } from '../../../../utils/action';
/**
 * @title RedeemAction class
 * @notice Provides a set of functions to encode calldata to redeem $Maia for $vMaia using VoteMaia contract.
 * @author MaiaDAO
 */
export declare class RedeemAction implements IAction<TRedeemParams, IActionResult<void>> {
    params: TRedeemParams;
    chainId?: SupportedChainId;
    /**
     * Constructor for the RedeemAction class.
     * @param params the parameters for the redeem action in the VoteMaia contract.
     * @returns a new instance of RedeemAction.
     * @notice the constructor is used to set the parameters for the redeem $vMaia action.
     */
    constructor(params: TRedeemParams, chainId?: SupportedChainId);
    /**
     * Encodes the contract interaction calldata to redeem $vMaia in exchange $Maia.
     * @param params the parameters for the redeem vMaia action.
     * @returns the target contract, encoded calldata and message value to send onchain for the redeem vMaia action.
     */
    encode(params: TRedeemParams): IActionResult<IActionResult<void>>;
}