feat/python: Update NodeInfo

bindings/python/iota_sdk/types/client_options.py

@@ -5,7 +5,7 @@
 from dataclasses import dataclass
 from typing import List, Optional
 from iota_sdk.types.common import json
-from iota_sdk.types.node_info import NodeInfoProtocol
+from iota_sdk.types.node_info import ProtocolParameters
 
 
 @json
@@ -68,7 +68,7 @@ class ClientOptions:
             The User-Agent header for requests.
         broker_options (MqttBrokerOptions):
             Options for the MQTT broker.
-        protocol_parameters (NodeInfoProtocol):
+        protocol_parameters (ProtocolParameters):
             Protocol parameters.
         api_timeout (Duration):
             Timeout for API requests.
@@ -85,6 +85,6 @@ class ClientOptions:
     quorum_threshold: Optional[int] = None
     user_agent: Optional[str] = None
     broker_options: Optional[MqttBrokerOptions] = None
-    protocol_parameters: Optional[NodeInfoProtocol] = None
+    protocol_parameters: Optional[ProtocolParameters] = None
     api_timeout: Optional[Duration] = None
     max_parallel_api_requests: Optional[int] = None

bindings/python/iota_sdk/types/network_info.py

@@ -4,12 +4,12 @@
 from __future__ import annotations
 from dataclasses import dataclass
 from iota_sdk.types.common import json
-from iota_sdk.types.node_info import NodeInfoProtocol
+from iota_sdk.types.node_info import ProtocolParameters
 
 
 @json
 @dataclass
 class NetworkInfo:
     """Network related information.
     """
-    protocol_parameters: NodeInfoProtocol
+    protocol_parameters: ProtocolParameters

bindings/python/iota_sdk/types/node_info.py

@@ -7,36 +7,37 @@
 from iota_sdk.types.common import HexStr, json
 
 
-@json
-@dataclass
-class NodeInfoMilestone:
-    """Milestone info.
-
-    Attributes:
-        index: The milestone index.
-        timestamp: The milestone timestamp.
-        milestone_id: The milestone ID.
-    """
-    index: int
-    timestamp: Optional[int] = None
-    milestone_id: Optional[HexStr] = None
-
-
 @json
 @dataclass
 class NodeInfoStatus:
     """Node status.
 
     Attributes:
-        is_healthy: Whether the node is healthy.
-        latest_milestone: The latest milestone info.
-        confirmed_milestone: The latest confirmed milestone info.
-        pruning_index: The pruning index of the node.
+        is_healthy: Tells whether the node is healthy or not.
+        accepted_tangle_time: A notion of time that is anchored to the latest accepted block.
+        relative_accepted_tangle_time: The time after Accepted Tangle Time has advanced with the system clock.
+        confirmed_tangle_time: A notion of time that is anchored to the latest confirmed block.
+        relative_confirmed_tangle_time: The time after Confirmed Tangle Time has advanced with the system clock.
+        latest_commitment_id: The latest slot that the node has committed to.
+        latest_finalized_slot: The index of the latest finalized slot.
+        latest_accepted_block_slot: The slot index of the latest accepted block.
+        latest_confirmed_block_slot: The slot index of the latest confirmed block.
+        pruning_epoch: The index of the slot before which the tangle history is pruned.
     """
     is_healthy: bool
-    latest_milestone: NodeInfoMilestone
-    confirmed_milestone: NodeInfoMilestone
-    pruning_index: int
+    accepted_tangle_time: str
+    relative_accepted_tangle_time: int
+    confirmed_tangle_time: int
+    relative_confirmed_tangle_time: int
+    latest_commitment_id: HexStr
+    # TODO Replace with a proper SlotIndex type
+    latest_finalized_slot: str
+    # TODO Replace with a proper SlotIndex type
+    latest_accepted_block_slot: str
+    # TODO Replace with a proper SlotIndex type
+    latest_confirmed_block_slot: str
+    # TODO Replace with a proper SlotIndex type
+    pruning_epoch: str
 
 
 @json
