eth_account

Account

class eth_account.account.Account

The primary entry point for working with Ethereum private keys.

It does not require a connection to an Ethereum node.

create(extra_entropy: str | bytes | int = '') → LocalAccount

Creates a new private key, and returns it as a LocalAccount.

Parameters:: extra_entropy (str or bytes or int) – Add extra randomness to whatever randomness your OS can provide
Returns:: an object with private key and convenience methods

>>> from eth_account import Account
>>> acct = Account.create('KEYSMASH FJAFJKLDSKF7JKFDJ 1530')
>>> acct.address
'0x5ce9454909639D2D17A3F753ce7d93fa0b9aB12E'
>>> acct.key
HexBytes('0x8676e9a8c86c8921e922e61e0bb6e9e9689aad4c99082620610b00140e5f21b8')

# These methods are also available: sign_message(), sign_transaction(),
# encrypt().
# They correspond to the same-named methods in Account.*
# but without the private key argument

create_with_mnemonic(passphrase: str = '', num_words: int = 12, language: Language | str = Language.ENGLISH, account_path: str = "m/44'/60'/0'/0/0") → Tuple[LocalAccount, str]

Create a new private key and related mnemonic.

Caution

This feature is experimental, unaudited, and likely to change soon

Creates a new private key, and returns it as a LocalAccount, alongside the mnemonic that can used to regenerate it using any BIP39-compatible wallet.

Parameters:

passphrase (str) – Extra passphrase to encrypt the seed phrase
num_words (int) – Number of words to use with seed phrase. Default is 12 words. Must be one of [12, 15, 18, 21, 24].
language ((Language, str)) – Language to use for BIP39 mnemonic seed phrase. The use of a string is deprecated and will be removed in a future version.
account_path (str) – Specify an alternate HD path for deriving the seed using BIP32 HD wallet key derivation.

Returns:

A tuple consisting of an object with private key and convenience methods, and the mnemonic seed phrase that can be used to restore the account.

Return type:

(LocalAccount, str)

>>> from eth_account import Account
>>> Account.enable_unaudited_hdwallet_features()
>>> acct, mnemonic = Account.create_with_mnemonic()
>>> acct.address 
'0x5ce9454909639D2D17A3F753ce7d93fa0b9aB12E'
>>> acct == Account.from_mnemonic(mnemonic)
True

# These methods are also available:
# sign_message(), sign_transaction(), encrypt()
# They correspond to the same-named methods in Account.*
# but without the private key argument

static decrypt(keyfile_json: str | Dict[str, Any], password: str) → HexBytes

Decrypts a private key.

The key may have been encrypted using an Ethereum client or encrypt().

Parameters:

keyfile_json (dict or str) – The encrypted key
password (str) – The password that was used to encrypt the key

Returns:

the raw private key

Return type:

HexBytes

>>> encrypted = {
... 'address': '5ce9454909639D2D17A3F753ce7d93fa0b9aB12E',
... 'crypto': {'cipher': 'aes-128-ctr',
...  'cipherparams': {'iv': '482ef54775b0cc59f25717711286f5c8'},
...  'ciphertext': 'cb636716a9fd46adbb31832d964df2082536edd5399a3393327dc89b0193a2be',
...  'kdf': 'scrypt',
...  'kdfparams': {},
...  'kdfparams': {'dklen': 32,
...                'n': 262144,
...                'p': 8,
...                'r': 1,
...                'salt': 'd3c9a9945000fcb6c9df0f854266d573'},
...  'mac': '4f626ec5e7fea391b2229348a65bfef532c2a4e8372c0a6a814505a350a7689d'},
... 'id': 'b812f3f9-78cc-462a-9e89-74418aa27cb0',
... 'version': 3}
>>> Account.decrypt(encrypted, 'password')
HexBytes('0xb25c7db31feed9122727bf0939dc769a96564b2de4c4726d035b36ecf1e5b364')

classmethod enable_unaudited_hdwallet_features() → None: Use this flag to enable unaudited HD Wallet features.

Creates a dictionary with an encrypted version of your private key. To import this keyfile into Ethereum clients like geth and parity: encode this dictionary with json.dumps() and save it to disk where your client keeps key files.

Parameters:

private_key (hex str, bytes, int or eth_keys.datatypes.PrivateKey) – The raw private key
password (str) – The password which you will need to unlock the account in your client
kdf (str) – The key derivation function to use when encrypting your private key
iterations (int) – The work factor for the key derivation function

Returns:

The data to use in your encrypted file

Return type:

dict

If kdf is not set, the default key derivation function falls back to the environment variable ETH_ACCOUNT_KDF. If that is not set, then ‘scrypt’ will be used as the default.

>>> from pprint import pprint
>>> encrypted = Account.encrypt(
...     0xb25c7db31feed9122727bf0939dc769a96564b2de4c4726d035b36ecf1e5b364,
...     'password'
... )
>>> pprint(encrypted)
{'address': '5ce9454909639D2D17A3F753ce7d93fa0b9aB12E',
 'crypto': {'cipher': 'aes-128-ctr',
            'cipherparams': {'iv': '...'},
            'ciphertext': '...',
            'kdf': 'scrypt',
            'kdfparams': {'dklen': 32,
                          'n': 262144,
                          'p': 1,
                          'r': 8,
                          'salt': '...'},
            'mac': '...'},
 'id': '...',
 'version': 3}

