Python Builder Signing SDK

Warnings

• breaking The library is in a very early stage (version 0.0.2). The API and internal mechanisms are subject to rapid change, potentially introducing breaking changes even between minor patch versions. Users should pin exact versions and review release notes diligently.
  Fix: Pin the exact version (e.g., `py-builder-signing-sdk==0.0.2`) in your `requirements.txt` or `pyproject.toml` and thoroughly test when upgrading.
• gotcha Directly embedding private keys in source code or insecurely managing them is a severe security risk. This library requires a private key for signing, which must be handled with extreme care.
  Fix: Always use secure methods for private key management, such as environment variables (e.g., `os.environ.get()`), a dedicated secret management service, or hardware security modules (HSMs).
• gotcha The library relies on `web3` and `eth-account` as dependencies. Major version upgrades of these libraries (e.g., `web3` v5 to v6) have introduced significant breaking changes in the past, which could indirectly affect `py-builder-signing-sdk`'s behavior or require specific versions.
  Fix: Ensure compatibility with your other `web3` and `eth-account` installations. If you encounter issues, check the `py-builder-signing-sdk`'s `setup.py` or `pyproject.toml` for explicit dependency version ranges and align your project's dependencies accordingly.

Install

• pip install py-builder-signing-sdk Install with pip

Imports

• Builder

  from builder_signing_sdk.builder import Builder

• Account

  from eth_account import Account

• LocalAccount

  from eth_account.signers.local import LocalAccount

Quickstart

This quickstart initializes the `Builder` SDK with an Ethereum account. It demonstrates how to securely handle private keys using environment variables and provides a basic setup for signing builder bids and bundles. Note that the actual signing calls are commented out as they require valid, context-specific data.

import os
from builder_signing_sdk.builder import Builder
from eth_account import Account

# WARNING: In a real application, retrieve your private key securely, e.g., from environment variables.
# DO NOT hardcode private keys in production code.
# This is a dummy private key for demonstration purposes ONLY.
private_key_env = os.environ.get('BUILDER_PRIVATE_KEY', '0x1111111111111111111111111111111111111111111111111111111111111111')

if private_key_env == '0x1111111111111111111111111111111111111111111111111111111111111111':
    print("WARNING: Using a dummy private key. Set BUILDER_PRIVATE_KEY environment variable for real usage.")

# Initialize an Ethereum account from the private key
account = Account.from_key(private_key_env)

# Define your builder's name
builder_name = os.environ.get('BUILDER_NAME', 'my-test-builder')

# Initialize the Builder SDK
builder = Builder(builder_name, account)

print(f"Initialized Builder SDK for '{builder_name}' with Ethereum address: {account.address}")
print("You can now use 'builder.sign_bid()' or 'builder.sign_bundle()' to sign MEV payloads.")

# Example of how you would call sign_bid (requires valid data, commented out to keep runnable):
# signed_bid_id = builder.sign_bid(
#     gas_limit=21000,
#     gas_price=10**10,
#     base_fee_per_gas=10**10,
#     builder_eth_balance_delta=0,
#     builder_eth_balance_after=0,
#     block_number=12345678,
#     tx_hash="0x" + "0"*64, 
#     tx_eth_value=0,
#     sender_address=account.address,
#     destination_address="0x" + "0"*40,
#     mev_gas_price=0
# )
# print(f"Signed dummy bid ID: {signed_bid_id}")