@imtbl/sdk 0.0.1-alpha.3 → 0.1.0-alpha

package/README.md

@@ -0,0 +1,28 @@
+<div align="center">
+  <p align="center">
+    <a href="https://docs.x.immutable.com/docs">
+      <img src="https://cdn.dribbble.com/users/1299339/screenshots/7133657/media/837237d447d36581ebd59ec36d30daea.gif" width="280"/>
+    </a>
+  </p>
+  <h1>Immutable Unified TypeScript SDK</h1>
+</div>
+
+# Immutable Unified TypeScript SDK
+
+## Documentation
+
+See our [developer documentation](https://docs.immutable.com) for information on building on Immutable.
+
+See our [API reference](https://docs.immutable.com/reference) for more information on our APIs.
+
+### Examples
+
+- For examples, please view them on our [documentation website](https://docs.immutable.com/sdk-docs/ts-immutable-sdk/overview/).
+
+## Installation
+
+```sh
+npm install @imtbl/sdk --save
+# or
+yarn add @imtbl/sdk
+```

package/dist/checkout_sdk.d.ts

@@ -546,6 +546,14 @@ declare class Web3Provider extends JsonRpcProvider {
     send(method: string, params: Array<any>): Promise<any>;
 }
 
+/**
+ * Interface representing token information.
+ * @property {string} name - The token name.
+ * @property {string} symbol - The token symbol.
+ * @property {number} decimals - The token decimals.
+ * @property {string} [address] - The token contract address.
+ * @property {string} [icon] - The token icon URL/data:image.
+ */
 interface TokenInfo {
     name: string;
     symbol: string;
@@ -553,98 +561,218 @@ interface TokenInfo {
     address?: string;
     icon?: string;
 }
+/**
+ * Interface representing the parameters for {@link Checkout.getTokenAllowList}.
+ * @property {TokenFilterTypes} type - The type of token to retrieve.
+ * @property {ChainId}  chainId - The ID of the blockchain network.
+ * @property {TokenFilter[]} [exclude] - The tokens to exclude from the list.
+ */
 interface GetTokenAllowListParams {
     type: TokenFilterTypes;
     chainId: ChainId;
     exclude?: TokenFilter[];
 }
+/**
+ * Interface representing the result of {@link Checkout.getTokenAllowList}.
+ * @property {TokenInfo[]} tokens - The list of tokens allowed for the specified params.
+ */
 interface GetTokenAllowListResult {
     tokens: TokenInfo[];
 }
+/**
+ * Enum representing the types of token filters available.
+ */
 declare enum TokenFilterTypes {
     SWAP = "swap",
     BRIDGE = "bridge",
     ALL = "all"
 }
+/**
+ * Interface representing a token filter that can be used to exclude certain tokens.
+ * @property {string} address - The token contract address.
+ */
 interface TokenFilter {
     address: string;
 }
+/**
+ * Enum representing the supported chains with their corresponding IDs.
+ */
 declare enum ChainId {
     ETHEREUM = 1,
     GOERLI = 5,
     POLYGON = 137
 }
+/**
+ * Interface representing the information of a network.
+ * @property {string} name - The name of the network.
+ * @property {number} chainId - The ID of the network.
+ * @property {TokenInfo} nativeCurrency - The info of the network's native currency.
+ * @property {boolean} isSupported - Flag indicating if the network is supported by the application.
+ */
 interface NetworkInfo {
     name: string;
     chainId: number;
     nativeCurrency: TokenInfo;
     isSupported: boolean;
 }
+/**
+ * Interface representing the parameters for {@link Checkout.switchNetwork}.
+ * @property {Web3Provider} provider - The provider to connect to the network.
+ * @property {ChainId} chainId - The ID of the network to switch to.
+ */
 interface SwitchNetworkParams {
     provider: Web3Provider;
     chainId: ChainId;
 }
+/**
+ * Interface representing the result of {@link Checkout.switchNetwork}.
+ * @property {NetworkInfo} network - The information of the network that was switched to.
+ */
 interface SwitchNetworkResult {
     network: NetworkInfo;
+    provider: Web3Provider;
 }
+/**
+ * * Interface representing the parameters for {@link Checkout.getNetworkInfo}.
+ * @property {Web3Provider} provider - The provider to connect to the network.
+ */
 interface GetNetworkParams {
     provider: Web3Provider;
 }
+/**
+ * Enum representing the types of filters that can be applied to get the allow list of networks.
+ */
 declare enum NetworkFilterTypes {
     ALL = "all"
 }
+/**
+ * Interface representing a filter for filtering a specific network.
+ * @property {ChainId} chainId - The ID of the network to allow or disallow.
+ */
 interface NetworkFilter {
     chainId: ChainId;
 }
+/**
+ * * Interface representing the parameters for {@link Checkout.getNetworkAllowList}.
+ * @property {NetworkFilterTypes} type - The type of allow list filter to apply.
+ * @property {NetworkFilter[]} [exclude] - The list of networks to exclude from the allow list.
+ */
 interface GetNetworkAllowListParams {
     type: NetworkFilterTypes;
     exclude?: NetworkFilter[];
 }
+/**
+ * Interface representing the result of {@link Checkout.getNetworkAllowList}.
+ * @property {NetworkInfo[]} networks - The list of allowed networks.
+ */
 interface GetNetworkAllowListResult {
     networks: NetworkInfo[];
 }
+/**
+ * Interface representing the parameters for {@link Checkout.getBalance}.
+ * @property {@link Web3Provider} provider - The provider to connect to the network.
+ * @property {string} walletAddress - The wallet address.
+ * @property {string | undefined} contractAddress - The contract address of the token.
+ */
 interface GetBalanceParams {
     provider: Web3Provider;
     walletAddress: string;
     contractAddress?: string;
 }
+/**
+ * Interface representing the result of {@link Checkout.getBalance}.
+ * @property {BigNumber} balance - The balance of the wallet for the token.
+ * @property {string} formattedBalance - The formatted balance of the wallet for the token.
+ * @property {TokenInfo} token - The token information.
+ */
 interface GetBalanceResult {
     balance: BigNumber;
     formattedBalance: string;
     token: TokenInfo;
 }
+/**
+ * Interface representing the parameters for {@link Checkout.getAllBalances}.
+ * @property {Web3Provider} provider - The provider to connect to the network.
+ * @property {string} walletAddress - The wallet address.
+ * @property {ChainId} chainId - The ID of the network.
+ */
 interface GetAllBalancesParams {
     provider: Web3Provider;
     walletAddress: string;
     chainId: ChainId;
 }
+/**
+ * Interface representing the result of {@link Checkout.getAllBalances}.
+ * @property {GetBalanceResult[]} balances - The array of balances of the wallet for every token.
+ */
 interface GetAllBalancesResult {
     balances: GetBalanceResult[];
 }
+/**
+ * Enum representing the list of default supported providers.
+ */
 declare enum ConnectionProviders {
     METAMASK = "metamask"
 }
+/**
+ * Interface representing the parameters for {@link Checkout.connect}.
+ * @property {ConnectionProviders} providerPreference - The preferred provider to connect to the network.
+ */
 type ConnectParams = {
     providerPreference: ConnectionProviders;
 };
+/**
+ * Interface representing the result of {@link Checkout.connect}.
+ * @property {Web3Provider} provider - The provider used to connect to the network.
+ * @property {NetworkInfo} network - Information about the connected network.
+ */
 interface ConnectResult {
     provider: Web3Provider;
     network: NetworkInfo;
 }
+/**
+ * Interface representing the parameters for {@link Checkout.checkIsWalletConnected}.
+ * @property {ConnectionProviders} providerPreference - The preferred provider to use to check the connection status to th Web3 network.
+ */
 interface CheckConnectionParams {
     providerPreference: ConnectionProviders;
 }
+/**
+ * Interface representing the result of {@link Checkout.checkIsWalletConnected}.
+ * @property {boolean} isConnected - A boolean indicating the connection status of th Web3 provider.
+ * @property {string} walletAddress - The wallet address used to check the connection.
+ */
 interface CheckConnectionResult {
     isConnected: boolean;
     walletAddress: string;
 }
+/**
+ * Interface representing the parameters for {@link Checkout.sendTransaction}.
+ * @property {Web3Provider} provider - The provider to connect to the network.
+ * @property {Transaction} transaction - The transaction to send.
+ */
 interface SendTransactionParams {
     provider: Web3Provider;
     transaction: Transaction;
 }
+/**
+ * Interface representing the result of {@link Checkout.sendTransaction}.
+ * @property {TransactionResponse} transactionResponse - The response of the transaction.
+ */
 interface SendTransactionResult {
     transactionResponse: TransactionResponse;
 }
+/**
+ * Interface representing a blockchain transaction.
+ * @property {string} nonce - The transaction nonce.
+ * @property {string} gasPrice - The gas price of the transaction.
+ * @property {string} gas - The gas limit for the transaction.
+ * @property {string} to - The address of the recipient.
+ * @property {string} from - The address of the sender.
+ * @property {string} value - The value to transfer in wei.
+ * @property {string} data - The data to include in the transaction.
+ * @property {number} chainId - The ID of the chain the transaction is for.
+ */
 interface Transaction {
     nonce: string;
     gasPrice: string;
@@ -655,38 +783,150 @@ interface Transaction {
     data: string;
     chainId: number;
 }
-declare enum WalletFilterTypes {
-    ALL = "all",
-    DESKTOP = "desktop",
-    MOBILE = "mobile"
-}
+/**
+ * Interface representing a wallet filter to be used in {@link GetWalletAllowListParams}.
+ * @property {ConnectionProviders} connectionProvider - The connection provider to filter wallets by.
+ */
 interface WalletFilter {
     connectionProvider: ConnectionProviders;
 }
+/**
+ * Interface representing the parameters for {@link Checkout.getWalletAllowList}.
+ * @property {WalletFilterTypes} type - The type of wallets to filter by.
+ * @property {WalletFilter[]} [exclude] - An optional list of wallet filters to exclude from the allowed wallets list.
+ */
 interface GetWalletAllowListParams {
     type: WalletFilterTypes;
     exclude?: WalletFilter[];
 }
+/**
+ * Interface representing information about a wallet used in {@link GetWalletAllowListResult}.
+ * @property {ConnectionProviders} connectionProvider - The connection provider for the wallet.
+ * @property {string} name - The name of the wallet.
+ * @property {string} description - A description of the wallet.
+ * @property {string} icon - The URL/data:image of an icon for the wallet.
+ */
 interface WalletInfo {
     connectionProvider: ConnectionProviders;
     name: string;
     description: string;
     icon: string;
 }
+/**
+ * Interface representing the result of {@link Checkout.getWalletAllowList}.
+ * @property {WalletInfo[]} wallets - A list of {@link WalletInfo} objects representing the allowed wallets.
+ */
 interface GetWalletAllowListResult {
     wallets: WalletInfo[];
 }
+/**
+ * Enum representing the platform filters used in {@link GetWalletAllowListParams}.
+ */
+declare enum WalletFilterTypes {
+    ALL = "all",
+    DESKTOP = "desktop",
+    MOBILE = "mobile"
+}
+/**
+ * The different types of errors that can be returned by the checkout process.
+ */
+declare enum CheckoutErrorType {
+    PROVIDER_PREFERENCE_ERROR = "PROVIDER_PREFERENCE_ERROR",
+    CONNECT_PROVIDER_ERROR = "CONNECT_PROVIDER_ERROR",
+    GET_BALANCE_ERROR = "GET_BALANCE_ERROR",
+    GET_ERC20_BALANCE_ERROR = "GET_ERC20_BALANCE_ERROR",
+    GET_NETWORK_INFO_ERROR = "GET_NETWORK_INFO_ERROR",
+    METAMASK_PROVIDER_ERROR = "METAMASK_PROVIDER_ERROR",
+    CHAIN_NOT_SUPPORTED_ERROR = "CHAIN_NOT_SUPPORTED_ERROR",
+    PROVIDER_REQUEST_MISSING_ERROR = "PROVIDER_REQUEST_MISSING_ERROR",
+    PROVIDER_REQUEST_FAILED_ERROR = "PROVIDER_REQUEST_FAILED_ERROR",
+    USER_REJECTED_REQUEST_ERROR = "USER_REJECTED_REQUEST_ERROR",
+    TRANSACTION_ERROR = "TRANSACTION_ERROR"
+}
+/**
+ * The type signature for an error.
+ * Contains a type that corresponds to a {@link CheckoutErrorType}, an optional message string and optional data object.
+ */
+type ErrorType = {
+    type: CheckoutErrorType;
+    message?: string;
+    data?: {
+        [key: string]: string;
+    };
+};
 declare class Checkout {
+    /**
+     * Check if a wallet is connected to the current application without requesting permission from the wallet and hence triggering a connect popup.
+     * @param {CheckConnectionParams} params - The necessary data required to verify a wallet connection status.
+     * @returns Wallet connection status details.
+     * @throws {@link ErrorType}
+     */
     checkIsWalletConnected(params: CheckConnectionParams): Promise<CheckConnectionResult>;
+    /**
+     * Establish a connection with a wallet provider such as MetaMask and returns the provider object and the current network details.
+     * @param {ConnectParams} params - The necessary data required to establish a connection with a wallet provider.
+     * @returns Wallet provider and current network information.
+     * @throws {@link ErrorType}
+     */
     connect(params: ConnectParams): Promise<ConnectResult>;
+    /**
+     * Switch the currently connected wallet to a new network.
+     * @param {SwitchNetworkParams} params - The necessary data required to switch network.
+     * @returns The new network information.
+     * @throws {@link ErrorType}
+     */
     switchNetwork(params: SwitchNetworkParams): Promise<SwitchNetworkResult>;
+    /**
+     * Fetch the balance of the native token of the current connected network or, if a contract address is provided, it will return the balance of that ERC20 token. For example, if the wallet is connected to the Ethereum Mainnet then the function gets the wallet ETH L1 balance.
+     * @param {GetBalanceParams} params - The necessary data required to fetch the wallet balance.
+     * @returns Native token balance for the given wallet.
+     * @throws {@link ErrorType}
+     */
     getBalance(params: GetBalanceParams): Promise<GetBalanceResult>;
+    /**
+     * Fetch all available balances (ERC20 & Native) of the current connected network of the given wallet. It will loop through the list of allowed tokens and check for balance on each one.
+     * @param {GetAllBalancesParams} params - The necessary data required to fetch all the wallet balances.
+     * @returns List of tokens balance for the given wallet.
+     * @throws {@link ErrorType}
+     */
     getAllBalances(params: GetAllBalancesParams): Promise<GetAllBalancesResult>;
+    /**
+     * Fetch the list of available networks that a wallet can add or/and switch to.
+     * @param {GetNetworkAllowListParams} params - The necessary data required to fetch the list of available networks.
+     * @returns List of networks.
+     * @throws {@link ErrorType}
+     */
     getNetworkAllowList(params: GetNetworkAllowListParams): Promise<GetNetworkAllowListResult>;
+    /**
+     * Get the list of tokens which are allowed to be used with the product.
+     * @param {GetTokenAllowListParams} params - The necessary data required to fetch the list of allowed tokens.
+     * @returns List of allowed tokens.
+     * @throws {@link ErrorType}
+     */
     getTokenAllowList(params: GetTokenAllowListParams): Promise<GetTokenAllowListResult>;
-    getWalletsAllowList(params: GetWalletAllowListParams): Promise<GetWalletAllowListResult>;
+    /**
+     * Fetch the list of wallets which are available to connect with.
+     * @param {GetWalletAllowListParams} params - The necessary data required to fetch the list of allowed wallets.
+     * @returns List of allowed wallets.
+     * @throws {@link ErrorType}
+     */
+    getWalletAllowList(params: GetWalletAllowListParams): Promise<GetWalletAllowListResult>;
+    /**
+     * Send a generic transaction to the provider.
+     * @param {SendTransactionParams} params - The necessary data required to send a transaction.
+     * @returns Transaction response.
+     * @throws {@link ErrorType}
+     * @remarks
+     * Further documenation can be found at [MetaMask | Sending Transactions](https://docs.metamask.io/guide/sending-transactions.html).
+     */
     sendTransaction(params: SendTransactionParams): Promise<SendTransactionResult>;
+    /**
+     * Get network information about the currently selected network.
+     * @param {GetNetworkParams} params - The necessary data required to get the current network information.
+     * @returns Network details.
+     * @throws {@link ErrorType}
+     */
     getNetworkInfo(params: GetNetworkParams): Promise<NetworkInfo>;
 }
 
-export { ChainId, CheckConnectionParams, CheckConnectionResult, Checkout, ConnectParams, ConnectResult, ConnectionProviders, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, NetworkFilter, NetworkFilterTypes, NetworkInfo, SendTransactionParams, SendTransactionResult, SwitchNetworkParams, SwitchNetworkResult, TokenFilter, TokenFilterTypes, TokenInfo, WalletFilter, WalletFilterTypes, WalletInfo };
+export { ChainId, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutErrorType, ConnectParams, ConnectResult, ConnectionProviders, ErrorType, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, NetworkFilter, NetworkFilterTypes, NetworkInfo, SendTransactionParams, SendTransactionResult, SwitchNetworkParams, SwitchNetworkResult, TokenFilter, TokenFilterTypes, TokenInfo, Transaction, WalletFilter, WalletFilterTypes, WalletInfo };