Metadata-Version: 2.4
Name: signinwithethereum
Version: 5.0.0
Summary: A Python implementation of Sign in with Ethereum (EIP-4361).
Project-URL: Homepage, https://siwe.xyz
Project-URL: Repository, https://github.com/signinwithethereum/siwe-py
Project-URL: EIP, https://github.com/ethereum/EIPs/blob/master/EIPS/eip-4361.md
Author-email: Jalil Wahdatehagh <jalil@ethfollow.xyz>, "Spruce Systems, Inc." <hello@spruceid.com>, Payton Garland <payton.r.g@gmail.com>
License-Expression: MIT OR Apache-2.0
License-File: LICENSE-APACHE
License-File: LICENSE-MIT
Keywords: EIP-4361,SIWE,Sign in with Ethereum
Requires-Python: <4.0,>=3.10
Requires-Dist: abnf<3,>=2.2
Requires-Dist: eth-account<0.14,>=0.13.1
Requires-Dist: eth-utils>=2.2.0
Requires-Dist: pydantic-core<3,>=2
Requires-Dist: pydantic<3,>=2.7
Requires-Dist: typing-extensions<5,>=4
Requires-Dist: web3<8,>=7.3.0
Description-Content-Type: text/markdown

# Sign in with Ethereum

This package provides a Python implementation of EIP-4361: Sign in With Ethereum.

## Installation

SIWE can be easily installed in any Python project with pip:

```bash
pip install signinwithethereum
```

The distribution is published as `signinwithethereum`, but the import name remains `siwe`:

```python
from siwe import SiweMessage
```

## Usage

SIWE provides a `SiweMessage` class which implements EIP-4361.

### Parsing a SIWE Message

Parsing is done by initializing a `SiweMessage` object with an EIP-4361 formatted string:

```python
from siwe import SiweMessage
message = SiweMessage.from_message(message=eip_4361_string)
```

Or to initialize a `SiweMessage` as a `pydantic.BaseModel` right away:

```python
message = SiweMessage(domain="login.xyz", address="0x1234...", ...)
```

### Verifying and Authenticating a SIWE Message

Verification and authentication is performed via EIP-191, using the `address` field of the `SiweMessage` as the expected signer. The validate method checks message structural integrity, signature address validity, and time-based validity attributes.

```python
try:
    message.verify(signature="0x...")
    # You can also specify other checks (e.g. the nonce or domain expected).
except siwe.VerificationError:
    # Invalid
```

### Serialization of a SIWE Message

`SiweMessage` instances can also be serialized as their EIP-4361 string representations via the `prepare_message` method:

```python
print(message.prepare_message())
```

## Example

Parsing and verifying a `SiweMessage` is easy:

```python
try:
    message = SiweMessage.from_message(eip_4361_string)
    message.verify(signature, nonce="abcdef", domain="example.com")
except ValueError:
    # Invalid message format
    print("Authentication attempt rejected.")
except siwe.ExpiredMessage:
    print("Authentication attempt rejected.")
except siwe.DomainMismatch:
    print("Authentication attempt rejected.")
except siwe.NonceMismatch:
    print("Authentication attempt rejected.")
except siwe.InvalidSignature:
    print("Authentication attempt rejected.")

# Message has been verified. Authentication complete. Continue with authorization/other.
```

## Testing

```bash
git submodule update --init
uv sync
uv run pytest
```

## See Also

- [Sign in with Ethereum: TypeScript](https://github.com/signinwithethereum/siwe)
- [SIWE website: siwe.xyz](https://siwe.xyz)
- [EIP-4361 Specification Draft](https://eips.ethereum.org/EIPS/eip-4361)
- [EIP-191 Specification](https://eips.ethereum.org/EIPS/eip-191)

## Disclaimer

Our Python library for Sign in with Ethereum has not yet undergone a formal
security audit. We welcome continued feedback on the usability, architecture,
and security of this implementation.
