Add configuration readme #61
Conversation
README.md
Outdated
| @@ -19,6 +19,13 @@ SDK for Hyperliquid API trading with Python. | |||
| ```bash | |||
| pip install hyperliquid-python-sdk | |||
| ``` | |||
| ## Configuration | |||
| Generate and authorize a new API private key on https://app.hyperliquid.xyz/API | |||
There was a problem hiding this comment.
I'm a bit torn on this recommendation. I think users are less likely to get confused if they use their wallet's private key directly. API wallet's do not have permission to perform several actions the sdk supports. I'd prefer if the docs recommended using your private key and maybe mentioning setting up an API wallet as an option if the complexity security tradeoff is worth it for you
There was a problem hiding this comment.
good point
I've updated the content here to primarily point to the main wallet and optionally use an API wallet
@traderben im also thinking of moving this to use the dotenv package for managing the private key rather than holding it in the config file. Is that something you're supportive of?
There was a problem hiding this comment.
Thanks for updating the readme. I don't see the value in adding a dependency on dotenv, so I'd rather not add that change
perplover
force-pushed
the
configuratio-readme
branch
from
4bc964c to
be98772
Compare
Co-authored-by: Ben <ben@hl-labs.xyz>
Add some details on how to setup the configuration for using the SDK