example reorganization

README.md

@@ -42,10 +42,10 @@ if __name__ == "__main__":
 The [`examples/`](examples) directory contains end-to-end scripts for the
 common flows. A few starting points:
 
-- [Read public REST endpoints](examples/get_info.py)
-- [Stream order books and account state over websocket](examples/ws.py)
-- [Create / modify / cancel an order over HTTP](examples/create_modify_cancel_order_http.py)
-- [Create / modify / cancel an order over websocket](examples/create_modify_cancel_order_ws.py)
+- [Read public REST endpoints](examples/market-data/get_info.py)
+- [Stream order books and account state over websocket](examples/websocket/ws.py)
+- [Create / modify / cancel an order over HTTP](examples/orders/create_modify_cancel_order_http.py)
+- [Create / modify / cancel an order over websocket](examples/orders/create_modify_cancel_order_ws.py)
 - [System setup (API key, signer)](examples/system_setup.py)
 
 See [`examples/README.md`](examples/README.md) for the full annotated list.

examples/sub_account_create.py → examples/accounts/sub_account_create.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/sub_account_transfer_eth.py → examples/accounts/sub_account_transfer_eth.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 TO_ACCOUNT_INDEX = 281474976710648
 

examples/sub_account_transfer_usdc.py → examples/accounts/sub_account_transfer_usdc.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 TO_ACCOUNT_INDEX = 281474976710648
 

examples/send_batch_tx_http.py → examples/batch-orders/send_batch_tx_http.py

@@ -1,6 +1,6 @@
 import asyncio
 import time
-from utils import default_example_setup, trim_exception
+from examples.utils import default_example_setup, trim_exception
 
 
 # this example does the same thing as the send_batch_tx_ws.py example, but sends the TX over HTTP instead of WS

examples/send_batch_tx_ws.py → examples/batch-orders/send_batch_tx_ws.py

@@ -2,7 +2,7 @@
 import asyncio
 import time
 
-from utils import default_example_setup, ws_send_batch_tx, trim_exception
+from examples.utils import default_example_setup, ws_send_batch_tx, trim_exception
 
 
 # this example does the same thing as the send_batch_tx_http.py example, but sends the TX over WS instead of HTTP

examples/add_eth_margin.py → examples/margin/add_eth_margin.py

@@ -1,6 +1,6 @@
 import asyncio
 import lighter
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def fetch(api_client, idx):

examples/disable_eth_as_margin.py → examples/margin/disable_eth_as_margin.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/disable_uta.py → examples/margin/disable_uta.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/enable_eth_as_margin.py → examples/margin/enable_eth_as_margin.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/enable_uta.py → examples/margin/enable_uta.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/margin_eth_20x_cross_http.py → examples/margin/margin_eth_20x_cross_http.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/margin_eth_50x_isolate_ws.py → examples/margin/margin_eth_50x_isolate_ws.py

@@ -1,6 +1,6 @@
 import websockets
 import asyncio
-from utils import default_example_setup, ws_send_tx
+from examples.utils import default_example_setup, ws_send_tx
 
 
 async def main():

examples/margin_eth_add_collateral_http.py → examples/margin/margin_eth_add_collateral_http.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/margin_eth_remove_collateral_ws.py → examples/margin/margin_eth_remove_collateral_ws.py

@@ -1,6 +1,6 @@
 import asyncio
 import websockets
-from utils import default_example_setup, ws_send_tx
+from examples.utils import default_example_setup, ws_send_tx
 
 
 async def main():

examples/get_set_maker_only_api_keys.py → examples/market-data/get_set_maker_only_api_keys.py

@@ -1,5 +1,5 @@
 import asyncio, json, lighter
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 async def main():
     client, api_client, _ = default_example_setup()

examples/cancel_all_orders_single_market.py → examples/orders/cancel_all_orders_single_market.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 # Scope a cancel-all to a single market.

examples/create_grouped_ioc_with_attached_sl_tp.py → examples/orders/create_grouped_ioc_with_attached_sl_tp.py

@@ -1,6 +1,6 @@
 import asyncio
 from lighter.signer_client import CreateOrderTxReq
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/create_grouped_ioc_with_integrator.py → examples/orders/create_grouped_ioc_with_integrator.py

@@ -1,6 +1,6 @@
 import asyncio
 from lighter.signer_client import CreateOrderTxReq
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/create_grouped_orders_cliend_order_index.py → examples/orders/create_grouped_orders_cliend_order_index.py

@@ -1,7 +1,7 @@
 import asyncio
 import time
 from lighter.signer_client import CreateOrderTxReq
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 BASE_CID = int(time.time()) % (2 ** 48 - 10)
 

examples/create_market_order_async_client.py → examples/orders/create_market_order_async_client.py

@@ -1,7 +1,7 @@
 import asyncio
 
 import lighter
-from utils import get_api_key_config, trim_exception
+from examples.utils import get_api_key_config, trim_exception
 
 
 async def create_signer_for_user(config_file="./api_key_config.json"):

