Class PegasysTrade

Abstract class for all instant trade providers' trades.

Hierarchy

UniswapV2AbstractTrade
- PegasysTrade

Index

Constructors

Constructors

constructor

new PegasysTrade(tradeStruct: UniswapV2TradeStruct, providerAddress: string): PegasysTrade
Parameters
- tradeStruct: UniswapV2TradeStruct
- providerAddress: string
Returns PegasysTrade
Inherited from UniswapV2AbstractTrade.constructor
- Defined in src/features/on-chain/calculation-manager/providers/dexes/common/uniswap-v2-abstract/uniswap-v2-abstract-trade.ts:137

Properties

`Readonly` deadlineMinutes

deadlineMinutes: number

Deadline for transaction in minutes.

`Readonly` dexContractAddress

dexContractAddress: "0x017dAd2578372CAEE5c6CddfE35eEDB3728544C4" = PEGASYS_CONTRACT_ADDRESS

`Readonly` exact

exact: Exact

Defines, whether to call 'exactInput' or 'exactOutput' method.

`Readonly` feeInfo

feeInfo: FeeInfo

`Readonly` from

from: PriceTokenAmount<EvmBlockchainName>

Token to sell with input amount.

`Readonly` gasFeeInfo

gasFeeInfo: null | GasFeeInfo

Gas fee info, including gas limit and gas price.

`Readonly` path

path: readonly Token<BlockchainName>[]

`Readonly` permit2ApproveConfig

permit2ApproveConfig: Permit2ApproveConfig = ...

Filled if approve goes through permit2 contract

`Readonly` routPoolInfo

routPoolInfo: undefined | AerodromeRoutePoolArgument[]

`Readonly` slippageTolerance

slippageTolerance: number

`Readonly` to

to: PriceTokenAmount<EvmBlockchainName>

Token to get with output amount.

`Readonly` useProxy

useProxy: boolean

True, if trade must be swapped through on-chain proxy contract.

`Static` `Readonly` contractAbi

contractAbi: AbiItem[] = SYS_ABI

`Static` `Readonly` swapMethods

swapMethods: ExactInputOutputSwapMethodsList = SYS_SWAP_METHOD

Accessors

apiFromAddress

set apiFromAddress(value: null | string): void
Parameters
- value: null | string
Returns void
Inherited from UniswapV2AbstractTrade.apiFromAddress
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/on-chain-trade.ts:49

priceImpact

get priceImpact(): null | number
Price impact, based on tokens' usd prices.

Returns null | number
Inherited from UniswapV2AbstractTrade.priceImpact
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/on-chain-trade.ts:85

toTokenAmountMin

get toTokenAmountMin(): PriceTokenAmount<BlockchainName>
Minimum amount of output token user can get.

Returns PriceTokenAmount<BlockchainName>
Inherited from UniswapV2AbstractTrade.toTokenAmountMin
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/on-chain-trade.ts:61

type

