Skip to content

Commit 0b92299

Browse files
authored
add account troubleshooting docs (#1855)
1 parent 06db364 commit 0b92299

File tree

3 files changed

+28
-0
lines changed

3 files changed

+28
-0
lines changed

docs/troubleshooting.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,3 +88,28 @@ Here are some links to testnet ether instructions (in no particular order):
8888
- `Kovan <https://github.com/kovan-testnet/faucet>`_
8989
- `Rinkeby <https://www.rinkeby.io/#faucet>`_
9090
- `Ropsten <https://www.reddit.com/r/ethdev/comments/72ltwj/the_new_if_you_need_some_ropsten_testnet_ethers/>`_
91+
92+
93+
.. _account_troubleshooting:
94+
95+
Why can't I create an account?
96+
------------------------------
97+
98+
If you're seeing the error ``The method personal_newAccount does not exist/is not available``,
99+
you may be trying to create an account while connected to a remote node provider, like Infura.
100+
As a matter of security, remote nodes cannot create accounts.
101+
102+
If you are in fact running a local node, make sure that it's properly configured to accept ``personal``
103+
methods. For Geth, that looks something like: ``--http.api personal,eth,<etc>`` or ``--ws.api personal,eth,<etc>``
104+
depending on your configuration. Note that the IPC configuration is most secure and includes the ``personal``
105+
API by default.
106+
107+
In general, your options for accounts are:
108+
109+
- Run a node (e.g., Geth) locally, connect to it via the local port, then use the ``personal`` API.
110+
- Import a keystore file for an account and :ref:`extract the private key<extract_geth_pk>`.
111+
- Create an account via the :ref:`eth-account <eth-account>` API, e.g., ``new_acct = w3.eth.account.create()``.
112+
- Use an external service (e.g., MyCrypto) to generate a new account, then securely import its private key.
113+
114+
.. Warning:: Don't store real value in an account until you are familiar with security best practices.
115+
If you lose your private key, you lose your account!

docs/web3.eth.account.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ Using private keys usually involves ``w3.eth.account`` in one way or another. Re
5555
or see a full list of things you can do in the docs for
5656
:class:`eth_account.Account <eth_account.account.Account>`.
5757

58+
.. _extract_geth_pk:
59+
5860
Extract private key from geth keyfile
5961
---------------------------------------------
6062

newsfragments/1855.doc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add account creation troubleshooting docs.

0 commit comments

Comments
 (0)