transfer notes and cleanup

Author: alexvelea

examples/README.md

@@ -103,6 +103,13 @@ Examples on how to do this can be found here:
 - `spot_get_account_assets_http.py`
 - `spot_get_account_assets_ws.py`
 
+Moving money to / from subaccounts is possible for spot assets. 
+For USDC, you can move directly from main perp balance to subaccount spot balance, for example.
+More details can be found in the following example:
+- `sub_account_create.py`
+- `sub_account_transfer_eth.py`
+- `sub_account_transfer_usdc.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:
@@ -118,6 +125,33 @@ If you want to deposit / withdraw from a public pool, check the following exampl
 To get information about pools, check:
 - `public_pool_info.py`
 
+## Moving funds around
+- `withdraw_fast.py`
+  - send USDC directly from Lighter to Arbitrum
+- `withdraw_normal.py`
+  - send USDC/ETH from Lighter to Ethereum
+- `transfer.py`
+  - generic example of how to transfer funds between accounts.
+  - same functionality as `sub_account_transfer_eth` and `sub_account_transfer_usdc`
+
+## Transfer Notes
+The `memo` field is a user message, and it has to be exactly 32 bytes long. In case of fast withdrawals, you need to specify the recipient in the memo.  
+This is the case since the memo is part of the signature. This way, the recipient is verified.   
+
+When calling `client.transfer`, you pass the amount without needing to worry about the decimals.   
+When calling `client.sign_transfer` on the other hand, you need to specify the decimals and pass an integer.  
+
+The `fee` field can be obtained by calling `info_api.transfer_fee_info(...)`. The field can be passed as it is.  
+Transfers between subaccounts are free for all assets.
+
+When sending assets, you can specify the source and destination routes.  
+A route is either `perp` or `spot`. You can send USDC directly from your perp balance to another person's spot balance.  
+If you receive USDC in your perp account, it will be instantly used as collateral for open positions.  
+This also allows you to move USDC from your spot balance to your perp balance.  
+Spot assets (like ETH) need to have both the from and to route set to `spot`. 
+You can get all `asset_id`s by following the example below: 
+- `spot_get_order_books.py`
+
 ## Setup steps for mainnet
 - deposit money on Lighter to create an account first
 - change the URL to `mainnet.zklighter.elliot.ai`

examples/spot_self_transfer_perp_spot.py

@@ -12,7 +12,7 @@ async def main():
         print(f"CheckClient error: {err}")
         return
 
-    memo = "a"*32  # memo is a user message, and it has to be exactly 32 bytes long
+    # You can find more notes on transfers in the README.md file, under `Transfer Notes`
     transfer_tx, response, err = await client.transfer(
         ETH_PRIVATE_KEY,
         to_account_index=client.account_index,
@@ -21,7 +21,7 @@ async def main():
         route_from=client.ROUTE_PERP,
         route_to=client.ROUTE_SPOT,
         fee=0,
-        memo=memo,
+        memo="0x" + "00" * 32,
     )
     if err is not None:
        raise Exception(f"error transferring {err}")

examples/spot_self_transfer_spot_perp.py

@@ -12,7 +12,7 @@ async def main():
         print(f"CheckClient error: {err}")
         return
 
-    memo = "a"*32  # memo is a user message, and it has to be exactly 32 bytes long
+    # You can find more notes on transfers in the README.md file, under `Transfer Notes`
     transfer_tx, response, err = await client.transfer(
         ETH_PRIVATE_KEY,
         to_account_index=client.account_index,
@@ -21,7 +21,7 @@ async def main():
         route_from=client.ROUTE_SPOT,
         route_to=client.ROUTE_PERP,
         fee=0,
-        memo=memo,
+        memo="0x" + "00" * 32,
     )
     if err is not None:
        raise Exception(f"error transferring {err}")

examples/sub_account_create.py

@@ -1,5 +1,4 @@
 import asyncio
-import lighter
 from utils import default_example_setup
 
 

examples/sub_account_transfer_eth.py

@@ -1,5 +1,4 @@
 import asyncio
-import lighter
 from utils import default_example_setup
 
 ETH_PRIVATE_KEY = "1234567812345678123456781234567812345678123456781234567812345678"
@@ -13,9 +12,7 @@ async def main():
         print(f"CheckClient error: {err}")
         return
 
-    memo = "a"*32  # memo is a user message, and it has to be exactly 32 bytes long
-
-    # Note: For ETH transfers, the only acceptable route is SPOT -> SPOT
+    # You can find more notes on transfers in the README.md file, under `Transfer Notes`
     transfer_tx, response, err = await client.transfer(
         ETH_PRIVATE_KEY,
         to_account_index=TO_ACCOUNT_INDEX,
@@ -24,7 +21,7 @@ async def main():
         route_from=client.ROUTE_SPOT,
         route_to=client.ROUTE_SPOT,
         fee=0,
-        memo=memo,
+        memo="0x" + "00" * 32,
     )
     if err is not None:
        raise Exception(f"error transferring {err}")

examples/sub_account_transfer_usdc.py

@@ -1,5 +1,4 @@
 import asyncio
-import lighter
 from utils import default_example_setup
 
 ETH_PRIVATE_KEY = "1234567812345678123456781234567812345678123456781234567812345678"
@@ -13,10 +12,7 @@ async def main():
         print(f"CheckClient error: {err}")
         return
 
-    memo = "a"*32  # memo is a user message, and it has to be exactly 32 bytes long
-
-    # Note: You can transfer USDC from the main account to the subaccount, both from the spot and from the perp balance.
-    # For the subaccount, you can receive it either in the spot or the perp balance (will be instantly used as collateral for open positions).
+    # You can find more notes on transfers in the README.md file, under `Transfer Notes`
     transfer_tx, response, err = await client.transfer(
         ETH_PRIVATE_KEY,
         to_account_index=TO_ACCOUNT_INDEX,
@@ -25,7 +21,7 @@ async def main():
         route_from=client.ROUTE_PERP,
         route_to=client.ROUTE_SPOT,
         fee=0,
-        memo=memo,
+        memo="0x" + "00" * 32,
     )
     if err is not None:
        raise Exception(f"error transferring {err}")

examples/transfer.py

@@ -2,37 +2,36 @@
 import lighter
 from utils import default_example_setup
 
+ETH_PRIVATE_KEY = "1234567812345678123456781234567812345678123456781234567812345678"
 TO_ACCOUNT_INDEX = 9
-ETH_PRIVATE_KEY = "0x..."
 
 
 async def main():
     client, api_client, _ = default_example_setup()
     info_api = lighter.InfoApi(api_client)
 
-    auth_token, _ = client.create_auth_token_with_expiry()
-    fee_info = await info_api.transfer_fee_info(client.account_index, authorization=auth_token, auth=auth_token, to_account_index=TO_ACCOUNT_INDEX)
-    print(fee_info)
+    auth_token, err = client.create_auth_token_with_expiry()
+    if err:
+        raise Exception(f"Auth token failed: {err}")
 
-    err = client.check_client()
-    if err is not None:
-        print(f"CheckClient error: {err}")
-        return
+    fee_info = await info_api.transfer_fee_info(client.account_index, authorization=auth_token, auth=auth_token, to_account_index=TO_ACCOUNT_INDEX)
 
-    memo = "a"*32  # memo is a user message, and it has to be exactly 32 bytes long
+    # You can find more notes on transfers in the README.md file, under `Transfer Notes`
     transfer_tx, response, err = await client.transfer(
-        ETH_PRIVATE_KEY,
-        usdc_amount=100,  # decimals are added by sdk
+        eth_private_key=ETH_PRIVATE_KEY,
         to_account_index=TO_ACCOUNT_INDEX,
+        asset_id=client.ASSET_ID_USDC,
+        route_from=client.ROUTE_PERP,
+        route_to=client.ROUTE_PERP,
+        amount=5,  # decimals are added by sdk
         fee=fee_info.transfer_fee_usdc,
-        memo=memo,
+        memo="0x" + "00" * 32,
     )
     if err is not None:
-       raise Exception(f"error transferring {err}")
+        raise Exception(f"error transferring {err}")
+
     print(transfer_tx, response)
 
-    lev_tx, response, err = await client.update_leverage(4, client.CROSS_MARGIN_MODE, 3)
-    print(lev_tx, response, err)
 
 if __name__ == "__main__":
-    asyncio.run(main())
+    asyncio.run(main())

examples/withdraw_fast.py

@@ -1,8 +1,3 @@
-#!/usr/bin/env python3
-"""
-Fast Withdraw - Instant withdrawal from Lighter L2 to Arbitrum
-"""
-
 import asyncio
 import json
 import lighter