@galacticcouncil/xc-sdk 0.1.0

package/build/types/transfer/DataOriginProcessor.d.ts

@@ -0,0 +1,42 @@
+import { Asset, AssetAmount, TransferCtx, TransferConfig, TransactCtx } from '@galacticcouncil/xc-core';
+import { Call, PlatformAdapter } from '../platforms';
+import { DataProcessor } from './DataProcessor';
+export declare class DataOriginProcessor extends DataProcessor {
+    constructor(adapter: PlatformAdapter, config: TransferConfig);
+    getCall(ctx: TransferCtx): Promise<Call>;
+    getDestinationFee(): Promise<{
+        fee: AssetAmount;
+        feeBreakdown: {
+            [key: string]: bigint;
+        };
+    }>;
+    getDestinationFeeBalance(address: string): Promise<AssetAmount>;
+    getFee(ctx: TransferCtx): Promise<AssetAmount>;
+    getFeeBalance(address: string): Promise<AssetAmount>;
+    getFeeAsset(address: string): Promise<Asset>;
+    private getTransfer;
+    getTransact(ctx: TransferCtx): Promise<TransactCtx | undefined>;
+    /**
+     * Transact remote execution context
+     *
+     * @param cfg - transact config
+     * @param ctx - augmented transfer context
+     * @returns transact remote call context
+     */
+    private getTransactData;
+    /**
+     * Transact fee on source chain
+     *
+     * @param cfg - transact config
+     * @returns transact source chain fee
+     */
+    private getTransactFee;
+    /**
+     * Transact fee balance on source chain
+     *
+     * @param cfg - transact config
+     * @param ctx - augmented transfer context
+     * @returns transact source chain fee balance
+     */
+    private getTransactFeeBalance;
+}

package/build/types/transfer/DataProcessor.d.ts

@@ -0,0 +1,12 @@
+import { Asset, AssetAmount, TransferConfig } from '@galacticcouncil/xc-core';
+import { PlatformAdapter } from '../platforms';
+export declare abstract class DataProcessor {
+    readonly adapter: PlatformAdapter;
+    readonly config: TransferConfig;
+    constructor(adapter: PlatformAdapter, config: TransferConfig);
+    getEd(): Promise<AssetAmount | undefined>;
+    getBalance(address: string): Promise<AssetAmount>;
+    getMin(): Promise<AssetAmount>;
+    private getAssetMin;
+    protected getDecimals(asset: Asset): Promise<number>;
+}

package/build/types/transfer/DataReverseProcessor.d.ts

@@ -0,0 +1,6 @@
+import { TransferConfig } from '@galacticcouncil/xc-core';
+import { PlatformAdapter } from '../platforms';
+import { DataProcessor } from './DataProcessor';
+export declare class DataReverseProcessor extends DataProcessor {
+    constructor(adapter: PlatformAdapter, config: TransferConfig);
+}

package/build/types/transfer/index.d.ts

@@ -0,0 +1,3 @@
+export { DataOriginProcessor } from './DataOriginProcessor';
+export { DataReverseProcessor } from './DataReverseProcessor';
+export * from './utils';

package/build/types/transfer/utils.d.ts

@@ -0,0 +1,41 @@
+import { AnyChain, AssetAmount } from '@galacticcouncil/xc-core';
+/**
+ * Calculate maximum allowed amount of asset to send from source to
+ * destination chain.
+ *
+ * @param balance - source chain asset balance
+ * @param fee - source chain transfer fee
+ * @param min - source chain minimum
+ * @param ed - source chain existential deposit (opt)
+ * @returns - maximum allowed amount of tokens to send or zero in
+ * case of not enough funds
+ */
+export declare function calculateMax(balance: AssetAmount, fee: AssetAmount, min: AssetAmount, ed?: AssetAmount): AssetAmount;
+/**
+ * Calculate minimum required amount of asset to send from source to
+ * destination chain.
+ *
+ * @param balance - destination chain asset balance
+ * @param fee - destination chain transfer fee
+ * @param min - destination chain minimum
+ * @param ed - destination chain existential deposit (opt)
+ * @returns - minimum required amount of tokens to send or zero in
+ * case of no available funds
+ */
+export declare function calculateMin(balance: AssetAmount, fee: AssetAmount, min: AssetAmount, ed?: AssetAmount): AssetAmount;
+/**
+ * Return h160 derivated address in case of Evm parachain
+ *
+ * @param address - h160 or ss58 address format
+ * @param chain - transfer chain ctx
+ * @returns - derivated address if evm resolver defined, fallback to default
+ */
+export declare function formatEvmAddress(address: string, chain: AnyChain): Promise<string>;
+/**
+ * Format amount if defined
+ *
+ * @param decimals - fee asset decimals
+ * @param amount - fee amount
+ * @returns formatted amount or 0
+ */
+export declare function formatAmount(decimals: number, amount?: number): bigint;

