Merge pull request #20 from TransposeData/dev

refactor: rename swaps_by_token to swaps_by_contract_address

Author: Jon-Becker

docs/token.md

@@ -137,7 +137,7 @@ The **Token Transfer Model** represents a single token transfer. The **Token Tra
 | ----------------------------------------------------------------------------------------------- | -------------------------------- | ------------ |
 | `token.swaps(occurred_after, occurred_before, order, limit)`                                    | `GET /v0/token/swaps`            | `List[Swap]` |
 | `token.swaps_by_account(account_address, occurred_after, occurred_before, order, limit)`        | `GET /v0/token/swaps-by-account` | `List[Swap]` |
-| `token.swaps_by_token(token_address, direction, occurred_after, occurred_before, order, limit)` | `GET /v0/token/swaps-by-token`   | `List[Swap]` |
+| `token.swaps_by_contract_address(token_address, direction, occurred_after, occurred_before, order, limit)` | `GET /v0/token/swaps-by-token`   | `List[Swap]` |
 | `token.swaps_by_pair(token_one, token_two occurred_after, occurred_before, order, limit)`       | `GET /v0/token/swaps-by-pair`    | `List[Swap]` |
 
 ### Token Swap Model

tests/test_token_swaps_by_token.py …/test_token_swaps_by_contract_address.pytests/test_token_swaps_by_token.py renamed to tests/test_token_swaps_by_contract_address.py tests/test_token_swaps_by_token.py renamed to tests/test_token_swaps_by_contract_address.py

@@ -4,7 +4,7 @@ def test_basic():
     try:
         api = Transpose(api_key)
 
-        swaps = api.token.swaps_by_token(token_address='0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2')
+        swaps = api.token.swaps_by_contract_address(contract_address='0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2')
 
         assert len(swaps) >= 1
 
@@ -15,7 +15,7 @@ def test_cursor():
     try:
         api = Transpose(api_key)
 
-        swaps = api.token.swaps_by_token(token_address='0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2', occurred_after='2019-01-01 00:00:00')
+        swaps = api.token.swaps_by_contract_address(contract_address='0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2', occurred_after='2019-01-01 00:00:00')
 
         assert len(swaps) >= 1
         assert api._next != None
@@ -31,7 +31,7 @@ def test_range():
     try:
         api = Transpose(api_key)
 
-        swaps = api.token.swaps_by_token(token_address='0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2', occurred_after='2019-01-01 00:00:00', occurred_before='2023-01-01 00:00:00')
+        swaps = api.token.swaps_by_contract_address(contract_address='0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2', occurred_after='2019-01-01 00:00:00', occurred_before='2023-01-01 00:00:00')
 
         assert len(swaps) >= 1
         assert all(swap.from_token == '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2' or swap.to_token == '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2' for swap in swaps)

transpose/src/api/constants.py

@@ -94,6 +94,6 @@
     # Swap Endpoints
     'swaps':                                  'https://api.transpose.io/v0/token/swaps',
     'swaps_by_account':                       'https://api.transpose.io/v0/token/swaps-by-account',
-    'swaps_by_token':                         'https://api.transpose.io/v0/token/swaps-by-token',
+    'swaps_by_contract_address':              'https://api.transpose.io/v0/token/swaps-by-contract-address',
     'swaps_by_pair':                          'https://api.transpose.io/v0/token/swaps-by-pair',
 }

…anspose/src/api/token/_swaps_by_token.py …/api/token/_swaps_by_contract_address.pytranspose/src/api/token/_swaps_by_token.py renamed to transpose/src/api/token/_swaps_by_contract_address.py transpose/src/api/token/_swaps_by_token.py renamed to transpose/src/api/token/_swaps_by_contract_address.py

@@ -1,12 +1,12 @@
 from ..constants import TOKEN_API_ENDPOINTS
 
-def _swaps_by_token  (token_address: str,
+def _swaps_by_contract_address  (contract_address: str,
                       direction: str='all',
                       occurred_after: int or str='1970-01-01T00:00:00',
                       occurred_before: int or str='2050-01-01T00:00:00',
                       order: str='asc',
                       limit: int=10) -> str:
 
-    base_url = '{}?token_address={}&direction={}&occurred_after={}&occurred_before={}&order={}&limit={}'.format(TOKEN_API_ENDPOINTS['swaps_by_token'], token_address, direction, occurred_after, occurred_before, order, limit)
+    base_url = '{}?contract_address={}&direction={}&occurred_after={}&occurred_before={}&order={}&limit={}'.format(TOKEN_API_ENDPOINTS['swaps_by_contract_address'], contract_address, direction, occurred_after, occurred_before, order, limit)
 
     return base_url

transpose/src/api/token/base.py

@@ -3,13 +3,13 @@
 from ._transfers import _transfers
 from ._swaps_by_pair import _swaps_by_pair
 from ._tokens_by_name import _tokens_by_name
-from ._swaps_by_token import _swaps_by_token
 from ._tokens_by_owner import _tokens_by_owner
 from ._swaps_by_account import _swaps_by_account
 from ._tokens_by_symbol import _tokens_by_symbol
 from ._transfers_by_account import _transfers_by_account
 from ._tokens_by_date_created import _tokens_by_date_created
 from ._native_token_transfers import _native_token_transfers
+from ._swaps_by_contract_address import _swaps_by_contract_address
 from ._tokens_by_contract_address import _tokens_by_contract_address
 from ._owners_by_contract_address import _owners_by_contract_address
 from ._transfers_by_contract_address import _transfers_by_contract_address
@@ -151,16 +151,16 @@ def swaps_by_account(self,
                         limit: int=10) -> List[Swap]:
         return self.super.perform_authorized_request(Swap, _swaps_by_account(account_address, occurred_after, occurred_before, order, limit))
 
-    # Get Swaps by Token
-    # https://api.transpose.io/v0/token/swaps-by-token
-    def swaps_by_token (self,
-                        token_address: str = None,
-                        direction: str = 'all',
-                        occurred_after: int or str='1970-01-01T00:00:00',
-                        occurred_before: int or str='2050-01-01T00:00:00',
-                        order: str='asc',
-                        limit: int=10) -> List[Swap]:
-        return self.super.perform_authorized_request(Swap, _swaps_by_token(token_address, direction, occurred_after, occurred_before, order, limit))
+    # Get Swaps by Contract Address
+    # https://api.transpose.io/v0/token/swaps-by-contract-address
+    def swaps_by_contract_address (self,
+                                    contract_address: str = None,
+                                    direction: str = 'all',
+                                    occurred_after: int or str='1970-01-01T00:00:00',
+                                    occurred_before: int or str='2050-01-01T00:00:00',
+                                    order: str='asc',
+                                    limit: int=10) -> List[Swap]:
+        return self.super.perform_authorized_request(Swap, _swaps_by_contract_address(contract_address, direction, occurred_after, occurred_before, order, limit))
 
     # Get Swaps by Pair
     # https://api.transpose.io/v0/token/swaps-by-pair