From a0cd8b55205054f04235005684c66e82165d3ce9 Mon Sep 17 00:00:00 2001 From: wainola Date: Tue, 10 Sep 2024 14:03:48 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20sygmapro?= =?UTF-8?q?tocol/sygma-sdk@65d0712ce10071a95a72e5ad4622fa1f99f11700=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../_buildwithsygma_core.BaseTransfer.html | 8 ++++---- classes/_buildwithsygma_core.Config.html | 20 +++++++++---------- ...ygma_evm.BaseEvmTransferFeeCalculator.html | 4 ++-- ...buildwithsygma_evm.BasicFeeCalculator.html | 4 ++-- ...withsygma_evm.PercentageFeeCalculator.html | 4 ++-- ..._buildwithsygma_evm.TwapFeeCalculator.html | 4 ++-- enums/_buildwithsygma_core.ConfigUrl.html | 4 ++-- enums/_buildwithsygma_core.Environment.html | 4 ++-- enums/_buildwithsygma_core.ExplorerUrl.html | 4 ++-- .../_buildwithsygma_core.FeeHandlerType.html | 4 ++-- enums/_buildwithsygma_core.IndexerUrl.html | 4 ++-- enums/_buildwithsygma_core.Network.html | 4 ++-- enums/_buildwithsygma_core.ResourceType.html | 4 ++-- enums/_buildwithsygma_core.RouteType.html | 4 ++-- enums/_buildwithsygma_core.SecurityModel.html | 4 ++-- .../_buildwithsygma_core.getDomains.html | 2 +- ...withsygma_core.getEnvironmentMetadata.html | 2 +- ...ildwithsygma_core.getRawConfiguration.html | 2 +- functions/_buildwithsygma_core.getRoutes.html | 2 +- ..._buildwithsygma_core.getSygmaScanLink.html | 2 +- ...buildwithsygma_core.getTransferStatus.html | 2 +- ...thsygma_core.isValidAddressForNetwork.html | 2 +- ...dwithsygma_core.isValidBitcoinAddress.html | 2 +- ...buildwithsygma_core.isValidEvmAddress.html | 2 +- ...ithsygma_core.isValidSubstrateAddress.html | 2 +- functions/_buildwithsygma_evm.approve.html | 2 +- ...ygma_evm.createCrossChainContractCall.html | 2 +- ...sygma_evm.createFungibleAssetTransfer.html | 2 +- ...ma_evm.createNonFungibleAssetTransfer.html | 2 +- ...ithsygma_evm.createTransactionRequest.html | 2 +- .../_buildwithsygma_evm.executeDeposit.html | 2 +- ..._buildwithsygma_evm.getERC20Allowance.html | 2 +- ...buildwithsygma_evm.getEvmErc20Balance.html | 2 +- ...ildwithsygma_evm.getEvmHandlerBalance.html | 2 +- ..._buildwithsygma_evm.getFeeInformation.html | 2 +- functions/_buildwithsygma_evm.isApproved.html | 2 +- ...bstrate.createDestIdMultilocationData.html | 2 +- ...hsygma_substrate.createMultiAssetData.html | 2 +- ....createSubstrateFungibleAssetTransfer.html | 2 +- .../_buildwithsygma_substrate.deposit.html | 2 +- ...ldwithsygma_substrate.getAssetBalance.html | 2 +- ..._buildwithsygma_substrate.getBasicFee.html | 2 +- ...uildwithsygma_substrate.getFeeHandler.html | 2 +- ...sygma_substrate.getNativeTokenBalance.html | 2 +- ...dwithsygma_substrate.getPercentageFee.html | 2 +- ...gma_substrate.handleTxExtrinsicResult.html | 2 +- ...ldwithsygma_substrate.throwErrorIfAny.html | 2 +- ...dwithsygma_utils.broadcastTransaction.html | 2 +- .../_buildwithsygma_utils.fetchUTXOS.html | 2 +- ..._buildwithsygma_utils.getFeeEstimates.html | 2 +- ...ildwithsygma_utils.hasEnoughLiquidity.html | 2 +- .../_buildwithsygma_utils.processUtxos.html | 2 +- .../_buildwithsygma_core.BaseConfig.html | 4 ++-- ...uildwithsygma_core.BaseTransferParams.html | 4 ++-- .../_buildwithsygma_core.BitcoinConfig.html | 4 ++-- .../_buildwithsygma_core.Eip1193Provider.html | 4 ++-- .../_buildwithsygma_core.EthereumConfig.html | 4 ++-- .../_buildwithsygma_core.SubstrateConfig.html | 4 ++-- .../_buildwithsygma_core.SygmaConfig.html | 4 ++-- ...dwithsygma_evm.EvmAssetTransferParams.html | 4 ++-- ...withsygma_evm.EvmFeeCalculationParams.html | 4 ++-- ..._evm.EvmTransferFeeCalculationHandler.html | 4 ++-- ..._buildwithsygma_evm.EvmTransferParams.html | 4 ++-- ...a_evm.FungibleTransferOptionalMessage.html | 4 ++-- ...dwithsygma_evm.FungibleTransferParams.html | 4 ++-- ...ygma_evm.GenericMessageTransferParams.html | 4 ++-- ...thsygma_evm.NonFungibleTransferParams.html | 4 ++-- ...buildwithsygma_evm.TransactionRequest.html | 4 ++-- ...bstrate.SubstrateAssetTransferRequest.html | 4 ++-- modules/_buildwithsygma_core.html | 2 +- .../_buildwithsygma_core.BitcoinResource.html | 2 +- types/_buildwithsygma_core.Domain.html | 2 +- .../_buildwithsygma_core.DomainMetadata.html | 2 +- types/_buildwithsygma_core.Domainlike.html | 2 +- ...ildwithsygma_core.EnvironmentMetadata.html | 2 +- types/_buildwithsygma_core.EvmResource.html | 2 +- types/_buildwithsygma_core.FeeHandler.html | 2 +- types/_buildwithsygma_core.Handler.html | 2 +- types/_buildwithsygma_core.HexString.html | 2 +- ...dwithsygma_core.IndexerRoutesResponse.html | 2 +- types/_buildwithsygma_core.ParachainId.html | 2 +- types/_buildwithsygma_core.Resource.html | 2 +- types/_buildwithsygma_core.Route.html | 2 +- ..._buildwithsygma_core.RouteIndexerType.html | 2 +- ...buildwithsygma_core.SubstrateResource.html | 2 +- ...buildwithsygma_core.SygmaDomainConfig.html | 2 +- .../_buildwithsygma_core.TransferStatus.html | 2 +- ...withsygma_core.TransferStatusResponse.html | 2 +- ...ildwithsygma_core.XcmMultiAssetIdType.html | 2 +- types/_buildwithsygma_evm.EvmFee.html | 2 +- types/_buildwithsygma_evm.EvmResourceish.html | 2 +- ...ithsygma_evm.ASSET_TRANSFER_GAS_LIMIT.html | 2 +- 92 files changed, 134 insertions(+), 134 deletions(-) diff --git a/classes/_buildwithsygma_core.BaseTransfer.html b/classes/_buildwithsygma_core.BaseTransfer.html index 88eec683a..c5caaaa7b 100644 --- a/classes/_buildwithsygma_core.BaseTransfer.html +++ b/classes/_buildwithsygma_core.BaseTransfer.html @@ -1,4 +1,4 @@ -BaseTransfer | Packages Example

Class BaseTransferAbstract

Constructors

constructor +BaseTransfer | Packages Example

Class BaseTransferAbstract

Constructors

constructor

Properties

destinationDomain sourceAddress sourceDomain @@ -11,8 +11,8 @@

Methods

isValidTransfer setDestinationDomain setResource -

Constructors

Protectedconstructor

Properties

ProtecteddestinationDomain

destinationDomain: Domain

ProtectedsourceAddress

sourceAddress: string

ProtectedsourceDomain

sourceDomain: Domain

ProtectedsygmaConfiguration

sygmaConfiguration: Config

ProtectedtransferResource

transferResource: EvmResource | SubstrateResource | BitcoinResource

Accessors

config

destination

resource

source

Methods

isValidTransfer

  • isValidTransfer(): Promise<boolean>

  • Method that checks whether the transfer +

Constructors

Protectedconstructor

Properties

ProtecteddestinationDomain

destinationDomain: Domain

ProtectedsourceAddress

sourceAddress: string

ProtectedsourceDomain

sourceDomain: Domain

ProtectedsygmaConfiguration

sygmaConfiguration: Config

ProtectedtransferResource

transferResource: EvmResource | SubstrateResource | BitcoinResource

Accessors

config

destination

resource

source

Methods

isValidTransfer

  • isValidTransfer(): Promise<boolean>

  • Method that checks whether the transfer is valid and route has been registered on the bridge

    -

    Returns Promise<boolean>

setDestinationDomain

setResource

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Returns Promise<boolean>

setDestinationDomain

setResource

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/classes/_buildwithsygma_core.Config.html b/classes/_buildwithsygma_core.Config.html index 4f1b4617b..a95a7b589 100644 --- a/classes/_buildwithsygma_core.Config.html +++ b/classes/_buildwithsygma_core.Config.html @@ -1,4 +1,4 @@ -Config | Packages Example

Class Config

Constructors

constructor +Config | Packages Example

Class Config

Constructors

constructor

Properties

configuration initialized

Methods

findDomainConfig @@ -11,20 +11,20 @@ init

Constructors

constructor

Properties

configuration

configuration: SygmaConfig

Cache storing all sygma environment configurations

-

initialized

initialized: boolean = false

Methods

findDomainConfig

initialized

initialized: boolean = false

Methods

findDomainConfig

findDomainConfigBySygmaId

findDomainConfigBySygmaId

getConfiguration

getDomain

getConfiguration

getDomain

getDomainConfig

getDomainConfig

getDomains

  • getDomains(options?): Domain[]

  • Retrieves list of supported domains +

Returns EthereumConfig | SubstrateConfig | BitcoinConfig

getDomains

  • getDomains(options?): Domain[]

  • Retrieves list of supported domains from the configuration

    -

    Parameters

    • Optionaloptions: {
          networkTypes?: Network[];
      }

    Returns Domain[]

getResources

getResources

init

  • init(environment): Promise<void>

  • Initialize and store all +

Returns Resource[]

init

  • init(environment): Promise<void>

  • Initialize and store all sygma configurations

    -

    Parameters

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Parameters

Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/classes/_buildwithsygma_evm.BaseEvmTransferFeeCalculator.html b/classes/_buildwithsygma_evm.BaseEvmTransferFeeCalculator.html index f48cfa7ce..ae487745c 100644 --- a/classes/_buildwithsygma_evm.BaseEvmTransferFeeCalculator.html +++ b/classes/_buildwithsygma_evm.BaseEvmTransferFeeCalculator.html @@ -1,4 +1,4 @@ -BaseEvmTransferFeeCalculator | Packages Example

Class BaseEvmTransferFeeCalculatorAbstract

Hierarchy (view full)

Implements

EvmFee +BaseEvmTransferFeeCalculator | Packages Example

Class BaseEvmTransferFeeCalculatorAbstract

Hierarchy (view full)

Implements

EvmFee Calculate transfer fee

calculateFee

Other

constructor @@ -8,7 +8,7 @@ Calculate transfer fee">

EvmFee -Calculate transfer fee

calculateFee

Other

constructor

nextHandler

nextHandler: undefined | EvmTransferFeeCalculationHandler

setNextHandler

Settings

Member Visibility

On This Page

