From d2ea5f4d176f13947604c0348f1e49a1fcd6452f Mon Sep 17 00:00:00 2001 From: saadjhk <48211799+saadjhk@users.noreply.github.com> Date: Tue, 3 Sep 2024 14:14:24 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20sygmapro?= =?UTF-8?q?tocol/sygma-sdk@fcb5a6896c91d2a64892b3402f102a3e4b45a1f0=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 +- ...sygma_evm.constructSubstrateRecipient.html | 2 +- ...ygma_evm.createCrossChainContractCall.html | 2 +- ...ildwithsygma_evm.createERCDepositData.html | 2 +- ...ma_evm.createEvmFungibleAssetTransfer.html | 2 +- ...reatePermissionlessGenericDepositData.html | 2 +- ...ithsygma_evm.createTransactionRequest.html | 2 +- .../_buildwithsygma_evm.erc20Transfer.html | 2 +- .../_buildwithsygma_evm.executeDeposit.html | 2 +- ...dwithsygma_evm.genericMessageTransfer.html | 2 +- ..._buildwithsygma_evm.getERC20Allowance.html | 2 +- ...gma_evm.getEVMRecipientAddressInBytes.html | 2 +- ...buildwithsygma_evm.getEvmErc20Balance.html | 2 +- ...ildwithsygma_evm.getEvmHandlerBalance.html | 2 +- ..._buildwithsygma_evm.getFeeInformation.html | 2 +- ...m.getSubstrateRecipientAddressInBytes.html | 2 +- functions/_buildwithsygma_evm.isApproved.html | 2 +- ...ma_evm.serializeGenericCallParameters.html | 2 +- functions/_buildwithsygma_evm.toHex.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.Eip1193Provider.html | 4 ++-- .../_buildwithsygma_core.EthereumConfig.html | 4 ++-- .../_buildwithsygma_core.SubstrateConfig.html | 4 ++-- .../_buildwithsygma_core.SygmaConfig.html | 4 ++-- ...withsygma_evm.EvmFeeCalculationParams.html | 4 ++-- ..._evm.EvmTransferFeeCalculationHandler.html | 4 ++-- ...gma_evm.GenericMessageTransferRequest.html | 4 ++-- ...buildwithsygma_evm.TransactionRequest.html | 4 ++-- ...bstrate.SubstrateAssetTransferRequest.html | 4 ++-- modules/_buildwithsygma_core.html | 2 +- .../_buildwithsygma_core.BitcoinResource.html | 2 +- types/_buildwithsygma_core.Domain.html | 2 +- .../_buildwithsygma_core.DomainMetadata.html | 2 +- types/_buildwithsygma_core.Domainlike.html | 2 +- ...ildwithsygma_core.EnvironmentMetadata.html | 2 +- types/_buildwithsygma_core.EvmResource.html | 2 +- types/_buildwithsygma_core.FeeHandler.html | 2 +- types/_buildwithsygma_core.Handler.html | 2 +- ...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.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 +- ...dwithsygma_evm.FungibleTransferParams.html | 2 +- ...dwithsygma_evm.GenericTransferRequest.html | 2 +- ...ithsygma_evm.ASSET_TRANSFER_GAS_LIMIT.html | 2 +- 90 files changed, 126 insertions(+), 126 deletions(-) diff --git a/classes/_buildwithsygma_core.BaseTransfer.html b/classes/_buildwithsygma_core.BaseTransfer.html index 392f7944b..72bf4c2f6 100644 --- a/classes/_buildwithsygma_core.BaseTransfer.html +++ b/classes/_buildwithsygma_core.BaseTransfer.html @@ -1,4 +1,4 @@ -BaseTransfer | Packages Example

Class BaseTransferAbstract

Constructors

constructor +BaseTransfer | Packages Example

Class BaseTransferAbstract

Constructors

constructor

Properties

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

Methods

isValidTransfer setDestinationDomain setResource -

Constructors

Protectedconstructor

Properties

ProtecteddestinationDomain

destinationDomain: Domain

ProtectedsourceAddress

sourceAddress: string

ProtectedsourceDomain

sourceDomain: Domain

ProtectedsygmaConfiguration

sygmaConfiguration: Config

ProtectedtransferResource

transferResource: EvmResource | SubstrateResource

Accessors

config

destination

resource

source

Methods

isValidTransfer

  • isValidTransfer(): Promise<boolean>

  • Method that checks whether the transfer +

