From 3cdd9d7079f8befde3aae704bb053c6a61fbc51c Mon Sep 17 00:00:00 2001 From: Lykhoyda Date: Tue, 29 Oct 2024 15:33:29 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20sygmapro?= =?UTF-8?q?tocol/sygma-sdk@0f9af9aa06950e0e282f5b6ba9d2b9f43bbae3f2=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 +- ...dwithsygma_evm.createAssetDepositData.html | 2 +- ...ygma_evm.createCrossChainContractCall.html | 2 +- ...ithsygma_evm.createERC1155DepositData.html | 2 +- ...sygma_evm.createFungibleAssetTransfer.html | 2 +- ...ma_evm.createNonFungibleAssetTransfer.html | 2 +- ...a_evm.createSemiFungibleAssetTransfer.html | 2 +- ...vm.createSubstrateMultiLocationObject.html | 2 +- ...ithsygma_evm.createTransactionRequest.html | 2 +- ...ldwithsygma_evm.encodeOptionalMessage.html | 2 +- ..._buildwithsygma_evm.getERC20Allowance.html | 2 +- ...buildwithsygma_evm.getEvmErc20Balance.html | 2 +- ...ildwithsygma_evm.getEvmHandlerBalance.html | 2 +- ..._buildwithsygma_evm.getFeeInformation.html | 2 +- ...withsygma_evm.getTransactionOverrides.html | 2 +- functions/_buildwithsygma_evm.isApproved.html | 2 +- ...sygma_evm.serializeDestinationAddress.html | 2 +- ...uildwithsygma_evm.serializeEvmAddress.html | 2 +- ...thsygma_evm.serializeSubstrateAddress.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 +- ...ildwithsygma_utils.hasEnoughLiquidity.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 ++-- ...hsygma_evm.SemiFungibleTransferParams.html | 4 ++-- ...buildwithsygma_evm.TransactionRequest.html | 4 ++-- ...bstrate.SubstrateAssetTransferRequest.html | 4 ++-- .../_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 +- ....NativeTokenDepositArgsWithEVMMessage.html | 2 +- ...iveTokenDepositArgsWithGeneralMessage.html | 2 +- ....NativeTokenDepositArgsWithoutMessage.html | 2 +- ...thsygma_evm.NativeTokenDepositMethods.html | 2 +- ...ithsygma_evm.ASSET_TRANSFER_GAS_LIMIT.html | 2 +- 100 files changed, 143 insertions(+), 143 deletions(-) diff --git a/classes/_buildwithsygma_core.BaseTransfer.html b/classes/_buildwithsygma_core.BaseTransfer.html index 6d054f00c..9c086056e 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 environment sourceAddress @@ -12,8 +12,8 @@

Methods

isValidTransfer setDestinationDomain setResource -

Constructors

Protectedconstructor

Properties

ProtecteddestinationDomain

destinationDomain: Domain

Protectedenvironment

environment: Environment

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

Protectedenvironment

environment: Environment

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 73fa28182..e96d5afd4 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 48ec283fc..994384977 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 e52189a77..065717dd6 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 356c14793..a7631765f 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 e077314cd..41166b2ee 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 829173649..e4c1b3a4a 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 44ec07294..300bcebde 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 fbbf243a5..d1d34c8a2 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 18d46a5d6..8e41e12ab 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 aa8aa6496..190b10b3a 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 83450b811..10e8d7eab 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 9ef6d3a7b..1f0352982 100644 --- a/enums/_buildwithsygma_core.ResourceType.html +++ b/enums/_buildwithsygma_core.ResourceType.html @@ -1,6 +1,6 @@ -ResourceType | Packages Example

Enumeration ResourceType

Enumeration Members

FUNGIBLE +ResourceType | Packages Example

Enumeration ResourceType

Enumeration Members

FUNGIBLE NON_FUNGIBLE PERMISSIONED_GENERIC PERMISSIONLESS_GENERIC SEMI_FUNGIBLE -

