opnet/src/abi/shared/interfaces/generic/IStackingContract.ts

The perfect library for building Bitcoin-based applications.

import { Address } from '@btc-vision/transaction';
import { CallResult } from '../../../../contracts/CallResult.js';

/**
 * @description This interface represents the WBTC contract.
 * @interface IWBTCContract
 * @extends {CallResult}
 * @cathegory Contracts
 */
export interface IStackingContract {
    stake(amount: bigint): Promise<CallResult<{ success: boolean }>>;

    unstake(): Promise<CallResult<{ success: boolean }>>;

    stakedAmount(address: Address): Promise<CallResult<{ amount: bigint }>>;

    stakedReward(address: Address): Promise<CallResult<{ amount: bigint }>>;

    claim(): Promise<CallResult<{ success: boolean }>>;

    rewardPool(): Promise<CallResult<{ reward: bigint }>>;

    totalStaked(): Promise<CallResult<{ total: bigint }>>;
}