Class Api<SecurityDataType>

Title

ibc/applications/transfer/v1/genesis.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 ibc.applications.transfer.v1/rest.ts:366

Properties

instance

instance: AxiosInstance

Methods

queryDenomHash

queryDenomHash(trace: string, params?: RequestParams): Promise<AxiosResponse<V1QueryDenomHashResponse>>
No description

Tags
Query

Name
QueryDenomHash

Summary
DenomHash queries a denomination hash information.

Request
GET:/ibc/apps/transfer/v1/denom_hashes/{trace}
Parameters
- trace: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryDenomHashResponse>>
- Defined in ibc.applications.transfer.v1/rest.ts:473

queryDenomTrace

queryDenomTrace(hash: string, params?: RequestParams): Promise<AxiosResponse<V1QueryDenomTraceResponse>>
No description

Tags
Query

Name
QueryDenomTrace

Summary
DenomTrace queries a denomination trace information.

Request
GET:/ibc/apps/transfer/v1/denom_traces/{hash}
Parameters
- hash: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryDenomTraceResponse>>
- Defined in ibc.applications.transfer.v1/rest.ts:515

queryDenomTraces

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

Tags
Query

Name
QueryDenomTraces

Summary
DenomTraces queries all denomination traces.

Request
GET:/ibc/apps/transfer/v1/denom_traces
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<V1QueryDenomTracesResponse>>
- Defined in ibc.applications.transfer.v1/rest.ts:489

queryEscrowAddress

queryEscrowAddress(channelId: string, portId: string, params?: RequestParams): Promise<AxiosResponse<V1QueryEscrowAddressResponse>>
No description

Tags
Query

Name
QueryEscrowAddress

Summary
EscrowAddress returns the escrow address for a particular port and channel id.

Request
GET:/ibc/apps/transfer/v1/channels/{channel_id}/ports/{port_id}/escrow_address
Parameters
- channelId: string
- portId: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryEscrowAddressResponse>>
- Defined in ibc.applications.transfer.v1/rest.ts:457

queryParams

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

Tags
Query

Name
QueryParams

Summary
Params queries all parameters of the ibc-transfer module.

Request
GET:/ibc/apps/transfer/v1/params
Parameters
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryParamsResponse>>
- Defined in ibc.applications.transfer.v1/rest.ts:531

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 ibc.applications.transfer.v1/rest.ts:405

setSecurityData

setSecurityData(data: null | SecurityDataType): void
Parameters
- data: null | SecurityDataType
Returns void
Inherited from HttpClient.setSecurityData
- Defined in ibc.applications.transfer.v1/rest.ts:373

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

queryDenomHash

Tags

Name

Summary

Request

Parameters

trace: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryDenomHashResponse>>

queryDenomTrace

Tags

Name

Summary

Request

Parameters

hash: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryDenomTraceResponse>>

queryDenomTraces

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

queryEscrowAddress

Tags

Name

Summary

Request

Parameters

channelId: string

portId: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryEscrowAddressResponse>>

queryParams

Tags

Name

Summary

Request

Parameters

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryParamsResponse>>

request

Type Parameters

T = any

_E = any

Parameters

__namedParameters: FullRequestParams

Returns Promise<AxiosResponse<T>>

setSecurityData

Parameters

data: null | SecurityDataType

`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