optimism-python's Introduction

Optimism-Python: Unofficial Python Client for the OP-Stack

🚧 DISCLAIMER: Reference SDK is still under active development so the repository might be temporarily out of date.

This library is a Python implementation of the OP-Stack SDK. It tries to mirror some of the core functionalities such as:

providing easy access to the OP-Stack contracts
bridging of assets from L1 to L2 (deposits) and vice-versa (withdrawls)
creating withdrawl proofs

Getting started

Installation

pip install optimism-python

Deposit ETH to L2

from web3 import Web3
from optimism import CrossChainMessenger

# Create a node provider for each chain
provider_l1 = Web3(Web3.HTTPProvider("https://eth-mainnet.g.alchemy.com/v2/<your-alchemy-key>"))
provider_l2 = Web3(Web3.HTTPProvider("https://optimism-mainnet.g.alchemy.com/v2/<your-alchemy-key>"))

# Specify an account for each chain (can be the same)
account_l1 = provider_l1.eth.account.from_key("<your-private-key>")
account_l2 = provider_l2.eth.account.from_key("<your-private-key>")

# Create a messenger instance
messenger = CrossChainMessenger(chain_id_l1=1,          # Ethereum Mainnet
                                chain_id_l2=10,         # Optimism Mainnet
                                account_l1=account_l1, 
                                account_l2=account_l2,
                                provider_l1=provider_l1,
                                provider_l2=provider_l2)

# Deposit 1 ETH to L2
messenger.deposit_eth(10**18)

optimism-python's People

Contributors

Stargazers

Watchers

optimism-python's Issues

ERC20 deposits and withdrawls

🚀 Feature Description

Adds the capability to deposit and withdraw ERC20 tokens through the CrossChainMessenger.

📝 Detailed Explanation

Currently, only deposits and withdrawls of ETH are possible. This feature will allow one to deposit an ERC20 token from the L1 to the L2 and withdraw an ERC20 token from L2 to L1. The interaction should be equivalent to the Optimism SDK as presented in this tutorial.

🎯 Acceptance Criteria

User can send a supported ERC20 token from L1 to L2 (referred to as deposit)
User can send a supported ERC20 token from L2 to L1 (referred to as withdrawl)

Big breaking changes are coming to to the op-stack bridge contracts

Just a heads up, the optimism team is making pretty big breaking changes to the SDK in preperation for our testnet launch. If you need guidance let me know. We will be updating the optimism sdk soon which can be used as reference

bleu wants to contribute to optimism-python

hey @rafalum I'm curious if you're looking for external contributions to bring this Python SDK to feature-parity with the TS one. @bleu-fi has applied to an Optimism Mission to work on a Python SDK but feels like we should contribute to your package instead of starting from scratch.

BTW I followed you on Twitter, if you prefer we can chat there via DMs or in another channel you prefer.

rafalum / optimism-python Goto Github PK