Enumeration Members

FUNGIBLE

FUNGIBLE: "fungible"

NON_FUNGIBLE

NON_FUNGIBLE: "nonfungible"

PERMISSIONED_GENERIC

PERMISSIONED_GENERIC: "permissionedGeneric"

PERMISSIONLESS_GENERIC

PERMISSIONLESS_GENERIC: "permissionlessGeneric"

SEMI_FUNGIBLE

SEMI_FUNGIBLE: "semifungible"

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"

SEMI_FUNGIBLE

SEMI_FUNGIBLE: "semifungible"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/_buildwithsygma_core.RouteType.html b/enums/_buildwithsygma_core.RouteType.html index 8ff337679..ea198ab68 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 cbd7649fb..fdfc42613 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 62dd57203..db8157147 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 bf3dda876..b45527762 100644 --- a/functions/_buildwithsygma_core.getEnvironmentMetadata.html +++ b/functions/_buildwithsygma_core.getEnvironmentMetadata.html @@ -4,4 +4,4 @@

Parameters

  • environment: Environment = Environment.MAINNET

    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 a6db34c69..52ecacde2 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 bda89cbd5..d36c38ae1 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 = Environment.MAINNET
    • 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 eb91c72b8..9fcfeeca3 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 4cde13012..bb8e75391 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 c5c17848c..7045c7115 100644 --- a/functions/_buildwithsygma_core.isValidAddressForNetwork.html +++ b/functions/_buildwithsygma_core.isValidAddressForNetwork.html @@ -1,2 +1,2 @@ isValidAddressForNetwork | Packages Example