>>> with open('my-keyfile', 'w') as f: 
...    f.write(json.dumps(encrypted))

from_key(private_key: bytes | int | HexStr | PrivateKey) → LocalAccount

Returns a convenient object for working with the given private key.

Parameters:: private_key (hex str, bytes, int or eth_keys.datatypes.PrivateKey) – The raw private key
Returns:: object with methods for signing and encrypting
Return type:: LocalAccount

>>> acct = Account.from_key(
... 0xb25c7db31feed9122727bf0939dc769a96564b2de4c4726d035b36ecf1e5b364)
>>> acct.address
'0x5ce9454909639D2D17A3F753ce7d93fa0b9aB12E'
>>> acct.key
HexBytes('0xb25c7db31feed9122727bf0939dc769a96564b2de4c4726d035b36ecf1e5b364')

# These methods are also available: sign_message(), sign_transaction(),
# encrypt(). They correspond to the same-named methods in Account.*
# but without the private key argument

from_mnemonic(mnemonic: str, passphrase: str = '', account_path: str = "m/44'/60'/0'/0/0") → LocalAccount

Generate an account from a mnemonic.

Caution

This feature is experimental, unaudited, and likely to change soon

Parameters:

mnemonic (str) – space-separated list of BIP39 mnemonic seed words
passphrase (str) – Optional passphrase used to encrypt the mnemonic
account_path (str) – Specify an alternate HD path for deriving the seed using BIP32 HD wallet key derivation.

Returns:

object with methods for signing and encrypting

Return type:

LocalAccount

>>> from eth_account import Account
>>> Account.enable_unaudited_hdwallet_features()
>>> acct = Account.from_mnemonic(
...  "coral allow abandon recipe top tray caught video climb similar "
...  "prepare bracket antenna rubber announce gauge volume "
...  "hub hood burden skill immense add acid")
>>> acct.address
'0x9AdA5dAD14d925f4df1378409731a9B71Bc8569d'

# These methods are also available: sign_message(), sign_transaction(),
#  encrypt(). They correspond to the same-named methods in Account.*
# but without the private key argument

Or, generate multiple accounts from a mnemonic.

>>> from eth_account import Account
>>> Account.enable_unaudited_hdwallet_features()
>>> iterator = 0
>>> for i in range(10):
...     acct = Account.from_mnemonic(
...         "health embark april buyer eternal leopard "
...         "want before nominee head thing tackle",
...         account_path=f"m/44'/60'/0'/0/{iterator}")
...     iterator = iterator + 1
...     acct.address
'0x61Cc15522D06983Ac7aADe23f9d5433d38e78195'
'0x1240460F6E370f28079E5F9B52f9DcB759F051b7'
'0xd30dC9f996539826C646Eb48bb45F6ee1D1474af'
'0x47e64beb58c9A469c5eD086aD231940676b44e7C'
'0x6D39032ffEF9987988a069F52EFe4d95D0770555'
'0x3836A6530D1889853b047799Ecd8827255072e77'
'0xed5490dEfF8d8FfAe45cb4066C3daC7C6BFF6a22'
'0xf04F9Ff322799253bcC6B12762AD127570a092c5'
'0x900F7fa9fbe85BB25b6cdB94Da24D807f7feb213'
'0xa248e118b0D19010387b1B768686cd9B473FA137'

Caution

For the love of Bob please do not use this mnemonic, it is for testing purposes only.

recover_message(signable_message: SignableMessage, vrs: Tuple[VRS, VRS, VRS] | None = None, signature: bytes | None = None) → ChecksumAddress

Get the address of the account that signed the given message. You must specify exactly one of: vrs or signature

Parameters:

signable_message – the message that was signed
vrs (tuple(v, r, s), each element is hex str, bytes or int) – the three pieces generated by an elliptic curve signature
signature (hex str or bytes or int) – signature bytes concatenated as r+s+v

Returns:

address of signer, hex-encoded & checksummed

Return type:

str

>>> from eth_account.messages import encode_defunct
>>> from eth_account import Account
>>> message = encode_defunct(text="I♥SF")
>>> vrs = (
...   28,
...   '0xe6ca9bba58c88611fad66a6ce8f996908195593807c4b38bd528d2cff09d4eb3',
...   '0x3e5bfbbf4d3e39b1a2fd816a7680c19ebebaf3a141b239934ad43cb33fcec8ce')
>>> Account.recover_message(message, vrs=vrs)
'0x5ce9454909639D2D17A3F753ce7d93fa0b9aB12E'


# All of these recover calls are equivalent:

# variations on vrs
>>> vrs = (
...   '0x1c',
...   '0xe6ca9bba58c88611fad66a6ce8f996908195593807c4b38bd528d2cff09d4eb3',
...   '0x3e5bfbbf4d3e39b1a2fd816a7680c19ebebaf3a141b239934ad43cb33fcec8ce')
>>> Account.recover_message(message, vrs=vrs)
'0x5ce9454909639D2D17A3F753ce7d93fa0b9aB12E'

>>> # Caution about this approach: likely problems if there are leading 0s
>>> vrs = (
...   0x1c,
...   0xe6ca9bba58c88611fad66a6ce8f996908195593807c4b38bd528d2cff09d4eb3,
...   0x3e5bfbbf4d3e39b1a2fd816a7680c19ebebaf3a141b239934ad43cb33fcec8ce)
>>> Account.recover_message(message, vrs=vrs)
'0x5ce9454909639D2D17A3F753ce7d93fa0b9aB12E'