calculateFee

Other

constructor

nextHandler

nextHandler: undefined | EvmTransferFeeCalculationHandler

setNextHandler

Settings

Member Visibility

On This Page

EvmFee diff --git a/classes/_buildwithsygma_evm.BasicFeeCalculator.html b/classes/_buildwithsygma_evm.BasicFeeCalculator.html index 48bacb7fa..d33037915 100644 --- a/classes/_buildwithsygma_evm.BasicFeeCalculator.html +++ b/classes/_buildwithsygma_evm.BasicFeeCalculator.html @@ -1,4 +1,4 @@ -BasicFeeCalculator | Packages Example

Class BasicFeeCalculatorInternal

Hierarchy (view full)

EvmFee +BasicFeeCalculator | Packages Example

Class BasicFeeCalculatorInternal

Hierarchy (view full)

EvmFee Calculate transfer fee

calculateFee

Other

constructor @@ -8,7 +8,7 @@ Calculate transfer fee">

EvmFee -Calculate transfer fee

calculateFee

Other

constructor

nextHandler

nextHandler: undefined | EvmTransferFeeCalculationHandler

setNextHandler

Settings

Member Visibility

On This Page

calculateFee

Other

constructor

nextHandler

nextHandler: undefined | EvmTransferFeeCalculationHandler

setNextHandler

Settings

Member Visibility

On This Page

EvmFee diff --git a/classes/_buildwithsygma_evm.PercentageFeeCalculator.html b/classes/_buildwithsygma_evm.PercentageFeeCalculator.html index fa9845149..179a9bca2 100644 --- a/classes/_buildwithsygma_evm.PercentageFeeCalculator.html +++ b/classes/_buildwithsygma_evm.PercentageFeeCalculator.html @@ -1,4 +1,4 @@ -PercentageFeeCalculator | Packages Example

Class PercentageFeeCalculatorInternal

Hierarchy (view full)

EvmFee +PercentageFeeCalculator | Packages Example

Class PercentageFeeCalculatorInternal

Hierarchy (view full)

EvmFee Calculate transfer fee

calculateFee

Other

constructor @@ -8,7 +8,7 @@ Calculate transfer fee">

EvmFee -Calculate transfer fee

calculateFee

Other

constructor

nextHandler

nextHandler: undefined | EvmTransferFeeCalculationHandler

setNextHandler

Settings

Member Visibility

On This Page

calculateFee

Other

constructor

nextHandler

nextHandler: undefined | EvmTransferFeeCalculationHandler

setNextHandler

Settings

Member Visibility

On This Page

EvmFee diff --git a/classes/_buildwithsygma_evm.TwapFeeCalculator.html b/classes/_buildwithsygma_evm.TwapFeeCalculator.html index dfa5e67a0..5f740bea6 100644 --- a/classes/_buildwithsygma_evm.TwapFeeCalculator.html +++ b/classes/_buildwithsygma_evm.TwapFeeCalculator.html @@ -1,4 +1,4 @@ -TwapFeeCalculator | Packages Example

Class TwapFeeCalculatorInternal

Hierarchy (view full)

EvmFee +TwapFeeCalculator | Packages Example

Class TwapFeeCalculatorInternal

Hierarchy (view full)

EvmFee Calculate transfer fee

calculateFee

Other

constructor @@ -8,7 +8,7 @@ Calculate transfer fee">

EvmFee -Calculate transfer fee

calculateFee

Other

constructor

nextHandler

nextHandler: undefined | EvmTransferFeeCalculationHandler

setNextHandler

Settings

Member Visibility

On This Page

calculateFee

Other

constructor

nextHandler

nextHandler: undefined | EvmTransferFeeCalculationHandler

setNextHandler

Settings

Member Visibility

On This Page

EvmFee diff --git a/enums/_buildwithsygma_core.ConfigUrl.html b/enums/_buildwithsygma_core.ConfigUrl.html index 079945392..973914932 100644 --- a/enums/_buildwithsygma_core.ConfigUrl.html +++ b/enums/_buildwithsygma_core.ConfigUrl.html @@ -1,4 +1,4 @@ -ConfigUrl | Packages Example

Enumeration ConfigUrl

Enumeration Members

DEVNET +ConfigUrl | Packages Example

Enumeration ConfigUrl

Enumeration Members

DEVNET MAINNET TESTNET -

Enumeration Members

DEVNET

DEVNET: "https://chainbridge-assets-stage.s3.us-east-2.amazonaws.com/shared-config-dev.json"

MAINNET

MAINNET: "https://sygma-assets-mainnet.s3.us-east-2.amazonaws.com/shared-config-mainnet.json"

TESTNET

TESTNET: "https://chainbridge-assets-stage.s3.us-east-2.amazonaws.com/shared-config-test.json"

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

DEVNET

DEVNET: "https://chainbridge-assets-stage.s3.us-east-2.amazonaws.com/shared-config-dev.json"

MAINNET

MAINNET: "https://sygma-assets-mainnet.s3.us-east-2.amazonaws.com/shared-config-mainnet.json"

TESTNET

TESTNET: "https://chainbridge-assets-stage.s3.us-east-2.amazonaws.com/shared-config-test.json"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/_buildwithsygma_core.Environment.html b/enums/_buildwithsygma_core.Environment.html index 85ef80e09..977bc92a7 100644 --- a/enums/_buildwithsygma_core.Environment.html +++ b/enums/_buildwithsygma_core.Environment.html @@ -1,5 +1,5 @@ -Environment | Packages Example

Enumeration Environment

Enumeration Members

DEVNET +Environment | Packages Example

Enumeration Environment

Enumeration Members

DEVNET LOCAL MAINNET TESTNET -

Enumeration Members

DEVNET

DEVNET: "devnet"

LOCAL

LOCAL: "local"

MAINNET

MAINNET: "mainnet"

TESTNET

TESTNET: "testnet"

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

DEVNET

DEVNET: "devnet"

LOCAL

LOCAL: "local"

MAINNET

MAINNET: "mainnet"

TESTNET

TESTNET: "testnet"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/_buildwithsygma_core.ExplorerUrl.html b/enums/_buildwithsygma_core.ExplorerUrl.html index b4beb8ba1..1ac7e06be 100644 --- a/enums/_buildwithsygma_core.ExplorerUrl.html +++ b/enums/_buildwithsygma_core.ExplorerUrl.html @@ -1,3 +1,3 @@ -ExplorerUrl | Packages Example

Enumeration ExplorerUrl

Enumeration Members

MAINNET +ExplorerUrl | Packages Example

Enumeration ExplorerUrl

Enumeration Members

MAINNET TESTNET -

Enumeration Members

MAINNET

MAINNET: "https://scan.buildwithsygma.com"

TESTNET

TESTNET: "https://scan.test.buildwithsygma.com"

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

MAINNET

MAINNET: "https://scan.buildwithsygma.com"

TESTNET

TESTNET: "https://scan.test.buildwithsygma.com"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/_buildwithsygma_core.FeeHandlerType.html b/enums/_buildwithsygma_core.FeeHandlerType.html index 3b72639fc..b797e80f7 100644 --- a/enums/_buildwithsygma_core.FeeHandlerType.html +++ b/enums/_buildwithsygma_core.FeeHandlerType.html @@ -1,4 +1,4 @@ -FeeHandlerType | Packages Example

Enumeration FeeHandlerType

Enumeration Members

BASIC +FeeHandlerType | Packages Example

Enumeration FeeHandlerType

Enumeration Members

BASIC PERCENTAGE TWAP -

Enumeration Members

BASIC

BASIC: "basic"

PERCENTAGE

PERCENTAGE: "percentage"

TWAP

TWAP: "twap"

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

BASIC

BASIC: "basic"

PERCENTAGE

PERCENTAGE: "percentage"

TWAP

TWAP: "twap"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/_buildwithsygma_core.IndexerUrl.html b/enums/_buildwithsygma_core.IndexerUrl.html index ac28fad82..74bad314c 100644 --- a/enums/_buildwithsygma_core.IndexerUrl.html +++ b/enums/_buildwithsygma_core.IndexerUrl.html @@ -1,3 +1,3 @@ -IndexerUrl | Packages Example

Enumeration IndexerUrl

Enumeration Members

MAINNET +IndexerUrl | Packages Example

Enumeration IndexerUrl

Enumeration Members

MAINNET TESTNET -

Enumeration Members

MAINNET

MAINNET: "https://api.buildwithsygma.com"

TESTNET

TESTNET: "https://api.test.buildwithsygma.com"

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

MAINNET

MAINNET: "https://api.buildwithsygma.com"

TESTNET

TESTNET: "https://api.test.buildwithsygma.com"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/_buildwithsygma_core.Network.html b/enums/_buildwithsygma_core.Network.html index b16fc8d4a..810571635 100644 --- a/enums/_buildwithsygma_core.Network.html +++ b/enums/_buildwithsygma_core.Network.html @@ -1,4 +1,4 @@ -Network | Packages Example

Enumeration Network

Enumeration Members

BITCOIN +Network | Packages Example

Enumeration Network

Enumeration Members

BITCOIN EVM SUBSTRATE -

Enumeration Members

BITCOIN

BITCOIN: "btc"

EVM

EVM: "evm"

SUBSTRATE

SUBSTRATE: "substrate"

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

BITCOIN

BITCOIN: "btc"

EVM

EVM: "evm"

SUBSTRATE

SUBSTRATE: "substrate"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/_buildwithsygma_core.ResourceType.html b/enums/_buildwithsygma_core.ResourceType.html index 6d9aaacef..c8ba7ebc2 100644 --- a/enums/_buildwithsygma_core.ResourceType.html +++ b/enums/_buildwithsygma_core.ResourceType.html @@ -1,5 +1,5 @@ -ResourceType | Packages Example

Enumeration ResourceType

Enumeration Members

FUNGIBLE +ResourceType | Packages Example

Enumeration ResourceType

Enumeration Members

FUNGIBLE NON_FUNGIBLE PERMISSIONED_GENERIC PERMISSIONLESS_GENERIC -

Enumeration Members

FUNGIBLE

FUNGIBLE: "fungible"

NON_FUNGIBLE

NON_FUNGIBLE: "nonfungible"

PERMISSIONED_GENERIC

PERMISSIONED_GENERIC: "permissionedGeneric"

PERMISSIONLESS_GENERIC

PERMISSIONLESS_GENERIC: "permissionlessGeneric"

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

FUNGIBLE

FUNGIBLE: "fungible"

NON_FUNGIBLE

NON_FUNGIBLE: "nonfungible"

PERMISSIONED_GENERIC

PERMISSIONED_GENERIC: "permissionedGeneric"

PERMISSIONLESS_GENERIC

PERMISSIONLESS_GENERIC: "permissionlessGeneric"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/_buildwithsygma_core.RouteType.html b/enums/_buildwithsygma_core.RouteType.html index 9324612fd..f70d9f5a1 100644 --- a/enums/_buildwithsygma_core.RouteType.html +++ b/enums/_buildwithsygma_core.RouteType.html @@ -1,3 +1,3 @@ -RouteType | Packages Example

Enumeration RouteType

Enumeration Members

FUNGIBLE +RouteType | Packages Example

Enumeration RouteType

Enumeration Members

FUNGIBLE GMP -

Enumeration Members

FUNGIBLE

FUNGIBLE: "fungible"

GMP

GMP: "gmp"

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

FUNGIBLE

FUNGIBLE: "fungible"

GMP

