ulysses-actions-sdk
Version:
An sdk for interacting with contracts using Ulysses Protocol
25 lines (24 loc) • 1.16 kB
TypeScript
import { IAction, IActionResult } from '../../../../utils/action';
/**
* @title ClaimRewardAction class
* @notice Provides a set of function to encode calldata for the claim reward action from a Flywheel contract.
* @author MaiaDAO
*/
export declare class ClaimRewardsAction implements IAction<string, IActionResult<void>> {
target: string;
params: string;
/**
* Constructor for the ClaimRewardsAction class.
* @param flywheel the address of the flywheel contract.
* @param recipient the recipient for the claim rewards.
* @returns a new instance of ClaimRewardsAction.
* @notice the constructor is used to set the parameters for the claim rewards action in the flywheel.
*/
constructor(flywheel: string, recipient: string);
/**
* Encodes the contract interaction calldata to claim rewards from a flywheel contract.
* @param recipient the recipient for the claim rewards action.
* @returns the target contract, encoded calldata and message value to send onchain for the claim rewards action.
*/
encode(recipient: string): IActionResult<IActionResult<void>>;
}