Public pools

Author: alexvelea

examples/README.md

@@ -103,6 +103,21 @@ Examples on how to do this can be found here:
 - `spot_get_account_assets_http.py`
 - `spot_get_account_assets_ws.py`
 
+## Public Pools
+Public pools behave just like subaccounts, except that anyone can join them.  
+You can create / modify a public pool using the SDK. Check out the following example:
+- `public_pool_create_modify.py` 
+
+To create API keys for a public pool, you need to run the setup script but specify the `ACCOUNT_INDEX` to be the one of the public pool.  
+After that, you can trade from the public as from any other account.
+
+If you want to deposit / withdraw from a public pool, check the following example:
+- `public_pool_deposit.py`
+- `public_pool_withdraw.py`
+
+To get information about pools, check:
+- `public_pool_info.py`
+
 ## Setup steps for mainnet
 - deposit money on Lighter to create an account first
 - change the URL to `mainnet.zklighter.elliot.ai`

examples/public_pool_create_modify.py

@@ -0,0 +1,59 @@
+import time
+import json
+import asyncio
+import lighter
+from utils import default_example_setup
+
+
+async def main():
+    client, api_client, _ = default_example_setup()
+    tx_api = lighter.TransactionApi(api_client)
+
+    err = client.check_client()
+    if err is not None:
+        print(f"CheckClient error: {err}")
+        return
+
+    auth, _ = client.create_auth_token_with_expiry()
+
+    # create a public pool
+    tx_info, response, err = await client.create_public_pool(
+        operator_fee=100000,  # 10%
+        initial_total_shares=1_000_000,  # 1000 USDC
+        min_operator_share_rate=100,  # 1%
+    )
+    if err is not None:
+        raise Exception(f'failed to create public pool {err}')
+    tx_hash = response.tx_hash
+    print(f"✅ send create public pool tx. hash: {tx_hash}")
+
+    # fetch pool account index from tx hash
+    pool_account_index = -1
+    for i in range(10):
+        time.sleep(1)
+        try:
+            response = await tx_api.tx(by="hash", value=tx_hash)
+            event_info_j = json.loads(response.event_info)
+            pool_account_index = event_info_j['a']
+        except Exception as e:
+            pass
+        if pool_account_index != -1:
+            break
+    if pool_account_index == -1:
+        raise Exception(f"failed to find pool account index for tx {tx_hash}")
+    print(f"✅ pool account index: {pool_account_index}")
+
+    # Note: ❗️operator_fee can only decrease
+    # modify pool metadata
+    tx_info, response, err = await client.update_public_pool(
+        public_pool_index=pool_account_index,
+        status=0,  # 0 is active | 1 is frozen
+        operator_fee=50000,  # 5%
+        min_operator_share_rate=1000,  # 10%
+    )
+    if err is not None:
+        raise Exception(f'failed to create update pool {err}')
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

examples/public_pool_deposit.py

@@ -0,0 +1,25 @@
+import asyncio
+
+from utils import default_example_setup
+
+POOL_ACCOUNT_INDEX = 281474976710651
+
+
+async def main():
+    client, api_client, _ = default_example_setup()
+
+    err = client.check_client()
+    if err is not None:
+        print(f"CheckClient error: {err}")
+        return
+
+    tx_info, response, err = await client.mint_shares(public_pool_index=POOL_ACCOUNT_INDEX, share_amount=10_000)
+    if err is not None:
+        raise Exception(f'failed to mint shares {err}')
+
+    await client.close()
+    await api_client.close()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

examples/public_pool_info.py

@@ -0,0 +1,33 @@
+import asyncio
+import lighter
+from utils import default_example_setup
+
+POOL_ACCOUNT_INDEX = 281474976710651
+
+
+async def main():
+    client, api_client, _ = default_example_setup()
+    account_api = lighter.AccountApi(api_client)
+
+    err = client.check_client()
+    if err is not None:
+        print(f"CheckClient error: {err}")
+        return
+
+    account = await account_api.account(by="index", value=str(client.account_index))
+
+    # Note: ❗️shares field does not return the shared you have in pools that you're the operator
+    for pool in account.accounts[0].shares:
+        pool_resp = await account_api.account(by="index", value=str(pool.public_pool_index))
+        pool_account = pool_resp.accounts[0]
+
+        share_price = float(pool_account.total_asset_value) / float(pool_account.pool_info.total_shares)
+        print(
+            f"poolAccountId: {pool.public_pool_index} numShared: {pool.shares_amount} sharePrice: {share_price:.6f} value: {share_price * pool.shares_amount:.2f} pnl: {share_price * pool.shares_amount - float(pool.entry_usdc):.2f}")
+
+    await client.close()
+    await api_client.close()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

examples/public_pool_withdraw.py

@@ -0,0 +1,26 @@
+import asyncio
+from utils import default_example_setup
+
+POOL_ACCOUNT_INDEX = 281474976710651
+
+
+async def main():
+    client, api_client, _ = default_example_setup()
+
+    err = client.check_client()
+    if err is not None:
+        print(f"CheckClient error: {err}")
+        return
+
+    auth, _ = client.create_auth_token_with_expiry()
+
+    tx_info, response, err = await client.burn_shares(public_pool_index=POOL_ACCOUNT_INDEX, share_amount=10_000)
+    if err is not None:
+        raise Exception(f'failed to mint shares {err}')
+
+    await client.close()
+    await api_client.close()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())