indev

Author: hschickdevs

.gitignore

@@ -151,4 +151,4 @@ package_testing.ipynb
 Result/*
 dev_ref/*
 testing*
-tests/report.csv
+examples/report.csv

README.md

@@ -52,21 +52,22 @@ How to use the package:
 
 ### Avalanche:
 
-1. Import the package into your Python script:
+1. Import the AvalanchePosition class into your Python script:
     ```python
-    from alpha_homora_v2.util import get_web3_provider
     from alpha_homora_v2.position import AvalanchePosition
     ```
 
-2. **(Optional)** Create your Web3 provider object to interact with the network:
+2. **(Optional)** Instantiate your custom Web3 provider object to interact with the network:
     ```python
+   from alpha_homora_v2.util import get_web3_provider
+   
     NETWORK_RPC_URL = "your_rpc_url"
     provider = get_web3_provider(NETWORK_RPC_URL)
     ```
 3. Creating an [AvalanchePosition](alpha_homora_v2/position.py) instance requires the following:
     - Your position ID (an integer)
         - This ID should match your position on Alpha Homora, without the "#"
-        - ![demo](img/id_highlight.png)
+          ![demo](img/id_highlight.png)
 
     <!--- DEPRECATED
     - The token symbol/pair (a string)

tests/avalanche/add_liquidity.py examples/avalanche/add_liquidity.pytests/avalanche/add_liquidity.py renamed to examples/avalanche/add_liquidity.py

@@ -9,7 +9,7 @@
 
 
 ADDRESS = os.getenv("PUBLIC_WALLET_ADDRESS")
-CSV_OUTPUT_FILEPATH = os.path.join(os.path.dirname(__file__), "report.csv")  # File will be generated to tests/report.csv
+CSV_OUTPUT_FILEPATH = os.path.join(os.path.dirname(__file__), "report.csv")  # File will be generated to examples/report.csv
 
 
 def build_rows(ahv2_positions: list[AvalanchePosition]):