@xswap-link/sdk 0.2.1 → 0.2.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @xswap-link/xswap-sdk
 
+## 0.2.2
+
+### Patch Changes
+
+- e04c4c6: document initialization
+
 ## 0.2.1
 
 ### Patch Changes

package/dist/index.css

@@ -337,18 +337,12 @@ video {
 .bottom-0 {
   bottom: 0px;
 }
-.bottom-5 {
-  bottom: 1.25rem;
-}
 .left-0 {
   left: 0px;
 }
 .right-0 {
   right: 0px;
 }
-.right-2 {
-  right: 0.5rem;
-}
 .right-4 {
   right: 1rem;
 }
@@ -376,9 +370,6 @@ video {
 .z-20 {
   z-index: 20;
 }
-.z-50 {
-  z-index: 50;
-}
 .z-\[1\] {
   z-index: 1;
 }
@@ -413,6 +404,10 @@ video {
   margin-top: 0px;
   margin-bottom: 0px;
 }
+.my-3 {
+  margin-top: 0.75rem;
+  margin-bottom: 0.75rem;
+}
 .my-4 {
   margin-top: 1rem;
   margin-bottom: 1rem;
@@ -909,9 +904,6 @@ video {
   padding-top: 1rem;
   padding-bottom: 1rem;
 }
-.pl-9 {
-  padding-left: 2.25rem;
-}
 .pr-8 {
   padding-right: 2rem;
 }
@@ -1029,6 +1021,9 @@ video {
   --tw-text-opacity: 1;
   color: rgb(102 187 106 / var(--tw-text-opacity));
 }
+.text-x_grey {
+  color: #ffffff80;
+}
 .no-underline {
   text-decoration-line: none;
 }
@@ -1067,6 +1062,18 @@ video {
     border: 1px solid rgba(255, 255, 255, 0.1);
   }
 }
+.xswap-tx-status {
+  position: absolute;
+  bottom: 1.25rem;
+  right: 0.5rem;
+  z-index: 50;
+  display: flex;
+  width: 100%;
+  flex-direction: column;
+  align-items: flex-end;
+  gap: 0.75rem;
+  padding-left: 2.25rem;
+}
 .placeholder\:text-sm::placeholder {
   font-size: 0.875rem;
   line-height: 1.25rem;

package/dist/index.d.mts

@@ -1,10 +1,5 @@
-import { BigNumber, ethers, BigNumberish } from 'ethers';
+import { BigNumber } from 'ethers';
 import { TransactionRequest } from '@ethersproject/providers';
-import { FC } from 'react';
-
-declare const Alert: ({ desc }: {
-    desc: string;
-}) => JSX.Element;
 
 type Addresses = {
     [chainId: string]: Contracts;
@@ -256,178 +251,8 @@ type MonitoredTransaction = {
     explorer: string | undefined;
 };
 
-type TxConfigFormProps = {
-    dstChainId: string;
-    dstTokenAddr: string;
-    customContractCalls: ContractCall[];
-    desc?: string;
-    supportedChains: Chain[];
-};
-declare const openTxConfigForm: ({ dstChainId, dstTokenAddr, customContractCalls, desc, supportedChains, }: TxConfigFormProps) => Promise<Route>;
-
-interface Props$1 {
-    transaction: MonitoredTransaction;
-}
-declare const TxHistoryButton: FC<Props$1>;
-declare const addTransactionToRenderedTransactions: (transaction: MonitoredTransaction) => void;
-declare const removeTransactionFromRenderedTransactions: (txHash: string) => void;
-declare const updateTransactionDoneInRenderedTransactions: (txHash: string) => void;
-declare const renderTxHistoryButtons: () => void;
-
-type Props = {
-    width: string;
-    height: string;
-    other?: string;
-};
-declare const Skeleton: ({ width, height }: Props) => JSX.Element;
-
-declare const DEFAULT_ECOSYSTEM = Ecosystem.EVM;
-declare const NUMBER_INPUT_REGEX: RegExp;
-declare const SLIPPAGE_PRESETS: number[];
-declare const DELIVERY_TIME: number;
-declare const EXPRESS_DELIVERY_TIME: number;
-declare const BALANCES_CHUNK_SIZE = 500;
-declare const ROUTE_TIMEOUT_MS = 5000;
-declare const MINIMUM_DISPLAYED_TOKEN_AMOUNT = 0.0001;
-declare const DEFAULT_SOURCE_CHAIN_ID = "1";
-declare const CCIP_EXPLORER = "https://ccip.chain.link/";
-declare const TX_RECEIPT_STATUS_LIFETIME = 10000;
-declare const MSG_SENT_EVENT_SIG = "MessageSent(bytes32,uint64,address,bytes,address,uint256,uint256,address,uint256)";
-declare const MSG_SENT_EVENT_ABI: string[];
-declare const MSG_RECEIVED_EVENT_SIG = "MessageReceived(bytes32,uint64,address,bytes,address,uint256)";
-declare const MSG_RECEIVED_EVENT_ABI: string[];
-
-declare const BatchQueryAbi: ({
-    inputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    type: string;
-    outputs?: undefined;
-    stateMutability?: undefined;
-} | {
-    inputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    outputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    stateMutability: string;
-    type: string;
-})[];
-declare const ERC20Abi: ({
-    constant: boolean;
-    inputs: {
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    outputs: {
-        name: string;
-        type: string;
-    }[];
-    payable: boolean;
-    stateMutability: string;
-    type: string;
-    anonymous?: undefined;
-} | {
-    payable: boolean;
-    stateMutability: string;
-    type: string;
-    constant?: undefined;
-    inputs?: undefined;
-    name?: undefined;
-    outputs?: undefined;
-    anonymous?: undefined;
-} | {
-    anonymous: boolean;
-    inputs: {
-        indexed: boolean;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    type: string;
-    constant?: undefined;
-    outputs?: undefined;
-    payable?: undefined;
-    stateMutability?: undefined;
-})[];
-
-declare const ADDRESSES: Addresses;
-
-/**
- * Get swap route based on provided criteria.
- * @param payload required
- */
-declare function getRoute(payload: GetRoutePayload): Promise<Route>;
-/**
- * GET chains based on provided criteria.
- * @param ecosystem optional
- */
-declare function getChains(ecosystem?: Ecosystem): Promise<Chain[]>;
-/**
- * GET chain data based on provided criteria.
- * @param chainId
- * @param ecosystem optional - Default: {@link DEFAULT_ECOSYSTEM}
- */
-declare function getChainData(chainId?: string, ecosystem?: Ecosystem): Promise<Chain>;
-/**
- * GET Tokens based on provided criteria
- * @param chainId required
- * @param address optional
- * @param ecosystem optional but {@link DEFAULT_ECOSYSTEM} will be considered
- */
-declare function getTokens(chainId: string, address?: string, ecosystem?: Ecosystem): Promise<Token[]>;
-declare function getBridgeTokens(): Promise<BridgeToken[]>;
-declare function getHistory(payload: {
-    walletAddress: string;
-}): Promise<TransactionHistory>;
-declare function getPrices(payload: GetPricesPayload): Promise<TokenPrices>;
-
-declare const generateStakingCalls: ({ token, staking, stakingAbi, stakingFunName, stakingFunParams, }: GenerateStakingCallsParams) => ContractCall[];
-
 declare const monitorTransactionStatus: (txChainId: string, txHash: string) => Promise<void>;
 
 declare const getSwapTx: ({ dstChain, dstToken, customContractCalls, desc, }: GetSwapTxPayload) => Promise<Transactions>;
 
-declare const IERC20: ethers.utils.Interface;
-declare const getBalanceOf: (wallet: string, token: string, rpcUrl: string) => Promise<string>;
-declare const getBalances: (chain: Chain, wallet: string) => Promise<TokenBalances>;
-declare const generateApproveTxData: (tokenAddress: string, spender: string, amount: BigNumberish) => TransactionRequest | undefined;
-/**
- * Calculate param's value offset within the encoded function's bytecode.
- * @param abi
- * @param funName
- * @param funParams
- * @param placeholderValue
- */
-declare const findPlaceholderIndex: (abi: string, funName: string, funParams: any[], placeholderValue: BigNumber) => number;
-
-declare const safeBigNumberFrom: (value: string) => BigNumber;
-declare const weiToHumanReadable: ({ amount, decimals, precisionFractionalPlaces, prettifySmallNumber, }: {
-    amount: string;
-    decimals: number;
-    precisionFractionalPlaces: number;
-    prettifySmallNumber?: boolean;
-}) => string;
-declare const generateRandomBigNumber: (length: number) => BigNumber;
-declare const generateUniqueRandomBigNumber: (length: number, existingValues: any[]) => BigNumber;
-
-declare const shortAddress: (address: string) => string;
-
-declare const replaceNull: (values: any[], newValue: any) => any[];
-declare const deepMergeObjects: (obj1: Record<string, any>, obj2: Record<string, any>) => {
-    [x: string]: any;
-};
-declare const chunkArray: (array: any[], chunkSize: number) => any[][];
-declare const getDate: (blockTimestamp: number) => string;
-
-export { ADDRESSES, type AddReferralPayload, type Addresses, Alert, BALANCES_CHUNK_SIZE, BatchQueryAbi, type BridgeToken, CCIP_EXPLORER, type Chain, type CoinTypeAddress, type CollectFees, type ContractCall, ContractName, type Contracts, DEFAULT_ECOSYSTEM, DEFAULT_SOURCE_CHAIN_ID, DELIVERY_TIME, ERC20Abi, EXPRESS_DELIVERY_TIME, Ecosystem, Environment, type GenerateStakingCallsParams, type GetPricesPayload, type GetRoutePayload, type GetSwapTxPayload, type HistoryTransaction, IERC20, MINIMUM_DISPLAYED_TOKEN_AMOUNT, MSG_RECEIVED_EVENT_ABI, MSG_RECEIVED_EVENT_SIG, MSG_SENT_EVENT_ABI, MSG_SENT_EVENT_SIG, type MonitoredTransaction, NUMBER_INPUT_REGEX, type Prices, type Protocol, ROUTE_TIMEOUT_MS, type Referral, type ReferralInfo, type Route, SLIPPAGE_PRESETS, Skeleton, TX_RECEIPT_STATUS_LIFETIME, type Token, type TokenBalances, type TokenPrices, type Transaction, type TransactionHistory, type TransactionStatus, type Transactions, type TxConfigFormData, type TxConfigFormProps, TxHistoryButton, Web3Environment, XSwapCallType, type XSwapConfig, type XSwapFee, type XSwapFees, addTransactionToRenderedTransactions, chunkArray, deepMergeObjects, findPlaceholderIndex, generateApproveTxData, generateRandomBigNumber, generateStakingCalls, generateUniqueRandomBigNumber, getBalanceOf, getBalances, getBridgeTokens, getChainData, getChains, getDate, getHistory, getPrices, getRoute, getSwapTx, getTokens, monitorTransactionStatus, openTxConfigForm, removeTransactionFromRenderedTransactions, renderTxHistoryButtons, replaceNull, safeBigNumberFrom, shortAddress, updateTransactionDoneInRenderedTransactions, weiToHumanReadable };
+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 TransactionStatus, type Transactions, type TxConfigFormData, Web3Environment, XSwapCallType, type XSwapConfig, type XSwapFee, type XSwapFees, getSwapTx, monitorTransactionStatus };

package/dist/index.d.ts

@@ -1,10 +1,5 @@
-import { BigNumber, ethers, BigNumberish } from 'ethers';
+import { BigNumber } from 'ethers';
 import { TransactionRequest } from '@ethersproject/providers';
-import { FC } from 'react';
-
-declare const Alert: ({ desc }: {
-    desc: string;
-}) => JSX.Element;
 
 type Addresses = {
     [chainId: string]: Contracts;
@@ -256,178 +251,8 @@ type MonitoredTransaction = {
     explorer: string | undefined;
 };
 
-type TxConfigFormProps = {
-    dstChainId: string;
-    dstTokenAddr: string;
-    customContractCalls: ContractCall[];
-    desc?: string;
-    supportedChains: Chain[];
-};
-declare const openTxConfigForm: ({ dstChainId, dstTokenAddr, customContractCalls, desc, supportedChains, }: TxConfigFormProps) => Promise<Route>;
-
-interface Props$1 {
-    transaction: MonitoredTransaction;
-}
-declare const TxHistoryButton: FC<Props$1>;
-declare const addTransactionToRenderedTransactions: (transaction: MonitoredTransaction) => void;
-declare const removeTransactionFromRenderedTransactions: (txHash: string) => void;
-declare const updateTransactionDoneInRenderedTransactions: (txHash: string) => void;
-declare const renderTxHistoryButtons: () => void;
-
-type Props = {
-    width: string;
-    height: string;
-    other?: string;
-};
-declare const Skeleton: ({ width, height }: Props) => JSX.Element;
-
-declare const DEFAULT_ECOSYSTEM = Ecosystem.EVM;
-declare const NUMBER_INPUT_REGEX: RegExp;
-declare const SLIPPAGE_PRESETS: number[];
-declare const DELIVERY_TIME: number;
-declare const EXPRESS_DELIVERY_TIME: number;
-declare const BALANCES_CHUNK_SIZE = 500;
-declare const ROUTE_TIMEOUT_MS = 5000;
-declare const MINIMUM_DISPLAYED_TOKEN_AMOUNT = 0.0001;
-declare const DEFAULT_SOURCE_CHAIN_ID = "1";
-declare const CCIP_EXPLORER = "https://ccip.chain.link/";
-declare const TX_RECEIPT_STATUS_LIFETIME = 10000;
-declare const MSG_SENT_EVENT_SIG = "MessageSent(bytes32,uint64,address,bytes,address,uint256,uint256,address,uint256)";
-declare const MSG_SENT_EVENT_ABI: string[];
-declare const MSG_RECEIVED_EVENT_SIG = "MessageReceived(bytes32,uint64,address,bytes,address,uint256)";
-declare const MSG_RECEIVED_EVENT_ABI: string[];
-
-declare const BatchQueryAbi: ({
-    inputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    type: string;
-    outputs?: undefined;
-    stateMutability?: undefined;
-} | {
-    inputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    outputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    stateMutability: string;
-    type: string;
-})[];
-declare const ERC20Abi: ({
-    constant: boolean;
-    inputs: {
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    outputs: {
-        name: string;
-        type: string;
-    }[];
-    payable: boolean;
-    stateMutability: string;
-    type: string;
-    anonymous?: undefined;
-} | {
-    payable: boolean;
-    stateMutability: string;
-    type: string;
-    constant?: undefined;
-    inputs?: undefined;
-    name?: undefined;
-    outputs?: undefined;
-    anonymous?: undefined;
-} | {
-    anonymous: boolean;
-    inputs: {
-        indexed: boolean;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    type: string;
-    constant?: undefined;
-    outputs?: undefined;
-    payable?: undefined;
-    stateMutability?: undefined;
-})[];
-
-declare const ADDRESSES: Addresses;
-
-/**
- * Get swap route based on provided criteria.
- * @param payload required
- */
-declare function getRoute(payload: GetRoutePayload): Promise<Route>;
-/**
- * GET chains based on provided criteria.
- * @param ecosystem optional
- */
-declare function getChains(ecosystem?: Ecosystem): Promise<Chain[]>;
-/**
- * GET chain data based on provided criteria.
- * @param chainId
- * @param ecosystem optional - Default: {@link DEFAULT_ECOSYSTEM}
- */
-declare function getChainData(chainId?: string, ecosystem?: Ecosystem): Promise<Chain>;
-/**
- * GET Tokens based on provided criteria
- * @param chainId required
- * @param address optional
- * @param ecosystem optional but {@link DEFAULT_ECOSYSTEM} will be considered
- */
-declare function getTokens(chainId: string, address?: string, ecosystem?: Ecosystem): Promise<Token[]>;
-declare function getBridgeTokens(): Promise<BridgeToken[]>;
-declare function getHistory(payload: {
-    walletAddress: string;
-}): Promise<TransactionHistory>;
-declare function getPrices(payload: GetPricesPayload): Promise<TokenPrices>;
-
-declare const generateStakingCalls: ({ token, staking, stakingAbi, stakingFunName, stakingFunParams, }: GenerateStakingCallsParams) => ContractCall[];
-
 declare const monitorTransactionStatus: (txChainId: string, txHash: string) => Promise<void>;
 
 declare const getSwapTx: ({ dstChain, dstToken, customContractCalls, desc, }: GetSwapTxPayload) => Promise<Transactions>;
 
-declare const IERC20: ethers.utils.Interface;
-declare const getBalanceOf: (wallet: string, token: string, rpcUrl: string) => Promise<string>;
-declare const getBalances: (chain: Chain, wallet: string) => Promise<TokenBalances>;
-declare const generateApproveTxData: (tokenAddress: string, spender: string, amount: BigNumberish) => TransactionRequest | undefined;
-/**
- * Calculate param's value offset within the encoded function's bytecode.
- * @param abi
- * @param funName
- * @param funParams
- * @param placeholderValue
- */
-declare const findPlaceholderIndex: (abi: string, funName: string, funParams: any[], placeholderValue: BigNumber) => number;
-
-declare const safeBigNumberFrom: (value: string) => BigNumber;
-declare const weiToHumanReadable: ({ amount, decimals, precisionFractionalPlaces, prettifySmallNumber, }: {
-    amount: string;
-    decimals: number;
-    precisionFractionalPlaces: number;
-    prettifySmallNumber?: boolean;
-}) => string;
-declare const generateRandomBigNumber: (length: number) => BigNumber;
-declare const generateUniqueRandomBigNumber: (length: number, existingValues: any[]) => BigNumber;
-
-declare const shortAddress: (address: string) => string;
-
-declare const replaceNull: (values: any[], newValue: any) => any[];
-declare const deepMergeObjects: (obj1: Record<string, any>, obj2: Record<string, any>) => {
-    [x: string]: any;
-};
-declare const chunkArray: (array: any[], chunkSize: number) => any[][];
-declare const getDate: (blockTimestamp: number) => string;
-
-export { ADDRESSES, type AddReferralPayload, type Addresses, Alert, BALANCES_CHUNK_SIZE, BatchQueryAbi, type BridgeToken, CCIP_EXPLORER, type Chain, type CoinTypeAddress, type CollectFees, type ContractCall, ContractName, type Contracts, DEFAULT_ECOSYSTEM, DEFAULT_SOURCE_CHAIN_ID, DELIVERY_TIME, ERC20Abi, EXPRESS_DELIVERY_TIME, Ecosystem, Environment, type GenerateStakingCallsParams, type GetPricesPayload, type GetRoutePayload, type GetSwapTxPayload, type HistoryTransaction, IERC20, MINIMUM_DISPLAYED_TOKEN_AMOUNT, MSG_RECEIVED_EVENT_ABI, MSG_RECEIVED_EVENT_SIG, MSG_SENT_EVENT_ABI, MSG_SENT_EVENT_SIG, type MonitoredTransaction, NUMBER_INPUT_REGEX, type Prices, type Protocol, ROUTE_TIMEOUT_MS, type Referral, type ReferralInfo, type Route, SLIPPAGE_PRESETS, Skeleton, TX_RECEIPT_STATUS_LIFETIME, type Token, type TokenBalances, type TokenPrices, type Transaction, type TransactionHistory, type TransactionStatus, type Transactions, type TxConfigFormData, type TxConfigFormProps, TxHistoryButton, Web3Environment, XSwapCallType, type XSwapConfig, type XSwapFee, type XSwapFees, addTransactionToRenderedTransactions, chunkArray, deepMergeObjects, findPlaceholderIndex, generateApproveTxData, generateRandomBigNumber, generateStakingCalls, generateUniqueRandomBigNumber, getBalanceOf, getBalances, getBridgeTokens, getChainData, getChains, getDate, getHistory, getPrices, getRoute, getSwapTx, getTokens, monitorTransactionStatus, openTxConfigForm, removeTransactionFromRenderedTransactions, renderTxHistoryButtons, replaceNull, safeBigNumberFrom, shortAddress, updateTransactionDoneInRenderedTransactions, weiToHumanReadable };
+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 TransactionStatus, type Transactions, type TxConfigFormData, Web3Environment, XSwapCallType, type XSwapConfig, type XSwapFee, type XSwapFees, getSwapTx, monitorTransactionStatus };