from typing import Optional
from multiversx_sdk.abi.biguint_value import BigUIntValue
from multiversx_sdk.abi.serializer import Serializer
from multiversx_sdk.abi.string_value import StringValue
from multiversx_sdk.core.address import Address
from multiversx_sdk.core.base_factory import BaseFactory
from multiversx_sdk.core.constants import GOVERNANCE_SMART_CONTRACT_ADDRESS_HEX
from multiversx_sdk.core.interfaces import IGasLimitEstimator
from multiversx_sdk.core.transaction import Transaction
from multiversx_sdk.core.transactions_factory_config import TransactionsFactoryConfig
from multiversx_sdk.governance.resources import VoteType
# will be changed in the future when a formula on how gas is computed will be available
EXTRA_GAS_LIMIT_FOR_VOTING_PROPOSAL = 100_000
[docs]
class GovernanceTransactionsFactory(BaseFactory):
def __init__(
self,
config: TransactionsFactoryConfig,
gas_limit_estimator: Optional[IGasLimitEstimator] = None,
) -> None:
super().__init__(config, gas_limit_estimator)
self._config = config
self._governance_contract = Address.new_from_hex(GOVERNANCE_SMART_CONTRACT_ADDRESS_HEX)
self._serializer = Serializer()
[docs]
def create_transaction_for_new_proposal(
self,
sender: Address,
commit_hash: str,
start_vote_epoch: int,
end_vote_epoch: int,
native_token_amount: int,
) -> Transaction:
data_parts = ["proposal"]
serialized_args = self._serializer.serialize_to_parts(
[StringValue(commit_hash), BigUIntValue(start_vote_epoch), BigUIntValue(end_vote_epoch)]
)
serialized_args = [arg.hex() for arg in serialized_args]
data_parts.extend(serialized_args)
transaction = Transaction(
sender=sender,
receiver=self._governance_contract,
gas_limit=0,
chain_id=self._config.chain_id,
value=native_token_amount,
)
self.set_payload(transaction, data_parts)
self.set_gas_limit(transaction=transaction, config_gas_limit=self._config.gas_limit_for_proposal)
return transaction
[docs]
def create_transaction_for_voting(
self,
sender: Address,
proposal_nonce: int,
vote: VoteType,
) -> Transaction:
serialized_args = self._serializer.serialize_to_parts([BigUIntValue(proposal_nonce), StringValue(vote.value)])
data_parts = ["vote"] + [arg.hex() for arg in serialized_args]
transaction = Transaction(
sender=sender,
receiver=self._governance_contract,
gas_limit=0,
chain_id=self._config.chain_id,
)
self.set_payload(transaction, data_parts)
self.set_gas_limit(
transaction=transaction,
config_gas_limit=self._config.gas_limit_for_vote + EXTRA_GAS_LIMIT_FOR_VOTING_PROPOSAL,
)
return transaction
[docs]
def create_transaction_for_closing_proposal(self, sender: Address, proposal_nonce: int) -> Transaction:
data_parts = ["closeProposal", self._serializer.serialize([BigUIntValue(proposal_nonce)])]
transaction = Transaction(
sender=sender,
receiver=self._governance_contract,
gas_limit=0,
chain_id=self._config.chain_id,
)
self.set_payload(transaction, data_parts)
self.set_gas_limit(transaction=transaction, config_gas_limit=self._config.gas_limit_for_closing_proposal)
return transaction
[docs]
def create_transaction_for_clearing_ended_proposals(
self,
sender: Address,
proposers: list[Address],
) -> Transaction:
data_parts = ["clearEndedProposals"] + [address.to_hex() for address in proposers]
transaction = Transaction(
sender=sender,
receiver=self._governance_contract,
gas_limit=0,
chain_id=self._config.chain_id,
)
self.set_payload(transaction, data_parts)
gas_limit = (
self._config.gas_limit_for_clear_proposals + len(proposers) * self._config.gas_limit_for_clear_proposals
)
self.set_gas_limit(transaction=transaction, config_gas_limit=gas_limit)
return transaction
[docs]
def create_transaction_for_claiming_accumulated_fees(
self,
sender: Address,
) -> Transaction:
data_parts = ["claimAccumulatedFees"]
transaction = Transaction(
sender=sender,
receiver=self._governance_contract,
gas_limit=0,
chain_id=self._config.chain_id,
)
self.set_payload(transaction, data_parts)
self.set_gas_limit(transaction=transaction, config_gas_limit=self._config.gas_limit_for_claim_accumulated_fees)
return transaction
[docs]
def create_transaction_for_changing_config(
self,
sender: Address,
proposal_fee: int,
lost_proposal_fee: int,
min_quorum: int,
min_veto_threshold: int,
min_pass_threshold: int,
) -> Transaction:
data_parts = ["changeConfig"]
args = self._serializer.serialize_to_parts(
[
StringValue(str(proposal_fee)),
StringValue(str(lost_proposal_fee)),
StringValue(str(min_quorum)),
StringValue(str(min_veto_threshold)),
StringValue(str(min_pass_threshold)),
]
)
data_parts = data_parts + [arg.hex() for arg in args]
transaction = Transaction(
sender=sender,
receiver=self._governance_contract,
gas_limit=0,
chain_id=self._config.chain_id,
)
self.set_payload(transaction, data_parts)
self.set_gas_limit(transaction=transaction, config_gas_limit=self._config.gas_limit_for_change_config)
return transaction