get type(): "SOLANA" | "LIFI" | "BRIDGERS" | "SQUIDROUTER" | "RANGO" | "OPEN_OCEAN" | "SYNAPSE" | "10K_SWAP" | "AERODROME" | "ACRYPTOS" | "ALDRIN_EXCHANGE" | "ALGEBRA" | "ALGEBRA_INTEGRAL" | "ANNEX" | "APE_SWAP" | "ARTH_SWAP" | "ASTRO_SWAP" | "ASCENT" | "AURORA_SWAP" | "AVNU" | "BABY_SWAP" | "BALANCER" | "BASE_SWAP" | "BEAM_SWAP" | "BI_SWAP" | "CAMELOT" | "CHERRY_SWAP" | "CLAIM_SWAP" | "CREMA_FINANCE" | "CRO_SWAP" | "CRONA_SWAP" | "CROPPER_FINANCE" | "CROW_FI" | "CRO_DEX" | "CURVE" | "DEFI_PLAZA" | "DEFI_SWAP" | "DFYN" | "DLN" | "DODO" | "DRAGON_SWAP" | "DYSTOPIA" | "ECHO_DEX" | "EDDY_FINANCE" | "ELK" | "FENIX_V2" | "FENIX_V3" | "FINKUJIRA" | "FUSIONX" | "HONEY_SWAP" | "HORIZONDEX" | "JET_SWAP" | "JOE" | "JUPITER" | "JUPITER_SWAP" | "J_SWAP" | "KIM" | "KYBER_SWAP" | "KUJATA" | "LUA_SWAP" | "MACARON" | "MAVERICK" | "MDEX" | "MERLIN_SWAP" | "MESH_SWAP" | "MM_FINANCE" | "MOJITO_SWAP" | "MUTE_SWAP" | "NET_SWAP" | "NATIVE_ROUTER" | "ODOS" | "OKC_SWAP" | "OKU_SWAP" | "ONE_INCH" | "ONE_MOON" | "ONE_SOL" | "OMNIDEX" | "OOLONG_SWAP" | "ORCA_SWAP" | "OSMOSIS_SWAP" | "PANCAKE_SWAP" | "PANCAKE_SWAP_V3" | "PANGOLIN" | "PARA_SWAP" | "PEGASYS" | "PHOTON_SWAP" | "POLYDEX" | "PITEAS" | "QUICK_SWAP" | "QUICK_SWAP_V3" | "PULSEX_V1" | "PULSEX_V2" | "RAYDIUM" | "REF_FINANCE" | "REN_BTC" | "ROUTER_SWAP" | "SABER_STABLE_SWAP" | "SAROS_SWAP" | "SERUM" | "SHIBA_SWAP" | "SMOOTHY" | "SOLAR_BEAM" | "SPACEFI_SWAP" | "SPIRIT_SWAP" | "SPL_TOKEN_SWAP" | "SPOOKY_SWAP" | "SOUL_SWAP" | "STELLA_SWAP" | "SUN_SWAP" | "SURFDEX" | "SUSHI_SWAP" | "SYNC_SWAP" | "SILK_SWAP" | "SYMBIOSIS_SWAP" | "TRADER" | "TRISOLARIS" | "IZUMI" | "UBE_SWAP" | "UNISWAP_V2" | "UNI_SWAP_V3" | "VERSE" | "VIPER_SWAP" | "VOLTAGE_SWAP" | "VOOI" | "VVS_FINANCE" | "WAGYU_SWAP" | "WANNA_SWAP" | "WAULT_SWAP" | "WOO_FI" | "WRAPPED" | "WYND" | "YUZU_SWAP" | "XY_DEX" | "ZAPPY" | "ZIP_SWAP" | "ZRX" | "ZETA_SWAP"
Type of instant trade provider.

