FederationGateway

FederationGateway

class FederationGateway(**kwargs)

Implements the federationgateway api endpoints.

deposits(block_height: int, **kwargs) → List[pystratis.api.federationgateway.responsemodels.maturedblockdepositsmodel.MaturedBlockDepositsModel]

Retrieves block deposits

Parameters:
  • block_height (int) – The block height at which to obtain deposits.
  • **kwargs – Extra keyword arguments.
Returns:

A list of matured block deposits.

Return type:

List[MaturedBlockDepositsModel]

Raises:

APIError – Error thrown by node API. See message for details.

fullysigned_transfer(deposit_id: Union[str, pystratis.core.types.uint256.uint256], transaction_id: Union[str, pystratis.core.types.uint256.uint256], **kwargs) → List[pystratis.api.federationgateway.responsemodels.crosschaintransfermodel.CrossChainTransferModel]

Get fully signed transfers.

Parameters:
  • deposit_id (uint256, str) – The deposit id hash.
  • transaction_id (uint256, str) – The transaction id hash.
  • **kwargs – Extra keyword arguments.
Returns:

A list of cross chain transfers.

Return type:

List[CrossChainTransferModel]

Raises:

APIError – Error thrown by node API. See message for details.

info(**kwargs) → pystratis.api.federationgateway.responsemodels.federationgatewayinfomodel.FederationGatewayInfoModel

Gets info on the state of the federation.

Parameters:**kwargs – Extra keyword arguments.
Returns:Information on the federation gateway.
Return type:FederationGatewayInfoModel
Raises:APIError – Error thrown by node API. See message for details.
ip_add(ipaddr: str, **kwargs) → str

Add a federation member’s IP address to the federation IP list

Parameters:
  • ipaddr (str) – The endpoint.
  • **kwargs – Extra keyword arguments.
Returns:

Response to ip add request.

Return type:

str

Raises:

APIError – Error thrown by node API. See message for details.

ip_remove(ipaddr: str, **kwargs) → str

Remove a federation member’s IP address to the federation IP list

Parameters:
  • ipaddr (str) – The endpoint.
  • **kwargs – Extra keyword arguments.
Returns:

response to ip remove request.

Return type:

str

Raises:

APIError – Error thrown by node API. See message for details.

ip_replace(ipaddrtouse: str, ipaddr: str, **kwargs) → str

Replace a federation member’s IP from the federation IP list with another.

Parameters:
  • ipaddrtouse (str) – The new endpoint.
  • ipaddr (str) – The endpoint being replaced.
  • **kwargs – Extra keyword arguments.
Returns:

Response to ip replace request.

Return type:

str

Raises:

APIError – Error thrown by node API. See message for details.

member_info(**kwargs) → pystratis.api.federationgateway.responsemodels.federationmemberinfomodel.FederationMemberInfoModel

Gets info on the state of a multisig member.

Parameters:**kwargs – Extra keyword arguments.
Returns:Information on the current multisig member.
Return type:FederationMemberInfoModel
Raises:APIError – Error thrown by node API. See message for details.
pending_transfer(deposit_id: Union[str, pystratis.core.types.uint256.uint256], transaction_id: Union[str, pystratis.core.types.uint256.uint256], **kwargs) → List[pystratis.api.federationgateway.responsemodels.crosschaintransfermodel.CrossChainTransferModel]

Gets pending transfers.

Parameters:
  • deposit_id (uint256, str) – The deposit id hash.
  • transaction_id (uint256, str) – The transaction id hash.
  • **kwargs – Extra keyword arguments.
Returns:

A list of cross chain transfers.

Return type:

List[CrossChainTransferModel]

Raises:

APIError – Error thrown by node API. See message for details.

verify_transfer(deposit_id_transaction_id: Union[str, pystratis.core.types.uint256.uint256], **kwargs) → Union[str, pystratis.api.federationgateway.responsemodels.validatetransactionresultmodel.ValidateTransactionResultModel]

Validate a transfer transaction.

Parameters:
  • deposit_id_transaction_id (uint256, str) – The transaction id containing the deposit with the deposit id.
  • **kwargs – Extra keyword arguments.
Returns:

A model describing the validity of the transfer.

Return type:

Union[str, ValidateTransactionResultModel]

Raises:

APIError – Error thrown by node API. See message for details.

CrosschainTransferModel

class CrossChainTransferModel

A pydantic model of a cross chain transfer.

FederationGatewayInfoModel

class FederationGatewayInfoModel

A pydantic model representing information on the federation gateway.

FederationMemberConnectionInfoModel

class FederationMemberConnectionInfoModel

A pydantic model for federation member connections.

FederationMemberInfoModel

class FederationMemberInfoModel

A pydantic model representing information about the current federation member.

MaturedBlockDepositsModel

class MaturedBlockDepositsModel

A pydantic model for matured block deposits.

SerializableResult

class SerializableResult

A pydantic model for a serializable result.

ValidateTransactionResultModel

class ValidateTransactionResultModel

A pydantic model for a validate transaction result.