UNPKG

ulysses-actions-sdk

Version:

An sdk for interacting with contracts using Ulysses Protocol

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