Returns "SOLANA" | "LIFI" | "BRIDGERS" | "SQUIDROUTER" | "RANGO" | "OPEN_OCEAN" | "SYNAPSE" | "10K_SWAP" | "AERODROME" | "ACRYPTOS" | "ALDRIN_EXCHANGE" | "ALGEBRA" | "ALGEBRA_INTEGRAL" | "ANNEX" | "APE_SWAP" | "ARTH_SWAP" | "ASTRO_SWAP" | "ASCENT" | "AURORA_SWAP" | "AVNU" | "BABY_SWAP" | "BALANCER" | "BASE_SWAP" | "BEAM_SWAP" | "BI_SWAP" | "CAMELOT" | "CHERRY_SWAP" | "CLAIM_SWAP" | "CREMA_FINANCE" | "CRO_SWAP" | "CRONA_SWAP" | "CROPPER_FINANCE" | "CROW_FI" | "CRO_DEX" | "CURVE" | "DEFI_PLAZA" | "DEFI_SWAP" | "DFYN" | "DLN" | "DODO" | "DRAGON_SWAP" | "DYSTOPIA" | "ECHO_DEX" | "EDDY_FINANCE" | "ELK" | "FENIX_V2" | "FENIX_V3" | "FINKUJIRA" | "FUSIONX" | "HONEY_SWAP" | "HORIZONDEX" | "JET_SWAP" | "JOE" | "JUPITER" | "JUPITER_SWAP" | "J_SWAP" | "KIM" | "KYBER_SWAP" | "KUJATA" | "LUA_SWAP" | "MACARON" | "MAVERICK" | "MDEX" | "MERLIN_SWAP" | "MESH_SWAP" | "MM_FINANCE" | "MOJITO_SWAP" | "MUTE_SWAP" | "NET_SWAP" | "NATIVE_ROUTER" | "ODOS" | "OKC_SWAP" | "OKU_SWAP" | "ONE_INCH" | "ONE_MOON" | "ONE_SOL" | "OMNIDEX" | "OOLONG_SWAP" | "ORCA_SWAP" | "OSMOSIS_SWAP" | "PANCAKE_SWAP" | "PANCAKE_SWAP_V3" | "PANGOLIN" | "PARA_SWAP" | "PEGASYS" | "PHOTON_SWAP" | "POLYDEX" | "PITEAS" | "QUICK_SWAP" | "QUICK_SWAP_V3" | "PULSEX_V1" | "PULSEX_V2" | "RAYDIUM" | "REF_FINANCE" | "REN_BTC" | "ROUTER_SWAP" | "SABER_STABLE_SWAP" | "SAROS_SWAP" | "SERUM" | "SHIBA_SWAP" | "SMOOTHY" | "SOLAR_BEAM" | "SPACEFI_SWAP" | "SPIRIT_SWAP" | "SPL_TOKEN_SWAP" | "SPOOKY_SWAP" | "SOUL_SWAP" | "STELLA_SWAP" | "SUN_SWAP" | "SURFDEX" | "SUSHI_SWAP" | "SYNC_SWAP" | "SILK_SWAP" | "SYMBIOSIS_SWAP" | "TRADER" | "TRISOLARIS" | "IZUMI" | "UBE_SWAP" | "UNISWAP_V2" | "UNI_SWAP_V3" | "VERSE" | "VIPER_SWAP" | "VOLTAGE_SWAP" | "VOOI" | "VVS_FINANCE" | "WAGYU_SWAP" | "WANNA_SWAP" | "WAULT_SWAP" | "WOO_FI" | "WRAPPED" | "WYND" | "YUZU_SWAP" | "XY_DEX" | "ZAPPY" | "ZIP_SWAP" | "ZRX" | "ZETA_SWAP"
Inherited from UniswapV2AbstractTrade.type
- Defined in src/features/on-chain/calculation-manager/providers/dexes/common/uniswap-v2-abstract/uniswap-v2-abstract-trade.ts:100

`Static` type

