<div align="center">
<h1 align="center">Voltaire</h1>
</div>
<!-- PROJECT LOGO -->
<div align="center">
<img src="https://github.com/candidelabs/voltaire/assets/7014833/603d130d-62ce-458e-b2f6-31597b5279ab">
<p>
<b>
Modular and lighting-fast Python Bundler for Ethereum EIP-4337 Account Abstraction
</b>
</p>
</div>
# Using an instance
For a quick bundler instance, use one of our [public hosted endpoints](https://docs.candide.dev/wallet/bundler/rpc-endpoints/) for your developement.
# Deployment
Deploy Voltaire using the latest docker image
```
docker run --net=host --rm -ti ghcr.io/candidelabs/voltaire/voltaire-bundler:latest --bundler_secret $BUNDLER_SECRET --rpc_url $RPC_URL --rpc_port $PORT --ethereum_node_url $ETHEREUM_NODE_URL --chain_id $CHAIN_ID --verbose --unsafe --disable_p2p
```
# Development
## Ubuntu: Get started testing the bundler in 5 minutes
### Install Poetry
```
curl -sSL https://install.python-poetry.org | python3 -
```
### Install dependencies
```
poetry install
```
### Make sure you are using the right python version
```
poetry env use python3.11
```
### Install Docker
Follow the installation guide to install [docker on ubunutu](https://docs.docker.com/engine/install/ubuntu/)
### Post docker installation
Follow the instruction for docker's [post linux instalation](https://docs.docker.com/engine/install/linux-postinstall/)
### Start geth
```
docker run --rm -ti --name geth -p 8545:8545 ethereum/client-go:v1.10.26 \
--miner.gaslimit 12000000 \
--http --http.api personal,eth,net,web3,debug \
--http.vhosts '*,localhost,host.docker.internal' --http.addr "0.0.0.0" \
--ignore-legacy-receipts --allow-insecure-unlock --rpc.allow-unprotected-txs \
--dev \
--verbosity 4 \
--nodiscover --maxpeers 0 --mine --miner.threads 1 \
--networkid 1337
```
### Deploy the EntryPoint and fund the signer (in another terminal)
```
geth --exec 'loadScript("scripts/deploy.js")' attach http://0.0.0.0:8545
```
### Set env values
```
source scripts/init-params
```
### Run the bundler
```
poetry run python3 -m voltaire_bundler --entrypoint $ENTRYPOINT --bundler_secret $BUNDLER_SECRET --chain_id 1337 --verbose
```
### Test the bundler by cloning `eth-infinitism/bundler-spec-tests`
Follow the instruction in <a href='https://github.com/eth-infinitism/bundler-spec-tests'>eth-infinitism/bundler-spec-tests</a> to install dependencies and run the test
## P2P rust section development
### Install Rust
```
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
### Install build dependencies
```
sudo apt install musl-tools
rustup target add x86_64-unknown-linux-musl
```
### Build the rust section using poetry script
```
poetry run build_p2p
```
## Contributions
Thank you for considering contributing to open-source code! We welcome contributions and are grateful for even the smallest of fixes.
If you want to contribute today or follow along with the contributor discussion, you can use our main discord to chat with us about the development of Voltaire.
<!-- LICENSE -->
## License
LGPL
<!-- ACKNOWLEDGMENTS -->
## Acknowledgments
None of this would have been possible without the following teams and organizations below:
* <a href='https://eips.ethereum.org/EIPS/eip-4337'>EIP-4337: Account Abstraction via Entry Point Contract specification </a>
* <a href='https://github.com/eth-infinitism/bundler'>eth-infinitism/bundler</a>
* Voltaire is funded exclusively by [The Ethereum Foundation](https://ethereum.foundation/)
* <a href='https://github.com/sigp/lighthouse'>Lighthouse: Ethereum consensus client</a>
Raw data
{
"_id": null,
"home_page": "https://github.com/candidelabs/voltaire",
"name": "voltaire_bundler",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "4337,account_abstraction,ethereum,bundler",
"author": "Candide Wallet Team",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/f0/3d/c5cf6f347dfa82ef4779ba35f1a22715b54532fa580453ce24a3bafb0ffc/voltaire_bundler-0.1.0a24.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <h1 align=\"center\">Voltaire</h1>\n</div>\n\n<!-- PROJECT LOGO -->\n\n<div align=\"center\">\n <img src=\"https://github.com/candidelabs/voltaire/assets/7014833/603d130d-62ce-458e-b2f6-31597b5279ab\">\n <p>\n <b>\n Modular and lighting-fast Python Bundler for Ethereum EIP-4337 Account Abstraction\n </b>\n </p>\n</div>\n\n# Using an instance\n\nFor a quick bundler instance, use one of our [public hosted endpoints](https://docs.candide.dev/wallet/bundler/rpc-endpoints/) for your developement.\n\n# Deployment\n\nDeploy Voltaire using the latest docker image\n\n```\ndocker run --net=host --rm -ti ghcr.io/candidelabs/voltaire/voltaire-bundler:latest --bundler_secret $BUNDLER_SECRET --rpc_url $RPC_URL --rpc_port $PORT --ethereum_node_url $ETHEREUM_NODE_URL --chain_id $CHAIN_ID --verbose --unsafe --disable_p2p\n```\n\n# Development\n\n## Ubuntu: Get started testing the bundler in 5 minutes \n\n### Install Poetry\n```\ncurl -sSL https://install.python-poetry.org | python3 -\n```\n### Install dependencies\n```\npoetry install\n```\n\n### Make sure you are using the right python version\n\n```\npoetry env use python3.11\n```\n\n### Install Docker\n\nFollow the installation guide to install [docker on ubunutu](https://docs.docker.com/engine/install/ubuntu/)\n\n### Post docker installation\n\nFollow the instruction for docker's [post linux instalation](https://docs.docker.com/engine/install/linux-postinstall/) \n\n### Start geth\n```\ndocker run --rm -ti --name geth -p 8545:8545 ethereum/client-go:v1.10.26 \\\n --miner.gaslimit 12000000 \\\n --http --http.api personal,eth,net,web3,debug \\\n --http.vhosts '*,localhost,host.docker.internal' --http.addr \"0.0.0.0\" \\\n --ignore-legacy-receipts --allow-insecure-unlock --rpc.allow-unprotected-txs \\\n --dev \\\n --verbosity 4 \\\n --nodiscover --maxpeers 0 --mine --miner.threads 1 \\\n --networkid 1337\n```\n\n### Deploy the EntryPoint and fund the signer (in another terminal)\n```\ngeth --exec 'loadScript(\"scripts/deploy.js\")' attach http://0.0.0.0:8545\n```\n\n### Set env values\n```\nsource scripts/init-params \n```\n\n### Run the bundler\n```\npoetry run python3 -m voltaire_bundler --entrypoint $ENTRYPOINT --bundler_secret $BUNDLER_SECRET --chain_id 1337 --verbose\n```\n\n### Test the bundler by cloning `eth-infinitism/bundler-spec-tests`\n\nFollow the instruction in <a href='https://github.com/eth-infinitism/bundler-spec-tests'>eth-infinitism/bundler-spec-tests</a> to install dependencies and run the test\n\n## P2P rust section development\n\n### Install Rust\n```\ncurl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh\n```\n\n### Install build dependencies\n```\nsudo apt install musl-tools\nrustup target add x86_64-unknown-linux-musl\n```\n\n### Build the rust section using poetry script\n```\npoetry run build_p2p\n```\n\n## Contributions\n\nThank you for considering contributing to open-source code! We welcome contributions and are grateful for even the smallest of fixes. \n\nIf you want to contribute today or follow along with the contributor discussion, you can use our main discord to chat with us about the development of Voltaire.\n\n<!-- LICENSE -->\n## License\nLGPL\n\n<!-- ACKNOWLEDGMENTS -->\n## Acknowledgments\n\nNone of this would have been possible without the following teams and organizations below: \n\n* <a href='https://eips.ethereum.org/EIPS/eip-4337'>EIP-4337: Account Abstraction via Entry Point Contract specification </a>\n* <a href='https://github.com/eth-infinitism/bundler'>eth-infinitism/bundler</a>\n* Voltaire is funded exclusively by [The Ethereum Foundation](https://ethereum.foundation/)\n* <a href='https://github.com/sigp/lighthouse'>Lighthouse: Ethereum consensus client</a>",
"bugtrack_url": null,
"license": "LGPL",
"summary": "EIP-4337 python Bundler",
"version": "0.1.0a24",
"project_urls": {
"Homepage": "https://github.com/candidelabs/voltaire",
"Repository": "https://github.com/candidelabs/voltaire"
},
"split_keywords": [
"4337",
"account_abstraction",
"ethereum",
"bundler"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a62ca21b4bcbe5317d582ab52c8c8d85b962236d1bef175cc07c9fd35a03e354",
"md5": "c4f86c19007fc726c7a5a683fa29f8e4",
"sha256": "45ecc0717cdb2d0a0ce108bd790a9699f5086769ab33f61f498298e6b7e739b7"
},
"downloads": -1,
"filename": "voltaire_bundler-0.1.0a24-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c4f86c19007fc726c7a5a683fa29f8e4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 53170,
"upload_time": "2024-01-21T22:42:29",
"upload_time_iso_8601": "2024-01-21T22:42:29.095219Z",
"url": "https://files.pythonhosted.org/packages/a6/2c/a21b4bcbe5317d582ab52c8c8d85b962236d1bef175cc07c9fd35a03e354/voltaire_bundler-0.1.0a24-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f03dc5cf6f347dfa82ef4779ba35f1a22715b54532fa580453ce24a3bafb0ffc",
"md5": "2ced3e9c8a53ad0897f7561ffb7ed70b",
"sha256": "059988f5f194b736a25f1edd92a6581907e94a3966c1e233ae207d4a95cde6d1"
},
"downloads": -1,
"filename": "voltaire_bundler-0.1.0a24.tar.gz",
"has_sig": false,
"md5_digest": "2ced3e9c8a53ad0897f7561ffb7ed70b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 43842,
"upload_time": "2024-01-21T22:42:31",
"upload_time_iso_8601": "2024-01-21T22:42:31.281759Z",
"url": "https://files.pythonhosted.org/packages/f0/3d/c5cf6f347dfa82ef4779ba35f1a22715b54532fa580453ce24a3bafb0ffc/voltaire_bundler-0.1.0a24.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-21 22:42:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "candidelabs",
"github_project": "voltaire",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "voltaire_bundler"
}
JSON
