Class Api<SecurityDataType>

Title

erc20/v1/erc20.proto

Version

version not set

Type Parameters

SecurityDataType extends unknown

Hierarchy

HttpClient<SecurityDataType>
- Api

Index

Constructors

constructor

new Api<SecurityDataType>(__namedParameters?: ApiConfig<SecurityDataType>): Api<SecurityDataType>
Type Parameters
- SecurityDataType extends unknown
Parameters
- __namedParameters: ApiConfig<SecurityDataType> = {}
Returns Api<SecurityDataType>
Inherited from HttpClient.constructor
- Defined in spidex.erc20.v1/rest.ts:228

Properties

instance

instance: AxiosInstance

Methods

msgConvertCoin

msgConvertCoin(query?: {
    coin.amount?: string;
    coin.denom?: string;
    receiver?: string;
    sender?: string;
}, params?: RequestParams): Promise<AxiosResponse<object>>
No description

Tags
Msg

Name
MsgConvertCoin

Summary
ConvertCoin mints a ERC20 representation of the native Cosmos coin denom that is registered on the token mapping.

Request
GET:/spidex/erc20/v1/tx/convert_coin
Parameters
- Optional query: {
      coin.amount?: string;
      coin.denom?: string;
      receiver?: string;
      sender?: string;
  }
  - Optional coin.amount?: string
  - Optional coin.denom?: string
  - Optional receiver?: string
  - Optional sender?: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<object>>
- Defined in spidex.erc20.v1/rest.ts:378

msgConvertERC20

msgConvertERC20(query?: {
    amount?: string;
    contract_address?: string;
    receiver?: string;
    sender?: string;
}, params?: RequestParams): Promise<AxiosResponse<object>>
No description

Tags
Msg

Name
MsgConvertErc20

Summary
ConvertERC20 mints a native Cosmos coin representation of the ERC20 token contract that is registered on the token mapping.

Request
GET:/spidex/erc20/v1/tx/convert_erc20
Parameters
- Optional query: {
      amount?: string;
      contract_address?: string;
      receiver?: string;
      sender?: string;
  }
  - Optional amount?: string
  - Optional contract_address?: string
  - Optional receiver?: string
  - Optional sender?: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<object>>
- Defined in spidex.erc20.v1/rest.ts:399

queryParams

queryParams(params?: RequestParams): Promise<AxiosResponse<V1QueryParamsResponse>>
No description

Tags
Query

Name
QueryParams

Summary
Params retrieves the erc20 module params

Request
GET:/spidex/erc20/v1/params
Parameters
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryParamsResponse>>
- Defined in spidex.erc20.v1/rest.ts:319

queryTokenPair

queryTokenPair(token: string, params?: RequestParams): Promise<AxiosResponse<V1QueryTokenPairResponse>>
No description

Tags
Query

Name
QueryTokenPair

Summary
TokenPair retrieves a registered token pair

Request
GET:/spidex/erc20/v1/token_pairs/{token}
Parameters
- token: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryTokenPairResponse>>
- Defined in spidex.erc20.v1/rest.ts:361

queryTokenPairs

queryTokenPairs(query?: {
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1QueryTokenPairsResponse>>
No description

Tags
Query

Name
QueryTokenPairs

Summary
TokenPairs retrieves registered token pairs

Request
GET:/spidex/erc20/v1/token_pairs
Parameters
- Optional query: {
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
  }
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryTokenPairsResponse>>
- Defined in spidex.erc20.v1/rest.ts:335

request

request<T, _E>(__namedParameters: FullRequestParams): Promise<AxiosResponse<T>>
Type Parameters
- T = any
- _E = any
Parameters
- __namedParameters: FullRequestParams
Returns Promise<AxiosResponse<T>>
Inherited from HttpClient.request
- Defined in spidex.erc20.v1/rest.ts:267

setSecurityData

setSecurityData(data: null | SecurityDataType): void
Parameters
- data: null | SecurityDataType
Returns void
Inherited from HttpClient.setSecurityData
- Defined in spidex.erc20.v1/rest.ts:235

Class Api<SecurityDataType>

Title

Version

Type Parameters

SecurityDataType extends unknown

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

SecurityDataType extends unknown

Parameters

__namedParameters: ApiConfig<SecurityDataType> = {}

Returns Api<SecurityDataType>

Properties

instance

Methods

msgConvertCoin

Tags

Name

Summary

Request

Parameters

Optional query: { coin.amount?: string; coin.denom?: string; receiver?: string; sender?: string; }

Optional coin.amount?: string

Optional coin.denom?: string

Optional receiver?: string

Optional sender?: string

params: RequestParams = {}

Returns Promise<AxiosResponse<object>>

msgConvertERC20

Tags

Name

Summary

Request

Parameters

Optional query: { amount?: string; contract_address?: string; receiver?: string; sender?: string; }

Optional amount?: string

Optional contract_address?: string

Optional receiver?: string

Optional sender?: string

params: RequestParams = {}

Returns Promise<AxiosResponse<object>>

queryParams

Tags

Name

Summary

Request

Parameters

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryParamsResponse>>

queryTokenPair

Tags

Name

Summary

Request

Parameters

token: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryTokenPairResponse>>

queryTokenPairs

Tags

Name

Summary

Request

Parameters

Optional query: { pagination.count_total?: boolean; pagination.key?: string; pagination.limit?: string; pagination.offset?: string; pagination.reverse?: boolean; }

Optional pagination.count_total?: boolean

Optional pagination.key?: string

Optional pagination.limit?: string

Optional pagination.offset?: string

Optional pagination.reverse?: boolean

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryTokenPairsResponse>>

request

Type Parameters

T = any

`Optional` query: {
coin.amount?: string;
coin.denom?: string;
receiver?: string;
sender?: string;
}

`Optional` coin.amount?: string

`Optional` coin.denom?: string

`Optional` receiver?: string

`Optional` sender?: string

`Optional` query: {
amount?: string;
contract_address?: string;
receiver?: string;
sender?: string;
}

`Optional` amount?: string

`Optional` contract_address?: string

`Optional` receiver?: string

`Optional` sender?: string

`Optional` query: {
pagination.count_total?: boolean;
pagination.key?: string;
pagination.limit?: string;
pagination.offset?: string;
pagination.reverse?: boolean;
}

`Optional` pagination.count_total?: boolean

`Optional` pagination.key?: string

`Optional` pagination.limit?: string

`Optional` pagination.offset?: string

`Optional` pagination.reverse?: boolean