@bithomp/xrpl-api/lib/types/amm.d.ts

A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger

import { AMMDepositFlags, AMMWithdrawFlags, AMMClawbackFlags } from "xrpl";
import { FormattedBaseSpecification } from "./specification";
import { FormattedAmount, FormattedIssuedCurrency } from "./amounts";
import { TxGlobalFlagsKeysInterface } from "./global";
export interface VoteSlotInterface {
    VoteEntry: {
        Account: string;
        TradingFee: number;
        VoteWeight: number;
    };
}
export declare const AMMDepositFlagsKeys: {
    lpToken: AMMDepositFlags;
    singleAsset: AMMDepositFlags;
    twoAsset: AMMDepositFlags;
    oneAssetLPToken: AMMDepositFlags;
    limitLPToken: AMMDepositFlags;
    twoAssetIfEmpty: AMMDepositFlags;
};
export declare function getAMMDepositFlagsKeys(nativeCurrency?: string): Record<string, number>;
export interface AMMDepositFlagsKeysInterface extends TxGlobalFlagsKeysInterface {
    lpToken?: boolean;
    singleAsset?: boolean;
    twoAsset?: boolean;
    oneAssetLPToken?: boolean;
    limitLPToken?: boolean;
}
export declare const AMMWithdrawFlagsKeys: {
    lpToken: AMMWithdrawFlags;
    withdrawAll: AMMWithdrawFlags;
    oneAssetWithdrawAll: AMMWithdrawFlags;
    singleAsset: AMMWithdrawFlags;
    twoAsset: AMMWithdrawFlags;
    oneAssetLPToken: AMMWithdrawFlags;
    limitLPToken: AMMWithdrawFlags;
};
export declare function getAMMWithdrawFlagsKeys(nativeCurrency?: string): Record<string, number>;
export interface AMMWithdrawFlagsKeysInterface extends TxGlobalFlagsKeysInterface {
    lpToken?: boolean;
    withdrawAll?: boolean;
    oneAssetWithdrawAll?: boolean;
    singleAsset?: boolean;
    twoAsset?: boolean;
    oneAssetLPToken?: boolean;
    limitLPToken?: boolean;
}
export declare const AMMClawbackFlagsKeys: {
    clawTwoAssets: AMMClawbackFlags;
};
export declare function getAMMClawbackFlagsKeys(nativeCurrency?: string): Record<string, number>;
export interface AMMClawbackFlagsKeysInterface extends TxGlobalFlagsKeysInterface {
    clawTwoAssets?: boolean;
}
export type FormattedAmmBidSpecification = {
    asset?: FormattedIssuedCurrency;
    asset2?: FormattedIssuedCurrency;
    bidMin?: FormattedAmount;
    bidMax?: FormattedAmount;
    authorizedAccounts?: string[];
} & FormattedBaseSpecification;
export type FormattedAmmCreateSpecification = {
    amount: FormattedAmount;
    amount2: FormattedAmount;
    tradingFee: Number;
} & FormattedBaseSpecification;
export type FormattedAmmDeleteSpecification = {
    asset?: FormattedIssuedCurrency;
    asset2?: FormattedIssuedCurrency;
} & FormattedBaseSpecification;
export type FormattedAmmDepositSpecification = {
    asset?: FormattedIssuedCurrency;
    asset2?: FormattedIssuedCurrency;
    amount?: FormattedAmount;
    amount2?: FormattedAmount;
    ePrice?: FormattedAmount;
    lpTokenOut?: FormattedAmount;
    flags?: AMMDepositFlagsKeysInterface;
} & FormattedBaseSpecification;
export type FormattedAmmWithdrawSpecification = {
    asset?: FormattedIssuedCurrency;
    asset2?: FormattedIssuedCurrency;
    amount?: FormattedAmount;
    amount2?: FormattedAmount;
    ePrice?: FormattedAmount;
    lpTokenIn?: FormattedAmount;
    flags?: AMMWithdrawFlagsKeysInterface;
} & FormattedBaseSpecification;
export type FormattedAmmVoteSpecification = {
    asset?: FormattedIssuedCurrency;
    asset2?: FormattedIssuedCurrency;
    tradingFee: Number;
} & FormattedBaseSpecification;
export type FormattedAmmClawbackSpecification = {
    asset?: FormattedIssuedCurrency;
    asset2?: FormattedIssuedCurrency;
    amount?: FormattedAmount;
    holder?: string;
} & FormattedBaseSpecification;