GMP: "gmp"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/_buildwithsygma_core.SecurityModel.html b/enums/_buildwithsygma_core.SecurityModel.html index 7af80f96d..547cdce95 100644 --- a/enums/_buildwithsygma_core.SecurityModel.html +++ b/enums/_buildwithsygma_core.SecurityModel.html @@ -1,2 +1,2 @@ -SecurityModel | Packages Example

Enumeration SecurityModel

Enumeration Members

MPC -

Enumeration Members

MPC

MPC: "mpc"

Settings

Member Visibility

On This Page

Enumeration Members
+SecurityModel | Packages Example

Enumeration SecurityModel

Enumeration Members

MPC +

Enumeration Members

MPC

MPC: "mpc"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/functions/_buildwithsygma_core.getDomains.html b/functions/_buildwithsygma_core.getDomains.html index 7332f4cc3..13d1725b6 100644 --- a/functions/_buildwithsygma_core.getDomains.html +++ b/functions/_buildwithsygma_core.getDomains.html @@ -2,4 +2,4 @@ By default it will fetch domains configured for mainnet bridge deployment. Alternative option can be specified in options.env. You can filter domains with specifity types or ones that have at least one outbound route of specified type.

-

Parameters

Returns Promise<Domain[]>

Settings

Member Visibility
+

Parameters

Returns Promise<Domain[]>

Settings

Member Visibility
diff --git a/functions/_buildwithsygma_core.getEnvironmentMetadata.html b/functions/_buildwithsygma_core.getEnvironmentMetadata.html index c6f5d522f..5fb9551b9 100644 --- a/functions/_buildwithsygma_core.getEnvironmentMetadata.html +++ b/functions/_buildwithsygma_core.getEnvironmentMetadata.html @@ -4,4 +4,4 @@

Parameters

  • environment: Environment = process.env.SYGMA_ENV

    The environment key from the Environment enum.

Returns Promise<EnvironmentMetadata>

An object mapping domain IDs to {DomainMetadata}.

Throws

Throws an error if the environment does not have defined metadata.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/_buildwithsygma_core.getRawConfiguration.html b/functions/_buildwithsygma_core.getRawConfiguration.html index 175ac2b18..9e8266d55 100644 --- a/functions/_buildwithsygma_core.getRawConfiguration.html +++ b/functions/_buildwithsygma_core.getRawConfiguration.html @@ -1,2 +1,2 @@ getRawConfiguration | Packages Example

Function getRawConfiguration

  • getRawConfiguration(environment?): Promise<SygmaConfig>

  • End users shouldn't really need that but lets expose for power users

    -

    Parameters

    Returns Promise<SygmaConfig>

Settings

Member Visibility
+

Parameters

Returns Promise<SygmaConfig>

Settings

Member Visibility
diff --git a/functions/_buildwithsygma_core.getRoutes.html b/functions/_buildwithsygma_core.getRoutes.html index d1a738b72..ffe5a6e5c 100644 --- a/functions/_buildwithsygma_core.getRoutes.html +++ b/functions/_buildwithsygma_core.getRoutes.html @@ -1,4 +1,4 @@ getRoutes | Packages Example

Function getRoutes

  • getRoutes(source, environment?, options?): Promise<Route[]>

  • Returns supported routes originating from given source domain.

    Parameters

    • source: Domainlike

      Either caip2 identifier or chainId or Domain Object from SDK

    • environment: Environment = process.env.SYGMA_ENV
    • Optionaloptions: {
          routeTypes?: RouteType[];
          sourceProvider?: Eip1193Provider;
      }

      Allows selecting bridge instance (mainnet by default) and filtering routes by type.

      -

    Returns Promise<Route[]>

Settings

Member Visibility
+

Returns Promise<Route[]>

Settings

Member Visibility
diff --git a/functions/_buildwithsygma_core.getSygmaScanLink.html b/functions/_buildwithsygma_core.getSygmaScanLink.html index 73addc567..0cfe91791 100644 --- a/functions/_buildwithsygma_core.getSygmaScanLink.html +++ b/functions/_buildwithsygma_core.getSygmaScanLink.html @@ -1 +1 @@ -getSygmaScanLink | Packages Example

Function getSygmaScanLink

  • getSygmaScanLink(sourceHash, environment): string

  • Parameters

    Returns string

Settings

Member Visibility
+getSygmaScanLink | Packages Example

Function getSygmaScanLink

  • getSygmaScanLink(sourceHash, environment): string

  • Parameters

    Returns string

Settings

Member Visibility
diff --git a/functions/_buildwithsygma_core.getTransferStatus.html b/functions/_buildwithsygma_core.getTransferStatus.html index d9cb72ded..82a8af646 100644 --- a/functions/_buildwithsygma_core.getTransferStatus.html +++ b/functions/_buildwithsygma_core.getTransferStatus.html @@ -1,2 +1,2 @@ getTransferStatus | Packages Example

Function getTransferStatus

Settings

Member Visibility
+

Parameters

Returns Promise<TransferStatusResponse>

Settings

Member Visibility
diff --git a/functions/_buildwithsygma_core.isValidAddressForNetwork.html b/functions/_buildwithsygma_core.isValidAddressForNetwork.html index dbdebea63..4b07ab26f 100644 --- a/functions/_buildwithsygma_core.isValidAddressForNetwork.html +++ b/functions/_buildwithsygma_core.isValidAddressForNetwork.html @@ -1,2 +1,2 @@ isValidAddressForNetwork | Packages Example

Function isValidAddressForNetwork

  • isValidAddressForNetwork(address, network): boolean

  • Validate Address based on network.

    -

    Parameters

    Returns boolean

Settings

Member Visibility
+

Parameters

Returns boolean

Settings

Member Visibility
diff --git a/functions/_buildwithsygma_core.isValidBitcoinAddress.html b/functions/_buildwithsygma_core.isValidBitcoinAddress.html index 8d74bdc15..3b7f8ade9 100644 --- a/functions/_buildwithsygma_core.isValidBitcoinAddress.html +++ b/functions/_buildwithsygma_core.isValidBitcoinAddress.html @@ -1,2 +1,2 @@ isValidBitcoinAddress | Packages Example

Function isValidBitcoinAddress

  • isValidBitcoinAddress(address): boolean

  • Validate Bitcoin address.

    -

    Parameters

    • address: string

    Returns boolean

Settings

Member Visibility
+

Parameters

Returns boolean

Settings

Member Visibility
diff --git a/functions/_buildwithsygma_core.isValidEvmAddress.html b/functions/_buildwithsygma_core.isValidEvmAddress.html index aad6a9c8b..7f0f8ec4f 100644 --- a/functions/_buildwithsygma_core.isValidEvmAddress.html +++ b/functions/_buildwithsygma_core.isValidEvmAddress.html @@ -1,2 +1,2 @@ isValidEvmAddress | Packages Example

Function isValidEvmAddress

  • isValidEvmAddress(address): boolean

  • Validate EVM address.

    -

    Parameters

    • address: string

    Returns boolean

Settings

Member Visibility
+

Parameters

Returns boolean

Settings

Member Visibility
diff --git a/functions/_buildwithsygma_core.isValidSubstrateAddress.html b/functions/_buildwithsygma_core.isValidSubstrateAddress.html index c3b4c07f5..d5e8699c4 100644 --- a/functions/_buildwithsygma_core.isValidSubstrateAddress.html +++ b/functions/_buildwithsygma_core.isValidSubstrateAddress.html @@ -1,2 +1,2 @@ isValidSubstrateAddress | Packages Example

Function isValidSubstrateAddress

  • isValidSubstrateAddress(address): boolean

  • Validate Substrate address.

    -

    Parameters

    • address: string

    Returns boolean

Settings

Member Visibility
+

Parameters

Returns boolean

Settings