Constructors

Protectedconstructor

Properties

ProtecteddestinationDomain

destinationDomain: Domain

ProtectedsourceAddress

sourceAddress: string

ProtectedsourceDomain

sourceDomain: Domain

ProtectedsygmaConfiguration

sygmaConfiguration: Config

ProtectedtransferResource

transferResource: EvmResource | SubstrateResource

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 176ca2c31..1237e34d3 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

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 abdff1230..b986c4eba 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 6a975ce17..817dfb862 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 4e192b1d6..44eae1689 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 5a03cd466..f4674b3a9 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 8daa6bb16..2c0cebd34 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 b015a728b..b1ddc095f 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 bf23cbe8f..18454606b 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 6ae036b7e..e04079180 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 042e59538..8f5532ec8 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 bcc405bc3..3f857a8ed 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: "bitcoin"

EVM

EVM: "evm"

SUBSTRATE

SUBSTRATE: "substrate"

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

BITCOIN

BITCOIN: "bitcoin"

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 270f8eb83..a35833b21 100644 --- a/enums/_buildwithsygma_core.ResourceType.html +++ b/enums/_buildwithsygma_core.ResourceType.html @@ -1,5 +1,5 @@ -ResourceType | Packages Example

Enumeration ResourceType

Enumeration Members

FUNGIBLE +ResourceType | Packages Example

Enumeration ResourceType

Enumeration Members

FUNGIBLE NON_FUNGIBLE PERMISSIONED_GENERIC PERMISSIONLESS_GENERIC -

Enumeration Members

FUNGIBLE

FUNGIBLE: "fungible"

NON_FUNGIBLE

NON_FUNGIBLE: "nonfungible"

PERMISSIONED_GENERIC

PERMISSIONED_GENERIC: "permissionedGeneric"

PERMISSIONLESS_GENERIC

PERMISSIONLESS_GENERIC: "permissionlessGeneric"

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

FUNGIBLE

FUNGIBLE: "fungible"

NON_FUNGIBLE

NON_FUNGIBLE: "nonfungible"

PERMISSIONED_GENERIC

PERMISSIONED_GENERIC: "permissionedGeneric"

PERMISSIONLESS_GENERIC

PERMISSIONLESS_GENERIC: "permissionlessGeneric"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/_buildwithsygma_core.RouteType.html b/enums/_buildwithsygma_core.RouteType.html index b63d33885..8227cd425 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 da5951a45..46b3af6a5 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 ea25e6ffe..9793ca740 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 a9c5613b9..bfd948477 100644 --- a/functions/_buildwithsygma_core.getEnvironmentMetadata.html +++ b/functions/_buildwithsygma_core.getEnvironmentMetadata.html @@ -4,4 +4,4 @@

Parameters

  • environment: Environment = process.env.SYGMA_ENV

    The environment key from the Environment enum.

Returns Promise<EnvironmentMetadata>

An object mapping domain IDs to {DomainMetadata}.

Throws

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

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/_buildwithsygma_core.getRawConfiguration.html b/functions/_buildwithsygma_core.getRawConfiguration.html index 0fc2e8294..21d809545 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 958f2a0bd..9e8fa477e 100644 --- a/functions/_buildwithsygma_core.getRoutes.html +++ b/functions/_buildwithsygma_core.getRoutes.html @@ -1,4 +1,4 @@ getRoutes | Packages Example

Function getRoutes

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

  • Returns supported routes originating from given source domain.

    Parameters

    • source: Domainlike

      Either caip2 identifier or chainId or Domain Object from SDK

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

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

      -

    Returns Promise<Route[]>

Settings

Member Visibility
+

Returns Promise<Route[]>

Settings

Member Visibility
diff --git a/functions/_buildwithsygma_core.getSygmaScanLink.html b/functions/_buildwithsygma_core.getSygmaScanLink.html index 8b73bfc06..08a1ed28a 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 8a82a7bf8..da72b1e31 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 012f6d81c..ebbe7ed04 100644 --- a/functions/_buildwithsygma_core.isValidAddressForNetwork.html +++ b/functions/_buildwithsygma_core.isValidAddressForNetwork.html @@ -1,2 +1,2 @@ isValidAddressForNetwork | Packages Example

Function isValidAddressForNetwork

  • isValidAddressForNetwork(address, network): boolean

  • Validate Address based on network.

    -

    Parameters

    Returns boolean

Settings