>>> vrs = (
...   b'\x1c',
...   b'\xe6\xca\x9b\xbaX\xc8\x86\x11\xfa\xd6jl\xe8\xf9\x96\x90\x81\x95Y8\x07\xc4\xb3\x8b\xd5(\xd2\xcf\xf0\x9dN\xb3',
...   b'>[\xfb\xbfM>9\xb1\xa2\xfd\x81jv\x80\xc1\x9e\xbe\xba\xf3\xa1A\xb29\x93J\xd4<\xb3?\xce\xc8\xce')
>>> Account.recover_message(message, vrs=vrs)
'0x5ce9454909639D2D17A3F753ce7d93fa0b9aB12E'

# variations on signature
>>> signature = '0xe6ca9bba58c88611fad66a6ce8f996908195593807c4b38bd528d2cff09d4eb33e5bfbbf4d3e39b1a2fd816a7680c19ebebaf3a141b239934ad43cb33fcec8ce1c'
>>> Account.recover_message(message, signature=signature)
'0x5ce9454909639D2D17A3F753ce7d93fa0b9aB12E'
>>> signature = b'\xe6\xca\x9b\xbaX\xc8\x86\x11\xfa\xd6jl\xe8\xf9\x96\x90\x81\x95Y8\x07\xc4\xb3\x8b\xd5(\xd2\xcf\xf0\x9dN\xb3>[\xfb\xbfM>9\xb1\xa2\xfd\x81jv\x80\xc1\x9e\xbe\xba\xf3\xa1A\xb29\x93J\xd4<\xb3?\xce\xc8\xce\x1c'
>>> Account.recover_message(message, signature=signature)
'0x5ce9454909639D2D17A3F753ce7d93fa0b9aB12E'
>>> # Caution about this approach: likely problems if there are leading 0s
>>> signature = 0xe6ca9bba58c88611fad66a6ce8f996908195593807c4b38bd528d2cff09d4eb33e5bfbbf4d3e39b1a2fd816a7680c19ebebaf3a141b239934ad43cb33fcec8ce1c
>>> Account.recover_message(message, signature=signature)
'0x5ce9454909639D2D17A3F753ce7d93fa0b9aB12E'

recover_transaction(serialized_transaction: HexStr | bytes | int) → ChecksumAddress

Get the address of the account that signed this transaction.

Parameters:: serialized_transaction (hex str, bytes or int) – the complete signed transaction
Returns:: address of signer, hex-encoded & checksummed
Return type:: ChecksumAddress

>>> raw_transaction = '0xf86a8086d55698372431831e848094f0109fc8df283027b6285cc889f5aa624eac1f55843b9aca008025a009ebb6ca057a0535d6186462bc0b465b561c94a295bdb0621fc19208ab149a9ca0440ffd775ce91a833ab410777204d5341a6f9fa91216a6f3ee2c051fea6a0428'
>>> Account.recover_transaction(raw_transaction)
'0x2c7536E3605D9C16a7a3D7b1898e529396a65c23'

set_key_backend(backend: CoinCurveECCBackend | NativeECCBackend) → None

Change the backend used by the underlying eth-keys library.

(The default is fine for most users)

Parameters:: backend – any backend that works in eth_keys.KeyApi(backend)

sign_authorization(authorization_dict: AuthorizationDict, private_key: bytes | int | HexStr | PrivateKey) → SignedSetCodeAuthorization

Sign an authorization using a local private key to be included in a EIP-7702 transaction.

Parameters:

authorization_dict (dict) – the required keys are: chainId, address, and nonce
private_key (hex str, bytes, int or eth_keys.datatypes.PrivateKey) – the private key to sign the data with

Returns:

the dictionary with the signature fields added, suitable for inclusion in a EIP-7702 transaction

Return type:

dict

Note

You need to sign one or more authorizations from an EOA willing to have a smart contract code associated with the EOA for the life of the transaction. The variable auth in the code below is the authorization dictionary containing the following keys:

chainId is the chain id for the chain where the EOA is located. If 0 is specified, authorization is signed for all chains
address is the address of the smart contract code to be associated with the EOA, as bytes
nonce is the nonce of the EOA, used to prevent replay attacks

To create a transaction that associates the code with the EOA, you need to create a transaction with an authorizationList, representing a list of signed authorizations for the transaction.

>>> from eth_account import Account

>>> key = "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
>>> auth = {
...     "chainId": 1337,
...     "address": "0x5ce9454909639d2d17a3f753ce7d93fa0b9ab12e",
...     # If the tx sender is the same as the authority, the nonce needs to be 1 higher than the current (transaction) nonce.
...     # This is because the nonce is increased before tx execution and again when processing the authorization.
...     "nonce": 1,
... }

