Class GovAPI

Hierarchy

BaseAPI
- GovAPI

Index

Constructors

Methods

deposits depositsByDepositor params proposal proposals tally votes votesByVoter

Constructors

constructor

new GovAPI(request: APIRequester): GovAPI
Parameters
- request: APIRequester
Returns GovAPI
Inherited from BaseAPI.constructor
- Defined in api/BaseAPI.ts:4

Methods

deposits

deposits(proposalId: number, params?: PaginationOptions): Promise<QueryDepositsResponse>
Parameters
- proposalId: number
- Optional params: PaginationOptions
Returns Promise<QueryDepositsResponse>
- Defined in api/GovAPI.ts:32

depositsByDepositor

depositsByDepositor(proposalId: number, depositor: string): Promise<QueryDepositResponse>
Parameters
- proposalId: number
- depositor: string
Returns Promise<QueryDepositResponse>
- Defined in api/GovAPI.ts:42

params

params(paramsType: "deposit" | "tally" | "voting"): Promise<QueryParamsResponse>
Parameters
- paramsType: "deposit" | "tally" | "voting"
Returns Promise<QueryParamsResponse>
- Defined in api/GovAPI.ts:78

proposal

proposal(proposalId: number): Promise<QueryProposalResponse>
Parameters
- proposalId: number
Returns Promise<QueryProposalResponse>
- Defined in api/GovAPI.ts:24

proposals

proposals(params?: PaginationOptions): Promise<QueryProposalsResponse>
Parameters
- Optional params: PaginationOptions
Returns Promise<QueryProposalsResponse>
- Defined in api/GovAPI.ts:13

tally

tally(proposalId: number): Promise<QueryTallyResultResponse>
Parameters
- proposalId: number
Returns Promise<QueryTallyResultResponse>
- Defined in api/GovAPI.ts:70

votes

votes(proposalId: number, params?: PaginationOptions): Promise<QueryVotesResponse>
Parameters
- proposalId: number
- Optional params: PaginationOptions
Returns Promise<QueryVotesResponse>
- Defined in api/GovAPI.ts:51

votesByVoter

votesByVoter(proposalId: number, voter: string): Promise<QueryVoteResponse>
Parameters
- proposalId: number
- voter: string
Returns Promise<QueryVoteResponse>
- Defined in api/GovAPI.ts:61