Preparing search index...
The search index is not available
rubic-sdk
rubic-sdk
XyCrossChainProvider
Class XyCrossChainProvider
Hierarchy
CrossChainProvider
XyCrossChainProvider
Index
Constructors
constructor
Properties
type
api
Endpoint
Methods
are
Supported
Blockchains
calculate
is
Supported
Blockchain
parse
Error
Constructors
constructor
new
Xy
Cross
Chain
Provider
(
)
:
XyCrossChainProvider
Returns
XyCrossChainProvider
Properties
Readonly
type
type
:
"xy"
= CROSS_CHAIN_TRADE_TYPE.XY
Static
Readonly
api
Endpoint
api
Endpoint
:
"https://open-api.xy.finance/v1"
= 'https://open-api.xy.finance/v1'
Methods
are
Supported
Blockchains
are
Supported
Blockchains
(
fromBlockchain
:
BlockchainName
, toBlockchain
:
BlockchainName
)
:
boolean
Parameters
fromBlockchain:
BlockchainName
toBlockchain:
BlockchainName
Returns
boolean
calculate
calculate
(
fromToken
:
PriceTokenAmount
<
EvmBlockchainName
>
, toToken
:
PriceToken
<
EvmBlockchainName
>
, options
:
Omit
<
CrossChainOptions
,
"fromSlippageTolerance"
|
"toSlippageTolerance"
|
"slippageTolerance"
|
"gasCalculation"
|
"deadline"
|
"providerAddress"
|
"timeout"
|
"changenowFullyEnabled"
|
"enableTestnets"
>
&
Required
<
Pick
<
CrossChainOptions
,
"fromSlippageTolerance"
|
"toSlippageTolerance"
|
"slippageTolerance"
|
"gasCalculation"
|
"deadline"
|
"providerAddress"
|
"timeout"
|
"changenowFullyEnabled"
|
"enableTestnets"
>
>
)
:
Promise
<
CalculationResult
>
Parameters
fromToken:
PriceTokenAmount
<
EvmBlockchainName
>
toToken:
PriceToken
<
EvmBlockchainName
>
options:
Omit
<
CrossChainOptions
,
"fromSlippageTolerance"
|
"toSlippageTolerance"
|
"slippageTolerance"
|
"gasCalculation"
|
"deadline"
|
"providerAddress"
|
"timeout"
|
"changenowFullyEnabled"
|
"enableTestnets"
>
&
Required
<
Pick
<
CrossChainOptions
,
"fromSlippageTolerance"
|
"toSlippageTolerance"
|
"slippageTolerance"
|
"gasCalculation"
|
"deadline"
|
"providerAddress"
|
"timeout"
|
"changenowFullyEnabled"
|
"enableTestnets"
>
>
Returns
Promise
<
CalculationResult
>
is
Supported
Blockchain
is
Supported
Blockchain
(
blockchain
:
BlockchainName
)
:
blockchain
is
"ETH"
|
"BSC"
|
"POLYGON"
|
"POLYGON_ZKEVM"
|
"AVALANCHE"
|
"MOONRIVER"
|
"FANTOM"
|
"ARBITRUM"
|
"OPTIMISM"
|
"CRONOS"
|
"ASTAR_EVM"
|
"ZK_SYNC"
|
"LINEA"
|
"BASE"
Parameters
blockchain:
BlockchainName
Returns
blockchain
is
"ETH"
|
"BSC"
|
"POLYGON"
|
"POLYGON_ZKEVM"
|
"AVALANCHE"
|
"MOONRIVER"
|
"FANTOM"
|
"ARBITRUM"
|
"OPTIMISM"
|
"CRONOS"
|
"ASTAR_EVM"
|
"ZK_SYNC"
|
"LINEA"
|
"BASE"
Static
parse
Error
parse
Error
(
err
:
unknown
)
:
RubicSdkError
Parameters
err:
unknown
Returns
RubicSdkError
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
Modules
rubic-
sdk
Xy
Cross
Chain
Provider
constructor
type
api
Endpoint
are
Supported
Blockchains
calculate
is
Supported
Blockchain
parse
Error
Generated using
TypeDoc