create crosschain api

Author: mncdg

meta_aggregation_api/models/chain.py

@@ -1,4 +1,3 @@
-from abc import ABC, abstractmethod
 from typing import Optional
 
 from pydantic import BaseModel, conint, constr
@@ -33,50 +32,3 @@ class ProvidersConfigModel(BaseModel):
 class AllProvidersConfigModel(ProvidersConfigModel, BaseModel):
  chain_id: Optional[int] = None
 
-
-class ChainSwapInfo(ABC):
-
- def __init__(self, chain_id: int):
- self._chain_id = chain_id
-
- @abstractmethod
- async def get_type(self) -> str:
- """
- Args:
- self: Access the class attributes
-
- Returns:
- A cross_chain or single_chain
- """
-
- @property
- def chain_id(self):
- return self._chain_id
-
-
-class SingleChainSwapInfo(ChainSwapInfo):
-
- def __init__(self, chain_id: int):
- super().__init__(chain_id)
-
- def get_type(self) -> str:
- return 'single_chain'
-
-
-class CrossChainSwapInfo(ChainSwapInfo):
- def __init__(self, give_chain_id: int, take_chain_id: int):
- super().__init__(give_chain_id)
- self._give_chain_id = give_chain_id
- self._take_chain_id = take_chain_id
-
- def get_type(self) -> str:
- return 'cross_chain'
-
- @property
- def give_chain_id(self) -> int:
- return self._give_chain_id
-
- @property
- def take_chain_id(self) -> int:
- return self._take_chain_id
-

meta_aggregation_api/providers/__init__.py

@@ -1,18 +1,20 @@
 from typing import TypeVar
 
+from meta_aggregation_api.providers.base_crosschain_provider import CrossChainProvider
 from meta_aggregation_api.providers.base_provider import BaseProvider
 
 T = TypeVar("T")
 
 
 class ProviderRegistry:
- def __init__(self, *providers: BaseProvider):
+ def __init__(self, *providers: BaseProvider | CrossChainProvider):
  self.provider_by_name = {
  provider.PROVIDER_NAME: provider for provider in providers
  }
 
- def __getitem__(self, provider_name: str) -> BaseProvider:
+ def __getitem__(self, provider_name: str) -> BaseProvider | CrossChainProvider:
  return self.provider_by_name[provider_name]
 
- def get(self, provider_name: str, default: T = None) -> BaseProvider | T:
+ def get(self, provider_name: str,
+ default: T = None) -> BaseProvider | CrossChainProvider | T:
  return self.provider_by_name.get(provider_name, default)

meta_aggregation_api/providers/base_crosschain_provider.py

@@ -0,0 +1,115 @@
+import asyncio
+from abc import ABC, abstractmethod
+from typing import Optional
+
+import aiohttp
+from pydantic import ValidationError
+
+from meta_aggregation_api.clients.apm_client import ApmClient
+from meta_aggregation_api.config import Config
+from meta_aggregation_api.models.meta_agg_models import (
+ ProviderPriceResponse,
+ ProviderQuoteResponse,
+)
+from meta_aggregation_api.utils.errors import (
+ BaseAggregationProviderError,
+ ParseResponseError,
+ ProviderTimeoutError,
+)
+from meta_aggregation_api.utils.logger import capture_exception
+
+
+class CrossChainProvider(ABC):
+ PROVIDER_NAME = 'base_crosschain_provider'
+ REQUEST_TIMEOUT = 7
+
+ def __init__(
+ self,
+ session: aiohttp.ClientSession,
+ config: Config,
+ apm_client: ApmClient,
+ **_,
+ ):
+ self.apm_client = apm_client
+ self.aiohttp_session = session
+ self.config = config
+
+ @abstractmethod
+ async def get_swap_quote(
+ self,
+ buy_token: str,
+ sell_token: str,
+ sell_amount: int,
+ chain_id_from: int,
+ chain_id_to: int,
+ taker_address: str,
+ gas_price: Optional[int] = None,
+ slippage_percentage: Optional[float] = None,
+ fee_recipient: Optional[str] = None,
+ buy_token_percentage_fee: Optional[float] = None,
+ ) -> ProviderQuoteResponse:
+ """
+ The get_swap_quote function is used to get the data for a swap from the provider.
+ Args:
+ self: Access the class attributes
+ buy_token:str: Token is being buy
+ sell_token:str: Token is being sold
+ sell_amount:int: Amount of sell_token to sell
+ chain_id_from:int: Specify the chain on which the transaction will be executed, a chain where the cross-chain swap will start
+ chain_id_to:int: chain where the cross-chain swap will finish
+ taker_address:str: Address who makes the transaction and will receive tokens
+ gas_price:Optional[int]=None: Specify the gas price for the transaction
+ slippage_percentage:Optional[float]=None: Specify the percentage of slippage to apply to the quote
+ fee_recipient:Optional[str]=None: Address who will receive the fee
+ buy_token_percentage_fee:Optional[float]=None: Percentage of the buy_token fee that will be paid to the fee_recipient
+
+ Returns:
+ A ProviderQuoteResponse object with the data for the swap. Check return type for more info.
+ """
+
+ @abstractmethod
+ async def get_swap_price(
+ self,
+ buy_token: str,
+ sell_token: str,
+ sell_amount: int,
+ chain_id_from: int,
+ chain_id_to: int,
+ gas_price: Optional[int] = None,
+ slippage_percentage: Optional[float] = None,
+ taker_address: Optional[str] = None,
+ fee_recipient: Optional[str] = None,
+ buy_token_percentage_fee: Optional[float] = None,
+ ) -> ProviderPriceResponse:
+ """
+ The get_swap_price function is used to find the best price for a swap from the provider.
+ It doesn't require the taker_address to be specified.
+ Args:
+ self: Access the class attributes
+ buy_token:str: Token is being buy
+ sell_token:str: Token is being sold
+ sell_amount:int: Amount of sell_token to sell
+ chain_id_from:int: Specify the chain on which the transaction will be executed, a chain where the cross-chain swap will start
+ chain_id_to:int: chain where the cross-chain swap will finish
+ gas_price:Optional[int]=None: Specify the gas price for the transaction
+ slippage_percentage:Optional[float]=None: Specify the percentage of slippage to apply to the quote
+ taker_address:Optional[str]=None: Address who makes the transaction and will receive tokens
+ fee_recipient:Optional[str]=None: Address who will receive the fee
+ buy_token_percentage_fee:Optional[float]=None: Percentage of the buy_token fee that will be paid to the fee_recipient
+
+ Returns:
+ A ProviderPriceResponse object with the price for the swap. Check return type for more info.
+ """
+
+ def handle_exception(
+ self, exception: Exception, **kwargs
+ ) -> BaseAggregationProviderError:
+ capture_exception(self.apm_client)
+ if isinstance(exception, (KeyError, ValidationError)):
+ exc = ParseResponseError(self.PROVIDER_NAME, str(exception), **kwargs)
+ return exc
+ if isinstance(
+ exception, (aiohttp.ServerDisconnectedError, asyncio.TimeoutError)
+ ):
+ exc = ProviderTimeoutError(self.PROVIDER_NAME, str(exception), **kwargs)
+ return exc