@@ -45,13 +46,13 @@ class NodeInfoMetrics:
     """Node metrics.
 
     Attributes:
-        blocks_per_second: The blocks per second gossiped in the network.
-        referenced_blocks_per_second: The referenced blocks per second in the network.
-        referenced_rate: The percentage of blocks that get referenced.
+        blocks_per_second: The current rate of new blocks per second.
+        confirmed_blocks_per_second: The current rate of confirmed blocks per second.
+        confirmation_rate: The ratio of confirmed blocks to new blocks of the last confirmed slot.
     """
     blocks_per_second: float
-    referenced_block_per_second: float
-    referenced_rate: float
+    confirmed_blocks_per_second: float
+    confirmation_rate: float
 
 
 @json
@@ -60,69 +61,203 @@ class RentStructure:
     """Rent structure for the storage deposit.
 
     Attributes:
-        v_byte_cost: The cost of base coin per virtual byte.
-        v_byte_factor_data: The weight factor used for key fields in the outputs.
-        v_byte_factor_key: The weight factor used for data fields in the outputs.
+        v_byte_cost: Defines the rent of a single virtual byte denoted in IOTA tokens.
+        v_byte_factor_data: Defines the factor to be used for data only fields.
+        v_byte_factor_key: Defines the factor to be used for key/lookup generating fields.
+        v_byte_factor_block_issuer_key: Defines the factor to be used for block issuer feature public keys.
+        v_byte_factor_staking_feature: Defines the factor to be used for staking feature.
+        v_byte_factor_delegation: Defines the factor to be used for delegation output.
     """
     v_byte_cost: int
     v_byte_factor_data: int
     v_byte_factor_key: int
+    v_byte_factor_block_issuer_key: int
+    v_byte_factor_staking_feature: int
+    v_byte_factor_delegation: int
+
+
+@json
+@dataclass
+class WorkScoreStructure:
+    """Work structure lists the Work Score of each type, it is used to denote the computation costs of processing an object.
+
+    Attributes:
+        data_byte: Data_kibibyte accounts for the network traffic per kibibyte.
+        block: Block accounts for work done to process a block in the node software.
+        missing_parent: Missing_parent is used to multiply for each missing parent if there are not enough strong ones.
+        input: Input accounts for loading the UTXO from the database and performing the mana calculations.
+        context_input: Context_input accounts for loading and checking the context input.
+        output: Output accounts for storing the UTXO in the database.
+        native_token: Native_token accounts for calculations done with native tokens.
+        staking: Staking accounts for the existence of a staking feature in the output.
+        block_issuer: BlockIssuer accounts for the existence of a block issuer feature in the output.
+        allotment: Allotment accounts for accessing the account-based ledger to transform the mana to block issuance credits.
+        signature_ed25519: SignatureEd25519 accounts for an Ed25519 signature check.
+        min_strong_parents_threshold: MinStrongParentsThreshold is the minimum amount of strong parents in a basic block, otherwise, the issuer gets slashed.
+    """
+    data_byte: int
+    block: int
+    missing_parent: int
+    input: int
+    context_input: int
+    output: int
+    native_token: int
+    staking: int
+    block_issuer: int
+    allotment: int
+    signature_ed25519: int
+    min_strong_parents_threshold: int
 
 
 @json
 @dataclass
-class NodeInfoProtocol:
-    """Protocol info.
+class CongestionControlParameters:
+    """Congestion Control Parameters defines the parameters used to calculate the Reference Mana Cost (RMC).
 
     Attributes:
