@berachain/berajs 0.2.12 → 0.3.0

package/dist/getValidatorQueuedOperatorAddress-Cc05dlO3.d.ts

@@ -1,511 +0,0 @@
-import { Address, PublicClient } from 'viem';
-import { BeraConfig, ChainId } from '@berachain/config/internal';
-import { I as IAggregatorArgs, g as IRawAggregatorQuote, b as Token, d as HoneyConfigContextReturn, B as BalanceToken, P as PythLatestUpdates } from './HoneyConfigProvider-COOuDNra.js';
-import { A as Aggregators } from './dex-C_BB0b0O.js';
-import { GlobalDataQuery, ApiVaultFragment, GetVaultsQueryVariables, GqlChain, GetVaultHistoryQueryVariables, GetVaultHistoryQuery, ApiValidatorInListFragment } from '@berachain/graphql/pol/api';
-import { P as ProtocolMetadata } from './pol.d-CeRgXBL8.js';
-
-interface GetConvertToAssetsProps {
-    sharesAmount: bigint;
-    vaultAddress: Address;
-    publicClient: PublicClient;
-}
-declare function getConvertToAssets({ sharesAmount, vaultAddress, publicClient, }: GetConvertToAssetsProps): Promise<{
-    raw: bigint;
-    formatted: string;
-}>;
-
-declare abstract class BaseAggregator {
-    abstract name: Aggregators;
-    /**
-     * Supported chains for the aggregator.
-     * If null, the aggregator is supported on all chains.
-     */
-    abstract supportedChains: number[] | null;
-    static PATH_NOT_FOUND_REASON: string;
-    needsAccountForQuote: boolean;
-    notFoundMessages: string[];
-    config: BeraConfig;
-    chainId: ChainId;
-    constructor(args?: BeraJS.BaseFunctionArgs);
-    /**
-     * Identifies the url of the last sent request. Might not have all query params.
-     * Mainly used for error reporting.
-     */
-    url: string;
-    abstract readonly type: "rest" | "graphql" | "rpc";
-    abstract getQuote(args: IAggregatorArgs): Promise<IRawAggregatorQuote | undefined> | Promise<IRawAggregatorQuote | undefined>;
-    /**
-     * return wbera for native tokens to accomodate the aggregator's router logic
-     */
-    protected parseAddresses(tokenIn: string, tokenOut: string): {
-        tokenInAddress: Address;
-        tokenOutAddress: Address;
-        isTokenInNative: boolean;
-        isTokenOutNative: boolean;
-    };
-    /**
-     * Calculate input amount after fees.
-     *
-     * @returns Amount in wad format
-     */
-    protected getAmountAfterFees(amount: string, aggregatorsFeeBps?: number): string;
-    /**
-     * Formats input data for aggregator swaps
-     */
-    protected getInputData({ tokenIn, amountIn, isNative, isPermit2Approval, permit2SpenderAddress, }: {
-        tokenIn: Address;
-        amountIn: string;
-        isNative: boolean;
-        isPermit2Approval?: boolean;
-        permit2SpenderAddress?: Address | null;
-    }): {
-        tokenIn: `0x${string}`;
-        amountIn: bigint;
-        isNative: boolean;
-        isPermit2Approval: boolean;
-        permit2SpenderAddress: `0x${string}`;
-    };
-    /**
-     * Calculate min amount out
-     */
-    protected getMinAmountOut(amountOut: string, slippage: number): bigint;
-    protected parseAllowanceRequirements({ tokenIn, rawAmount, spender, }: {
-        tokenIn: Token;
-        rawAmount: string;
-        spender: Address;
-    }): {
-        token: Token;
-        amount: {
-            raw: string;
-            formatted: string;
-        };
-        spender: `0x${string}`;
-    }[];
-    /**
-     * Check if chain is supported
-     */
-    checkChainSupport({ tokenIn, tokenOut, }: {
-        tokenIn: Token;
-        tokenOut: Token;
-        honeyNativeState?: Pick<HoneyConfigContextReturn, "collateralList">;
-        underlyingToken?: Token | null;
-    }): boolean;
-    assertChainSupport({ tokenIn, tokenOut, underlyingToken, }: {
-        tokenIn: Token;
-        tokenOut: Token;
-        underlyingToken?: Token | null;
-    }): void;
-    protected fetch(url: string | URL, options?: RequestInit): Promise<Response>;
-}
-
-interface GetVaultsBalancesArgs extends BeraJS.BaseFunctionArgs {
-    client: PublicClient;
-    collateralList: Token[];
-    honeyFactoryAddress?: Address;
-}
-interface GetHoneyVaultsBalanceResponse extends BalanceToken {
-    vault: Address;
-}
-declare function getHoneyVaultsBalance({ client, collateralList, honeyFactoryAddress, ...args }: GetVaultsBalancesArgs): Promise<GetHoneyVaultsBalanceResponse[]>;
-
-interface IsBadCollateralArgs extends BeraJS.BaseFunctionArgs {
-    client: PublicClient;
-    collateral: Token;
-    latestPrices: PythLatestUpdates | undefined;
-    isPythWrapperEnabled: boolean;
-}
-interface IsBadCollateralResponse {
-    isBlacklisted: boolean;
-    isDepegged: boolean;
-}
-/**
- * Checks if a given collateral asset is considered bad, either by being blacklisted or depegged.
- *
- * @param {Object} args - The arguments object.
- * @param {PublicClient} args.client - The client used to interact with the blockchain.
- * @param {Token} args.collateral - The collateral asset to check.
- *
- * @returns {Promise<IsBadCollateralResponse | undefined>} An object indicating if the collateral is blacklisted or depegged.
- */
-declare function isBadCollateralAsset({ client, collateral, latestPrices, isPythWrapperEnabled, ...args }: IsBadCollateralArgs): Promise<IsBadCollateralResponse | undefined>;
-
-declare enum RewardVaultDistributionMode {
-    Duration = "duration",
-    TargetRate = "targetRate",
-    TargetApr = "targetApr"
-}
-interface GetRewardVaultRewardsReturn {
-    rewardsDuration: number;
-    manager: Address;
-    /**
-     * The amount of BGT that will be distributed per second
-     */
-    rewardRate: string;
-    /**
-     * The timestamp when rewards will be depleted
-     */
-    periodFinish: number;
-    /**
-     * The amount of BGT that will be distributed from now until the periodFinish timestamp
-     */
-    availableRewards: string;
-    /**
-     * The amount of BGT that will be distributed per second.
-     *
-     * If this is 0, the duration mode is active.
-     */
-    targetRewardsPerSecond: string;
-    /**
-     * The minimum reward duration for the target rate
-     */
-    minRewardDurationForTargetRate: number;
-    /**
-     * The current mode of the vault
-     */
-    mode: RewardVaultDistributionMode.Duration | RewardVaultDistributionMode.TargetRate;
-}
-declare function getRewardVaultRewards(address: Address, publicClient: PublicClient): Promise<GetRewardVaultRewardsReturn>;
-
-type GetBgtAprSimulationArgs = {
-    /**
-     * Staked TVL of the vault in USD.
-     *
-     * Null if not available
-     */
-    tvl: number | null;
-    /**
-     * Price of BGT in USD
-     */
-    bgtPrice: number;
-    /**
-     * Undistributed BGT rewards
-     */
-    availableRewards: number;
-    /**
-     * Finish period of the reward distribution in seconds
-     */
-    periodFinish: number;
-    /**
-     * Current duration of the reward distribution in seconds. This will be used if the reward rate is 0.
-     *
-     */
-    currentDuration: number;
-    /**
-     * Maximum reward duration in seconds
-     */
-    MAX_REWARD_DURATION: number;
-    /**
-     * Minimum reward duration in seconds
-     */
-    MIN_REWARD_DURATION: number;
-} & ({
-    /**
-     *
-     */
-    mode: RewardVaultDistributionMode.TargetApr;
-    apr: number;
-    /**
-     * Minimum reward duration for the target rate
-     */
-    minRewardDurationForTargetRate: number;
-} | {
-    /**
-     *
-     */
-    mode: RewardVaultDistributionMode.TargetRate;
-    rewardRate: number;
-    /**
-     * Minimum reward duration for the target rate
-     */
-    minRewardDurationForTargetRate: number;
-} | {
-    /**
-     *
-     */
-    mode: RewardVaultDistributionMode.Duration;
-    /**
-     * Duration of the reward distribution in seconds
-     */
-    duration: number;
-    rewardRate?: never;
-    /**
-     * Must be between MIN_REWARD_DURATION and MAX_REWARD_DURATION
-     */
-    minRewardDurationForTargetRate?: never;
-});
-type GetBgtAprSimulationResult = {
-    apr: number | null;
-    duration: number;
-    rewardRate: number;
-    periodFinish: number;
-    /**
-     * It's the input target rate for the target rate mode.
-     *
-     * If input was target apr, it will be the calculated reward rate.
-     *
-     * If input was duration, it will be null.
-     */
-    targetRate: string | null;
-    /**
-     * If the mode is changed, this will be the new mode. Null otherwise.
-     */
-    mode: RewardVaultDistributionMode | null;
-};
-declare function getBgtAprSimulation({ availableRewards, periodFinish, tvl, bgtPrice, MIN_REWARD_DURATION, MAX_REWARD_DURATION, ...args }: GetBgtAprSimulationArgs): GetBgtAprSimulationResult;
-
-type ReturnedFromQuery = GlobalDataQuery["polGetGlobalInfo"] & {
-    top3EmittingValidators: GlobalDataQuery["top3EmittingValidators"]["validators"];
-    allValidatorsCount: number;
-};
-interface GlobalInfo extends Partial<ReturnedFromQuery> {
-}
-
-interface GlobalData extends GlobalInfo {
-    bgtTotalSupply: string | undefined;
-    bgtTotalBoosts: string | undefined;
-}
-declare function getGlobalData(publicClient: PublicClient): Promise<GlobalData>;
-
-interface GetMarkets {
-    marketList: ProtocolMetadata[];
-    marketDictionary: {
-        [key: string]: ProtocolMetadata;
-    };
-}
-declare function getMarkets(args?: BeraJS.BaseFunctionArgs): Promise<GetMarkets>;
-
-interface RewardVaultIncentive {
-    token: Address;
-    manager: Address;
-    minIncentiveRate: string;
-    incentiveRate: string;
-    remainingAmount: string;
-    name?: string;
-    symbol?: string;
-    /**
-     * Amount of tokens that needs approval before they can be added to the incentive.
-     *
-     * Anyone can just `transfer` ERC20 to the vault, but incentive manager need to send accountIncentives to turn on distribution.
-     */
-    pendingAmount: string;
-    decimals: number;
-}
-declare function getRewardVaultIncentives({ address, stakingToken, publicClient, }: {
-    address: Address;
-    stakingToken: Address;
-    publicClient: PublicClient;
-}): Promise<RewardVaultIncentive[]>;
-
-interface GetRewardVaultData {
-    rewardVaultList: ApiVaultFragment[];
-    pagination: {
-        currentPage: number;
-        totalCount: number;
-    };
-}
-declare function getRewardVaults({ filter, publicClient, ...args }?: {
-    filter?: GetVaultsQueryVariables;
-    publicClient?: PublicClient | undefined;
-} & BeraJS.BaseFunctionArgs): Promise<GetRewardVaultData>;
-
-interface VaultMetadata {
-    current: {
-        exchangeRate: string;
-        totalSupply: string;
-        totalAssets: string;
-        tvl: string;
-    };
-    previous: {
-        exchangeRate: string;
-        totalSupply: string;
-        totalAssets: string;
-        tvl: string;
-    };
-    totalWBeraIssued: string;
-    lockPeriod?: number;
-    address: Address;
-}
-/**
- *
- * @param address - The address of the vault
- * @param underlyingAsset - The address of the vault's underlying asset token
- * @throws {Error} If the vault is not found
- * @returns
- */
-declare function getSWBeraVaultMetadata({ address, underlyingAsset, publicClient, blockTime, }: {
-    address: Address;
-    underlyingAsset: Address;
-    publicClient?: PublicClient;
-    blockTime: number;
-}): Promise<VaultMetadata>;
-
-/**
- * Interface representing a staked BERA withdrawal request
- */
-interface StakedBeraWithdrawal {
-    receiptTokenAddress: Address;
-    withdrawalAmount?: bigint;
-    timeRemaining?: string;
-    withdrawalRequestId?: bigint;
-}
-/**
- * Retrieves staked BERA withdrawal information for a given account
- *
- * This function handles both V1 and V2 versions of the stake vault contract:
- * - V1: Uses a single withdrawal request per account
- * - V2: Uses ERC721 tokens to represent multiple withdrawal requests per account
- *
- * @param contractAddress - The address of the stake vault contract
- * @param accountAddress - The address of the account to check withdrawals for
- * @param publicClient - Viem public client for blockchain interactions
- * @param version - The version of the stake vault contract ("V1" or "V2")
- * @returns Promise resolving to an array of withdrawal request information
- */
-declare function getSWBeraWithdrawal({ contractAddress, accountAddress, publicClient, version, }: {
-    contractAddress: Address;
-    accountAddress: Address;
-    publicClient: PublicClient;
-    version: "V1" | "V2";
-}): Promise<StakedBeraWithdrawal[]>;
-
-interface UserVault {
-    unclaimedBgt: string;
-    formattedBalance: string;
-    stakingTokenPrice: number | null;
-    vault: ApiVaultFragment;
-}
-type GetUserVaultsResponse = {
-    totalStakedValue: number;
-    totalBgtRewards: string;
-    vaults: UserVault[];
-};
-declare function getUserVaults({ account, publicClient, ...args }: {
-    account: Address;
-    publicClient: PublicClient;
-} & BeraJS.BaseFunctionArgs): Promise<GetUserVaultsResponse>;
-
-type GetVaultHistoryArgs = {
-    vault: Address;
-    chain?: GqlChain;
-} & Omit<GetVaultHistoryQueryVariables, "vaultId" | "chain"> & BeraJS.BaseFunctionArgs;
-declare function getVaultHistory({ vault, chain, ...args }: GetVaultHistoryArgs): Promise<GetVaultHistoryQuery["polGetRewardVaultSnapshots"] | undefined>;
-
-interface ValidatorRewardAllocationRaw {
-    startBlock: bigint;
-    weights: readonly {
-        receiver: `0x${string}`;
-        percentageNumerator: bigint;
-    }[];
-}
-interface ValidatorRewardAllocation {
-    start: {
-        blockNumber: number;
-        timestamp: number;
-    };
-    weights: readonly {
-        receiver: `0x${string}`;
-        /**
-         * Weight percentage as a number between 0 and 1.
-         */
-        percentage: number;
-    }[];
-}
-interface ValidatorRewardAllocationUpdate {
-    active: ValidatorRewardAllocation["start"];
-    set: ValidatorRewardAllocation["start"];
-}
-interface ValidatorRewardAllocationUpdateWithExpiration extends ValidatorRewardAllocationUpdate {
-    expiresAtTs: number;
-}
-declare function formatValidatorRewardAllocation(raw: ValidatorRewardAllocationRaw, startTs: number): ValidatorRewardAllocation;
-declare function isSameRewardAllocation(a: ValidatorRewardAllocation, b: ValidatorRewardAllocation): boolean;
-declare function getValidatorRewardAllocation({ client, pubKey, ...args }: BeraJS.BaseFunctionArgs & {
-    client: PublicClient;
-    pubKey: Address;
-}): Promise<{
-    /**
-     * The active reward allocation for the validator.
-     */
-    activeRewardAllocation: ValidatorRewardAllocation;
-    /**
-     * The set reward allocation for the validator.
-     *
-     * It might differ from the active reward allocation if the validator hasn't updated
-     *  the reward allocation for more than the reward allocation inactivity block span.
-     */
-    setRewardAllocation: ValidatorRewardAllocation;
-    /**
-     * Whether the reward allocation is inactive so it falls back to the baseline reward allocation.
-     */
-    isBaseline: boolean;
-    isNeverSet: boolean;
-}>;
-
-type UserBoostsOnValidator = {
-    pubkey: Address;
-    /**
-     * The amount of boosts that can be dropped.
-     */
-    droppableBoostAmount: string;
-    activeBoostAmount: string;
-    queuedBoostAmount: string;
-    queuedBoostStartBlock: number;
-    queuedDropBoostAmount: string;
-    queuedDropBoostStartBlock: number;
-    hasPendingBoosts: boolean;
-    hasActiveBoosts: boolean;
-    /**
-     * Whether the user has active boosts that can be dropped.
-     */
-    hasDroppableBoosts: boolean;
-};
-declare function getUserBoostsOnValidator({ account, pubkey, publicClient, ...args }: {
-    account: Address;
-    pubkey: Address;
-    publicClient: PublicClient | undefined;
-} & BeraJS.BaseFunctionArgs): Promise<UserBoostsOnValidator>;
-
-type ValidatorWithUserBoost = ApiValidatorInListFragment & {
-    userBoosts: UserBoostsOnValidator;
-};
-declare function getUserActiveValidators({ account, publicClient, chain, ...args }: {
-    account: string;
-    publicClient: PublicClient | undefined;
-    chain?: GqlChain;
-} & BeraJS.BaseFunctionArgs): Promise<ValidatorWithUserBoost[] | undefined>;
-
-interface StakingPoolAmount {
-    amount: bigint;
-    formattedAmount: string;
-}
-interface UserStakingPoolPosition {
-    validatorAddress: Address;
-    earning: number;
-    staked?: StakingPoolAmount;
-    rewards?: StakingPoolAmount;
-    queueData?: {
-        stake?: StakingPoolAmount[];
-        unstake?: (StakingPoolAmount & {
-            timestamp: number;
-        })[];
-    };
-}
-declare function getUserStakingPositions(account: Address): Promise<UserStakingPoolPosition[]>;
-
-interface ValidatorQueuedCommission {
-    blockNumberLast: number;
-    commissionRate: number;
-}
-declare function getValidatorQueuedCommission({ client, pubKey, ...args }: BeraJS.BaseFunctionArgs & {
-    client: PublicClient;
-    pubKey: Address;
-}): Promise<ValidatorQueuedCommission | undefined | null>;
-
-type ValidatorQueuedOperatorAddress = [bigint, string];
-declare function getValidatorQueuedOperatorAddress({ client, pubKey, ...args }: {
-    client: PublicClient;
-    pubKey: Address;
-} & BeraJS.BaseFunctionArgs): Promise<ValidatorQueuedOperatorAddress | undefined>;
-
-export { getRewardVaultIncentives as A, BaseAggregator as B, getRewardVaultRewards as C, getRewardVaults as D, getSWBeraVaultMetadata as E, getSWBeraWithdrawal as F, type GetBgtAprSimulationArgs as G, getUserActiveValidators as H, type IsBadCollateralArgs as I, getUserBoostsOnValidator as J, getUserStakingPositions as K, getUserVaults as L, getValidatorQueuedCommission as M, getValidatorQueuedOperatorAddress as N, getValidatorRewardAllocation as O, getVaultHistory as P, isBadCollateralAsset as Q, RewardVaultDistributionMode as R, type StakedBeraWithdrawal as S, isSameRewardAllocation as T, type UserBoostsOnValidator as U, type ValidatorRewardAllocation as V, type GetBgtAprSimulationResult as a, type GetConvertToAssetsProps as b, type GetHoneyVaultsBalanceResponse as c, type GetMarkets as d, type GetRewardVaultData as e, type GetRewardVaultRewardsReturn as f, type GetUserVaultsResponse as g, type GetVaultHistoryArgs as h, type GlobalData as i, type IsBadCollateralResponse as j, type RewardVaultIncentive as k, type UserStakingPoolPosition as l, type UserVault as m, type ValidatorQueuedCommission as n, type ValidatorQueuedOperatorAddress as o, type ValidatorRewardAllocationRaw as p, type ValidatorRewardAllocationUpdate as q, type ValidatorRewardAllocationUpdateWithExpiration as r, type ValidatorWithUserBoost as s, type VaultMetadata as t, formatValidatorRewardAllocation as u, getBgtAprSimulation as v, getConvertToAssets as w, getGlobalData as x, getHoneyVaultsBalance as y, getMarkets as z };