Class MarginedVammClient

- The vAMM is the contract that enables user's to take perpetual positions through its "virtual" automated market maker.

Hierarchy

MarginedVammQueryClient
- MarginedVammClient

Implements

MarginedVammInterface

Constructors

constructor

new MarginedVammClient(client, sender, contractAddress): MarginedVammClient
Parameters
- client: SigningCosmWasmClient
- sender: string
- contractAddress: string
Returns MarginedVammClient
Overrides MarginedVammQueryClient.constructor
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:386

Properties

client

client: SigningCosmWasmClient

contractAddress

contractAddress: string

sender

sender: string

Methods

calcFee

calcFee(__namedParameters): Promise<CalcFeeResponse>
Returns the total (i.e. toll + spread) fees for an amount.
Parameters
- __namedParameters: {
  quoteAssetAmount: string;
  }
  - quoteAssetAmount: string
Returns Promise<CalcFeeResponse>
Implementation of MarginedVammInterface.calcFee

Inherited from MarginedVammQueryClient.calcFee
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:281

config

config(): Promise<ConfigResponse>
Returns contract configuration.

Returns Promise<ConfigResponse>
Implementation of MarginedVammInterface.config

Inherited from MarginedVammQueryClient.config
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:111

getOwner

getOwner(): Promise<OwnerResponse>
Returns the owner of the contract.

Returns Promise<OwnerResponse>
Implementation of MarginedVammInterface.getOwner

Inherited from MarginedVammQueryClient.getOwner
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:127

inputAmount

inputAmount(__namedParameters): Promise<string>
Returns the amount for a trade of input with a given size.
Parameters
- __namedParameters: {
  amount: string;
  direction: Direction;
  }
  - amount: string
  - direction: Direction
Returns Promise<string>
Implementation of MarginedVammInterface.inputAmount

Inherited from MarginedVammQueryClient.inputAmount
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:169

inputPrice

inputPrice(__namedParameters): Promise<string>
Returns the average price for a trade of a given size.
Parameters
- __namedParameters: {
  amount: string;
  direction: Direction;
  }
  - amount: string
  - direction: Direction
Returns Promise<string>
Implementation of MarginedVammInterface.inputPrice

Inherited from MarginedVammQueryClient.inputPrice
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:135

inputTwap

inputTwap(__namedParameters): Promise<string>
Returns input twap price of the vAMM, using the reserve snapshots, default 15 minutes interval.
Parameters
- __namedParameters: {
  amount: string;
  direction: Direction;
  }
  - amount: string
  - direction: Direction
Returns Promise<string>
Implementation of MarginedVammInterface.inputTwap

Inherited from MarginedVammQueryClient.inputTwap
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:203

isOverFluctuationLimit

isOverFluctuationLimit(__namedParameters): Promise<boolean>
Returns bool to show is fluctuation limit has been exceeded.
Parameters
- __namedParameters: {
  baseAssetAmount: string;
  direction: Direction;
  }
  - baseAssetAmount: string
  - direction: Direction
Returns Promise<boolean>
Implementation of MarginedVammInterface.isOverFluctuationLimit

Inherited from MarginedVammQueryClient.isOverFluctuationLimit
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:303

isOverSpreadLimit

isOverSpreadLimit(): Promise<boolean>
Returns bool to show is spread limit has been exceeded.

Returns Promise<boolean>
Implementation of MarginedVammInterface.isOverSpreadLimit

Inherited from MarginedVammQueryClient.isOverSpreadLimit
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:295

outputAmount

outputAmount(__namedParameters): Promise<string>
Returns the amount for a trade of output with a given size.
Parameters
- __namedParameters: {
  amount: string;
  direction: Direction;
  }
  - amount: string
  - direction: Direction
Returns Promise<string>
Implementation of MarginedVammInterface.outputAmount

Inherited from MarginedVammQueryClient.outputAmount
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:186

outputPrice

outputPrice(__namedParameters): Promise<string>
Returns the average price for a trade of a given size.
Parameters
- __namedParameters: {
  amount: string;
  direction: Direction;
  }
  - amount: string
  - direction: Direction
Returns Promise<string>
Implementation of MarginedVammInterface.outputPrice

Inherited from MarginedVammQueryClient.outputPrice
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:152

outputTwap

outputTwap(__namedParameters): Promise<string>
Returns output twap price of the vAMM, using the reserve snapshots, default 15 minutes interval.
Parameters
- __namedParameters: {
  amount: string;
  direction: Direction;
  }
  - amount: string
  - direction: Direction
