From a7ba1dffcbbeb168f46ae6e9d39d27d0c3656875 Mon Sep 17 00:00:00 2001 From: tarikgul Date: Tue, 7 Nov 2023 09:03:48 -0500 Subject: [PATCH] Update docs --- .../AssetTransferApi.AssetTransferApi.html | 8 ++--- .../errors_BaseError.BaseErrorsEnum.html | 30 +++++++++---------- docs/enums/types.Direction.html | 20 ++++++------- ...nstructApiPromise.constructApiPromise.html | 2 +- .../constructApiPromise.ApiInfo.html | 8 ++--- docs/interfaces/types.TransferArgsOpts.html | 20 ++++++------- docs/interfaces/types.TxResult.html | 16 +++++----- docs/modules/AssetTransferApi.html | 2 +- docs/modules/constructApiPromise.html | 2 +- docs/modules/errors_BaseError.html | 2 +- docs/modules/types.html | 2 +- docs/types/types.ConstructedFormat.html | 2 +- docs/types/types.Format.html | 2 +- docs/types/types.LocalTransferTypes.html | 2 +- docs/types/types.Methods.html | 2 +- docs/types/types.XcmDirection.html | 2 +- 16 files changed, 61 insertions(+), 61 deletions(-) diff --git a/docs/classes/AssetTransferApi.AssetTransferApi.html b/docs/classes/AssetTransferApi.AssetTransferApi.html index 0dffcade..a578e607 100644 --- a/docs/classes/AssetTransferApi.AssetTransferApi.html +++ b/docs/classes/AssetTransferApi.AssetTransferApi.html @@ -28,7 +28,7 @@

Hierarchy