-        network_name: The human friendly name of the network.
-        bech32_hrp: The HRP prefix used for Bech32 addresses in the network.
-        token_supply: TokenSupply defines the current token supply on the network.
-        version: The version of the protocol running.
-        rent_structure: The rent structure used by given node/network.
+        min_reference_mana_cost: The minimum value of the reference Mana cost.
+        increase: The increase step size of the reference Mana cost.
+        decrease: The decrease step size of the reference Mana cost.
+        increase_threshold: The threshold for increasing the reference Mana cost.
+        decrease_threshold: The threshold for decreasing the reference Mana cost.
+        scheduler_rate: The rate at which the scheduler runs in workscore units per second.
+        min_mana: The minimum amount of Mana that an account must have to have a block scheduled.
+        max_buffer_size: The maximum size of the buffer in the scheduler.
+        max_validation_buffer_size: The maximum number of blocks in the validation buffer.
     """
+    min_reference_mana_cost: str
+    increase: str
+    decrease: str
+    increase_threshold: int
+    decrease_threshold: int
+    scheduler_rate: int
+    min_mana: str
+    max_buffer_size: int
+    max_validation_buffer_size: int
+
+
+@json
+@dataclass
+class VersionSignaling:
+    """Version Signaling defines the parameters used by signaling protocol parameters upgrade.
+
+    Attributes:
+        window_size: The size of the window in epochs to find which version of protocol parameters was most signaled, from current_epoch - window_size to current_epoch.
+        window_target_ratio: The target number of supporters for a version to win in a window_size.
+        activation_offset: The offset in epochs to activate the new version of protocol parameters.
+    """
+    window_size: int
+    window_target_ratio: int
+    activation_offset: int
+
+
+@json
+@dataclass
+class ManaStructure:
+    """Mana Structure defines the parameters used by mana calculation.
+
+    Attributes:
+        bits_count: The number of bits used to represent Mana.
+        generation_rate: The amount of potential Mana generated by 1 IOTA in 1 slot.
+        generation_rate_exponent: The scaling of generation_rate expressed as an exponent of 2.
+        decay_factors: A lookup table of epoch index diff to mana decay factor (slice index 0 = 1 epoch).
+        decay_factors_exponent: The scaling of decay_factors expressed as an exponent of 2.
+        decay_factor_epochs_sum: An integer approximation of the sum of decay over epochs.
+        decay_factor_epochs_sum_exponent: The scaling of decay_factor_epochs_sum expressed as an exponent of 2.
+    """
+    bits_count: int
+    generation_rate: int
+    generation_rate_exponent: int
+    decay_factors: List[int]
+    decay_factors_exponent: int
+    decay_factor_epochs_sum: int
+    decay_factor_epochs_sum_exponent: int
+
+
+@json
+@dataclass
+class ProtocolParameters:
+    """The protocol parameters.
+
+    Attributes:
+        type: Set to value 0 to denote a IOTA 2.0 protocol parameter.
+        version: Protocol version used by the network.
+        network_name: The Name of the network from which the networkId is derived.
+        bech32_hrp: Tells whether the node supports mainnet or testnet addresses.
+                    Value `iota` indicates that the node supports mainnet addresses.
+                    Value `atoi` indicates that the node supports testnet addresses.
+        rent_structure: The rent structure used by a given node/network.
+        work_score_structure: Work structure lists the Work Score of each type, it is used to denote the computation costs of processing an object.
+        token_supply: Current supply of the base token. Plain string encoded number.
+        genesis_unix_timestamp: The genesis timestamp at which the slots start to count.
+        slot_duration_in_seconds: The duration of a slot, in seconds.
+        slots_per_epoch_exponent: The number of slots in an epoch expressed as an exponent of 2.
+        mana_structure: Mana Structure defines the parameters used by mana calculation.
+        staking_unbonding_period: The unbonding period in epochs before an account can stop staking.
+        validation_blocks_per_slot: Validation Blocks Per Slot is the number of validation blocks that each validator should issue each slot.
+        punishment_epochs: The number of epochs worth of Mana that a node is punished with for each additional validation block it issues.
+        liveness_threshold: Determine if a block is eligible by evaluating issuing_time and commitments in its past cone to ATT and last_committed_slot respectively.
+        min_committable_age: Min_committable_age is the minimum age relative to the accepted tangle time slot index that a slot can be committed.
+        max_committable_age: Max_committable_age is the maximum age for a slot commitment to be included in a block relative to the slot index of the block issuing time.
+        epoch_nearing_threshold: Determine the slot that should trigger a new committee selection for the next and upcoming epoch.
+        congestion_control_parameters: Congestion Control Parameters defines the parameters used to calculate the Reference Mana Cost (RMC).
+        version_signaling: The version signaling parameters.
+    """
+    type: int
+    version: int
     network_name: str
     bech32_hrp: str
-    token_supply: str
-    version: int
     rent_structure: RentStructure
+    work_score_structure: WorkScoreStructure
+    token_supply: str
+    genesis_unix_timestamp: int
+    slot_duration_in_seconds: int
+    slots_per_epoch_exponent: int
+    mana_structure: ManaStructure
+    staking_unbonding_period: str
+    validation_blocks_per_slot: int
+    punishment_epochs: str
+    staking_unbonding_period: str
+    liveness_threshold: str
+    min_committable_age: str
+    max_committable_age: str
+    # TODO Replace with a proper SlotIndex type
+    epoch_nearing_threshold: str
+    congestion_control_parameters: CongestionControlParameters
+    version_signaling: VersionSignaling
 
 
 @json
 @dataclass
-class PendingProtocolParameter:
-    """Pending protocol parameters.
+class ProtocolParametersResponse:
+    """Protocol Parameters with start epoch.
 
     Attributes:
-        type: Type of change.
-        target_milestone_index: Milestone index at which the new protocol parameters become active.
-        protocol_version: The new protocol version.
-        params: The new protocol parameters.
+        start_epoch: The start epoch of the set of protocol parameters.
+        parameters: The protocol parameters.
     """