Returns Promise<string>
Implementation of MarginedVammInterface.outputTwap

Inherited from MarginedVammQueryClient.outputTwap
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:220

setOpen

setOpen(__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
Allows owner to open the vAMM enable positions to be taken.
Parameters
- __namedParameters: {
  open: boolean;
  }
  - open: boolean
- _fee: number | StdFee | "auto" = "auto"
- Optional _memo: string
- Optional _funds: Coin[]
Returns Promise<ExecuteResult>
Implementation of MarginedVammInterface.setOpen
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:516

settleFunding

settleFunding(_fee?, _memo?, _funds?): Promise<ExecuteResult>
Calculates the funding payments due.
Parameters
- _fee: number | StdFee | "auto" = "auto"
- Optional _memo: string
- Optional _funds: Coin[]
Returns Promise<ExecuteResult>
Implementation of MarginedVammInterface.settleFunding
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:508

spotPrice

spotPrice(): Promise<string>
Returns spot price of the vAMM.

Returns Promise<string>
Implementation of MarginedVammInterface.spotPrice

Inherited from MarginedVammQueryClient.spotPrice
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:237

state

state(): Promise<StateResponse>
Returns contract state, including liquidity etc.

Returns Promise<StateResponse>
Implementation of MarginedVammInterface.state

Inherited from MarginedVammQueryClient.state
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:119

swapInput

swapInput(__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
Allows the margin engine to swap quote asset into the vAMM.
Parameters
- __namedParameters: {
      baseAssetLimit: string;
      canGoOverFluctuation: boolean;
      direction: Direction;
      positionId: number;
      quoteAssetAmount: string;
  }
  - baseAssetLimit: string
  - canGoOverFluctuation: boolean
  - direction: Direction
  - positionId: number
  - quoteAssetAmount: string
- _fee: number | StdFee | "auto" = "auto"
- Optional _memo: string
- Optional _funds: Coin[]
Returns Promise<ExecuteResult>
Implementation of MarginedVammInterface.swapInput
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:459

swapOutput

swapOutput(__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
Allows the margin engine to swap base asset into the vAMM.
Parameters
- __namedParameters: {
      baseAssetAmount: string;
      direction: Direction;
      positionId: number;
      quoteAssetLimit: string;
  }
  - baseAssetAmount: string
  - direction: Direction
  - positionId: number
  - quoteAssetLimit: string
- _fee: number | StdFee | "auto" = "auto"
- Optional _memo: string
- Optional _funds: Coin[]
Returns Promise<ExecuteResult>
Implementation of MarginedVammInterface.swapOutput
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:485

twapPrice

twapPrice(__namedParameters): Promise<string>
Return twap price of the vAMM, using the reserve snapshots.
Parameters
- __namedParameters: {
  interval: number;
  }
  - interval: number
Returns Promise<string>
Implementation of MarginedVammInterface.twapPrice

Inherited from MarginedVammQueryClient.twapPrice
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:245

underlyingPrice

underlyingPrice(): Promise<string>
Returns latest price from PriceFeed contract.

Returns Promise<string>
Implementation of MarginedVammInterface.underlyingPrice

Inherited from MarginedVammQueryClient.underlyingPrice
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:259

underlyingTwapPrice

underlyingTwapPrice(__namedParameters): Promise<string>
Returns a twap price from PriceFeed contract.
Parameters
- __namedParameters: {
  interval: number;
  }
  - interval: number
Returns Promise<string>
Implementation of MarginedVammInterface.underlyingTwapPrice

Inherited from MarginedVammQueryClient.underlyingTwapPrice
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:267

updateConfig

updateConfig(__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
Enables owner to update key contract parameters.
```
vammContract.updateConfig({
 tollRatio: '0'
});
```
Parameters
- __namedParameters: {
      baseAssetHoldingCap?: string;
      fluctuationLimitRatio?: string;
      insuranceFund?: string;
      marginEngine?: string;
      openInterestNotionalCap?: string;
      pricefeed?: string;
      spotPriceTwapInterval?: number;
      spreadRatio?: string;
      tollRatio?: string;
  }
  - Optional baseAssetHoldingCap?: string
  - Optional fluctuationLimitRatio?: string
  - Optional insuranceFund?: string
  - Optional marginEngine?: string
  - Optional openInterestNotionalCap?: string
  - Optional pricefeed?: string
  - Optional spotPriceTwapInterval?: number
  - Optional spreadRatio?: string
  - Optional tollRatio?: string
- _fee: number | StdFee | "auto" = "auto"
- Optional _memo: string
- Optional _funds: Coin[]
Returns Promise<ExecuteResult>
Implementation of MarginedVammInterface.updateConfig
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:407

updateOwner

updateOwner(__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
Transfers the contract owner.
Parameters
- __namedParameters: {
  owner: string;
  }
  - owner: string
- _fee: number | StdFee | "auto" = "auto"
- Optional _memo: string
- Optional _funds: Coin[]
Returns Promise<ExecuteResult>
Implementation of MarginedVammInterface.updateOwner
- Defined in packages/contracts-sdk/src/MarginedVamm.client.ts:445

Class MarginedVammClient

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: SigningCosmWasmClient

sender: string

contractAddress: string

Returns MarginedVammClient

Properties

client

contractAddress

sender

Methods

calcFee

Parameters

__namedParameters: { quoteAssetAmount: string; }

quoteAssetAmount: string

Returns Promise<CalcFeeResponse>

config

Returns Promise<ConfigResponse>

getOwner

Returns Promise<OwnerResponse>

inputAmount

Parameters

__namedParameters: { amount: string; direction: Direction; }

amount: string

direction: Direction

Returns Promise<string>

inputPrice

Parameters

__namedParameters: { amount: string; direction: Direction; }

amount: string

direction: Direction

Returns Promise<string>

inputTwap

Parameters

__namedParameters: { amount: string; direction: Direction; }

amount: string

direction: Direction

Returns Promise<string>

isOverFluctuationLimit

Parameters

__namedParameters: { baseAssetAmount: string; direction: Direction; }

baseAssetAmount: string

direction: Direction

Returns Promise<boolean>

isOverSpreadLimit

Returns Promise<boolean>

outputAmount

Parameters

__namedParameters: { amount: string; direction: Direction; }

amount: string

direction: Direction

Returns Promise<string>

outputPrice

Parameters

__namedParameters: { amount: string; direction: Direction; }

amount: string

direction: Direction

Returns Promise<string>

outputTwap

Parameters

__namedParameters: { amount: string; direction: Direction; }

amount: string

direction: Direction

Returns Promise<string>

setOpen

Parameters

__namedParameters: { open: boolean; }

open: boolean

_fee: number | StdFee | "auto" = "auto"

Optional _memo: string

Optional _funds: Coin[]

Returns Promise<ExecuteResult>

__namedParameters: {
quoteAssetAmount: string;
}

__namedParameters: {
amount: string;
direction: Direction;
}

__namedParameters: {
amount: string;
direction: Direction;
}

__namedParameters: {
amount: string;
direction: Direction;
}

__namedParameters: {
baseAssetAmount: string;
direction: Direction;
}

__namedParameters: {
amount: string;
direction: Direction;
}

__namedParameters: {
amount: string;
direction: Direction;
}

__namedParameters: {
amount: string;
direction: Direction;
}

__namedParameters: {
open: boolean;
}

`Optional` _memo: string

`Optional` _funds: Coin[]

`Optional` _memo: string

`Optional` _funds: Coin[]

__namedParameters: {
baseAssetLimit: string;
canGoOverFluctuation: boolean;
direction: Direction;
positionId: number;
quoteAssetAmount: string;
}

`Optional` _memo: string

`Optional` _funds: Coin[]

__namedParameters: {
baseAssetAmount: string;
direction: Direction;
positionId: number;
quoteAssetLimit: string;
}

`Optional` _memo: string

`Optional` _funds: Coin[]

__namedParameters: {
interval: number;
}

__namedParameters: {
interval: number;
}

__namedParameters: {
baseAssetHoldingCap?: string;
fluctuationLimitRatio?: string;
insuranceFund?: string;
marginEngine?: string;
openInterestNotionalCap?: string;
pricefeed?: string;
spotPriceTwapInterval?: number;
spreadRatio?: string;
tollRatio?: string;
}

`Optional` baseAssetHoldingCap?: string

`Optional` fluctuationLimitRatio?: string

`Optional` insuranceFund?: string

`Optional` marginEngine?: string

`Optional` openInterestNotionalCap?: string

`Optional` pricefeed?: string

`Optional` spotPriceTwapInterval?: number

`Optional` spreadRatio?: string

`Optional` tollRatio?: string

`Optional` _memo: string

`Optional` _funds: Coin[]

__namedParameters: {
owner: string;
}

`Optional` _memo: string

`Optional` _funds: Coin[]