>>> signed_auth = Account.sign_authorization(auth, key)
>>> signed_auth
SignedSetCodeAuthorization(chain_id=1337,
 address=b'\\\xe9EI\tc\x9d-\x17\xa3\xf7S\xce}\x93\xfa\x0b\x9a\xb1.',
 nonce=1,
 y_parity=0,
 r=52163433520757118830640642673035732532535423029712132518776649895118143897479,
 s=57576671166887700066365341925867052133948674355067837907255957076179513983345,
 signature='0x735375048fc96b87390b5a11c411fc57245d8e55038bf49e659d048a0d1a3f877f4b3db448845cb217812f23c6b345e99f2d21c44ec10e93a8f039814167417100',
 authorization_hash=HexBytes('0x9026f77ed6740d6d08f0cdc0591a86b2232700020a816718fbf760785e9ca2f2'))

>>> tx = {
...     "gas": 100000,
...     "maxFeePerGas": 2000000000,
...     "maxPriorityFeePerGas": 2000000000,
...     "data": "0x252dba42",  # replace with calldata for the contract at the auth ``address``
...     "nonce": 0,
...     "to": "0x09616C3d61b3331fc4109a9E41a8BDB7d9776609",
...     "value": 0,
...     "accessList": (),
...     "authorizationList": [signed_auth],
...     "chainId": 1337,
... }
>>> signed = Account.sign_transaction(tx, key)
>>> w3.eth.send_raw_transaction(signed.raw_transaction)  

sign_message(signable_message: SignableMessage, private_key: bytes | int | HexStr | PrivateKey) → SignedMessage

Sign the provided message.

This API supports any messaging format that will encode to EIP-191 messages.

If you would like historical compatibility with w3.eth.sign() you can use encode_defunct().

Other options are the “validator”, or “structured data” standards. You can import all supported message encoders in eth_account.messages.

Parameters:

signable_message – the encoded message for signing
private_key (hex str, bytes, int or eth_keys.datatypes.PrivateKey) – the key to sign the message with

Returns:

Various details about the signature - most importantly the fields: v, r, and s

Return type:

SignedMessage

>>> msg = "I♥SF"
>>> from eth_account.messages import encode_defunct
>>> msghash = encode_defunct(text=msg)
>>> msghash
SignableMessage(version=b'E',
 header=b'thereum Signed Message:\n6',
 body=b'I\xe2\x99\xa5SF')
>>> # If you're curious about the internal fields of SignableMessage, take a look at EIP-191, linked above
>>> key = "0xb25c7db31feed9122727bf0939dc769a96564b2de4c4726d035b36ecf1e5b364"
>>> Account.sign_message(msghash, key)
SignedMessage(message_hash=HexBytes('0x1476abb745d423bf09273f1afd887d951181d25adc66c4834a70491911b7f750'),
 r=104389933075820307925104709181714897380569894203213074526835978196648170704563,
 s=28205917190874851400050446352651915501321657673772411533993420917949420456142,
 v=28,
 signature=HexBytes('0xe6ca9bba58c88611fad66a6ce8f996908195593807c4b38bd528d2cff09d4eb33e5bfbbf4d3e39b1a2fd816a7680c19ebebaf3a141b239934ad43cb33fcec8ce1c'))

Sign a transaction using a local private key.

It produces signature details and the hex-encoded transaction suitable for broadcast using w3.eth.send_raw_transaction().

To create the transaction dict that calls a contract, use my_contract.functions.myFunction().build_transaction().

Note: For non-legacy (typed) transactions, if the transaction type is not explicitly provided, it may be determined from the transaction parameters of a well-formed transaction. See below for examples on how to sign with different transaction types.

Parameters:

transaction_dict (dict) – the transaction with available keys, depending on the type of transaction: nonce, chainId, to, data, value, gas, gasPrice, type, accessList, maxFeePerGas, and maxPriorityFeePerGas
private_key (hex str, bytes, int or eth_keys.datatypes.PrivateKey) – the private key to sign the data with
blobs (list of bytes or HexBytes) – optional list of blobs to sign in addition to the transaction

Returns:

Various details about the signature - most importantly the fields: v, r, and s

Return type:

SignedTransaction

>>> # EIP-1559 dynamic fee transaction (more efficient and preferred over legacy txn)
>>> from eth_account import Account
>>> dynamic_fee_transaction = {
...     "type": 2,  # optional - can be implicitly determined based on max fee params
...     "gas": 100000,
...     "maxFeePerGas": 2000000000,
...     "maxPriorityFeePerGas": 2000000000,
...     "data": "0x616263646566",
...     "nonce": 34,
...     "to": "0x09616C3d61b3331fc4109a9E41a8BDB7d9776609",
...     "value": "0x5af3107a4000",
...     "accessList": (  # optional
...         {
...             "address": "0x0000000000000000000000000000000000000001",
...             "storageKeys": (
...                 "0x0100000000000000000000000000000000000000000000000000000000000000",
...             )
...         },
...     ),
...     "chainId": 1337,
... }
>>> key = '0x4c0883a69102937d6231471b5dbb6204fe5129617082792ae468d01a3f362318'
>>> signed_df_tx = Account.sign_transaction(dynamic_fee_transaction, key)
>>> signed_df_tx
SignedTransaction(raw_transaction=HexBytes('0x02f8b28205392284773594008477359400830186a09409616c3d61b3331fc4109a9e41a8bdb7d9776609865af3107...d58b85d5'),
 hash=HexBytes('0x2721b2ac99d878695e410af9e8968859b6f6e94f544840be0eb2935bead7deba'),
 r=48949965662841329840326477994465373664672499148507933176648302825256944281697,
 s=1123041608316060268133200864147951676126406077675157976022772782796802590165,
 v=1)