meta_aggregation_api/providers/base_provider.py

@@ -7,7 +7,6 @@
 
 from meta_aggregation_api.clients.apm_client import ApmClient
 from meta_aggregation_api.config import Config
-from meta_aggregation_api.models.chain import ChainSwapInfo
 from meta_aggregation_api.models.meta_agg_models import (
  ProviderPriceResponse,
  ProviderQuoteResponse,
@@ -41,7 +40,7 @@ async def get_swap_quote(
  buy_token: str,
  sell_token: str,
  sell_amount: int,
- chain_info: ChainSwapInfo,
+ chain_id: int,
  taker_address: str,
  gas_price: Optional[int] = None,
  slippage_percentage: Optional[float] = None,
@@ -55,7 +54,7 @@ async def get_swap_quote(
  buy_token:str: Token is being buy
  sell_token:str: Token is being sold
  sell_amount:int: Amount of sell_token to sell
- chain_info:ChainSwapInfo: Information about chains to execute transaction
+ chain_id:int: Specify the chain on which the transaction will be executed
  taker_address:str: Address who makes the transaction and will receive tokens
  gas_price:Optional[int]=None: Specify the gas price for the transaction
  slippage_percentage:Optional[float]=None: Specify the percentage of slippage to apply to the quote
@@ -72,7 +71,7 @@ async def get_swap_price(
  buy_token: str,
  sell_token: str,
  sell_amount: int,
- chain_info: ChainSwapInfo,
+ chain_id: int,
  gas_price: Optional[int] = None,
  slippage_percentage: Optional[float] = None,
  taker_address: Optional[str] = None,
@@ -87,7 +86,7 @@ async def get_swap_price(
  buy_token:str: Token is being buy
  sell_token:str: Token is being sold
  sell_amount:int: Amount of sell_token to sell
- chain_info:ChainSwapInfo: Information about chains to execute transaction
+ chain_id:int: Specify the chain on which the transaction will be executed
  gas_price:Optional[int]=None: Specify the gas price for the transaction
  slippage_percentage:Optional[float]=None: Specify the percentage of slippage to apply to the quote
  taker_address:Optional[str]=None: Address who makes the transaction and will receive tokens

meta_aggregation_api/providers/debridge_dln_v1/debridge_dln_provider_v1.py

@@ -10,13 +10,12 @@
 from aiohttp import ClientResponse, ClientResponseError, ServerDisconnectedError
 from pydantic import ValidationError
 
-from meta_aggregation_api.models.chain import CrossChainSwapInfo
 from meta_aggregation_api.models.meta_agg_models import (
  ProviderPriceResponse,
  ProviderQuoteResponse,
 )
 from meta_aggregation_api.models.provider_response_models import SwapSources
-from meta_aggregation_api.providers.base_provider import BaseProvider
+from meta_aggregation_api.providers.base_crosschain_provider import CrossChainProvider
 from meta_aggregation_api.utils.errors import (
  AggregationProviderError,
  BaseAggregationProviderError,
@@ -26,10 +25,10 @@
 logger = get_logger(__name__)
 
 
-class DebridgeDlnProviderV1(BaseProvider):
+class DebridgeDlnProviderV1(CrossChainProvider):
  """https://docs.debridge.finance"""
 
- TRADING_API = os.environ.get('DEBRIDGE_TRADING_API', 'https://api.dln.trade/v1.0/dln')
+ TRADING_API = os.environ.get('DEBRIDGE_TRADING_API', 'https://api.dln.trade/v1.0/dln/order')
  ORDER_API = os.environ.get('DEBRIDGE_ORDER_API', 'https://dln-api.debridge.finance/api')
 
  with open(Path(__file__).parent / 'config.json') as f:
@@ -90,15 +89,14 @@ async def get_swap_price(
  buy_token: str,
  sell_token: str,
  sell_amount: int,
- chain_info: CrossChainSwapInfo,
+ chain_id_from: int,
+ chain_id_to: int,
  gas_price: Optional[int] = None,
  slippage_percentage: Optional[float] = 1,
  taker_address: Optional[str] = None,
  fee_recipient: Optional[str] = None,
  buy_token_percentage_fee: Optional[float] = None,
  ):
- give_chain_id = chain_info.give_chain_id
- take_chain_id = chain_info.take_chain_id
  if buy_token.lower() == self.config.NATIVE_TOKEN_ADDRESS:
  buy_token = '0x0000000000000000000000000000000000000000'
 
@@ -107,10 +105,10 @@ async def get_swap_price(
 
  url = '%s/quote' % (self.TRADING_API)
  params = {
- 'srcChainId': give_chain_id,
+ 'srcChainId': chain_id_from,
  'srcChainTokenIn': sell_token,
  'srcChainTokenInAmount': sell_amount,
- 'dstChainId': take_chain_id,
+ 'dstChainId': chain_id_to,
  'dstChainTokenOut': buy_token,
  'affiliateFeePercent': 0,
  'prependOperatingExpenses': 'false',
@@ -123,8 +121,8 @@ async def get_swap_price(
  ServerDisconnectedError,
  ) as e:
  exc = self.handle_exception(
- e, params=params, token_address=sell_token, give_chain_id=give_chain_id,
- take_chain_id=take_chain_id
+ e, params=params, token_address=sell_token, give_chain_id=chain_id_from,
+ take_chain_id=chain_id_to
  )
  raise exc
  return self._convert_response_from_swap_price(response)
@@ -134,35 +132,32 @@ async def get_swap_quote(
  buy_token: str,
  sell_token: str,
  sell_amount: int,
- chain_info: CrossChainSwapInfo,
+ chain_id_from: int,
+ chain_id_to: int,
  taker_address: str,
  gas_price: Optional[int] = None,
  slippage_percentage: Optional[float] = None,
  fee_recipient: Optional[str] = None,
  buy_token_percentage_fee: Optional[float] = None,
  ) -> ProviderQuoteResponse:
- give_chain_id = chain_info.give_chain_id
- take_chain_id = chain_info.take_chain_id
  if buy_token.lower() == self.config.NATIVE_TOKEN_ADDRESS:
  buy_token = '0x0000000000000000000000000000000000000000'
 
  if sell_token.lower() == self.config.NATIVE_TOKEN_ADDRESS:
  sell_token = '0x0000000000000000000000000000000000000000'
 
- url = '%s/createOrder' % (self.TRADING_API)
+ url = '%s/create-tx' % (self.TRADING_API)
  params = {
- 'srcChainId': give_chain_id,
+ 'srcChainId': chain_id_from,
  'srcChainTokenIn': sell_token,
  'srcChainTokenInAmount': sell_amount,
- 'dstChainId': take_chain_id,
+ 'dstChainId': chain_id_to,
  'dstChainTokenOut': buy_token,
  'affiliateFeePercent': 0,
  'dstChainTokenOutAmount': 'auto',
+ 'srcChainOrderAuthorityAddress': taker_address,
  'dstChainTokenOutRecipient': taker_address,
- 'srcChainRefundAddress': taker_address,
  'dstChainOrderAuthorityAddress': taker_address,
- 'senderAddress': taker_address,
- 'enableEstimate': 'true',
  }
 
  try:
@@ -173,7 +168,7 @@ async def get_swap_quote(
  ServerDisconnectedError,
  ) as e:
  exc = self.handle_exception(
- e, params=params, token_address=sell_token, chain_id=chain_info.chain_id
+ e, params=params, token_address=sell_token, chain_id=chain_id_from
  )
  raise exc
  return self._convert_response_from_swap_quote(response)
@@ -224,7 +219,7 @@ def _convert_response_from_swap_quote(
  buy_amount=estimation['dstChainTokenOut']['amount'],
  sell_amount=estimation['srcChainTokenIn']['amount'],
  gas_price=0,
- gas=tx['gasLimit'],
+ gas=0,
  value=tx['value'],
  price=str(price),
  data=tx['data'],