Skip to content

Commit c2f0ce6

Browse files
authored
Follow new convention (StarkNet -> Starknet) (software-mansion#764)
* non breaking StarkNet -> Starknet * StarkNet -> Starknet in contracts * starknet -> Starknet * error messages changed! starknet -> Starknet * fix the guide * fix `core` docs files * fix api docs * fix migration guide
1 parent 85fff18 commit c2f0ce6

38 files changed

+106
-106
lines changed

docs/account_creation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Account creation
22
================
33

44

5-
An account is needed to start interacting with StarkNet.
5+
An account is needed to start interacting with Starknet.
66
If you don't have one there are a few ways of creating one programmatically:
77

88
- using DeployAccount transaction
@@ -20,7 +20,7 @@ Deploying an account with DeployAccount transaction requires the following:
2020
- computing an address based on the account's secrets
2121
- prefunding an address with the fee tokens (e.g. using the token bridge)
2222
- creating and signing a DeployAccount transaction with generated secrets
23-
- sending the transaction to StarkNet
23+
- sending the transaction to Starknet
2424

2525
Here is step by step example:
2626

docs/api/messages.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
StarkNet <> Ethereum Messaging
1+
Starknet <> Ethereum Messaging
22
==============================
33

44
.. warning::
5-
StarkNet <> Ethereum Messaging module is deprecated. If you are using it,
6-
please contact us on our StarkNet discord channel: starknet-py.
5+
Starknet <> Ethereum Messaging module is deprecated. If you are using it,
6+
please contact us on our Starknet discord channel: starknet-py.
77

88
.. _Messaging:
99

10-
Module containing utilities to operate on StarkNet -> Ethereum and Ethereum -> StarkNet messages
10+
Module containing utilities to operate on Starknet -> Ethereum and Ethereum -> Starknet messages
1111

1212
.. py:module:: starknet_py.net.l1.messages
1313

docs/api/signer.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ BaseSigner interface
1515
BaseSigner default implementation
1616
---------------------------------
1717

18-
By default, StarkNet.py uses ``StarkCurveSigner`` which works with OpenZeppelin's account contract.
18+
By default, starknet.py uses ``StarkCurveSigner`` which works with OpenZeppelin's account contract.
1919

2020
.. py:module:: starknet_py.net.signer.stark_curve_signer
2121

docs/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
# -- Project information -----------------------------------------------------
2323

24-
project = "Starknet.py"
24+
project = "starknet.py"
2525
copyright = "2023, Software Mansion"
2626
author = "Software Mansion"
2727

@@ -78,8 +78,8 @@
7878
pygments_dark_style = "dracula"
7979

8080
html_favicon = "_static/favicon.png"
81-
html_title = "StarkNet.py Documentation"
82-
html_short_title = "StarkNet.py"
81+
html_title = "starknet.py Documentation"
82+
html_short_title = "starknet.py"
8383
html_permalinks_icon = "#"
8484

8585
html_theme_options = {

docs/development.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Rules to follow when writing a code:
120120
Release checklist
121121
-------------------
122122

123-
Perform these actions before releasing a new StarkNet.py version
123+
Perform these actions before releasing a new starknet.py version
124124

125125
1. Bump package version in ``pyproject.toml``
126126
2. Re-lock using ``poetry lock --no-update``

docs/guide/account_and_client.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ Here is an example:
1717
FullNodeClient usage
1818
--------------------
1919

20-
Use a :ref:`FullNodeClient` to interact with services providing `starknet rpc interface <https://github.com/starkware-libs/starknet-specs/blob/606c21e06be92ea1543fd0134b7f98df622c2fbf/api/starknet_api_openrpc.json>`_
21-
like `Pathfinder Full Node <https://github.com/eqlabs/pathfinder>`_ or starknet-devnet. StarkNet.py provides uniform interface for
20+
Use a :ref:`FullNodeClient` to interact with services providing `Starknet rpc interface <https://github.com/starkware-libs/starknet-specs/blob/606c21e06be92ea1543fd0134b7f98df622c2fbf/api/starknet_api_openrpc.json>`_
21+
like `Pathfinder Full Node <https://github.com/eqlabs/pathfinder>`_ or starknet-devnet. starknet.py provides uniform interface for
2222
both gateway and full node client - usage is exactly the same as gateway client minus some optional
2323
parameters.
2424

25-
Using own full node allows for querying StarkNet with better performance.
25+
Using own full node allows for querying Starknet with better performance.
2626
Since gateway will be deprecated at some point in the future, having ``FullNodeClient`` with interface uniform with that of ``GatewayClient``
27-
will allow for simple migration for StarkNet.py users.
27+
will allow for simple migration for starknet.py users.
2828

2929
.. codesnippet:: ../../starknet_py/tests/e2e/docs/guide/test_full_node_client.py
3030
:language: python
@@ -43,7 +43,7 @@ You can use :class:`starknet_py.net.client_errors.ClientError` to catch errors f
4343
Custom nonce logic
4444
------------------
4545

46-
By default, :ref:`Account` calls StarkNet for nonce every time a new transaction is signed or executed.
46+
By default, :ref:`Account` calls Starknet for nonce every time a new transaction is signed or executed.
4747
This is okay for most users, but in case your applications needs to pre-sign multiple transactions
4848
for execution, deals with high amount of transactions or just needs to support different nonce
4949
logic, it is possible to so with :ref:`Account`. Simply overwrite the

docs/guide/deploying_contracts.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Here's an example how to use it.
2323
Simple declare and deploy
2424
-------------------------
2525

26-
The simplest way of declaring and deploying contracts on the StarkNet is to use the :ref:`Contract` class.
26+
The simplest way of declaring and deploying contracts on the Starknet is to use the :ref:`Contract` class.
2727
Under the hood, this flow sends :meth:`Declare` transaction and then sends :meth:`InvokeFunction`
2828
through Universal Deployment Contract (UDC) to deploy a contract.
2929

docs/guide/ethereum_communication.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
StarkNet <> Ethereum communication
1+
Starknet <> Ethereum communication
22
==================================
33

44
.. warning::
5-
StarkNet <> Ethereum Messaging module is deprecated. If you are using it,
6-
please contact us on our StarkNet discord channel: starknet-py.
5+
Starknet <> Ethereum Messaging module is deprecated. If you are using it,
6+
please contact us on our Starknet discord channel: starknet-py.
77

8-
To retrieve the StarkNet -> Ethereum or Ethereum -> StarkNet message count, you need to provide some data that you used to create that message.
8+
To retrieve the Starknet -> Ethereum or Ethereum -> Starknet message count, you need to provide some data that you used to create that message.
99
Then after creating the message's representation, you can query its current count.
1010

11-
You can find out more about StarkNet <> Ethereum messaging here: https://starknet.io/documentation/l1-l2-messaging/
11+
You can find out more about Starknet <> Ethereum messaging here: https://starknet.io/documentation/l1-l2-messaging/
1212

1313
Full API description :ref:`here<Messaging>`.
1414

1515

1616

17-
Ethereum -> StarkNet messages
17+
Ethereum -> Starknet messages
1818
#############################
1919

2020
The message's count is an `int`, representing the number of unconsumed messages on L2 with that exact content.
@@ -26,7 +26,7 @@ Since the `nonce`'s value will always be unique for each message, this value is
2626
:dedent: 4
2727

2828

29-
StarkNet -> Ethereum messages
29+
Starknet -> Ethereum messages
3030
#############################
3131

3232
As in previous section, you can provide L1 message content, and then fetch the queued message count.

docs/guide/resolving_proxy_contracts.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Resolving proxy contracts
44
.. note::
55
If you know the abi of the contract, **always prefer** creating Contract directly from constructor.
66

7-
:meth:`Contract.from_address <starknet_py.contract.Contract.from_address>` must perform some calls to StarkNet to get an abi of the contract.
7+
:meth:`Contract.from_address <starknet_py.contract.Contract.from_address>` must perform some calls to Starknet to get an abi of the contract.
88

9-
Resolving proxies is a powerful feature of Starknet.py. If your contract is a proxy to some implementation, you can use
9+
Resolving proxies is a powerful feature of starknet.py. If your contract is a proxy to some implementation, you can use
1010
high-level :meth:`Contract.from_address <starknet_py.contract.Contract.from_address>` method to get a contract instance.
1111

1212
:meth:`Contract.from_address <starknet_py.contract.Contract.from_address>` works with contracts which are not proxies, so it is the most universal method of getting
@@ -22,9 +22,9 @@ a contract not knowing the abi.
2222
ProxyChecks
2323
-----------
2424

25-
Since the Proxy contracts on StarkNet can have different implementations, as every user can define their custom implementation, there is no single way of checking if some contract is a Proxy contract.
25+
Since the Proxy contracts on Starknet can have different implementations, as every user can define their custom implementation, there is no single way of checking if some contract is a Proxy contract.
2626

27-
There are two main ways of proxying a contract on StarkNet:
27+
There are two main ways of proxying a contract on Starknet:
2828
- forward the calls using ``library_call`` and ``class_hash`` of proxied contract
2929
- forward the calls using ``delegate_call`` and ``address`` of proxied contract
3030

docs/guide/serialization.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Serialization
44
Data serialization
55
-------------------
66

7-
Starknet.py **serializes** python values to Cairo values and **deserializes** Cairo values to python values.
7+
starknet.py **serializes** python values to Cairo values and **deserializes** Cairo values to python values.
88

99
.. attention::
1010
Serializing short strings to felts has been deprecated. Please use `starknet_py.cairo.felt.encode_shortstring` to

0 commit comments

Comments
 (0)