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

package/dist/orderbook.d.ts

@@ -1,6 +1,6 @@
 import { OrderbookOverrides } from 'config/config';
-import { ListingResult, ListListingsResult } from 'openapi/sdk';
-import { ListListingsParams, PrepareListingParams, PrepareListingResponse, CreateListingParams, FulfillOrderResponse, CancelOrderResponse } from 'types';
+import { ListingResult, ListListingsResult, OrdersService } from 'openapi/sdk';
+import { ListListingsParams as ListListingsParams$1, PrepareListingParams as PrepareListingParams$1, PrepareListingResponse as PrepareListingResponse$1, CreateListingParams as CreateListingParams$1, FulfillOrderResponse as FulfillOrderResponse$1, CancelOrderResponse as CancelOrderResponse$1 } from 'types';
 
 declare enum Environment {
     PRODUCTION = "production",
@@ -41,7 +41,7 @@ declare class Orderbook {
      * @param {ListOrderParams} listOrderParams - Filtering, ordering and page parameters.
      * @return {Orders} The paged orders.
      */
-    listListings(listOrderParams: ListListingsParams): Promise<ListListingsResult>;
+    listListings(listOrderParams: ListListingsParams$1): Promise<ListListingsResult>;
     /**
      * Get required transactions and messages for signing prior to creating a listing
      * through the createListing method
@@ -50,13 +50,13 @@ declare class Orderbook {
      * the unsigned approval transaction, the typed order message for signing and
      * the order components that can be submitted to `createListing` with a signature.
      */
-    prepareListing({ makerAddress, sell, buy, orderExpiry, }: PrepareListingParams): Promise<PrepareListingResponse>;
+    prepareListing({ makerAddress, sell, buy, orderExpiry, }: PrepareListingParams$1): Promise<PrepareListingResponse$1>;
     /**
      * Create an order
      * @param {CreateListingParams} createListingParams - create an order with the given params.
      * @return {ListingResult} The result of the order created in the Immutable services.
      */
-    createListing(createListingParams: CreateListingParams): Promise<ListingResult>;
+    createListing(createListingParams: CreateListingParams$1): Promise<ListingResult>;
     /**
      * Get unsigned transactions that can be submitted to fulfil an open order. If the approval
      * transaction exists it must be signed and submitted to the chain before the fulfilment
@@ -65,7 +65,7 @@ declare class Orderbook {
      * @param {string} fulfillerAddress - The address of the account fulfilling the order.
      * @return {FulfillOrderResponse} Approval and fulfilment transactions.
      */
-    fulfillOrder(listingId: string, takerAddress: string): Promise<FulfillOrderResponse>;
+    fulfillOrder(listingId: string, takerAddress: string): Promise<FulfillOrderResponse$1>;
     /**
      * Get an unsigned cancel order transaction. Orders can only be cancelled by
      * the account that created them.
@@ -73,9 +73,180 @@ declare class Orderbook {
      * @param {string} accountAddress - The address of the account cancelling the order.
      * @return {CancelOrderResponse} The unsigned cancel order transaction
      */
-    cancelOrder(listingId: string, accountAddress: string): Promise<CancelOrderResponse>;
+    cancelOrder(listingId: string, accountAddress: string): Promise<CancelOrderResponse$1>;
+}
+
+declare type Bytes = ArrayLike<number>;
+declare type BytesLike = Bytes | string;
+interface Hexable {
+    toHexString(): string;
+}
+
+declare type BigNumberish = BigNumber | Bytes | bigint | string | number;
+declare class BigNumber implements Hexable {
+    readonly _hex: string;
+    readonly _isBigNumber: boolean;
+    constructor(constructorGuard: any, hex: string);
+    fromTwos(value: number): BigNumber;
+    toTwos(value: number): BigNumber;
+    abs(): BigNumber;
+    add(other: BigNumberish): BigNumber;
+    sub(other: BigNumberish): BigNumber;
+    div(other: BigNumberish): BigNumber;
+    mul(other: BigNumberish): BigNumber;
+    mod(other: BigNumberish): BigNumber;
+    pow(other: BigNumberish): BigNumber;
+    and(other: BigNumberish): BigNumber;
+    or(other: BigNumberish): BigNumber;
+    xor(other: BigNumberish): BigNumber;
+    mask(value: number): BigNumber;
+    shl(value: number): BigNumber;
+    shr(value: number): BigNumber;
+    eq(other: BigNumberish): boolean;
+    lt(other: BigNumberish): boolean;
+    lte(other: BigNumberish): boolean;
+    gt(other: BigNumberish): boolean;
+    gte(other: BigNumberish): boolean;
+    isNegative(): boolean;
+    isZero(): boolean;
+    toNumber(): number;
+    toBigInt(): bigint;
+    toString(): string;
+    toHexString(): string;
+    toJSON(key?: string): any;
+    static from(value: any): BigNumber;
+    static isBigNumber(value: any): value is BigNumber;
+}
+
+declare type AccessList = Array<{
+    address: string;
+    storageKeys: Array<string>;
+}>;
+
+interface TypedDataDomain {
+    name?: string;
+    version?: string;
+    chainId?: BigNumberish;
+    verifyingContract?: string;
+    salt?: BytesLike;
+}
+interface TypedDataField {
+    name: string;
+    type: string;
+}
+
+interface PopulatedTransaction {
+    to?: string;
+    from?: string;
+    nonce?: number;
+    gasLimit?: BigNumber;
+    gasPrice?: BigNumber;
+    data?: string;
+    value?: BigNumber;
+    chainId?: number;
+    type?: number;
+    accessList?: AccessList;
+    maxFeePerGas?: BigNumber;
+    maxPriorityFeePerGas?: BigNumber;
+    customData?: Record<string, any>;
+    ccipReadEnabled?: boolean;
+}
+
+declare enum OrderType {
+    FULL_OPEN = 0,
+    PARTIAL_OPEN = 1,
+    FULL_RESTRICTED = 2,
+    PARTIAL_RESTRICTED = 3
+}
+declare enum ItemType {
+    NATIVE = 0,
+    ERC20 = 1,
+    ERC721 = 2,
+    ERC1155 = 3,
+    ERC721_WITH_CRITERIA = 4,
+    ERC1155_WITH_CRITERIA = 5
+}
+
+type OfferItem = {
+    itemType: ItemType;
+    token: string;
+    identifierOrCriteria: string;
+    startAmount: string;
+    endAmount: string;
+};
+type ConsiderationItem = {
+    itemType: ItemType;
+    token: string;
+    identifierOrCriteria: string;
+    startAmount: string;
+    endAmount: string;
+    recipient: string;
+};
+type OrderParameters = {
+    offerer: string;
+    zone: string;
+    orderType: OrderType;
+    startTime: BigNumberish;
+    endTime: BigNumberish;
+    zoneHash: string;
+    salt: string;
+    offer: OfferItem[];
+    consideration: ConsiderationItem[];
+    totalOriginalConsiderationItems: BigNumberish;
+    conduitKey: string;
+};
+type OrderComponents = OrderParameters & {
+    counter: BigNumberish;
+};
+
+interface ERC721Item {
+    type: 'ERC721';
+    contractAddress: string;
+    tokenId: string;
+}
+interface ERC20Item {
+    type: 'ERC20';
+    contractAddress: string;
+    amount: string;
+}
+interface NativeItem {
+    type: 'NATIVE';
+    amount: string;
+}
+interface RoyaltyInfo {
+    recipient: string;
+    amountRequired: string;
+}
+interface PrepareListingParams {
+    makerAddress: string;
+    sell: ERC721Item;
+    buy: ERC20Item | NativeItem;
+    orderExpiry?: Date;
+}
+interface PrepareListingResponse {
+    unsignedApprovalTransaction?: PopulatedTransaction;
+    typedOrderMessageForSigning: {
+        domain: TypedDataDomain;
+        types: Record<string, TypedDataField[]>;
+        value: Record<string, any>;
+    };
+    orderComponents: OrderComponents;
+    orderHash: string;
+}
+interface CreateListingParams {
+    orderComponents: OrderComponents;
+    orderHash: string;
+    orderSignature: string;
+}
+type ListListingsParams = Omit<Parameters<typeof OrdersService.prototype.listListings>[0], 'chainName'>;
+interface FulfillOrderResponse {
+    unsignedApprovalTransaction?: PopulatedTransaction;
+    unsignedFulfillmentTransaction: PopulatedTransaction;
+}
+interface CancelOrderResponse {
+    unsignedCancelOrderTransaction: PopulatedTransaction;
 }
 
 declare const module = "orderbook";
 
-export { Orderbook, module };
+export { CancelOrderResponse, CreateListingParams, ERC20Item, ERC721Item, FulfillOrderResponse, ListListingsParams, NativeItem, Orderbook, PrepareListingParams, PrepareListingResponse, RoyaltyInfo, module };

package/dist/passport.d.ts

@@ -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.
@@ -10524,7 +10531,8 @@ declare enum RpcErrorCode {
     METHOD_NOT_FOUND = -32601,
     INVALID_PARAMS = -32602,
     INTERNAL_ERROR = -32603,
-    PARSE_ERROR = -32700
+    PARSE_ERROR = -32700,
+    USER_REJECTED_REQUEST = -32003
 }
 declare class JsonRpcError extends Error {
     readonly message: string;
@@ -10574,6 +10582,8 @@ declare class Passport {
     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
      */