-    type: int
-    target_milestone_index: int
-    protocol_version: int
-    params: str
+    start_epoch: str
+    parameters: ProtocolParameters
 
 
 @dataclass
 class NodeInfoBaseToken:
     """The base coin info.
 
     Attributes:
-        name: Name of the base coin.
-        ticker_symbol: Base coin ticker symbol.
-        unit: Base coin unit.
-        decimals: Number of decimals.
-        use_metric_prefix: Whether the coin uses a metric prefix.
-        subunit: Base coin subunit.
+        name: The name of the base token of the network.
+        ticker_symbol: Ticker symbol of the token to be displayed on trading platforms.
+        unit: The primary unit of the token.
+        subunit: The name of the smallest possible denomination of the primary unit. subunit * 10^decimals = unit.
+        decimals: Number of decimals the primary unit is divisible up to.
+        use_metric_prefix: Whether to use metric prefixes for displaying unit.
     """
     name: str
     ticker_symbol: str
     unit: str
+    subunit: Optional[str] = None
     decimals: int
     use_metric_prefix: bool
-    subunit: Optional[str] = None
 
 
 @json
@@ -132,22 +267,20 @@ class NodeInfo:
 
     Attributes:
         name: The name of the node (e.g. Hornet).
-        version: The version of the node.
+        version: The semantic version of the node.
         status: The status of the node.
-        metrics: Some node metrics.
-        supported_protocol_versions: Supported protocol versions by the ndoe.
-        protocol: Information about the running protocol.
-        pending_protocol_parameters: A list of pending (not yet active) protocol parameters.
-        base_token: Information about the base token.
-        features: List of features supported by the node.
+        metrics: Node metrics.
+        protocol_parameters: Supported protocol versions by the node.
+        base_token: Gives info about the base token the network uses.
+        features: The features that are supported by the node.
+                  For example, a node could support the feature, which would allow the BIC to be included by the node account.
+                  All features must be lowercase.
     """
     name: str
     version: str
     status: NodeInfoStatus
     metrics: NodeInfoMetrics
-    supported_protocol_version: List[int]
-    protocol: NodeInfoProtocol
-    pending_protocol_parameters: List[PendingProtocolParameter]
+    protocol_parameters: List[ProtocolParametersResponse]
     base_token: NodeInfoBaseToken
     features: List[str]