Class MarginedEngineQueryClient

constructor

• new MarginedEngineQueryClient(client, contractAddress): MarginedEngineQueryClient

• Parameters

  • client: CosmWasmClient

  • contractAddress: string

  Returns MarginedEngineQueryClient

client

contractAddress

allPositions

• allPositions(__namedParameters): Promise<ArrayOfPosition>

• Returns a user's positions for all vAMMs.

  Parameters

  • __namedParameters: {
        limit?: number;
        orderBy?: number;
        startAfter?: number;
        trader: string;
    }

    • Optional limit?: number

    • Optional orderBy?: number

    • Optional startAfter?: number

    • trader: string

  Returns Promise<ArrayOfPosition>

balanceWithFundingPayment

• balanceWithFundingPayment(__namedParameters): Promise<string>

• Returns a user's margin balance across all vAMMs inclusive funding payments.

  Parameters

  • __namedParameters: {
        positionId: number;
    }

    • positionId: number

  Returns Promise<string>

config

• config(): Promise<ConfigResponse>

• Returns the contracts configuration.

  Returns Promise<ConfigResponse>

cumulativePremiumFraction

• cumulativePremiumFraction(__namedParameters): Promise<Integer>

• Returns the cumulative premium fraction of a vAMM.

  Parameters

  • __namedParameters: {
        vamm: string;
    }

    • vamm: string

  Returns Promise<Integer>

freeCollateral

• freeCollateral(__namedParameters): Promise<Integer>

• Returns the excess collateral a user has for a vAMM.

  Parameters

  • __namedParameters: {
        positionId: number;
        vamm: string;
    }

    • positionId: number

    • vamm: string

  Returns Promise<Integer>

getPauser

• getPauser(): Promise<PauserResponse>

• Returns the pauser of the contract.

  Returns Promise<PauserResponse>

getWhitelist

• getWhitelist(): Promise<HooksResponse>

• Returns whitelist that can by pass some trader's restrictions.

  Returns Promise<HooksResponse>

isWhitelisted

• isWhitelisted(__namedParameters): Promise<boolean>

• Check a trader is in whitelist.

  Parameters

  • __namedParameters: {
        address: string;
    }

    • address: string

  Returns Promise<boolean>

lastPositionId

• lastPositionId(): Promise<LastPositionIdResponse>

• Returns Promise<LastPositionIdResponse>

marginRatio

• marginRatio(__namedParameters): Promise<Integer>

• Returns the margin ratio of a user for a vAMM.

  Parameters

  • __namedParameters: {
        positionId: number;
        vamm: string;
    }

    • positionId: number

    • vamm: string

  Returns Promise<Integer>

marginRatioByCalcOption

• marginRatioByCalcOption(__namedParameters): Promise<Integer>

• Parameters

  • __namedParameters: {
        calcOption: PnlCalcOption;
        positionId: number;
        vamm: string;
    }

    • calcOption: PnlCalcOption

    • positionId: number

    • vamm: string

  Returns Promise<Integer>

position

• position(__namedParameters): Promise<Position>

• Returns a user's position for a specific vAMM.

  Parameters

  • __namedParameters: {
        positionId: number;
        vamm: string;
    }

    • positionId: number

    • vamm: string

  Returns Promise<Position>

positionWithFundingPayment

• positionWithFundingPayment(__namedParameters): Promise<Position>

• Returns a user's margin balance inclusive funding payments for a specific vAMM.

  Parameters

  • __namedParameters: {
        positionId: number;
        vamm: string;
    }

    • positionId: number

    • vamm: string

  Returns Promise<Position>

positions

• positions(__namedParameters): Promise<ArrayOfPosition>

• Parameters

  • __namedParameters: {
        filter: PositionFilter;
        limit?: number;
        orderBy?: number;
        side?: Side;
        startAfter?: number;
        vamm: string;
    }

    • filter: PositionFilter

    • Optional limit?: number

    • Optional orderBy?: number

    • Optional side?: Side

    • Optional startAfter?: number

    • vamm: string

  Returns Promise<ArrayOfPosition>

state

• state(): Promise<StateResponse>

• Returns the state variables of the contract.

  Returns Promise<StateResponse>

tick

• tick(__namedParameters): Promise<TickResponse>

• Parameters

  • __namedParameters: {
        entryPrice: string;
        side: Side;
        vamm: string;
    }

    • entryPrice: string

    • side: Side

    • vamm: string

  Returns Promise<TickResponse>

ticks

• ticks(__namedParameters): Promise<TicksResponse>

• Parameters

  • __namedParameters: {
        limit?: number;
        orderBy?: number;
        side: Side;
        startAfter?: string;
        vamm: string;
    }

    • Optional limit?: number

    • Optional orderBy?: number

    • side: Side

    • Optional startAfter?: string

    • vamm: string

  Returns Promise<TicksResponse>

unrealizedPnl

• unrealizedPnl(__namedParameters): Promise<PositionUnrealizedPnlResponse>

• Returns the unrealized PnL (profit and loss) of a user for a specific vAMM using a specific calculation method.

  Parameters

  • __namedParameters: {
        calcOption: PnlCalcOption;
        positionId: number;
        vamm: string;
    }

    • calcOption: PnlCalcOption

    • positionId: number

    • vamm: string

  Returns Promise<PositionUnrealizedPnlResponse>