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