Member Visibility
diff --git a/functions/_buildwithsygma_evm.approve.html b/functions/_buildwithsygma_evm.approve.html index af0625056..45cb03620 100644 --- a/functions/_buildwithsygma_evm.approve.html +++ b/functions/_buildwithsygma_evm.approve.html @@ -3,4 +3,4 @@
  • spender: string

    The address for which the token is being approved.

  • amountOrIdForApproval: string

    The amount or tokenId to be approved.

    • Returns Promise<PopulatedTransaction>

    A promise that resolves to a contract receipt once the approval transaction is executed.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.createCrossChainContractCall.html b/functions/_buildwithsygma_evm.createCrossChainContractCall.html index a70f0f755..6cb298f09 100644 --- a/functions/_buildwithsygma_evm.createCrossChainContractCall.html +++ b/functions/_buildwithsygma_evm.createCrossChainContractCall.html @@ -1,2 +1,2 @@ createCrossChainContractCall | Packages Example

    Function createCrossChainContractCall

    Settings

    Member Visibility
    +

    Type Parameters

    Parameters

    Returns Promise<GenericMessageTransfer<ContractAbi, FunctionName>>

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.createFungibleAssetTransfer.html b/functions/_buildwithsygma_evm.createFungibleAssetTransfer.html index b7d148cc1..bd312009a 100644 --- a/functions/_buildwithsygma_evm.createFungibleAssetTransfer.html +++ b/functions/_buildwithsygma_evm.createFungibleAssetTransfer.html @@ -1,2 +1,2 @@ createFungibleAssetTransfer | Packages Example

    Function createFungibleAssetTransfer

    Settings

    Member Visibility
    +

    Parameters

    Returns Promise<FungibleAssetTransfer>

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.createNonFungibleAssetTransfer.html b/functions/_buildwithsygma_evm.createNonFungibleAssetTransfer.html index 9fda14df1..dc64b07bc 100644 --- a/functions/_buildwithsygma_evm.createNonFungibleAssetTransfer.html +++ b/functions/_buildwithsygma_evm.createNonFungibleAssetTransfer.html @@ -1 +1 @@ -createNonFungibleAssetTransfer | Packages Example

    Function createNonFungibleAssetTransfer

    Settings

    Member Visibility
    +createNonFungibleAssetTransfer | Packages Example

    Function createNonFungibleAssetTransfer

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.createTransactionRequest.html b/functions/_buildwithsygma_evm.createTransactionRequest.html index fc2883282..c16bcbae7 100644 --- a/functions/_buildwithsygma_evm.createTransactionRequest.html +++ b/functions/_buildwithsygma_evm.createTransactionRequest.html @@ -1,4 +1,4 @@ createTransactionRequest | Packages Example

    Function createTransactionRequest

    Settings

    Member Visibility
    +

    Returns TransactionRequest

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.executeDeposit.html b/functions/_buildwithsygma_evm.executeDeposit.html index 6b75db87b..fe7766747 100644 --- a/functions/_buildwithsygma_evm.executeDeposit.html +++ b/functions/_buildwithsygma_evm.executeDeposit.html @@ -5,4 +5,4 @@
  • feeData: EvmFee

    The fee data result for the deposit operation.

  • bridgeInstance: Bridge

    The bridge instance used to perform the deposit operation.

  • Optionaloverrides: PayableOverrides

    • Returns Promise<PopulatedTransaction>

    Unsigned transaction

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.getERC20Allowance.html b/functions/_buildwithsygma_evm.getERC20Allowance.html index 5a14fb093..e6520c82a 100644 --- a/functions/_buildwithsygma_evm.getERC20Allowance.html +++ b/functions/_buildwithsygma_evm.getERC20Allowance.html @@ -6,4 +6,4 @@
  • senderAddress: string

    The address of the token sender.

  • spender: string

    The address for which the token allowance is checked.

    • Returns Promise<BigNumber>

    A promise that resolves to a number representing the current allowance of the ERC20 token.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.getEvmErc20Balance.html b/functions/_buildwithsygma_evm.getEvmErc20Balance.html index 2d73ce446..35ddfdcf4 100644 --- a/functions/_buildwithsygma_evm.getEvmErc20Balance.html +++ b/functions/_buildwithsygma_evm.getEvmErc20Balance.html @@ -3,4 +3,4 @@
  • tokenAddress: string

    ERC20 token address

  • address: string

    EVM address to query

    • Returns Promise<bigint>

    balance

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.getEvmHandlerBalance.html b/functions/_buildwithsygma_evm.getEvmHandlerBalance.html index 45f4d8920..889a0e761 100644 --- a/functions/_buildwithsygma_evm.getEvmHandlerBalance.html +++ b/functions/_buildwithsygma_evm.getEvmHandlerBalance.html @@ -2,4 +2,4 @@

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.getFeeInformation.html b/functions/_buildwithsygma_evm.getFeeInformation.html index 7fc1180a2..574b70e98 100644 --- a/functions/_buildwithsygma_evm.getFeeInformation.html +++ b/functions/_buildwithsygma_evm.getFeeInformation.html @@ -1 +1 @@ -getFeeInformation | Packages Example

    Function getFeeInformation

    • getFeeInformation(config, sourceProvider, sygmaSourceId, sygmaDestinationDomainId, sygmaResourceId): Promise<{
          feeHandlerAddress: string;
          feeHandlerType: FeeHandlerType;
      }>
    • Internal

      Parameters

      • config: Config
      • sourceProvider: BaseProvider
      • sygmaSourceId: number
      • sygmaDestinationDomainId: number
      • sygmaResourceId: string

      Returns Promise<{
          feeHandlerAddress: string;
          feeHandlerType: FeeHandlerType;
      }>

    Settings

    Member Visibility
    +getFeeInformation | Packages Example

    Function getFeeInformation

    • getFeeInformation(config, sourceProvider, sygmaSourceId, sygmaDestinationDomainId, sygmaResourceId): Promise<{
          feeHandlerAddress: string;
          feeHandlerType: FeeHandlerType;
      }>
    • Internal

      Parameters

      • config: Config
      • sourceProvider: BaseProvider
      • sygmaSourceId: number
      • sygmaDestinationDomainId: number
      • sygmaResourceId: string

      Returns Promise<{
          feeHandlerAddress: string;
          feeHandlerType: FeeHandlerType;
      }>

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.isApproved.html b/functions/_buildwithsygma_evm.isApproved.html index 7413ea104..1ec48d47f 100644 --- a/functions/_buildwithsygma_evm.isApproved.html +++ b/functions/_buildwithsygma_evm.isApproved.html @@ -6,4 +6,4 @@
  • spender: string

    The address for which the token approval status is checked.

  • tokenId: number

    The TokenId of the token to be checked.

    • Returns Promise<boolean>

    A promise that resolves to a boolean indicating whether the token is approved for the handler address.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_substrate.createDestIdMultilocationData.html b/functions/_buildwithsygma_substrate.createDestIdMultilocationData.html index 93ae6993b..765ee7cb5 100644 --- a/functions/_buildwithsygma_substrate.createDestIdMultilocationData.html +++ b/functions/_buildwithsygma_substrate.createDestIdMultilocationData.html @@ -1 +1 @@ -createDestIdMultilocationData | Packages Example

    Function createDestIdMultilocationData

    Settings

    Member Visibility
    +createDestIdMultilocationData | Packages Example

    Function createDestIdMultilocationData

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_substrate.createMultiAssetData.html b/functions/_buildwithsygma_substrate.createMultiAssetData.html index f9a62ecb9..244ec35fa 100644 --- a/functions/_buildwithsygma_substrate.createMultiAssetData.html +++ b/functions/_buildwithsygma_substrate.createMultiAssetData.html @@ -4,4 +4,4 @@

    Returns object

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_substrate.createSubstrateFungibleAssetTransfer.html b/functions/_buildwithsygma_substrate.createSubstrateFungibleAssetTransfer.html index 6d2d053a6..5b9cf68e8 100644 --- a/functions/_buildwithsygma_substrate.createSubstrateFungibleAssetTransfer.html +++ b/functions/_buildwithsygma_substrate.createSubstrateFungibleAssetTransfer.html @@ -1 +1 @@ -createSubstrateFungibleAssetTransfer | Packages Example

    Function createSubstrateFungibleAssetTransfer

    Settings

    Member Visibility
    +createSubstrateFungibleAssetTransfer | Packages Example

    Function createSubstrateFungibleAssetTransfer

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_substrate.deposit.html b/functions/_buildwithsygma_substrate.deposit.html index 2a161a1d7..d616699a4 100644 --- a/functions/_buildwithsygma_substrate.deposit.html +++ b/functions/_buildwithsygma_substrate.deposit.html @@ -10,4 +10,4 @@

    Returns SubmittableExtrinsic<"promise", SubmittableResult>

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_substrate.getAssetBalance.html b/functions/_buildwithsygma_substrate.getAssetBalance.html index 045db6087..2fc79608e 100644 --- a/functions/_buildwithsygma_substrate.getAssetBalance.html +++ b/functions/_buildwithsygma_substrate.getAssetBalance.html @@ -3,4 +3,4 @@
  • assetID: number

    The ID of the asset to query. More details

  • accountAddress: string

    The address of the account for which to retrieve the asset balance.

    • Returns Promise<AssetBalance>

    A promise that resolves with the retrieved asset balance.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_substrate.getBasicFee.html b/functions/_buildwithsygma_substrate.getBasicFee.html index b00f93eb3..0ee412d32 100644 --- a/functions/_buildwithsygma_substrate.getBasicFee.html +++ b/functions/_buildwithsygma_substrate.getBasicFee.html @@ -7,4 +7,4 @@

    Throws
  • destinationDomainId: number

    The ID of the domain.

  • xcmMultiAssetId: XcmMultiAssetIdType

    The XCM MultiAsset ID of the asset. More details

    • Returns Promise<SubstrateFee>

    A promise that resolves to a SubstrateFee object.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_substrate.getFeeHandler.html b/functions/_buildwithsygma_substrate.getFeeHandler.html index b39486754..5c8ac1177 100644 --- a/functions/_buildwithsygma_substrate.getFeeHandler.html +++ b/functions/_buildwithsygma_substrate.getFeeHandler.html @@ -4,4 +4,4 @@
  • destinationDomainId: number

    The ID of the domain.

  • xcmMultiAssetId: XcmMultiAssetIdType

    The XCM MultiAsset ID of the asset. More details

    • Returns Promise<FeeHandlerType>

    A promise that resolves to a FeeHandlerType object.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_substrate.getNativeTokenBalance.html b/functions/_buildwithsygma_substrate.getNativeTokenBalance.html index a36d18d82..80ebe1aa2 100644 --- a/functions/_buildwithsygma_substrate.getNativeTokenBalance.html +++ b/functions/_buildwithsygma_substrate.getNativeTokenBalance.html @@ -2,4 +2,4 @@

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_substrate.getPercentageFee.html b/functions/_buildwithsygma_substrate.getPercentageFee.html index 4a0762ffa..9a68020bb 100644 --- a/functions/_buildwithsygma_substrate.getPercentageFee.html +++ b/functions/_buildwithsygma_substrate.getPercentageFee.html @@ -5,4 +5,4 @@

    Throws

    Unable to retrieve fee from pallet

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_substrate.handleTxExtrinsicResult.html b/functions/_buildwithsygma_substrate.handleTxExtrinsicResult.html index b7ecac1c4..78976eb10 100644 --- a/functions/_buildwithsygma_substrate.handleTxExtrinsicResult.html +++ b/functions/_buildwithsygma_substrate.handleTxExtrinsicResult.html @@ -6,4 +6,4 @@
  • result: SubmittableResult

    The submittable result object.

  • unsub: (() => void)

    A function to stop listen for events.

  • Optionalcallbacks: DepositCallbacksType

    Optional callbacks for success and error cases.

    -

    • Returns void

    Settings

    Member Visibility
    +

    Returns void

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_substrate.throwErrorIfAny.html b/functions/_buildwithsygma_substrate.throwErrorIfAny.html index 78c16f3fe..4865c53c2 100644 --- a/functions/_buildwithsygma_substrate.throwErrorIfAny.html +++ b/functions/_buildwithsygma_substrate.throwErrorIfAny.html @@ -1 +1 @@ -throwErrorIfAny | Packages Example

    Function throwErrorIfAny

    Settings

    Member Visibility
    +throwErrorIfAny | Packages Example

    Function throwErrorIfAny

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_utils.broadcastTransaction.html b/functions/_buildwithsygma_utils.broadcastTransaction.html index 5af9263fb..0ded6948a 100644 --- a/functions/_buildwithsygma_utils.broadcastTransaction.html +++ b/functions/_buildwithsygma_utils.broadcastTransaction.html @@ -3,4 +3,4 @@
  • transaction id

    • Description

    Broadcast transaction to the network

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_utils.fetchUTXOS.html b/functions/_buildwithsygma_utils.fetchUTXOS.html index b444cc612..701f92794 100644 --- a/functions/_buildwithsygma_utils.fetchUTXOS.html +++ b/functions/_buildwithsygma_utils.fetchUTXOS.html @@ -3,4 +3,4 @@

    Returns Promise<Utxo[]>

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_utils.getFeeEstimates.html b/functions/_buildwithsygma_utils.getFeeEstimates.html index a2c127c2d..ea0fdb031 100644 --- a/functions/_buildwithsygma_utils.getFeeEstimates.html +++ b/functions/_buildwithsygma_utils.getFeeEstimates.html @@ -3,4 +3,4 @@
  • fee estimate

    • Description

    Get fee estimates from blockstream API

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_utils.hasEnoughLiquidity.html b/functions/_buildwithsygma_utils.hasEnoughLiquidity.html index f1184e69c..d602d56e8 100644 --- a/functions/_buildwithsygma_utils.hasEnoughLiquidity.html +++ b/functions/_buildwithsygma_utils.hasEnoughLiquidity.html @@ -1,3 +1,3 @@ hasEnoughLiquidity | Packages Example

    Function hasEnoughLiquidity

    • hasEnoughLiquidity(transfer, destinationProviderUrl): Promise<boolean>

    • Parameters

      • transfer: SubstrateFungibleAssetTransfer | FungibleAssetTransfer

        either an EVM or Substrate fungible asset transfer

      • destinationProviderUrl: string

        URL of the destination provider

        -

      Returns Promise<boolean>

    Settings

    Member Visibility
    +

    Returns Promise<boolean>

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_utils.processUtxos.html b/functions/_buildwithsygma_utils.processUtxos.html index 9bc4dfc04..bf526e5f3 100644 --- a/functions/_buildwithsygma_utils.processUtxos.html +++ b/functions/_buildwithsygma_utils.processUtxos.html @@ -4,4 +4,4 @@

    Returns Utxo[]

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/interfaces/_buildwithsygma_core.BaseConfig.html b/interfaces/_buildwithsygma_core.BaseConfig.html index 72330ee8e..75d2afd63 100644 --- a/interfaces/_buildwithsygma_core.BaseConfig.html +++ b/interfaces/_buildwithsygma_core.BaseConfig.html @@ -1,4 +1,4 @@ -BaseConfig | Packages Example

    Interface BaseConfig<T>

    interface BaseConfig<T> {
        blockConfirmations: number;
        bridge: string;
        caipId: string;
        chainId: number;
        id: number;
        name: string;
        nativeTokenDecimals: bigint;
        nativeTokenFullName: string;
        nativeTokenSymbol: string;
        resources: Resource[];
        startBlock: bigint;
        type: T;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Properties

    blockConfirmations +BaseConfig | Packages Example

    Interface BaseConfig<T>

    interface BaseConfig<T> {
        blockConfirmations: number;
        bridge: string;
        caipId: string;
        chainId: number;
        id: number;
        name: string;
        nativeTokenDecimals: bigint;
        nativeTokenFullName: string;
        nativeTokenSymbol: string;
        resources: Resource[];
        startBlock: bigint;
        type: T;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Properties

    blockConfirmations bridge caipId chainId @@ -10,4 +10,4 @@ resources startBlock type -

    Properties

    blockConfirmations

    blockConfirmations: number

    bridge

    bridge: string

    caipId

    caipId: string

    chainId

    chainId: number

    id

    id: number

    name

    name: string

    nativeTokenDecimals

    nativeTokenDecimals: bigint

    nativeTokenFullName

    nativeTokenFullName: string

    nativeTokenSymbol

    nativeTokenSymbol: string

    resources

    resources: Resource[]

    startBlock

    startBlock: bigint

    type

    type: T

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    blockConfirmations

    blockConfirmations: number

    bridge

    bridge: string

    caipId

    caipId: string

    chainId

    chainId: number

    id

    id: number

    name

    name: string

    nativeTokenDecimals

    nativeTokenDecimals: bigint

    nativeTokenFullName

    nativeTokenFullName: string

    nativeTokenSymbol

    nativeTokenSymbol: string

    resources

    resources: Resource[]

    startBlock

    startBlock: bigint

    type

    type: T

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_core.BaseTransferParams.html b/interfaces/_buildwithsygma_core.BaseTransferParams.html index 0cf85d724..8a192be67 100644 --- a/interfaces/_buildwithsygma_core.BaseTransferParams.html +++ b/interfaces/_buildwithsygma_core.BaseTransferParams.html @@ -1,5 +1,5 @@ -BaseTransferParams | Packages Example

    Interface BaseTransferParams

    interface BaseTransferParams {
        destination: Domainlike;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
    }

    Properties

    destination +BaseTransferParams | Packages Example

    Interface BaseTransferParams

    interface BaseTransferParams {
        destination: Domainlike;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
    }

    Properties

    destination resource source sourceAddress -

    Properties

    destination

    destination: Domainlike

    resource

    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    destination

    destination: Domainlike

    resource

    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_core.BitcoinConfig.html b/interfaces/_buildwithsygma_core.BitcoinConfig.html index 8b88d51e0..6b6fedcce 100644 --- a/interfaces/_buildwithsygma_core.BitcoinConfig.html +++ b/interfaces/_buildwithsygma_core.BitcoinConfig.html @@ -1,4 +1,4 @@ -BitcoinConfig | Packages Example

    Interface BitcoinConfig

    interface BitcoinConfig {
        blockConfirmations: number;
        bridge: string;
        caipId: string;
        chainId: number;
        feeAddress: string;
        id: number;
        name: string;
        nativeTokenDecimals: bigint;
        nativeTokenFullName: string;
        nativeTokenSymbol: string;
        resources: Resource[];
        startBlock: bigint;
        type: BITCOIN;
    }

    Hierarchy (view full)

    Properties

    blockConfirmations +BitcoinConfig | Packages Example

    Interface BitcoinConfig

    interface BitcoinConfig {
        blockConfirmations: number;
        bridge: string;
        caipId: string;
        chainId: number;
        feeAddress: string;
        id: number;
        name: string;
        nativeTokenDecimals: bigint;
        nativeTokenFullName: string;
        nativeTokenSymbol: string;
        resources: Resource[];
        startBlock: bigint;
        type: BITCOIN;
    }

    Hierarchy (view full)

    Properties

    blockConfirmations bridge caipId chainId @@ -11,4 +11,4 @@ resources startBlock type -

    Properties

    blockConfirmations

    blockConfirmations: number

    bridge

    bridge: string

    caipId

    caipId: string

    chainId

    chainId: number

    feeAddress

    feeAddress: string

    id

    id: number

    name

    name: string

    nativeTokenDecimals

    nativeTokenDecimals: bigint

    nativeTokenFullName

    nativeTokenFullName: string

    nativeTokenSymbol

    nativeTokenSymbol: string

    resources

    resources: Resource[]

    startBlock

    startBlock: bigint

    type

    type: BITCOIN

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    blockConfirmations

    blockConfirmations: number

    bridge

    bridge: string

    caipId

    caipId: string

    chainId

    chainId: number

    feeAddress

    feeAddress: string

    id

    id: number

    name

    name: string

    nativeTokenDecimals

    nativeTokenDecimals: bigint

    nativeTokenFullName

    nativeTokenFullName: string

    nativeTokenSymbol

    nativeTokenSymbol: string

    resources

    resources: Resource[]

    startBlock

    startBlock: bigint

    type

    type: BITCOIN

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_core.Eip1193Provider.html b/interfaces/_buildwithsygma_core.Eip1193Provider.html index ca3f2414a..2f8305f1e 100644 --- a/interfaces/_buildwithsygma_core.Eip1193Provider.html +++ b/interfaces/_buildwithsygma_core.Eip1193Provider.html @@ -1,2 +1,2 @@ -Eip1193Provider | Packages Example

    Interface Eip1193Provider

    interface Eip1193Provider {
        request(request: {
            method: string;
            params?: unknown[] | Record<string, unknown>;
        }): Promise<unknown>;
    }

    Methods

    request -

    Methods

    request

    • request(request): Promise<unknown>

    • Parameters

      • request: {
            method: string;
            params?: unknown[] | Record<string, unknown>;
        }
        • method: string
        • Optionalparams?: unknown[] | Record<string, unknown>

      Returns Promise<unknown>

    Settings

    Member Visibility

    On This Page

    Methods
    +Eip1193Provider | Packages Example

    Interface Eip1193Provider

    interface Eip1193Provider {
        request(request: {
            method: string;
            params?: unknown[] | Record<string, unknown>;
        }): Promise<unknown>;
    }

    Methods

    request +

    Methods

    request

    • request(request): Promise<unknown>

    • Parameters

      • request: {
            method: string;
            params?: unknown[] | Record<string, unknown>;
        }
        • method: string
        • Optionalparams?: unknown[] | Record<string, unknown>

      Returns Promise<unknown>

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/interfaces/_buildwithsygma_core.EthereumConfig.html b/interfaces/_buildwithsygma_core.EthereumConfig.html index a92e13145..32f60db0b 100644 --- a/interfaces/_buildwithsygma_core.EthereumConfig.html +++ b/interfaces/_buildwithsygma_core.EthereumConfig.html @@ -1,4 +1,4 @@ -EthereumConfig | Packages Example

    Interface EthereumConfig

    interface EthereumConfig {
        blockConfirmations: number;
        bridge: string;
        caipId: string;
        chainId: number;
        feeHandlers: FeeHandler[];
        feeRouter: string;
        handlers: Handler[];
        id: number;
        name: string;
        nativeTokenDecimals: bigint;
        nativeTokenFullName: string;
        nativeTokenSymbol: string;
        resources: Resource[];
        startBlock: bigint;
        type: EVM;
    }

    Hierarchy (view full)

    Properties

    blockConfirmations +EthereumConfig | Packages Example

    Interface EthereumConfig

    interface EthereumConfig {
        blockConfirmations: number;
        bridge: string;
        caipId: string;
        chainId: number;
        feeHandlers: FeeHandler[];
        feeRouter: string;
        handlers: Handler[];
        id: number;
        name: string;
        nativeTokenDecimals: bigint;
        nativeTokenFullName: string;
        nativeTokenSymbol: string;
        resources: Resource[];
        startBlock: bigint;
        type: EVM;
    }

    Hierarchy (view full)

    Properties

    blockConfirmations bridge caipId chainId @@ -13,4 +13,4 @@ resources startBlock type -

    Properties

    blockConfirmations

    blockConfirmations: number

    bridge

    bridge: string

    caipId

    caipId: string

    chainId

    chainId: number

    feeHandlers

    feeHandlers: FeeHandler[]

    feeRouter

    feeRouter: string

    handlers

    handlers: Handler[]

    id

    id: number

    name

    name: string

    nativeTokenDecimals

    nativeTokenDecimals: bigint

    nativeTokenFullName

    nativeTokenFullName: string

    nativeTokenSymbol

    nativeTokenSymbol: string

    resources

    resources: Resource[]

    startBlock

    startBlock: bigint

    type

    type: EVM

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    blockConfirmations

    blockConfirmations: number

    bridge

    bridge: string

    caipId

    caipId: string

    chainId

    chainId: number

    feeHandlers

    feeHandlers: FeeHandler[]

    feeRouter

    feeRouter: string

    handlers

    handlers: Handler[]

    id

    id: number

    name

    name: string

    nativeTokenDecimals

    nativeTokenDecimals: bigint

    nativeTokenFullName

    nativeTokenFullName: string

    nativeTokenSymbol

    nativeTokenSymbol: string

    resources

    resources: Resource[]

    startBlock

    startBlock: bigint

    type

    type: EVM

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_core.SubstrateConfig.html b/interfaces/_buildwithsygma_core.SubstrateConfig.html index 8aa79b287..32813627a 100644 --- a/interfaces/_buildwithsygma_core.SubstrateConfig.html +++ b/interfaces/_buildwithsygma_core.SubstrateConfig.html @@ -1,4 +1,4 @@ -SubstrateConfig | Packages Example

    Interface SubstrateConfig

    interface SubstrateConfig {
        blockConfirmations: number;
        bridge: string;
        caipId: string;
        chainId: number;
        handlers: Handler[];
        id: number;
        name: string;
        nativeTokenDecimals: bigint;
        nativeTokenFullName: string;
        nativeTokenSymbol: string;
        parachainId: number;
        resources: Resource[];
        startBlock: bigint;
        type: SUBSTRATE;
    }

    Hierarchy (view full)

    Properties

    blockConfirmations +SubstrateConfig | Packages Example

    Interface SubstrateConfig

    interface SubstrateConfig {
        blockConfirmations: number;
        bridge: string;
        caipId: string;
        chainId: number;
        handlers: Handler[];
        id: number;
        name: string;
        nativeTokenDecimals: bigint;
        nativeTokenFullName: string;
        nativeTokenSymbol: string;
        parachainId: number;
        resources: Resource[];
        startBlock: bigint;
        type: SUBSTRATE;
    }

    Hierarchy (view full)

    Properties

    blockConfirmations bridge caipId chainId @@ -12,4 +12,4 @@ resources startBlock type -

    Properties

    blockConfirmations

    blockConfirmations: number

    bridge

    bridge: string

    caipId

    caipId: string

    chainId

    chainId: number

    handlers

    handlers: Handler[]

    id

    id: number

    name

    name: string

    nativeTokenDecimals

    nativeTokenDecimals: bigint

    nativeTokenFullName

    nativeTokenFullName: string

    nativeTokenSymbol

    nativeTokenSymbol: string

    parachainId

    parachainId: number

    resources

    resources: Resource[]

    startBlock

    startBlock: bigint

    type

    type: SUBSTRATE

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    blockConfirmations

    blockConfirmations: number

    bridge

    bridge: string

    caipId

    caipId: string

    chainId

    chainId: number

    handlers

    handlers: Handler[]

    id

    id: number

    name

    name: string

    nativeTokenDecimals

    nativeTokenDecimals: bigint

    nativeTokenFullName

    nativeTokenFullName: string

    nativeTokenSymbol

    nativeTokenSymbol: string

    parachainId

    parachainId: number

    resources

    resources: Resource[]

    startBlock

    startBlock: bigint

    type

    type: SUBSTRATE

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_core.SygmaConfig.html b/interfaces/_buildwithsygma_core.SygmaConfig.html index cee68f725..1f89a4cf2 100644 --- a/interfaces/_buildwithsygma_core.SygmaConfig.html +++ b/interfaces/_buildwithsygma_core.SygmaConfig.html @@ -1,2 +1,2 @@ -SygmaConfig | Packages Example

    Interface SygmaConfig

    interface SygmaConfig {
        domains: (EthereumConfig | SubstrateConfig | BitcoinConfig)[];
    }

    Properties

    domains -

    Properties

    domains

    domains: (EthereumConfig | SubstrateConfig | BitcoinConfig)[]

    Settings

    Member Visibility

    On This Page

    Properties
    +SygmaConfig | Packages Example

    Interface SygmaConfig

    interface SygmaConfig {
        domains: (EthereumConfig | SubstrateConfig | BitcoinConfig)[];
    }

    Properties

    domains +

    Properties

    domains

    domains: (EthereumConfig | SubstrateConfig | BitcoinConfig)[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_evm.EvmAssetTransferParams.html b/interfaces/_buildwithsygma_evm.EvmAssetTransferParams.html index 30f9b83da..5683c546b 100644 --- a/interfaces/_buildwithsygma_evm.EvmAssetTransferParams.html +++ b/interfaces/_buildwithsygma_evm.EvmAssetTransferParams.html @@ -1,4 +1,4 @@ -EvmAssetTransferParams | Packages Example

    Interface EvmAssetTransferParams

    interface EvmAssetTransferParams {
        amount?: bigint;
        destination: Domainlike;
        recipientAddress: string;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
        tokenId?: string;
    }

    Hierarchy (view full)

    Properties

    amount? +EvmAssetTransferParams | Packages Example

    Interface EvmAssetTransferParams

    interface EvmAssetTransferParams {
        amount?: bigint;
        destination: Domainlike;
        recipientAddress: string;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
        tokenId?: string;
    }

    Hierarchy (view full)

    Properties

    amount? destination recipientAddress resource @@ -6,4 +6,4 @@ sourceAddress sourceNetworkProvider tokenId? -

    Properties

    Optionalamount

    amount?: bigint

    destination

    destination: Domainlike

    recipientAddress

    recipientAddress: string

    resource

    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    sourceNetworkProvider

    sourceNetworkProvider: Eip1193Provider

    OptionaltokenId

    tokenId?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalamount

    amount?: bigint

    destination

    destination: Domainlike

    recipientAddress

    recipientAddress: string

    resource

    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    sourceNetworkProvider

    sourceNetworkProvider: Eip1193Provider

    OptionaltokenId

    tokenId?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_evm.EvmFeeCalculationParams.html b/interfaces/_buildwithsygma_evm.EvmFeeCalculationParams.html index f5a96d4d1..8b9512f55 100644 --- a/interfaces/_buildwithsygma_evm.EvmFeeCalculationParams.html +++ b/interfaces/_buildwithsygma_evm.EvmFeeCalculationParams.html @@ -1,6 +1,6 @@ EvmFeeCalculationParams | Packages Example

    Interface EvmFeeCalculationParams

    Parameters that are required to calculate fee for a Sygma transfer.

    -
    interface EvmFeeCalculationParams {
        depositData?: string;
        destinationSygmaId: number;
        feeHandlerAddress: string;
        feeHandlerType: FeeHandlerType;
        provider: Provider;
        resourceSygmaId: string;
        sender: string;
        sourceSygmaId: number;
    }

    Properties

    depositData? +
    interface EvmFeeCalculationParams {
        depositData?: string;
        destinationSygmaId: number;
        feeHandlerAddress: string;
        feeHandlerType: FeeHandlerType;
        provider: Provider;
        resourceSygmaId: string;
        sender: string;
        sourceSygmaId: number;
    }

    Properties

    depositData? destinationSygmaId feeHandlerAddress feeHandlerType @@ -8,4 +8,4 @@ resourceSygmaId sender sourceSygmaId -

    Properties

    OptionaldepositData

    depositData?: string

    destinationSygmaId

    destinationSygmaId: number

    feeHandlerAddress

    feeHandlerAddress: string

    feeHandlerType

    feeHandlerType: FeeHandlerType

    provider

    provider: Provider

    resourceSygmaId

    resourceSygmaId: string

    sender

    sender: string

    sourceSygmaId

    sourceSygmaId: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionaldepositData

    depositData?: string

    destinationSygmaId

    destinationSygmaId: number

    feeHandlerAddress

    feeHandlerAddress: string

    feeHandlerType

    feeHandlerType: FeeHandlerType

    provider

    provider: Provider

    resourceSygmaId

    resourceSygmaId: string

    sender

    sender: string

    sourceSygmaId

    sourceSygmaId: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_evm.EvmTransferFeeCalculationHandler.html b/interfaces/_buildwithsygma_evm.EvmTransferFeeCalculationHandler.html index a76dca990..2bd6abd53 100644 --- a/interfaces/_buildwithsygma_evm.EvmTransferFeeCalculationHandler.html +++ b/interfaces/_buildwithsygma_evm.EvmTransferFeeCalculationHandler.html @@ -1,3 +1,3 @@ -EvmTransferFeeCalculationHandler | Packages Example

    Interface EvmTransferFeeCalculationHandler

    interface EvmTransferFeeCalculationHandler {
        calculateFee(params: EvmFeeCalculationParams): Promise<EvmFee>;
        setNextHandler(handler: EvmTransferFeeCalculationHandler): EvmTransferFeeCalculationHandler;
    }

    Implemented by

    Methods

    calculateFee +EvmTransferFeeCalculationHandler | Packages Example

    Interface EvmTransferFeeCalculationHandler

    interface EvmTransferFeeCalculationHandler {
        calculateFee(params: EvmFeeCalculationParams): Promise<EvmFee>;
        setNextHandler(handler: EvmTransferFeeCalculationHandler): EvmTransferFeeCalculationHandler;
    }

    Implemented by

    Methods

    calculateFee setNextHandler -

    Methods

    calculateFee

    setNextHandler

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Methods

    calculateFee

    setNextHandler

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/interfaces/_buildwithsygma_evm.EvmTransferParams.html b/interfaces/_buildwithsygma_evm.EvmTransferParams.html index 3daf78388..12f0f25ad 100644 --- a/interfaces/_buildwithsygma_evm.EvmTransferParams.html +++ b/interfaces/_buildwithsygma_evm.EvmTransferParams.html @@ -1,6 +1,6 @@ -EvmTransferParams | Packages Example

    Interface EvmTransferParams

    interface EvmTransferParams {
        destination: Domainlike;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
    }

    Hierarchy (view full)

    Properties

    destination +EvmTransferParams | Packages Example

    Interface EvmTransferParams

    interface EvmTransferParams {
        destination: Domainlike;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
    }

    Hierarchy (view full)

    Properties

    destination resource source sourceAddress sourceNetworkProvider -

    Properties

    destination

    destination: Domainlike

    resource

    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    sourceNetworkProvider

    sourceNetworkProvider: Eip1193Provider

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    destination

    destination: Domainlike

    resource

    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    sourceNetworkProvider

    sourceNetworkProvider: Eip1193Provider

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_evm.FungibleTransferOptionalMessage.html b/interfaces/_buildwithsygma_evm.FungibleTransferOptionalMessage.html index e34dbc24b..d5462ab1a 100644 --- a/interfaces/_buildwithsygma_evm.FungibleTransferOptionalMessage.html +++ b/interfaces/_buildwithsygma_evm.FungibleTransferOptionalMessage.html @@ -1,4 +1,4 @@ -FungibleTransferOptionalMessage | Packages Example

    Interface FungibleTransferOptionalMessage

    interface FungibleTransferOptionalMessage {
        actions: FungibleDepositAction[];
        receiver: string;
        transactionId: string;
    }

    Properties

    actions +FungibleTransferOptionalMessage | Packages Example

    Interface FungibleTransferOptionalMessage

    interface FungibleTransferOptionalMessage {
        actions: FungibleDepositAction[];
        receiver: string;
        transactionId: string;
    }

    Properties

    actions receiver transactionId -

    Properties

    actions

    actions: FungibleDepositAction[]

    receiver

    receiver: string

    transactionId

    transactionId: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    actions

    actions: FungibleDepositAction[]

    receiver

    receiver: string

    transactionId

    transactionId: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_evm.FungibleTransferParams.html b/interfaces/_buildwithsygma_evm.FungibleTransferParams.html index 4c7cca700..0b95be06d 100644 --- a/interfaces/_buildwithsygma_evm.FungibleTransferParams.html +++ b/interfaces/_buildwithsygma_evm.FungibleTransferParams.html @@ -1,4 +1,4 @@ -FungibleTransferParams | Packages Example

    Interface FungibleTransferParams

    interface FungibleTransferParams {
        amount: bigint;
        destination: Domainlike;
        optionalGas?: bigint;
        optionalMessage?: FungibleTransferOptionalMessage;
        recipientAddress: string;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        securityModel?: SecurityModel;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
        tokenId?: string;
    }

    Hierarchy (view full)

    Properties

    amount +FungibleTransferParams | Packages Example

    Interface FungibleTransferParams

    interface FungibleTransferParams {
        amount: bigint;
        destination: Domainlike;
        optionalGas?: bigint;
        optionalMessage?: FungibleTransferOptionalMessage;
        recipientAddress: string;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        securityModel?: SecurityModel;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
        tokenId?: string;
    }

    Hierarchy (view full)

    Properties

    amount destination optionalGas? optionalMessage? @@ -9,4 +9,4 @@ sourceAddress sourceNetworkProvider tokenId? -

    Properties

    amount

    amount: bigint

    destination

    destination: Domainlike

    OptionaloptionalGas

    optionalGas?: bigint

    OptionaloptionalMessage

    optionalMessage?: FungibleTransferOptionalMessage

    recipientAddress

    recipientAddress: string

    resource

    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource

    OptionalsecurityModel

    securityModel?: SecurityModel

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    sourceNetworkProvider

    sourceNetworkProvider: Eip1193Provider

    OptionaltokenId

    tokenId?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    amount

    amount: bigint

    destination

    destination: Domainlike

    OptionaloptionalGas

    optionalGas?: bigint

    OptionaloptionalMessage

    optionalMessage?: FungibleTransferOptionalMessage

    recipientAddress

    recipientAddress: string

    resource

    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource

    OptionalsecurityModel

    securityModel?: SecurityModel

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    sourceNetworkProvider

    sourceNetworkProvider: Eip1193Provider

    OptionaltokenId

    tokenId?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_evm.GenericMessageTransferParams.html b/interfaces/_buildwithsygma_evm.GenericMessageTransferParams.html index b8123c964..a5a94e0fe 100644 --- a/interfaces/_buildwithsygma_evm.GenericMessageTransferParams.html +++ b/interfaces/_buildwithsygma_evm.GenericMessageTransferParams.html @@ -1,4 +1,4 @@ -GenericMessageTransferParams | Packages Example

    Interface GenericMessageTransferParams<ContractAbi, FunctionName>

    interface GenericMessageTransferParams<ContractAbi, FunctionName> {
        destination: Domainlike;
        destinationContractAbi: ContractAbi;
        destinationContractAddress: string;
        functionName: FunctionName;
        functionParameters: {
            [key in string | number | symbol]: {
                [key in string | number | symbol]: AbiParameterToPrimitiveType<Extract<Extract<ContractAbi[number], {
                    stateMutability: AbiStateMutability;
                    type: "function";
                }>, {
                    name: FunctionName;
                }>["inputs"][key<key>], "inputs">
            }[key]
        };
        gasLimit: bigint;
        maxFee: bigint;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
    }

    Type Parameters

    • ContractAbi extends Abi
    • FunctionName extends ExtractAbiFunctionNames<ContractAbi, "nonpayable" | "payable">

    Hierarchy (view full)

    Properties

    destination +GenericMessageTransferParams | Packages Example

    Interface GenericMessageTransferParams<ContractAbi, FunctionName>

    interface GenericMessageTransferParams<ContractAbi, FunctionName> {
        destination: Domainlike;
        destinationContractAbi: ContractAbi;
        destinationContractAddress: string;
        functionName: FunctionName;
        functionParameters: {
            [key in string | number | symbol]: {
                [key in string | number | symbol]: AbiParameterToPrimitiveType<Extract<Extract<ContractAbi[number], {
                    stateMutability: AbiStateMutability;
                    type: "function";
                }>, {
                    name: FunctionName;
                }>["inputs"][key<key>], "inputs">
            }[key]
        };
        gasLimit: bigint;
        maxFee: bigint;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
    }

    Type Parameters

    • ContractAbi extends Abi
    • FunctionName extends ExtractAbiFunctionNames<ContractAbi, "nonpayable" | "payable">

    Hierarchy (view full)

    Properties

    destination destinationContractAbi destinationContractAddress functionName @@ -9,4 +9,4 @@ source sourceAddress sourceNetworkProvider -

    Properties

    destination

    destination: Domainlike

    destinationContractAbi

    destinationContractAbi: ContractAbi

    destinationContractAddress

    destinationContractAddress: string

    functionName

    functionName: FunctionName

    functionParameters

    functionParameters: {
        [key in string | number | symbol]: {
            [key in string | number | symbol]: AbiParameterToPrimitiveType<Extract<Extract<ContractAbi[number], {
                stateMutability: AbiStateMutability;
                type: "function";
            }>, {
                name: FunctionName;
            }>["inputs"][key<key>], "inputs">
        }[key]
    }

    gasLimit

    gasLimit: bigint

    maxFee

    maxFee: bigint

    resource

    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    sourceNetworkProvider

    sourceNetworkProvider: Eip1193Provider

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    destination

    destination: Domainlike

    destinationContractAbi

    destinationContractAbi: ContractAbi

    destinationContractAddress

    destinationContractAddress: string

    functionName

    functionName: FunctionName

    functionParameters

    functionParameters: {
        [key in string | number | symbol]: {
            [key in string | number | symbol]: AbiParameterToPrimitiveType<Extract<Extract<ContractAbi[number], {
                stateMutability: AbiStateMutability;
                type: "function";
            }>, {
                name: FunctionName;
            }>["inputs"][key<key>], "inputs">
        }[key]
    }

    gasLimit

    gasLimit: bigint

    maxFee

    maxFee: bigint

    resource

    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    sourceNetworkProvider

    sourceNetworkProvider: Eip1193Provider

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_evm.NonFungibleTransferParams.html b/interfaces/_buildwithsygma_evm.NonFungibleTransferParams.html index d069ae1bc..ee135a249 100644 --- a/interfaces/_buildwithsygma_evm.NonFungibleTransferParams.html +++ b/interfaces/_buildwithsygma_evm.NonFungibleTransferParams.html @@ -1,4 +1,4 @@ -NonFungibleTransferParams | Packages Example

    Interface NonFungibleTransferParams

    interface NonFungibleTransferParams {
        amount?: bigint;
        destination: Domainlike;
        recipientAddress: string;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
        tokenId: string;
    }

    Hierarchy (view full)

    Properties

    amount? +NonFungibleTransferParams | Packages Example

    Interface NonFungibleTransferParams

    interface NonFungibleTransferParams {
        amount?: bigint;
        destination: Domainlike;
        recipientAddress: string;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
        tokenId: string;
    }

    Hierarchy (view full)

    Properties

    amount? destination recipientAddress resource @@ -6,4 +6,4 @@ sourceAddress sourceNetworkProvider tokenId -

    Properties

    Optionalamount

    amount?: bigint

    destination

    destination: Domainlike

    recipientAddress

    recipientAddress: string

    resource

    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    sourceNetworkProvider

    sourceNetworkProvider: Eip1193Provider

    tokenId

    tokenId: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalamount

    amount?: bigint

    destination

    destination: Domainlike

    recipientAddress

    recipientAddress: string

    resource

    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    sourceNetworkProvider

    sourceNetworkProvider: Eip1193Provider

    tokenId

    tokenId: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_evm.TransactionRequest.html b/interfaces/_buildwithsygma_evm.TransactionRequest.html index 53bd57487..671526a7a 100644 --- a/interfaces/_buildwithsygma_evm.TransactionRequest.html +++ b/interfaces/_buildwithsygma_evm.TransactionRequest.html @@ -1,5 +1,5 @@ -TransactionRequest | Packages Example

    Interface TransactionRequest

    interface TransactionRequest {
        data: string;
        gasLimit: bigint;
        to: string;
        value: bigint;
    }

    Properties

    data +TransactionRequest | Packages Example

    Interface TransactionRequest

    interface TransactionRequest {
        data: string;
        gasLimit: bigint;
        to: string;
        value: bigint;
    }

    Properties

    data gasLimit to value -

    Properties

    data

    data: string

    gasLimit

    gasLimit: bigint

    to

    to: string

    value

    value: bigint

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    data

    data: string

    gasLimit

    gasLimit: bigint

    to

    to: string

    value

    value: bigint

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_substrate.SubstrateAssetTransferRequest.html b/interfaces/_buildwithsygma_substrate.SubstrateAssetTransferRequest.html index 345c3d5e2..abf508a3f 100644 --- a/interfaces/_buildwithsygma_substrate.SubstrateAssetTransferRequest.html +++ b/interfaces/_buildwithsygma_substrate.SubstrateAssetTransferRequest.html @@ -1,8 +1,8 @@ -SubstrateAssetTransferRequest | Packages Example

    Interface SubstrateAssetTransferRequest

    interface SubstrateAssetTransferRequest {
        amount: bigint;
        destination: Domainlike;
        destinationAddress: string;
        resource:
            | string
            | SubstrateResource
            | EvmResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: ApiPromise;
    }

    Hierarchy

    • BaseTransferParams
      • SubstrateAssetTransferRequest

    Properties

    amount +SubstrateAssetTransferRequest | Packages Example

    Interface SubstrateAssetTransferRequest

    interface SubstrateAssetTransferRequest {
        amount: bigint;
        destination: Domainlike;
        destinationAddress: string;
        resource:
            | string
            | SubstrateResource
            | EvmResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: ApiPromise;
    }

    Hierarchy

    • BaseTransferParams
      • SubstrateAssetTransferRequest

    Properties

    amount destination destinationAddress resource source sourceAddress sourceNetworkProvider -

    Properties

    amount

    amount: bigint

    destination

    destination: Domainlike

    destinationAddress

    destinationAddress: string

    resource

    resource:
        | string
        | SubstrateResource
        | EvmResource
        | BitcoinResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    sourceNetworkProvider

    sourceNetworkProvider: ApiPromise

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    amount

    amount: bigint

    destination

    destination: Domainlike

    destinationAddress

    destinationAddress: string

    resource

    resource:
        | string
        | SubstrateResource
        | EvmResource
        | BitcoinResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    sourceNetworkProvider

    sourceNetworkProvider: ApiPromise

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/modules/_buildwithsygma_core.html b/modules/_buildwithsygma_core.html index 6f42215d5..6379330f7 100644 --- a/modules/_buildwithsygma_core.html +++ b/modules/_buildwithsygma_core.html @@ -1,4 +1,4 @@ -@buildwithsygma/core - v1.2.1 | Packages Example

    Module @buildwithsygma/core - v1.2.1

    +@buildwithsygma/core - v1.2.2 | Packages Example

    Module @buildwithsygma/core - v1.2.2

    Sygma SDK


    diff --git a/types/_buildwithsygma_core.BitcoinResource.html b/types/_buildwithsygma_core.BitcoinResource.html index 3bd20a005..38a5fa741 100644 --- a/types/_buildwithsygma_core.BitcoinResource.html +++ b/types/_buildwithsygma_core.BitcoinResource.html @@ -1 +1 @@ -BitcoinResource | Packages Example

    Type Alias BitcoinResource

    BitcoinResource: BaseResource & {
        address: string;
        feeAmount?: number;
        script: string;
        tweak: string;
    }

    Settings

    Member Visibility
    +BitcoinResource | Packages Example

    Type Alias BitcoinResource

    BitcoinResource: BaseResource & {
        address: string;
        feeAmount?: number;
        script: string;
        tweak: string;
    }

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.Domain.html b/types/_buildwithsygma_core.Domain.html index 3f2a41008..af2b2d11e 100644 --- a/types/_buildwithsygma_core.Domain.html +++ b/types/_buildwithsygma_core.Domain.html @@ -1 +1 @@ -Domain | Packages Example

    Type Alias Domain

    Domain: {
        caipId: string;
        chainId: number;
        feeAddress?: string;
        iconUrl?: string;
        id: number;
        name: string;
        parachainId?: ParachainId;
        type: Network;
    }

    Settings

    Member Visibility
    +Domain | Packages Example

    Type Alias Domain

    Domain: {
        caipId: string;
        chainId: number;
        feeAddress?: string;
        iconUrl?: string;
        id: number;
        name: string;
        parachainId?: ParachainId;
        type: Network;
    }

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.DomainMetadata.html b/types/_buildwithsygma_core.DomainMetadata.html index 110ad1664..9ef524f28 100644 --- a/types/_buildwithsygma_core.DomainMetadata.html +++ b/types/_buildwithsygma_core.DomainMetadata.html @@ -1 +1 @@ -DomainMetadata | Packages Example

    Type Alias DomainMetadata

    DomainMetadata: {
        url: string;
    }

    Settings

    Member Visibility
    +DomainMetadata | Packages Example

    Type Alias DomainMetadata

    DomainMetadata: {
        url: string;
    }

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.Domainlike.html b/types/_buildwithsygma_core.Domainlike.html index 3f6b5a791..048a690df 100644 --- a/types/_buildwithsygma_core.Domainlike.html +++ b/types/_buildwithsygma_core.Domainlike.html @@ -1 +1 @@ -Domainlike | Packages Example

    Type Alias Domainlike

    Domainlike: string | number | Domain

    Settings

    Member Visibility
    +Domainlike | Packages Example

    Type Alias Domainlike

    Domainlike: string | number | Domain

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.EnvironmentMetadata.html b/types/_buildwithsygma_core.EnvironmentMetadata.html index 637d88be8..bdc4653d3 100644 --- a/types/_buildwithsygma_core.EnvironmentMetadata.html +++ b/types/_buildwithsygma_core.EnvironmentMetadata.html @@ -1 +1 @@ -EnvironmentMetadata | Packages Example

    Type Alias EnvironmentMetadata

    EnvironmentMetadata: {
        [key: number]: DomainMetadata;
    }

    Settings

    Member Visibility
    +EnvironmentMetadata | Packages Example

    Type Alias EnvironmentMetadata

    EnvironmentMetadata: {
        [key: number]: DomainMetadata;
    }

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.EvmResource.html b/types/_buildwithsygma_core.EvmResource.html index 895bccc04..e9880211e 100644 --- a/types/_buildwithsygma_core.EvmResource.html +++ b/types/_buildwithsygma_core.EvmResource.html @@ -1 +1 @@ -EvmResource | Packages Example

    Type Alias EvmResource

    EvmResource: BaseResource & {
        address: string;
    }

    Settings

    Member Visibility
    +EvmResource | Packages Example

    Type Alias EvmResource

    EvmResource: BaseResource & {
        address: string;
    }

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.FeeHandler.html b/types/_buildwithsygma_core.FeeHandler.html index f42b2db4d..6ec1b21a3 100644 --- a/types/_buildwithsygma_core.FeeHandler.html +++ b/types/_buildwithsygma_core.FeeHandler.html @@ -1 +1 @@ -FeeHandler | Packages Example

    Type Alias FeeHandler

    FeeHandler: {
        address: string;
        type: FeeHandlerType;
    }

    Settings

    Member Visibility
    +FeeHandler | Packages Example

    Type Alias FeeHandler

    FeeHandler: {
        address: string;
        type: FeeHandlerType;
    }

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.Handler.html b/types/_buildwithsygma_core.Handler.html index 78137d8dc..2434d926c 100644 --- a/types/_buildwithsygma_core.Handler.html +++ b/types/_buildwithsygma_core.Handler.html @@ -1 +1 @@ -Handler | Packages Example

    Type Alias Handler

    Handler: {
        address: string;
        type: ResourceType;
    }

    Settings

    Member Visibility
    +Handler | Packages Example

    Type Alias Handler

    Handler: {
        address: string;
        type: ResourceType;
    }

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.HexString.html b/types/_buildwithsygma_core.HexString.html index 3572054c7..263ed22da 100644 --- a/types/_buildwithsygma_core.HexString.html +++ b/types/_buildwithsygma_core.HexString.html @@ -1 +1 @@ -HexString | Packages Example

    Type Alias HexString

    HexString: `0x${string}`

    Settings

    Member Visibility
    +HexString | Packages Example

    Type Alias HexString

    HexString: `0x${string}`

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.IndexerRoutesResponse.html b/types/_buildwithsygma_core.IndexerRoutesResponse.html index f8cef6a07..e654d2ef9 100644 --- a/types/_buildwithsygma_core.IndexerRoutesResponse.html +++ b/types/_buildwithsygma_core.IndexerRoutesResponse.html @@ -1 +1 @@ -IndexerRoutesResponse | Packages Example

    Type Alias IndexerRoutesResponse

    IndexerRoutesResponse: {
        routes: RouteIndexerType[];
    }

    Settings

    Member Visibility
    +IndexerRoutesResponse | Packages Example

    Type Alias IndexerRoutesResponse

    IndexerRoutesResponse: {
        routes: RouteIndexerType[];
    }

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.ParachainId.html b/types/_buildwithsygma_core.ParachainId.html index 97a14ef87..1eb835592 100644 --- a/types/_buildwithsygma_core.ParachainId.html +++ b/types/_buildwithsygma_core.ParachainId.html @@ -1 +1 @@ -ParachainId | Packages Example

    Type Alias ParachainId

    ParachainId: number

    Settings

    Member Visibility
    +ParachainId | Packages Example

    Type Alias ParachainId

    ParachainId: number

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.Resource.html b/types/_buildwithsygma_core.Resource.html index 8bae0cc68..ab355b95c 100644 --- a/types/_buildwithsygma_core.Resource.html +++ b/types/_buildwithsygma_core.Resource.html @@ -1 +1 @@ -Resource | Packages Example

    Type Alias Resource

    Resource: EvmResource | SubstrateResource | BitcoinResource

    Settings

    Member Visibility
    +Resource | Packages Example

    Type Alias Resource

    Resource: EvmResource | SubstrateResource | BitcoinResource

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.Route.html b/types/_buildwithsygma_core.Route.html index 2dcd24b51..5e8eb92db 100644 --- a/types/_buildwithsygma_core.Route.html +++ b/types/_buildwithsygma_core.Route.html @@ -1 +1 @@ -Route | Packages Example

    Type Alias Route

    Route: {
        feeHandler?: FeeHandler;
        fromDomain: Domain;
        resource: Resource;
        toDomain: Domain;
    }

    Settings

    Member Visibility
    +Route | Packages Example

    Type Alias Route

    Route: {
        feeHandler?: FeeHandler;
        fromDomain: Domain;
        resource: Resource;
        toDomain: Domain;
    }

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.RouteIndexerType.html b/types/_buildwithsygma_core.RouteIndexerType.html index acc8bf587..61ca68b79 100644 --- a/types/_buildwithsygma_core.RouteIndexerType.html +++ b/types/_buildwithsygma_core.RouteIndexerType.html @@ -1 +1 @@ -RouteIndexerType | Packages Example

    Type Alias RouteIndexerType

    RouteIndexerType: {
        fromDomainId: string;
        resourceId: string;
        toDomainId: string;
        type: RouteType;
    }

    Settings

    Member Visibility
    +RouteIndexerType | Packages Example

    Type Alias RouteIndexerType

    RouteIndexerType: {
        fromDomainId: string;
        resourceId: string;
        toDomainId: string;
        type: RouteType;
    }

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.SubstrateResource.html b/types/_buildwithsygma_core.SubstrateResource.html index 1c7235367..ddd420d7d 100644 --- a/types/_buildwithsygma_core.SubstrateResource.html +++ b/types/_buildwithsygma_core.SubstrateResource.html @@ -1 +1 @@ -SubstrateResource | Packages Example

    Type Alias SubstrateResource

    SubstrateResource: BaseResource & {
        assetID?: number;
        assetName: string;
        xcmMultiAssetId: XcmMultiAssetIdType;
    }

    Settings

    Member Visibility
    +SubstrateResource | Packages Example

    Type Alias SubstrateResource

    SubstrateResource: BaseResource & {
        assetID?: number;
        assetName: string;
        xcmMultiAssetId: XcmMultiAssetIdType;
    }

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.SygmaDomainConfig.html b/types/_buildwithsygma_core.SygmaDomainConfig.html index a95026e66..552a7c30e 100644 --- a/types/_buildwithsygma_core.SygmaDomainConfig.html +++ b/types/_buildwithsygma_core.SygmaDomainConfig.html @@ -1 +1 @@ -SygmaDomainConfig | Packages Example

    Type Alias SygmaDomainConfig

    SygmaDomainConfig: EthereumConfig | SubstrateConfig | BitcoinConfig

    Settings

    Member Visibility
    +SygmaDomainConfig | Packages Example

    Type Alias SygmaDomainConfig

    SygmaDomainConfig: EthereumConfig | SubstrateConfig | BitcoinConfig

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.TransferStatus.html b/types/_buildwithsygma_core.TransferStatus.html index a77021ed9..62b8f3d29 100644 --- a/types/_buildwithsygma_core.TransferStatus.html +++ b/types/_buildwithsygma_core.TransferStatus.html @@ -1 +1 @@ -TransferStatus | Packages Example

    Type Alias TransferStatus

    TransferStatus: "pending" | "executed" | "failed"

    Settings

    Member Visibility
    +TransferStatus | Packages Example

    Type Alias TransferStatus

    TransferStatus: "pending" | "executed" | "failed"

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.TransferStatusResponse.html b/types/_buildwithsygma_core.TransferStatusResponse.html index a4963b7c9..b045d4a01 100644 --- a/types/_buildwithsygma_core.TransferStatusResponse.html +++ b/types/_buildwithsygma_core.TransferStatusResponse.html @@ -1 +1 @@ -TransferStatusResponse | Packages Example

    Type Alias TransferStatusResponse

    TransferStatusResponse: {
        depositNonce: number;
        destinationHash: string;
        explorerUrl: string;
        fromDomainId: number;
        sourceHash: string;
        status: TransferStatus;
        toDomainId: number;
    }

    Settings

    Member Visibility
    +TransferStatusResponse | Packages Example

    Type Alias TransferStatusResponse

    TransferStatusResponse: {
        depositNonce: number;
        destinationHash: string;
        explorerUrl: string;
        fromDomainId: number;
        sourceHash: string;
        status: TransferStatus;
        toDomainId: number;
    }

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.XcmMultiAssetIdType.html b/types/_buildwithsygma_core.XcmMultiAssetIdType.html index 26fe4734d..0be7fffda 100644 --- a/types/_buildwithsygma_core.XcmMultiAssetIdType.html +++ b/types/_buildwithsygma_core.XcmMultiAssetIdType.html @@ -1 +1 @@ -XcmMultiAssetIdType | Packages Example

    Type Alias XcmMultiAssetIdType

    XcmMultiAssetIdType: {
        concrete: {
            interior: "here" | {
                x3: ({
                    parachain: number;
                } | {
                    generalKey: [number, string];
                })[];
            };
            parents: number;
        };
    }

    Settings

    Member Visibility
    +XcmMultiAssetIdType | Packages Example

    Type Alias XcmMultiAssetIdType

    XcmMultiAssetIdType: {
        concrete: {
            interior: "here" | {
                x3: ({
                    parachain: number;
                } | {
                    generalKey: [number, string];
                })[];
            };
            parents: number;
        };
    }

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_evm.EvmFee.html b/types/_buildwithsygma_evm.EvmFee.html index a2e49cdb6..169496f0e 100644 --- a/types/_buildwithsygma_evm.EvmFee.html +++ b/types/_buildwithsygma_evm.EvmFee.html @@ -8,4 +8,4 @@ percentage calculation is used

  • OptionaltokenAddress?: string

    fungible token ERC20 address

  • type: FeeHandlerType

    type of fee calculation that will be used

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_evm.EvmResourceish.html b/types/_buildwithsygma_evm.EvmResourceish.html index af11cb0c5..d78460bea 100644 --- a/types/_buildwithsygma_evm.EvmResourceish.html +++ b/types/_buildwithsygma_evm.EvmResourceish.html @@ -1,2 +1,2 @@ EvmResourceish | Packages Example

    Type Alias EvmResourceish

    EvmResourceish: string | EvmResource

    An EVM resource is accepted as either the resource object or it's Sygma ID

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/variables/_buildwithsygma_evm.ASSET_TRANSFER_GAS_LIMIT.html b/variables/_buildwithsygma_evm.ASSET_TRANSFER_GAS_LIMIT.html index cfcd94a8b..43fe04118 100644 --- a/variables/_buildwithsygma_evm.ASSET_TRANSFER_GAS_LIMIT.html +++ b/variables/_buildwithsygma_evm.ASSET_TRANSFER_GAS_LIMIT.html @@ -1 +1 @@ -ASSET_TRANSFER_GAS_LIMIT | Packages Example

    Variable ASSET_TRANSFER_GAS_LIMITConst

    ASSET_TRANSFER_GAS_LIMIT: BigNumber = ...

    Settings

    Member Visibility
    +ASSET_TRANSFER_GAS_LIMIT | Packages Example

    Variable ASSET_TRANSFER_GAS_LIMITConst

    ASSET_TRANSFER_GAS_LIMIT: BigNumber = ...

    Settings

    Member Visibility