solver-MultiRpc

https://github.com/symm-io/solver-multirpc
Admin
A robust Python library for reliable Ethereum interactions using multiple RPC endpoints with both...
Tokens:2,457
Snippets:26
Trust Score:8.2
Update:5 months ago
Show doc for...
Tokens:
Raw
### AsyncMultiRpc Initialization and Usage

Source: https://github.com/symm-io/solver-multirpc/blob/main/README.md

Example of initializing and using AsyncMultiRpc for asynchronous contract interactions. Requires setting up RPC endpoints, contract ABI, and account details.

```python
import asyncio
import json
from src.multirpc.utils import NestedDict
from multirpc import AsyncMultiRpc


async def main():
    rpcs = NestedDict({
        "view": {
            1: ['https://1rpc.io/ftm', 'https://rpcapi.fantom.network', 'https://rpc3.fantom.network'],
            2: ['https://rpc.fantom.network', 'https://rpc2.fantom.network', ],
            3: ['https://rpc.ankr.com/fantom'],
        },
        "transaction": {
            1: ['https://1rpc.io/ftm', 'https://rpcapi.fantom.network', 'https://rpc3.fantom.network'],
            2: ['https://rpc.fantom.network', 'https://rpc2.fantom.network', ],
            3: ['https://rpc.ankr.com/fantom'],
        }
    })
    with open("abi.json", "r") as f:
        abi = json.load(f)
    multi_rpc = AsyncMultiRpc(rpcs, 'YOUR_CONTRACT_ADDRESS', contract_abi=abi, enable_gas_estimation=True)
    multi_rpc.set_account("YOUR_PUBLIC_ADDRESS", "YOUR_PRIVATE_KEY")

    result = await multi_rpc.functions.YOUR_FUNCTION().call()
    print(result)


asyncio.run(main())
```

--------------------------------

### Install solver-MultiRpc

Source: https://github.com/symm-io/solver-multirpc/blob/main/README.md

Install the solver-MultiRpc library using pip.

```bash
pip install solver-multiRPC
```

--------------------------------

### MultiRpc Initialization and Usage

Source: https://github.com/symm-io/solver-multirpc/blob/main/README.md

Example of initializing and using MultiRpc for synchronous contract interactions. Requires setting up RPC endpoints, contract ABI, and account details.

```python
from multirpc import MultiRpc


def main():
    multi_rpc = MultiRpc(rpcs, 'YOUR_CONTRACT_ADDRESS', contract_abi=abi, enable_gas_estimation=True)
    multi_rpc.set_account("YOUR_PUBLIC_ADDRESS", "YOUR_PRIVATE_KEY")

    result = multi_rpc.functions.YOUR_FUNCTION().call()
    print(result)


main()
```

--------------------------------

### AsyncMultiRpc Initialization and Usage

Source: https://github.com/symm-io/solver-multirpc/blob/main/README.md

Demonstrates how to initialize and use the AsyncMultiRpc class for asynchronous Ethereum contract interactions.

```APIDOC
## AsyncMultiRpc Initialization and Usage

### Description
Initialize the `AsyncMultiRpc` class with your RPC URLs, contract address, and contract ABI. Then, set the account details and call contract functions asynchronously.

### Initialization
```python
from multirpc import AsyncMultiRpc

# Assuming 'rpcs', 'abi', 'YOUR_CONTRACT_ADDRESS' are defined
multi_rpc = AsyncMultiRpc(rpcs, 'YOUR_CONTRACT_ADDRESS', contract_abi=abi, enable_gas_estimation=True)
```

### Setting Account
```python
multi_rpc.set_account("YOUR_PUBLIC_ADDRESS", "YOUR_PRIVATE_KEY")
```

### Calling Contract Functions
```python
# For view functions
result = await multi_rpc.functions.YOUR_FUNCTION().call()

# For transaction functions (waits for receipt by default)
# To disable waiting for receipt, pass wait_for_receipt=0
result = await multi_rpc.functions.YOUR_FUNCTION().call(wait_for_receipt=0)

# Calling with a different private key
result = await multi_rpc.functions.YOUR_FUNCTION().call(address=PublicKey, private_key=PrivateKey)

# Using block identifier
result = multi_rpc.functions.yourViewFunction().call(block_identifier='latest')
```

### Passing View Policy
```python
from multirpc import ViewPolicy

# Initialize with a specific view policy
multi_rpc = AsyncMultiRpc(rpcs, contract_address, abi, view_policy=ViewPolicy.FirstSuccess)
```
```

--------------------------------

### MultiRpc Initialization and Usage

Source: https://github.com/symm-io/solver-multirpc/blob/main/README.md

Demonstrates how to initialize and use the MultiRpc class for synchronous Ethereum contract interactions.

```APIDOC
## MultiRpc Initialization and Usage

### Description
Initialize the `MultiRpc` class with your RPC URLs, contract address, and contract ABI. Then, set the account details and call contract functions synchronously.

### Initialization
```python
from multirpc import MultiRpc

# Assuming 'rpcs', 'abi', 'YOUR_CONTRACT_ADDRESS' are defined
multi_rpc = MultiRpc(rpcs, contract_address='YOUR_CONTRACT_ADDRESS', contract_abi=abi)
```

### Setting Account
```python
multi_rpc.set_account("YOUR_PUBLIC_ADDRESS", "YOUR_PRIVATE_KEY")
```

### Calling Contract Functions
```python
# For view functions
result = multi_rpc.functions.YOUR_FUNCTION().call()

