v1.0.11: add withdraw and withdrawTo [BAC-1607] (#58)

* add withdraw and withdrawTo

* update test

Author: samweinberg23

dydx3/modules/eth.py

@@ -301,6 +301,73 @@ def deposit_to_exchange(
             options=send_options,
         )
 
+    def withdraw(
+        self,
+        stark_public_key=None,
+        send_options=None,
+    ):
+        '''
+        Withdraw from exchange.
+
+        :param stark_public_key: optional
+        :type stark_public_key: string
+
+        :param send_options: optional
+        :type send_options: dict
+
+        :returns: transactionHash
+
+        :raises: ValueError
+        '''
+        stark_public_key = stark_public_key or self.stark_public_key
+        if stark_public_key is None:
+            raise ValueError('No stark_public_key was provided')
+
+        contract = self.get_exchange_contract()
+        return self.send_eth_transaction(
+            method=contract.functions.withdraw(
+                int(stark_public_key, 16),
+                COLLATERAL_ASSET_ID_BY_NETWORK_ID[self.network_id],
+            ),
+            options=send_options,
+        )
+
+    def withdraw_to(
+        self,
+        recipient,
+        stark_public_key=None,
+        send_options=None,
+    ):
+        '''
+        Withdraw from exchange to address.
+
+        :param recipient: required
+        :type recipient: string
+
+        :param stark_public_key: optional
+        :type stark_public_key: string
+
+        :param send_options: optional
+        :type send_options: dict
+
+        :returns: transactionHash
+
+        :raises: ValueError
+        '''
+        stark_public_key = stark_public_key or self.stark_public_key
+        if stark_public_key is None:
+            raise ValueError('No stark_public_key was provided')
+
+        contract = self.get_exchange_contract()
+        return self.send_eth_transaction(
+            method=contract.functions.withdrawTo(
+                int(stark_public_key, 16),
+                COLLATERAL_ASSET_ID_BY_NETWORK_ID[self.network_id],
+                recipient,
+            ),
+            options=send_options,
+        )
+
     def transfer_eth(
         self,
         to_address=None,  # Require keyword args to avoid confusing the amount.

integration_tests/test_integration.py

@@ -355,3 +355,47 @@ def test_integration(self):
             client_id='mock-client-id',
             expiration_epoch_seconds=expiration_epoch_seconds,
         )
+
+        # Send an on-chain withdraw.
+        withdraw_tx_hash = client.eth.withdraw()
+        print('Waiting for withdraw...')
+        client.eth.wait_for_tx(withdraw_tx_hash)
+        print('...done.')
+
+        # Wait for the withdraw to be processed.
+        print('Waiting for withdraw to be processed on dYdX...')
+        wait_for_condition(
+            lambda: len(client.private.get_transfers()['transfers']) > 0,
+            True,
+            60,
+        )
+        print('...transfer was recorded, waiting for confirmation...')
+        wait_for_condition(
+            lambda: client.private.get_account()['account']['quoteBalance'],
+            '2',
+            180,
+        )
+        print('...done.')
+
+        # Send an on-chain withdraw_to.
+        withdraw_to_tx_hash = client.eth.withdraw_to(
+            recipient=ethereum_address,
+        )
+        print('Waiting for withdraw_to...')
+        client.eth.wait_for_tx(withdraw_to_tx_hash)
+        print('...done.')
+
+        # Wait for the withdraw_to to be processed.
+        print('Waiting for withdraw_to to be processed on dYdX...')
+        wait_for_condition(
+            lambda: len(client.private.get_transfers()['transfers']) > 0,
+            True,
+            60,
+        )
+        print('...transfer was recorded, waiting for confirmation...')
+        wait_for_condition(
+            lambda: client.private.get_account()['account']['quoteBalance'],
+            '2',
+            180,
+        )
+        print('...done.')

setup.py

@@ -19,7 +19,7 @@
 
 setup(
     name='dydx-v3-python',
-    version='1.0.10',
+    version='1.0.11',
     packages=find_packages(),
     package_data={
         'dydx3': [