From 1053490739dd0bbd4f0969156a214fa458c524f6 Mon Sep 17 00:00:00 2001 From: Tarik Gul <47201679+TarikGul@users.noreply.github.com> Date: Fri, 16 Jun 2023 14:46:29 -0400 Subject: [PATCH] chore(release): v0.1.0-beta.0 (#207) --- CHANGELOG.md | 23 +++++++++++++++++++++++ README.md | 8 ++++++-- docs/classes/AssetsTransferApi.html | 22 +++++++++++----------- docs/enums/Direction.html | 22 +++++++++++----------- docs/functions/constructApiPromise.html | 8 ++++---- docs/index.html | 18 +++++++++++------- docs/interfaces/ApiInfo.html | 8 ++++---- docs/interfaces/TransferArgsOpts.html | 22 +++++++++++----------- docs/interfaces/TxResult.html | 22 +++++++++++----------- docs/modules.html | 8 ++++---- docs/types/ConstructedFormat.html | 8 ++++---- docs/types/Format.html | 8 ++++---- docs/types/LocalTransferTypes.html | 8 ++++---- docs/types/Methods.html | 8 ++++---- package.json | 2 +- 15 files changed, 113 insertions(+), 82 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b92d6e97..be49c1cc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,28 @@ # Changelog +## [0.1.0-beta.0](https://github.com/paritytech/asset-transfer-api/compare/v0.1.0-alpha.5..v0.1.0-beta.0)(2023-06-16) + +### Stable Beta is here! + +- Add `AssetsTransferApi.fetchFeeInfo` +- Add `AssetsTransferApi.regsitry` which exposes a bunch of useful functionality now. Check out the following [PR #183](https://github.com/paritytech/asset-transfer-api/pull/183) +- Implement `paysWithFeeOrigin` as an option for `AssetsTransferApi.createTransferTransaction` +- Fix type issues for `SystemToPara` +- Add examples +- Update polkadot-js deps +- More verbose errors for when multiple identical assets symbols exists in the same registry. +- Fix ascending order for multiple multi assets for `SystemToPara`. +- Export types at top level. +- Add `dest`, and `origin` to `TxResult`. +- Update `fetchFeeInfo` to take in `call`, and `payload` types. + +NOTE - The API is considered stable for the following direction: + +- RelayToPara +- RelayToSystem +- SystemToRelay +- SystemToPara + ## [0.1.0-alpha.5](https://github.com/paritytech/asset-transfer-api/compare/v0.1.0-alpha.4..v0.1.0-alpha.5)(2023-06-07) - Breaking Change: Rework `AssetTransferApi` constructor, and `constructApiPromise` diff --git a/README.md b/README.md index e06437ce..aea16a73 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,15 @@

+## Docs + +Find full documentation [here](https://paritytech.github.io/asset-transfer-api/), for quick start guide read below. All examples can be found [here](./examples/). + ## About -WARNING: THIS PACKAGE IS NOT PRODUCTION READY! +WARNING: This package is in stable beta, and does not support sending assets in all directions. Read **Current Cross-chain Support** for more info. -**ALPHA**: This package is in alpha and is being rapidly and actively developed on, so some design choices are subject to change. +**BETA**: This package is in stable beta. **Summary**: Asset-transfer-api is a library focused on simplifying the construction of asset transfers for Substrate based chains that involves system parachains like Statemine and Statemint. It exposes a reduced set of methods which facilitates users to send transfers to other (para) chains or locally. diff --git a/docs/classes/AssetsTransferApi.html b/docs/classes/AssetsTransferApi.html index cfddb254..97bdd1d5 100644 --- a/docs/classes/AssetsTransferApi.html +++ b/docs/classes/AssetsTransferApi.html @@ -1,4 +1,4 @@ -AssetsTransferApi | @substrate/asset-transfer-api - v0.1.0-alpha.5
+AssetsTransferApi | @substrate/asset-transfer-api - v0.1.0-beta.0
  • Preparing search index...
    • -
  • The search index is not available
@substrate/asset-transfer-api - v0.1.0-alpha.5
+
  • The search index is not available
    • @substrate/asset-transfer-api - v0.1.0-beta.0
    @@ -25,7 +25,7 @@

    Hierarchy

    • AssetsTransferApi
    +
  • Defined in AssetsTransferApi.ts:59
    • @@ -83,7 +83,7 @@
    Optional Returns Promise<TxResult<T>>
    +
  • Defined in AssetsTransferApi.ts:89

    • decodeExtrinsic

    +
  • Defined in AssetsTransferApi.ts:452

    • fetchFeeInfo

      - +

    • Fetch estimated fee information for an extrinsic

      @@ -129,19 +129,19 @@

      TParameters

      • -
        tx: SubmittableExtrinsic<"promise", ISubmittableResult>
        -

        A polkadot-js submittable extrinsic

        +
        tx: ConstructedFormat<T>
        +

        a payload, call or submittable

      • -
        Optional format: T
        +
        format: T

        The format the tx is in

    Returns Promise<null | RuntimeDispatchInfo | RuntimeDispatchInfoV1>

    +
  • Defined in AssetsTransferApi.ts:275
    • @@ -163,7 +163,7 @@

    decodeExtrinsic
  • fetchFeeInfo

    • -
    @@ -20,7 +20,7 @@

    Enumeration Direction

    +
  • Defined in types.ts:29
    • @@ -45,7 +45,7 @@

    ParaToPara

    +
  • Defined in types.ts:41

    • ParaToRelay

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

    ParaToRelay

    +
  • Defined in types.ts:45

    • ParaToSystem

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

    ParaToSystem

    +
  • Defined in types.ts:49

    • RelayToPara

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

    RelayToPara

    +
  • Defined in types.ts:57

    • RelayToSystem

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

    RelayToSystem

    +
  • Defined in types.ts:53

    • SystemToPara

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

    SystemToPara

    +
  • Defined in types.ts:33

    • SystemToRelay

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

    SystemToRelay

    +
  • Defined in types.ts:37
    • @@ -119,7 +119,7 @@

    SystemToPara
  • SystemToRelay

    • -
    @@ -37,7 +37,7 @@
    opts: Returns Promise<ApiInfo>
    +
  • Defined in constructApiPromise.ts:24
    • @@ -52,7 +52,7 @@

    Member Visibility

    Theme

    -
    -

    @substrate/asset-transfer-api - v0.1.0-alpha.5

    +

    @substrate/asset-transfer-api - v0.1.0-beta.0



    @substrate/asset-transfer-api

    @@ -30,8 +30,9 @@

    Asset API used for common good parachains



    -

    About

    WARNING: THIS PACKAGE IS NOT PRODUCTION READY!

    -

    ALPHA: This package is in alpha and is being rapidly and actively developed on, so some design choices are subject to change.

    +

    Docs

    Find full documentation here, for quick start guide read below. All examples can be found here.

    +

    About

    WARNING: This package is in stable beta, and does not support sending assets in all directions. Read Current Cross-chain Support for more info.

    +

    BETA: This package is in stable beta.

    Summary: Asset-transfer-api is a library focused on simplifying the construction of asset transfers for Substrate based chains that involves system parachains like Statemine and Statemint. It exposes a reduced set of methods which facilitates users to send transfers to other (para) chains or locally.

    Current Cross-chain Support

    The below chart is focusing on what directions are supported for constructing asset transfers and in what XCM version. The goal is to have everything in green checkmarks. Note that local transfers (intra-chain) are not visualized here.

    @@ -140,10 +141,13 @@

    Docs +
  • +
    • -
    @@ -24,7 +24,7 @@

    Hierarchy

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

    Member Visibility

    Theme

    -
    @@ -29,7 +29,7 @@

    Hierarchy

    • TransferArgsOpts
    +
  • Defined in types.ts:145
    • @@ -57,7 +57,7 @@

    Optional

    +
  • Defined in types.ts:153

    • Optional isLimited

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

    Optional

    +
  • Defined in types.ts:168

    • Optional keepAlive

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

    Optional

    +
  • Defined in types.ts:183

    • Optional paysWithFeeDest

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

    Optional

    +
  • Defined in types.ts:163

    • Optional paysWithFeeOrigin

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

    Optional

    +
  • Defined in types.ts:159

    • Optional weightLimit

    weightLimit?: string
    @@ -102,7 +102,7 @@

    Optional

    +
  • Defined in types.ts:173

    • Optional xcmVersion

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

    Optional

    +
  • Defined in types.ts:178
    • @@ -137,7 +137,7 @@

    weightLimit
  • xcmVersion

    • -
    @@ -30,7 +30,7 @@

    Hierarchy

    • TxResult
    +
  • Defined in types.ts:111
    • @@ -55,7 +55,7 @@

    dest

    +
  • Defined in types.ts:115

    • direction

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

    directionDescription

    The direction of the cross chain transfer.

    +
  • Defined in types.ts:131

    • format

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

    format

    +
  • Defined in types.ts:123

    • method

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

    method

    +
  • Defined in types.ts:135

    • origin

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

    origin

    +
  • Defined in types.ts:119

    • tx

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

    txDescription

    The constructed transaction.

    +
  • Defined in types.ts:139

    • xcmVersion

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

    xcmVersionDescription

    The xcm version that was used to construct the tx.

    +
  • Defined in types.ts:127
    • @@ -129,7 +129,7 @@

    tx
  • xcmVersion

    • -
    -

    @substrate/asset-transfer-api - v0.1.0-alpha.5

    +

    @substrate/asset-transfer-api - v0.1.0-beta.0

    Index

    @@ -54,7 +54,7 @@

    Member Visibility

    Theme

    -
    @@ -25,7 +25,7 @@

    Type Parameters

    T

    +
  • Defined in types.ts:76
    • @@ -40,7 +40,7 @@

    Member Visibility

    Theme

    -
    @@ -25,7 +25,7 @@

    Type alias Format

    +
  • Defined in types.ts:71
    • @@ -40,7 +40,7 @@

    Member Visibility

    Theme

    -
    @@ -20,7 +20,7 @@

    Type alias LocalTransferTypes

    +
  • Defined in types.ts:87
    • @@ -35,7 +35,7 @@

    Member Visibility

    Theme

    -
    @@ -20,7 +20,7 @@

    Type alias Methods

    +
  • Defined in types.ts:96
    • @@ -35,7 +35,7 @@

    Member Visibility

    Theme

    -