# For transaction functions (waits for receipt by default)
# To disable waiting for receipt, pass wait_for_receipt=0
result = multi_rpc.functions.YOUR_FUNCTION().call(wait_for_receipt=0)

# Calling with a different private key
result = multi_rpc.functions.YOUR_FUNCTION().call(address=PublicKey, private_key=PrivateKey)

# Using block identifier
result = multi_rpc.functions.yourViewFunction().call(block_identifier='latest')
```

### Passing View Policy
```python
from multirpc import ViewPolicy

# Initialize with a specific view policy
multi_rpc = MultiRpc(rpcs, contract_address, abi, view_policy=ViewPolicy.FirstSuccess)
```
```

--------------------------------

### MultiRpc Initialization

Source: https://github.com/symm-io/solver-multirpc/blob/main/README.md

Initialize the MultiRpc class with RPC URLs, contract address, and contract ABI.

```python
multi_rpc = MultiRpc(rpcs, contract_address='YOUR_CONTRACT_ADDRESS', contract_abi=abi)
```

--------------------------------

### Implement Custom Gas Estimation Logic

Source: https://github.com/symm-io/solver-multirpc/blob/main/README.md

Extend the GasEstimation class and override _custom_gas_estimation to implement custom gas price logic. Ensure custom gas prices do not exceed the gas_upper_bound.

```python
from multirpc import GasEstimation, TxPriority, GasEstimationMethod
from web3 import Web3
from web3.types import Wei


class CustomGasEstimation(GasEstimation):

    async def _custom_gas_estimation(self, priority: TxPriority, gas_upper_bound: float) -> dict:
        # Your custom gas estimation logic here
        custom_gas_price = 50  # Replace with your custom logic
        if custom_gas_price > gas_upper_bound:
            raise OutOfRangeTransactionFee(f"Custom gas price {custom_gas_price} exceeds upper bound {gas_upper_bound}")
        return {
            "gasPrice": Web3.to_wei(custom_gas_price, 'gwei')
        }


# Create an instance of your custom gas estimation
custom_gas_estimation = CustomGasEstimation(
    chain_id=1,
    providers=[],
    default_method=GasEstimationMethod.CUSTOM,
    gas_api_provider=''
)

# Use it with MultiRpc
multi_rpc = MultiRpc(rpc_urls, contract_address, contract_abi, gas_estimation=custom_gas_estimation)
```

--------------------------------

### Configure Gas Estimation for MultiRpc

Source: https://github.com/symm-io/solver-multirpc/blob/main/README.md

Pass a GasEstimation object to MultiRpc to configure gas price estimation. Ensure providers are correctly set for the desired chain ID.

```python
from multirpc import MultiRpc, GasEstimation, GasEstimationMethod

gas_estimation = GasEstimation(
    chain_id=1,  # Mainnet
    providers=[],  # List of AsyncWeb3 providers
    default_method=GasEstimationMethod.GAS_API_PROVIDER,
    gas_api_provider='https://gasstation-mainnet.matic.network'  # Replace with your API provider
)

# Pass the GasEstimation object to MultiRpc
multi_rpc = MultiRpc(rpc_urls, contract_address, contract_abi, gas_estimation=gas_estimation)
```

--------------------------------

### Set Account for MultiRpc

Source: https://github.com/symm-io/solver-multirpc/blob/main/README.md

Set the Ethereum account details (address and private key) for sending transactions with MultiRpc.

```python
multi_rpc.set_account("YOUR_PUBLIC_ADDRESS", "YOUR_PRIVATE_KEY")
```

--------------------------------

### Pass View Policy to MultiRpc

Source: https://github.com/symm-io/solver-multirpc/blob/main/README.md

Specify a view policy (`MostUpdated` or `FirstSuccess`) during MultiRpc initialization to control how view function calls are handled.

```python
multi_rpc = MultiRpc(rpc_urls, contract_address, contract_abi, view_policy=ViewPolicy.FirstSuccess)
```

--------------------------------

### Call Contract Function with MultiRpc

Source: https://github.com/symm-io/solver-multirpc/blob/main/README.md

Call a view function from your contract using MultiRpc. By default, it returns tx_receipt after a 90-second wait. Set `wait_for_receipt=0` to disable receipt waiting.

```python
result = await multi_rpc.functions.YOUR_FUNCTION().call()
```

--------------------------------

### Specify Gas Estimation Method in Call

Source: https://github.com/symm-io/solver-multirpc/blob/main/README.md

Specify the gas estimation method directly within the call() method if needed. This overrides the default behavior of checking all possible methods.

```python
tx_hash = multi_rpc.functions.yourTransactionFunction().call(
    gas_estimation_method=GasEstimationMethod.RPC,  # Specify the gas estimation method
)
```

--------------------------------

### Call Contract Function with Different Private Key

Source: https://github.com/symm-io/solver-multirpc/blob/main/README.md

Call a transaction function with a different private key by passing the `private_key` and `address` parameters to the `call()` method.

```python
result = await multi_rpc.functions.YOUR_FUNCTION().call(address=PublicKey, private_key=PrivateKey)
```

--------------------------------

### Use Block Identifier in MultiRpc Calls

Source: https://github.com/symm-io/solver-multirpc/blob/main/README.md

Specify a block identifier (e.g., 'latest', 'earliest', or a block number) when calling view functions to retrieve contract state at a specific block. Note that most free RPCs only support querying blocks up to 10 minutes old.

```python
# You can use 'latest', 'earliest', or a specific block number
result = multi_rpc.functions.yourViewFunction().call(block_identifier='latest')
```
Tokens:
Raw