Merge branch 'development'

Author: ddoktorski

.github/workflows/checks.yml

@@ -1,9 +1,7 @@
 name: Checks
 
 env:
-  STARKNET_VERSION: "0.13.0"
-  RPC_SPEC_VERSION: "0.6.0"
-  DEVNET_SHA: "1bd447d"
+  DEVNET_SHA: "c6ffb99"
 
 on:
   push:

docs/development.rst

@@ -24,11 +24,10 @@ Below is the command you can use to do this, designed for compatibility with the
 
 .. code-block:: bash
 
-    STARKNET_VERSION="0.13.0" RPC_SPEC_VERSION="0.6.0" \
     cargo install \
     --locked \
     --git https://github.com/0xSpaceShard/starknet-devnet-rs.git \
-    --rev 1bd447d
+    --rev c6ffb99
 
 If you choose to install `starknet-devnet-rs <https://github.com/0xSpaceShard/starknet-devnet-rs>`_ using a different method, please make sure to add the executable ``starknet-devnet`` to your ``PATH`` environment variable.
 

docs/guide/account_and_client.rst

@@ -28,8 +28,7 @@ To enable auto estimation, set the ``auto_estimate`` parameter to ``True``.
     It is strongly discouraged to use automatic fee estimation in production code as it may lead to an unexpectedly high fee.
 
 The returned estimated fee is multiplied by ``1.5`` for V1 and V2 transactions to mitigate fluctuations in price.
-For V3 transactions, ``max_amount`` and ``max_price_per_unit`` are scaled by ``1.1`` and ``1.5`` respectively.
-
+For V3 transactions, ``max_amount`` and ``max_price_per_unit`` are scaled by ``1.5`` and ``1.5`` respectively.
 
 .. note::
     It is possible to configure the value by which the estimated fee is multiplied,

docs/migration_guide.rst

@@ -1,6 +1,37 @@
 Migration guide
 ===============
 
+******************************
+0.21.0 (alpha) Migration guide
+******************************
+
+Version 0.21.0 of **starknet.py** comes with support for RPC 0.7.0-rc2!
+
+0.21.0 Targeted versions
+------------------------
+
+- Starknet - `0.13.1 <https://docs.starknet.io/documentation/starknet_versions/version_notes/#version0.13.1>`_
+- RPC - `0.7.0-rc2 <https://github.com/starkware-libs/starknet-specs/releases/tag/v0.7.0-rc2>`_
+
+0.21.0 Breaking changes
+-----------------------
+
+.. currentmodule:: starknet_py.net.client_models
+
+1. :class:`PendingStarknetBlock` and :class:`PendingStarknetBlockWithTxHashes` field ``parent_block_hash`` has been renamed to ``parent_hash``
+2. :class:`StarknetBlockCommon` has been renamed to :class:`BlockHeader`
+3. :class:`StarknetBlock` and :class:`StarknetBlockWithTxHashes` fields ``parent_block_hash`` and ``root`` have been renamed to ``parent_hash`` and ``new_root`` respectively
+4. :class:`FunctionInvocation` field ``execution_resources`` has been renamed to ``computation_resources``
+
+0.21.0 Minor changes
+-----------------------
+
+1. :class:`EventsChunk` field ``events`` is now a list of :class:`EmittedEvent` instead of :class:`Event`
+2. :class:`ExecutionResources` has a new required field ``data_availability``
+3. :class:`InvokeTransactionTrace`, :class:`DeclareTransactionTrace` and :class:`DeployAccountTransactionTrace` have a new required field ``execution_resources``
+4. :class:`EstimatedFee` has new required fields ``data_gas_consumed`` and ``data_gas_price``
+5. :class:`StarknetBlock`, :class:`PendingStarknetBlock`, :class:`StarknetBlockWithTxHashes`, :class:`PendingStarknetBlockWithTxHashes` have new required fields ``l1_data_gas_price`` and ``l1_da_mode``
+
 **********************
 0.20.0 Migration guide
 **********************

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "starknet-py"
-version = "0.20.0"
+version = "0.21.0-alpha"
 description = "A python SDK for Starknet"
 authors = ["Tomasz Rejowski <tomasz.rejowski@swmansion.com>", "Jakub Ptak <jakub.ptak@swmansion.com>"]
 include = ["starknet_py", "starknet_py/utils/crypto/libcrypto_c_exports.*"]

starknet_py/net/account/account.py

@@ -60,7 +60,7 @@ class Account(BaseAccount):
     ESTIMATED_FEE_MULTIPLIER: float = 1.5
     """Amount by which each estimated fee is multiplied when using `auto_estimate`."""
 
