ulysses-actions-sdk/dist/entities/ulyssesActions/bHermes/actions/burn.d.ts

An sdk for interacting with contracts using Ulysses Protocol

import { TBurnHermesParams } from 'hermes-v2-sdk';
import { SupportedChainId } from 'maia-core-sdk';
import { IAction, IActionResult } from '../../../../utils/action';
/**
 * @title BurnHermesAction class
 * @notice Provides a set of function to encode calldata for the burn action in bHermes contract.
 * @author MaiaDAO
 */
export declare class BurnHermesAction implements IAction<TBurnHermesParams, IActionResult<void>> {
    params: TBurnHermesParams;
    chainId?: SupportedChainId;
    /**
     * Constructor for the BurnHermesAction class.
     * @param params the parameters for the burn action in bHermes.
     * @returns a new instance of BurnHermesAction.
     * @notice the constructor is used to set the parameters for the burn action in bHermes.
     */
    constructor(params: TBurnHermesParams, chainId?: SupportedChainId);
    /**
     * Encodes the contract interaction calldata to burn $Hermes in exchange for $bHermes.
     * @param params the parameters for the burn action in bHermes.
     * @returns the target contract, encoded calldata and message value to send to Branch Router for the burn action.
     */
    encode(params: TBurnHermesParams): IActionResult<IActionResult<void>>;
}