eth-keypass

Simple EVM account management tool.

NOTE: This library is still in early alpha development. Prior to a v1.0.0 (which may never come), expect breaking changes and no backward compatibility between versions.

Installation

You can install the latest release via pip:

pip install eth_keypass

Or clone the repository for the most up-to-date version:

git clone https://github.com/iamdefinitelyahuman/eth-keypass.git
cd eth-keypass
pip install -e .

Usage

1. Create and access a Keypass

Creating a keypass is a single function call. The result is a persistent database stored on disk.

>>> import eth_keypass

>>> kp = eth_keypass.create("main")
Create password for new keypass 'main': ***

>>> kp
<KeypassDB path=/home/user/.local/share/eth-keypass/main.sqlite3 unlocked>

Once created, it can be opened and unlocked in another session.

>>> import eth_keypass

>>> kp = eth_keypass.open("main")
>>> kp.unlock()
Enter the password for keypass 'main': ***

# alternatively use the top-level "unlock" to open and unlock in a single action
>>> kp = eth_keypass.unlock("main", password="mypassword")

2. Create an account

A new account can be generated directly inside the keypass. Its private key is encrypted and stored in the database.

>>> acct = kp.create_account()
>>> acct
<Account 0x0D3AaC9458167352493864Af54D1CBD7F1B8fF68 signable>

3. Import existing accounts

A keypass can hold multiple accounts.

You can import an existing account from a raw private key:

>>> kp.add_private_key(
...     "0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
...     alias="imported-key",
... )
<Account 0xFCAd0B19bB29D4674531d6f115237E16AfCE377c signable>

Or import from an Ethereum keystore JSON:

>>> kp.import_keystore(
...     "./my-keystore.json",
...     password="keystore-password",
...     alias="imported-json",
... )
<Account 0x104da57BF95262B119553181bA62dD5B8F204f49 signable>

4. Set aliases

You can set aliases for accounts to simplify retrieval later. A single account can have multiple aliases.

>>> kp.set_alias(acct, "hot")
>>> kp.set_alias(acct, "trading")

>>> kp["hot"]
<Account 0x0D3AaC9458167352493864Af54D1CBD7F1B8fF68 signable>

>>> kp["0x0D3AaC9458167352493864Af54D1CBD7F1B8fF68"]
<Account 0x0D3AaC9458167352493864Af54D1CBD7F1B8fF68 signable>

>>> kp["hot"] == kp["trading"] == acct
True

5. Add watch-only accounts

If you assign an alias to an address that has no private key in the keypass, it is stored as a watch-only account.

This lets you keep named references to important addresses and retrieve them later by alias.

>>> kp.set_alias("0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", "vitalik")

>>> kp["vitalik"]
<Account 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045 watch-only>

6. Sign a transaction

Here we build a transaction from one of our signing accounts to send to one of our watch-only accounts.

>>> tx = {
...     "to": kp["vitalik"],
...     "value": 10**18,
...     "gas": 21_000,
...     "maxFeePerGas": 30_000_000_000,
...     "maxPriorityFeePerGas": 2_000_000_000,
...     "nonce": 0,
...     "chainId": 1
... }
>>> signed = kp["hot"].sign_transaction(tx)

>>> signed
SignedTransaction(raw_transaction=b'\x02...', hash=b'\xa1...', r=..., s=..., v=1)

7. Sign messages

The Account object also exposes methods for signing messages and authorizations.

Account.sign_authorization(authorization_dict: dict[str, Any])

Account.sign_message(signable_message: Any)

Account.sign_typed_data(
    domain_data: dict[str, Any] | None = None,
    message_types: dict[str, Any] | None = None,
    message_data: dict[str, Any] | None = None,
    full_message: dict[str, Any] | None = None,
)

All signing methods implement an equivalent API to the same-named functions in the eth-account library.

8. Default keypass and accounts

You can create a "default" keypass by calling create with no arguments:

>>> eth_keypass.create()
Create password for new keypass 'default':
<KeypassDB path=/home/user/.local/share/eth-keypass/default.sqlite3 unlocked>

Every keypass also maintains a default account.

>>> kp.default_account
eth_keypass.errors.NoDefaultAccountError: database has no default account set

>>> kp.create_account(alias="degen", set_as_default=True)
<Account 0xcc27b3Be484E3692737993ca8273349e9483454D signable>

>>> kp.default_account
<Account 0xcc27b3Be484E3692737993ca8273349e9483454D signable>

This makes portable scripts possible. Each user signs using their own default keypass and account.

import eth_keypass

kp = eth_keypass.unlock()

acct = kp.default_account
acct.sign_transaction(...)

Tests

First, install the dev dependencies:

pip install -e ".[dev]"

To run the test suite:

pytest

License

This project is licensed under the MIT license.