Metadata-Version: 2.1
Name: lantern3
Version: 0.1.0
Summary: Light up the Ethereum blockchain
Home-page: https://github.com/taekop/lantern3.py
Author: taekop
Author-email: taekop@naver.com
License: MIT
Keywords: ethereum
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9,<4.0
Description-Content-Type: text/markdown
License-File: LICENSE

# lantern3.py

Light up the Ethereum blockchain with Lantern3, a Python library that provides high-level interfaces for sending bundled transactions to block builders. Lantern3 aims to increase the success rate of transaction inclusion while mitigating issues such as transaction reverts, front-running, back-running, and sandwich attacks.

## Builders

Lantern3 supports multiple block builders that you can use to send your bundled transactions.

| Name          | RPC Endpoint                | Notes                                               |
| ------------- | --------------------------- | --------------------------------------------------- |
| Flashbots     | https://relay.flashbots.net | [`FlashbotsBuilder`](lantern3/builder/flashbots.py) |
| builder0x69   | https://builder0x69.io      |                                                     |
| beaverbuild   | https://rpc.beaverbuild.org |                                                     |
| rsync-builder | https://rsync-builder.xyz   |                                                     |

Please refer to the documentation of each block builder for any specific requirements or considerations when using them.

## Examples

To get started with Lantern3, you can explore the provided examples. The following example demonstrates a simple transfer of Ether:

```shell
$ python3 examples/simple_transfer.py <YOUR_PRIVATE_KEY>
```

Please note that before running the examples, you may need to install the necessary dependencies by following the installation instructions in the project's documentation.

## Contributing

We welcome contributions to Lantern3! If you encounter any issues, have suggestions, or want to contribute improvements or new features, please open an issue or submit a pull request on the GitHub repository.

## License

Lantern3 is licensed under the [MIT License](https://opensource.org/license/mit/). See the [LICENSE](LICENSE) file for more details.
