@azuro-org/toolkit/dist/utils/cashout/getPrecalculatedCashouts.d.ts

This framework-agnostic package provides essential utilities for building applications on the Azuro Protocol.

import { type ChainId } from '../../config';
type GetPrecalculatedCashoutsResponse = {
    margin: string;
    marginMin: string;
    availables: {
        conditionId: string;
        available: boolean;
        outcomes: {
            outcomeId: number;
            price: string;
        }[];
    }[];
};
export type GetPrecalculatedCashoutsResult = GetPrecalculatedCashoutsResponse | null;
/** @deprecated use GetPrecalculatedCashoutsResult instead */
export type GetPrecalculatedCashouts = GetPrecalculatedCashoutsResult;
export type GetPrecalculatedCashoutsParams = {
    chainId: ChainId;
    conditionIds: string[];
};
/**
 * Retrieves precalculated cashout availability and prices for specified conditions.
 * Returns margin information and outcome prices for each available condition.
 *
 * - Docs: https://gem.azuro.org/hub/apps/toolkit/utils/cashout/getPrecalculatedCashouts
 *
 * @example
 * import { getPrecalculatedCashouts } from '@azuro-org/toolkit'
 *
 * const chainId = 100
 * const conditionIds = ['123', '456', '789']
 *
 * const cashouts = await getPrecalculatedCashouts({
 *   chainId,
 *   conditionIds,
 * })
 *
 * if (cashouts) {
 *   cashouts.availables.forEach(({ conditionId, available, outcomes }) => {
 *     console.log(`Condition ${conditionId} available: ${available}`)
 *     outcomes.forEach(({ outcomeId, price }) => {
 *       console.log(`  Outcome ${outcomeId}: ${price}`)
 *     })
 *   })
 * }
 * */
export declare const getPrecalculatedCashouts: (props: GetPrecalculatedCashoutsParams) => Promise<GetPrecalculatedCashoutsResult>;
export {};