Class GovAPI

Hierarchy

BaseAPI
- GovAPI

Index

Constructors

constructor

Methods

Constructors

constructor

new GovAPI(c: APIRequester): GovAPI

Inherited from BaseAPI.constructor
- Defined in client/lcd/api/BaseAPI.ts:4
Parameters
- c: APIRequester
Returns GovAPI

Methods

depositParameters

depositParameters(params?: APIParams): Promise<DepositParams>

- Defined in client/lcd/api/GovAPI.ts:329
Gets the Gov module's deposit parameters

Parameters
- params: APIParams = {}
Returns Promise<DepositParams>

deposits

deposits(proposalId: number, _params?: Partial<PaginationOptions & APIParams>): Promise<[Deposit[], Pagination]>

- Defined in client/lcd/api/GovAPI.ts:173
Get the deposits for a proposal

Parameters
- proposalId: number
  
  proposal's ID
- _params: Partial<PaginationOptions & APIParams> = {}
Returns Promise<[Deposit[], Pagination]>

initialDeposit

initialDeposit(proposalId: number): Promise<Coins>

- Defined in client/lcd/api/GovAPI.ts:156
Get the proposal's initial deposit

Parameters
- proposalId: number
  
  proposal's ID
Returns Promise<Coins>

parameters

parameters(params?: APIParams): Promise<GovParams>

- Defined in client/lcd/api/GovAPI.ts:370
Gets the Gov module's current parameters

Parameters
- params: APIParams = {}
Returns Promise<GovParams>

proposal

proposal(proposalId: number, params?: APIParams): Promise<Proposal>

- Defined in client/lcd/api/GovAPI.ts:123
Get a specific proposal by its ID

Parameters
- proposalId: number
  
  proposal's ID
- params: APIParams = {}
Returns Promise<Proposal>

proposals

proposals(params?: Partial<PaginationOptions & APIParams>): Promise<[Proposal[], Pagination]>

- Defined in client/lcd/api/GovAPI.ts:108
Gets all proposals.

Parameters
- params: Partial<PaginationOptions & APIParams> = {}
Returns Promise<[Proposal[], Pagination]>

proposer

proposer(proposalId: number): Promise<string>

- Defined in client/lcd/api/GovAPI.ts:139
Get the proposal's proposer

Parameters
- proposalId: number
  
  proposal's ID
Returns Promise<string>

searchProposalCreationTx

searchProposalCreationTx(proposalId: number): Promise<Tx.Data>

- Defined in client/lcd/api/GovAPI.ts:226
Parameters
- proposalId: number
Returns Promise<Tx.Data>

tally

tally(proposalId: number, params?: APIParams): Promise<Tally>

- Defined in client/lcd/api/GovAPI.ts:311
Gets the current tally for a proposal.

Parameters
- proposalId: number
  
  proposal's ID
- params: APIParams = {}
Returns Promise<Tally>

tallyParameters

tallyParameters(params?: APIParams): Promise<TallyParams>

- Defined in client/lcd/api/GovAPI.ts:356
Gets teh Gov module's tally parameters

Parameters
- params: APIParams = {}
Returns Promise<TallyParams>

votes

votes(proposalId: number, _params?: Partial<PaginationOptions & APIParams>): Promise<[Vote[], Pagination]>

- Defined in client/lcd/api/GovAPI.ts:250
Get the current votes for a proposal

Parameters
- proposalId: number
  
  proposal's ID
- _params: Partial<PaginationOptions & APIParams> = {}
Returns Promise<[Vote[], Pagination]>

votingParameters

votingParameters(params?: APIParams): Promise<VotingParams>

- Defined in client/lcd/api/GovAPI.ts:344
Gets the Gov module's voting parameters

Parameters
- params: APIParams = {}
Returns Promise<VotingParams>