@imtbl/sdk 0.1.8-alpha.2 → 0.1.9-alpha

package/dist/checkout_sdk.d.ts

@@ -41,14 +41,6 @@ declare class BigNumber implements Hexable {
     static isBigNumber(value: any): value is BigNumber;
 }
 
-declare type Network = {
-    name: string;
-    chainId: number;
-    ensAddress?: string;
-    _defaultProvider?: (providers: any, options?: any) => any;
-};
-declare type Networkish = Network | string | number;
-
 declare type Deferrable<T> = {
     [K in keyof T]: T[K] | Promise<T[K]>;
 };
@@ -58,6 +50,14 @@ declare class Description<T = any> {
     });
 }
 
+declare type Network = {
+    name: string;
+    chainId: number;
+    ensAddress?: string;
+    _defaultProvider?: (providers: any, options?: any) => any;
+};
+declare type Networkish = Network | string | number;
+
 declare type AccessList = Array<{
     address: string;
     storageKeys: Array<string>;
@@ -238,6 +238,43 @@ declare abstract class Provider implements OnceBlockable {
     static isProvider(value: any): value is Provider;
 }
 
+interface TypedDataDomain {
+    name?: string;
+    version?: string;
+    chainId?: BigNumberish;
+    verifyingContract?: string;
+    salt?: BytesLike;
+}
+interface TypedDataField {
+    name: string;
+    type: string;
+}
+interface TypedDataSigner {
+    _signTypedData(domain: TypedDataDomain, types: Record<string, Array<TypedDataField>>, value: Record<string, any>): Promise<string>;
+}
+declare abstract class Signer {
+    readonly provider?: Provider;
+    abstract getAddress(): Promise<string>;
+    abstract signMessage(message: Bytes | string): Promise<string>;
+    abstract signTransaction(transaction: Deferrable<TransactionRequest>): Promise<string>;
+    abstract connect(provider: Provider): Signer;
+    readonly _isSigner: boolean;
+    constructor();
+    getBalance(blockTag?: BlockTag): Promise<BigNumber>;
+    getTransactionCount(blockTag?: BlockTag): Promise<number>;
+    estimateGas(transaction: Deferrable<TransactionRequest>): Promise<BigNumber>;
+    call(transaction: Deferrable<TransactionRequest>, blockTag?: BlockTag): Promise<string>;
+    sendTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionResponse>;
+    getChainId(): Promise<number>;
+    getGasPrice(): Promise<BigNumber>;
+    getFeeData(): Promise<FeeData>;
+    resolveName(name: string): Promise<string>;
+    checkTransaction(transaction: Deferrable<TransactionRequest>): Deferrable<TransactionRequest>;
+    populateTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionRequest>;
+    _checkProvider(operation?: string): void;
+    static isSigner(value: any): value is Signer;
+}
+
 declare type FormatFunc = (value: any) => any;
 declare type FormatFuncs = {
     [key: string]: FormatFunc;
@@ -438,43 +475,6 @@ declare class BaseProvider extends Provider implements EnsProvider {
     removeAllListeners(eventName?: EventType): this;
 }
 
-interface TypedDataDomain {
-    name?: string;
-    version?: string;
-    chainId?: BigNumberish;
-    verifyingContract?: string;
-    salt?: BytesLike;
-}
-interface TypedDataField {
-    name: string;
-    type: string;
-}
-interface TypedDataSigner {
-    _signTypedData(domain: TypedDataDomain, types: Record<string, Array<TypedDataField>>, value: Record<string, any>): Promise<string>;
-}
-declare abstract class Signer {
-    readonly provider?: Provider;
-    abstract getAddress(): Promise<string>;
-    abstract signMessage(message: Bytes | string): Promise<string>;
-    abstract signTransaction(transaction: Deferrable<TransactionRequest>): Promise<string>;
-    abstract connect(provider: Provider): Signer;
-    readonly _isSigner: boolean;
-    constructor();
-    getBalance(blockTag?: BlockTag): Promise<BigNumber>;
-    getTransactionCount(blockTag?: BlockTag): Promise<number>;
-    estimateGas(transaction: Deferrable<TransactionRequest>): Promise<BigNumber>;
-    call(transaction: Deferrable<TransactionRequest>, blockTag?: BlockTag): Promise<string>;
-    sendTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionResponse>;
-    getChainId(): Promise<number>;
-    getGasPrice(): Promise<BigNumber>;
-    getFeeData(): Promise<FeeData>;
-    resolveName(name: string): Promise<string>;
-    checkTransaction(transaction: Deferrable<TransactionRequest>): Deferrable<TransactionRequest>;
-    populateTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionRequest>;
-    _checkProvider(operation?: string): void;
-    static isSigner(value: any): value is Signer;
-}
-
 declare class JsonRpcSigner extends Signer implements TypedDataSigner {
     readonly provider: JsonRpcProvider;
     _index: number;
@@ -563,16 +563,23 @@ interface ModuleConfiguration<T> {
     overrides?: T;
 }
 
+/**
+ * @typedef {string} Address - Represents an Ethereum address.
+ */
+type Address = string;
+/**
+ * @typedef {Address | 'NATIVE'} FungibleToken - Represents a fungible token, either an ERC20 token address or the native token.
+ */
+type FungibleToken = Address | 'NATIVE';
+
 /**
  * Enum representing the supported chains with their corresponding IDs.
  */
 declare enum ChainId {
     ETHEREUM = 1,
-    SEPOLIA = 11155111,
-    IMTBL_ZKEVM_DEVNET = 13373,
     IMTBL_ZKEVM_TESTNET = 13372,
-    POLYGON_ZKEVM_TESTNET = 1442,
-    POLYGON_ZKEVM = 137
+    SEPOLIA = 11155111,
+    IMTBL_ZKEVM_DEVNET = 13383
 }
 /**
  * Interface representing token information.
@@ -591,7 +598,6 @@ interface TokenInfo {
 }
 /**
  * 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.
  */
@@ -613,7 +619,6 @@ interface GetBalanceResult {
 }
 /**
  * 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.
  */
@@ -652,13 +657,9 @@ interface NetworkInfo {
 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 ConnectParams {
+    provider: Web3Provider;
+}
 /**
  * Interface representing the result of {@link Checkout.connect}.
  * @property {Web3Provider} provider - The provider used to connect to the network.
@@ -668,12 +669,8 @@ 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;
+    provider: Web3Provider;
 }
 /**
  * Interface representing the result of {@link Checkout.checkIsWalletConnected}.
@@ -684,6 +681,71 @@ interface CheckConnectionResult {
     isConnected: boolean;
     walletAddress: string;
 }
+/**
+ * * Enum representing the actions that gas can be estimated for when calling {@link Checkout.gasEstimate}.
+ * */
+declare enum GasEstimateType {
+    BRIDGE_TO_L2 = "BRIDGE_TO_L2",
+    SWAP = "SWAP"
+}
+/**
+ * * Type representing the params that can be used with {@link Checkout.gasEstimate}.
+ * */
+type GasEstimateParams = GasEstimateBridgeToL2Params | GasEstimateSwapParams;
+/**
+ * * Interface representing the parameters to estimate gas for a bridge to L2 for {@link Checkout.gasEstimate}.
+ @property {gasEstimateType} - The type of action to estimate gas for.
+ @property {boolean} isSpendingCapApprovalRequired - Is spending cap approval required.
+ @property {tokenAddress} - The address of the token to bridge.
+ * */
+interface GasEstimateBridgeToL2Params {
+    gasEstimateType: GasEstimateType.BRIDGE_TO_L2;
+    isSpendingCapApprovalRequired: boolean;
+    tokenAddress?: FungibleToken;
+}
+/**
+ * * Interface representing the parameters to estimate gas for a swap for {@link Checkout.gasEstimate}.
+ @property {gasEstimateType} - The type of action to estimate gas for.
+ * */
+interface GasEstimateSwapParams {
+    gasEstimateType: GasEstimateType.SWAP;
+}
+/**
+ * * Interface representing the result for {@link Checkout.gasEstimate}.
+ @property {gasEstimateType} - The type of action this gas estimate is for.
+ @property {gasFee} - The gas fee estimate.
+ * */
+interface GasEstimateSwapResult {
+    gasEstimateType: GasEstimateType.SWAP;
+    gasFee: TokenAmountEstimate;
+}
+/**
+ * * Interface representing the result for {@link Checkout.gasEstimate}.
+ @property {gasEstimateType} - The type of action this gas estimate is for.
+ @property {gasFee} - The gas fee estimate.
+ @property {bridgeFee} - The bridge fee estimate.
+  @property {bridgeable} - Indicates whether the token can be bridged or not.
+ * */
+interface GasEstimateBridgeToL2Result {
+    gasEstimateType: GasEstimateType.BRIDGE_TO_L2;
+    gasFee: TokenAmountEstimate;
+    bridgeFee: TokenAmountEstimate;
+    bridgeable: boolean;
+}
+/**
+ * * Interface representing the type used in the result for {@link Checkout.gasEstimate}.
+ @property {BigNumber} estimatedAmount - estimated amount.
+ @property {TokenInfo} token - token for the estimate.
+ * */
+interface TokenAmountEstimate {
+    estimatedAmount?: BigNumber;
+    token?: TokenInfo;
+}
+/**
+ * Object mapping the list of supported networks with the corresponding RPC urls.
+ */
+type RpcUrlMap = Map<ChainId, string>;
+declare const RPC_URL_MAP: RpcUrlMap;
 /**
  * Type representing the details of a network.
  * @property {string} chainIdHex - The hexadecimal ID of the network.
@@ -805,12 +867,28 @@ interface SendTransactionParams {
 interface SendTransactionResult {
     transactionResponse: TransactionResponse;
 }
+/**
+ * Enum representing the avaiable wallet providers to use when creating a provider
+ */
+declare enum WalletProviderName {
+    METAMASK = "metamask"
+}
+interface CreateProviderParams {
+    walletProvider: WalletProviderName;
+}
+/**
+ * Interface representing the result of {@link Checkout.createProvider}.
+ * @property {Web3Provider} provider - The provider used to connect to the network.
+ */
+type CreateProviderResult = {
+    provider: Web3Provider;
+};
 /**
  * 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;
+    providerName: WalletProviderName;
 }
 /**
  * Interface representing the parameters for {@link Checkout.getWalletAllowList}.
@@ -829,7 +907,7 @@ interface GetWalletAllowListParams {
  * @property {string} icon - The URL/data:image of an icon for the wallet.
  */
 interface WalletInfo {
-    connectionProvider: ConnectionProviders;
+    providerName: WalletProviderName;
     name: string;
     description: string;
     icon: string;
@@ -853,7 +931,9 @@ declare enum WalletFilterTypes {
  * The different types of errors that can be returned by the checkout process.
  */
 declare enum CheckoutErrorType {
-    PROVIDER_PREFERENCE_ERROR = "PROVIDER_PREFERENCE_ERROR",
+    WEB3_PROVIDER_ERROR = "WEB3_PROVIDER_ERROR",
+    PROVIDER_ERROR = "PROVIDER_ERROR",
+    DEFAULT_PROVIDER_ERROR = "DEFAULT_PROVIDER_ERROR",
     CONNECT_PROVIDER_ERROR = "CONNECT_PROVIDER_ERROR",
     GET_BALANCE_ERROR = "GET_BALANCE_ERROR",
     GET_ERC20_BALANCE_ERROR = "GET_ERC20_BALANCE_ERROR",
@@ -865,7 +945,8 @@ declare enum CheckoutErrorType {
     USER_REJECTED_REQUEST_ERROR = "USER_REJECTED_REQUEST_ERROR",
     TRANSACTION_FAILED = "TRANSACTION_FAILED",
     INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
-    UNPREDICTABLE_GAS_LIMIT = "UNPREDICTABLE_GAS_LIMIT"
+    UNPREDICTABLE_GAS_LIMIT = "UNPREDICTABLE_GAS_LIMIT",
+    INVALID_GAS_ESTIMATE_TYPE = "INVALID_GAS_ESTIMATE_TYPE"
 }
 /**
  * The type signature for an error.
@@ -886,6 +967,13 @@ declare class CheckoutConfiguration {
 declare class Checkout {
     readonly config: CheckoutConfiguration;
     constructor(config?: CheckoutModuleConfiguration);
+    /**
+     * Create a provider object which can be used within the Checkout class methods.
+     * @param {CreateProviderParams} params The data required to create a provider
+     * @returns A new provider object
+     * @throws {@link ErrorType}
+     */
+    createProvider(params: CreateProviderParams): Promise<CreateProviderResult>;
     /**
      * Check if a wallet is connected to the current application
      * without requesting permission from the wallet and hence triggering a connect popup.
@@ -962,6 +1050,13 @@ declare class Checkout {
      * @throws {@link ErrorType}
      */
     getNetworkInfo(params: GetNetworkParams): Promise<NetworkInfo>;
+    static isWeb3Provider(web3Provider: Web3Provider): boolean;
+    /**
+     * Estimates the gas to perform an action.
+     * @param {GasEstimateParams} params - The params required to calculate a gas estimate
+     * @returns The gas estimate for the given action.
+     */
+    gasEstimate(params: GasEstimateParams): Promise<GasEstimateSwapResult | GasEstimateBridgeToL2Result>;
 }
 
-export { ChainId, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutErrorType, CheckoutModuleConfiguration, 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, WalletFilter, WalletFilterTypes, WalletInfo };
+export { ChainId, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutErrorType, CheckoutModuleConfiguration, ConnectParams, ConnectResult, ConnectionProviders, ErrorType, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateType, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, NetworkFilter, NetworkFilterTypes, NetworkInfo, RPC_URL_MAP, SendTransactionParams, SendTransactionResult, SwitchNetworkParams, SwitchNetworkResult, TokenFilter, TokenFilterTypes, TokenInfo, WalletFilter, WalletFilterTypes, WalletInfo, WalletProviderName };