@imtbl/sdk 0.15.1-alpha → 0.16.0-alpha.1

package/dist/index.d.ts

@@ -7804,7 +7804,7 @@ declare type TradeB = TradeSide;
  * @export
  * @interface Trade
  */
-interface Trade {
+interface Trade$2 {
     /**
      *
      * @type {TradeA}
@@ -7872,7 +7872,7 @@ interface ListTradesResponse {
      * @type {Array<Trade>}
      * @memberof ListTradesResponse
      */
-    'result': Array<Trade>;
+    'result': Array<Trade$2>;
 }
 
 /**
@@ -11659,7 +11659,7 @@ declare class TradesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TradesApi
      */
-    getTrade(requestParameters: TradesApiGetTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade, any>>;
+    getTrade(requestParameters: TradesApiGetTradeRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Trade$2, any>>;
     /**
      * 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
@@ -12651,7 +12651,7 @@ declare class ImmutableXClient {
      * @returns a promise that resolves with the requested Trade
      * @throws {@link index.IMXError}
      */
-    getTrade(request: TradesApiGetTradeRequest): Promise<Trade>;
+    getTrade(request: TradesApiGetTradeRequest): Promise<Trade$2>;
     /**
      * Get a list of Trades
      * @param request - optional object containing the parameters to be provided in the API request
@@ -13075,6 +13075,7 @@ declare class Passport {
     getUserInfoDeviceFlow(): Promise<UserProfile | undefined>;
     getIdToken(): Promise<string | undefined>;
     getAccessToken(): Promise<string | undefined>;
+    getLinkedAddresses(): Promise<string[]>;
 }
 
 type passport_d_AccountsChangedEvent = AccountsChangedEvent;
@@ -13356,9 +13357,6 @@ type CreateListingRequestBody = {
      * Buy item for listing should either be NATIVE or ERC20 item
      */
     buy: Array<Item>;
-    /**
-     * The maker marketplace fee
-     */
     fee?: Fee$1;
     /**
      * Time after which the Order is considered expired
@@ -13480,6 +13478,54 @@ type ListListingsResult$1 = {
     result: Array<Order$1>;
 };
 
+/**
+ * The metadata related to the transaction in which the activity occurred
+ */
+type TradeBlockchainMetadata = {
+    /**
+     * The transaction hash of the trade
+     */
+    transaction_hash: string;
+    /**
+     * EVM block number (uint64 as string)
+     */
+    block_number: string;
+    /**
+     * Transaction index in a block (uint32 as string)
+     */
+    transaction_index: string;
+    /**
+     * The log index of the fulfillment event in a block (uint32 as string)
+     */
+    log_index: string;
+};
+
+type Trade$1 = {
+    buy: Array<Item>;
+    buyer_address: string;
+    buyer_fees: Array<Fee$1>;
+    chain: Chain;
+    order_id: string;
+    blockchain_metadata: TradeBlockchainMetadata;
+    /**
+     * Time the on-chain trade event is indexed by the order book system
+     */
+    indexed_at: string;
+    /**
+     * Global Trade identifier
+     */
+    id: string;
+    sell: Array<Item>;
+    seller_address: string;
+    maker_address: string;
+    taker_address: string;
+};
+
+type ListTradeResult = {
+    page: Page$1;
+    result: Array<Trade$1>;
+};
+
 /**
  * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
  */
@@ -13490,6 +13536,10 @@ type PageCursor = string;
  */
 type PageSize = number;
 
+type TradeResult$1 = {
+    result: Trade$1;
+};
+
 declare class OrdersService {
     readonly httpRequest: BaseHttpRequest;
     constructor(httpRequest: BaseHttpRequest);
@@ -13569,6 +13619,45 @@ declare class OrdersService {
     }): CancelablePromise<{
         result: Array<FulfillmentDataResult>;
     }>;
+    /**
+     * List all trades
+     * List all trades
+     * @returns ListTradeResult OK response.
+     * @throws ApiError
+     */
+    listTrades({ chainName, accountAddress, pageSize, sortBy, sortDirection, pageCursor, }: {
+        chainName: ChainName$1;
+        accountAddress?: string;
+        /**
+         * Maximum number of trades to return per page
+         */
+        pageSize?: PageSize;
+        /**
+         * Trade field to sort by
+         */
+        sortBy?: 'created_at';
+        /**
+         * Ascending or descending direction for sort
+         */
+        sortDirection?: 'asc' | 'desc';
+        /**
+         * Page cursor to retrieve previous or next page. Use the value returned in the response.
+         */
+        pageCursor?: PageCursor;
+    }): CancelablePromise<ListTradeResult>;
+    /**
+     * Get a single trade by ID
+     * Get a single trade by ID
+     * @returns TradeResult OK response.
+     * @throws ApiError
+     */
+    getTrade({ chainName, tradeId, }: {
+        chainName: ChainName$1;
+        /**
+         * Global Trade identifier
+         */
+        tradeId: string;
+    }): CancelablePromise<TradeResult$1>;
 }
 
 interface ERC721Item$1 {
@@ -13607,6 +13696,7 @@ interface CreateListingParams {
     makerFee?: FeeValue;
 }
 type ListListingsParams = Omit<Parameters<typeof OrdersService.prototype.listListings>[0], 'chainName'>;
+type ListTradesParams = Omit<Parameters<typeof OrdersService.prototype.listTrades>[0], 'chainName'>;
 declare enum FeeType {
     MAKER_MARKETPLACE = "MAKER_MARKETPLACE",
     TAKER_MARKETPLACE = "TAKER_MARKETPLACE",
@@ -13707,6 +13797,50 @@ interface Page {
      */
     nextCursor: string | null;
 }
+interface Trade {
+    id: string;
+    orderId: string;
+    chain: {
+        id: string;
+        name: string;
+    };
+    buy: (ERC20Item$1 | NativeItem$1)[];
+    sell: ERC721Item$1[];
+    buyerFees: Fee[];
+    sellerAddress: string;
+    buyerAddress: string;
+    makerAddress: string;
+    takerAddress: string;
+    /**
+     * Time the on-chain event was indexed by the Immutable order book service
+     */
+    indexedAt: string;
+    blockchainMetadata: {
+        /**
+         * The transaction hash of the trade
+         */
+        transactionHash: string;
+        /**
+         * EVM block number (uint64 as string)
+         */
+        blockNumber: string;
+        /**
+         * Transaction index in a block (uint32 as string)
+         */
+        transactionIndex: string;
+        /**
+         * The log index of the fulfillment event in a block (uint32 as string)
+         */
+        logIndex: string;
+    };
+}
+interface TradeResult {
+    result: Trade;
+}
+interface ListTradesResult {
+    page: Page;
+    result: Trade[];
+}
 
 /**
  * zkEVM orderbook SDK
@@ -13729,6 +13863,12 @@ declare class Orderbook {
      * @return {ListingResult} The returned order result.
      */
     getListing(listingId: string): Promise<ListingResult>;
+    /**
+     * Get a trade by ID
+     * @param {string} tradeId - The tradeId to find.
+     * @return {TradeResult} The returned order result.
+     */
+    getTrade(tradeId: string): Promise<TradeResult>;
     /**
      * List orders. This method is used to get a list of orders filtered by conditions specified
      * in the params object.
@@ -13736,6 +13876,13 @@ declare class Orderbook {
      * @return {ListListingsResult} The paged orders.
      */
     listListings(listOrderParams: ListListingsParams): Promise<ListListingsResult>;
+    /**
+     * List trades. This method is used to get a list of trades filtered by conditions specified
+     * in the params object
+     * @param {ListTradesParams} listTradesParams - Filtering, ordering and page parameters.
+     * @return {ListTradesResult} The paged trades.
+     */
+    listTrades(listTradesParams: ListTradesParams): Promise<ListTradesResult>;
     /**
      * Get required transactions and messages for signing prior to creating a listing
      * through the createListing method
@@ -13786,6 +13933,8 @@ type orderbook_d_FeeValue = FeeValue;
 type orderbook_d_FulfillOrderResponse = FulfillOrderResponse;
 type orderbook_d_ListListingsParams = ListListingsParams;
 type orderbook_d_ListListingsResult = ListListingsResult;
+type orderbook_d_ListTradesParams = ListTradesParams;
+type orderbook_d_ListTradesResult = ListTradesResult;
 type orderbook_d_ListingResult = ListingResult;
 type orderbook_d_Order = Order;
 type orderbook_d_OrderStatus = OrderStatus;
@@ -13799,6 +13948,8 @@ type orderbook_d_RoyaltyInfo = RoyaltyInfo;
 type orderbook_d_SignableAction = SignableAction;
 type orderbook_d_SignablePurpose = SignablePurpose;
 declare const orderbook_d_SignablePurpose: typeof SignablePurpose;
+type orderbook_d_Trade = Trade;
+type orderbook_d_TradeResult = TradeResult;
 type orderbook_d_TransactionAction = TransactionAction;
 type orderbook_d_TransactionBuilder = TransactionBuilder;
 type orderbook_d_TransactionPurpose = TransactionPurpose;
@@ -13818,6 +13969,8 @@ declare namespace orderbook_d {
     orderbook_d_FulfillOrderResponse as FulfillOrderResponse,
     orderbook_d_ListListingsParams as ListListingsParams,
     orderbook_d_ListListingsResult as ListListingsResult,
+    orderbook_d_ListTradesParams as ListTradesParams,
+    orderbook_d_ListTradesResult as ListTradesResult,
     orderbook_d_ListingResult as ListingResult,
     NativeItem$1 as NativeItem,
     orderbook_d_Order as Order,
@@ -13829,6 +13982,8 @@ declare namespace orderbook_d {
     orderbook_d_RoyaltyInfo as RoyaltyInfo,
     orderbook_d_SignableAction as SignableAction,
     orderbook_d_SignablePurpose as SignablePurpose,
+    orderbook_d_Trade as Trade,
+    orderbook_d_TradeResult as TradeResult,
     orderbook_d_TransactionAction as TransactionAction,
     orderbook_d_TransactionBuilder as TransactionBuilder,
     orderbook_d_TransactionPurpose as TransactionPurpose,
@@ -14169,6 +14324,15 @@ type GasEstimateSwapTokenConfig = {
     inAddress: string;
     outAddress: string;
 };
+/**
+ * A type representing all the feature flags available.
+ * @property {TokenInfo[] | undefined} allowed - List of allowed tokens for a given chain.
+ * @property {boolean | undefined} blockscout - Feature flag to enable/disable blockscout integration.
+ */
+type ChainTokensConfig = {
+    allowed?: TokenInfo[];
+    blockscout?: boolean;
+};
 /**
  * Represents information about a network.
  * @interface NetworkInfo
@@ -14479,6 +14643,7 @@ declare enum CheckoutErrorType {
     DEFAULT_PROVIDER_ERROR = "DEFAULT_PROVIDER_ERROR",
     CONNECT_PROVIDER_ERROR = "CONNECT_PROVIDER_ERROR",
     GET_BALANCE_ERROR = "GET_BALANCE_ERROR",
+    GET_INDEXER_BALANCE_ERROR = "GET_INDEXER_BALANCE_ERROR",
     GET_ERC20_BALANCE_ERROR = "GET_ERC20_BALANCE_ERROR",
     GET_ERC721_BALANCE_ERROR = "GET_ERC721_BALANCE_ERROR",
     GET_NETWORK_INFO_ERROR = "GET_NETWORK_INFO_ERROR",
@@ -14494,6 +14659,7 @@ declare enum CheckoutErrorType {
     UNSUPPORTED_TOKEN_TYPE_ERROR = "UNSUPPORTED_TOKEN_TYPE_ERROR",
     UNSUPPORTED_BALANCE_REQUIREMENT_ERROR = "UNSUPPORTED_BALANCE_REQUIREMENT_ERROR",
     GET_ORDER_LISTING_ERROR = "GET_ORDER_LISTING_ERROR",
+    PREPARE_ORDER_LISTING_ERROR = "PREPARE_ORDER_LISTING_ERROR",
     SWITCH_NETWORK_UNSUPPORTED = "SWITCH_NETWORK_UNSUPPORTED",
     GET_ERC20_ALLOWANCE_ERROR = "GET_ERC20_ALLOWANCE_ERROR",
     GET_ERC721_ALLOWANCE_ERROR = "GET_ERC721_ALLOWANCE_ERROR"
@@ -14518,7 +14684,7 @@ type RemoteConfigParams = {
 declare class RemoteConfigFetcher {
     constructor(params: RemoteConfigParams);
     getConfig(key?: keyof RemoteConfiguration): Promise<RemoteConfiguration | RemoteConfiguration[keyof RemoteConfiguration] | undefined>;
-    getTokens(chainId: ChainId): Promise<TokenInfo[]>;
+    getTokensConfig(chainId: ChainId): Promise<ChainTokensConfig>;
 }
 declare class CheckoutConfiguration {
     readonly isDevelopment: boolean;
@@ -14528,6 +14694,44 @@ declare class CheckoutConfiguration {
     readonly networkMap: NetworkMap;
     constructor(config: CheckoutModuleConfiguration);
 }
+/**
+ * Interface representing the parameters for {@link Checkout.sell}
+ * @property {Web3Provider} provider - The provider to use for the sell.
+ * @property {string} id - The ERC721 ID.
+ * @property {string} collectionAddress - The contract address of the ERC721s collection.
+ * @property {BuyToken} buyToken - The token to buy the item with.
+ */
+interface SellParams {
+    provider: Web3Provider;
+    id: string;
+    collectionAddress: string;
+    buyToken: BuyToken;
+}
+/**
+ * Represents the token that the item can be bought with once listed for sale.
+ * NativeBuyToken or ERC20BuyToken {@link Checkout.smartCheckout}.
+ */
+type BuyToken = NativeBuyToken | ERC20BuyToken;
+/**
+ * Represents a native buy token
+ * @property {ItemType} type - The type indicate this is a native token.
+ * @property {BigNumber} amount - The amount of native token.
+ */
+type NativeBuyToken = {
+    type: ItemType.NATIVE;
+    amount: BigNumber;
+};
+/**
+ * Represents a ERC20 buy token
+ * @property {ItemType} type - The type indicate this is a ERC20 token.
+ * @property {BigNumber} amount - The amount of native token.
+ * @property {string} contractAddress - The contract address of the ERC20.
+ */
+type ERC20BuyToken = {
+    type: ItemType.ERC20;
+    amount: BigNumber;
+    contractAddress: string;
+};
 declare class Checkout {
     readonly config: CheckoutConfiguration;
     /**
@@ -14607,6 +14811,11 @@ declare class Checkout {
      * @param {BuyParams} params - The parameters for the buy.
     */
     buy(params: BuyParams): Promise<void>;
+    /**
+     * Determines the requirements for performing a sell.
+     * @param {SellParams} params - The parameters for the sell.
+    */
+    sell(params: SellParams): Promise<void>;
     /**
      * Determines the transaction requirements to complete a purchase.
      * @params {SmartCheckoutParams} params - The parameters for smart checkout.
@@ -29823,9 +30032,9 @@ declare class ERC721 {
      */
     ownerOf(provider: Provider$1, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
     /**
-     * @returns the royalty allowlist as a string.
+     * @returns the operator allowlist as a string.
      */
-    royaltyAllowlist(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
+    operatorAllowlist(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
     /**
      * @returns the royalty information for a particular tokenId.
      */
@@ -30008,9 +30217,9 @@ declare class ERC721 {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
     /**
-     * @returns a populated transaction for the setRoyaltyAllowlistRegistry contract function
+     * @returns a populated transaction for the setOperatorAllowlistRegistry contract function
      */
-    populateSetRoyaltyAllowlistRegistry(_royaltyAllowlist: PromiseOrValue<string>, overrides?: Overrides & {
+    populateSetOperatorAllowlistRegistry(_operatorAllowlist: PromiseOrValue<string>, overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
 }
@@ -30118,9 +30327,9 @@ declare class ERC721MintByID {
      */
     ownerOf(provider: Provider$1, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
     /**
-     * @returns the royalty allowlist as a string.
+     * @returns the operator allowlist as a string.
      */
-    royaltyAllowlist(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
+    operatorAllowlist(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
     /**
      * @returns the royalty information for a particular tokenId.
      */
@@ -30267,9 +30476,9 @@ declare class ERC721MintByID {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
     /**
-     * @returns a populated transaction for the setRoyaltyAllowlistRegistry contract function
+     * @returns a populated transaction for the setOperatorAllowlistRegistry contract function
      */
-    populateSetRoyaltyAllowlistRegistry(_royaltyAllowlist: PromiseOrValue<string>, overrides?: Overrides & {
+    populateSetOperatorAllowlistRegistry(_operatorAllowlist: PromiseOrValue<string>, overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
 }