1
0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-26 19:49:26 +01:00
docs/data-scientists/ocean.py/remote-setup.md

151 lines
5.2 KiB
Markdown
Raw Normal View History

---
description: Remote setup for running & testing ocean.py
---
# Remote Setup
This setup does not use barge and uses a remote chain to do the transactions. When the network URL is specified & configured, ocean.py will use components (such as Provider, Aquarius, C2D) according to the expected blockchain.
2024-06-03 13:41:12 +02:00
Here, we do setup for Sepolia. It's similar for other remote chains.
Here, we will:
1. Configure Networks
2. Create two accounts - `REMOTE_TEST_PRIVATE_KEY1` and `2`
2024-06-03 13:41:12 +02:00
3. Get test ETH on Sepolia
4. Get test OCEAN on Sepolia
5. Set envvars
6. Set up Alice and Bob wallets in Python
Let's go!
### 1. Configure Networks
#### 1.1 Supported networks
All [Ocean chain deployments](https://docs.oceanprotocol.com/discover/networks) (Eth mainnet, Polygon, etc) are supported.
For any supported network, use the RPC URL of your choice when passing it to the ocean config object.
#### 1.2 RPCs and Infura
2023-07-14 16:29:02 +02:00
In order to obtain API keys for blockchain access, follow up [this document](http://127.0.0.1:5000/o/mTcjMqA4ylf55anucjH8/s/zQlpIJEeu8x5yl0OLuXn/) for tips & tricks.
**If you do have an Infura account**
2024-06-03 13:41:12 +02:00
Use the full RPC URL including the base and API key, e.g. for sepolia: `https://sepolia.infura.io/v3/<API-KEY>`
### 2. Create EVM Accounts (One-Time)
An EVM account is singularly defined by its private key. Its address is a function of that key. Let's generate two accounts!
In a new or existing console, run Python.
```bash
python
```
In the Python console:
```python
from eth_account.account import Account
account1 = Account.create()
account2 = Account.create()
print(f"""
REMOTE_TEST_PRIVATE_KEY1={account1.key.hex()}, ADDRESS1={account1.address}
REMOTE_TEST_PRIVATE_KEY2={account2.key.hex()}, ADDRESS2={account2.address}
""")
```
Then, hit Ctrl-C to exit the Python console.
Now, you have two EVM accounts (address & private key). Save them somewhere safe, like a local file or a password manager.
2024-06-03 13:41:12 +02:00
These accounts will work on any EVM-based chain: production chains like Eth mainnet and Polygon, and testnets like Sepolia. Here, we'll use them for Sepolia.
2024-06-03 13:41:12 +02:00
### 3. Get (test) ETH on Sepolia
2024-06-03 13:41:12 +02:00
We need the a network's native token to pay for transactions on the network. [ETH](https://ethereum.org/en/get-eth/) is the native token for Ethereum mainnet; [MATIC](https://polygon.technology/matic-token/) is the native token for Polygon, and [(test) ETH](https://www.alchemy.com/faucets/ethereum-sepolia) is the native token for Sepolia.
2024-06-03 13:41:12 +02:00
To get free (test) ETH on Sepolia:
2024-06-03 13:41:12 +02:00
1. Go to the faucet [https://www.alchemy.com/faucets/ethereum-sepolia](https://www.alchemy.com/faucets/ethereum-sepolia). Login or create an account on Alchemy.
2. Request funds for ADDRESS1
3. Request funds for ADDRESS2
2024-06-03 13:41:12 +02:00
### 4. Get (test) OCEAN on Sepolia
[OCEAN](https://oceanprotocol.com/token) can be used as a data payment token, and locked into veOCEAN for Data Farming / curation. The READMEs show how to use OCEAN in both cases.
2024-06-03 13:41:12 +02:00
* (Test) OCEAN is on each testnet. Test OCEAN on Sepolia is at [`0x1B083D8584dd3e6Ff37d04a6e7e82b5F622f3985`](https://sepolia.etherscan.io/address/0x1B083D8584dd3e6Ff37d04a6e7e82b5F622f3985).
2024-06-03 13:41:12 +02:00
To get free (test) OCEAN on Sepolia:
2024-06-03 13:41:12 +02:00
1. Go to the faucet [https://faucet.sepolia.oceanprotocol.com/](https://faucet.sepolia.oceanprotocol.com/)
2. Request funds for ADDRESS1
3. Request funds for ADDRESS2
2024-06-03 13:41:12 +02:00
You can confirm receiving funds by going to the following url, and seeing your reported OCEAN balance: `https://sepolia.etherscan.io/address/0x1B083D8584dd3e6Ff37d04a6e7e82b5F622f3985?a=<ADDRESS1 or ADDRESS2>`
### 5. Set envvars
As usual, Linux/MacOS needs "`export`" and Windows needs "`set`". In the console:
**Linux & MacOS users:**
```bash
# For accounts: set private keys
export REMOTE_TEST_PRIVATE_KEY1=<your REMOTE_TEST_PRIVATE_KEY1>
export REMOTE_TEST_PRIVATE_KEY2=<your REMOTE_TEST_PRIVATE_KEY2>
```
**Windows users:**
```powershell
# For accounts: set private keys
set REMOTE_TEST_PRIVATE_KEY1=<your REMOTE_TEST_PRIVATE_KEY1>
set REMOTE_TEST_PRIVATE_KEY2=<your REMOTE_TEST_PRIVATE_KEY2>
```
### 6. Setup in Python
In your working console, run Python:
```bash
python
```
In the Python console:
```python
# Create Ocean instance
import os
from ocean_lib.example_config import get_config_dict
from ocean_lib.ocean.ocean import Ocean
config = get_config_dict("https://polygon.llamarpc.com") # or use another RPC URL, or an Infura one
ocean = Ocean(config)
# Create OCEAN object. ocean_lib knows where OCEAN is on all remote networks
OCEAN = ocean.OCEAN_token
# Create Alice's wallet
from eth_account import Account
alice_private_key = os.getenv('REMOTE_TEST_PRIVATE_KEY1')
alice = Account.from_key(private_key=alice_private_key)
assert alice.balance() > 0, "Alice needs MATIC"
assert OCEAN.balanceOf(alice) > 0, "Alice needs OCEAN"
# Create Bob's wallet. While some flows just use Alice wallet, it's simpler to do all here.
bob_private_key = os.getenv('REMOTE_TEST_PRIVATE_KEY2')
bob = Account.from_key(private_key=bob_private_key)
assert bob.balance() > 0, "Bob needs MATIC"
assert OCEAN.balanceOf(bob) > 0, "Bob needs OCEAN"
# Compact wei <> eth conversion
from ocean_lib.ocean.util import to_wei, from_wei
```
If you get a gas-related error like `transaction underpriced`, you'll need to change the `maxFeePerGas` or `maxPriorityFeePerGas`.