@waterx/sdk 2.4.0 → 3.0.0

package/dist/src/fetch.d.ts

@@ -1,254 +0,0 @@
-/**
- * Read-only queries built on top of `waterx_perp_view`.
- *
- * Each helper builds a one-shot PTB, runs `client.simulate(tx)`, and
- * decodes the first command's return values into the matching generated
- * BCS struct. The simulated sender is the zero address.
- */
-import type { WaterXClient } from "./client.ts";
-import { AccountData, GlobalConfigData, MarketData, OrderData, PoolData, PositionData, RedeemRequestData, TokenPoolData } from "./generated/waterx_perp_view/view.ts";
-import { type ParkedBackingAssetBalance } from "./utils/consolidate-balance.ts";
-export type AccountDataView = ReturnType<typeof AccountData.parse>;
-/**
- * Look up the registered AccountData for a given wxa account ID.
- * Returns `undefined` if the account has no perp data slot installed yet
- * (the slot auto-installs on the first `add_position` / `add_order`).
- * The underlying view fn returns `Option<AccountData>`.
- */
-export declare function getAccountData(client: WaterXClient, accountId: string): Promise<AccountDataView | undefined>;
-export type MarketDataView = ReturnType<typeof MarketData.parse>;
-export type PoolDataView = ReturnType<typeof PoolData.parse>;
-export type TokenPoolDataView = ReturnType<typeof TokenPoolData.parse>;
-export type GlobalConfigDataView = ReturnType<typeof GlobalConfigData.parse>;
-export declare function getMarketData(client: WaterXClient, args: {
-    ticker: string;
-    lpType?: string;
-}): Promise<MarketDataView>;
-export declare function getPoolData(client: WaterXClient, args?: {
-    lpType?: string;
-}): Promise<PoolDataView>;
-export declare function getTokenPoolData(client: WaterXClient, args: {
-    tokenIndex: bigint | number;
-    lpType?: string;
-}): Promise<TokenPoolDataView>;
-export declare function getGlobalConfigData(client: WaterXClient): Promise<GlobalConfigDataView>;
-export type PositionDataView = ReturnType<typeof PositionData.parse>;
-export declare function positionExists(client: WaterXClient, args: {
-    ticker: string;
-    positionId: bigint | number;
-    lpType?: string;
-}): Promise<boolean>;
-export declare function getPosition(client: WaterXClient, args: {
-    ticker: string;
-    positionId: bigint | number;
-    /** Human-readable USD prices for Pnl / liq price calc; pass 0n if unsure. */
-    basePriceUsd: bigint | number;
-    collateralPriceUsd: bigint | number;
-    lpType?: string;
-}): Promise<PositionDataView>;
-export type OrderDataView = ReturnType<typeof OrderData.parse>;
-export declare function getOrder(client: WaterXClient, args: {
-    ticker: string;
-    orderId: bigint | number;
-    orderTypeTag: number;
-    triggerPrice: bigint | number;
-    basePriceUsd: bigint | number;
-    lpType?: string;
-}): Promise<OrderDataView>;
-export interface PageOpts {
-    cursor?: bigint | number;
-    pageSize?: bigint | number;
-}
-export declare function getMarketOrders(client: WaterXClient, args: {
-    ticker: string;
-    basePriceUsd?: bigint | number;
-    lpType?: string;
-} & PageOpts): Promise<{
-    orders: OrderDataView[];
-    nextCursor?: bigint;
-}>;
-export declare function getMarketPositions(client: WaterXClient, args: {
-    ticker: string;
-    basePriceUsd: bigint | number;
-    collateralPriceUsd?: bigint | number;
-    lpType?: string;
-} & PageOpts): Promise<{
-    positions: PositionDataView[];
-    nextCursor?: bigint;
-}>;
-export declare function getAccountPositions(client: WaterXClient, args: {
-    ticker: string;
-    accountObjectAddress: string;
-    basePriceUsd: bigint | number;
-    collateralPriceUsd?: bigint | number;
-    lpType?: string;
-}): Promise<PositionDataView[]>;
-export declare function getAccountOrders(client: WaterXClient, args: {
-    ticker: string;
-    accountObjectAddress: string;
-    basePriceUsd?: bigint | number;
-    lpType?: string;
-}): Promise<OrderDataView[]>;
-export type RedeemRequestDataView = ReturnType<typeof RedeemRequestData.parse>;
-export declare function getRedeemRequests(client: WaterXClient, args?: {
-    lpType?: string;
-} & PageOpts): Promise<{
-    requests: RedeemRequestDataView[];
-    nextCursor?: bigint;
-}>;
-/** Returns the referrer address bound to `referee`, or `undefined` if none. */
-export declare function getRefererFor(client: WaterXClient, referee: string): Promise<string | undefined>;
-/** True if `code` is a syntactically valid referral code (matches the contract's char rules). */
-export declare function isValidReferralCode(client: WaterXClient, code: string): Promise<boolean>;
-/** True if `code` is already claimed in the on-chain ReferralTable. */
-export declare function referralCodeExists(client: WaterXClient, code: string): Promise<boolean>;
-/**
- * List the wxa account IDs owned by `owner` (`account::account_ids`).
- * Returns `[]` when the owner has never created an account. Use this to
- * resolve the `account_id` a cross-chain deposit must target before
- * filling the EVM `suiRecipient` field.
- */
-export declare function getAccountsByOwner(client: WaterXClient, owner: string): Promise<string[]>;
-/**
- * A wxa account's stored `Balance<T>` (`account::account_balance<T>`).
- * `coinType` defaults to the deployment's CREDIT type — i.e. the bridged
- * balance available to withdraw. Returns `0n` for an unknown coin type.
- */
-export declare function getAccountBalance(client: WaterXClient, accountId: string, coinType?: string): Promise<bigint>;
-/**
- * Inclusive wxUSD credit an account can spend after the default async tx-builder
- * pre-sweep ({@link appendConsolidateForSpend}).
- *
- * - `internalRaw` — stored `Balance<CREDIT>` (`getAccountBalance`).
- * - `pendingBackingRaw` — native-custody backing assets (USDC, USDSUI, …)
- *   parked at the account's Sui address, rescaled to CREDIT decimals at the
- *   1:1 PSM peg (same probe as {@link appendConsolidateToUsd}).
- * - `pendingCreditAtAddressRaw` — CREDIT at the account address (accumulator +
- *   owned coins). Swept into the internal slot by
- *   {@link appendConsolidateAddressCredit} via `consumeDepositDirect`.
- * - `totalRaw` — sum of the three components; matches post-
- *   {@link appendConsolidateForSpend} spendable balance for predict / perp
- *   builders with `consolidateToUsd: true` (default).
- */
-export interface SpendableCreditBalance {
-    internalRaw: bigint;
-    pendingBackingRaw: bigint;
-    pendingCreditAtAddressRaw: bigint;
-    totalRaw: bigint;
-    /** Per-asset breakdown for the backing-asset probe (empty when nothing parked). */
-    parkedBacking: ParkedBackingAssetBalance[];
-}
-export declare function getSpendableCreditBalance(client: WaterXClient, accountId: string): Promise<SpendableCreditBalance>;
-/** Vault-wide native-custody state. */
-export interface CustodyVaultData {
-    /** Total CREDIT minted by the custody vault (`credit_supply`). */
-    creditSupply: bigint;
-}
-/** Reads vault-wide native-custody state via `custody_vault::credit_supply`. */
-export declare function getCustodyVaultData(client: WaterXClient): Promise<CustodyVaultData>;
-/** Per-asset native-custody state for one backing asset. */
-export interface CustodyAssetData {
-    /** Whether the asset is registered as a `SingleVault` on the custody vault. */
-    registered: boolean;
-    /** 1e9-scaled default mint fee rate (`0n` when the asset is not registered). */
-    mintFeeRate: bigint;
-    /** 1e9-scaled default burn fee rate (`0n` when the asset is not registered). */
-    burnFeeRate: bigint;
-}
-/**
- * Reads per-asset native-custody state for backing asset `assetType`.
- *
- * Fee rates are the vault's default config — queried with the zero address as
- * caller, so no partner discount is applied — as 1e9-scaled `Float` values.
- * When the asset is not registered, returns `registered: false` with `0n` rates.
- *
- * Note: the `SingleVault` balance / decimal / backing / min-burn / deprecated
- * fields are not exposed here — the contract's getters for those return a
- * `&SingleVault<T>` reference, which a PTB simulate cannot read.
- */
-export declare function getCustodyAssetData(client: WaterXClient, assetType: string): Promise<CustodyAssetData>;
-/**
- * Live rate-limit / cap snapshot read from the `wormhole_bridge::Bridge`
- * shared object. All amounts are raw base units of the bridged credit coin.
- *
- * `dailyMinted` / `dailyBurned` are the sliding-window sums as the on-chain
- * `daily_minted` / `daily_burned` views report them — buckets that rotated
- * out of the trailing window are evicted lazily on the next mint/burn, so
- * these can read slightly high until then (conservative).
- */
-export interface BridgeLimitsView {
-    paused: boolean;
-    dailyMintLimit: bigint;
-    dailyMinted: bigint;
-    maxMintPerTx: bigint;
-    dailyBurnLimit: bigint;
-    dailyBurned: bigint;
-    maxBurnPerTx: bigint;
-    /** Per-account 24h burn cap; 0n means the gate is disabled. */
-    personalBurnCapAmount: bigint;
-    /** Present only when `accountId` is supplied — burn counted in that
-     *  account's current window (the per-account cap key is the account id). */
-    personalBurned?: bigint;
-    /** Present only when `backing` is supplied — `minted_for(chainId, token)`,
-     *  the amount currently withdrawable to that EVM (chain, token). */
-    backingMinted?: bigint;
-}
-export interface BridgeLimitsArgs {
-    /** wxa trading account id — enables the per-account `personalBurned` read. */
-    accountId?: string;
-    /** Wormhole destination chain id + 20-byte EVM token — enables the
-     *  `mintedFor` backing read. */
-    backing?: {
-        wormholeChainId: number;
-        token: Uint8Array | number[];
-    };
-}
-/**
- * Batched read of the bridge's rate-limit / cap state in a single simulate.
- * Pass `accountId` to also fetch the per-account burn usage, and `backing`
- * to also fetch the destination-chain backing (`minted_for`).
- *
- * Throws if `wormhole_bridge` (or its `Bridge` object id) is absent from the
- * canonical config — e.g. on a network where the Sui bridge isn't published.
- */
-export declare function getBridgeLimits(client: WaterXClient, args?: BridgeLimitsArgs): Promise<BridgeLimitsView>;
-export interface BridgeFeeView {
-    /** Raw fee charged on a wormhole (Sui → EVM) exit of `amount`:
-     *  `max(ceil(effectiveRate * amount), effectiveMinFee)`. */
-    feeAmount: bigint;
-    /** Whether the exit clears the on-chain net-zero guard — i.e. a strictly
-     *  positive amount remains after the fee. Gate "estimated fee" UI on THIS,
-     *  not `feeAmount` alone: a dust `amount`, or a min-fee floor ≥ `amount`,
-     *  makes `feeAmount >= amount` and the exit would abort (audit L1). */
-    wouldExecute: boolean;
-    /** Effective % rate for the chain (per-chain override → default → 0),
-     *  1e9-scaled (the `Float`-as-`u128` ABI convention). */
-    effectiveRate: bigint;
-    /** Effective minimum-fee floor for the chain (override → default → 0),
-     *  in CREDIT base units. */
-    effectiveMinFee: bigint;
-    /** Net CREDIT the recipient receives after the fee; `0n` when the exit
-     *  wouldn't execute (`wouldExecute === false`). */
-    netAmount: bigint;
-}
-/**
- * Estimate the bridge fee for a wormhole (Sui → EVM) CREDIT exit of `amount`
- * to `evmDestinationChain`, read in a single simulate from the on-chain
- * `withdrawal_queue` views. The charged fee is
- * `max(ceil(effectiveRate * amount), effectiveMinFee)`.
- *
- * Surface UI off `wouldExecute`, NOT `feeAmount` alone — `feeAmount` is the raw
- * fee and can equal/exceed `amount` (ceil rounding on a dust entry, or a min-fee
- * floor larger than the entry), in which case the on-chain exit aborts its
- * net-zero guard (audit L1). `netAmount` is `0n` whenever `wouldExecute` is
- * false.
- *
- * @param args.amount             CREDIT base units (the bridged coin's smallest unit).
- * @param args.evmDestinationChain WORMHOLE chain id of the destination EVM.
- * @param args.creditType         CREDIT coin type; defaults to `client.creditType()`.
- */
-export declare function getBridgeFee(client: WaterXClient, args: {
-    evmDestinationChain: number;
-    amount: bigint | number;
-    creditType?: string;
-}): Promise<BridgeFeeView>;