Class Api<SecurityDataType>

Title

cosmos/tx/v1beta1/service.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 cosmos.tx.v1beta1/rest.ts:1181

Properties

instance

instance: AxiosInstance

Methods

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 cosmos.tx.v1beta1/rest.ts:1220

serviceBroadcastTx

serviceBroadcastTx(body: V1Beta1BroadcastTxRequest, params?: RequestParams): Promise<AxiosResponse<V1Beta1BroadcastTxResponse>>
No description

Tags
Service

Name
ServiceBroadcastTx

Summary
BroadcastTx broadcast transaction.

Request
POST:/cosmos/tx/v1beta1/txs
Parameters
- body: V1Beta1BroadcastTxRequest
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1BroadcastTxResponse>>
- Defined in cosmos.tx.v1beta1/rest.ts:1320

serviceGetBlockWithTxs

serviceGetBlockWithTxs(height: string, query?: {
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1GetBlockWithTxsResponse>>
Description
Since: cosmos-sdk 0.45.2

Tags
Service

Name
ServiceGetBlockWithTxs

Summary
GetBlockWithTxs fetches a block with decoded txs.

Request
GET:/cosmos/tx/v1beta1/txs/block/{height}
Parameters
- height: 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
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1GetBlockWithTxsResponse>>
- Defined in cosmos.tx.v1beta1/rest.ts:1338

serviceGetTx

serviceGetTx(hash: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1GetTxResponse>>
No description

Tags
Service

Name
ServiceGetTx

Summary
GetTx fetches a tx by hash.

Request
GET:/cosmos/tx/v1beta1/txs/{hash}
Parameters
- hash: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1GetTxResponse>>
- Defined in cosmos.tx.v1beta1/rest.ts:1365

serviceGetTxsEvent

serviceGetTxsEvent(query?: {
    events?: string[];
    limit?: string;
    order_by?: "ORDER_BY_UNSPECIFIED" | "ORDER_BY_ASC" | "ORDER_BY_DESC";
    page?: string;
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
}, params?: RequestParams): Promise<AxiosResponse<V1Beta1GetTxsEventResponse>>
No description

Tags
Service

Name
ServiceGetTxsEvent

Summary
GetTxsEvent fetches txs by event.

Request
GET:/cosmos/tx/v1beta1/txs
Parameters
- Optional query: {
      events?: string[];
      limit?: string;
      order_by?: "ORDER_BY_UNSPECIFIED" | "ORDER_BY_ASC" | "ORDER_BY_DESC";
      page?: string;
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
  }
  - Optional events?: string[]
  - Optional limit?: string
  - Optional order_by?: "ORDER_BY_UNSPECIFIED" | "ORDER_BY_ASC" | "ORDER_BY_DESC"
  - Optional page?: string
  - 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<V1Beta1GetTxsEventResponse>>
- Defined in cosmos.tx.v1beta1/rest.ts:1290

serviceSimulate

serviceSimulate(body: V1Beta1SimulateRequest, params?: RequestParams): Promise<AxiosResponse<V1Beta1SimulateResponse>>
No description

Tags
Service

Name
ServiceSimulate

Summary
Simulate simulates executing a transaction for estimating gas usage.

Request
POST:/cosmos/tx/v1beta1/simulate
Parameters
- body: V1Beta1SimulateRequest
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1SimulateResponse>>
- Defined in cosmos.tx.v1beta1/rest.ts:1272

setSecurityData

setSecurityData(data: null | SecurityDataType): void
Parameters
- data: null | SecurityDataType
Returns void
Inherited from HttpClient.setSecurityData
- Defined in cosmos.tx.v1beta1/rest.ts:1188

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

request

Type Parameters

T = any

_E = any

Parameters

__namedParameters: FullRequestParams

Returns Promise<AxiosResponse<T>>

serviceBroadcastTx

Tags

Name

Summary

Request

Parameters

body: V1Beta1BroadcastTxRequest

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1BroadcastTxResponse>>

serviceGetBlockWithTxs

Description

Tags

Name

Summary

Request

Parameters

height: 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

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1GetBlockWithTxsResponse>>

serviceGetTx

Tags

Name

Summary

Request

Parameters

hash: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1GetTxResponse>>

serviceGetTxsEvent

Tags

Name

Summary

Request

Parameters

Optional query: { events?: string[]; limit?: string; order_by?: "ORDER_BY_UNSPECIFIED" | "ORDER_BY_ASC" | "ORDER_BY_DESC"; page?: string; pagination.count_total?: boolean; pagination.key?: string; pagination.limit?: string; pagination.offset?: string; pagination.reverse?: boolean; }

Optional events?: string[]

Optional limit?: string

Optional order_by?: "ORDER_BY_UNSPECIFIED" | "ORDER_BY_ASC" | "ORDER_BY_DESC"

Optional page?: string

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

serviceSimulate

`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

`Optional` query: {
events?: string[];
limit?: string;
order_by?: "ORDER_BY_UNSPECIFIED" | "ORDER_BY_ASC" | "ORDER_BY_DESC";
page?: string;
pagination.count_total?: boolean;
pagination.key?: string;
pagination.limit?: string;
pagination.offset?: string;
pagination.reverse?: boolean;
}

`Optional` events?: string[]

`Optional` limit?: string

`Optional` order_by?: "ORDER_BY_UNSPECIFIED" | "ORDER_BY_ASC" | "ORDER_BY_DESC"

`Optional` page?: string

`Optional` pagination.count_total?: boolean

`Optional` pagination.key?: string

`Optional` pagination.limit?: string

`Optional` pagination.offset?: string

`Optional` pagination.reverse?: boolean