Merge branch 'development'

Author: franciszekjob

.github/workflows/checks.yml

@@ -3,6 +3,8 @@ name: Checks
 env:
   CAIRO_LANG_VERSION: "0.13.1"
   DEVNET_VERSION: "0.1.2"
+  DEVNET_SHA: 7e7dbb5
+  LEDGER_APP_SHA: dd58c5c
 
 on:
   push:
@@ -97,7 +99,7 @@ jobs:
       # ====================== CONTRACTS v2 ====================== #
       - name: Cache contracts v2
         id: cache-contracts_v2
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: starknet_py/tests/e2e/mock/contracts_v2/target
           key: ${{ runner.os }}-contracts-${{ hashFiles('starknet_py/tests/e2e/mock/contracts_v2') }}
@@ -111,7 +113,7 @@ jobs:
 
       - name: Cache contracts v1
         id: cache-contracts_v1
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: starknet_py/tests/e2e/mock/contracts_v1/target
           key: ${{ runner.os }}-contracts-${{ hashFiles('starknet_py/tests/e2e/mock/contracts_v1') }}
@@ -120,29 +122,8 @@ jobs:
         if: steps.cache-contracts_v1.outputs.cache-hit != 'true'
         run: |
           poetry run poe compile_contracts v1
-  
-      # ====================== CONTRACTS v0 ====================== #
 
-      - name: Cache contracts v0
-        id: cache-contracts
-        uses: actions/cache@v3
-        with:
-          path: starknet_py/tests/e2e/mock/contracts_compiled
-          key: ${{ runner.os }}-contracts-${{ hashFiles('starknet_py/tests/e2e/mock/contracts', 'poetry.lock') }}-${{ env.CAIRO_LANG_VERSION }}
-
-      - name: Install deprecated cairo compiler
-        if: steps.cache-contracts.outputs.cache-hit != 'true'
-        run: |
-          pip install --upgrade setuptools
-          pip install sympy==1.11.1
-          pip install cairo-lang==${{ env.CAIRO_LANG_VERSION }}
-
-      - name: Compile contracts v0
-        if: steps.cache-contracts.outputs.cache-hit != 'true'
-        run: |
-          poetry run poe compile_contracts v0
-
-      - name: Upload contracts v0
+      - name: Upload contracts artifacts
         uses: actions/upload-artifact@v3
         with:
           name: contract-artifacts
@@ -159,7 +140,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
+        python-version: [ "3.8", "3.12" ]
     env:
       LEDGER_PROXY_ADDRESS: 127.0.0.1
       LEDGER_PROXY_PORT: 9999
@@ -217,6 +198,7 @@ jobs:
           options: --rm -v ${{ github.workspace }}:/apps
           run: |
             cd /apps/app-starknet
+            git checkout ${{ env.LEDGER_APP_SHA }}
             cargo clean
             cargo ledger build nanox
 
@@ -307,6 +289,11 @@ jobs:
         run: |
           poetry install
 
+      # ====================== SETUP DEVNET ====================== #
+
+      - name: Install devnet
+        run: ./starknet_py/tests/install_devnet.sh
+
       # ====================== RUN TESTS ====================== #
 
       - name: Check circular imports
@@ -336,7 +323,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
+        python-version: [ "3.8", "3.12" ]
     env:
       SEPOLIA_RPC_URL: ${{ secrets.SEPOLIA_RPC_URL }}
     steps:
@@ -358,11 +345,19 @@ jobs:
 
       # ====================== SETUP DEVNET ====================== #
 
+      - name: Cache devnet build
+        id: windows-devnet-cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ github.workspace }}\starknet_py\tests\e2e\devnet\bin
+          key: ${{ runner.os }}-devnet-${{ env.DEVNET_SHA }}
+
       - name: Install devnet
+        if: steps.windows-devnet-cache.outputs.cache-hit != 'true'
         run: |
