@xswap-link/sdk 0.3.5 → 0.4.1

package/.eslintrc.json

@@ -1,10 +1,14 @@
 {
   "root": true,
   "parser": "@typescript-eslint/parser",
-  "plugins": [
-    "@typescript-eslint"
-  ],
+  "plugins": ["@typescript-eslint"],
   "extends": [
-    "plugin:@typescript-eslint/recommended"
-  ]
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:react-hooks/recommended"
+  ],
+  "rules": {
+    "@typescript-eslint/no-explicit-any": "error",
+    "react-hooks/exhaustive-deps": "warn"
+  }
 }

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @xswap-link/xswap-sdk
 
+## 0.4.1
+
+### Patch Changes
+
+- 6656911: Fix CDN build
+
+## 0.4.0
+
+### Minor Changes
+
+- ce4fdc2: feat: update modal ui
+
+### Patch Changes
+
+- 2d57189: introduce new swap view
+
 ## 0.3.5
 
 ### Patch Changes

package/README.md

@@ -75,7 +75,8 @@ Local file should look like this:
 ```
 import { XSwapConfig } from "@src/models";
 
-const xSwapConfig: XSwapConfig = {
+const xSwapConfig: Partial<XSwapConfig> = {
+    // Props you want to override. Example:
     apiUrl: "http://127.0.0.1:5001/api",
 };
 

package/dist/index.d.mts

@@ -1,19 +1,28 @@
-import { BigNumber } from 'ethers';
+import { BigNumber, ContractReceipt, ContractTransaction } from 'ethers';
+import { TransactionResponse } from '@ethersproject/providers';
+import { Dispatch, SetStateAction } from 'react';
 
 type Addresses = {
     [chainId: string]: Contracts;
 };
-type Contracts = {
+type Contracts = Partial<{
     [contractName in ContractName]: string;
-};
+}>;
 declare enum ContractName {
+    USDC = "USDC",
     BatchQuery = "BatchQuery",
+    CustomXSwapRouter = "CustomXSwapRouter",
     FeeCollector = "FeeCollector",
-    XSwapRouter = "XSwapRouter"
+    StakingCosmicCadets = "StakingCosmicCadets",
+    StakingSolarDivision = "StakingSolarDivision",
+    StakingIntergalacticCommand = "StakingIntergalacticCommand",
+    XSwapRouter = "XSwapRouter",
+    XSwapToken = "XSwapToken"
 }
 
 type XSwapConfig = {
     apiUrl: string;
+    localCss: boolean;
 };
 
 type BridgeToken = {
@@ -64,6 +73,17 @@ type TokenPrices = {
 type TokenBalances = {
     [tokenAddress: string]: BigNumber | undefined;
 };
+type TokenOption = Token & {
+    chainId: string;
+    disabled?: boolean;
+    balance?: BigNumber;
+};
+type ImportedTokenData = {
+    address: string;
+    symbol: string;
+    name: string;
+    decimals: number;
+};
 
 type CoinTypeAddress = {
     coinType: number;
@@ -118,6 +138,29 @@ type GenerateStakingCallsParams = {
     stakingFunParams: any[];
 };
 
+type AddReferralPayload = {
+    code: string;
+    address: string;
+};
+
+type GetTokenBalancesPayload = {
+    walletAddress: string;
+};
+
+type GetFinishedLeaderboardQuestsPayload = {
+    walletAddress: string;
+};
+
+type GetLeaderboardChangePayload = {
+    walletAddress: string;
+    additionalPoints: number;
+};
+
+type GetPricesPayload = {
+    chainId: string;
+    currency?: string;
+};
+
 type GetRoutePayload = {
     integratorId: string;
     fromChain: string;
@@ -140,26 +183,18 @@ type GetRoutePayload = {
     fallbackAddresses?: CoinTypeAddress[];
 };
 
-type AddReferralPayload = {
-    code: string;
-    address: string;
-};
-
-type GetSwapTxPayload = {
+type ModalIntegrationPayload = {
     integratorId: string;
     dstChain: string;
     dstToken: string;
+    srcChain?: string;
+    srcToken?: string;
     customContractCalls?: ContractCall[];
     desc?: string;
     returnTransactions?: boolean;
     dstDisplayToken?: string;
 };
 
-type GetPricesPayload = {
-    chainId: string;
-    currency?: string;
-};
-
 type Protocol = {
     name: string;
     part: number;
@@ -211,6 +246,7 @@ type HistoryTransaction = {
     transferId: string;
     transferType: TransferType;
     walletAddress: string;
+    messageId: string;
     failed: boolean;
     source: {
         blockchainId: string;
@@ -235,6 +271,7 @@ type HistoryTransaction = {
 };
 type TransactionStatus = "IN_PROGRESS" | "DONE" | "REVERTED" | "NOT_FOUND";
 type Transaction = {
+    messageId?: string;
     hash: string;
     timestamp: number;
     sourceChainId: string;
@@ -259,13 +296,62 @@ type MonitoredTransaction = {
     explorer: string | undefined;
 };
 
-declare const renderTxStatus: (txChainId: string, txHash: string) => Promise<void>;
+interface EvmHandlers {
+    onSuccess?: (data: ContractReceipt) => void;
+    onError?: <T>(data: T) => void;
+    onConfirm?: (data?: ContractTransaction) => void;
+}
+
+type EnqueueTxProps = {
+    executeTransaction: () => Promise<TransactionResponse> | undefined;
+    txStatus: TxStatus;
+    txMsg?: string;
+    handlers?: EvmHandlers;
+    network?: Ecosystem;
+    showDefaultSuccessMessage?: boolean;
+};
+type TxUIWrapperState = {
+    enqueueTransaction: (props: EnqueueTxProps) => number;
+    closeTransactionModal: (nonce: number) => void;
+    isTxModalOpen: boolean;
+    setTxModalOpen: Dispatch<SetStateAction<boolean>>;
+    loading: boolean;
+    txStatus: TxStatus;
+    setTxStatus: Dispatch<SetStateAction<TxStatus>>;
+    txExplorerUrl: string;
+    txHash: string;
+    txError: string;
+    txMsg: string;
+    setTxMsg: Dispatch<SetStateAction<string>>;
+    setTxError: Dispatch<SetStateAction<string>>;
+    txNeedsApproval: boolean;
+    setTxNeedsApproval: Dispatch<SetStateAction<boolean>>;
+};
+/**
+ * make sure there's always appropriate CONFIRMATION status following the SIGNING one
+ * see setTxStatus((prevStatus) => prevStatus + 1) at TxUIWrapper.tsx -> addUILogicToHandlersEVM
+ */
+declare enum TxStatus {
+    SWAP_INIT = 0,
+    SIGNING_APPROVAL = 1,
+    CONFIRMING_APPROVAL = 2,
+    SIGNING_TX = 3,
+    CONFIRMING_TX = 4,
+    COMPLETED = 5
+}
+type TxStats = {
+    points?: string;
+    rank?: string;
+    cashback?: string;
+};
+
+declare const renderTxStatus: (txChainId: string, txHash: string, dstTokenAddress?: string, dstTokenAmount?: string) => Promise<void>;
 
-declare const openTransactionModal: ({ integratorId, dstChain, dstToken, customContractCalls, desc, returnTransactions, dstDisplayToken, }: GetSwapTxPayload) => Promise<Transactions | undefined>;
+declare const openTransactionModal: ({ integratorId, dstChain, dstToken, srcChain, srcToken, customContractCalls, desc, returnTransactions, dstDisplayToken, }: ModalIntegrationPayload) => Promise<Transactions | undefined>;
 
 declare const XPay: {
-    openTransactionModal: ({ integratorId, dstChain, dstToken, customContractCalls, desc, returnTransactions, dstDisplayToken, }: GetSwapTxPayload) => Promise<Transactions | undefined>;
-    renderTxStatus: (txChainId: string, txHash: string) => Promise<void>;
+    openTransactionModal: ({ integratorId, dstChain, dstToken, srcChain, srcToken, customContractCalls, desc, returnTransactions, dstDisplayToken, }: ModalIntegrationPayload) => Promise<Transactions | undefined>;
+    renderTxStatus: (txChainId: string, txHash: string, dstTokenAddress?: string, dstTokenAmount?: string) => Promise<void>;
 };
 
-export { type AddReferralPayload, type Addresses, type BridgeToken, type Chain, type CoinTypeAddress, type CollectFees, type ContractCall, ContractName, type Contracts, Ecosystem, Environment, type GenerateStakingCallsParams, type GetPricesPayload, type GetRoutePayload, type GetSwapTxPayload, type HistoryTransaction, type MonitoredTransaction, type Prices, type Protocol, type Referral, type ReferralInfo, type Route, type Token, type TokenBalances, type TokenPrices, type Transaction, type TransactionHistory, type TransactionRequest, type TransactionStatus, type Transactions, type TxConfigFormData, Web3Environment, XSwapCallType, type XSwapConfig, type XSwapFee, type XSwapFees, XPay as default, openTransactionModal, renderTxStatus };
+export { type AddReferralPayload, type Addresses, type BridgeToken, type Chain, type CoinTypeAddress, type CollectFees, type ContractCall, ContractName, type Contracts, Ecosystem, type EnqueueTxProps, Environment, type GenerateStakingCallsParams, type GetFinishedLeaderboardQuestsPayload, type GetLeaderboardChangePayload, type GetPricesPayload, type GetRoutePayload, type GetTokenBalancesPayload, type HistoryTransaction, type ImportedTokenData, type ModalIntegrationPayload, type MonitoredTransaction, type Prices, type Protocol, type Referral, type ReferralInfo, type Route, type Token, type TokenBalances, type TokenOption, type TokenPrices, type Transaction, type TransactionHistory, type TransactionRequest, type TransactionStatus, type Transactions, type TxConfigFormData, type TxStats, TxStatus, type TxUIWrapperState, Web3Environment, XSwapCallType, type XSwapConfig, type XSwapFee, type XSwapFees, XPay as default, openTransactionModal, renderTxStatus };

package/dist/index.d.ts

@@ -1,19 +1,28 @@
-import { BigNumber } from 'ethers';
+import { BigNumber, ContractReceipt, ContractTransaction } from 'ethers';
+import { TransactionResponse } from '@ethersproject/providers';
+import { Dispatch, SetStateAction } from 'react';
 
 type Addresses = {
     [chainId: string]: Contracts;
 };
-type Contracts = {
+type Contracts = Partial<{
     [contractName in ContractName]: string;
-};
+}>;
 declare enum ContractName {
+    USDC = "USDC",
     BatchQuery = "BatchQuery",
+    CustomXSwapRouter = "CustomXSwapRouter",
     FeeCollector = "FeeCollector",
-    XSwapRouter = "XSwapRouter"
+    StakingCosmicCadets = "StakingCosmicCadets",
+    StakingSolarDivision = "StakingSolarDivision",
+    StakingIntergalacticCommand = "StakingIntergalacticCommand",
+    XSwapRouter = "XSwapRouter",
+    XSwapToken = "XSwapToken"
 }
 
 type XSwapConfig = {
     apiUrl: string;
+    localCss: boolean;
 };
 
 type BridgeToken = {
@@ -64,6 +73,17 @@ type TokenPrices = {
 type TokenBalances = {
     [tokenAddress: string]: BigNumber | undefined;
 };
+type TokenOption = Token & {
+    chainId: string;
+    disabled?: boolean;
+    balance?: BigNumber;
+};
+type ImportedTokenData = {
+    address: string;
+    symbol: string;
+    name: string;
+    decimals: number;
+};
 
 type CoinTypeAddress = {
     coinType: number;
@@ -118,6 +138,29 @@ type GenerateStakingCallsParams = {
     stakingFunParams: any[];
 };
 
+type AddReferralPayload = {
+    code: string;
+    address: string;
+};
+
+type GetTokenBalancesPayload = {
+    walletAddress: string;
+};
+
+type GetFinishedLeaderboardQuestsPayload = {
+    walletAddress: string;
+};
+
+type GetLeaderboardChangePayload = {
+    walletAddress: string;
+    additionalPoints: number;
+};
+
+type GetPricesPayload = {
+    chainId: string;
+    currency?: string;
+};
+
 type GetRoutePayload = {
     integratorId: string;
     fromChain: string;
@@ -140,26 +183,18 @@ type GetRoutePayload = {
     fallbackAddresses?: CoinTypeAddress[];
 };
 
-type AddReferralPayload = {
-    code: string;
-    address: string;
-};
-
-type GetSwapTxPayload = {
+type ModalIntegrationPayload = {
     integratorId: string;
     dstChain: string;
     dstToken: string;
+    srcChain?: string;
+    srcToken?: string;
     customContractCalls?: ContractCall[];
     desc?: string;
     returnTransactions?: boolean;
     dstDisplayToken?: string;
 };
 
-type GetPricesPayload = {
-    chainId: string;
-    currency?: string;
-};
-
 type Protocol = {
     name: string;
     part: number;
@@ -211,6 +246,7 @@ type HistoryTransaction = {
     transferId: string;
     transferType: TransferType;
     walletAddress: string;
+    messageId: string;
     failed: boolean;
     source: {
         blockchainId: string;
@@ -235,6 +271,7 @@ type HistoryTransaction = {
 };
 type TransactionStatus = "IN_PROGRESS" | "DONE" | "REVERTED" | "NOT_FOUND";
 type Transaction = {
+    messageId?: string;
     hash: string;
     timestamp: number;
     sourceChainId: string;
@@ -259,13 +296,62 @@ type MonitoredTransaction = {
     explorer: string | undefined;
 };
 
-declare const renderTxStatus: (txChainId: string, txHash: string) => Promise<void>;
+interface EvmHandlers {
+    onSuccess?: (data: ContractReceipt) => void;
+    onError?: <T>(data: T) => void;
+    onConfirm?: (data?: ContractTransaction) => void;
+}
+
+type EnqueueTxProps = {
+    executeTransaction: () => Promise<TransactionResponse> | undefined;
+    txStatus: TxStatus;
+    txMsg?: string;
+    handlers?: EvmHandlers;
+    network?: Ecosystem;
+    showDefaultSuccessMessage?: boolean;
+};
+type TxUIWrapperState = {
+    enqueueTransaction: (props: EnqueueTxProps) => number;
+    closeTransactionModal: (nonce: number) => void;
+    isTxModalOpen: boolean;
+    setTxModalOpen: Dispatch<SetStateAction<boolean>>;
+    loading: boolean;
+    txStatus: TxStatus;
+    setTxStatus: Dispatch<SetStateAction<TxStatus>>;
+    txExplorerUrl: string;
+    txHash: string;
+    txError: string;
+    txMsg: string;
+    setTxMsg: Dispatch<SetStateAction<string>>;
+    setTxError: Dispatch<SetStateAction<string>>;
+    txNeedsApproval: boolean;
+    setTxNeedsApproval: Dispatch<SetStateAction<boolean>>;
+};
+/**
+ * make sure there's always appropriate CONFIRMATION status following the SIGNING one
+ * see setTxStatus((prevStatus) => prevStatus + 1) at TxUIWrapper.tsx -> addUILogicToHandlersEVM
+ */
+declare enum TxStatus {
+    SWAP_INIT = 0,
+    SIGNING_APPROVAL = 1,
+    CONFIRMING_APPROVAL = 2,
+    SIGNING_TX = 3,
+    CONFIRMING_TX = 4,
+    COMPLETED = 5
+}
+type TxStats = {
+    points?: string;
+    rank?: string;
+    cashback?: string;
+};
+
+declare const renderTxStatus: (txChainId: string, txHash: string, dstTokenAddress?: string, dstTokenAmount?: string) => Promise<void>;
 
-declare const openTransactionModal: ({ integratorId, dstChain, dstToken, customContractCalls, desc, returnTransactions, dstDisplayToken, }: GetSwapTxPayload) => Promise<Transactions | undefined>;
+declare const openTransactionModal: ({ integratorId, dstChain, dstToken, srcChain, srcToken, customContractCalls, desc, returnTransactions, dstDisplayToken, }: ModalIntegrationPayload) => Promise<Transactions | undefined>;
 
 declare const XPay: {
-    openTransactionModal: ({ integratorId, dstChain, dstToken, customContractCalls, desc, returnTransactions, dstDisplayToken, }: GetSwapTxPayload) => Promise<Transactions | undefined>;
-    renderTxStatus: (txChainId: string, txHash: string) => Promise<void>;
+    openTransactionModal: ({ integratorId, dstChain, dstToken, srcChain, srcToken, customContractCalls, desc, returnTransactions, dstDisplayToken, }: ModalIntegrationPayload) => Promise<Transactions | undefined>;
+    renderTxStatus: (txChainId: string, txHash: string, dstTokenAddress?: string, dstTokenAmount?: string) => Promise<void>;
 };
 
-export { type AddReferralPayload, type Addresses, type BridgeToken, type Chain, type CoinTypeAddress, type CollectFees, type ContractCall, ContractName, type Contracts, Ecosystem, Environment, type GenerateStakingCallsParams, type GetPricesPayload, type GetRoutePayload, type GetSwapTxPayload, type HistoryTransaction, type MonitoredTransaction, type Prices, type Protocol, type Referral, type ReferralInfo, type Route, type Token, type TokenBalances, type TokenPrices, type Transaction, type TransactionHistory, type TransactionRequest, type TransactionStatus, type Transactions, type TxConfigFormData, Web3Environment, XSwapCallType, type XSwapConfig, type XSwapFee, type XSwapFees, XPay as default, openTransactionModal, renderTxStatus };
+export { type AddReferralPayload, type Addresses, type BridgeToken, type Chain, type CoinTypeAddress, type CollectFees, type ContractCall, ContractName, type Contracts, Ecosystem, type EnqueueTxProps, Environment, type GenerateStakingCallsParams, type GetFinishedLeaderboardQuestsPayload, type GetLeaderboardChangePayload, type GetPricesPayload, type GetRoutePayload, type GetTokenBalancesPayload, type HistoryTransaction, type ImportedTokenData, type ModalIntegrationPayload, type MonitoredTransaction, type Prices, type Protocol, type Referral, type ReferralInfo, type Route, type Token, type TokenBalances, type TokenOption, type TokenPrices, type Transaction, type TransactionHistory, type TransactionRequest, type TransactionStatus, type Transactions, type TxConfigFormData, type TxStats, TxStatus, type TxUIWrapperState, Web3Environment, XSwapCallType, type XSwapConfig, type XSwapFee, type XSwapFees, XPay as default, openTransactionModal, renderTxStatus };