@imtbl/sdk 0.2.3-alpha.1 → 0.3.0-alpha.1

package/dist/index.d.ts

@@ -2100,7 +2100,7 @@ declare abstract class ForkEvent extends Description {
 }
 declare type EventType = string | Array<string | Array<string>> | EventFilter | ForkEvent;
 declare type Listener = (...args: Array<any>) => void;
-declare abstract class Provider implements OnceBlockable {
+declare abstract class Provider$1 implements OnceBlockable {
     abstract getNetwork(): Promise<Network>;
     abstract getBlockNumber(): Promise<number>;
     abstract getGasPrice(): Promise<BigNumber>;
@@ -2119,19 +2119,19 @@ declare abstract class Provider implements OnceBlockable {
     abstract getLogs(filter: Filter): Promise<Array<Log>>;
     abstract resolveName(name: string | Promise<string>): Promise<null | string>;
     abstract lookupAddress(address: string | Promise<string>): Promise<null | string>;
-    abstract on(eventName: EventType, listener: Listener): Provider;
-    abstract once(eventName: EventType, listener: Listener): Provider;
+    abstract on(eventName: EventType, listener: Listener): Provider$1;
+    abstract once(eventName: EventType, listener: Listener): Provider$1;
     abstract emit(eventName: EventType, ...args: Array<any>): boolean;
     abstract listenerCount(eventName?: EventType): number;
     abstract listeners(eventName?: EventType): Array<Listener>;
-    abstract off(eventName: EventType, listener?: Listener): Provider;
-    abstract removeAllListeners(eventName?: EventType): Provider;
-    addListener(eventName: EventType, listener: Listener): Provider;
-    removeListener(eventName: EventType, listener: Listener): Provider;
+    abstract off(eventName: EventType, listener?: Listener): Provider$1;
+    abstract removeAllListeners(eventName?: EventType): Provider$1;
+    addListener(eventName: EventType, listener: Listener): Provider$1;
+    removeListener(eventName: EventType, listener: Listener): Provider$1;
     abstract waitForTransaction(transactionHash: string, confirmations?: number, timeout?: number): Promise<TransactionReceipt>;
     readonly _isProvider: boolean;
     constructor();
-    static isProvider(value: any): value is Provider;
+    static isProvider(value: any): value is Provider$1;
 }
 
 interface TypedDataDomain {
@@ -2149,11 +2149,11 @@ interface TypedDataSigner {
     _signTypedData(domain: TypedDataDomain, types: Record<string, Array<TypedDataField>>, value: Record<string, any>): Promise<string>;
 }
 declare abstract class Signer {
-    readonly provider?: Provider;
+    readonly provider?: Provider$1;
     abstract getAddress(): Promise<string>;
     abstract signMessage(message: Bytes | string): Promise<string>;
     abstract signTransaction(transaction: Deferrable<TransactionRequest>): Promise<string>;
-    abstract connect(provider: Provider): Signer;
+    abstract connect(provider: Provider$1): Signer;
     readonly _isSigner: boolean;
     constructor();
     getBalance(blockTag?: BlockTag): Promise<BigNumber>;
@@ -2305,7 +2305,7 @@ declare class Resolver implements EnsResolver {
     getContentHash(): Promise<string>;
     getText(key: string): Promise<string>;
 }
-declare class BaseProvider extends Provider implements EnsProvider {
+declare class BaseProvider extends Provider$1 implements EnsProvider {
     _networkPromise: Promise<Network>;
     _network: Network;
     _events: Array<Event$1>;
@@ -2411,7 +2411,7 @@ declare class JsonRpcSigner extends Signer implements TypedDataSigner {
     _index: number;
     _address: string;
     constructor(constructorGuard: any, provider: JsonRpcProvider, addressOrIndex?: string | number);
-    connect(provider: Provider): JsonRpcSigner;
+    connect(provider: Provider$1): JsonRpcSigner;
     connectUnchecked(): JsonRpcSigner;
     getAddress(): Promise<string>;
     sendUncheckedTransaction(transaction: Deferrable<TransactionRequest>): Promise<string>;
@@ -12743,6 +12743,7 @@ declare enum Networks {
 interface OidcConfiguration {
     clientId: string;
     logoutRedirectUri: string;
+    logoutMode?: 'redirect' | 'silent';
     redirectUri: string;
     scope?: string;
     audience?: string;
@@ -12755,6 +12756,12 @@ interface PassportOverrides {
     passportDomain: string;
     imxPublicApiDomain: string;
     immutableXClient: ImmutableXClient;
+    zkEvmRpcUrl: string;
+    zkEvmChainId: string;
+    relayerUrl: string;
+    indexerMrBasePath: string;
+    orderBookMrBasePath: string;
+    passportMrBasePath: string;
 }
 interface PassportModuleConfiguration extends ModuleConfiguration<PassportOverrides>, OidcConfiguration {
 }
@@ -12772,6 +12779,44 @@ type DeviceTokenResponse = {
     expires_in: number;
 };
 
+declare enum RpcErrorCode {
+    RPC_SERVER_ERROR = -32000,
+    INVALID_REQUEST = -32600,
+    METHOD_NOT_FOUND = -32601,
+    INVALID_PARAMS = -32602,
+    INTERNAL_ERROR = -32603,
+    UNAUTHORIZED = -32604,
+    PARSE_ERROR = -32700
+}
+declare class JsonRpcError extends Error {
+    readonly message: string;
+    readonly code: RpcErrorCode;
+    constructor(code: RpcErrorCode, message: string);
+}
+
+interface RequestArguments {
+    method: string;
+    params?: Array<any>;
+}
+type JsonRpcRequestPayload = RequestArguments & {
+    jsonrpc?: string;
+    id?: string | number;
+};
+interface JsonRpcRequestCallback {
+    (err: JsonRpcError | null, result?: JsonRpcResponsePayload | (JsonRpcResponsePayload | null)[] | null): void;
+}
+interface JsonRpcResponsePayload {
+    result?: Array<any> | null;
+    error?: JsonRpcError | null;
+    jsonrpc?: string;
+    id?: string | number;
+}
+type Provider = {
+    request: (request: RequestArguments) => Promise<any>;
+    sendAsync: (request: JsonRpcRequestPayload | JsonRpcRequestPayload[], callback: JsonRpcRequestCallback) => void;
+    send: (request: string | JsonRpcRequestPayload | JsonRpcRequestPayload[], callbackOrParams?: JsonRpcRequestCallback | Array<any>, callback?: JsonRpcRequestCallback) => void;
+};
+
 declare class Passport {
     private readonly authManager;
     private readonly config;
@@ -12779,6 +12824,7 @@ declare class Passport {
     private readonly immutableXClient;
     private readonly magicAdapter;
     private readonly passportImxProviderFactory;
+    private readonly multiRollupApiClients;
     constructor(passportModuleConfiguration: PassportModuleConfiguration);
     connectImxSilent(): Promise<IMXProvider | null>;
     connectImx(): Promise<IMXProvider>;
@@ -12789,8 +12835,14 @@ declare class Passport {
      */
     checkStoredDeviceFlowCredentials(): DeviceTokenResponse | null;
     connectImxWithCredentials(tokenResponse: DeviceTokenResponse): Promise<IMXProvider | null>;
+    protected connectEvm(): Provider;
     loginCallback(): Promise<void>;
     logout(): Promise<void>;
+    /**
+     * This method should only be called from the logout redirect uri
+     * when logout mode is 'silent'.
+     */
+    logoutSilentCallback(url: string): Promise<void>;
     logoutDeviceFlow(): Promise<void>;
     getUserInfo(): Promise<UserProfile | undefined>;
     getUserInfoDeviceFlow(): Promise<UserProfile | undefined>;
@@ -27939,7 +27991,6 @@ type SemanticVersion = {
  * @property {WidgetTheme | undefined} theme - The theme of the Checkout Widget (default: "DARK")
  * @property {Environment | undefined} environment - The environment configuration (default: "SANDBOX")
  * @property {SemanticVersion | undefined} version - The version of the checkout widgets js file to use (default: "0.1.0")
- * @property {boolean | undefined} isOnRampEnabled - Enable on-ramp top-up method (default: "true")
  * @property {boolean | undefined} isSwapEnabled - Enable swap top-up method (default: "true")
  * @property {boolean | undefined} isBridgeEnabled - Enable bridge top-up method (default: "true")
  */
@@ -27947,7 +27998,6 @@ type CheckoutWidgetsConfig = {
     theme?: WidgetTheme;
     environment?: Environment;
     version?: SemanticVersion;
-    isOnRampEnabled?: boolean;
     isSwapEnabled?: boolean;
     isBridgeEnabled?: boolean;
 };
@@ -28306,15 +28356,15 @@ declare class ERC20 {
     /**
      * @returns a promise that resolves with a BigNumber that represents the amount of tokens in existence
      */
-    totalSupply(provider: Provider, overrides?: CallOverrides): Promise<BigNumber>;
+    totalSupply(provider: Provider$1, overrides?: CallOverrides): Promise<BigNumber>;
     /**
      * @returns a promise that resolves with a BigNumber that represents the amount of tokens owned by account
      */
-    balanceOf(provider: Provider, account: PromiseOrValue$1<string>, overrides?: CallOverrides): Promise<BigNumber>;
+    balanceOf(provider: Provider$1, account: PromiseOrValue$1<string>, overrides?: CallOverrides): Promise<BigNumber>;
     /**
      * @returns a promise that resolves with a BigNumber that represents the remaining number of tokens that spender will be allowed to spend on behalf of owner through transferFrom
      */
-    allowance(provider: Provider, owner: PromiseOrValue$1<string>, spender: PromiseOrValue$1<string>, overrides?: CallOverrides): Promise<BigNumber>;
+    allowance(provider: Provider$1, owner: PromiseOrValue$1<string>, spender: PromiseOrValue$1<string>, overrides?: CallOverrides): Promise<BigNumber>;
     /**
      * @returns a promise that resolves with a populated transaction
      */
@@ -28346,87 +28396,87 @@ declare class ERC721PermissionedMintable {
     /**
      * @returns the DEFAULT_ADMIN_ROLE as a string.
      */
-    DEFAULT_ADMIN_ROLE(provider: Provider, overrides?: CallOverrides): Promise<string>;
+    DEFAULT_ADMIN_ROLE(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
     /**
      * @returns the MINTER_ROLE as a string.
      */
-    MINTER_ROLE(provider: Provider, overrides?: CallOverrides): Promise<string>;
+    MINTER_ROLE(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
     /**
      * @returns the balance of an address as a BigNumber.
      */
-    balanceOf(provider: Provider, owner: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
+    balanceOf(provider: Provider$1, owner: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
     /**
      * @returns the baseURI as a string.
      */
-    baseURI(provider: Provider, overrides?: CallOverrides): Promise<string>;
+    baseURI(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
     /**
      * @returns the contractURI as a string.
      */
-    contractURI(provider: Provider, overrides?: CallOverrides): Promise<string>;
+    contractURI(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
     /**
      * @returns admin addresses as an array of strings.
      */
-    getAdmins(provider: Provider, overrides?: CallOverrides): Promise<string[]>;
+    getAdmins(provider: Provider$1, overrides?: CallOverrides): Promise<string[]>;
     /**
      * @returns the approved address for a token ID, or zero if no address set.
      */
-    getApproved(provider: Provider, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
+    getApproved(provider: Provider$1, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
     /**
      * @returns the role admin address.
      */
-    getRoleAdmin(provider: Provider, role: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<string>;
+    getRoleAdmin(provider: Provider$1, role: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<string>;
     /**
      * @returns the role member address at a particular index.
      */
-    getRoleMember(provider: Provider, role: PromiseOrValue<BytesLike>, index: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
+    getRoleMember(provider: Provider$1, role: PromiseOrValue<BytesLike>, index: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
     /**
      * @returns the role member count as a BigNumber.
      */
-    getRoleMemberCount(provider: Provider, role: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<BigNumber>;
+    getRoleMemberCount(provider: Provider$1, role: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<BigNumber>;
     /**
      * @returns a boolean for whether an account has a particular role.
      */
-    hasRole(provider: Provider, role: PromiseOrValue<BytesLike>, account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>;
+    hasRole(provider: Provider$1, role: PromiseOrValue<BytesLike>, account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>;
     /**
      * @returns a booolean that tells whether an operator is approved by a given owner.
      */
-    isApprovedForAll(provider: Provider, owner: PromiseOrValue<string>, operator: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>;
+    isApprovedForAll(provider: Provider$1, owner: PromiseOrValue<string>, operator: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>;
     /**
      * @returns the name of the contract as a string.
      */
-    name(provider: Provider, overrides?: CallOverrides): Promise<string>;
+    name(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
     /**
      * @returns the owner address of a particular tokenId.
      */
-    ownerOf(provider: Provider, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
+    ownerOf(provider: Provider$1, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
     /**
      * @returns the royalty allowlist as a string.
      */
-    royaltyAllowlist(provider: Provider, overrides?: CallOverrides): Promise<string>;
+    royaltyAllowlist(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
     /**
      * @returns the royalty information for a particular tokenId.
      */
-    royaltyInfo(provider: Provider, _tokenId: PromiseOrValue<BigNumberish>, _salePrice: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[string, BigNumber]>;
+    royaltyInfo(provider: Provider$1, _tokenId: PromiseOrValue<BigNumberish>, _salePrice: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[string, BigNumber]>;
     /**
      * @returns the symbol of the contract as a string.
      */
-    symbol(provider: Provider, overrides?: CallOverrides): Promise<string>;
+    symbol(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
     /**
      * @returns a token ID at a given index of all the tokens stored by the contract.
      */
-    tokenByIndex(provider: Provider, index: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
+    tokenByIndex(provider: Provider$1, index: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
     /**
      * @returns a token ID owned by owner at a given index of its token list.
      */
-    tokenOfOwnerByIndex(provider: Provider, owner: PromiseOrValue<string>, index: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
+    tokenOfOwnerByIndex(provider: Provider$1, owner: PromiseOrValue<string>, index: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
     /**
      * @returns the Uniform Resource Identifier (URI) for tokenId token.
      */
-    tokenURI(provider: Provider, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
+    tokenURI(provider: Provider$1, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
     /**
      * @returns returns the total amount of tokens stored by the contract.
      */
-    totalSupply(provider: Provider, overrides?: CallOverrides): Promise<BigNumber>;
+    totalSupply(provider: Provider$1, overrides?: CallOverrides): Promise<BigNumber>;
     /**
      * Write functions
      */
@@ -28516,4 +28566,4 @@ declare class ERC721PermissionedMintable {
     }): Promise<PopulatedTransaction>;
 }
 
-export { APIError, ActivityType, AllowedNetworkConfig, BlockchainData, BlockchainDataModuleConfiguration, BridgeEventType, BridgeFailed, BridgeReact, BridgeReactProps, BridgeSuccess, CHECKOUT_API_BASE_URL, ChainId, ChainName, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutErrorType, CheckoutModuleConfiguration, CheckoutWidgetTagNames, CheckoutWidgets, CheckoutWidgetsConfig, ConnectEventType, ConnectParams, ConnectReact, ConnectResult, ConnectionFailed, ConnectionSuccess, DeviceConnectResponse, DeviceTokenResponse, DexConfig, ERC20, ERC721PermissionedMintable, Environment, ErrorType, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateTokenConfig, GasEstimateType, GenericIMXProvider, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, IMTBLWidgetEvents, IMXProvider, ImmutableConfiguration, ImmutableXClient, ImtblBridgeProps, ImtblConnectProps, ImtblSwapProps, ImtblWalletProps, ImxModuleConfiguration as ImxClientModuleConfiguration, WalletConnection as ImxClientWalletConnection, MetaMaskIMXProvider, ModuleConfiguration, NetworkFilter, NetworkFilterTypes, NetworkInfo, Networks, OrchestrationEventType, Orderbook, Passport, PassportError, PassportModuleConfiguration, PassportOverrides, ProviderConfiguration, RemoteConfiguration, RequestBridgeEvent, RequestConnectEvent, RequestOnrampEvent, RequestSwapEvent, RequestWalletEvent, SemanticVersion, SendTransactionParams, SendTransactionResult, SwapEventType, SwapFailed, SwapReact, SwapReactProps, SwapRejected, SwapSuccess, SwitchNetworkParams, SwitchNetworkResult, TokenFilter, TokenFilterTypes, TokenInfo, UpdateConfig, UserProfile, WalletDisconnectWalletEvent, WalletEventType, WalletFilter, WalletFilterTypes, WalletInfo, WalletNetworkSwitchEvent, WalletProviderName, WalletReact, WalletReactProps, WidgetEvent, WidgetTheme, createStarkSigner as imxClientCreateStarkSigner, generateLegacyStarkPrivateKey as imxClientGenerateLegacyStarkPrivateKey, module };
+export { APIError, ActivityType, AllowedNetworkConfig, BlockchainData, BlockchainDataModuleConfiguration, BridgeEventType, BridgeFailed, BridgeReact, BridgeReactProps, BridgeSuccess, CHECKOUT_API_BASE_URL, ChainId, ChainName, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutErrorType, CheckoutModuleConfiguration, CheckoutWidgetTagNames, CheckoutWidgets, CheckoutWidgetsConfig, ConnectEventType, ConnectParams, ConnectReact, ConnectResult, ConnectionFailed, ConnectionSuccess, DeviceConnectResponse, DeviceTokenResponse, DexConfig, ERC20, ERC721PermissionedMintable, Environment, ErrorType, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateTokenConfig, GasEstimateType, GenericIMXProvider, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, IMTBLWidgetEvents, IMXProvider, ImmutableConfiguration, ImmutableXClient, ImtblBridgeProps, ImtblConnectProps, ImtblSwapProps, ImtblWalletProps, ImxModuleConfiguration as ImxClientModuleConfiguration, WalletConnection as ImxClientWalletConnection, JsonRpcRequestCallback, JsonRpcRequestPayload, JsonRpcResponsePayload, MetaMaskIMXProvider, ModuleConfiguration, NetworkFilter, NetworkFilterTypes, NetworkInfo, Networks, OrchestrationEventType, Orderbook, Passport, PassportError, PassportModuleConfiguration, PassportOverrides, Provider, ProviderConfiguration, RemoteConfiguration, RequestArguments, RequestBridgeEvent, RequestConnectEvent, RequestOnrampEvent, RequestSwapEvent, RequestWalletEvent, SemanticVersion, SendTransactionParams, SendTransactionResult, SwapEventType, SwapFailed, SwapReact, SwapReactProps, SwapRejected, SwapSuccess, SwitchNetworkParams, SwitchNetworkResult, TokenFilter, TokenFilterTypes, TokenInfo, UpdateConfig, UserProfile, WalletDisconnectWalletEvent, WalletEventType, WalletFilter, WalletFilterTypes, WalletInfo, WalletNetworkSwitchEvent, WalletProviderName, WalletReact, WalletReactProps, WidgetEvent, WidgetTheme, createStarkSigner as imxClientCreateStarkSigner, generateLegacyStarkPrivateKey as imxClientGenerateLegacyStarkPrivateKey, module };