Member Visibility
+

Parameters

Returns boolean

Settings

Member Visibility
diff --git a/functions/_buildwithsygma_core.isValidBitcoinAddress.html b/functions/_buildwithsygma_core.isValidBitcoinAddress.html index e6dd26642..67bfd0dc4 100644 --- a/functions/_buildwithsygma_core.isValidBitcoinAddress.html +++ b/functions/_buildwithsygma_core.isValidBitcoinAddress.html @@ -1,2 +1,2 @@ isValidBitcoinAddress | Packages Example

Function isValidBitcoinAddress

  • isValidBitcoinAddress(address): boolean

  • Validate Bitcoin address.

    -

    Parameters

    • address: string

    Returns boolean

Settings

Member Visibility
+

Parameters

Returns boolean

Settings

Member Visibility
diff --git a/functions/_buildwithsygma_core.isValidEvmAddress.html b/functions/_buildwithsygma_core.isValidEvmAddress.html index 6cc3d342d..a2252f91e 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 90cf4adbc..f1d6fe7ff 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 affe177b1..d74f4493c 100644 --- a/functions/_buildwithsygma_evm.approve.html +++ b/functions/_buildwithsygma_evm.approve.html @@ -3,4 +3,4 @@
  • spender: string

    The address for which the token is being approved.

  • amountOrIdForApproval: string

    The amount or tokenId to be approved.

    • Returns Promise<PopulatedTransaction>

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.constructSubstrateRecipient.html b/functions/_buildwithsygma_evm.constructSubstrateRecipient.html index a3782b45b..d51711e55 100644 --- a/functions/_buildwithsygma_evm.constructSubstrateRecipient.html +++ b/functions/_buildwithsygma_evm.constructSubstrateRecipient.html @@ -1,4 +1,4 @@ constructSubstrateRecipient | Packages Example

    Function constructSubstrateRecipient

    Converts a Substrate recipient address to a JSON multilocation.

    • constructSubstrateRecipient(recipientAddress, parachainId?): string

    • Parameters

      • recipientAddress: string

        The recipient address as a string.

      • OptionalparachainId: number

      Returns string

      The recipient address as a stringified Substrate Multilocation Object

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.createCrossChainContractCall.html b/functions/_buildwithsygma_evm.createCrossChainContractCall.html index 07319f905..d01e925c7 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.createERCDepositData.html b/functions/_buildwithsygma_evm.createERCDepositData.html index 96078906b..903337241 100644 --- a/functions/_buildwithsygma_evm.createERCDepositData.html +++ b/functions/_buildwithsygma_evm.createERCDepositData.html @@ -6,4 +6,4 @@
  • recipientAddress: string

    The address of the recipient.

  • OptionalparachainId: number

    Optional parachain id if the substrate destination targets another parachain.

    • Returns string

    The deposit data as hex string

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.createEvmFungibleAssetTransfer.html b/functions/_buildwithsygma_evm.createEvmFungibleAssetTransfer.html index 438cbbdba..8c287a5cb 100644 --- a/functions/_buildwithsygma_evm.createEvmFungibleAssetTransfer.html +++ b/functions/_buildwithsygma_evm.createEvmFungibleAssetTransfer.html @@ -1,2 +1,2 @@ createEvmFungibleAssetTransfer | Packages Example

    Function createEvmFungibleAssetTransfer

    • createEvmFungibleAssetTransfer(params): Promise<EvmFungibleAssetTransfer>

    • Prepare a Sygma fungible token transfer

      -

      Parameters

      • params: EvmFungibleTransferRequest

      Returns Promise<EvmFungibleAssetTransfer>

    Settings

    Member Visibility
    +

    Parameters

    Returns Promise<EvmFungibleAssetTransfer>

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.createPermissionlessGenericDepositData.html b/functions/_buildwithsygma_evm.createPermissionlessGenericDepositData.html index 4fcb7fecb..7ac6b984d 100644 --- a/functions/_buildwithsygma_evm.createPermissionlessGenericDepositData.html +++ b/functions/_buildwithsygma_evm.createPermissionlessGenericDepositData.html @@ -4,4 +4,4 @@
  • maxFee: string

    max fee defined

  • depositor: string

    address of depositor on source chain

  • executionData: string

    the data to pass as parameter of the function being called on destination chain

    -

    • Returns string

    Settings

    Member Visibility
    +

    Returns string

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.createTransactionRequest.html b/functions/_buildwithsygma_evm.createTransactionRequest.html index 4fadec764..e81e8ced8 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.erc20Transfer.html b/functions/_buildwithsygma_evm.erc20Transfer.html index 77e7cac9d..13c877e36 100644 --- a/functions/_buildwithsygma_evm.erc20Transfer.html +++ b/functions/_buildwithsygma_evm.erc20Transfer.html @@ -6,4 +6,4 @@

    Returns Promise<PopulatedTransaction>

    -

    Settings

    Member Visibility
    +

    Settings

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

    The fee data result for the deposit operation.

  • bridgeInstance: Bridge

    The bridge instance used to perform the deposit operation.

  • Optionaloverrides: PayableOverrides

    • Returns Promise<PopulatedTransaction>

    Unsigned transaction

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.genericMessageTransfer.html b/functions/_buildwithsygma_evm.genericMessageTransfer.html index 75770f3c6..b8447c6ef 100644 --- a/functions/_buildwithsygma_evm.genericMessageTransfer.html +++ b/functions/_buildwithsygma_evm.genericMessageTransfer.html @@ -1,3 +1,3 @@ genericMessageTransfer | Packages Example

    Function genericMessageTransfer

    Create a generic cross chain message transaction using typechain and ethers

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.getERC20Allowance.html b/functions/_buildwithsygma_evm.getERC20Allowance.html index d98f1f373..c08f324eb 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.getEVMRecipientAddressInBytes.html b/functions/_buildwithsygma_evm.getEVMRecipientAddressInBytes.html index 56873a7f8..930016b84 100644 --- a/functions/_buildwithsygma_evm.getEVMRecipientAddressInBytes.html +++ b/functions/_buildwithsygma_evm.getEVMRecipientAddressInBytes.html @@ -1,4 +1,4 @@ getEVMRecipientAddressInBytes | Packages Example

    Function getEVMRecipientAddressInBytes

    Converts a EVM recipient address to a Uint8Array of bytes.

    • getEVMRecipientAddressInBytes(recipientAddress): Uint8Array

    • Parameters

      • recipientAddress: string

        The recipient address, as a string.

      Returns Uint8Array

      The recipient address as a Uint8Array of bytes

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.getEvmErc20Balance.html b/functions/_buildwithsygma_evm.getEvmErc20Balance.html index 90df77750..c99ca7386 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 7da735ee5..1def9da3f 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 dfa8ec18c..49a9c45a7 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.getSubstrateRecipientAddressInBytes.html b/functions/_buildwithsygma_evm.getSubstrateRecipientAddressInBytes.html index d201bdb7c..90b8cdc51 100644 --- a/functions/_buildwithsygma_evm.getSubstrateRecipientAddressInBytes.html +++ b/functions/_buildwithsygma_evm.getSubstrateRecipientAddressInBytes.html @@ -1,4 +1,4 @@ getSubstrateRecipientAddressInBytes | Packages Example

    Function getSubstrateRecipientAddressInBytes

    Converts a Substrate recipient multilocation to a Uint8Array of bytes.

    • getSubstrateRecipientAddressInBytes(recipientAddress, parachainId?): Uint8Array

    • Parameters

      • recipientAddress: string

        The recipient address, as a string

      • OptionalparachainId: number

      Returns Uint8Array

      The recipient address as a Uint8Array of bytes

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.isApproved.html b/functions/_buildwithsygma_evm.isApproved.html index 16a2e758b..02f41da4c 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.serializeGenericCallParameters.html b/functions/_buildwithsygma_evm.serializeGenericCallParameters.html index 24bebef5a..53a8b60bc 100644 --- a/functions/_buildwithsygma_evm.serializeGenericCallParameters.html +++ b/functions/_buildwithsygma_evm.serializeGenericCallParameters.html @@ -1,3 +1,3 @@ serializeGenericCallParameters | Packages Example

    Function serializeGenericCallParameters

    • serializeGenericCallParameters(params): string

    • Convert JS primitive types to hex encoded strings for EVM function calls

      -

      Parameters

      • params: (
            | string
            | number
            | bigint
            | boolean
            | BigNumber)[]

      Returns string

    Settings

    Member Visibility
    +

    Parameters

    Returns string

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_evm.toHex.html b/functions/_buildwithsygma_evm.toHex.html index d57afcc91..463a60c65 100644 --- a/functions/_buildwithsygma_evm.toHex.html +++ b/functions/_buildwithsygma_evm.toHex.html @@ -2,4 +2,4 @@ based on ethers.utils.hexZeroPad

    Settings

    Member Visibility
    +

    Returns string

    Settings

    Member Visibility
    diff --git a/functions/_buildwithsygma_substrate.createDestIdMultilocationData.html b/functions/_buildwithsygma_substrate.createDestIdMultilocationData.html index fca8a38cb..9fd948766 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 7ef9ac7d2..c3033f22f 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 51fb0877e..aeb0b26da 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 2ac22c2aa..bea2d0ce6 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 2aaf2a52b..f2b85121c 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 006b2adef..dcc531a8f 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 c4273e825..cfe5c6995 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 8ef509182..5d045b3fa 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 d35b05915..3dccc3080 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 9d44330fa..51567ae53 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 c5d973788..ca2fa1dcf 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 97f2e2259..553c3c2fd 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 | EvmFungibleAssetTransfer

        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 c59c59d11..65fe2108d 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 6f0fd476b..2d3b07a01 100644 --- a/interfaces/_buildwithsygma_core.BaseTransferParams.html +++ b/interfaces/_buildwithsygma_core.BaseTransferParams.html @@ -1,5 +1,5 @@ -BaseTransferParams | Packages Example

    Interface BaseTransferParams

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

    Properties

    destination +BaseTransferParams | Packages Example

    Interface BaseTransferParams

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

    Properties

    destination resource source sourceAddress -

    Properties

    destination

    destination: Domainlike

    resource

    resource: string | EvmResource | SubstrateResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    destination

    destination: Domainlike

    resource

    resource: string | EvmResource | SubstrateResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_core.Eip1193Provider.html b/interfaces/_buildwithsygma_core.Eip1193Provider.html index cc9ff4b16..07b6a75e8 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 f87721cf0..3f901829d 100644 --- a/interfaces/_buildwithsygma_core.EthereumConfig.html +++ b/interfaces/_buildwithsygma_core.EthereumConfig.html @@ -1,4 +1,4 @@ -EthereumConfig | Packages Example

    Interface EthereumConfig

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

    Hierarchy (view full)

    Properties

    blockConfirmations +EthereumConfig | Packages Example

    Interface EthereumConfig

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

    Hierarchy (view full)

    Properties

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

    Properties

    blockConfirmations

    blockConfirmations: number

    bridge

    bridge: string

    caipId

    caipId: string

    chainId

    chainId: number

    feeHandlers

    feeHandlers: FeeHandler[]

    feeRouter

    feeRouter: string

    handlers

    handlers: Handler[]

    id

    id: number

    name

    name: string

    nativeTokenDecimals

    nativeTokenDecimals: bigint

    nativeTokenFullName

    nativeTokenFullName: string

    nativeTokenSymbol

    nativeTokenSymbol: string

    resources

    resources: Resource[]

    startBlock

    startBlock: bigint

    type

    type: EVM

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    blockConfirmations

    blockConfirmations: number

    bridge

    bridge: string

    caipId

    caipId: string

    chainId

    chainId: number

    feeHandlers

    feeHandlers: FeeHandler[]

    feeRouter

    feeRouter: string

    handlers

    handlers: Handler[]

    id

    id: number

    name

    name: string

    nativeTokenDecimals

    nativeTokenDecimals: bigint

    nativeTokenFullName

    nativeTokenFullName: string

    nativeTokenSymbol

    nativeTokenSymbol: string

    resources

    resources: Resource[]

    startBlock

    startBlock: bigint

    type

    type: EVM

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_core.SubstrateConfig.html b/interfaces/_buildwithsygma_core.SubstrateConfig.html index c2f6e096a..51167e246 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 020440fec..d2f7ce6d7 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)[];
    }

    Properties

    domains -

    Properties

    domains

    domains: (EthereumConfig | SubstrateConfig)[]

    Settings

    Member Visibility

    On This Page

    Properties
    +SygmaConfig | Packages Example

    Interface SygmaConfig

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

    Properties

    domains +

    Properties

    domains

    domains: (EthereumConfig | SubstrateConfig)[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_evm.EvmFeeCalculationParams.html b/interfaces/_buildwithsygma_evm.EvmFeeCalculationParams.html index 18466ea94..de22bb00f 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 443a590f3..fa8561706 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.GenericMessageTransferRequest.html b/interfaces/_buildwithsygma_evm.GenericMessageTransferRequest.html index d1d10b5b5..3e33035ad 100644 --- a/interfaces/_buildwithsygma_evm.GenericMessageTransferRequest.html +++ b/interfaces/_buildwithsygma_evm.GenericMessageTransferRequest.html @@ -1,6 +1,6 @@ GenericMessageTransferRequest | Packages Example

    Interface GenericMessageTransferRequest<ContractAbi, FunctionName>

    Required parameters for initiating a generic message transfer request

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

    Type Parameters

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

    Hierarchy

    • EvmTransferParams
      • GenericMessageTransferRequest

    Properties

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

    Type Parameters

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

    Hierarchy

    • EvmTransferParams
      • GenericMessageTransferRequest

    Properties

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

    Properties

    destination

    destination: Domainlike

    destinationContractAbi

    destinationContractAbi: ContractAbi

    destinationContractAddress

    destinationContractAddress: string

    functionName

    functionName: FunctionName

    functionParameters

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

    gasLimit

    gasLimit: bigint

    maxFee

    maxFee: bigint

    resource

    resource: string | EvmResource | SubstrateResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    sourceNetworkProvider

    sourceNetworkProvider: Eip1193Provider

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    destination

    destination: Domainlike

    destinationContractAbi

    destinationContractAbi: ContractAbi

    destinationContractAddress

    destinationContractAddress: string

    functionName

    functionName: FunctionName

    functionParameters

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

    gasLimit

    gasLimit: bigint

    maxFee

    maxFee: bigint

    resource

    resource: string | EvmResource | SubstrateResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    sourceNetworkProvider

    sourceNetworkProvider: Eip1193Provider

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_evm.TransactionRequest.html b/interfaces/_buildwithsygma_evm.TransactionRequest.html index 44616ddda..1da1a6262 100644 --- a/interfaces/_buildwithsygma_evm.TransactionRequest.html +++ b/interfaces/_buildwithsygma_evm.TransactionRequest.html @@ -1,5 +1,5 @@ -TransactionRequest | Packages Example

    Interface TransactionRequest

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

    Properties

    data +TransactionRequest | Packages Example

    Interface TransactionRequest

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

    Properties

    data gasLimit to value -

    Properties

    data

    data: string

    gasLimit

    gasLimit: bigint

    to

    to: string

    value

    value: bigint

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    data

    data: string

    gasLimit

    gasLimit: bigint

    to

    to: string

    value

    value: bigint

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/interfaces/_buildwithsygma_substrate.SubstrateAssetTransferRequest.html b/interfaces/_buildwithsygma_substrate.SubstrateAssetTransferRequest.html index 5efeb0b25..07b31e4ae 100644 --- a/interfaces/_buildwithsygma_substrate.SubstrateAssetTransferRequest.html +++ b/interfaces/_buildwithsygma_substrate.SubstrateAssetTransferRequest.html @@ -1,8 +1,8 @@ -SubstrateAssetTransferRequest | Packages Example

    Interface SubstrateAssetTransferRequest

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

    Hierarchy

    • BaseTransferParams
      • SubstrateAssetTransferRequest

    Properties

    amount +SubstrateAssetTransferRequest | Packages Example

    Interface SubstrateAssetTransferRequest

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

    Hierarchy

    • BaseTransferParams
      • SubstrateAssetTransferRequest

    Properties

    amount destination destinationAddress resource source sourceAddress sourceNetworkProvider -

    Properties

    amount

    amount: bigint

    destination

    destination: Domainlike

    destinationAddress

    destinationAddress: string

    resource

    resource: string | SubstrateResource | EvmResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    sourceNetworkProvider

    sourceNetworkProvider: ApiPromise

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    amount

    amount: bigint

    destination

    destination: Domainlike

    destinationAddress

    destinationAddress: string

    resource

    resource: string | SubstrateResource | EvmResource

    source

    source: Domainlike

    sourceAddress

    sourceAddress: string

    sourceNetworkProvider

    sourceNetworkProvider: ApiPromise

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/modules/_buildwithsygma_core.html b/modules/_buildwithsygma_core.html index ddf256812..aef8e6381 100644 --- a/modules/_buildwithsygma_core.html +++ b/modules/_buildwithsygma_core.html @@ -1,4 +1,4 @@ -@buildwithsygma/core - v1.0.2 | Packages Example

    Module @buildwithsygma/core - v1.0.2

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

    Module @buildwithsygma/core - v1.0.3

    Sygma SDK


    diff --git a/types/_buildwithsygma_core.BitcoinResource.html b/types/_buildwithsygma_core.BitcoinResource.html index 8e0a7cacb..fcf10538b 100644 --- a/types/_buildwithsygma_core.BitcoinResource.html +++ b/types/_buildwithsygma_core.BitcoinResource.html @@ -1 +1 @@ -BitcoinResource | Packages Example

    Type Alias BitcoinResource

    BitcoinResource: BaseResource & {
        script: string;
        tweak: string;
    }

    Settings

    Member Visibility
    +BitcoinResource | Packages Example

    Type Alias BitcoinResource

    BitcoinResource: BaseResource & {
        script: string;
        tweak: string;
    }

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.Domain.html b/types/_buildwithsygma_core.Domain.html index d06e21fd6..e28e89cc6 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;
        iconUrl?: string;
        id: number;
        name: string;
        parachainId?: ParachainId;
        type: Network;
    }

    Settings

    Member Visibility
    +Domain | Packages Example

    Type Alias Domain

    Domain: {
        caipId: string;
        chainId: number;
        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 15bbe5112..02efb60a2 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 a139da63d..521d72797 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 66fb88e2b..d8caa6579 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 6ab539c25..66369a843 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 de5c37a23..45c204884 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 b49a87622..538d0e0ba 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.IndexerRoutesResponse.html b/types/_buildwithsygma_core.IndexerRoutesResponse.html index da6dda33c..b22a5f8dd 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 b49c4cf75..055d2c927 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 382d13eb2..211672ed8 100644 --- a/types/_buildwithsygma_core.Resource.html +++ b/types/_buildwithsygma_core.Resource.html @@ -1 +1 @@ -Resource | Packages Example

    Type Alias Resource

    Resource: EvmResource | SubstrateResource

    Settings

    Member Visibility
    +Resource | Packages Example

    Type Alias Resource

    Resource: EvmResource | SubstrateResource

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_core.Route.html b/types/_buildwithsygma_core.Route.html index f0a351cd3..db8ca9c0e 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 61b345a58..66a41b622 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 c04969732..a36674c67 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.TransferStatus.html b/types/_buildwithsygma_core.TransferStatus.html index 4df3fcc70..bd51759d9 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 e2ca77f34..35fb3b039 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 e401f6959..2b222cac7 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 1a1b21a9a..cceaa167d 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 cba51c586..b81f96dd2 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.FungibleTransferParams.html b/types/_buildwithsygma_evm.FungibleTransferParams.html index 0742c8279..cff29e047 100644 --- a/types/_buildwithsygma_evm.FungibleTransferParams.html +++ b/types/_buildwithsygma_evm.FungibleTransferParams.html @@ -4,4 +4,4 @@
  • feeData: EvmFee

    The fee data associated with the ERC20 token transfer, including the gas price and gas limit.

  • Optionaloverrides?: ethers.PayableOverrides

    Optional overrides for the transaction, such as gas price, gas limit, or value.

  • resourceId: string

    The unique identifier for the resource being transferred.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/types/_buildwithsygma_evm.GenericTransferRequest.html b/types/_buildwithsygma_evm.GenericTransferRequest.html index d1419cea8..fb6f90a3b 100644 --- a/types/_buildwithsygma_evm.GenericTransferRequest.html +++ b/types/_buildwithsygma_evm.GenericTransferRequest.html @@ -1 +1 @@ -GenericTransferRequest | Packages Example

    Type Alias GenericTransferRequest

    GenericTransferRequest: {
        destinationContractAddress: string;
        destinationDomain: string | number | Domain;
        destinationFunctionSignature: string;
        executionData: string;
        gasLimit: bigint;
        securityModel?: SecurityModel;
        sourceDomain: string | number | Domain;
        sourceNetworkProvider: Eip1193Provider;
    }

    Settings

    Member Visibility
    +GenericTransferRequest | Packages Example

    Type Alias GenericTransferRequest

    GenericTransferRequest: {
        destinationContractAddress: string;
        destinationDomain: string | number | Domain;
        destinationFunctionSignature: string;
        executionData: string;
        gasLimit: bigint;
        securityModel?: SecurityModel;
        sourceDomain: string | number | Domain;
        sourceNetworkProvider: Eip1193Provider;
    }

    Settings

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