Class MarginedFeePoolClient

- The Fee Pool is simply a contract that accrues the fees generated by the protocol.

Hierarchy

MarginedFeePoolQueryClient
- MarginedFeePoolClient

Implements

MarginedFeePoolInterface

Index

Constructors

constructor

new MarginedFeePoolClient(client, sender, contractAddress): MarginedFeePoolClient
Parameters
- client: SigningCosmWasmClient
- sender: string
- contractAddress: string
Returns MarginedFeePoolClient
Overrides MarginedFeePoolQueryClient.constructor
- Defined in packages/contracts-sdk/src/MarginedFeePool.client.ts:129

Properties

client

client: SigningCosmWasmClient

contractAddress

contractAddress: string

sender

sender: string

Methods

addToken

addToken(__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
Append token to be accepted for fee payments.
Parameters
- __namedParameters: {
  token: string;
  }
  - token: string
- _fee: number | StdFee | "auto" = "auto"
- Optional _memo: string
- Optional _funds: Coin[]
Returns Promise<ExecuteResult>
Implementation of MarginedFeePoolInterface.addToken
- Defined in packages/contracts-sdk/src/MarginedFeePool.client.ts:156

config

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

Returns Promise<ConfigResponse>
Implementation of MarginedFeePoolInterface.config

Inherited from MarginedFeePoolQueryClient.config
- Defined in packages/contracts-sdk/src/MarginedFeePool.client.ts:43

getOwner

getOwner(): Promise<OwnerResponse>
Returns contract owner

Returns Promise<OwnerResponse>
Implementation of MarginedFeePoolInterface.getOwner

Inherited from MarginedFeePoolQueryClient.getOwner
- Defined in packages/contracts-sdk/src/MarginedFeePool.client.ts:51

getTokenLength

getTokenLength(): Promise<TokenLengthResponse>
Returns number of tokens accepted as fees.

Returns Promise<TokenLengthResponse>
Implementation of MarginedFeePoolInterface.getTokenLength

Inherited from MarginedFeePoolQueryClient.getTokenLength
- Defined in packages/contracts-sdk/src/MarginedFeePool.client.ts:73

getTokenList

getTokenList(__namedParameters): Promise<AllTokenResponse>
Returns list of fee tokens.
Parameters
- __namedParameters: {
  limit?: number;
  }
  - Optional limit?: number
Returns Promise<AllTokenResponse>
Implementation of MarginedFeePoolInterface.getTokenList

Inherited from MarginedFeePoolQueryClient.getTokenList
- Defined in packages/contracts-sdk/src/MarginedFeePool.client.ts:81

isToken

isToken(__namedParameters): Promise<TokenResponse>
Returns bool showing if token is accepted as fees.
Parameters
- __namedParameters: {
  token: string;
  }
  - token: string
Returns Promise<TokenResponse>
Implementation of MarginedFeePoolInterface.isToken

Inherited from MarginedFeePoolQueryClient.isToken
- Defined in packages/contracts-sdk/src/MarginedFeePool.client.ts:59

removeToken

removeToken(__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
Remove token that is to be accepted for fee payments.
Parameters
- __namedParameters: {
  token: string;
  }
  - token: string
- _fee: number | StdFee | "auto" = "auto"
- Optional _memo: string
- Optional _funds: Coin[]
Returns Promise<ExecuteResult>
Implementation of MarginedFeePoolInterface.removeToken
- Defined in packages/contracts-sdk/src/MarginedFeePool.client.ts:170

sendToken

sendToken(__namedParameters, _fee?, _memo?, _funds?): Promise<ExecuteResult>
Transfer tokens held by fee pool to a recipient address.
Parameters
- __namedParameters: {
      amount: string;
      recipient: string;
      token: string;
  }
  - amount: string
  - recipient: string
  - token: string
- _fee: number | StdFee | "auto" = "auto"
- Optional _memo: string
- Optional _funds: Coin[]
Returns Promise<ExecuteResult>
Implementation of MarginedFeePoolInterface.sendToken
- Defined in packages/contracts-sdk/src/MarginedFeePool.client.ts:184

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 MarginedFeePoolInterface.updateOwner
- Defined in packages/contracts-sdk/src/MarginedFeePool.client.ts:142

Class MarginedFeePoolClient

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: SigningCosmWasmClient

sender: string

contractAddress: string

Returns MarginedFeePoolClient

Properties

client

contractAddress

sender

Methods

addToken

Parameters

__namedParameters: { token: string; }

token: string

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

Optional _memo: string

Optional _funds: Coin[]

Returns Promise<ExecuteResult>

config

Returns Promise<ConfigResponse>

getOwner

Returns Promise<OwnerResponse>

getTokenLength

Returns Promise<TokenLengthResponse>

getTokenList

Parameters

__namedParameters: { limit?: number; }

Optional limit?: number

Returns Promise<AllTokenResponse>

isToken

Parameters

__namedParameters: { token: string; }

token: string

Returns Promise<TokenResponse>

removeToken

Parameters

__namedParameters: { token: string; }

token: string

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

Optional _memo: string

Optional _funds: Coin[]

Returns Promise<ExecuteResult>

sendToken

Parameters

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

amount: string

recipient: string

token: string

_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>

Settings

Member Visibility

Theme

On This Page

__namedParameters: {
token: string;
}

`Optional` _memo: string

`Optional` _funds: Coin[]

__namedParameters: {
limit?: number;
}

`Optional` limit?: number

__namedParameters: {
token: string;
}

__namedParameters: {
token: string;
}

`Optional` _memo: string

`Optional` _funds: Coin[]

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

`Optional` _memo: string

`Optional` _funds: Coin[]

__namedParameters: {
owner: string;
}

`Optional` _memo: string

`Optional` _funds: Coin[]