Class LegacyGovAPI

Hierarchy

BaseAPI
- LegacyGovAPI

Index

Constructors

constructor

Properties

lcd

Methods

Constructors

constructor

new LegacyGovAPI(lcd: LCDClient): LegacyGovAPI

Overrides BaseAPI.constructor
- Defined in client/lcd/api/LegacyGovAPI.ts:106
Parameters
- lcd: LCDClient
Returns LegacyGovAPI

Properties

lcd

Methods

depositParameters

depositParameters(chainID: string, params?: APIParams): Promise<DepositParams>

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

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

deposits

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

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

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

getReqFromAddress

getReqFromAddress(address: string): APIRequester

Inherited from BaseAPI.getReqFromAddress
- Defined in client/lcd/api/BaseAPI.ts:20
Parameters
- address: string
Returns APIRequester

getReqFromChainID

getReqFromChainID(chainID: string): APIRequester

Inherited from BaseAPI.getReqFromChainID
- Defined in client/lcd/api/BaseAPI.ts:16
Parameters
- chainID: string
Returns APIRequester

initialDeposit

initialDeposit(proposalId: number, chainID: string): Promise<Coins>

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

Parameters
- proposalId: number
  
  proposal's ID
- chainID: string
  
  chain id
Returns Promise<Coins>

parameters

parameters(chainID: string, params?: APIParams): Promise<GovParams>

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

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

proposal

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

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

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

proposals

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

- Defined in client/lcd/api/LegacyGovAPI.ts:114
Gets all proposals.

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

proposer

proposer(proposalId: number, chainID: string): Promise<string>

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

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

searchProposalCreationTx

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

- Defined in client/lcd/api/LegacyGovAPI.ts:252
Parameters
- proposalId: number
- chainID: string
Returns Promise<Tx.Data>

tally

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

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

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

tallyParameters

tallyParameters(chainID: string, params?: APIParams): Promise<TallyParams>

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

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

votes

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

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

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

votingParameters

votingParameters(chainID: string, params?: APIParams): Promise<VotingParams>

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

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