-          $DEVNET_INSTALL_DIR = "$(git rev-parse --show-toplevel)/starknet_py/tests/e2e/devnet"
-          cargo install --git https://github.com/0xSpaceShard/starknet-devnet-rs.git --locked --rev 7e7dbb5 --root $DEVNET_INSTALL_DIR
-
+          $DEVNET_INSTALL_DIR = "${{ github.workspace }}\starknet_py\tests\e2e\devnet"
+          cargo install --git https://github.com/0xSpaceShard/starknet-devnet-rs.git --locked --rev ${{ env.DEVNET_SHA }} --root $DEVNET_INSTALL_DIR
+        shell: pwsh
       # ====================== SETUP PYTHON ====================== #
 
       - name: Install poetry
@@ -410,7 +405,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
+        python-version: [ "3.8", "3.12" ]
     steps:
       - uses: actions/checkout@v4
 
@@ -474,7 +469,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
+        python-version: [ "3.8", "3.12" ]
     steps:
       - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@dc6353516c68da0f06325f42ad880f76a5e77ec9
@@ -512,10 +507,19 @@ jobs:
 
       # ====================== SETUP DEVNET ====================== #
 
+      - name: Cache devnet build
+        id: windows-devnet-cache
+        uses: actions/cache@v4
+        with:
+          path: ${{ github.workspace }}\starknet_py\tests\e2e\devnet\bin
+          key: ${{ runner.os }}-devnet-${{ env.DEVNET_SHA }}
+
       - name: Install devnet
+        if: steps.windows-devnet-cache.outputs.cache-hit != 'true'
         run: |
-          $DEVNET_INSTALL_DIR = "$(git rev-parse --show-toplevel)/starknet_py/tests/e2e/devnet"
-          cargo install --git https://github.com/0xSpaceShard/starknet-devnet-rs.git --locked --rev 7e7dbb5 --root $DEVNET_INSTALL_DIR
+          $DEVNET_INSTALL_DIR = "${{ github.workspace }}\starknet_py\tests\e2e\devnet"
+          cargo install --git https://github.com/0xSpaceShard/starknet-devnet-rs.git --locked --rev ${{ env.DEVNET_SHA }} --root $DEVNET_INSTALL_DIR
+        shell: pwsh
 
       # ====================== RUN TESTS ====================== #
 

.github/workflows/package.yml

@@ -1,5 +1,10 @@
 name: Build wheels
-on: workflow_dispatch
+
+on:
+  push:
+    tags:
+      - '*'
+  workflow_dispatch:
 
 jobs:
   build_sdist:

README.md

