Class Api<SecurityDataType>

Title

cosmos/gov/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 cosmos.gov.v1/rest.ts:547

Properties

instance

instance: AxiosInstance

Methods

queryDeposit

queryDeposit(proposalId: string, depositor: string, params?: RequestParams): Promise<AxiosResponse<V1QueryDepositResponse>>
No description

Tags
Query

Name
QueryDeposit

Summary
Deposit queries single deposit information based proposalID, depositAddr.

Request
GET:/cosmos/gov/v1/proposals/{proposal_id}/deposits/{depositor}
Parameters
- proposalId: string
- depositor: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryDepositResponse>>
- Defined in cosmos.gov.v1/rest.ts:732

queryDeposits

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

Tags
Query

Name
QueryDeposits

Summary
Deposits queries all deposits of a single proposal.

Request
GET:/cosmos/gov/v1/proposals/{proposal_id}/deposits
Parameters
- proposalId: 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<V1QueryDepositsResponse>>
- Defined in cosmos.gov.v1/rest.ts:705

queryParams

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

Tags
Query

Name
QueryParams

Summary
Params queries all parameters of the gov module.

Request
GET:/cosmos/gov/v1/params/{params_type}
Parameters
- paramsType: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryParamsResponse>>
- Defined in cosmos.gov.v1/rest.ts:638

queryProposal

queryProposal(proposalId: string, params?: RequestParams): Promise<AxiosResponse<V1QueryProposalResponse>>
No description

Tags
Query

Name
QueryProposal

Summary
Proposal queries proposal details based on ProposalID.

Request
GET:/cosmos/gov/v1/proposals/{proposal_id}
Parameters
- proposalId: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryProposalResponse>>
- Defined in cosmos.gov.v1/rest.ts:689

queryProposals

queryProposals(query?: {
    depositor?: string;
    pagination.count_total?: boolean;
    pagination.key?: string;
    pagination.limit?: string;
    pagination.offset?: string;
    pagination.reverse?: boolean;
    proposal_status?: "PROPOSAL_STATUS_UNSPECIFIED" | "PROPOSAL_STATUS_DEPOSIT_PERIOD" | "PROPOSAL_STATUS_VOTING_PERIOD" | "PROPOSAL_STATUS_PASSED" | "PROPOSAL_STATUS_REJECTED" | "PROPOSAL_STATUS_FAILED";
    voter?: string;
}, params?: RequestParams): Promise<AxiosResponse<V1QueryProposalsResponse>>
No description

Tags
Query

Name
QueryProposals

Summary
Proposals queries all proposals based on given status.

Request
GET:/cosmos/gov/v1/proposals
Parameters
- Optional query: {
      depositor?: string;
      pagination.count_total?: boolean;
      pagination.key?: string;
      pagination.limit?: string;
      pagination.offset?: string;
      pagination.reverse?: boolean;
      proposal_status?: "PROPOSAL_STATUS_UNSPECIFIED" | "PROPOSAL_STATUS_DEPOSIT_PERIOD" | "PROPOSAL_STATUS_VOTING_PERIOD" | "PROPOSAL_STATUS_PASSED" | "PROPOSAL_STATUS_REJECTED" | "PROPOSAL_STATUS_FAILED";
      voter?: string;
  }
  - Optional depositor?: string
  - Optional pagination.count_total?: boolean
  - Optional pagination.key?: string
  - Optional pagination.limit?: string
  - Optional pagination.offset?: string
  - Optional pagination.reverse?: boolean
  - Optional proposal_status?: "PROPOSAL_STATUS_UNSPECIFIED" | "PROPOSAL_STATUS_DEPOSIT_PERIOD" | "PROPOSAL_STATUS_VOTING_PERIOD" | "PROPOSAL_STATUS_PASSED" | "PROPOSAL_STATUS_REJECTED" | "PROPOSAL_STATUS_FAILED"
  - Optional voter?: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryProposalsResponse>>
- Defined in cosmos.gov.v1/rest.ts:654

queryTallyResult

queryTallyResult(proposalId: string, params?: RequestParams): Promise<AxiosResponse<V1QueryTallyResultResponse>>
No description

Tags
Query

Name
QueryTallyResult

Summary
TallyResult queries the tally of a proposal vote.

Request
GET:/cosmos/gov/v1/proposals/{proposal_id}/tally
Parameters
- proposalId: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryTallyResultResponse>>
- Defined in cosmos.gov.v1/rest.ts:748

queryVote

queryVote(proposalId: string, voter: string, params?: RequestParams): Promise<AxiosResponse<V1QueryVoteResponse>>
No description

Tags
Query

Name
QueryVote

Summary
Vote queries voted information based on proposalID, voterAddr.

Request
GET:/cosmos/gov/v1/proposals/{proposal_id}/votes/{voter}
Parameters
- proposalId: string
- voter: string
- params: RequestParams = {}
Returns Promise<AxiosResponse<V1QueryVoteResponse>>
- Defined in cosmos.gov.v1/rest.ts:791

queryVotes

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

Tags
Query

Name
QueryVotes

Summary
Votes queries votes of a given proposal.

Request
GET:/cosmos/gov/v1/proposals/{proposal_id}/votes
Parameters
- proposalId: 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<V1QueryVotesResponse>>
- Defined in cosmos.gov.v1/rest.ts:764

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.gov.v1/rest.ts:586

setSecurityData

setSecurityData(data: null | SecurityDataType): void
Parameters
- data: null | SecurityDataType
Returns void
Inherited from HttpClient.setSecurityData
- Defined in cosmos.gov.v1/rest.ts:554

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

queryDeposit

Tags

Name

Summary

Request

Parameters

proposalId: string

depositor: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryDepositResponse>>

queryDeposits

Tags

Name

Summary

Request

Parameters

proposalId: 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<V1QueryDepositsResponse>>

queryParams

Tags

Name

Summary

Request

Parameters

paramsType: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryParamsResponse>>

queryProposal

Tags

Name

Summary

Request

Parameters

proposalId: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryProposalResponse>>

queryProposals

Tags

Name

Summary

Request

Parameters

Optional depositor?: string

Optional pagination.count_total?: boolean

Optional pagination.key?: string

Optional pagination.limit?: string

Optional pagination.offset?: string

Optional pagination.reverse?: boolean

Optional proposal_status?: "PROPOSAL_STATUS_UNSPECIFIED" | "PROPOSAL_STATUS_DEPOSIT_PERIOD" | "PROPOSAL_STATUS_VOTING_PERIOD" | "PROPOSAL_STATUS_PASSED" | "PROPOSAL_STATUS_REJECTED" | "PROPOSAL_STATUS_FAILED"

Optional voter?: string

params: RequestParams = {}

Returns Promise<AxiosResponse<V1QueryProposalsResponse>>

queryTallyResult

`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` depositor?: string

`Optional` pagination.count_total?: boolean

`Optional` pagination.key?: string

`Optional` pagination.limit?: string

`Optional` pagination.offset?: string

`Optional` pagination.reverse?: boolean

`Optional` proposal_status?: "PROPOSAL_STATUS_UNSPECIFIED" | "PROPOSAL_STATUS_DEPOSIT_PERIOD" | "PROPOSAL_STATUS_VOTING_PERIOD" | "PROPOSAL_STATUS_PASSED" | "PROPOSAL_STATUS_REJECTED" | "PROPOSAL_STATUS_FAILED"

`Optional` voter?: 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