+
  • Defined in AssetTransferApi.ts:79
    • @@ -88,7 +88,7 @@
    opts: Returns Promise<TxResult<T>>
    +
  • Defined in AssetTransferApi.ts:126

    • decodeExtrinsic

    +
  • Defined in AssetTransferApi.ts:523

    • fetchFeeInfo

    +
  • Defined in AssetTransferApi.ts:477
    • diff --git a/docs/enums/errors_BaseError.BaseErrorsEnum.html b/docs/enums/errors_BaseError.BaseErrorsEnum.html index 3a0699d0..7536f775 100644 --- a/docs/enums/errors_BaseError.BaseErrorsEnum.html +++ b/docs/enums/errors_BaseError.BaseErrorsEnum.html @@ -21,7 +21,7 @@

    Enumeration BaseErrorsEnum

    +
  • Defined in errors/BaseError.ts:6
    • @@ -53,7 +53,7 @@

    AssetNotFound

    +
  • Defined in errors/BaseError.ts:20

    • DisabledOption

    DisabledOption: "DisabledOption"
    @@ -61,7 +61,7 @@

    DisabledOption

    +
  • Defined in errors/BaseError.ts:64

    • InternalError

    InternalError: "InternalError"
    @@ -69,7 +69,7 @@

    InternalError

    +
  • Defined in errors/BaseError.ts:56

    • InvalidAddress

    InvalidAddress: "InvalidAddress"
    @@ -77,7 +77,7 @@

    InvalidAddress

    +
  • Defined in errors/BaseError.ts:60

    • InvalidAsset

    InvalidAsset: "InvalidAsset"
    @@ -86,7 +86,7 @@

    InvalidAsset

    +
  • Defined in errors/BaseError.ts:16

    • InvalidDirection

    InvalidDirection: "InvalidDirection"
    @@ -94,7 +94,7 @@

    InvalidDirection

    +
  • Defined in errors/BaseError.ts:32

    • InvalidInput

    InvalidInput: "InvalidInput"
    @@ -103,7 +103,7 @@

    InvalidInput

    +
  • Defined in errors/BaseError.ts:11

    • InvalidMultiLocationAsset

    InvalidMultiLocationAsset: "InvalidMultiLocationAsset"
    @@ -111,7 +111,7 @@

    InvalidMultiLocationAsset

    +
  • Defined in errors/BaseError.ts:36

    • InvalidPallet

    InvalidPallet: "InvalidPallet"
    @@ -119,7 +119,7 @@

    InvalidPallet

    +
  • Defined in errors/BaseError.ts:24

    • InvalidXcmVersion

    InvalidXcmVersion: "InvalidXcmVersion"
    @@ -127,7 +127,7 @@

    InvalidXcmVersion

    +
  • Defined in errors/BaseError.ts:48

    • MultipleNonUniqueAssetsFound

    MultipleNonUniqueAssetsFound: "MultipleNonUniqueAssetsFound"
    @@ -135,7 +135,7 @@

    MultipleNonUniqueAssets

    +
  • Defined in errors/BaseError.ts:40

    • NotImplemented

    NotImplemented: "NotImplemented"
    @@ -143,7 +143,7 @@

    NotImplemented

    +
  • Defined in errors/BaseError.ts:52

    • PalletNotFound

    PalletNotFound: "PalletNotFound"
    @@ -151,7 +151,7 @@

    PalletNotFound

    +
  • Defined in errors/BaseError.ts:28

    • RegistryNotFound

    RegistryNotFound: "RegistryNotFound"
    @@ -159,7 +159,7 @@

    RegistryNotFound

    +
  • Defined in errors/BaseError.ts:44
    • diff --git a/docs/enums/types.Direction.html b/docs/enums/types.Direction.html index fbaf3780..34250e4a 100644 --- a/docs/enums/types.Direction.html +++ b/docs/enums/types.Direction.html @@ -21,7 +21,7 @@

    Enumeration Direction

    +
  • Defined in types.ts:26
    • @@ -48,7 +48,7 @@

    Local

    +
  • Defined in types.ts:30

    • ParaToPara

    ParaToPara: "ParaToPara"
    @@ -56,7 +56,7 @@

    ParaToPara

    +
  • Defined in types.ts:46

    • ParaToRelay

    ParaToRelay: "ParaToRelay"
    @@ -64,7 +64,7 @@

    ParaToRelay

    +
  • Defined in types.ts:50

    • ParaToSystem

    ParaToSystem: "ParaToSystem"
    @@ -72,7 +72,7 @@

    ParaToSystem

    +
  • Defined in types.ts:54

    • RelayToPara

    RelayToPara: "RelayToPara"
    @@ -80,7 +80,7 @@

    RelayToPara

    +
  • Defined in types.ts:62

    • RelayToSystem

    RelayToSystem: "RelayToSystem"
    @@ -88,7 +88,7 @@

    RelayToSystem

    +
  • Defined in types.ts:58

    • SystemToPara

    SystemToPara: "SystemToPara"
    @@ -96,7 +96,7 @@

    SystemToPara

    +
  • Defined in types.ts:34

    • SystemToRelay

    SystemToRelay: "SystemToRelay"
    @@ -104,7 +104,7 @@

    SystemToRelay

    +
  • Defined in types.ts:38

    • SystemToSystem

    SystemToSystem: "SystemToSystem"
    @@ -112,7 +112,7 @@

    SystemToSystem

    +
  • Defined in types.ts:42
    • diff --git a/docs/functions/constructApiPromise.constructApiPromise.html b/docs/functions/constructApiPromise.constructApiPromise.html index 8247ba4a..5a26f121 100644 --- a/docs/functions/constructApiPromise.constructApiPromise.html +++ b/docs/functions/constructApiPromise.constructApiPromise.html @@ -40,7 +40,7 @@
    opts: Returns Promise<ApiInfo>
    +
  • Defined in constructApiPromise.ts:39
    • diff --git a/docs/interfaces/constructApiPromise.ApiInfo.html b/docs/interfaces/constructApiPromise.ApiInfo.html index 2016eb22..2793a3fb 100644 --- a/docs/interfaces/constructApiPromise.ApiInfo.html +++ b/docs/interfaces/constructApiPromise.ApiInfo.html @@ -25,7 +25,7 @@

    Hierarchy

    • ApiInfo
    +
  • Defined in constructApiPromise.ts:12
    • @@ -46,7 +46,7 @@

    api

    +
  • Defined in constructApiPromise.ts:16

    • safeXcmVersion

    safeXcmVersion: number
    @@ -54,7 +54,7 @@

    safeXcmVersion

    +
  • Defined in constructApiPromise.ts:24

    • specName

    specName: string
    @@ -62,7 +62,7 @@

    specName

    +
  • Defined in constructApiPromise.ts:20
    • diff --git a/docs/interfaces/types.TransferArgsOpts.html b/docs/interfaces/types.TransferArgsOpts.html index 7c873b5f..92acf91b 100644 --- a/docs/interfaces/types.TransferArgsOpts.html +++ b/docs/interfaces/types.TransferArgsOpts.html @@ -30,7 +30,7 @@

    Hierarchy

    • TransferArgsOpts
    +
  • Defined in types.ts:168
    • @@ -60,7 +60,7 @@

    Optional

    +
  • Defined in types.ts:176

    • Optional isLimited

    isLimited?: boolean
    @@ -69,7 +69,7 @@

    Optional

    +
  • Defined in types.ts:196

    • Optional keepAlive

    keepAlive?: boolean
    @@ -78,7 +78,7 @@

    Optional

    +
  • Defined in types.ts:223

    • Optional paysWithFeeDest

    paysWithFeeDest?: string
    @@ -86,7 +86,7 @@

    Optional

    +
  • Defined in types.ts:186

    • Optional paysWithFeeOrigin

    paysWithFeeOrigin?: string
    @@ -96,7 +96,7 @@

    Optional

    +
  • Defined in types.ts:182

    • Optional sendersAddr

    sendersAddr?: string
    @@ -105,7 +105,7 @@

    Optional

    +
  • Defined in types.ts:191

    • Optional transferLiquidToken

    transferLiquidToken?: boolean
    @@ -114,7 +114,7 @@

    Optional

    +
  • Defined in types.ts:228

    • Optional weightLimit

    weightLimit?: {
        proofSize?: string;
        refTime?: string;
    }
    @@ -138,7 +138,7 @@
    Optional
    +
  • Defined in types.ts:201

    • Optional xcmVersion

    xcmVersion?: number
    @@ -147,7 +147,7 @@

    Optional

    +
  • Defined in types.ts:218
    • diff --git a/docs/interfaces/types.TxResult.html b/docs/interfaces/types.TxResult.html index 0de9cebe..6ec32929 100644 --- a/docs/interfaces/types.TxResult.html +++ b/docs/interfaces/types.TxResult.html @@ -31,7 +31,7 @@

    Hierarchy

    • TxResult
    +
  • Defined in types.ts:134
    • @@ -56,7 +56,7 @@

    dest

    +
  • Defined in types.ts:138

    • direction

    direction: Direction | "local"
    @@ -64,7 +64,7 @@

    directionDescription

    The direction of the cross chain transfer.

    +
  • Defined in types.ts:154

    • format

    format: Format | "local"
    @@ -72,7 +72,7 @@

    format

    +
  • Defined in types.ts:146

    • method

    method: Methods
    @@ -80,7 +80,7 @@

    method

    +
  • Defined in types.ts:158

    • origin

    origin: string
    @@ -88,7 +88,7 @@

    origin

    +
  • Defined in types.ts:142

    • tx

    tx: ConstructedFormat<T>
    @@ -96,7 +96,7 @@

    txDescription

    The constructed transaction.

    +
  • Defined in types.ts:162

    • xcmVersion

    xcmVersion: null | number
    @@ -104,7 +104,7 @@

    xcmVersionDescription

    The xcm version that was used to construct the tx.

    +
  • Defined in types.ts:150
    • diff --git a/docs/modules/AssetTransferApi.html b/docs/modules/AssetTransferApi.html index 62779b09..689c1dbe 100644 --- a/docs/modules/AssetTransferApi.html +++ b/docs/modules/AssetTransferApi.html @@ -16,7 +16,7 @@
  • AssetTransferApi

    • Module AssetTransferApi

    +
  • Defined in AssetTransferApi.ts:1

    • Index

    diff --git a/docs/modules/constructApiPromise.html b/docs/modules/constructApiPromise.html index eaaa4d2a..027d4320 100644 --- a/docs/modules/constructApiPromise.html +++ b/docs/modules/constructApiPromise.html @@ -16,7 +16,7 @@
  • constructApiPromise

    • Module constructApiPromise

    +
  • Defined in constructApiPromise.ts:1

    • Index

    diff --git a/docs/modules/errors_BaseError.html b/docs/modules/errors_BaseError.html index 39b6b9f7..7dbefad0 100644 --- a/docs/modules/errors_BaseError.html +++ b/docs/modules/errors_BaseError.html @@ -16,7 +16,7 @@
  • errors/BaseError

    • Module errors/BaseError

    +
  • Defined in errors/BaseError.ts:1

    • Index

    diff --git a/docs/modules/types.html b/docs/modules/types.html index 435fd6b7..7c2c9610 100644 --- a/docs/modules/types.html +++ b/docs/modules/types.html @@ -16,7 +16,7 @@
  • types

    • Module types

    +
  • Defined in types.ts:1

    • Index

    diff --git a/docs/types/types.ConstructedFormat.html b/docs/types/types.ConstructedFormat.html index 57daab5e..f154c65f 100644 --- a/docs/types/types.ConstructedFormat.html +++ b/docs/types/types.ConstructedFormat.html @@ -26,7 +26,7 @@

    Type Parameters

    T

    +
  • Defined in types.ts:91
    • diff --git a/docs/types/types.Format.html b/docs/types/types.Format.html index 0f87a9d9..c97445bb 100644 --- a/docs/types/types.Format.html +++ b/docs/types/types.Format.html @@ -26,7 +26,7 @@

    Type alias Format

    +
  • Defined in types.ts:86
    • diff --git a/docs/types/types.LocalTransferTypes.html b/docs/types/types.LocalTransferTypes.html index a89d5cb7..c725a945 100644 --- a/docs/types/types.LocalTransferTypes.html +++ b/docs/types/types.LocalTransferTypes.html @@ -21,7 +21,7 @@

    Type alias LocalTransferTypes

    +
  • Defined in types.ts:102
    • diff --git a/docs/types/types.Methods.html b/docs/types/types.Methods.html index d7e685e4..1e451aca 100644 --- a/docs/types/types.Methods.html +++ b/docs/types/types.Methods.html @@ -21,7 +21,7 @@

    Type alias Methods

    +
  • Defined in types.ts:115
    • diff --git a/docs/types/types.XcmDirection.html b/docs/types/types.XcmDirection.html index be93a856..4894c100 100644 --- a/docs/types/types.XcmDirection.html +++ b/docs/types/types.XcmDirection.html @@ -21,7 +21,7 @@

    Type alias XcmDirection

    +
  • Defined in types.ts:68