Class Api<SecurityDataType>

Title

cosmos/auth/v1beta1/auth.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.auth.v1beta1/rest.ts:405

Properties

instance

instance: AxiosInstance

Methods

queryAccount

queryAccount(address: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryAccountResponse>>
No description

Tags
Query

Name
QueryAccount

Summary
Account returns account details based on address.

Request
GET:/cosmos/auth/v1beta1/accounts/{address}
Parameters
- address: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryAccountResponse>>
- Defined in cosmos.auth.v1beta1/rest.ts:522

queryAccountAddressByID

queryAccountAddressByID(id: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryAccountAddressByIDResponse>>
Description
Since: cosmos-sdk 0.46.2

Tags
Query

Name
QueryAccountAddressById

Summary
AccountAddressByID returns account address based on account number.

Request
GET:/cosmos/auth/v1beta1/address_by_id/{id}
Parameters
- id: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryAccountAddressByIDResponse>>
- Defined in cosmos.auth.v1beta1/rest.ts:538

queryAccounts

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

Tags
Query

Name
QueryAccounts

Summary
Accounts returns all the existing accounts

Request
GET:/cosmos/auth/v1beta1/accounts
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<V1Beta1QueryAccountsResponse>>
- Defined in cosmos.auth.v1beta1/rest.ts:496

queryAddressBytesToString

queryAddressBytesToString(addressBytes: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1AddressBytesToStringResponse>>
Description
Since: cosmos-sdk 0.46

Tags
Query

Name
QueryAddressBytesToString

Summary
AddressBytesToString converts Account Address bytes to string

Request
GET:/cosmos/auth/v1beta1/bech32/{address_bytes}
Parameters
- addressBytes: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1AddressBytesToStringResponse>>
- Defined in cosmos.auth.v1beta1/rest.ts:570

queryAddressStringToBytes

queryAddressStringToBytes(addressString: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1AddressStringToBytesResponse>>
Description
Since: cosmos-sdk 0.46

Tags
Query

Name
QueryAddressStringToBytes

Summary
AddressStringToBytes converts Address string to bytes

Request
GET:/cosmos/auth/v1beta1/bech32/{address_string}
Parameters
- addressString: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1AddressStringToBytesResponse>>
- Defined in cosmos.auth.v1beta1/rest.ts:586

queryBech32Prefix

queryBech32Prefix(params?: RequestParams): Promise<AxiosResponse<V1Beta1Bech32PrefixResponse>>
Description
Since: cosmos-sdk 0.46

Tags
Query

Name
QueryBech32Prefix

Summary
Bech32Prefix queries bech32Prefix

Request
GET:/cosmos/auth/v1beta1/bech32
Parameters
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1Bech32PrefixResponse>>
- Defined in cosmos.auth.v1beta1/rest.ts:554

queryModuleAccountByName

queryModuleAccountByName(name: string, params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryModuleAccountByNameResponse>>
No description

Tags
Query

Name
QueryModuleAccountByName

Summary
ModuleAccountByName returns the module account info by module name

Request
GET:/cosmos/auth/v1beta1/module_accounts/{name}
Parameters
- name: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryModuleAccountByNameResponse>>
- Defined in cosmos.auth.v1beta1/rest.ts:618

queryModuleAccounts

queryModuleAccounts(params?: RequestParams): Promise<AxiosResponse<V1Beta1QueryModuleAccountsResponse>>
Description
Since: cosmos-sdk 0.46

Tags
Query

Name
QueryModuleAccounts

Summary
ModuleAccounts returns all the existing module accounts.

Request
GET:/cosmos/auth/v1beta1/module_accounts
Parameters
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryModuleAccountsResponse>>
- Defined in cosmos.auth.v1beta1/rest.ts:602

queryParams

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

Tags
Query

Name
QueryParams

Summary
Params queries all parameters.

Request
GET:/cosmos/auth/v1beta1/params
Parameters
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1Beta1QueryParamsResponse>>
- Defined in cosmos.auth.v1beta1/rest.ts:634

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.auth.v1beta1/rest.ts:444

setSecurityData

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

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

queryAccount

Tags

Name

Summary

Request

Parameters

address: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryAccountResponse>>

queryAccountAddressByID

Description

Tags

Name

Summary

Request

Parameters

id: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1QueryAccountAddressByIDResponse>>

queryAccounts

Description

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

queryAddressBytesToString

Description

Tags

Name

Summary

Request

Parameters

addressBytes: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1AddressBytesToStringResponse>>

queryAddressStringToBytes

Description

Tags

Name

Summary

Request

Parameters

addressString: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1Beta1AddressStringToBytesResponse>>

queryBech32Prefix

Description

Tags

Name

Summary

Request

`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