get type(): "SOLANA" | "LIFI" | "BRIDGERS" | "SQUIDROUTER" | "RANGO" | "OPEN_OCEAN" | "SYNAPSE" | "10K_SWAP" | "AERODROME" | "ACRYPTOS" | "ALDRIN_EXCHANGE" | "ALGEBRA" | "ALGEBRA_INTEGRAL" | "ANNEX" | "APE_SWAP" | "ARTH_SWAP" | "ASTRO_SWAP" | "ASCENT" | "AURORA_SWAP" | "AVNU" | "BABY_SWAP" | "BALANCER" | "BASE_SWAP" | "BEAM_SWAP" | "BI_SWAP" | "CAMELOT" | "CHERRY_SWAP" | "CLAIM_SWAP" | "CREMA_FINANCE" | "CRO_SWAP" | "CRONA_SWAP" | "CROPPER_FINANCE" | "CROW_FI" | "CRO_DEX" | "CURVE" | "DEFI_PLAZA" | "DEFI_SWAP" | "DFYN" | "DLN" | "DODO" | "DRAGON_SWAP" | "DYSTOPIA" | "ECHO_DEX" | "EDDY_FINANCE" | "ELK" | "FENIX_V2" | "FENIX_V3" | "FINKUJIRA" | "FUSIONX" | "HONEY_SWAP" | "HORIZONDEX" | "JET_SWAP" | "JOE" | "JUPITER" | "JUPITER_SWAP" | "J_SWAP" | "KIM" | "KYBER_SWAP" | "KUJATA" | "LUA_SWAP" | "MACARON" | "MAVERICK" | "MDEX" | "MERLIN_SWAP" | "MESH_SWAP" | "MM_FINANCE" | "MOJITO_SWAP" | "MUTE_SWAP" | "NET_SWAP" | "NATIVE_ROUTER" | "ODOS" | "OKC_SWAP" | "OKU_SWAP" | "ONE_INCH" | "ONE_MOON" | "ONE_SOL" | "OMNIDEX" | "OOLONG_SWAP" | "ORCA_SWAP" | "OSMOSIS_SWAP" | "PANCAKE_SWAP" | "PANCAKE_SWAP_V3" | "PANGOLIN" | "PARA_SWAP" | "PEGASYS" | "PHOTON_SWAP" | "POLYDEX" | "PITEAS" | "QUICK_SWAP" | "QUICK_SWAP_V3" | "PULSEX_V1" | "PULSEX_V2" | "RAYDIUM" | "REF_FINANCE" | "REN_BTC" | "ROUTER_SWAP" | "SABER_STABLE_SWAP" | "SAROS_SWAP" | "SERUM" | "SHIBA_SWAP" | "SMOOTHY" | "SOLAR_BEAM" | "SPACEFI_SWAP" | "SPIRIT_SWAP" | "SPL_TOKEN_SWAP" | "SPOOKY_SWAP" | "SOUL_SWAP" | "STELLA_SWAP" | "SUN_SWAP" | "SURFDEX" | "SUSHI_SWAP" | "SYNC_SWAP" | "SILK_SWAP" | "SYMBIOSIS_SWAP" | "TRADER" | "TRISOLARIS" | "IZUMI" | "UBE_SWAP" | "UNISWAP_V2" | "UNI_SWAP_V3" | "VERSE" | "VIPER_SWAP" | "VOLTAGE_SWAP" | "VOOI" | "VVS_FINANCE" | "WAGYU_SWAP" | "WANNA_SWAP" | "WAULT_SWAP" | "WOO_FI" | "WRAPPED" | "WYND" | "YUZU_SWAP" | "XY_DEX" | "ZAPPY" | "ZIP_SWAP" | "ZRX" | "ZETA_SWAP"
Returns "SOLANA" | "LIFI" | "BRIDGERS" | "SQUIDROUTER" | "RANGO" | "OPEN_OCEAN" | "SYNAPSE" | "10K_SWAP" | "AERODROME" | "ACRYPTOS" | "ALDRIN_EXCHANGE" | "ALGEBRA" | "ALGEBRA_INTEGRAL" | "ANNEX" | "APE_SWAP" | "ARTH_SWAP" | "ASTRO_SWAP" | "ASCENT" | "AURORA_SWAP" | "AVNU" | "BABY_SWAP" | "BALANCER" | "BASE_SWAP" | "BEAM_SWAP" | "BI_SWAP" | "CAMELOT" | "CHERRY_SWAP" | "CLAIM_SWAP" | "CREMA_FINANCE" | "CRO_SWAP" | "CRONA_SWAP" | "CROPPER_FINANCE" | "CROW_FI" | "CRO_DEX" | "CURVE" | "DEFI_PLAZA" | "DEFI_SWAP" | "DFYN" | "DLN" | "DODO" | "DRAGON_SWAP" | "DYSTOPIA" | "ECHO_DEX" | "EDDY_FINANCE" | "ELK" | "FENIX_V2" | "FENIX_V3" | "FINKUJIRA" | "FUSIONX" | "HONEY_SWAP" | "HORIZONDEX" | "JET_SWAP" | "JOE" | "JUPITER" | "JUPITER_SWAP" | "J_SWAP" | "KIM" | "KYBER_SWAP" | "KUJATA" | "LUA_SWAP" | "MACARON" | "MAVERICK" | "MDEX" | "MERLIN_SWAP" | "MESH_SWAP" | "MM_FINANCE" | "MOJITO_SWAP" | "MUTE_SWAP" | "NET_SWAP" | "NATIVE_ROUTER" | "ODOS" | "OKC_SWAP" | "OKU_SWAP" | "ONE_INCH" | "ONE_MOON" | "ONE_SOL" | "OMNIDEX" | "OOLONG_SWAP" | "ORCA_SWAP" | "OSMOSIS_SWAP" | "PANCAKE_SWAP" | "PANCAKE_SWAP_V3" | "PANGOLIN" | "PARA_SWAP" | "PEGASYS" | "PHOTON_SWAP" | "POLYDEX" | "PITEAS" | "QUICK_SWAP" | "QUICK_SWAP_V3" | "PULSEX_V1" | "PULSEX_V2" | "RAYDIUM" | "REF_FINANCE" | "REN_BTC" | "ROUTER_SWAP" | "SABER_STABLE_SWAP" | "SAROS_SWAP" | "SERUM" | "SHIBA_SWAP" | "SMOOTHY" | "SOLAR_BEAM" | "SPACEFI_SWAP" | "SPIRIT_SWAP" | "SPL_TOKEN_SWAP" | "SPOOKY_SWAP" | "SOUL_SWAP" | "STELLA_SWAP" | "SUN_SWAP" | "SURFDEX" | "SUSHI_SWAP" | "SYNC_SWAP" | "SILK_SWAP" | "SYMBIOSIS_SWAP" | "TRADER" | "TRISOLARIS" | "IZUMI" | "UBE_SWAP" | "UNISWAP_V2" | "UNI_SWAP_V3" | "VERSE" | "VIPER_SWAP" | "VOLTAGE_SWAP" | "VOOI" | "VVS_FINANCE" | "WAGYU_SWAP" | "WANNA_SWAP" | "WAULT_SWAP" | "WOO_FI" | "WRAPPED" | "WYND" | "YUZU_SWAP" | "XY_DEX" | "ZAPPY" | "ZIP_SWAP" | "ZRX" | "ZETA_SWAP"
Overrides UniswapV2AbstractTrade.type
- Defined in src/features/on-chain/calculation-manager/providers/dexes/syscoin/pegasys/pegasys-trade.ts:15

