Skip to main content

terra_sdk.client.lcd.api.gov

AsyncGovAPI Objects


_1
class AsyncGovAPI(BaseAsyncAPI)

proposals


_1
async def proposals(options: dict = {}, params: Optional[APIParams] = None) -> [List[Proposal], dict]

Fetches all proposals.

Arguments:

  • options dict, optional - dictionary containing options. Defaults to . you can use one or more below:
  • "proposal_status" - terra_sdk.core.gov.ProposalStatus (int)
  • "voter" - voter address (str),
  • "depositor" - depositor address(str)
  • params APIParams, optional - additional params for the API like pagination

Returns:

  • List[Proposal] - proposals

proposal


_1
async def proposal(proposal_id: int) -> Proposal

Fetches a single proposal by id.

Arguments:

  • proposal_id int - proposal ID

Returns:

  • Proposal - proposal

proposer


_1
async def proposer(proposal_id: int) -> str

Fetches the proposer of a proposal.

Arguments:

  • proposal_id int - proposal ID

Returns:

  • str - proposal's proposer, None if proposal is not exist

deposits


_1
async def deposits(proposal_id: int, params: Optional[APIParams] = None)

Fetches the deposit information about a proposal.

Arguments:

  • proposal_id int - proposal ID
  • params APIParams, optional - additional params for the API like pagination

votes


_1
async def votes(proposal_id: int, params: Optional[APIParams] = None)

Fetches the votes for a proposal.

Arguments:

  • proposal_id int - proposal ID
  • params APIParams, optional - additional params for the API like pagination

tally


_1
async def tally(proposal_id: int)

Fetches the tally for a proposal.

Arguments:

  • proposal_id int - proposal ID

deposit_parameters


_1
async def deposit_parameters() -> dict

Fetches the Gov module's deposit parameters.

Returns:

  • dict - deposit parameters

voting_parameters


_1
async def voting_parameters() -> dict

Fetches the Gov module's voting parameters.

Returns:

  • dict - voting parameters

tally_parameters


_1
async def tally_parameters() -> dict

Fetches the Gov module's tally parameters.

Returns:

  • dict - tally parameters

parameters


_1
async def parameters() -> dict

Fetches the Gov module's parameters.

Returns:

  • dict - Gov module parameters