UNPKG

ulysses-actions-sdk

Version:

An sdk for interacting with contracts using Ulysses Protocol

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