Methods

approve

approve(options: EvmBasicTransactionOptions, checkNeedApprove?: boolean, amount?: BigNumber | "infinity"): Promise<TransactionReceipt>
Sends approve transaction with connected wallet.
Parameters
- options: EvmBasicTransactionOptions
  
  Transaction options.
- checkNeedApprove: boolean = true
  
  If true, first allowance is checked.
- amount: BigNumber | "infinity" = 'infinity'
  
  Amount of tokens in approval window in spending cap field
Returns Promise<TransactionReceipt>
Inherited from UniswapV2AbstractTrade.approve
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/evm-on-chain-trade/evm-on-chain-trade.ts:153

encode

encode(options: EncodeTransactionOptions): Promise<EvmEncodeConfig>
Builds transaction config, with encoded data.
Parameters
- options: EncodeTransactionOptions
  
  Encode transaction options.
Returns Promise<EvmEncodeConfig>
Inherited from UniswapV2AbstractTrade.encode
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/evm-on-chain-trade/evm-on-chain-trade.ts:312

encodeApprove

encodeApprove(tokenAddress: string, spenderAddress: string, value: BigNumber | "infinity", options?: EvmTransactionOptions): Promise<TransactionConfig>
Builds encoded approve transaction config.

Returns
Encoded approve transaction config.
Parameters
- tokenAddress: string
  
  Address of the smart-contract corresponding to the token.
- spenderAddress: string
  
  Wallet or contract address to approve.
- value: BigNumber | "infinity"
  
  Token amount to approve in wei.
- options: EvmTransactionOptions = {}
  
  Additional options.
Returns Promise<TransactionConfig>
Inherited from UniswapV2AbstractTrade.encodeApprove
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/evm-on-chain-trade/evm-on-chain-trade.ts:187

encodeDirect

encodeDirect(options: EncodeTransactionOptions): Promise<EvmEncodeConfig>
Encodes trade to swap it directly through dex contract.
Parameters
- options: EncodeTransactionOptions
  
  Encode options.
Returns Promise<EvmEncodeConfig>
Inherited from UniswapV2AbstractTrade.encodeDirect
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/evm-on-chain-trade/evm-on-chain-trade.ts:394

getData

