Federation¶
Federation¶
-
class
Federation(**kwargs)¶ Implements the federation api endpoints.
-
federation_at_height(block_height: int, **kwargs) → List[pystratis.core.pubkey.PubKey]¶ Gets the federation membership at the specified height.
Parameters: - block_height – The height to query
- **kwargs –
Returns: The pubkeys of federation members at the specified height.
Return type: List[PubKey]
Raises: APIError– Error thrown by node API. See message for details.
-
members(**kwargs) → List[pystratis.api.federation.responsemodels.federationmembermodel.FederationMemberModel]¶ Retrieves a list of active federation members and last active times.
Parameters: **kwargs – Extra keyword arguments. Returns: Information on each of federation members. Return type: List[FederationMemberModel] Raises: APIError– Error thrown by node API. See message for details.
-
members_current(**kwargs) → pystratis.api.federation.responsemodels.federationmemberdetailedmodel.FederationMemberDetailedModel¶ Retrieves the information for the current federation member’s voting status and mining estimates.
Parameters: **kwargs – Extra keyword arguments. Returns: Information on the current member. Return type: FederationMemberDetailedModel Raises: APIError– Error thrown by node API. See message for details.
-
miner_at_height(block_height: int, **kwargs) → pystratis.core.pubkey.PubKey¶ Gets the federation pubkey that mined the block at the specified height.
Parameters: - block_height – The height to query
- **kwargs –
Returns: The pubkey that produced the block at the specified height.
Return type: Raises: APIError– Error thrown by node API. See message for details.
-
reconstruct(**kwargs) → str¶ Signals the node to rebuild the federation. Will need to restart node when complete.
Parameters: **kwargs – Extra keyword arguments. Returns: The node response ot the request. Return type: str Raises: APIError– Error thrown by node API. See message for details.
-