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

Constructors

constructor +BaseTransfer | Packages Example

Constructors

Properties

destinationDomain: Domain
sourceAddress: string
sourceDomain: Domain
sygmaConfiguration: Config

Accessors

Methods

  • Method that checks whether the transfer +

Constructors

Properties

destinationDomain: Domain
sourceAddress: string
sourceDomain: Domain
sygmaConfiguration: Config

Accessors

Methods

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

    -

    Returns Promise<boolean>

+

Returns Promise<boolean>

diff --git a/classes/_buildwithsygma_core.Config.html b/classes/_buildwithsygma_core.Config.html index d164f2d30..29e2c404e 100644 --- a/classes/_buildwithsygma_core.Config.html +++ b/classes/_buildwithsygma_core.Config.html @@ -1,4 +1,4 @@ -Config | Packages Example

Constructors

constructor +Config | Packages Example

Constructors

Properties

Methods

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

Constructors

Properties

configuration: SygmaConfig

Cache storing all sygma environment configurations

-
initialized: boolean = false

Methods

initialized: boolean = false

Methods

  • Retrieves list of supported domains +

Returns EthereumConfig | SubstrateConfig | BitcoinConfig

  • Retrieves list of supported domains from the configuration

    -

    Parameters

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

    Returns Domain[]

  • Initialize and store all +

Returns Resource[]

  • Initialize and store all sygma configurations

    -

    Parameters

    Returns Promise<void>

+

Parameters

Returns Promise<void>

diff --git a/classes/_buildwithsygma_evm.BaseEvmTransferFeeCalculator.html b/classes/_buildwithsygma_evm.BaseEvmTransferFeeCalculator.html index b905418f4..9aca4151b 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

Other

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

EvmFee -Calculate transfer fee

Other

nextHandler: undefined | EvmTransferFeeCalculationHandler

Other

nextHandler: undefined | EvmTransferFeeCalculationHandler
diff --git a/functions/_buildwithsygma_core.getRoutes.html b/functions/_buildwithsygma_core.getRoutes.html index fd5053c58..75fadde02 100644 --- a/functions/_buildwithsygma_core.getRoutes.html +++ b/functions/_buildwithsygma_core.getRoutes.html @@ -1,4 +1,4 @@ getRoutes | Packages Example
  • 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[]>

+

Returns Promise<Route[]>

diff --git a/functions/_buildwithsygma_core.getSygmaScanLink.html b/functions/_buildwithsygma_core.getSygmaScanLink.html index 575d70b29..58ed178ee 100644 --- a/functions/_buildwithsygma_core.getSygmaScanLink.html +++ b/functions/_buildwithsygma_core.getSygmaScanLink.html @@ -1 +1 @@ -getSygmaScanLink | Packages Example
  • Parameters

    Returns string

+getSygmaScanLink | Packages Example
  • Parameters

    Returns string

diff --git a/functions/_buildwithsygma_core.getTransferStatus.html b/functions/_buildwithsygma_core.getTransferStatus.html index 89ec965df..6b9b167e5 100644 --- a/functions/_buildwithsygma_core.getTransferStatus.html +++ b/functions/_buildwithsygma_core.getTransferStatus.html @@ -1,2 +1,2 @@ getTransferStatus | Packages Example
+

Parameters

Returns Promise<TransferStatusResponse>

diff --git a/functions/_buildwithsygma_core.isValidAddressForNetwork.html b/functions/_buildwithsygma_core.isValidAddressForNetwork.html index 2ee348edf..1eb1e893a 100644 --- a/functions/_buildwithsygma_core.isValidAddressForNetwork.html +++ b/functions/_buildwithsygma_core.isValidAddressForNetwork.html @@ -1,2 +1,2 @@ isValidAddressForNetwork | Packages Example
  • Validate Address based on network.

    -

    Parameters

    Returns boolean

+

Parameters

Returns boolean

diff --git a/functions/_buildwithsygma_core.isValidBitcoinAddress.html b/functions/_buildwithsygma_core.isValidBitcoinAddress.html index 88d6df77f..82ac18a4a 100644 --- a/functions/_buildwithsygma_core.isValidBitcoinAddress.html +++ b/functions/_buildwithsygma_core.isValidBitcoinAddress.html @@ -1,2 +1,2 @@ isValidBitcoinAddress | Packages Example
  • Validate Bitcoin address.

    -

    Parameters

    • address: string

    Returns boolean

+

Parameters

Returns boolean

diff --git a/functions/_buildwithsygma_core.isValidEvmAddress.html b/functions/_buildwithsygma_core.isValidEvmAddress.html index 6e6399da7..606ff86c5 100644 --- a/functions/_buildwithsygma_core.isValidEvmAddress.html +++ b/functions/_buildwithsygma_core.isValidEvmAddress.html @@ -1,2 +1,2 @@ isValidEvmAddress | Packages Example
  • Validate EVM address.

    -

    Parameters

    • address: string

    Returns boolean

+

Parameters

Returns boolean

diff --git a/functions/_buildwithsygma_core.isValidSubstrateAddress.html b/functions/_buildwithsygma_core.isValidSubstrateAddress.html index a55729e4f..95d4bbef2 100644 --- a/functions/_buildwithsygma_core.isValidSubstrateAddress.html +++ b/functions/_buildwithsygma_core.isValidSubstrateAddress.html @@ -1,2 +1,2 @@ isValidSubstrateAddress | Packages Example
  • Validate Substrate address.

    -

    Parameters

    • address: string

    Returns boolean

+

Parameters

Returns boolean