getData(fromAddress: string, options?: SwapTransactionOptions): Promise<EvmTransactionOptions>
Parameters
- fromAddress: string
- options: SwapTransactionOptions = {}
Returns Promise<EvmTransactionOptions>
Inherited from UniswapV2AbstractTrade.getData
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/evm-on-chain-trade/evm-on-chain-trade.ts:278

getTradeInfo

getTradeInfo(): TradeInfo
Returns TradeInfo
Inherited from UniswapV2AbstractTrade.getTradeInfo
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/on-chain-trade.ts:246

needApprove

needApprove(fromAddress?: string): Promise<boolean>
Returns true, if allowance is not enough.
Parameters
- Optional fromAddress: string
Returns Promise<boolean>
Inherited from UniswapV2AbstractTrade.needApprove
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/on-chain-trade.ts:95

swap

swap(options?: SwapTransactionOptions): Promise<string>
Sends swap transaction with connected wallet. If user has not enough allowance, then approve transaction will be called first.

Example
```
const onConfirm = (hash: string) => console.log(hash);
const receipt = await trades[TRADE_TYPE.UNISWAP_V2].swap({ onConfirm });
```
Parameters
- options: SwapTransactionOptions = {}
  
  Transaction options.
Returns Promise<string>
Inherited from UniswapV2AbstractTrade.swap
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/evm-on-chain-trade/evm-on-chain-trade.ts:240

`Static` callForRoutes

callForRoutes(blockchain: EvmBlockchainName, exact: Exact, routesMethodArguments: ExtendedRoutesMethodArguments): Promise<ContractMulticallResponse<string[]>[]>
Parameters
- blockchain: EvmBlockchainName
- exact: Exact
- routesMethodArguments: ExtendedRoutesMethodArguments
Returns Promise<ContractMulticallResponse<string[]>[]>
Inherited from UniswapV2AbstractTrade.callForRoutes
- Defined in src/features/on-chain/calculation-manager/providers/dexes/common/uniswap-v2-abstract/uniswap-v2-abstract-trade.ts:67

Class PegasysTrade

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

tradeStruct: UniswapV2TradeStruct

providerAddress: string

Returns PegasysTrade

Properties

Readonly deadlineMinutes

Readonly dexContractAddress

Readonly exact

Readonly feeInfo

Readonly from

Readonly gasFeeInfo

Readonly path

Readonly permit2ApproveConfig

Readonly routPoolInfo

Readonly slippageTolerance

Readonly to

Readonly useProxy

Static Readonly contractAbi

Static Readonly swapMethods

Accessors

apiFromAddress

Parameters

value: null | string

Returns void

priceImpact

Returns null | number

toTokenAmountMin

Returns PriceTokenAmount<BlockchainName>

type

Static type

Methods

approve

Parameters

options: EvmBasicTransactionOptions

checkNeedApprove: boolean = true

amount: BigNumber | "infinity" = 'infinity'

Returns Promise<TransactionReceipt>

encode

Parameters

options: EncodeTransactionOptions

Returns Promise<EvmEncodeConfig>

encodeApprove

Returns

Parameters

tokenAddress: string

spenderAddress: string

value: BigNumber | "infinity"

options: EvmTransactionOptions = {}

Returns Promise<TransactionConfig>

encodeDirect

Parameters

options: EncodeTransactionOptions

Returns Promise<EvmEncodeConfig>

getData

Parameters

fromAddress: string

options: SwapTransactionOptions = {}

Returns Promise<EvmTransactionOptions>

getTradeInfo

Returns TradeInfo

needApprove

Parameters

Optional fromAddress: string

Returns Promise<boolean>

swap

Example

Parameters

options: SwapTransactionOptions = {}

Returns Promise<string>

Static callForRoutes

Parameters

`Readonly` deadlineMinutes

`Readonly` dexContractAddress

`Readonly` exact

`Readonly` feeInfo

`Readonly` from

`Readonly` gasFeeInfo

`Readonly` path

`Readonly` permit2ApproveConfig

`Readonly` routPoolInfo

`Readonly` slippageTolerance

`Readonly` to

`Readonly` useProxy

`Static` `Readonly` contractAbi

`Static` `Readonly` swapMethods

`Static` type

`Optional` fromAddress: string

`Static` callForRoutes