@@ -29,36 +29,186 @@ Installation varies between operating systems.
 
 [See our documentation on complete instructions](https://starknetpy.rtfd.io/en/latest/installation.html)
 
-## ▶️ Example usage
 
-### Asynchronous API
+## 💨 Quickstart
+### Using FullNodeClient
+A [Client](https://starknetpy.readthedocs.io/en/latest/api/client.html#client) is a facade for interacting with Starknet. 
+[FullNodeClient](https://starknetpy.readthedocs.io/en/latest/api/full_node_client.html#module-starknet_py.net.full_node_client) is a client which interacts with a Starknet full nodes like [Pathfinder](https://github.com/eqlabs/pathfinder), [Papyrus](https://github.com/starkware-libs/papyrus) or [Juno](https://github.com/NethermindEth/juno). 
+It supports read and write operations, like querying the blockchain state or adding new transactions.
 
-This is the recommended way of using the SDK.
 
 ```python
-from starknet_py.contract import Contract
 from starknet_py.net.full_node_client import FullNodeClient
 
-contract = await Contract.from_address(
-    address="0x06689f1bf69af5b8e94e5ab9778c885b37c593d1156234eb423967621f596e73",
-    client=FullNodeClient(node_url="https://your.node.url"),
+node_url = "https://your.node.url"
+client = FullNodeClient(node_url=node_url)
+
+call_result = await client.get_block(block_number=1)
+```
+The default interface is asynchronous. Although it is the recommended way of using starknet.py, you can also use a synchronous version. It might be helpful to play with Starknet directly in python interpreter.
+
+```python
+node_url = "https://your.node.url"
+client = FullNodeClient(node_url=node_url)
+call_result = client.get_block_sync(block_number=1)
+```
+You can check out all of the FullNodeClient’s methods here: [FullNodeClient](https://starknetpy.readthedocs.io/en/latest/api/full_node_client.html#module-starknet_py.net.full_node_client).
+
+### Creating Account
+[Account](https://starknetpy.readthedocs.io/en/latest/api/account.html#starknet_py.net.account.account.Account) is the default implementation of [BaseAccount](https://starknetpy.readthedocs.io/en/latest/api/account.html#starknet_py.net.account.base_account.BaseAccount) interface. 
+It supports an account contract which proxies the calls to other contracts on Starknet.
+
+Account can be created in two ways:
+- By constructor (It is required to provide an `address` and either `key_pair` or `signer`).
+- By static methods `Account.deploy_account_v1` or `Account.deploy_account_v3`
+
+Additionally, you can use the [sncast](https://foundry-rs.github.io/starknet-foundry/starknet/index.html) tool to create an account, 
+which will automatically be saved to a file.
+There are some examples how to do it:
+```python
+from starknet_py.net.account.account import Account
+from starknet_py.net.full_node_client import FullNodeClient
+from starknet_py.net.models.chains import StarknetChainId
+from starknet_py.net.signer.stark_curve_signer import KeyPair
+from starknet_py.net.signer.stark_curve_signer import StarkCurveSigner
+
+# Creates an instance of account which is already deployed
+# Account using transaction version=1 (has __validate__ function)
+client = FullNodeClient(node_url="https://your.node.url")
+account = Account(
+    client=client,
+    address="0x4321",
+    key_pair=KeyPair(private_key=654, public_key=321),
+    chain=StarknetChainId.SEPOLIA,
+)
+
+# There is another way of creating key_pair
+key_pair = KeyPair.from_private_key(key=123)
+# or
+key_pair = KeyPair.from_private_key(key="0x123")
+
+# Instead of providing key_pair it is possible to specify a signer
+signer = StarkCurveSigner("0x1234", key_pair, StarknetChainId.SEPOLIA)
+
+account = Account(
+    client=client, address="0x1234", signer=signer, chain=StarknetChainId.SEPOLIA
+)
+```
+
+### Using Account
+Example usage:
+
+```python
+from starknet_py.contract import Contract
+from starknet_py.net.client_models import ResourceBounds
+l1_resource_bounds = ResourceBounds(
+    max_amount=int(1e5), max_price_per_unit=int(1e13)
+)
+# Declare and deploy an example contract which implements a simple k-v store.
+# Contract.declare_v3 takes string containing a compiled contract (sierra) and
+# a class hash (casm_class_hash) or string containing a compiled contract (casm)
+declare_result = await Contract.declare_v3(
+    account,
+    compiled_contract=compiled_contract,
+    compiled_class_hash=class_hash,
+    l1_resource_bounds=l1_resource_bounds,
+)
+
+await declare_result.wait_for_acceptance()
+deploy_result = await declare_result.deploy_v3(
+    l1_resource_bounds=l1_resource_bounds,
 )
-(value,) = await contract.functions["get_balance"].call()
+# Wait until deployment transaction is accepted
+await deploy_result.wait_for_acceptance()
+
+# Get deployed contract
+map_contract = deploy_result.deployed_contract
+k, v = 13, 4324
+# Adds a transaction to mutate the state of k-v store. The call goes through account proxy, because we've used
+# Account to create the contract object
+await (
+    await map_contract.functions["put"].invoke_v3(
+        k,
+        v,
+        l1_resource_bounds=ResourceBounds(
+            max_amount=int(1e5), max_price_per_unit=int(1e13)
+        ),
+    )
+).wait_for_acceptance()
+
+# Retrieves the value, which is equal to 4324 in this case
+(resp,) = await map_contract.functions["get"].call(k)
+
+# There is a possibility of invoking the multicall
+
+# Creates a list of prepared function calls
+calls = [
+    map_contract.functions["put"].prepare_invoke_v3(key=10, value=20),
+    map_contract.functions["put"].prepare_invoke_v3(key=30, value=40),
+]
+
+# Executes only one transaction with prepared calls
+transaction_response = await account.execute_v3(
+    calls=calls,
+    l1_resource_bounds=l1_resource_bounds,
+)
+await account.client.wait_for_tx(transaction_response.transaction_hash)
 ```
 
-### Synchronous API
+### Using Contract
+[Contract](https://starknetpy.readthedocs.io/en/latest/api/contract.html#starknet_py.contract.Contract) makes interacting with contracts deployed on Starknet much easier:
+```python
+from starknet_py.contract import Contract
+
+contract_address = (
+    "0x01336fa7c870a7403aced14dda865b75f29113230ed84e3a661f7af70fe83e7b"
+)
+key = 1234
+
+# Create contract from contract's address - Contract will download contract's ABI to know its interface.
+contract = await Contract.from_address(address=contract_address, provider=account)
+
+# If the ABI is known, create the contract directly (this is the preferred way).
+contract = Contract(
+    address=contract_address,
+    abi=abi,
+    provider=account,
+    cairo_version=1,
+)
 
-You can access synchronous world with `_sync` postfix.
+# All exposed functions are available at contract.functions.
+# Here we invoke a function, creating a new transaction.
+invocation = await contract.functions["put"].invoke_v1(key, 7, max_fee=int(1e16))
+
+# Invocation returns InvokeResult object. It exposes a helper for waiting until transaction is accepted.
+await invocation.wait_for_acceptance()
+
+# Calling contract's function doesn't create a new transaction, you get the function's result.
+(saved,) = await contract.functions["get"].call(key)
+# saved = 7 now
+```
+
+To check if invoke succeeded use `wait_for_acceptance` on InvokeResult and get its status.
+
+Although asynchronous API is recommended, you can also use Contract’s synchronous API:
 
 ```python
 from starknet_py.contract import Contract
-from starknet_py.net.full_node_client import FullNodeClient
 
-contract = Contract.from_address_sync(
-    address="0x06689f1bf69af5b8e94e5ab9778c885b37c593d1156234eb423967621f596e73",
-    client=FullNodeClient(node_url="https://your.node.url"),
+contract_address = (
+    "0x01336fa7c870a7403aced14dda865b75f29113230ed84e3a661f7af70fe83e7b"
 )
-(value,) = contract.functions["get_balance"].call_sync()
+
+key = 1234
+contract = Contract.from_address_sync(address=contract_address, provider=account)
+
+invocation = contract.functions["put"].invoke_v1_sync(key, 7, max_fee=int(1e16))
+invocation.wait_for_acceptance_sync()
+
+(saved,) = contract.functions["get"].call_sync(key)  # 7
 ```
 
-For more examples click [here](https://starknetpy.rtfd.io/en/latest/quickstart.html).
+Contract automatically serializes values to Cairo calldata. This includes adding array lengths automatically. 
+See more info in [Serialization](https://starknetpy.readthedocs.io/en/latest/guide/serialization.html#serialization).
+
+Quickstart in docs - click [here](https://starknetpy.rtfd.io/en/latest/quickstart.html).

docs/account_creation.rst

@@ -16,7 +16,7 @@ and then creating the transaction which will charge the fee from the address.
 Deploying an account with DeployAccount transaction requires the following:
 
  - class_hash of the account contract
- - generating a private key and deployment salt
+ - private key and deployment salt
  - computing an address based on the account's secrets
  - prefunding an address with the fee tokens (e.g. using the token bridge)
  - creating and signing a DeployAccount transaction with generated secrets

docs/api/models.rst

@@ -19,9 +19,6 @@ Module containing base models and functions to operate on them.
 .. autoclass:: DeployAccountV3
     :exclude-members: __init__, __new__
 
-.. autoclass:: DeclareV1
-    :exclude-members: __init__, __new__
-
 .. autoclass:: DeclareV2
     :exclude-members: __init__, __new__