>>> w3.eth.send_raw_transaction(signed_df_tx.raw_transaction)  

>>> # legacy transaction (less efficient than EIP-1559 dynamic fee txn)
>>> from eth_account import Account
>>> legacy_transaction = {
...     # Note that the address must be in checksum format or native bytes:
...     'to': '0xF0109fC8DF283027b6285cc889F5aA624EaC1F55',
...     'value': 1000000000,
...     'gas': 2000000,
...     'gasPrice': 234567897654321,
...     'nonce': 0,
...     'chainId': 1337
... }
>>> key = '0x4c0883a69102937d6231471b5dbb6204fe5129617082792ae468d01a3f362318'
>>> signed_legacy_tx = Account.sign_transaction(legacy_transaction, key)
>>> signed_legacy_tx
SignedTransaction(raw_transaction=HexBytes('0xf86c8086d55698372431831e848094f0109fc8df283027b6285cc889f5aa624eac1f55843b9aca0080820a95a01a7...c0bfdb52'),
 hash=HexBytes('0xd0a3e5dc7439f260c64cb0220139ec5dc7e016f82ce272a25a0f0b38fe751673'),
 r=11971260903864915610009019893820767192081275151191539081612245320300335068143,
 s=35365272040292958794699923036506252105590820339897221552886630515981233937234,
 v=2709)
>>> w3.eth.send_raw_transaction(signed_legacy_tx.raw_transaction)  

>>> from eth_account import Account
>>> access_list_transaction = {
...     "type": 1,  # optional - can be implicitly determined based on 'accessList' and 'gasPrice' params
...     "gas": 100000,
...     "gasPrice": 1000000000,
...     "data": "0x616263646566",
...     "nonce": 34,
...     "to": "0x09616C3d61b3331fc4109a9E41a8BDB7d9776609",
...     "value": "0x5af3107a4000",
...     "accessList": (
...         {
...             "address": "0x0000000000000000000000000000000000000001",
...             "storageKeys": (
...                 "0x0100000000000000000000000000000000000000000000000000000000000000",
...             )
...         },
...     ),
...     "chainId": 1337,
... }
>>> key = '0x4c0883a69102937d6231471b5dbb6204fe5129617082792ae468d01a3f362318'
>>> signed_al_tx = Account.sign_transaction(access_list_transaction, key)
>>> signed_al_tx
SignedTransaction(raw_transaction=HexBytes('0x01f8ad82053922843b9aca00830186a09409616c3d61b3331fc4109a9e41a8bdb7d9776609865af3107a400086616...2b5043ea'),
 hash=HexBytes('0xca9af2ef41691e06eb07e02125938fd9bb5a311e8daf330b264e77d6cdf3d17e'),
 r=107355854401379915513092408112372039746594668141865279802319959599514133709188,
 s=6729502936685237038651223791038758905953302464070244934323623239104475448298,
 v=1)
>>> w3.eth.send_raw_transaction(signed_al_tx.raw_transaction)  

>>> from eth_account import Account
>>> blob_transaction = {
...    "type": 3,  # optional - can be implicitly determined based on `maxFeePerBlobGas` param
...    "gas": 100000,
...    "maxFeePerGas": 2000000000,
...    "maxPriorityFeePerGas": 2000000000,
...    "maxFeePerBlobGas": 2000000000,
...    "data": "0x616263646566",
...    "nonce": 34,
...    "to": "0x09616C3d61b3331fc4109a9E41a8BDB7d9776609",
...    "value": "0x5af3107a4000",
...    "accessList": (  # optional
...        {
...            "address": "0x0000000000000000000000000000000000000001",
...            "storageKeys": (
...                "0x0100000000000000000000000000000000000000000000000000000000000000",
...            )
...        },
...    ),
...    "chainId": 1337,
... }
>>> empty_blob = b"\x00" * 32 * 4096  # 4096 empty 32-byte field elements
>>> key = '0x4c0883a69102937d6231471b5dbb6204fe5129617082792ae468d01a3f362318'

>>> # The `blobVersionedHashes` transaction field is calculated from the `blobs` kwarg
>>> signed_blob_tx = Account.sign_transaction(blob_transaction, key, blobs=[empty_blob])
>>> signed_blob_tx
SignedTransaction(raw_transaction=HexBytes('0x03fa020147f8d98205392284773594008477359400830186a09409616c3d61b3331fc4109a9e41a8bdb7d97766098...00000000'),
 hash=HexBytes('0xf9dc8867c4324fd7f4506622aa700989562770f01d7d681cef74a1a1deb9fea9'),
 r=14319949980593194209648175507603206696573324965145502821772573913457715875718,
 s=9129184742597516615341309773045281461399831333162885393648678700392065987233,
 v=1)
>>> w3.eth.send_raw_transaction(signed_blob_tx.raw_transaction)  

Sign the provided EIP-712 message with the provided key.

Parameters:

private_key (hex str, bytes, int or eth_keys.datatypes.PrivateKey) – the key to sign the message with
domain_data (dict) – EIP712 domain data
message_types (dict) – custom types used by the value data
message_data (dict) – data to be signed
full_message (dict) – a dict containing all data and types

Returns:

Various details about the signature - most importantly the fields: v, r, and s

Return type:

SignedMessage

You may supply the information to be encoded in one of two ways:

As exactly three arguments:

domain_data, a dict of the EIP-712 domain data

message_types, a dict of custom types (do not include a EIP712Domain key)

message_data, a dict of the data to be signed

Or as a single argument:

full_message, a dict containing the following keys:

types, a dict of custom types (may include a EIP712Domain key)

primaryType, (optional) a string of the primary type of the message

domain, a dict of the EIP-712 domain data

message, a dict of the data to be signed

Warning

Note that this code has not gone through an external audit, and the test cases are incomplete.

See documentation for encode_typed_data() for usage details

See the EIP-712 spec for more information.

>>> # examples of basic usage
>>> from eth_account import Account
>>> # 3-argument usage

>>> # all domain properties are optional
>>> domain_data = {
...     "name": "Ether Mail",
...     "version": "1",
...     "chainId": 1,
...     "verifyingContract": "0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC",
...     "salt": b"decafbeef",
... }
>>> # custom types
>>> message_types = {
...     "Person": [
...         {"name": "name", "type": "string"},
...         {"name": "wallet", "type": "address"},
...     ],
...     "Mail": [
...         {"name": "from", "type": "Person"},
...         {"name": "to", "type": "Person"},
...         {"name": "contents", "type": "string"},
...     ],
... }
>>> # the data to be signed
>>> message_data = {
...     "from": {
...         "name": "Cow",
...         "wallet": "0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826",
...     },
...     "to": {
...         "name": "Bob",
...         "wallet": "0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB",
...     },
...     "contents": "Hello, Bob!",
... }
>>> key = "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
>>> signed_message = Account.sign_typed_data(key, domain_data, message_types, message_data)
>>> signed_message.message_hash
HexBytes('0xc5bb16ccc59ae9a3ad1cb8343d4e3351f057c994a97656e1aff8c134e56f7530')

>>> # 1-argument usage

>>> # all domain properties are optional
>>> full_message = {
...     "types": {
...         "EIP712Domain": [
...             {"name": "name", "type": "string"},
...             {"name": "version", "type": "string"},
...             {"name": "chainId", "type": "uint256"},
...             {"name": "verifyingContract", "type": "address"},
...             {"name": "salt", "type": "bytes32"},
...         ],
...         "Person": [
...             {"name": "name", "type": "string"},
...             {"name": "wallet", "type": "address"},
...         ],
...         "Mail": [
...             {"name": "from", "type": "Person"},
...             {"name": "to", "type": "Person"},
...             {"name": "contents", "type": "string"},
...         ],
...     },
...     "primaryType": "Mail",
...     "domain": {
...         "name": "Ether Mail",
...         "version": "1",
...         "chainId": 1,
...         "verifyingContract": "0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC",
...         "salt": b"decafbeef"
...     },
...     "message": {
...         "from": {
...             "name": "Cow",
...             "wallet": "0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826"
...         },
...         "to": {
...             "name": "Bob",
...             "wallet": "0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB"
...         },
...         "contents": "Hello, Bob!",
...     },
... }
>>> signed_message_2 = Account.sign_typed_data(key, full_message=full_message)
>>> signed_message_2.message_hash
HexBytes('0xc5bb16ccc59ae9a3ad1cb8343d4e3351f057c994a97656e1aff8c134e56f7530')
>>> signed_message_2 == signed_message
True

Sign the provided hash.

Warning

Never sign a hash that you didn’t generate, it can be an arbitrary transaction. For example, it might send all of your account’s ether to an attacker. Instead, prefer sign_message(), which cannot accidentally sign a transaction.

Parameters:

message_hash (hex str, bytes or int) – the 32-byte message hash to be signed
private_key (hex str, bytes, int or eth_keys.datatypes.PrivateKey) – the key to sign the message with

Returns:

Various details about the signature - most importantly the fields: v, r, and s

Return type:

SignedMessage

See Signers for alternative signers.

SignedTransaction & SignedMessage

class eth_account.datastructures.CustomPydanticModel

Bases: BaseModel

A base class for eth-account pydantic models that provides custom JSON-RPC serialization configuration. JSON-RPC serialization is configured to use camelCase keys and to exclude fields that are marked as exclude=True. To serialize a model to the expected JSON-RPC format, use model_dump(by_alias=True).

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'arbitrary_types_allowed': True, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_json_schema(by_alias: bool = True, ref_template: str = '#/$defs/{model}', schema_generator: ~typing.Type[~pydantic.json_schema.GenerateJsonSchema] = <class 'eth_account.datastructures.OmitJsonSchema'>, mode: ~typing.Literal['validation', 'serialization'] = 'validation') → Dict[str, Any]: Omits excluded fields from the JSON schema, preventing errors that would otherwise be raised by the default schema generator.

recursive_model_dump() → Any

class eth_account.datastructures.OmitJsonSchema(by_alias: bool = True, ref_template: str = '#/$defs/{model}')

Bases: GenerateJsonSchema