-    ESTIMATED_AMOUNT_MULTIPLIER: float = 1.1
+    ESTIMATED_AMOUNT_MULTIPLIER: float = 1.5
     ESTIMATED_UNIT_PRICE_MULTIPLIER: float = 1.5
     """Values by which each estimated `max_amount` and `max_price_per_unit` are multiplied when using 
     `auto_estimate`. Used only for V3 transactions"""
@@ -165,7 +165,10 @@ async def _get_resource_bounds(
 
             l1_resource_bounds = ResourceBounds(
                 max_amount=int(
-                    estimated_fee.gas_consumed * Account.ESTIMATED_AMOUNT_MULTIPLIER
+                    (estimated_fee.overall_fee / estimated_fee.gas_price)
+                    * Account.ESTIMATED_AMOUNT_MULTIPLIER
+                    if estimated_fee.gas_price != 0
+                    else 0
                 ),
                 max_price_per_unit=int(
                     estimated_fee.gas_price * Account.ESTIMATED_UNIT_PRICE_MULTIPLIER

starknet_py/net/client_models.py

@@ -33,21 +33,32 @@ class Call:
 @dataclass
 class Event:
     """
-    Dataclass representing an event emitted by transaction.
+    Dataclass representing a Starknet event.
     """
 
     from_address: int
     keys: List[int]
     data: List[int]
 
 
+@dataclass
+class EmittedEvent(Event):
+    """
+    Dataclass representing an event emitted by transaction.
+    """
+
+    transaction_hash: int
+    block_hash: Optional[int] = None
+    block_number: Optional[int] = None
+
+
 @dataclass
 class EventsChunk:
     """
     Dataclass representing events returned by FullNodeClient.get_events method.
     """
 
-    events: List[Event]
+    events: List[EmittedEvent]
     continuation_token: Optional[str] = None
 
 
@@ -131,6 +142,11 @@ class DAMode(Enum):
     L2 = 1
 
 
+class L1DAMode(Enum):
+    BLOB = "BLOB"
+    CALLDATA = "CALLDATA"
+
+
 class TransactionType(Enum):
     """
     Enum representing transaction types.
@@ -347,23 +363,42 @@ class TransactionFinalityStatus(Enum):
 
 
 @dataclass
-class ExecutionResources:
+class DataResources:
     """
-    Dataclass representing the resources consumed by the transaction.
+    Dataclass representing the data-availability resources of the transaction
+    """
+
+    l1_gas: int
+    l1_data_gas: int
+
+
+@dataclass
+class ComputationResources:
+    """
+    Dataclass representing the resources consumed by the VM.
     """
 
     # pylint: disable=too-many-instance-attributes
 
     steps: int
-    range_check_builtin_applications: Optional[int] = None
-    pedersen_builtin_applications: Optional[int] = None
-    poseidon_builtin_applications: Optional[int] = None
-    ec_op_builtin_applications: Optional[int] = None
-    ecdsa_builtin_applications: Optional[int] = None
-    bitwise_builtin_applications: Optional[int] = None
-    keccak_builtin_applications: Optional[int] = None
-    memory_holes: Optional[int] = None
-    segment_arena_builtin: Optional[int] = None
+    memory_holes: Optional[int]
+    range_check_builtin_applications: Optional[int]
+    pedersen_builtin_applications: Optional[int]
+    poseidon_builtin_applications: Optional[int]
+    ec_op_builtin_applications: Optional[int]
+    ecdsa_builtin_applications: Optional[int]
+    bitwise_builtin_applications: Optional[int]
+    keccak_builtin_applications: Optional[int]
+    segment_arena_builtin: Optional[int]
+
+
+@dataclass
+class ExecutionResources(ComputationResources):
+    """
+    Dataclass representing the resources consumed by the transaction, includes both computation and data.
+    """
+
+    data_availability: DataResources
 
 
 # TODO (#1219): split into PendingTransactionReceipt and TransactionReceipt
@@ -385,16 +420,21 @@ class TransactionReceipt:
     events: List[Event] = field(default_factory=list)
     messages_sent: List[L2toL1Message] = field(default_factory=list)
 
-    contract_address: Optional[int] = None
-
     block_number: Optional[int] = None
     block_hash: Optional[int] = None
 
-    message_hash: Optional[int] = None  # L1_HANDLER_TXN_RECEIPT-only
+    contract_address: Optional[int] = None  # DEPLOY_ACCOUNT_TXN_RECEIPT only
+    message_hash: Optional[int] = None  # L1_HANDLER_TXN_RECEIPT only
 
     revert_reason: Optional[str] = None
 
 
+@dataclass
+class TransactionWithReceipt:
+    transaction: Transaction
+    receipt: TransactionReceipt
+
+
 @dataclass
 class SentTransactionResponse:
     """
@@ -432,58 +472,68 @@ class BlockStatus(Enum):
     REJECTED = "REJECTED"
     ACCEPTED_ON_L2 = "ACCEPTED_ON_L2"
     ACCEPTED_ON_L1 = "ACCEPTED_ON_L1"
-    PROVEN = "PROVEN"
 
 
 @dataclass
-class PendingStarknetBlock:
+class PendingBlockHeader:
+    parent_hash: int
+    timestamp: int
+    sequencer_address: int
+    l1_gas_price: ResourcePrice
+    l1_data_gas_price: ResourcePrice
+    l1_da_mode: L1DAMode
+    starknet_version: str
+
+
+@dataclass
+class PendingStarknetBlock(PendingBlockHeader):
     """
     Dataclass representing a pending block on Starknet.
     """
 
     transactions: List[Transaction]
-    parent_block_hash: int
-    timestamp: int
-    sequencer_address: int
-    l1_gas_price: ResourcePrice
-    starknet_version: str
 
 
 @dataclass
-class PendingStarknetBlockWithTxHashes:
+class PendingStarknetBlockWithTxHashes(PendingBlockHeader):
     """
     Dataclass representing a pending block on Starknet containing transaction hashes.
     """
 
     transactions: List[int]
-    parent_block_hash: int
-    timestamp: int
-    sequencer_address: int
-    l1_gas_price: ResourcePrice
-    starknet_version: str
 
 
 @dataclass
-class StarknetBlockCommon:
+class PendingStarknetBlockWithReceipts(PendingBlockHeader):
+    """
+    Dataclass representing a pending block on Starknet with txs and receipts result
+    """
+
+    transactions: List[TransactionWithReceipt]
+
+
+@dataclass
+class BlockHeader:
     """
     Dataclass representing a block header.
     """
 
-    # TODO (#1219): change that into composition
     # pylint: disable=too-many-instance-attributes
 
     block_hash: int
-    parent_block_hash: int
+    parent_hash: int
     block_number: int
-    root: int
+    new_root: int
     timestamp: int
     sequencer_address: int
     l1_gas_price: ResourcePrice
+    l1_data_gas_price: ResourcePrice
+    l1_da_mode: L1DAMode
     starknet_version: str
 
 
 @dataclass
-class StarknetBlock(StarknetBlockCommon):
+class StarknetBlock(BlockHeader):
     """
     Dataclass representing a block on Starknet.
     """
@@ -493,7 +543,7 @@ class StarknetBlock(StarknetBlockCommon):
 
 
 @dataclass
-class StarknetBlockWithTxHashes(StarknetBlockCommon):
+class StarknetBlockWithTxHashes(BlockHeader):
     """
     Dataclass representing a block on Starknet containing transaction hashes.
     """
@@ -502,6 +552,16 @@ class StarknetBlockWithTxHashes(StarknetBlockCommon):
     transactions: List[int]
 
 
+@dataclass
+class StarknetBlockWithReceipts(BlockHeader):
+    """
+    Dataclass representing a block on Starknet with txs and receipts result
+    """
+
+    status: BlockStatus
+    transactions: List[TransactionWithReceipt]
+
+
 @dataclass
 class BlockHashAndNumber:
     block_hash: int
@@ -544,9 +604,11 @@ class EstimatedFee:
     Dataclass representing estimated fee.
     """
 
-    overall_fee: int
-    gas_price: int
     gas_consumed: int
+    gas_price: int
+    data_gas_consumed: int
+    data_gas_price: int
+    overall_fee: int
     unit: PriceUnit
 
 
@@ -831,7 +893,7 @@ class FunctionInvocation:
     calls: List["FunctionInvocation"]
     events: List[OrderedEvent]
     messages: List[OrderedMessage]
-    execution_resources: ExecutionResources
+    computation_resources: ComputationResources
 
 
 @dataclass
@@ -850,6 +912,7 @@ class InvokeTransactionTrace:
     """
 
     execute_invocation: Union[FunctionInvocation, RevertedFunctionInvocation]
+    execution_resources: ExecutionResources
     validate_invocation: Optional[FunctionInvocation] = None
     fee_transfer_invocation: Optional[FunctionInvocation] = None
     state_diff: Optional[StateDiff] = None
@@ -861,6 +924,7 @@ class DeclareTransactionTrace:
     Dataclass representing a transaction trace of an DECLARE transaction.
     """
 
+    execution_resources: ExecutionResources
     validate_invocation: Optional[FunctionInvocation] = None
     fee_transfer_invocation: Optional[FunctionInvocation] = None
     state_diff: Optional[StateDiff] = None
@@ -873,6 +937,7 @@ class DeployAccountTransactionTrace:
     """
 
     constructor_invocation: FunctionInvocation
+    execution_resources: ExecutionResources
     validate_invocation: Optional[FunctionInvocation] = None
     fee_transfer_invocation: Optional[FunctionInvocation] = None
     state_diff: Optional[StateDiff] = None