Class MarginedInsuranceFundClient

- Insurance fund contains funds that are used to cover shortfall(slippage) in funding payments, additionally insurance fund accrues a portion of transaction fees and profits.

Hierarchy

MarginedInsuranceFundQueryClient
- MarginedInsuranceFundClient

Implements

MarginedInsuranceFundInterface

Index

Constructors

constructor

new MarginedInsuranceFundClient(client, sender, contractAddress): MarginedInsuranceFundClient
Parameters
- client: SigningCosmWasmClient
- sender: string
- contractAddress: string
Returns MarginedInsuranceFundClient
Overrides MarginedInsuranceFundQueryClient.constructor
- Defined in packages/contracts-sdk/src/MarginedInsuranceFund.client.ts:158

Properties

client

client: SigningCosmWasmClient

contractAddress

contractAddress: string

sender

sender: string

Methods

addVamm

addVamm(__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
Append vamm to list of supported vAMMs.
Parameters
- __namedParameters: {
  vamm: string;
  }
  - vamm: string
- _fee: number | StdFee | "auto" = "auto"
- Optional _memo: string
- Optional _funds: Coin[]
Returns Promise<ExecuteResult>
Implementation of MarginedInsuranceFundInterface.addVamm
- Defined in packages/contracts-sdk/src/MarginedInsuranceFund.client.ts:186

config

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

Returns Promise<ConfigResponse>
Implementation of MarginedInsuranceFundInterface.config

Inherited from MarginedInsuranceFundQueryClient.config
- Defined in packages/contracts-sdk/src/MarginedInsuranceFund.client.ts:53

getAllVamm

getAllVamm(__namedParameters): Promise<AllVammResponse>
Returns list of supported vAMMs.
Parameters
- __namedParameters: {
  limit?: number;
  }
  - Optional limit?: number
Returns Promise<AllVammResponse>
Implementation of MarginedInsuranceFundInterface.getAllVamm

Inherited from MarginedInsuranceFundQueryClient.getAllVamm
- Defined in packages/contracts-sdk/src/MarginedInsuranceFund.client.ts:83

getAllVammStatus

getAllVammStatus(__namedParameters): Promise<AllVammStatusResponse>
Returns the status of all vAMMs supported.
Parameters
- __namedParameters: {
  limit?: number;
  }
  - Optional limit?: number
Returns Promise<AllVammStatusResponse>
Implementation of MarginedInsuranceFundInterface.getAllVammStatus

Inherited from MarginedInsuranceFundQueryClient.getAllVammStatus
- Defined in packages/contracts-sdk/src/MarginedInsuranceFund.client.ts:97

getOwner

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

Returns Promise<OwnerResponse>
Implementation of MarginedInsuranceFundInterface.getOwner

Inherited from MarginedInsuranceFundQueryClient.getOwner
- Defined in packages/contracts-sdk/src/MarginedInsuranceFund.client.ts:61

getVammStatus

getVammStatus(__namedParameters): Promise<VammStatusResponse>
Returns the status of a specific vAMM.
Parameters
- __namedParameters: {
  vamm: string;
  }
  - vamm: string
Returns Promise<VammStatusResponse>
Implementation of MarginedInsuranceFundInterface.getVammStatus

Inherited from MarginedInsuranceFundQueryClient.getVammStatus
- Defined in packages/contracts-sdk/src/MarginedInsuranceFund.client.ts:111

isVamm

isVamm(__namedParameters): Promise<VammResponse>
Returns bool showing if vamm is supported.
Parameters
- __namedParameters: {
  vamm: string;
  }
  - vamm: string
Returns Promise<VammResponse>
Implementation of MarginedInsuranceFundInterface.isVamm

Inherited from MarginedInsuranceFundQueryClient.isVamm
- Defined in packages/contracts-sdk/src/MarginedInsuranceFund.client.ts:69

removeVamm

removeVamm(__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
Remove vamm from list of supported vAMMs.
Parameters
- __namedParameters: {
  vamm: string;
  }
  - vamm: string
- _fee: number | StdFee | "auto" = "auto"
- Optional _memo: string
- Optional _funds: Coin[]
Returns Promise<ExecuteResult>
Implementation of MarginedInsuranceFundInterface.removeVamm
- Defined in packages/contracts-sdk/src/MarginedInsuranceFund.client.ts:200

shutdownVamms

shutdownVamms(_fee?, _memo?, _funds?): Promise<ExecuteResult>
Emergency shutdown function that halts all vAMMs trading.
Parameters
- _fee: number | StdFee | "auto" = "auto"
- Optional _memo: string
- Optional _funds: Coin[]
Returns Promise<ExecuteResult>
Implementation of MarginedInsuranceFundInterface.shutdownVamms
- Defined in packages/contracts-sdk/src/MarginedInsuranceFund.client.ts:231

updateOwner

updateOwner(__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
Enables transfer of contract ownership and the beneficiary of insurance funds. Beneficiary is an address that is able to request funds held by the insurance fund contract.
Parameters
- __namedParameters: {
  owner: string;
  }
  - owner: string
- _fee: number | StdFee | "auto" = "auto"
- Optional _memo: string
- Optional _funds: Coin[]
Returns Promise<ExecuteResult>
Implementation of MarginedInsuranceFundInterface.updateOwner
- Defined in packages/contracts-sdk/src/MarginedInsuranceFund.client.ts:172

withdraw

withdraw(__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
Enables the beneficiary to request contract funds.
Parameters
- __namedParameters: {
  amount: string;
  token: AssetInfo;
  }
  - amount: string
  - token: AssetInfo
- _fee: number | StdFee | "auto" = "auto"
- Optional _memo: string
- Optional _funds: Coin[]
Returns Promise<ExecuteResult>
Implementation of MarginedInsuranceFundInterface.withdraw
- Defined in packages/contracts-sdk/src/MarginedInsuranceFund.client.ts:214

Class MarginedInsuranceFundClient

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: SigningCosmWasmClient

sender: string

contractAddress: string

Returns MarginedInsuranceFundClient

Properties

client

contractAddress

sender

Methods

addVamm

Parameters

__namedParameters: { vamm: string; }

vamm: string

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

Optional _memo: string

Optional _funds: Coin[]

Returns Promise<ExecuteResult>

config

Returns Promise<ConfigResponse>

getAllVamm

Parameters

__namedParameters: { limit?: number; }

Optional limit?: number

Returns Promise<AllVammResponse>

getAllVammStatus

Parameters

__namedParameters: { limit?: number; }

Optional limit?: number

Returns Promise<AllVammStatusResponse>

getOwner

Returns Promise<OwnerResponse>

getVammStatus

Parameters

__namedParameters: { vamm: string; }

vamm: string

Returns Promise<VammStatusResponse>

isVamm

Parameters

__namedParameters: { vamm: string; }

vamm: string

Returns Promise<VammResponse>

removeVamm

Parameters

__namedParameters: { vamm: string; }

vamm: string

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

Optional _memo: string

Optional _funds: Coin[]

Returns Promise<ExecuteResult>

shutdownVamms

Parameters

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

Optional _memo: string

Optional _funds: Coin[]

Returns Promise<ExecuteResult>

updateOwner

Parameters

__namedParameters: { owner: string; }

owner: string

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

Optional _memo: string

Optional _funds: Coin[]

Returns Promise<ExecuteResult>

withdraw

Parameters

__namedParameters: { amount: string; token: AssetInfo; }

amount: string

token: AssetInfo

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

Optional _memo: string

__namedParameters: {
vamm: string;
}

`Optional` _memo: string

`Optional` _funds: Coin[]

__namedParameters: {
limit?: number;
}

`Optional` limit?: number

__namedParameters: {
limit?: number;
}

`Optional` limit?: number

__namedParameters: {
vamm: string;
}

__namedParameters: {
vamm: string;
}

__namedParameters: {
vamm: string;
}

`Optional` _memo: string

`Optional` _funds: Coin[]

`Optional` _memo: string

`Optional` _funds: Coin[]

__namedParameters: {
owner: string;
}

`Optional` _memo: string

`Optional` _funds: Coin[]

__namedParameters: {
amount: string;
token: AssetInfo;
}

`Optional` _memo: string

`Optional` _funds: Coin[]