examples/create_market_order_eth_buy.py → examples/orders/create_market_order_eth_buy.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/create_market_order_eth_sell.py → examples/orders/create_market_order_eth_sell.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/create_market_order_max_slippage.py → examples/orders/create_market_order_max_slippage.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/create_market_order_quote_amount.py → examples/orders/create_market_order_quote_amount.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/create_modify_cancel_order_http.py → examples/orders/create_modify_cancel_order_http.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/create_modify_cancel_order_ws.py → examples/orders/create_modify_cancel_order_ws.py

@@ -1,6 +1,6 @@
 import websockets
 import asyncio
-from utils import default_example_setup, ws_send_tx
+from examples.utils import default_example_setup, ws_send_tx
 
 
 # this example does the same thing as the create_modify_cancel_order.py example, but sends the TX over WS instead of HTTP

examples/create_modify_cancel_skip_nonce.py → examples/orders/create_modify_cancel_skip_nonce.py

@@ -1,7 +1,7 @@
 import asyncio
 
 from lighter.nonce_manager import NonceManagerType
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/create_order_skip_nonce.py → examples/orders/create_order_skip_nonce.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/create_position_tied_sl_tp.py → examples/orders/create_position_tied_sl_tp.py

@@ -1,6 +1,6 @@
 import asyncio
 from lighter.signer_client import CreateOrderTxReq
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/create_with_multiple_keys.py → examples/orders/create_with_multiple_keys.py

@@ -1,6 +1,6 @@
 import time
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/self_trade_create_modify_order.py → examples/orders/self_trade_create_modify_order.py

@@ -1,6 +1,6 @@
 import asyncio
 import time
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 # Self-trade prevention (STP) on order creation / modification.

examples/self_trade_grouped_orders.py → examples/orders/self_trade_grouped_orders.py

@@ -1,6 +1,6 @@
 import asyncio
 from lighter.signer_client import CreateOrderTxReq
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 # Self-trade prevention applied to a grouped (OTOCO) order.

examples/public_pool_create_modify.py → examples/public-pool/public_pool_create_modify.py

@@ -2,7 +2,7 @@
 import json
 import asyncio
 import lighter
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/public_pool_deposit.py → examples/public-pool/public_pool_deposit.py

@@ -1,6 +1,6 @@
 import asyncio
 
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 POOL_ACCOUNT_INDEX = 281474976710651
 

examples/public_pool_info.py → examples/public-pool/public_pool_info.py

@@ -1,6 +1,6 @@
 import asyncio
 import lighter
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 POOL_ACCOUNT_INDEX = 281474976710651
 

examples/public_pool_withdraw.py → examples/public-pool/public_pool_withdraw.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 POOL_ACCOUNT_INDEX = 281474976710651
 

examples/stake_and_unstake.py → examples/public-pool/stake_and_unstake.py

@@ -1,6 +1,6 @@
 import asyncio
 
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 STAKING_POOL_INDEX = 281474976624800
 

examples/spot_get_account_assets_http.py → examples/spot/spot_get_account_assets_http.py

@@ -1,7 +1,7 @@
 import logging
 import asyncio
 import lighter
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 async def main():

examples/spot_get_account_assets_ws.py → examples/spot/spot_get_account_assets_ws.py

@@ -4,7 +4,7 @@
 import websockets
 
 from lighter.models import WSAccountAssets
-from utils import default_example_setup, ws_subscribe, ws_ping
+from examples.utils import default_example_setup, ws_subscribe, ws_ping
 
 
 async def consume_messages(ws):

examples/spot_get_order_books.py → examples/spot/spot_get_order_books.py

@@ -2,7 +2,7 @@
 import asyncio
 import lighter
 from lighter import Asset
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 # This example shows how to fetch order books and assets details
 # This information should be enough to be able to trade on Lighter

examples/spot_self_transfer_perp_spot.py → examples/spot/spot_self_transfer_perp_spot.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 async def main():
     client, api_client, _ = default_example_setup()

examples/spot_self_transfer_spot_perp.py → examples/spot/spot_self_transfer_spot_perp.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 
 

examples/transfer.py → examples/transfers/transfer.py

@@ -1,6 +1,6 @@
 import asyncio
 import lighter
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 ETH_PRIVATE_KEY = "1234567812345678123456781234567812345678123456781234567812345678"
 TO_ACCOUNT_INDEX = 9

examples/transfer_same_master_account.py → examples/transfers/transfer_same_master_account.py

@@ -1,6 +1,6 @@
 import asyncio
 import lighter
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 TO_ACCOUNT_INDEX = 281474976710648 # same master account
 

examples/withdraw_fast.py → examples/transfers/withdraw_fast.py

@@ -1,7 +1,7 @@
 import asyncio
 import json
 import lighter
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 ETH_PRIVATE_KEY = "1234567812345678123456781234567812345678123456781234567812345678"
 WITHDRAW_ADDRESS = "0x0000..."

examples/withdraw_normal.py → examples/transfers/withdraw_normal.py

@@ -1,5 +1,5 @@
 import asyncio
-from utils import default_example_setup
+from examples.utils import default_example_setup
 
 AMOUNT = 5.0