package/build/types/types.d.ts

@@ -0,0 +1,51 @@
+import { AssetAmount, SwapCtx, TransferValidationReport } from '@galacticcouncil/xc-core';
+import { Call } from './platforms';
+/**
+ * Transfer source data
+ *
+ * @interface TransferSourceData
+ * @member {AssetAmount} balance Transfer asset balance
+ * @member {AssetAmount} destinationFee Transfer destination fee
+ * @member {AssetAmount} destinationFeeBalance Transfer destination fee asset balance
+ * @member {AssetAmount} fee Transfer fee
+ * @member {AssetAmount} feeBalance Transfer fee asset balance
+ * @member {SwapCtx} feeSwap Transfer fee swap context details
+ * @member {AssetAmount} max Maximum allowed amount of transfer asset to send
+ * @member {AssetAmount} min Minimum required amount of transfer asset to send
+ */
+export interface TransferSourceData {
+    balance: AssetAmount;
+    destinationFee: AssetAmount;
+    destinationFeeBalance: AssetAmount;
+    destinationFeeSwap: SwapCtx;
+    fee: AssetAmount;
+    feeBalance: AssetAmount;
+    feeSwap: SwapCtx;
+    max: AssetAmount;
+    min: AssetAmount;
+}
+/**
+ * Transfer destination data
+ *
+ * @interface TransferDestinationData
+ * @member {AssetAmount} balance Received asset balance
+ * @member {AssetAmount} fee Transfer destination fee
+ */
+export interface TransferDestinationData {
+    balance: AssetAmount;
+    fee: AssetAmount;
+}
+/**
+ * Transfer input
+ *
+ * @interface Transfer
+ * @member {TransferSourceData} source Source chain data
+ * @member {TransferDestinationData} destination Destination chain data
+ */
+export interface Transfer {
+    source: TransferSourceData;
+    destination: TransferDestinationData;
+    buildCall(amount: bigint | number | string): Promise<Call>;
+    estimateFee(amount: bigint | number | string): Promise<AssetAmount>;
+    validate(fee?: bigint): Promise<TransferValidationReport[]>;
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@galacticcouncil/xc-sdk",
+  "version": "0.1.0",
+  "description": "Cross-chain sdk",
+  "author": "GalacticCouncil",
+  "type": "module",
+  "repository": {
+    "directory": "packages/xc-sdk",
+    "type": "git",
+    "url": "git+https://github.com/galacticcouncil/sdk.git"
+  },
+  "keywords": [
+    "evm",
+    "substrate",
+    "wallet",
+    "xcm",
+    "wormhole"
+  ],
+  "bugs": {
+    "url": "https://github.com/galacticcouncil/sdk/issues"
+  },
+  "files": [
+    "build"
+  ],
+  "main": "./build/index.cjs",
+  "module": "./build/index.mjs",
+  "types": "./build/types/index.d.ts",
+  "scripts": {
+    "build": "npm run clean && node ./esbuild.dist.mjs",
+    "build:watch": "node ./esbuild.dev.mjs",
+    "postbuild": "tsc --emitDeclarationOnly --outDir build/types",
+    "clean": "rimraf build",
+    "link": "npm ln"
+  },
+  "dependencies": {
+    "@galacticcouncil/xc-core": "^0.1.0"
+  }
+}