ulysses-actions-sdk
Version:
An sdk for interacting with contracts using Ulysses Protocol
26 lines (25 loc) • 1.32 kB
TypeScript
import { TUnstakeTokenParams } from 'hermes-v2-sdk';
import { SupportedChainId } from 'maia-core-sdk';
import { IAction, IActionResult } from '../../../../utils/action';
/**
* @title UnstakeTokenAction class
* @notice Provides a set of function to encode calldata for the unstake token action in UniswapV3Staker contract.
* @author MaiaDAO
*/
export declare class UnstakeTokenAction implements IAction<TUnstakeTokenParams, IActionResult<void>> {
params: TUnstakeTokenParams;
chainId?: SupportedChainId;
/**
* Constructor for the UnstakeTokenAction class.
* @param params the parameters for the unstake token action in UniswapV3Staker.
* @returns a new instance of UnstakeTokenAction.
* @notice the constructor is used to set the parameters for the unstake token action in UniswapV3Staker.
*/
constructor(params: TUnstakeTokenParams, chainId?: SupportedChainId);
/**
* Encodes the contract interaction calldata to increment a gauge in UniswapV3Staker.
* @param params the parameters for the unstake token action in UniswapV3Staker.
* @returns the target contract, encoded calldata and message value to send onchain for the unstake token action.
*/
encode(params: TUnstakeTokenParams): IActionResult<IActionResult<void>>;
}