Skip to content

Commit 9d32791

Browse files
committed
Update readme
1 parent b849fd6 commit 9d32791

1 file changed

Lines changed: 27 additions & 9 deletions

File tree

README.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,20 +48,20 @@ When updates are made to the package, the version will automatically be incremen
4848

4949
How to use the package:
5050

51-
- Import the package into your Python script:
51+
1. Import the package into your Python script:
5252
```python
5353
from alpha_homora_v2.util import get_web3_provider
5454
from alpha_homora_v2.position import AlphaHomoraV2Position
5555
```
5656

57-
- Create your Web3 provider object to interact with the network:
57+
2. Create your Web3 provider object to interact with the network:
5858
```python
5959
NETWORK_RPC_URL = "your_rpc_url"
6060
6161
provider = get_provider(NETWORK_RPC_URL)
6262
```
6363

64-
- Creating an [AlphaHomoraV2Position](alpha_homora_v2/position.py) instance requires the following:
64+
3. Creating an [AlphaHomoraV2Position](alpha_homora_v2/position.py) instance requires the following:
6565
- A web3 provider object
6666
- Your position ID (an integer)
6767
- This ID should match your position on Alpha Homora, without the "#"
@@ -84,20 +84,33 @@ How to use the package:
8484
position = AlphaHomoraV2Position(
8585
web3_provider=provider,
8686
position_id=11049,
87-
position_symbol="AVAX/USDT.e",
8887
dex="Pangolin V2",
8988
owner_wallet_address="0x...",
90-
owner_private_key="123abc456efg789hij..."
89+
owner_private_key="123abc456efg789hij..." # (Optional - see step 4)
9190
)
9291
```
93-
- Use your position instance to interact with the Alpha Homora V2 position smart contracts on the network:
92+
4. Use your position instance to interact with the Alpha Homora V2 position smart contracts on the network:
9493
```python
95-
# Harvest rewards:
96-
position.claim_all_rewards()
94+
""" Informational Methods (Private Key not Required) """
95+
# Get value of harvestable rewards:
96+
position.get_rewards_value()
97+
98+
# Get current debt ratio:
99+
position.get_debt_ratio()
100+
101+
# Get position value (equity, debt, and position value):
102+
position.get_position_value()
97103
98104
# get LP pool info:
99105
position.get_pool_info()
100106
107+
# (WIP) Get current pool APY
108+
position.get_current_apy()
109+
110+
""" Transactional Methods (Private Key Required) """
111+
# Harvest available rewards:
112+
position.claim_all_rewards()
113+
101114
# Close the position:
102115
position.close()
103116
```
@@ -114,5 +127,10 @@ pip uninstall alpha-homora-v2
114127
1. ~~Get position value of equity and debt~~
115128
2. ~~Get current debt ratio~~
116129
3. Get outstanding rewards value in native rewards token and USD
130+
- ~~Pangolin V2~~
131+
- Trader Joe
117132
4. Get current pool APY
118-
5. Integrate with Ethereum network exchanges
133+
5. Integrate with Alpha Homora V2 Networks:
134+
- ~~Avalanche~~
135+
- Ethereum
136+
- Fantom

0 commit comments

Comments
 (0)