handle_invalid_for_json_schema(schema: InvalidSchema | AnySchema | NoneSchema | BoolSchema | IntSchema | FloatSchema | DecimalSchema | StringSchema | BytesSchema | DateSchema | TimeSchema | DatetimeSchema | TimedeltaSchema | LiteralSchema | EnumSchema | IsInstanceSchema | IsSubclassSchema | CallableSchema | ListSchema | TupleSchema | SetSchema | FrozenSetSchema | GeneratorSchema | DictSchema | AfterValidatorFunctionSchema | BeforeValidatorFunctionSchema | WrapValidatorFunctionSchema | PlainValidatorFunctionSchema | WithDefaultSchema | NullableSchema | UnionSchema | TaggedUnionSchema | ChainSchema | LaxOrStrictSchema | JsonOrPythonSchema | TypedDictSchema | ModelFieldsSchema | ModelSchema | DataclassArgsSchema | DataclassSchema | ArgumentsSchema | ArgumentsV3Schema | CallSchema | CustomErrorSchema | JsonSchema | UrlSchema | MultiHostUrlSchema | DefinitionsSchema | DefinitionReferenceSchema | UuidSchema | ComplexSchema, error_info: str) → dict[str, Any]

class eth_account.datastructures.SignedMessage(message_hash: HexBytes, r: int, s: int, v: int, signature: HexBytes): Bases: SignedMessage

class eth_account.datastructures.SignedSetCodeAuthorization(*, chainId: int, address: bytes, nonce: int, yParity: int, r: int, s: int, signature: Signature, authorizationHash: HexBytes)

Bases: CustomPydanticModel

address: bytes

property authority: bytes

Return the address of the authority that signed the authorization.

In order to prevent any potential confusion or mal-intent, the authority is always derived from the signature and the authorization hash, rather than statically assigned. This value should be verified against the expected authority for a signed authorization.

authorization_hash: HexBytes

chain_id: int

model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'arbitrary_types_allowed': True, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nonce: int

r: int

s: int

classmethod serialize_address(value: bytes) → ChecksumAddress

signature: Signature

y_parity: int

class eth_account.datastructures.SignedTransaction(raw_transaction: HexBytes, hash: HexBytes, r: int, s: int, v: int): Bases: SignedTransaction

Messages

class eth_account.messages.SignableMessage(version: bytes, header: bytes, body: bytes)

Bases: NamedTuple

A message compatible with EIP-191 that is ready to be signed.

The properties are components of an EIP-191 signable message. Other message formats can be encoded into this format for easy signing. This data structure doesn’t need to know about the original message format. For example, you can think of EIP-712 as compiling down to an EIP-191 message.

In typical usage, you should never need to create these by hand. Instead, use one of the available encode_* methods in this module, like:

encode_intended_validator()

encode_defunct()

encode_typed_data()

body: bytes: Alias for field number 2

header: bytes: Alias for field number 1

version: bytes: Alias for field number 0

eth_account.messages.defunct_hash_message(primitive: bytes | None = None, *, hexstr: str | None = None, text: str | None = None) → HexBytes

Convert the provided message into a message hash, to be signed.

Caution

Intended for use with eth_account.account.Account.unsafe_sign_hash(). This is for backwards compatibility only. All new implementations should use encode_defunct() instead.

Parameters:

primitive (bytes or int) – the binary message to be signed
hexstr (str) – the message encoded as hex
text (str) – the message as a series of unicode characters (a normal Py3 str)

Returns:

The hash of the message, after adding the prefix

eth_account.messages.encode_defunct(primitive: bytes | None = None, *, hexstr: str | None = None, text: str | None = None) → SignableMessage

Encode a message for signing, using an old, unrecommended approach.

Only use this method if you must have compatibility with w3.eth.sign().

EIP-191 defines this as “version E”.

Supply exactly one of the three arguments: bytes, a hex string, or a unicode string.

Parameters:

primitive (bytes or int) – the binary message to be signed
hexstr (str) – the message encoded as hex
text (str) – the message as a series of unicode characters (a normal Py3 str)

Returns:

The EIP-191 encoded message, ready for signing

>>> from eth_account.messages import encode_defunct
>>> from eth_utils.curried import to_hex, to_bytes

>>> message_text = "I♥SF"
>>> encode_defunct(text=message_text)
SignableMessage(version=b'E',
                header=b'thereum Signed Message:\n6',
                body=b'I\xe2\x99\xa5SF')

These four also produce the same hash:
>>> encode_defunct(to_bytes(text=message_text))
SignableMessage(version=b'E',
                header=b'thereum Signed Message:\n6',
                body=b'I\xe2\x99\xa5SF')

>>> encode_defunct(bytes(message_text, encoding='utf-8'))
SignableMessage(version=b'E',
                header=b'thereum Signed Message:\n6',
                body=b'I\xe2\x99\xa5SF')

>>> to_hex(text=message_text)
'0x49e299a55346'
>>> encode_defunct(hexstr='0x49e299a55346')
SignableMessage(version=b'E',
                header=b'thereum Signed Message:\n6',
                body=b'I\xe2\x99\xa5SF')

>>> encode_defunct(0x49e299a55346)
SignableMessage(version=b'E',
                header=b'thereum Signed Message:\n6',
                body=b'I\xe2\x99\xa5SF')

eth_account.messages.encode_intended_validator(validator_address: Address | str, primitive: bytes | None = None, *, hexstr: str | None = None, text: str | None = None) → SignableMessage

Encode a message using the “intended validator” approach (ie~ version 0) defined in EIP-191.

Supply the message as exactly one of these three arguments: bytes as a primitive, a hex string, or a unicode string.

Warning

Note that this code has not gone through an external audit.

Parameters:

validator_address – which on-chain contract is capable of validating this message, provided as a checksummed address or in native bytes.
primitive (bytes or int) – the binary message to be signed
hexstr (str) – the message encoded as hex
text (str) – the message as a series of unicode characters (a normal Py3 str)

Returns:

The EIP-191 encoded message, ready for signing

eth_account.messages.encode_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) → SignableMessage

Encode an EIP-712 message in a manner compatible with other implementations in use, such as the Metamask and Ethers signTypedData functions.

See the EIP-712 spec for more information.

You may supply the information to be encoded in one of two ways:

As exactly three arguments:

domain_data, a dict of the EIP-712 domain data

message_types, a dict of custom types (do not include a EIP712Domain key)

message_data, a dict of the data to be signed

Or as a single argument:

full_message, a dict containing the following keys:

types, a dict of custom types (may include a EIP712Domain key)

primaryType, (optional) a string of the primary type of the message

domain, a dict of the EIP-712 domain data

message, a dict of the data to be signed

Warning

Note that this code has not gone through an external audit, and the test cases are incomplete.

Type Coercion:

For fixed-size bytes types, smaller values will be padded to fit in larger types, but values larger than the type will raise ValueOutOfBounds. e.g., an 8-byte value will be padded to fit a bytes16 type, but 16-byte value provided for a bytes8 type will raise an error.
Fixed-size and dynamic bytes types will accept int``s. Any negative values will be converted to ``0 before being converted to bytes
int and uint types will also accept strings. If prefixed with "0x" , the string will be interpreted as hex. Otherwise, it will be interpreted as decimal.
Any value for a bool type that Python considers “falsy” will be interpreted as False. The strings "False", "false", and "0" will be also interpreted as False. All other values will be interpreted as True.

Noteable differences from signTypedData:

Custom types that are not alphanumeric will encode differently.
Custom types that are used but not defined in types will not encode.

Parameters:

domain_data – EIP712 domain data
message_types – custom types used by the value data
message_data – data to be signed
full_message – a dict containing all data and types

Returns:

a SignableMessage, an encoded message ready to be signed

>>> # examples of basic usage
>>> from eth_account import Account
>>> from eth_account.messages import encode_typed_data
>>> # 3-argument usage

>>> # all domain properties are optional
>>> domain_data = {
...     "name": "Ether Mail",
...     "version": "1",
...     "chainId": 1,
...     "verifyingContract": "0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC",
...     "salt": b"decafbeef",
... }
>>> # custom types
>>> message_types = {
...     "Person": [
...         {"name": "name", "type": "string"},
...         {"name": "wallet", "type": "address"},
...     ],
...     "Mail": [
...         {"name": "from", "type": "Person"},
...         {"name": "to", "type": "Person"},
...         {"name": "contents", "type": "string"},
...     ],
... }
>>> # the data to be signed
>>> message_data = {
...     "from": {
...         "name": "Cow",
...         "wallet": "0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826",
...     },
...     "to": {
...         "name": "Bob",
...         "wallet": "0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB",
...     },
...     "contents": "Hello, Bob!",
... }
>>> key = "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
>>> signable_message = encode_typed_data(domain_data, message_types, message_data)
>>> signed_message = Account.sign_message(signable_message, key)
>>> signed_message.message_hash
HexBytes('0xc5bb16ccc59ae9a3ad1cb8343d4e3351f057c994a97656e1aff8c134e56f7530')
>>> # the message can be signed in one step using Account.sign_typed_data
>>> signed_typed_data = Account.sign_typed_data(key, domain_data, message_types, message_data)
>>> signed_typed_data == signed_message
True

>>> # 1-argument usage

>>> # all domain properties are optional
>>> full_message = {
...     "types": {
...         "EIP712Domain": [
...             {"name": "name", "type": "string"},
...             {"name": "version", "type": "string"},
...             {"name": "chainId", "type": "uint256"},
...             {"name": "verifyingContract", "type": "address"},
...             {"name": "salt", "type": "bytes32"},
...         ],
...         "Person": [
...             {"name": "name", "type": "string"},
...             {"name": "wallet", "type": "address"},
...         ],
...         "Mail": [
...             {"name": "from", "type": "Person"},
...             {"name": "to", "type": "Person"},
...             {"name": "contents", "type": "string"},
...         ],
...     },
...     "primaryType": "Mail",
...     "domain": {
...         "name": "Ether Mail",
...         "version": "1",
...         "chainId": 1,
...         "verifyingContract": "0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC",
...         "salt": b"decafbeef"
...     },
...     "message": {
...         "from": {
...             "name": "Cow",
...             "wallet": "0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826"
...         },
...         "to": {
...             "name": "Bob",
...             "wallet": "0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB"
...         },
...         "contents": "Hello, Bob!",
...     },
... }
>>> signable_message_2 = encode_typed_data(full_message=full_message)
>>> signed_message_2 = Account.sign_message(signable_message_2, key)
>>> signed_message_2.message_hash
HexBytes('0xc5bb16ccc59ae9a3ad1cb8343d4e3351f057c994a97656e1aff8c134e56f7530')
>>> signed_message_2 == signed_message
True
>>> # the full_message can be signed in one step using Account.sign_typed_data
>>> signed_typed_data_2 = Account.sign_typed_data(key, domain_data, message_types, message_data)
>>> signed_typed_data_2 == signed_message_2
True