Merge branch 'development'

Author: tomek0123456789

.github/dependabot.yml

@@ -8,5 +8,5 @@ updates:
   - package-ecosystem: "pip" # See documentation for possible values
     directory: "/" # Location of package manifests
     schedule:
-      interval: "weekly"
+      interval: "monthly"
     versioning-strategy: increase-if-necessary

.github/workflows/checks.yml

@@ -226,6 +226,71 @@ jobs:
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3
 
+  # ---------------------------------------------------------- #
+  # ..................RUN-TESTS-INTEGRATION................... #
+  # ---------------------------------------------------------- #
+
+  run-tests-integration:
+    name: Tests on integration
+    needs: setup-tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Download contracts
+        uses: actions/download-artifact@v3
+        with:
+          name: contract-artifacts
+          path: starknet_py/tests/e2e/mock/
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+          cache: 'pip'
+
+      # ====================== SETUP PYTHON ====================== #
+
+      - name: Install poetry
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry
+          poetry config installer.modern-installation false
+
+      - name: Install python 3.9 requirements
+        run: |
+          poetry export -f requirements.txt --only=py39-dev --without-hashes --output requirements.txt
+          pip install -r requirements.txt
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+          cache: 'poetry'
+
+      - name: Install dependencies
+        run: |
+          poetry install --without py39-dev
+
+      # ====================== RUN TESTS ====================== #
+
+      - name: Check circular imports
+        run: |
+          poetry run poe circular_imports_check
+
+      - name: Run tests
+        run: |
+          poetry run poe test_ci_integration_full_node
+          poetry run poe test_ci_integration_gateway
+
+      - name: Generate coverage in XML
+        run: |
+          poetry run coverage xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+
   # ---------------------------------------------------------- #
   # ....................RUN-TESTS-WINDOWS..................... #
   # ---------------------------------------------------------- #

.github/workflows/stale.yml

@@ -13,6 +13,7 @@ jobs:
       - uses: actions/stale@v8
         with:
           exempt-all-pr-assignees: true
+          exempt-issue-labels: 'pinned'
           exempt-pr-labels: 'pinned'
           stale-issue-message: 'This issue is stale because it has not received any activity in the last 30 days. Remove stale label or add a comment, otherwise it will be closed in 5 days.'
           close-issue-message: 'This issue was closed because it has been stale for 5 days with no activity.'

docs/installation.rst

@@ -50,7 +50,15 @@ You can install starknet.py on Windows in two ways:
 
 1. Install it just like you would on Linux.
 
-You might encounter problems related to ``libcrypto_c_exports``. Make sure that you have `MinGW <https://www.mingw-w64.org/>`_ installed and up-to-date.
+You might encounter problems related to ``libcrypto_c_exports``.
+
+In such case make sure that you have `MinGW <https://www.mingw-w64.org/>`_ installed and up-to-date.
+
+.. hint::
+    An easy way to install MinGW is through `chocolatey <https://community.chocolatey.org/packages/mingw>`_.
+
+    You also should have MinGW in your PATH environment variable (e.g. ``C:\ProgramData\chocolatey\lib\mingw\tools\install\mingw64\bin``).
+
 
 If you encounter any further problems related to installation, you can create an `issue at our GitHub <https://github.com/software-mansion/starknet.py/issues/new?assignees=&labels=bug&projects=&template=bug_report.yaml&title=%5BBUG%5D+%3Ctitle%3E>`_
 or ask for help in ``#🐍 | starknet-py`` channel on `Starknet Discord server <https://starknet.io/discord>`_.

docs/migration_guide.rst

@@ -1,6 +1,64 @@
 Migration guide
 ===============
 
+**********************
+0.18.0 Migration guide
+**********************
+
+This version of starknet.py brings support Starknet 0.12.1 and `RPC v0.4.0 <https://github.com/starkware-libs/starknet-specs/releases/tag/v0.4.0>`!
+
+
+1. :class:`TransactionReceipt` dataclass properties have been changed (more details in RPC specification linked above).
+
+0.18.0 Deprecations
+-------------------
+
+.. currentmodule:: starknet_py.net.client_models
+
+1. ``status`` field in :class:`TransactionReceipt` returned by :meth:`FullNodeClient.get_transaction_receipt` has been deprecated.
+
+
+0.18.0 Minor changes
+--------------------
+
+.. currentmodule:: starknet_py.net.full_node_client
+
+1. :meth:`FullNodeClient.get_transaction_receipt` now returns two additional fields: ``acceptance_status`` and ``finality_status``.
+
+.. currentmodule:: starknet_py.net.client_models
+
+2. Added two fields to :class:`TransactionReceipt` - ``revert_error`` (Gateway) and ``revert_reason`` (FullNode).
+3. ``hash`` property in :class:`Transaction` is now optional.
+4. Added missing field ``contract_address_salt`` to :class:`DeployTransaction`.
+
+.. currentmodule:: starknet_py.net.client
+
+5. Lowered ``check_interval`` parameter default value in :meth:``Client.wait_for_tx`` from 5 seconds to 2.
+
+.. currentmodule:: starknet_py.net.client_models
+
+6. Added fields to dataclasses that previously were missing (e.g. ``contract_address_salt`` in :class:`DeployTransaction`).
+
+.. currentmodule:; starknet_py.cairo.felt
+
+7. :func:`decode_shortstring` now is returned without ``\x00`` in front of the decoded string.
+
+
+0.18.0 Bugfixes
+---------------
+
+1. Fixed invalid type in :class:`BlockStateUpdate` from ``StateDiff`` to ``Union[StateDiff, GatewayStateDiff]``
+2. Fixed ``Contract not found`` error in ``AbiResolver``
+
+
+|
+
+.. raw:: html
+
+  <hr>
+
+|
+
 **********************
 0.17.0 Migration guide
 **********************
@@ -38,8 +96,8 @@ Also, four methods were added to its interface:
 - :meth:`FullNodeClient.get_syncing_status`
 
 
-Breaking changes
-----------------
+0.17.0 Breaking changes
+-----------------------
 
 1. Deprecated function ``compute_invoke_hash`` in :mod:`starknet_py.net.models.transaction` has been removed in favor of :func:`starknet_py.hash.transaction.compute_invoke_transaction_hash`.
 
@@ -50,8 +108,8 @@ Breaking changes
 3. Removed ``PENDING`` transaction status.
 
 
-Minor changes
--------------
+0.17.0 Minor changes
+--------------------
 
 .. currentmodule:: starknet_py.contract
 
@@ -84,15 +142,15 @@ RPC related changes:
 10. :meth:`Client.wait_for_tx` has a new parameter ``retries`` describing the amount of retries before a time out when querying for a transaction.
 
 
-Deprecations
-------------
+0.17.0 Deprecations
+-------------------
 .. currentmodule:: starknet_py.net.client
 
 1. `wait_for_accept` parameter in :meth:`Client.wait_for_tx` and :meth:`SentTransaction.wait_for_acceptance` has been deprecated.
 
 
-Bugfixes
---------
+0.17.0 Bugfixes
+---------------
 
 .. currentmodule:: starknet_py.hash.class_hash