Interface MarginedEngineReadOnlyInterface

Hierarchy

MarginedEngineReadOnlyInterface
- MarginedEngineInterface

Implemented by

MarginedEngineQueryClient

Index

Properties

allPositions balanceWithFundingPayment config contractAddress cumulativePremiumFraction freeCollateral getPauser getWhitelist isWhitelisted lastPositionId marginRatio marginRatioByCalcOption position positionWithFundingPayment positions state tick ticks unrealizedPnl

Properties

allPositions

allPositions: ((__namedParameters) => Promise<ArrayOfPosition>)

Type declaration

- (__namedParameters): Promise<ArrayOfPosition>
- 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>)

Type declaration

- (__namedParameters): Promise<string>
- Parameters
  - __namedParameters: {
    positionId: number;
    }
    - positionId: number
  Returns Promise<string>

config

config: (() => Promise<ConfigResponse>)

Type declaration

- (): Promise<ConfigResponse>
- Returns Promise<ConfigResponse>

contractAddress

contractAddress: string

cumulativePremiumFraction

cumulativePremiumFraction: ((__namedParameters) => Promise<Integer>)

Type declaration

- (__namedParameters): Promise<Integer>
- Parameters
  - __namedParameters: {
    vamm: string;
    }
    - vamm: string
  Returns Promise<Integer>

freeCollateral

freeCollateral: ((__namedParameters) => Promise<Integer>)

Type declaration

- (__namedParameters): Promise<Integer>
- Parameters
  - __namedParameters: {
    positionId: number;
    vamm: string;
    }
    - positionId: number
    - vamm: string
  Returns Promise<Integer>

getPauser

getPauser: (() => Promise<PauserResponse>)

Type declaration

- (): Promise<PauserResponse>
- Returns Promise<PauserResponse>

getWhitelist

getWhitelist: (() => Promise<HooksResponse>)

Type declaration

- (): Promise<HooksResponse>
- Returns Promise<HooksResponse>

isWhitelisted

isWhitelisted: ((__namedParameters) => Promise<boolean>)

Type declaration

- (__namedParameters): Promise<boolean>
- Parameters
  - __namedParameters: {
    address: string;
    }
    - address: string
  Returns Promise<boolean>

lastPositionId

lastPositionId: (() => Promise<LastPositionIdResponse>)

Type declaration

- (): Promise<LastPositionIdResponse>
- Returns Promise<LastPositionIdResponse>

marginRatio

marginRatio: ((__namedParameters) => Promise<Integer>)

Type declaration

- (__namedParameters): Promise<Integer>
- Parameters
  - __namedParameters: {
    positionId: number;
    vamm: string;
    }
    - positionId: number
    - vamm: string
  Returns Promise<Integer>

marginRatioByCalcOption

marginRatioByCalcOption: ((__namedParameters) => Promise<Integer>)

Type declaration

- (__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>)

Type declaration

- (__namedParameters): Promise<Position>
- Parameters
  - __namedParameters: {
    positionId: number;
    vamm: string;
    }
    - positionId: number
    - vamm: string
  Returns Promise<Position>

positionWithFundingPayment

positionWithFundingPayment: ((__namedParameters) => Promise<Position>)

Type declaration

- (__namedParameters): Promise<Position>
- Parameters
  - __namedParameters: {
    positionId: number;
    vamm: string;
    }
    - positionId: number
    - vamm: string
  Returns Promise<Position>

positions

positions: ((__namedParameters) => Promise<ArrayOfPosition>)

Type declaration

- (__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>)

Type declaration

- (): Promise<StateResponse>
- Returns Promise<StateResponse>

tick

tick: ((__namedParameters) => Promise<TickResponse>)

Type declaration

- (__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>)

Type declaration

- (__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>)

Type declaration

- (__namedParameters): Promise<PositionUnrealizedPnlResponse>
- Parameters
  - __namedParameters: {
        calcOption: PnlCalcOption;
        positionId: number;
        vamm: string;
    }
    - calcOption: PnlCalcOption
    - positionId: number
    - vamm: string
  Returns Promise<PositionUnrealizedPnlResponse>

Interface MarginedEngineReadOnlyInterface

Hierarchy

Implemented by

Index

Properties

Properties

allPositions

Type declaration

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

Type declaration

Parameters

__namedParameters: { positionId: number; }

positionId: number

Returns Promise<string>

config

Type declaration

Returns Promise<ConfigResponse>

contractAddress

cumulativePremiumFraction

Type declaration

Parameters

__namedParameters: { vamm: string; }

vamm: string

Returns Promise<Integer>

freeCollateral

Type declaration

Parameters

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

positionId: number

vamm: string

Returns Promise<Integer>

getPauser

Type declaration

Returns Promise<PauserResponse>

getWhitelist

Type declaration

Returns Promise<HooksResponse>

isWhitelisted

Type declaration

Parameters

__namedParameters: { address: string; }

address: string

Returns Promise<boolean>

lastPositionId

Type declaration

Returns Promise<LastPositionIdResponse>

marginRatio

Type declaration

Parameters

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

positionId: number

vamm: string

Returns Promise<Integer>

marginRatioByCalcOption

Type declaration

Parameters

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

calcOption: PnlCalcOption

positionId: number

vamm: string

Returns Promise<Integer>

position

Type declaration

Parameters

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

positionId: number

vamm: string

Returns Promise<Position>

positionWithFundingPayment

Type declaration

Parameters

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

positionId: number

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

`Optional` limit?: number

`Optional` orderBy?: number

`Optional` startAfter?: number

__namedParameters: {
positionId: number;
}

__namedParameters: {
vamm: string;
}

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

__namedParameters: {
address: string;
}

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

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

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

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

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

`Optional` limit?: number

`Optional` orderBy?: number

`Optional` side?: Side

`Optional` startAfter?: number

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

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

`Optional` limit?: number

`Optional` orderBy?: number

`Optional` startAfter?: string

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