diff --git a/functions/_buildwithsygma_evm.approve.html b/functions/_buildwithsygma_evm.approve.html index c299003a8..e09e7d44b 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.

    -
    +
    diff --git a/functions/_buildwithsygma_evm.createCrossChainContractCall.html b/functions/_buildwithsygma_evm.createCrossChainContractCall.html index 1a467c181..9a4141c5e 100644 --- a/functions/_buildwithsygma_evm.createCrossChainContractCall.html +++ b/functions/_buildwithsygma_evm.createCrossChainContractCall.html @@ -1,2 +1,2 @@ createCrossChainContractCall | Packages Example
    +

    Type Parameters

    Parameters

    Returns Promise<GenericMessageTransfer<ContractAbi, FunctionName>>

    diff --git a/functions/_buildwithsygma_evm.createFungibleAssetTransfer.html b/functions/_buildwithsygma_evm.createFungibleAssetTransfer.html index 7443b45c3..4f8a441af 100644 --- a/functions/_buildwithsygma_evm.createFungibleAssetTransfer.html +++ b/functions/_buildwithsygma_evm.createFungibleAssetTransfer.html @@ -1,2 +1,2 @@ createFungibleAssetTransfer | Packages Example
    +

    Parameters

    Returns Promise<FungibleAssetTransfer>

    diff --git a/functions/_buildwithsygma_evm.createNonFungibleAssetTransfer.html b/functions/_buildwithsygma_evm.createNonFungibleAssetTransfer.html index ff20d13e3..1d270afa0 100644 --- a/functions/_buildwithsygma_evm.createNonFungibleAssetTransfer.html +++ b/functions/_buildwithsygma_evm.createNonFungibleAssetTransfer.html @@ -1 +1 @@ -createNonFungibleAssetTransfer | Packages Example
    +createNonFungibleAssetTransfer | Packages Example
    diff --git a/functions/_buildwithsygma_evm.createTransactionRequest.html b/functions/_buildwithsygma_evm.createTransactionRequest.html index 70a8118b1..aa12f49c4 100644 --- a/functions/_buildwithsygma_evm.createTransactionRequest.html +++ b/functions/_buildwithsygma_evm.createTransactionRequest.html @@ -1,4 +1,4 @@ createTransactionRequest | Packages Example
    +

    Returns TransactionRequest

    diff --git a/functions/_buildwithsygma_evm.executeDeposit.html b/functions/_buildwithsygma_evm.executeDeposit.html index 2515ee669..93f1d0805 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

    -
    +
    diff --git a/functions/_buildwithsygma_evm.getERC20Allowance.html b/functions/_buildwithsygma_evm.getERC20Allowance.html index c3b1d51f3..1ad62dbf8 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.

    -
    +
    diff --git a/functions/_buildwithsygma_evm.getEvmErc20Balance.html b/functions/_buildwithsygma_evm.getEvmErc20Balance.html index cf3fa6b06..e49dce14a 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

    -
    +
    diff --git a/functions/_buildwithsygma_evm.getEvmHandlerBalance.html b/functions/_buildwithsygma_evm.getEvmHandlerBalance.html index a23b82a33..aa2f1e7fa 100644 --- a/functions/_buildwithsygma_evm.getEvmHandlerBalance.html +++ b/functions/_buildwithsygma_evm.getEvmHandlerBalance.html @@ -2,4 +2,4 @@
    +
    diff --git a/functions/_buildwithsygma_evm.getFeeInformation.html b/functions/_buildwithsygma_evm.getFeeInformation.html index 0d324b12c..275137a3c 100644 --- a/functions/_buildwithsygma_evm.getFeeInformation.html +++ b/functions/_buildwithsygma_evm.getFeeInformation.html @@ -1 +1 @@ -getFeeInformation | Packages Example
    • Internal

      Parameters

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

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

    +getFeeInformation | Packages Example
    • Internal

      Parameters

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

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

    diff --git a/functions/_buildwithsygma_evm.isApproved.html b/functions/_buildwithsygma_evm.isApproved.html index 002dbe65d..62a18fc8d 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.

    -
    +
    diff --git a/functions/_buildwithsygma_substrate.createDestIdMultilocationData.html b/functions/_buildwithsygma_substrate.createDestIdMultilocationData.html index b8cce7748..2d6384fcf 100644 --- a/functions/_buildwithsygma_substrate.createDestIdMultilocationData.html +++ b/functions/_buildwithsygma_substrate.createDestIdMultilocationData.html @@ -1 +1 @@ -createDestIdMultilocationData | Packages Example
    +createDestIdMultilocationData | Packages Example
    diff --git a/functions/_buildwithsygma_substrate.createMultiAssetData.html b/functions/_buildwithsygma_substrate.createMultiAssetData.html index c12e0a971..edabb68ff 100644 --- a/functions/_buildwithsygma_substrate.createMultiAssetData.html +++ b/functions/_buildwithsygma_substrate.createMultiAssetData.html @@ -4,4 +4,4 @@

    Returns object

    -
    +
    diff --git a/functions/_buildwithsygma_substrate.createSubstrateFungibleAssetTransfer.html b/functions/_buildwithsygma_substrate.createSubstrateFungibleAssetTransfer.html index 334658ad4..602f3747b 100644 --- a/functions/_buildwithsygma_substrate.createSubstrateFungibleAssetTransfer.html +++ b/functions/_buildwithsygma_substrate.createSubstrateFungibleAssetTransfer.html @@ -1 +1 @@ -createSubstrateFungibleAssetTransfer | Packages Example
    +createSubstrateFungibleAssetTransfer | Packages Example
    diff --git a/functions/_buildwithsygma_substrate.deposit.html b/functions/_buildwithsygma_substrate.deposit.html index 562cd7282..573fc9f84 100644 --- a/functions/_buildwithsygma_substrate.deposit.html +++ b/functions/_buildwithsygma_substrate.deposit.html @@ -10,4 +10,4 @@

    Returns SubmittableExtrinsic<"promise", SubmittableResult>

    -
    +
    diff --git a/functions/_buildwithsygma_substrate.getAssetBalance.html b/functions/_buildwithsygma_substrate.getAssetBalance.html index 561f610b8..308f597fc 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.

    -
    +
    diff --git a/functions/_buildwithsygma_substrate.getBasicFee.html b/functions/_buildwithsygma_substrate.getBasicFee.html index 7c82bc924..afbdda0e6 100644 --- a/functions/_buildwithsygma_substrate.getBasicFee.html +++ b/functions/_buildwithsygma_substrate.getBasicFee.html @@ -7,4 +7,4 @@

    Returns Promise<SubstrateFee>

    A promise that resolves to a SubstrateFee object.

    -
    +
    diff --git a/functions/_buildwithsygma_substrate.getFeeHandler.html b/functions/_buildwithsygma_substrate.getFeeHandler.html index ec57d86e4..16f0d58d3 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.

    -
    +
    diff --git a/functions/_buildwithsygma_substrate.getNativeTokenBalance.html b/functions/_buildwithsygma_substrate.getNativeTokenBalance.html index 952586a6d..fa226c7a3 100644 --- a/functions/_buildwithsygma_substrate.getNativeTokenBalance.html +++ b/functions/_buildwithsygma_substrate.getNativeTokenBalance.html @@ -2,4 +2,4 @@
    +
    diff --git a/functions/_buildwithsygma_substrate.getPercentageFee.html b/functions/_buildwithsygma_substrate.getPercentageFee.html index 57d5aaf84..3c6bcf3b0 100644 --- a/functions/_buildwithsygma_substrate.getPercentageFee.html +++ b/functions/_buildwithsygma_substrate.getPercentageFee.html @@ -5,4 +5,4 @@

    Unable to retrieve fee from pallet

    +
    diff --git a/functions/_buildwithsygma_substrate.handleTxExtrinsicResult.html b/functions/_buildwithsygma_substrate.handleTxExtrinsicResult.html index 33a867097..0f59e2c64 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

    +

    Returns void

    diff --git a/functions/_buildwithsygma_substrate.throwErrorIfAny.html b/functions/_buildwithsygma_substrate.throwErrorIfAny.html index 4f9b8988e..8c304b739 100644 --- a/functions/_buildwithsygma_substrate.throwErrorIfAny.html +++ b/functions/_buildwithsygma_substrate.throwErrorIfAny.html @@ -1 +1 @@ -throwErrorIfAny | Packages Example
    +throwErrorIfAny | Packages Example
    diff --git a/functions/_buildwithsygma_utils.broadcastTransaction.html b/functions/_buildwithsygma_utils.broadcastTransaction.html index 65176b5a3..7e59b7374 100644 --- a/functions/_buildwithsygma_utils.broadcastTransaction.html +++ b/functions/_buildwithsygma_utils.broadcastTransaction.html @@ -3,4 +3,4 @@
  • transaction id
  • Broadcast transaction to the network

    -
    +
    diff --git a/functions/_buildwithsygma_utils.fetchUTXOS.html b/functions/_buildwithsygma_utils.fetchUTXOS.html index fee64324f..12f36ff28 100644 --- a/functions/_buildwithsygma_utils.fetchUTXOS.html +++ b/functions/_buildwithsygma_utils.fetchUTXOS.html @@ -3,4 +3,4 @@

    Returns Promise<Utxo[]>

    -
    +
    diff --git a/functions/_buildwithsygma_utils.getFeeEstimates.html b/functions/_buildwithsygma_utils.getFeeEstimates.html index 019127a05..4df623871 100644 --- a/functions/_buildwithsygma_utils.getFeeEstimates.html +++ b/functions/_buildwithsygma_utils.getFeeEstimates.html @@ -3,4 +3,4 @@
  • fee estimate
  • Get fee estimates from blockstream API

    -
    +
    diff --git a/functions/_buildwithsygma_utils.hasEnoughLiquidity.html b/functions/_buildwithsygma_utils.hasEnoughLiquidity.html index ad3ee111a..479f2b578 100644 --- a/functions/_buildwithsygma_utils.hasEnoughLiquidity.html +++ b/functions/_buildwithsygma_utils.hasEnoughLiquidity.html @@ -1,3 +1,3 @@ hasEnoughLiquidity | Packages Example
    • Parameters

      • transfer: SubstrateFungibleAssetTransfer | FungibleAssetTransfer

        either an EVM or Substrate fungible asset transfer

      • destinationProviderUrl: string

        URL of the destination provider

        -

      Returns Promise<boolean>

    +

    Returns Promise<boolean>

    diff --git a/functions/_buildwithsygma_utils.processUtxos.html b/functions/_buildwithsygma_utils.processUtxos.html index d10fed809..49ebd6c83 100644 --- a/functions/_buildwithsygma_utils.processUtxos.html +++ b/functions/_buildwithsygma_utils.processUtxos.html @@ -4,4 +4,4 @@

    Returns Utxo[]

    -
    +
    diff --git a/interfaces/_buildwithsygma_core.BaseConfig.html b/interfaces/_buildwithsygma_core.BaseConfig.html index 3ad5340ab..717f27fe6 100644 --- a/interfaces/_buildwithsygma_core.BaseConfig.html +++ b/interfaces/_buildwithsygma_core.BaseConfig.html @@ -1,4 +1,4 @@ -BaseConfig | Packages Example
    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> {
        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: number
    bridge: string
    caipId: string
    chainId: number
    id: number
    name: string
    nativeTokenDecimals: bigint
    nativeTokenFullName: string
    nativeTokenSymbol: string
    resources: Resource[]
    startBlock: bigint
    type: T
    +

    Properties

    blockConfirmations: number
    bridge: string
    caipId: string
    chainId: number
    id: number
    name: string
    nativeTokenDecimals: bigint
    nativeTokenFullName: string
    nativeTokenSymbol: string
    resources: Resource[]
    startBlock: bigint
    type: T
    diff --git a/interfaces/_buildwithsygma_core.BaseTransferParams.html b/interfaces/_buildwithsygma_core.BaseTransferParams.html index f9b8a0435..b6887127b 100644 --- a/interfaces/_buildwithsygma_core.BaseTransferParams.html +++ b/interfaces/_buildwithsygma_core.BaseTransferParams.html @@ -1,5 +1,5 @@ -BaseTransferParams | Packages Example
    interface BaseTransferParams {
        destination: Domainlike;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
    }

    Properties

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

    Properties

    destination: Domainlike
    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource
    source: Domainlike
    sourceAddress: string
    +

    Properties

    destination: Domainlike
    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource
    source: Domainlike
    sourceAddress: string
    diff --git a/interfaces/_buildwithsygma_core.BitcoinConfig.html b/interfaces/_buildwithsygma_core.BitcoinConfig.html index 8a19abf34..c028669cf 100644 --- a/interfaces/_buildwithsygma_core.BitcoinConfig.html +++ b/interfaces/_buildwithsygma_core.BitcoinConfig.html @@ -1,4 +1,4 @@ -BitcoinConfig | Packages Example
    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 {
        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: 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
    +

    Properties

    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
    diff --git a/interfaces/_buildwithsygma_core.Eip1193Provider.html b/interfaces/_buildwithsygma_core.Eip1193Provider.html index 6180e8028..226227630 100644 --- a/interfaces/_buildwithsygma_core.Eip1193Provider.html +++ b/interfaces/_buildwithsygma_core.Eip1193Provider.html @@ -1,2 +1,2 @@ -Eip1193Provider | Packages Example
    interface Eip1193Provider {
        request(request: {
            method: string;
            params?: unknown[] | Record<string, unknown>;
        }): Promise<unknown>;
    }

    Methods

    Methods

    • Parameters

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

      Returns Promise<unknown>

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

    Methods

    Methods

    • Parameters

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

      Returns Promise<unknown>

    diff --git a/interfaces/_buildwithsygma_core.EthereumConfig.html b/interfaces/_buildwithsygma_core.EthereumConfig.html index 085f72b9b..77685c521 100644 --- a/interfaces/_buildwithsygma_core.EthereumConfig.html +++ b/interfaces/_buildwithsygma_core.EthereumConfig.html @@ -1,4 +1,4 @@ -EthereumConfig | Packages Example
    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 {
        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: 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
    +

    Properties

    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
    diff --git a/interfaces/_buildwithsygma_core.SubstrateConfig.html b/interfaces/_buildwithsygma_core.SubstrateConfig.html index 79f468f1b..614d9f5e2 100644 --- a/interfaces/_buildwithsygma_core.SubstrateConfig.html +++ b/interfaces/_buildwithsygma_core.SubstrateConfig.html @@ -1,4 +1,4 @@ -SubstrateConfig | Packages Example
    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 {
        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: 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
    +

    Properties

    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
    diff --git a/interfaces/_buildwithsygma_core.SygmaConfig.html b/interfaces/_buildwithsygma_core.SygmaConfig.html index b1b3a34cb..2379e856a 100644 --- a/interfaces/_buildwithsygma_core.SygmaConfig.html +++ b/interfaces/_buildwithsygma_core.SygmaConfig.html @@ -1,2 +1,2 @@ -SygmaConfig | Packages Example
    interface SygmaConfig {
        domains: (EthereumConfig | SubstrateConfig | BitcoinConfig)[];
    }

    Properties

    Properties

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

    Properties

    Properties

    diff --git a/interfaces/_buildwithsygma_evm.EvmAssetTransferParams.html b/interfaces/_buildwithsygma_evm.EvmAssetTransferParams.html index b9052bafa..d7bd1cef9 100644 --- a/interfaces/_buildwithsygma_evm.EvmAssetTransferParams.html +++ b/interfaces/_buildwithsygma_evm.EvmAssetTransferParams.html @@ -1,4 +1,4 @@ -EvmAssetTransferParams | Packages Example
    interface EvmAssetTransferParams {
        amount?: bigint;
        destination: Domainlike;
        recipientAddress: string;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
        tokenId?: string;
    }

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    amount?: bigint
    destination: Domainlike
    recipientAddress: string
    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource
    source: Domainlike
    sourceAddress: string
    sourceNetworkProvider: Eip1193Provider
    tokenId?: string
    +

    Properties

    amount?: bigint
    destination: Domainlike
    recipientAddress: string
    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource
    source: Domainlike
    sourceAddress: string
    sourceNetworkProvider: Eip1193Provider
    tokenId?: string
    diff --git a/interfaces/_buildwithsygma_evm.EvmFeeCalculationParams.html b/interfaces/_buildwithsygma_evm.EvmFeeCalculationParams.html index 98385eba8..39124cec4 100644 --- a/interfaces/_buildwithsygma_evm.EvmFeeCalculationParams.html +++ b/interfaces/_buildwithsygma_evm.EvmFeeCalculationParams.html @@ -1,6 +1,6 @@ EvmFeeCalculationParams | Packages Example

    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

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

    Properties

    depositData?: string
    destinationSygmaId: number
    feeHandlerAddress: string
    feeHandlerType: FeeHandlerType
    provider: Provider
    resourceSygmaId: string
    sender: string
    sourceSygmaId: number
    +

    Properties

    depositData?: string
    destinationSygmaId: number
    feeHandlerAddress: string
    feeHandlerType: FeeHandlerType
    provider: Provider
    resourceSygmaId: string
    sender: string
    sourceSygmaId: number
    diff --git a/interfaces/_buildwithsygma_evm.EvmTransferFeeCalculationHandler.html b/interfaces/_buildwithsygma_evm.EvmTransferFeeCalculationHandler.html index d5a364323..ecb397a8e 100644 --- a/interfaces/_buildwithsygma_evm.EvmTransferFeeCalculationHandler.html +++ b/interfaces/_buildwithsygma_evm.EvmTransferFeeCalculationHandler.html @@ -1,3 +1,3 @@ -EvmTransferFeeCalculationHandler | Packages Example
    interface EvmTransferFeeCalculationHandler {
        calculateFee(params: EvmFeeCalculationParams): Promise<EvmFee>;
        setNextHandler(handler: EvmTransferFeeCalculationHandler): EvmTransferFeeCalculationHandler;
    }

    Implemented by

    Methods

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

    Implemented by

    Methods

    +

    Methods

    diff --git a/interfaces/_buildwithsygma_evm.EvmTransferParams.html b/interfaces/_buildwithsygma_evm.EvmTransferParams.html index 13adc46c1..463d7652b 100644 --- a/interfaces/_buildwithsygma_evm.EvmTransferParams.html +++ b/interfaces/_buildwithsygma_evm.EvmTransferParams.html @@ -1,6 +1,6 @@ -EvmTransferParams | Packages Example
    interface EvmTransferParams {
        destination: Domainlike;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
    }

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    destination: Domainlike
    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource
    source: Domainlike
    sourceAddress: string
    sourceNetworkProvider: Eip1193Provider
    +

    Properties

    destination: Domainlike
    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource
    source: Domainlike
    sourceAddress: string
    sourceNetworkProvider: Eip1193Provider
    diff --git a/interfaces/_buildwithsygma_evm.FungibleTransferOptionalMessage.html b/interfaces/_buildwithsygma_evm.FungibleTransferOptionalMessage.html index 8b1e2f446..89b1a7c3b 100644 --- a/interfaces/_buildwithsygma_evm.FungibleTransferOptionalMessage.html +++ b/interfaces/_buildwithsygma_evm.FungibleTransferOptionalMessage.html @@ -1,4 +1,4 @@ -FungibleTransferOptionalMessage | Packages Example
    interface FungibleTransferOptionalMessage {
        actions: FungibleDepositAction[];
        receiver: string;
        transactionId: string;
    }

    Properties

    actions +FungibleTransferOptionalMessage | Packages Example
    interface FungibleTransferOptionalMessage {
        actions: FungibleDepositAction[];
        receiver: string;
        transactionId: string;
    }

    Properties

    actions: FungibleDepositAction[]
    receiver: string
    transactionId: string
    +

    Properties

    actions: FungibleDepositAction[]
    receiver: string
    transactionId: string
    diff --git a/interfaces/_buildwithsygma_evm.FungibleTransferParams.html b/interfaces/_buildwithsygma_evm.FungibleTransferParams.html index ec74b0038..c67b54bbc 100644 --- a/interfaces/_buildwithsygma_evm.FungibleTransferParams.html +++ b/interfaces/_buildwithsygma_evm.FungibleTransferParams.html @@ -1,4 +1,4 @@ -FungibleTransferParams | Packages Example
    interface FungibleTransferParams {
        amount: bigint;
        destination: Domainlike;
        optionalGas?: bigint;
        optionalMessage?: FungibleTransferOptionalMessage;
        recipientAddress: string;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        securityModel?: SecurityModel;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
        tokenId?: string;
    }

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    amount: bigint
    destination: Domainlike
    optionalGas?: bigint
    recipientAddress: string
    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource
    securityModel?: SecurityModel
    source: Domainlike
    sourceAddress: string
    sourceNetworkProvider: Eip1193Provider
    tokenId?: string
    +

    Properties

    amount: bigint
    destination: Domainlike
    optionalGas?: bigint
    recipientAddress: string
    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource
    securityModel?: SecurityModel
    source: Domainlike
    sourceAddress: string
    sourceNetworkProvider: Eip1193Provider
    tokenId?: string
    diff --git a/interfaces/_buildwithsygma_evm.GenericMessageTransferParams.html b/interfaces/_buildwithsygma_evm.GenericMessageTransferParams.html index 7570e2d3d..c70c11d48 100644 --- a/interfaces/_buildwithsygma_evm.GenericMessageTransferParams.html +++ b/interfaces/_buildwithsygma_evm.GenericMessageTransferParams.html @@ -1,4 +1,4 @@ -GenericMessageTransferParams | Packages Example

    Interface GenericMessageTransferParams<ContractAbi, FunctionName>

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

    Type Parameters

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

    Hierarchy (view full)

    Properties

    destination +GenericMessageTransferParams | Packages Example

    Interface GenericMessageTransferParams<ContractAbi, FunctionName>

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

    Type Parameters

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

    Hierarchy (view full)

    Properties

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

    Properties

    destination: Domainlike
    destinationContractAbi: ContractAbi
    destinationContractAddress: string
    functionName: FunctionName
    functionParameters: {
        [key in string | number | symbol]: {
            [key in string | number | symbol]: AbiParameterToPrimitiveType<Extract<Extract<ContractAbi[number], {
                stateMutability: AbiStateMutability;
                type: "function";
            }>, {
                name: FunctionName;
            }>["inputs"][key<key>], "inputs">
        }[key]
    }
    gasLimit: bigint
    maxFee: bigint
    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource
    source: Domainlike
    sourceAddress: string
    sourceNetworkProvider: Eip1193Provider
    diff --git a/interfaces/_buildwithsygma_evm.NonFungibleTransferParams.html b/interfaces/_buildwithsygma_evm.NonFungibleTransferParams.html index e4ad96a74..fe6453561 100644 --- a/interfaces/_buildwithsygma_evm.NonFungibleTransferParams.html +++ b/interfaces/_buildwithsygma_evm.NonFungibleTransferParams.html @@ -1,4 +1,4 @@ -NonFungibleTransferParams | Packages Example
    interface NonFungibleTransferParams {
        amount?: bigint;
        destination: Domainlike;
        recipientAddress: string;
        resource:
            | string
            | EvmResource
            | SubstrateResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: Eip1193Provider;
        tokenId: string;
    }

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    amount?: bigint
    destination: Domainlike
    recipientAddress: string
    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource
    source: Domainlike
    sourceAddress: string
    sourceNetworkProvider: Eip1193Provider
    tokenId: string
    +

    Properties

    amount?: bigint
    destination: Domainlike
    recipientAddress: string
    resource:
        | string
        | EvmResource
        | SubstrateResource
        | BitcoinResource
    source: Domainlike
    sourceAddress: string
    sourceNetworkProvider: Eip1193Provider
    tokenId: string
    diff --git a/interfaces/_buildwithsygma_evm.TransactionRequest.html b/interfaces/_buildwithsygma_evm.TransactionRequest.html index e90a694b8..6a4d31588 100644 --- a/interfaces/_buildwithsygma_evm.TransactionRequest.html +++ b/interfaces/_buildwithsygma_evm.TransactionRequest.html @@ -1,4 +1,4 @@ -TransactionRequest | Packages Example
    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 {
        chainId?: number;
        data: string;
        gasLimit: bigint;
        gasPrice?: bigint;
        maxFeePerGas?: bigint;
        maxPriorityFeePerGas?: bigint;
        nonce?: number;
        to: string;
        type?: number;
        value: bigint;
    }

    Properties

    Properties

    chainId?: number
    data: string
    gasLimit: bigint
    gasPrice?: bigint
    maxFeePerGas?: bigint
    maxPriorityFeePerGas?: bigint
    nonce?: number
    to: string
    type?: number
    value: bigint
    +

    Properties

    chainId?: number
    data: string
    gasLimit: bigint
    gasPrice?: bigint
    maxFeePerGas?: bigint
    maxPriorityFeePerGas?: bigint
    nonce?: number
    to: string
    type?: number
    value: bigint
    diff --git a/interfaces/_buildwithsygma_substrate.SubstrateAssetTransferRequest.html b/interfaces/_buildwithsygma_substrate.SubstrateAssetTransferRequest.html index dd1347496..d9247ccba 100644 --- a/interfaces/_buildwithsygma_substrate.SubstrateAssetTransferRequest.html +++ b/interfaces/_buildwithsygma_substrate.SubstrateAssetTransferRequest.html @@ -1,8 +1,8 @@ -SubstrateAssetTransferRequest | Packages Example
    interface SubstrateAssetTransferRequest {
        amount: bigint;
        destination: Domainlike;
        destinationAddress: string;
        resource:
            | string
            | SubstrateResource
            | EvmResource
            | BitcoinResource;
        source: Domainlike;
        sourceAddress: string;
        sourceNetworkProvider: ApiPromise;
    }

    Hierarchy

    • BaseTransferParams
      • SubstrateAssetTransferRequest

    Properties

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

    Hierarchy

    • BaseTransferParams
      • SubstrateAssetTransferRequest

    Properties

    amount: bigint
    destination: Domainlike
    destinationAddress: string
    resource:
        | string
        | SubstrateResource
        | EvmResource
        | BitcoinResource
    source: Domainlike
    sourceAddress: string
    sourceNetworkProvider: ApiPromise
    +

    Properties

    amount: bigint
    destination: Domainlike
    destinationAddress: string
    resource:
        | string
        | SubstrateResource
        | EvmResource
        | BitcoinResource
    source: Domainlike
    sourceAddress: string
    sourceNetworkProvider: ApiPromise
    diff --git a/modules/_buildwithsygma_evm.html b/modules/_buildwithsygma_evm.html index 477af61f7..efb194b8e 100644 --- a/modules/_buildwithsygma_evm.html +++ b/modules/_buildwithsygma_evm.html @@ -1,4 +1,4 @@ -@buildwithsygma/evm - v1.3.1 | Packages Example

    Module @buildwithsygma/evm - v1.3.1

    +@buildwithsygma/evm - v1.3.2 | Packages Example

    Module @buildwithsygma/evm - v1.3.2

    Sygma SDK


    diff --git a/types/_buildwithsygma_core.BitcoinResource.html b/types/_buildwithsygma_core.BitcoinResource.html index 4c83b15ad..cb8cd4138 100644 --- a/types/_buildwithsygma_core.BitcoinResource.html +++ b/types/_buildwithsygma_core.BitcoinResource.html @@ -1 +1 @@ -BitcoinResource | Packages Example
    BitcoinResource: BaseResource & {
        address: string;
        feeAmount?: number;
        script: string;
        tweak: string;
    }
    +BitcoinResource | Packages Example
    BitcoinResource: BaseResource & {
        address: string;
        feeAmount?: number;
        script: string;
        tweak: string;
    }
    diff --git a/types/_buildwithsygma_core.Domain.html b/types/_buildwithsygma_core.Domain.html index 770b737d3..f551c0616 100644 --- a/types/_buildwithsygma_core.Domain.html +++ b/types/_buildwithsygma_core.Domain.html @@ -1 +1 @@ -Domain | Packages Example
    Domain: {
        caipId: string;
        chainId: number;
        feeAddress?: string;
        iconUrl?: string;
        id: number;
        name: string;
        parachainId?: ParachainId;
        type: Network;
    }
    +Domain | Packages Example
    Domain: {
        caipId: string;
        chainId: number;
        feeAddress?: string;
        iconUrl?: string;
        id: number;
        name: string;
        parachainId?: ParachainId;
        type: Network;
    }
    diff --git a/types/_buildwithsygma_core.DomainMetadata.html b/types/_buildwithsygma_core.DomainMetadata.html index 1601c0ee8..5cae0e1a8 100644 --- a/types/_buildwithsygma_core.DomainMetadata.html +++ b/types/_buildwithsygma_core.DomainMetadata.html @@ -1 +1 @@ -DomainMetadata | Packages Example
    DomainMetadata: {
        url: string;
    }
    +DomainMetadata | Packages Example
    DomainMetadata: {
        url: string;
    }
    diff --git a/types/_buildwithsygma_core.Domainlike.html b/types/_buildwithsygma_core.Domainlike.html index 20308fb75..975c12348 100644 --- a/types/_buildwithsygma_core.Domainlike.html +++ b/types/_buildwithsygma_core.Domainlike.html @@ -1 +1 @@ -Domainlike | Packages Example
    Domainlike: string | number | Domain
    +Domainlike | Packages Example
    Domainlike: string | number | Domain
    diff --git a/types/_buildwithsygma_core.EnvironmentMetadata.html b/types/_buildwithsygma_core.EnvironmentMetadata.html index f0f808f5f..7052fe5c5 100644 --- a/types/_buildwithsygma_core.EnvironmentMetadata.html +++ b/types/_buildwithsygma_core.EnvironmentMetadata.html @@ -1 +1 @@ -EnvironmentMetadata | Packages Example
    EnvironmentMetadata: {
        [key: number]: DomainMetadata;
    }
    +EnvironmentMetadata | Packages Example
    EnvironmentMetadata: {
        [key: number]: DomainMetadata;
    }
    diff --git a/types/_buildwithsygma_core.EvmResource.html b/types/_buildwithsygma_core.EvmResource.html index 77a67a4b2..c17443b12 100644 --- a/types/_buildwithsygma_core.EvmResource.html +++ b/types/_buildwithsygma_core.EvmResource.html @@ -1 +1 @@ -EvmResource | Packages Example
    EvmResource: BaseResource & {
        address: string;
    }
    +EvmResource | Packages Example
    EvmResource: BaseResource & {
        address: string;
    }
    diff --git a/types/_buildwithsygma_core.FeeHandler.html b/types/_buildwithsygma_core.FeeHandler.html index e21a8c23d..f4ad46c5d 100644 --- a/types/_buildwithsygma_core.FeeHandler.html +++ b/types/_buildwithsygma_core.FeeHandler.html @@ -1 +1 @@ -FeeHandler | Packages Example
    FeeHandler: {
        address: string;
        type: FeeHandlerType;
    }
    +FeeHandler | Packages Example
    FeeHandler: {
        address: string;
        type: FeeHandlerType;
    }
    diff --git a/types/_buildwithsygma_core.Handler.html b/types/_buildwithsygma_core.Handler.html index 487ee44ff..0d70973a7 100644 --- a/types/_buildwithsygma_core.Handler.html +++ b/types/_buildwithsygma_core.Handler.html @@ -1 +1 @@ -Handler | Packages Example
    Handler: {
        address: string;
        type: ResourceType;
    }
    +Handler | Packages Example
    Handler: {
        address: string;
        type: ResourceType;
    }
    diff --git a/types/_buildwithsygma_core.HexString.html b/types/_buildwithsygma_core.HexString.html index 7a4702e93..9f6fa8da8 100644 --- a/types/_buildwithsygma_core.HexString.html +++ b/types/_buildwithsygma_core.HexString.html @@ -1 +1 @@ -HexString | Packages Example
    HexString: `0x${string}`
    +HexString | Packages Example
    HexString: `0x${string}`
    diff --git a/types/_buildwithsygma_core.IndexerRoutesResponse.html b/types/_buildwithsygma_core.IndexerRoutesResponse.html index c1ad0906b..f29c790dc 100644 --- a/types/_buildwithsygma_core.IndexerRoutesResponse.html +++ b/types/_buildwithsygma_core.IndexerRoutesResponse.html @@ -1 +1 @@ -IndexerRoutesResponse | Packages Example
    IndexerRoutesResponse: {
        routes: RouteIndexerType[];
    }
    +IndexerRoutesResponse | Packages Example
    IndexerRoutesResponse: {
        routes: RouteIndexerType[];
    }
    diff --git a/types/_buildwithsygma_core.ParachainId.html b/types/_buildwithsygma_core.ParachainId.html index ae581c243..14fda6cd2 100644 --- a/types/_buildwithsygma_core.ParachainId.html +++ b/types/_buildwithsygma_core.ParachainId.html @@ -1 +1 @@ -ParachainId | Packages Example
    ParachainId: number
    +ParachainId | Packages Example
    ParachainId: number
    diff --git a/types/_buildwithsygma_core.Resource.html b/types/_buildwithsygma_core.Resource.html index d9d3e465a..db2cad72f 100644 --- a/types/_buildwithsygma_core.Resource.html +++ b/types/_buildwithsygma_core.Resource.html @@ -1 +1 @@ -Resource | Packages Example
    +Resource | Packages Example
    diff --git a/types/_buildwithsygma_core.Route.html b/types/_buildwithsygma_core.Route.html index 03cf67103..ad56deafa 100644 --- a/types/_buildwithsygma_core.Route.html +++ b/types/_buildwithsygma_core.Route.html @@ -1 +1 @@ -Route | Packages Example
    Route: {
        feeHandler?: FeeHandler;
        fromDomain: Domain;
        resource: Resource;
        toDomain: Domain;
    }
    +Route | Packages Example
    Route: {
        feeHandler?: FeeHandler;
        fromDomain: Domain;
        resource: Resource;
        toDomain: Domain;
    }
    diff --git a/types/_buildwithsygma_core.RouteIndexerType.html b/types/_buildwithsygma_core.RouteIndexerType.html index b607df473..70b6af2c6 100644 --- a/types/_buildwithsygma_core.RouteIndexerType.html +++ b/types/_buildwithsygma_core.RouteIndexerType.html @@ -1 +1 @@ -RouteIndexerType | Packages Example
    RouteIndexerType: {
        fromDomainId: string;
        resourceId: string;
        toDomainId: string;
        type: RouteType;
    }
    +RouteIndexerType | Packages Example
    RouteIndexerType: {
        fromDomainId: string;
        resourceId: string;
        toDomainId: string;
        type: RouteType;
    }
    diff --git a/types/_buildwithsygma_core.SubstrateResource.html b/types/_buildwithsygma_core.SubstrateResource.html index 519ac7d84..d94032199 100644 --- a/types/_buildwithsygma_core.SubstrateResource.html +++ b/types/_buildwithsygma_core.SubstrateResource.html @@ -1 +1 @@ -SubstrateResource | Packages Example
    SubstrateResource: BaseResource & {
        assetID?: number;
        assetName: string;
        xcmMultiAssetId: XcmMultiAssetIdType;
    }
    +SubstrateResource | Packages Example
    SubstrateResource: BaseResource & {
        assetID?: number;
        assetName: string;
        xcmMultiAssetId: XcmMultiAssetIdType;
    }
    diff --git a/types/_buildwithsygma_core.SygmaDomainConfig.html b/types/_buildwithsygma_core.SygmaDomainConfig.html index dd4f94334..7e1a552e6 100644 --- a/types/_buildwithsygma_core.SygmaDomainConfig.html +++ b/types/_buildwithsygma_core.SygmaDomainConfig.html @@ -1 +1 @@ -SygmaDomainConfig | Packages Example
    +SygmaDomainConfig | Packages Example
    diff --git a/types/_buildwithsygma_core.TransferStatus.html b/types/_buildwithsygma_core.TransferStatus.html index cdd985d38..0f9e09e8e 100644 --- a/types/_buildwithsygma_core.TransferStatus.html +++ b/types/_buildwithsygma_core.TransferStatus.html @@ -1 +1 @@ -TransferStatus | Packages Example
    TransferStatus: "pending" | "executed" | "failed"
    +TransferStatus | Packages Example
    TransferStatus: "pending" | "executed" | "failed"
    diff --git a/types/_buildwithsygma_core.TransferStatusResponse.html b/types/_buildwithsygma_core.TransferStatusResponse.html index 3ca6c4b3b..5cabd5d80 100644 --- a/types/_buildwithsygma_core.TransferStatusResponse.html +++ b/types/_buildwithsygma_core.TransferStatusResponse.html @@ -1 +1 @@ -TransferStatusResponse | Packages Example
    TransferStatusResponse: {
        depositNonce: number;
        destinationHash: string;
        explorerUrl: string;
        fromDomainId: number;
        sourceHash: string;
        status: TransferStatus;
        toDomainId: number;
    }
    +TransferStatusResponse | Packages Example
    TransferStatusResponse: {
        depositNonce: number;
        destinationHash: string;
        explorerUrl: string;
        fromDomainId: number;
        sourceHash: string;
        status: TransferStatus;
        toDomainId: number;
    }
    diff --git a/types/_buildwithsygma_core.XcmMultiAssetIdType.html b/types/_buildwithsygma_core.XcmMultiAssetIdType.html index 359f9814a..93bb887b2 100644 --- a/types/_buildwithsygma_core.XcmMultiAssetIdType.html +++ b/types/_buildwithsygma_core.XcmMultiAssetIdType.html @@ -1 +1 @@ -XcmMultiAssetIdType | Packages Example
    XcmMultiAssetIdType: {
        concrete: {
            interior: "here" | {
                x3: ({
                    parachain: number;
                } | {
                    generalKey: [number, string];
                })[];
            };
            parents: number;
        };
    }
    +XcmMultiAssetIdType | Packages Example
    XcmMultiAssetIdType: {
        concrete: {
            interior: "here" | {
                x3: ({
                    parachain: number;
                } | {
                    generalKey: [number, string];
                })[];
            };
            parents: number;
        };
    }
    diff --git a/types/_buildwithsygma_evm.EvmFee.html b/types/_buildwithsygma_evm.EvmFee.html index 87cf04078..270bcce47 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

    -
  • +
    diff --git a/types/_buildwithsygma_evm.EvmResourceish.html b/types/_buildwithsygma_evm.EvmResourceish.html index ccc000738..01da64d78 100644 --- a/types/_buildwithsygma_evm.EvmResourceish.html +++ b/types/_buildwithsygma_evm.EvmResourceish.html @@ -1,2 +1,2 @@ EvmResourceish | Packages Example
    EvmResourceish: string | EvmResource

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

    -
    +
    diff --git a/variables/_buildwithsygma_evm.ASSET_TRANSFER_GAS_LIMIT.html b/variables/_buildwithsygma_evm.ASSET_TRANSFER_GAS_LIMIT.html index d1400d589..32d7891c8 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
    ASSET_TRANSFER_GAS_LIMIT: BigNumber = ...
    +ASSET_TRANSFER_GAS_LIMIT | Packages Example
    ASSET_TRANSFER_GAS_LIMIT: BigNumber = ...