Interface MarginedEngineInterface

Hierarchy

MarginedEngineReadOnlyInterface
- MarginedEngineInterface

Implemented by

MarginedEngineClient

Properties

addWhitelist

addWhitelist: ((__namedParameters, _fee?, _memo?, _funds?) => Promise<ExecuteResult>)

Type declaration

- (__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
- Parameters
  - __namedParameters: {
    address: string;
    }
    - address: string
  - Optional _fee: number | StdFee | "auto"
  - Optional _memo: string
  - Optional _funds: Coin[]
  Returns Promise<ExecuteResult>

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>

closePosition

closePosition: ((__namedParameters, _fee?, _memo?, _funds?) => Promise<ExecuteResult>)

Type declaration

- (__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
- Parameters
  - __namedParameters: {
        positionId: number;
        quoteAssetLimit: string;
        vamm: string;
    }
    - positionId: number
    - quoteAssetLimit: string
    - vamm: string
  - Optional _fee: number | StdFee | "auto"
  - Optional _memo: string
  - Optional _funds: Coin[]
  Returns Promise<ExecuteResult>

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>

depositMargin

depositMargin: ((__namedParameters, _fee?, _memo?, _funds?) => Promise<ExecuteResult>)

Type declaration

- (__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
- Parameters
  - __namedParameters: {
        amount: string;
        positionId: number;
        vamm: string;
    }
    - amount: string
    - positionId: number
    - vamm: string
  - Optional _fee: number | StdFee | "auto"
  - Optional _memo: string
  - Optional _funds: Coin[]
  Returns Promise<ExecuteResult>

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>

liquidate

liquidate: ((__namedParameters, _fee?, _memo?, _funds?) => Promise<ExecuteResult>)

Type declaration

- (__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
- Parameters
  - __namedParameters: {
        positionId: number;
        quoteAssetLimit: string;
        vamm: string;
    }
    - positionId: number
    - quoteAssetLimit: string
    - vamm: string
  - Optional _fee: number | StdFee | "auto"
  - Optional _memo: string
  - Optional _funds: Coin[]
  Returns Promise<ExecuteResult>

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>

openPosition

openPosition: ((__namedParameters, _fee?, _memo?, _funds?) => Promise<ExecuteResult>)

Type declaration

- (__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
- Parameters
  - __namedParameters: {
        baseAssetLimit: string;
        leverage: string;
        marginAmount: string;
        side: Side;
        stopLoss?: string;
        takeProfit: string;
        vamm: string;
    }
    - baseAssetLimit: string
    - leverage: string
    - marginAmount: string
    - side: Side
    - Optional stopLoss?: string
    - takeProfit: string
    - vamm: string
  - Optional _fee: number | StdFee | "auto"
  - Optional _memo: string
  - Optional _funds: Coin[]
  Returns Promise<ExecuteResult>

payFunding

payFunding: ((__namedParameters, _fee?, _memo?, _funds?) => Promise<ExecuteResult>)

Type declaration

- (__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
- Parameters
  - __namedParameters: {
    vamm: string;
    }
    - vamm: string
  - Optional _fee: number | StdFee | "auto"
  - Optional _memo: string
  - Optional _funds: Coin[]
  Returns Promise<ExecuteResult>

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>

removeWhitelist

removeWhitelist: ((__namedParameters, _fee?, _memo?, _funds?) => Promise<ExecuteResult>)

Type declaration

- (__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
- Parameters
  - __namedParameters: {
    address: string;
    }
    - address: string
  - Optional _fee: number | StdFee | "auto"
  - Optional _memo: string
  - Optional _funds: Coin[]
  Returns Promise<ExecuteResult>

sender

sender: string

setPause

setPause: ((__namedParameters, _fee?, _memo?, _funds?) => Promise<ExecuteResult>)

Type declaration

- (__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
- Parameters
  - __namedParameters: {
    pause: boolean;
    }
    - pause: boolean
  - Optional _fee: number | StdFee | "auto"
  - Optional _memo: string
  - Optional _funds: Coin[]
  Returns Promise<ExecuteResult>

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>

triggerTpSl

triggerTpSl: ((__namedParameters, _fee?, _memo?, _funds?) => Promise<ExecuteResult>)

Type declaration

- (__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
- Parameters
  - __namedParameters: {
        positionId: number;
        quoteAssetLimit: string;
        vamm: string;
    }
    - positionId: number
    - quoteAssetLimit: string
    - vamm: string
  - Optional _fee: number | StdFee | "auto"
  - Optional _memo: string
  - Optional _funds: Coin[]
  Returns Promise<ExecuteResult>

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>

updateConfig

updateConfig: ((__namedParameters, _fee?, _memo?, _funds?) => Promise<ExecuteResult>)

Type declaration

- (__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
- Parameters
  - __namedParameters: {
        feePool?: string;
        initialMarginRatio?: string;
        insuranceFund?: string;
        liquidationFee?: string;
        maintenanceMarginRatio?: string;
        owner?: string;
        partialLiquidationRatio?: string;
        tpSlSpread?: string;
    }
    - Optional feePool?: string
    - Optional initialMarginRatio?: string
    - Optional insuranceFund?: string
    - Optional liquidationFee?: string
    - Optional maintenanceMarginRatio?: string
    - Optional owner?: string
    - Optional partialLiquidationRatio?: string
    - Optional tpSlSpread?: string
  - Optional _fee: number | StdFee | "auto"
  - Optional _memo: string
  - Optional _funds: Coin[]
  Returns Promise<ExecuteResult>

updatePauser

updatePauser: ((__namedParameters, _fee?, _memo?, _funds?) => Promise<ExecuteResult>)

Type declaration

- (__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
- Parameters
  - __namedParameters: {
    pauser: string;
    }
    - pauser: string
  - Optional _fee: number | StdFee | "auto"
  - Optional _memo: string
  - Optional _funds: Coin[]
  Returns Promise<ExecuteResult>

updateTpSl

updateTpSl: ((__namedParameters, _fee?, _memo?, _funds?) => Promise<ExecuteResult>)

Type declaration

- (__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
- Parameters
  - __namedParameters: {
        positionId: number;
        stopLoss?: string;
        takeProfit?: string;
        vamm: string;
    }
    - positionId: number
    - Optional stopLoss?: string
    - Optional takeProfit?: string
    - vamm: string
  - Optional _fee: number | StdFee | "auto"
  - Optional _memo: string
  - Optional _funds: Coin[]
  Returns Promise<ExecuteResult>

withdrawMargin

withdrawMargin: ((__namedParameters, _fee?, _memo?, _funds?) => Promise<ExecuteResult>)

Type declaration

- (__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
- Parameters
  - __namedParameters: {
        amount: string;
        positionId: number;
        vamm: string;
    }
    - amount: string
    - positionId: number
    - vamm: string
  - Optional _fee: number | StdFee | "auto"
  - Optional _memo: string
  - Optional _funds: Coin[]
  Returns Promise<ExecuteResult>

Interface MarginedEngineInterface

Hierarchy

Implemented by

Index

Properties

Properties

addWhitelist

Type declaration

Parameters

__namedParameters: { address: string; }

address: string

Optional _fee: number | StdFee | "auto"

Optional _memo: string

Optional _funds: Coin[]

Returns Promise<ExecuteResult>

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>

closePosition

Type declaration

Parameters

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

positionId: number

quoteAssetLimit: string

vamm: string

Optional _fee: number | StdFee | "auto"

Optional _memo: string

Optional _funds: Coin[]

Returns Promise<ExecuteResult>

config

Type declaration

Returns Promise<ConfigResponse>

contractAddress

cumulativePremiumFraction

Type declaration

Parameters

__namedParameters: { vamm: string; }

vamm: string

Returns Promise<Integer>

depositMargin

Type declaration

Parameters

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

amount: string

positionId: number

vamm: string

Optional _fee: number | StdFee | "auto"

Optional _memo: string

Optional _funds: Coin[]

Returns Promise<ExecuteResult>

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

__namedParameters: {
address: string;
}

`Optional` _fee: number | StdFee | "auto"

`Optional` _memo: string

`Optional` _funds: Coin[]

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

`Optional` limit?: number

`Optional` orderBy?: number

`Optional` startAfter?: number

__namedParameters: {
positionId: number;
}

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

`Optional` _fee: number | StdFee | "auto"

`Optional` _memo: string

`Optional` _funds: Coin[]

__namedParameters: {
vamm: string;
}

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

`Optional` _fee: number | StdFee | "auto"

`Optional` _memo: string

`Optional` _funds: Coin[]

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

__namedParameters: {
address: string;
}

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

`Optional` _fee: number | StdFee | "auto"

`Optional` _memo: string

`Optional` _funds: Coin[]

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

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

__namedParameters: {
baseAssetLimit: string;
leverage: string;
marginAmount: string;
side: Side;
stopLoss?: string;
takeProfit: string;
vamm: string;
}

`Optional` stopLoss?: string

`Optional` _fee: number | StdFee | "auto"

`Optional` _memo: string

`Optional` _funds: Coin[]

__namedParameters: {
vamm: string;
}

`Optional` _fee: number | StdFee | "auto"

`Optional` _memo: string

`Optional` _funds: Coin[]

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

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