@imtbl/sdk 0.4.0-alpha.2 → 0.4.1-alpha

package/dist/passport.d.ts

@@ -203,7 +203,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>;
@@ -222,27 +222,27 @@ 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;
 }
 
 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>;
@@ -856,7 +856,7 @@ interface TokenData {
      */
     'quantity': string;
     /**
-     * Quantity of this asset with the sum of all fees applied to the asset
+     * [DEPRECATED for v3 endpoints] Quantity of this asset with the sum of all fees applied to the asset. Replaced by quantity_with_fees in maker_fees / taker_fees depending on the type of order. Refer https://docs.x.immutable.com/docs/maker-taker-fees/#new-maker-taker-fields-and-the-deprecation-of-quantity_with_fees-in-buy-and-sell.
      * @type {string}
      * @memberof TokenData
      */
@@ -3719,7 +3719,7 @@ interface GetSignableOrderRequestV3 {
      */
     'amount_sell': string;
     /**
-     * ExpirationTimestamp in Unix time. Note: will be rounded down to the nearest hour
+     * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
      * @type {number}
      * @memberof GetSignableOrderRequestV3
      */
@@ -3818,7 +3818,7 @@ interface GetSignableOrderResponse {
      */
     'asset_id_sell': string;
     /**
-     * Expiration timestamp for this order
+     * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
      * @type {number}
      * @memberof GetSignableOrderResponse
      */
@@ -3979,7 +3979,7 @@ interface GetSignableRegistrationResponse {
  */
 interface GetSignableTradeRequest {
     /**
-     * ExpirationTimestamp in Unix time. Note: will be rounded down to the nearest hour
+     * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
      * @type {number}
      * @memberof GetSignableTradeRequest
      */
@@ -4066,7 +4066,7 @@ interface GetSignableTradeResponse {
      */
     'asset_id_sell': string;
     /**
-     * Expiration timestamp for this order
+     * ExpirationTimestamp in Unix time in hours. Note: will be rounded down to the nearest hour
      * @type {number}
      * @memberof GetSignableTradeResponse
      */
@@ -5153,7 +5153,7 @@ interface OrderV3 {
      */
     'expiration_timestamp': string | null;
     /**
-     * Fee information for the order
+     * [DEPRECATED] Fee information for the order. Replaced by maker_fees / taker_fees depending on the type of order. Refer https://docs.x.immutable.com/docs/maker-taker-fees/#new-maker-taker-fields-and-the-deprecation-of-quantity_with_fees-in-buy-and-sell.
      * @type {Array<OrderFeeInfo>}
      * @memberof OrderV3
      */
@@ -8707,10 +8707,11 @@ interface OrdersApiListOrdersV3Request {
  */
 declare class OrdersApi extends BaseAPI {
     /**
-     * Cancel an order. Use https://docs.x.immutable.com/reference#/operations/getSignableCancelOrder to get request body params.
+     * Cancel an order. Use https://docs.x.immutable.com/reference#/operations/getSignableCancelOrder to get request body params.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/cancelOrderV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
      * @summary Cancel an order
      * @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof OrdersApi
      */
@@ -8725,10 +8726,11 @@ declare class OrdersApi extends BaseAPI {
      */
     cancelOrderV3(requestParameters: OrdersApiCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CancelOrderResponse, any>>;
     /**
-     * Create an order. Use https://docs.x.immutable.com/reference#/operations/getSignableOrder to get request body params.
+     * Create an order. Use https://docs.x.immutable.com/reference#/operations/getSignableOrder to get request body params.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/createOrderV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
      * @summary Create an order
      * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof OrdersApi
      */
@@ -8743,10 +8745,11 @@ declare class OrdersApi extends BaseAPI {
      */
     createOrderV3(requestParameters: OrdersApiCreateOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateOrderResponse, any>>;
     /**
-     * Get an order
+     * Get an order.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/getOrderV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
      * @summary Get an order
      * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof OrdersApi
      */
@@ -8761,17 +8764,18 @@ declare class OrdersApi extends BaseAPI {
      */
     getOrderV3(requestParameters: OrdersApiGetOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<OrderV3, any>>;
     /**
-     * Get a signable cancel order message
-     * @summary Get a signable cancel order message
+     * Sign cancel order message.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/getSignableCancelOrderV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
+     * @summary Sign cancel order message
      * @param {OrdersApiGetSignableCancelOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof OrdersApi
      */
     getSignableCancelOrder(requestParameters: OrdersApiGetSignableCancelOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
     /**
-     * Get a signable cancel order message (V3)
-     * @summary Get a signable cancel order message (V3)
+     * Generate a signable cancel order message (V3)
+     * @summary Generate a signable cancel order message (V3)
      * @param {OrdersApiGetSignableCancelOrderV3Request} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -8779,8 +8783,8 @@ declare class OrdersApi extends BaseAPI {
      */
     getSignableCancelOrderV3(requestParameters: OrdersApiGetSignableCancelOrderV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableCancelOrderResponse, any>>;
     /**
-     * Get a signable order request (V3)
-     * @summary Get a signable order request (V3)
+     * Generate a signable order request (V3)
+     * @summary Generate a signable order request (V3)
      * @param {OrdersApiGetSignableOrderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -8788,10 +8792,11 @@ declare class OrdersApi extends BaseAPI {
      */
     getSignableOrder(requestParameters: OrdersApiGetSignableOrderRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<GetSignableOrderResponse, any>>;
     /**
-     * Get a list of orders
-     * @summary Get a list of orders
+     * Get a list of orders  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/listOrdersV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
+     * @summary Get a list of orders.
      * @param {OrdersApiListOrdersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof OrdersApi
      */
@@ -9154,10 +9159,10 @@ interface TradesApiListTradesRequest {
     readonly cursor?: string;
     /**
      * Property to sort by
-     * @type {'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity'}
+     * @type {'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity'}
      * @memberof TradesApiListTrades
      */
-    readonly orderBy?: 'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity';
+    readonly orderBy?: 'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity';
     /**
      * Direction to sort (asc/desc)
      * @type {string}
@@ -9227,10 +9232,10 @@ interface TradesApiListTradesV3Request {
     readonly cursor?: string;
     /**
      * Property to sort by
-     * @type {'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp'}
+     * @type {'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp'}
      * @memberof TradesApiListTradesV3
      */
-    readonly orderBy?: 'created_at' | 'updated_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp';
+    readonly orderBy?: 'created_at' | 'transaction_id' | 'party_a_sold_quantity' | 'party_b_sold_quantity' | 'timestamp' | 'updated_timestamp';
     /**
      * Direction to sort (asc/desc)
      * @type {string}
@@ -9258,10 +9263,11 @@ interface TradesApiListTradesV3Request {
  */
 declare class TradesApi extends BaseAPI {
     /**
-     * Create a trade. Use https://docs.x.immutable.com/reference#/operations/getSignableTrade to get request body params.
+     * Create a trade. Use https://docs.x.immutable.com/reference#/operations/getSignableTrade to get request body params.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/createTradeV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
      * @summary Create a Trade between two parties
      * @param {TradesApiCreateTradeRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof TradesApi
      */
@@ -9276,8 +9282,8 @@ declare class TradesApi extends BaseAPI {
      */
     createTradeV3(requestParameters: TradesApiCreateTradeV3Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTradeResponse, any>>;
     /**
-     * Get a signable trade V3 message
-     * @summary Get a signable trade V3 message
+     * Generate a signable trade message (V3)
+     * @summary Generate a signable trade message (V3)
      * @param {TradesApiGetSignableTradeRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -9294,10 +9300,11 @@ declare class TradesApi extends BaseAPI {
      */
     getTrade(requestParameters: TradesApiGetTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade, any>>;
     /**
-     * Get a list of trades
+     * Get a list of trades.  This version of the endpoint is deprecated, the latest version can be found at https://docs.x.immutable.com/reference/#/operations/listTradesV3.  Deprecation date - Mon, 01 May 2023  Sunset date - Fri, 01 Sept 2023
      * @summary Get a list of trades
      * @param {TradesApiListTradesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof TradesApi
      */
@@ -9530,7 +9537,7 @@ interface TransfersApiListTransfersRequest {
  */
 declare class TransfersApi extends BaseAPI {
     /**
-     * Create a new transfer request.
+     * Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransfer to get request body params.
      * @summary Creates a transfer of multiple tokens between two parties
      * @param {TransfersApiCreateTransferRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -9539,7 +9546,7 @@ declare class TransfersApi extends BaseAPI {
      */
     createTransfer(requestParameters: TransfersApiCreateTransferRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateTransferResponse, any>>;
     /**
-     * Create a new transfer request.
+     * Create a new transfer request. Use https://docs.x.immutable.com/reference#/operations/getSignableTransferV1 to get request body params.
      * @summary Creates a transfer of tokens between two parties
      * @param {TransfersApiCreateTransferV1Request} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -10352,14 +10359,14 @@ declare class ImmutableXClient {
      * @returns a promise that resolves with the requested Order
      * @throws {@link index.IMXError}
      */
-    getOrder(request: OrdersApiGetOrderRequest): Promise<Order>;
+    getOrder(request: OrdersApiGetOrderRequest): Promise<OrderV3>;
     /**
      * Get a list of Orders
      * @param request - optional object containing the parameters to be provided in the API request
      * @returns a promise that resolves with the requested list of Orders
      * @throws {@link index.IMXError}
      */
-    listOrders(request?: OrdersApiListOrdersRequest): Promise<ListOrdersResponse>;
+    listOrders(request?: OrdersApiListOrdersRequest): Promise<ListOrdersResponseV3>;
     /**
      * Get details of a Trade with the given ID
      * @param request - the request object containing the parameters to be provided in the API request
@@ -10473,6 +10480,7 @@ declare enum Networks {
 interface OidcConfiguration {
     clientId: string;
     logoutRedirectUri: string;
+    logoutMode?: 'redirect' | 'silent';
     redirectUri: string;
     scope?: string;
     audience?: string;
@@ -10485,6 +10493,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 {
 }
@@ -10502,6 +10516,59 @@ type DeviceTokenResponse = {
     expires_in: number;
 };
 
+/**
+ * ProviderErrors should take priority over RpcErrorCodes
+ */
+declare enum ProviderErrorCode {
+    USER_REJECTED_REQUEST = 4001,
+    UNAUTHORIZED = 4100,
+    UNSUPPORTED_METHOD = 4200,
+    DISCONNECTED = 4900
+}
+declare enum RpcErrorCode {
+    RPC_SERVER_ERROR = -32000,
+    INVALID_REQUEST = -32600,
+    METHOD_NOT_FOUND = -32601,
+    INVALID_PARAMS = -32602,
+    INTERNAL_ERROR = -32603,
+    PARSE_ERROR = -32700,
+    USER_REJECTED_REQUEST = -32003
+}
+declare class JsonRpcError extends Error {
+    readonly message: string;
+    readonly code: ProviderErrorCode | RpcErrorCode;
+    constructor(code: ProviderErrorCode | 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;
+    on: (event: string, listener: (...args: any[]) => void) => void;
+    removeListener: (event: string, listener: (...args: any[]) => void) => void;
+};
+declare enum ProviderEvent {
+    ACCOUNTS_CHANGED = "accountsChanged"
+}
+type AccountsChangedEvent = Array<string>;
+
 declare class Passport {
     private readonly authManager;
     private readonly config;
@@ -10509,18 +10576,27 @@ 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>;
     loginWithDeviceFlow(): Promise<DeviceConnectResponse>;
     connectImxDeviceFlow(deviceCode: string, interval: number, timeoutMs?: number): Promise<IMXProvider | null>;
+    getPKCEAuthorizationUrl(): string;
+    connectImxPKCEFlow(authorizationCode: string, state: string): Promise<IMXProvider | null>;
     /**
      * @returns {boolean} the stored device flow credentials if they exist
      */
     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>;
@@ -10528,4 +10604,4 @@ declare class Passport {
     getAccessToken(): Promise<string | undefined>;
 }
 
-export { DeviceConnectResponse, DeviceTokenResponse, Networks, Passport, PassportError, PassportModuleConfiguration, PassportOverrides, UserProfile };
+export { AccountsChangedEvent, DeviceConnectResponse, DeviceTokenResponse, JsonRpcError, JsonRpcRequestCallback, JsonRpcRequestPayload, JsonRpcResponsePayload, Networks, Passport, PassportError, PassportModuleConfiguration, PassportOverrides, Provider, ProviderErrorCode, ProviderEvent, RequestArguments, RpcErrorCode, UserProfile };