Function isValidAddressForNetwork

  • isValidAddressForNetwork(environment, 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 a64f0ff65..1663a325c 100644 --- a/functions/_buildwithsygma_core.isValidBitcoinAddress.html +++ b/functions/_buildwithsygma_core.isValidBitcoinAddress.html @@ -1,2 +1,2 @@ isValidBitcoinAddress | Packages Example

Function isValidBitcoinAddress

  • isValidBitcoinAddress(environment, address): boolean

  • Validate Bitcoin address.

    -

    Parameters

    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 66c2b1718..d94e44cd1 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 26e000c1d..539541564 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 c2e25373f..1122e5e7c 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.

  • Optionaloverrides: Overrides

    • 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.createAssetDepositData.html b/functions/_buildwithsygma_evm.createAssetDepositData.html index 15d51c10d..b51266aad 100644 --- a/functions/_buildwithsygma_evm.createAssetDepositData.html +++ b/functions/_buildwithsygma_evm.createAssetDepositData.html @@ -1 +1 @@ -createAssetDepositData | Packages Example

    Function createAssetDepositData

    Settings

    Member Visibility
    +createAssetDepositData | Packages Example

    Function createAssetDepositData

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.createCrossChainContractCall.html b/functions/_buildwithsygma_evm.createCrossChainContractCall.html index 423c8c287..f26acb827 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.createERC1155DepositData.html b/functions/_buildwithsygma_evm.createERC1155DepositData.html index 66fec6cb9..7654917c3 100644 --- a/functions/_buildwithsygma_evm.createERC1155DepositData.html +++ b/functions/_buildwithsygma_evm.createERC1155DepositData.html @@ -1 +1 @@ -createERC1155DepositData | Packages Example

    Function createERC1155DepositData

    Settings

    Member Visibility
    +createERC1155DepositData | Packages Example

    Function createERC1155DepositData

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.createFungibleAssetTransfer.html b/functions/_buildwithsygma_evm.createFungibleAssetTransfer.html index 6025a3449..93d71898e 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 d665a24d6..e59ed3cc1 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.createSemiFungibleAssetTransfer.html b/functions/_buildwithsygma_evm.createSemiFungibleAssetTransfer.html index 686ad3f2f..8d33ee79e 100644 --- a/functions/_buildwithsygma_evm.createSemiFungibleAssetTransfer.html +++ b/functions/_buildwithsygma_evm.createSemiFungibleAssetTransfer.html @@ -1 +1 @@ -createSemiFungibleAssetTransfer | Packages Example

    Function createSemiFungibleAssetTransfer

    Settings

    Member Visibility
    +createSemiFungibleAssetTransfer | Packages Example

    Function createSemiFungibleAssetTransfer

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.createSubstrateMultiLocationObject.html b/functions/_buildwithsygma_evm.createSubstrateMultiLocationObject.html index 4e71293f9..724583d29 100644 --- a/functions/_buildwithsygma_evm.createSubstrateMultiLocationObject.html +++ b/functions/_buildwithsygma_evm.createSubstrateMultiLocationObject.html @@ -1 +1 @@ -createSubstrateMultiLocationObject | Packages Example

    Function createSubstrateMultiLocationObject

    Settings

    Member Visibility
    +createSubstrateMultiLocationObject | Packages Example

    Function createSubstrateMultiLocationObject

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.createTransactionRequest.html b/functions/_buildwithsygma_evm.createTransactionRequest.html index 3943a31f7..9ac66f4e8 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.encodeOptionalMessage.html b/functions/_buildwithsygma_evm.encodeOptionalMessage.html index 76ecece31..0392b9ba2 100644 --- a/functions/_buildwithsygma_evm.encodeOptionalMessage.html +++ b/functions/_buildwithsygma_evm.encodeOptionalMessage.html @@ -1 +1 @@ -encodeOptionalMessage | Packages Example

    Function encodeOptionalMessage

    Settings

    Member Visibility
    +encodeOptionalMessage | Packages Example

    Function encodeOptionalMessage

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.getERC20Allowance.html b/functions/_buildwithsygma_evm.getERC20Allowance.html index 5d3735df7..79e5f8028 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 538a8da78..22c19e671 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 acf77318e..53af5f61a 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 165885e7f..9cee04655 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.getTransactionOverrides.html b/functions/_buildwithsygma_evm.getTransactionOverrides.html index 047b07d11..76f612d30 100644 --- a/functions/_buildwithsygma_evm.getTransactionOverrides.html +++ b/functions/_buildwithsygma_evm.getTransactionOverrides.html @@ -1 +1 @@ -getTransactionOverrides | Packages Example

    Function getTransactionOverrides

    Settings

    Member Visibility
    +getTransactionOverrides | Packages Example

    Function getTransactionOverrides

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.isApproved.html b/functions/_buildwithsygma_evm.isApproved.html index e94d837b3..a1cfe6157 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_evm.serializeDestinationAddress.html b/functions/_buildwithsygma_evm.serializeDestinationAddress.html index 052b3c3c1..0422f6cea 100644 --- a/functions/_buildwithsygma_evm.serializeDestinationAddress.html +++ b/functions/_buildwithsygma_evm.serializeDestinationAddress.html @@ -1 +1 @@ -serializeDestinationAddress | Packages Example

    Function serializeDestinationAddress

    Settings

    Member Visibility
    +serializeDestinationAddress | Packages Example

    Function serializeDestinationAddress

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.serializeEvmAddress.html b/functions/_buildwithsygma_evm.serializeEvmAddress.html index c97c6524b..a116eaf0a 100644 --- a/functions/_buildwithsygma_evm.serializeEvmAddress.html +++ b/functions/_buildwithsygma_evm.serializeEvmAddress.html @@ -1 +1 @@ -serializeEvmAddress | Packages Example

    Function serializeEvmAddress

    Settings

    Member Visibility
    +serializeEvmAddress | Packages Example

    Function serializeEvmAddress

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.serializeSubstrateAddress.html b/functions/_buildwithsygma_evm.serializeSubstrateAddress.html index dfbb2c415..31eed73be 100644 --- a/functions/_buildwithsygma_evm.serializeSubstrateAddress.html +++ b/functions/_buildwithsygma_evm.serializeSubstrateAddress.html @@ -1 +1 @@ -serializeSubstrateAddress | Packages Example

    Function serializeSubstrateAddress

    Settings

    Member Visibility
    +serializeSubstrateAddress | Packages Example

    Function serializeSubstrateAddress

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_substrate.createDestIdMultilocationData.html b/functions/_buildwithsygma_substrate.createDestIdMultilocationData.html index ac36b31ad..515d092c9 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 6985b8aa9..87d5455fd 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 cf7389b3d..da5a9be30 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 64d73efd0..8d7134f41 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 f2761c020..23d5062e9 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 b91294a26..5f1f38505 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 8947fae56..834475b6b 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 75d22b1d8..27d056011 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 8a624ce1d..f99020c51 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 ab0fb5a13..84eb1f235 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 4ca91f315..677067dc9 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.hasEnoughLiquidity.html b/functions/_buildwithsygma_utils.hasEnoughLiquidity.html index 0e022f3dd..e868c244d 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/interfaces/_buildwithsygma_core.BaseConfig.html b/interfaces/_buildwithsygma_core.BaseConfig.html index bbddecac2..662ad928e 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 207d025a3..f05a35b4d 100644 --- a/interfaces/_buildwithsygma_core.BaseTransferParams.html +++ b/interfaces/_buildwithsygma_core.BaseTransferParams.html @@ -1,6 +1,6 @@ -BaseTransferParams | Packages Example

    Interface BaseTransferParams

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

    Properties

    destination +BaseTransferParams | Packages Example

    Interface BaseTransferParams

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

    Properties

    destination environment? resource source sourceAddress -

    Properties

    destination

    destination: Domainlike

    Optionalenvironment

    environment?: Environment

    resource

    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    destination

    destination: Domainlike

    Optionalenvironment

    environment?: Environment

    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 82d8777e7..b0c1776a2 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 15b91c0ed..93bf5ea39 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 929a94fc8..00778e636 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;
        nativeTokenAdapter: 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;
        nativeTokenAdapter: string;
        nativeTokenDecimals: bigint;
        nativeTokenFullName: string;
        nativeTokenSymbol: string;
        resources: Resource[];
        startBlock: bigint;
        type: EVM;
    }

    Hierarchy (view full)

    Properties

    blockConfirmations bridge caipId chainId @@ -14,4 +14,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

    nativeTokenAdapter

    nativeTokenAdapter: 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

    nativeTokenAdapter

    nativeTokenAdapter: 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 1927a3be5..81523bbd2 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 9ccb472e8..2cfec0e66 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 ce2f62a05..d85e5e7bf 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;
        environment?: Environment;
        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;
        environment?: Environment;
        recipientAddress: string;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
        tokenId?: string;
    }

    Hierarchy (view full)

    Properties

    amount? destination environment? recipientAddress @@ -7,4 +7,4 @@ sourceAddress sourceNetworkProvider tokenId? -

    Properties

    Optionalamount

    amount?: bigint

    destination

    destination: Domainlike

    Optionalenvironment

    environment?: Environment

    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

    Optionalenvironment

    environment?: Environment

    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 eabc7c3ab..ae625ab6f 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 2b8ab3e19..24e5c702e 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 2a4116547..f87e41d46 100644 --- a/interfaces/_buildwithsygma_evm.EvmTransferParams.html +++ b/interfaces/_buildwithsygma_evm.EvmTransferParams.html @@ -1,7 +1,7 @@ -EvmTransferParams | Packages Example

    Interface EvmTransferParams

    interface EvmTransferParams {
        destination: Domainlike;
        environment?: Environment;
        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;
        environment?: Environment;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
    }

    Hierarchy (view full)

    Properties

    destination environment? resource source sourceAddress sourceNetworkProvider -

    Properties

    destination

    destination: Domainlike

    Optionalenvironment

    environment?: Environment

    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

    Optionalenvironment

    environment?: Environment

    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 953a8ac7d..f83e5878e 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 0f40feebe..79f299569 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;
        environment?: Environment;
        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;
        environment?: Environment;
        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 environment? optionalGas? @@ -10,4 +10,4 @@ sourceAddress sourceNetworkProvider tokenId? -

    Properties

    amount

    amount: bigint

    destination

    destination: Domainlike

    Optionalenvironment

    environment?: Environment

    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

    Optionalenvironment

    environment?: Environment

    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 be1992698..718cc33ec 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;
        environment?: Environment;
        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;
        environment?: Environment;
        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 environment? @@ -10,4 +10,4 @@ source sourceAddress sourceNetworkProvider -

    Properties

    destination

    destination: Domainlike

    destinationContractAbi

    destinationContractAbi: ContractAbi

    destinationContractAddress

    destinationContractAddress: string

    Optionalenvironment

    environment?: Environment

    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

    Optionalenvironment

    environment?: Environment

    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 7577241ba..f8d20354e 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;
        environment?: Environment;
        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;
        environment?: Environment;
        recipientAddress: string;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
        tokenId: string;
    }

    Hierarchy (view full)

    Properties

    amount? destination environment? recipientAddress @@ -7,4 +7,4 @@ sourceAddress sourceNetworkProvider tokenId -

    Properties

    Optionalamount

    amount?: bigint

    destination

    destination: Domainlike

    Optionalenvironment

    environment?: Environment

    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

    Optionalenvironment

    environment?: Environment

    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.SemiFungibleTransferParams.html b/interfaces/_buildwithsygma_evm.SemiFungibleTransferParams.html index f74cd5f72..09d46f9da 100644 --- a/interfaces/_buildwithsygma_evm.SemiFungibleTransferParams.html +++ b/interfaces/_buildwithsygma_evm.SemiFungibleTransferParams.html @@ -1,4 +1,4 @@ -SemiFungibleTransferParams | Packages Example

    Interface SemiFungibleTransferParams

    interface SemiFungibleTransferParams {
        amounts: bigint[];
        destination: Domainlike;
        environment?: Environment;
        recipientAddress: string;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
        tokenIds: string[];
    }

    Hierarchy (view full)

    Properties

    amounts +SemiFungibleTransferParams | Packages Example

    Interface SemiFungibleTransferParams

    interface SemiFungibleTransferParams {
        amounts: bigint[];
        destination: Domainlike;
        environment?: Environment;
        recipientAddress: string;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
        tokenIds: string[];
    }

    Hierarchy (view full)

    Properties

    amounts destination environment? recipientAddress @@ -7,4 +7,4 @@ sourceAddress sourceNetworkProvider tokenIds -

    Properties

    amounts

    amounts: bigint[]

    destination

    destination: Domainlike

    Optionalenvironment

    environment?: Environment

    recipientAddress

    recipientAddress: string

    resource

    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    sourceNetworkProvider

    sourceNetworkProvider: Eip1193Provider

    tokenIds

    tokenIds: string[]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    amounts

    amounts: bigint[]

    destination

    destination: Domainlike

    Optionalenvironment

    environment?: Environment

    recipientAddress

    recipientAddress: string

    resource

    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    sourceNetworkProvider

    sourceNetworkProvider: Eip1193Provider

    tokenIds

    tokenIds: string[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_evm.TransactionRequest.html b/interfaces/_buildwithsygma_evm.TransactionRequest.html index a08e332f9..1decfaf47 100644 --- a/interfaces/_buildwithsygma_evm.TransactionRequest.html +++ b/interfaces/_buildwithsygma_evm.TransactionRequest.html @@ -1,4 +1,4 @@ -TransactionRequest | Packages Example

    Interface TransactionRequest

    interface TransactionRequest {
        chainId?: number;
        data: string;
        gasLimit: bigint;
        gasPrice?: bigint;
        maxFeePerGas?: bigint;
        maxPriorityFeePerGas?: bigint;
        nonce?: number;
        to: string;
        type?: number;
        value: bigint;
    }

    Properties

    chainId? +TransactionRequest | Packages Example

    Interface TransactionRequest

    interface TransactionRequest {
        chainId?: number;
        data: string;
        gasLimit: bigint;
        gasPrice?: bigint;
        maxFeePerGas?: bigint;
        maxPriorityFeePerGas?: bigint;
        nonce?: number;
        to: string;
        type?: number;
        value: bigint;
    }

    Properties

    chainId? data gasLimit gasPrice? @@ -8,4 +8,4 @@ to type? value -

    Properties

    OptionalchainId

    chainId?: number

    data

    data: string

    gasLimit

    gasLimit: bigint

    OptionalgasPrice

    gasPrice?: bigint

    OptionalmaxFeePerGas

    maxFeePerGas?: bigint

    OptionalmaxPriorityFeePerGas

    maxPriorityFeePerGas?: bigint

    Optionalnonce

    nonce?: number

    to

    to: string

    Optionaltype

    type?: number

    value

    value: bigint

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalchainId

    chainId?: number

    data

    data: string

    gasLimit

    gasLimit: bigint

    OptionalgasPrice

    gasPrice?: bigint

    OptionalmaxFeePerGas

    maxFeePerGas?: bigint

    OptionalmaxPriorityFeePerGas

    maxPriorityFeePerGas?: bigint

    Optionalnonce

    nonce?: number

    to

    to: string

    Optionaltype

    type?: number

    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 ed7fceb83..289c322d3 100644 --- a/interfaces/_buildwithsygma_substrate.SubstrateAssetTransferRequest.html +++ b/interfaces/_buildwithsygma_substrate.SubstrateAssetTransferRequest.html @@ -1,4 +1,4 @@ -SubstrateAssetTransferRequest | Packages Example

    Interface SubstrateAssetTransferRequest

    interface SubstrateAssetTransferRequest {
        amount: bigint;
        destination: Domainlike;
        destinationAddress: string;
        environment?: Environment;
        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;
        environment?: Environment;
        resource:
            | string
            | SubstrateResource
            | EvmResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: ApiPromise;
    }

    Hierarchy

    • BaseTransferParams
      • SubstrateAssetTransferRequest

    Properties

    amount destination destinationAddress environment? @@ -6,4 +6,4 @@ source sourceAddress sourceNetworkProvider -

    Properties

    amount

    amount: bigint

    destination

    destination: Domainlike

    destinationAddress

    destinationAddress: string

    Optionalenvironment

    environment?: Environment

    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

    Optionalenvironment

    environment?: Environment

    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/types/_buildwithsygma_core.BitcoinResource.html b/types/_buildwithsygma_core.BitcoinResource.html index f0dba4ef2..48db76037 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 9e0b68b88..e86e6d8a5 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 1f1619cc8..51d6886cc 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 ec08b8c78..79b18d168 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 a10c7cd2b..d2a7f0d62 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 5b123918c..b91aef1e2 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 44df96fe4..123110064 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 81ca47772..b3dc75f40 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 7d6e3eb49..a440415b0 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 ed4fe6bf8..bbc8beef5 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 2764fbc71..d6ce99d4a 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 bdc32eb8e..9b37796ae 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 9c6a144ad..e28e70889 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 c80aa8743..57ad8e7e8 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 57cf92de0..d3bf0f0c8 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 b78223e34..d48c9b5a5 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 a9559efd6..0cdcac04c 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 8ed8fe2b5..3c023d8e8 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 57d0f4d86..02d01a8e2 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 fc069ccb6..9fe003ba5 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 7eb83b185..8f255bc29 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/types/_buildwithsygma_evm.NativeTokenDepositArgsWithEVMMessage.html b/types/_buildwithsygma_evm.NativeTokenDepositArgsWithEVMMessage.html index c4ab533e7..425c3a11a 100644 --- a/types/_buildwithsygma_evm.NativeTokenDepositArgsWithEVMMessage.html +++ b/types/_buildwithsygma_evm.NativeTokenDepositArgsWithEVMMessage.html @@ -1 +1 @@ -NativeTokenDepositArgsWithEVMMessage | Packages Example

    Type Alias NativeTokenDepositArgsWithEVMMessage

    NativeTokenDepositArgsWithEVMMessage: [string, string, bigint, string]

    Settings

    Member Visibility
    +NativeTokenDepositArgsWithEVMMessage | Packages Example

    Type Alias NativeTokenDepositArgsWithEVMMessage

    NativeTokenDepositArgsWithEVMMessage: [string, string, bigint, string]

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_evm.NativeTokenDepositArgsWithGeneralMessage.html b/types/_buildwithsygma_evm.NativeTokenDepositArgsWithGeneralMessage.html index 837a6efcb..f7875b64b 100644 --- a/types/_buildwithsygma_evm.NativeTokenDepositArgsWithGeneralMessage.html +++ b/types/_buildwithsygma_evm.NativeTokenDepositArgsWithGeneralMessage.html @@ -1 +1 @@ -NativeTokenDepositArgsWithGeneralMessage | Packages Example

    Type Alias NativeTokenDepositArgsWithGeneralMessage

    NativeTokenDepositArgsWithGeneralMessage: [string, string]

    Settings

    Member Visibility
    +NativeTokenDepositArgsWithGeneralMessage | Packages Example

    Type Alias NativeTokenDepositArgsWithGeneralMessage

    NativeTokenDepositArgsWithGeneralMessage: [string, string]

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_evm.NativeTokenDepositArgsWithoutMessage.html b/types/_buildwithsygma_evm.NativeTokenDepositArgsWithoutMessage.html index a0e9e57a6..f713d1b1b 100644 --- a/types/_buildwithsygma_evm.NativeTokenDepositArgsWithoutMessage.html +++ b/types/_buildwithsygma_evm.NativeTokenDepositArgsWithoutMessage.html @@ -1 +1 @@ -NativeTokenDepositArgsWithoutMessage | Packages Example

    Type Alias NativeTokenDepositArgsWithoutMessage

    NativeTokenDepositArgsWithoutMessage: [string, string]

    Settings

    Member Visibility
    +NativeTokenDepositArgsWithoutMessage | Packages Example

    Type Alias NativeTokenDepositArgsWithoutMessage

    NativeTokenDepositArgsWithoutMessage: [string, string]

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_evm.NativeTokenDepositMethods.html b/types/_buildwithsygma_evm.NativeTokenDepositMethods.html index 8ec83d9a4..23dd252ce 100644 --- a/types/_buildwithsygma_evm.NativeTokenDepositMethods.html +++ b/types/_buildwithsygma_evm.NativeTokenDepositMethods.html @@ -1 +1 @@ -NativeTokenDepositMethods | Packages Example

    Type Alias NativeTokenDepositMethods

    NativeTokenDepositMethods:
        | "deposit"
        | "depositToEVM"
        | "depositGeneral"
        | "depositToEVMWithMessage"

    Settings

    Member Visibility
    +NativeTokenDepositMethods | Packages Example

    Type Alias NativeTokenDepositMethods

    NativeTokenDepositMethods:
        | "deposit"
        | "depositToEVM"
        | "depositGeneral"
        | "depositToEVMWithMessage"

    Settings

    Member Visibility
    diff --git a/variables/_buildwithsygma_evm.ASSET_TRANSFER_GAS_LIMIT.html b/variables/_buildwithsygma_evm.ASSET_TRANSFER_GAS_LIMIT.html index c25358a53..7d0df82c7 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