@paraspell/sdk-pjs 8.0.0

package/dist/index.d.ts

@@ -0,0 +1,176 @@
+import * as _paraspell_sdk_core from '@paraspell/sdk-core';
+import { TApiOrUrl, TSerializeEthTransferOptions, TSerializedEthTransfer, TSendOptions, TEvmBuilderOptions, TOptionalEvmBuilderOptions, IPolkadotApi, TNodePolkadotKusama, TCurrencyCoreV1WithAmount, GeneralBuilder as GeneralBuilder$1, IUseKeepAliveFinalBuilder as IUseKeepAliveFinalBuilder$1, TNodeDotKsmWithRelayChains } from '@paraspell/sdk-core';
+export * from '@paraspell/sdk-core';
+import * as _snowbridge_api_dist_toPolkadot from '@snowbridge/api/dist/toPolkadot';
+import { SubmittableExtrinsic } from '@polkadot/api/types';
+import * as _polkadot_api from '@polkadot/api';
+import { ApiPromise } from '@polkadot/api';
+import { AbstractProvider, Signer } from 'ethers';
+
+type TPjsApi = ApiPromise;
+type TPjsApiOrUrl = TApiOrUrl<TPjsApi>;
+type Extrinsic = SubmittableExtrinsic<'promise'>;
+
+declare const buildEthTransferOptions: ({ currency, to, address, destAddress }: TSerializeEthTransferOptions) => Promise<TSerializedEthTransfer>;
+
+/**
+ * Transfers assets from parachain to another parachain or from/to relay chain.
+ * @param options - The transfer options.
+ * @returns An extrinsic to be signed and sent.
+ */
+declare const send: (options: Omit<TSendOptions<TPjsApi, Extrinsic>, "api" | "destApiForKeepAlive"> & {
+    api?: TPjsApiOrUrl;
+    destApiForKeepAlive?: TPjsApiOrUrl;
+}) => Promise<Extrinsic>;
+declare const getDryRun: (options: _paraspell_sdk_core.TDryRunBaseOptions<Extrinsic> & {
+    api?: TPjsApiOrUrl;
+}) => Promise<_paraspell_sdk_core.TDryRunResult>;
+declare const transferEthToPolkadot: (options: Omit<TEvmBuilderOptions<TPjsApi, Extrinsic>, "api">) => Promise<{
+    result: _snowbridge_api_dist_toPolkadot.SendResult;
+    plan: _snowbridge_api_dist_toPolkadot.SendValidationResult;
+}>;
+
+declare const transfer_buildEthTransferOptions: typeof buildEthTransferOptions;
+declare const transfer_getDryRun: typeof getDryRun;
+declare const transfer_send: typeof send;
+declare const transfer_transferEthToPolkadot: typeof transferEthToPolkadot;
+declare namespace transfer {
+  export { transfer_buildEthTransferOptions as buildEthTransferOptions, transfer_getDryRun as getDryRun, transfer_send as send, transfer_transferEthToPolkadot as transferEthToPolkadot };
+}
+
+/**
+ * Retrieves the native balance for a given account on a specified node.
+ *
+ * @returns The native balance as a bigint.
+ */
+declare const getBalanceNative: (options: _paraspell_sdk_core.TGetBalanceNativeOptionsBase & {
+    api?: TPjsApiOrUrl;
+}) => Promise<bigint>;
+/**
+ * Retrieves the balance of a foreign asset for a given account on a specified node.
+ *
+ * @returns The balance of the foreign asset as a bigint, or null if not found.
+ */
+declare const getBalanceForeign: (options: _paraspell_sdk_core.TGetBalanceForeignOptionsBase & {
+    api?: TPjsApiOrUrl;
+}) => Promise<bigint>;
+/**
+ * Retrieves detailed transfer information for a cross-chain transfer.
+ *
+ * @returns A Promise that resolves to the transfer information.
+ */
+declare const getTransferInfo: (options: _paraspell_sdk_core.TGetTransferInfoOptionsBase & {
+    api?: TPjsApiOrUrl;
+}) => Promise<_paraspell_sdk_core.TTransferInfo>;
+/**
+ * Retrieves the asset balance for a given account on a specified node.
+ *
+ * @returns The asset balance as a bigint.
+ */
+declare const getAssetBalance: (options: _paraspell_sdk_core.TGetAssetBalanceOptionsBase & {
+    api?: TPjsApiOrUrl;
+}) => Promise<bigint>;
+/**
+ * Claims assets from a parachain.
+ *
+ * @returns An extrinsic representing the claim transaction.
+ */
+declare const claimAssets: (options: {
+    node: _paraspell_sdk_core.TNodeWithRelayChains;
+    multiAssets: _paraspell_sdk_core.TMultiAsset[];
+    address: _paraspell_sdk_core.TAddress;
+    version?: _paraspell_sdk_core.TVersionClaimAssets;
+} & {
+    api?: TPjsApiOrUrl;
+}) => Promise<Extrinsic>;
+declare const getOriginFeeDetails: (options: _paraspell_sdk_core.TGetOriginFeeDetailsOptionsBase & {
+    api?: TPjsApiOrUrl;
+}) => Promise<_paraspell_sdk_core.TOriginFeeDetails>;
+declare const getMaxNativeTransferableAmount: (options: _paraspell_sdk_core.TGetMaxNativeTransferableAmountOptionsBase & {
+    api?: TPjsApiOrUrl;
+}) => Promise<bigint>;
+declare const getMaxForeignTransferableAmount: (options: _paraspell_sdk_core.TGetMaxForeignTransferableAmountOptionsBase & {
+    api?: TPjsApiOrUrl;
+}) => Promise<bigint>;
+declare const getTransferableAmount: (options: _paraspell_sdk_core.TGetTransferableAmountOptionsBase & {
+    api?: TPjsApiOrUrl;
+}) => Promise<bigint>;
+
+declare const assets_claimAssets: typeof claimAssets;
+declare const assets_getAssetBalance: typeof getAssetBalance;
+declare const assets_getBalanceForeign: typeof getBalanceForeign;
+declare const assets_getBalanceNative: typeof getBalanceNative;
+declare const assets_getMaxForeignTransferableAmount: typeof getMaxForeignTransferableAmount;
+declare const assets_getMaxNativeTransferableAmount: typeof getMaxNativeTransferableAmount;
+declare const assets_getOriginFeeDetails: typeof getOriginFeeDetails;
+declare const assets_getTransferInfo: typeof getTransferInfo;
+declare const assets_getTransferableAmount: typeof getTransferableAmount;
+declare namespace assets {
+  export { assets_claimAssets as claimAssets, assets_getAssetBalance as getAssetBalance, assets_getBalanceForeign as getBalanceForeign, assets_getBalanceNative as getBalanceNative, assets_getMaxForeignTransferableAmount as getMaxForeignTransferableAmount, assets_getMaxNativeTransferableAmount as getMaxNativeTransferableAmount, assets_getOriginFeeDetails as getOriginFeeDetails, assets_getTransferInfo as getTransferInfo, assets_getTransferableAmount as getTransferableAmount };
+}
+
+/**
+ * Builder class for constructing transfers from Ethereum to Polkadot.
+ */
+declare class EvmBuilderClass<TApi, TRes> {
+    _options: TOptionalEvmBuilderOptions<TApi, TRes>;
+    constructor(api: IPolkadotApi<TApi, TRes>, provider?: AbstractProvider);
+    from(node: 'Ethereum' | 'Moonbeam' | 'Moonriver'): this;
+    /**
+     * Specifies the destination node on Polkadot.
+     *
+     * @param node - The Polkadot node to which the transfer will be made.
+     * @returns An instance of EvmBuilder
+     */
+    to(node: TNodePolkadotKusama): this;
+    /**
+     * Specifies the currency to transfer.
+     *
+     * @param currency - The currency to be transferred.
+     * @returns An instance of EvmBuilder
+     */
+    currency(currency: TCurrencyCoreV1WithAmount): this;
+    /**
+     * Specifies the recipient address on Polkadot.
+     *
+     * @param address - The Polkadot address to receive the transfer.
+     * @returns An instance of EvmBuilder
+     */
+    address(address: string): this;
+    /**
+     * Specifies the signer for the Ethereum transaction.
+     *
+     * @param signer - The Ethereum signer to authorize the transfer.
+     * @returns An instance of EvmBuilder
+     */
+    signer(signer: Signer): this;
+    /**
+     * Builds and executes the transfer from Ethereum to Polkadot.
+     *
+     * @throws Error if any required parameters are missing.
+     */
+    build(): Promise<string>;
+}
+
+/**
+ * Creates a new Builder instance.
+ *
+ * @param api - The API instance to use for building transactions. If not provided, a new instance will be created.
+ * @returns A new Builder instance.
+ */
+declare const Builder: (api?: TPjsApiOrUrl) => _paraspell_sdk_core.IFromBuilder<_polkadot_api.ApiPromise, Extrinsic>;
+declare const GeneralBuilder: {
+    new (batchManager: {
+        transactionOptions: _paraspell_sdk_core.TSendOptions<_polkadot_api.ApiPromise, Extrinsic>[];
+        addTransaction(options: _paraspell_sdk_core.TSendOptions<_polkadot_api.ApiPromise, Extrinsic>): void;
+        isEmpty(): boolean;
+        buildBatch(api: _paraspell_sdk_core.IPolkadotApi<_polkadot_api.ApiPromise, Extrinsic>, from: _paraspell_sdk_core.TNodeDotKsmWithRelayChains, options?: _paraspell_sdk_core.TBatchOptions): Promise<Extrinsic>;
+    }, api: _paraspell_sdk_core.IPolkadotApi<_polkadot_api.ApiPromise, Extrinsic>, from?: _paraspell_sdk_core.TNodeDotKsmWithRelayChains): GeneralBuilder$1<_polkadot_api.ApiPromise, Extrinsic>;
+};
+declare const EvmBuilder: (provider?: AbstractProvider) => EvmBuilderClass<_polkadot_api.ApiPromise, Extrinsic>;
+
+type IUseKeepAliveFinalBuilder = IUseKeepAliveFinalBuilder$1<TPjsApi, Extrinsic>;
+
+declare const createApiInstanceForNode: (node: TNodeDotKsmWithRelayChains) => Promise<_polkadot_api.ApiPromise>;
+
+export { Builder, EvmBuilder, type Extrinsic, GeneralBuilder, type IUseKeepAliveFinalBuilder, type TPjsApi, type TPjsApiOrUrl, assets, buildEthTransferOptions, claimAssets, createApiInstanceForNode, getAssetBalance, getBalanceForeign, getBalanceNative, getDryRun, getMaxForeignTransferableAmount, getMaxNativeTransferableAmount, getOriginFeeDetails, getTransferInfo, getTransferableAmount, send, transferEthToPolkadot, transfer as xcmPallet };