# Stellar Keystore
This is a helper library for creating stellar keystore wallets.
Due to the lack of relevant [SEPs](https://github.com/stellar/stellar-protocol/tree/master/ecosystem) currently, [stellarport/stellar-keystore](https://github.com/stellarport/stellar-keystore) is the most widely applied implementation, so the implementation of this library is consistent with it.
## What is a keystore wallet?
A keystore wallet is a data blob that stores an encrypted secret key. The objective of a keystore wallet is to allow a user who does not want to remember/manage a secret key
and would instead rather manage a password, to store and securely encrypt their secret key using their desired password.
## What does this library offer?
This library offers methods that will allow your application to create stellar keystore wallets (i.e. keystore wallets containing secret keys controlling stellar public keys)
as well as retrieve a stellar keypair given a keystore wallet/password combination.
## Installation
```bash
pip install stellar-keystore
```
## Usage
```python
from stellar_sdk import Keypair
from stellar_keystore import *
# Create a new keystore wallet
keypair = Keypair.random()
keystore_wallet = create_keystore(keypair, b"password")
# Retrieve the keypair from the keystore wallet
keypair = load_keystore(keystore_wallet, b"password")
```
## API
```python
def create_keystore(keypair: Keypair, password: bytes) -> dict:
"""Create a keystore from a keypair.
:param keypair: The keypair to create a keystore from.
:param password: The password to encrypt the keystore with.
:return: The keystore.
"""
pass
```
```python
def load_keystore(keystore: dict, password: bytes) -> Keypair:
"""Load a keypair from a keystore.
:param keystore: The keystore to load a keypair from.
:param password: The password to decrypt the keystore with.
:return: The keypair.
"""
pass
```
Raw data
{
"_id": null,
"home_page": "https://github.com/overcat/stellar-keystore",
"name": "stellar-keystore",
"maintainer": "overcat",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "4catcode@gmail.com",
"keywords": "stellar,stellar.org,keystore,keyfile",
"author": "overcat",
"author_email": "4catcode@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/00/52/cbea1ecc91b785a812b052b58295e5b549788d83cd836c61e9085fdebee0/stellar_keystore-0.1.2.tar.gz",
"platform": null,
"description": "# Stellar Keystore\n\nThis is a helper library for creating stellar keystore wallets. \n\nDue to the lack of relevant [SEPs](https://github.com/stellar/stellar-protocol/tree/master/ecosystem) currently, [stellarport/stellar-keystore](https://github.com/stellarport/stellar-keystore) is the most widely applied implementation, so the implementation of this library is consistent with it.\n\n## What is a keystore wallet?\nA keystore wallet is a data blob that stores an encrypted secret key. The objective of a keystore wallet is to allow a user who does not want to remember/manage a secret key\nand would instead rather manage a password, to store and securely encrypt their secret key using their desired password.\n\n## What does this library offer?\nThis library offers methods that will allow your application to create stellar keystore wallets (i.e. keystore wallets containing secret keys controlling stellar public keys)\nas well as retrieve a stellar keypair given a keystore wallet/password combination.\n\n## Installation\n```bash\npip install stellar-keystore\n```\n\n## Usage\n```python\nfrom stellar_sdk import Keypair\nfrom stellar_keystore import *\n\n# Create a new keystore wallet\nkeypair = Keypair.random()\nkeystore_wallet = create_keystore(keypair, b\"password\")\n\n# Retrieve the keypair from the keystore wallet\nkeypair = load_keystore(keystore_wallet, b\"password\")\n```\n\n## API\n```python\ndef create_keystore(keypair: Keypair, password: bytes) -> dict:\n \"\"\"Create a keystore from a keypair.\n\n :param keypair: The keypair to create a keystore from.\n :param password: The password to encrypt the keystore with.\n :return: The keystore.\n \"\"\"\n pass\n```\n\n```python\ndef load_keystore(keystore: dict, password: bytes) -> Keypair:\n \"\"\"Load a keypair from a keystore.\n\n :param keystore: The keystore to load a keypair from.\n :param password: The password to decrypt the keystore with.\n :return: The keypair.\n \"\"\"\n pass\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Tools for handling the encrypted keystore format used to store Stellar keypairs.",
"version": "0.1.2",
"split_keywords": [
"stellar",
"stellar.org",
"keystore",
"keyfile"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "309ba29da946c0edcc14f6d72cc968eb4f6970b3248e6522c852323f67205514",
"md5": "c79693e1965bbf5d1aada44383abc062",
"sha256": "94514c7876e7656763a498a3caf064e57d10524967b8d9c3b31ab2b7abd9c2b7"
},
"downloads": -1,
"filename": "stellar_keystore-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c79693e1965bbf5d1aada44383abc062",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 7382,
"upload_time": "2023-04-20T10:37:41",
"upload_time_iso_8601": "2023-04-20T10:37:41.705838Z",
"url": "https://files.pythonhosted.org/packages/30/9b/a29da946c0edcc14f6d72cc968eb4f6970b3248e6522c852323f67205514/stellar_keystore-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0052cbea1ecc91b785a812b052b58295e5b549788d83cd836c61e9085fdebee0",
"md5": "feacae577f14e7903a168d3f88dd98e3",
"sha256": "67b6e692b48751000a304b5efc48c4edc22dc57be528a4d02ad53dd1faf9f098"
},
"downloads": -1,
"filename": "stellar_keystore-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "feacae577f14e7903a168d3f88dd98e3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 6691,
"upload_time": "2023-04-20T10:37:48",
"upload_time_iso_8601": "2023-04-20T10:37:48.276963Z",
"url": "https://files.pythonhosted.org/packages/00/52/cbea1ecc91b785a812b052b58295e5b549788d83cd836c61e9085fdebee0/stellar_keystore-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-20 10:37:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "overcat",
"github_project": "stellar-keystore",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "stellar-keystore"
}
JSON
