@imtbl/orderbook 2.0.0-alpha.0

package/dist/types/openapi/sdk/models/CreateListingRequestBody.d.ts

@@ -0,0 +1,36 @@
+import type { Fee } from './Fee';
+import type { Item } from './Item';
+import type { ProtocolData } from './ProtocolData';
+export type CreateListingRequestBody = {
+    account_address: string;
+    order_hash: string;
+    /**
+     * Buy item for listing should either be NATIVE or ERC20 item
+     */
+    buy: Array<Item>;
+    /**
+     * Buy fees should only include maker marketplace fees and should be no more than two entries as more entires will incur more gas. It is best practice to have this as few as possible.
+     */
+    fees: Array<Fee>;
+    /**
+     * Time after which the Order is considered expired
+     */
+    end_at: string;
+    protocol_data: ProtocolData;
+    /**
+     * A random value added to the create Order request
+     */
+    salt: string;
+    /**
+     * Sell item for listing should be an ERC721 item
+     */
+    sell: Array<Item>;
+    /**
+     * Digital signature generated by the user for the specific Order
+     */
+    signature: string;
+    /**
+     * Time after which Order is considered active
+     */
+    start_at: string;
+};

package/dist/types/openapi/sdk/models/ERC1155CollectionItem.d.ts

@@ -0,0 +1,14 @@
+export type ERC1155CollectionItem = {
+    /**
+     * Token type user is offering, which in this case is ERC1155
+     */
+    type: 'ERC1155_COLLECTION';
+    /**
+     * Address of ERC1155 collection
+     */
+    contract_address: string;
+    /**
+     * A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).
+     */
+    amount: string;
+};

package/dist/types/openapi/sdk/models/ERC1155Item.d.ts

@@ -0,0 +1,18 @@
+export type ERC1155Item = {
+    /**
+     * Token type user is offering, which in this case is ERC1155
+     */
+    type: 'ERC1155';
+    /**
+     * Address of ERC1155 token
+     */
+    contract_address: string;
+    /**
+     * ID of ERC1155 token
+     */
+    token_id: string;
+    /**
+     * A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).
+     */
+    amount: string;
+};

package/dist/types/openapi/sdk/models/ERC20Item.d.ts

@@ -0,0 +1,14 @@
+export type ERC20Item = {
+    /**
+     * Token type user is offering, which in this case is ERC20
+     */
+    type: 'ERC20';
+    /**
+     * Address of ERC20 token
+     */
+    contract_address: string;
+    /**
+     * A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).
+     */
+    amount: string;
+};

package/dist/types/openapi/sdk/models/ERC721CollectionItem.d.ts

@@ -0,0 +1,14 @@
+export type ERC721CollectionItem = {
+    /**
+     * Token type user is offering, which in this case is ERC721
+     */
+    type: 'ERC721_COLLECTION';
+    /**
+     * Address of ERC721 collection
+     */
+    contract_address: string;
+    /**
+     * A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).
+     */
+    amount: string;
+};

package/dist/types/openapi/sdk/models/ERC721Item.d.ts

@@ -0,0 +1,14 @@
+export type ERC721Item = {
+    /**
+     * Token type user is offering, which in this case is ERC721
+     */
+    type: 'ERC721';
+    /**
+     * Address of ERC721 token
+     */
+    contract_address: string;
+    /**
+     * ID of ERC721 token
+     */
+    token_id: string;
+};

package/dist/types/openapi/sdk/models/Error.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Resource not found
+ */
+export type Error = {
+    /**
+     * Error trace id
+     */
+    id?: string;
+    /**
+     * Error message
+     */
+    message: string;
+};

package/dist/types/openapi/sdk/models/ExpiredOrderStatus.d.ts

@@ -0,0 +1,6 @@
+export type ExpiredOrderStatus = {
+    /**
+     * A terminal order status indicating that an order cannot be fulfilled due to expiry.
+     */
+    name: 'EXPIRED';
+};

package/dist/types/openapi/sdk/models/FailedOrderCancellation.d.ts

@@ -0,0 +1,18 @@
+export type FailedOrderCancellation = {
+    /**
+     * ID of the order which failed to be cancelled
+     */
+    order: string;
+    /**
+     * Reason code indicating why the order failed to be cancelled
+     */
+    reason_code: FailedOrderCancellation.reason_code;
+};
+export declare namespace FailedOrderCancellation {
+    /**
+     * Reason code indicating why the order failed to be cancelled
+     */
+    enum reason_code {
+        FILLED = "FILLED"
+    }
+}

package/dist/types/openapi/sdk/models/Fee.d.ts

@@ -0,0 +1,25 @@
+export type Fee = {
+    /**
+     * Fee payable to recipient upon settlement
+     */
+    amount: string;
+    /**
+     * Fee type
+     */
+    type: Fee.type;
+    /**
+     * Wallet address of fee recipient
+     */
+    recipient_address: string;
+};
+export declare namespace Fee {
+    /**
+     * Fee type
+     */
+    enum type {
+        ROYALTY = "ROYALTY",
+        MAKER_ECOSYSTEM = "MAKER_ECOSYSTEM",
+        TAKER_ECOSYSTEM = "TAKER_ECOSYSTEM",
+        PROTOCOL = "PROTOCOL"
+    }
+}

package/dist/types/openapi/sdk/models/FillStatus.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The ratio of the order that has been filled, an order that has been fully filled will have the same numerator and denominator values.
+ */
+export type FillStatus = {
+    /**
+     * The numerator of the fill status
+     */
+    numerator: string;
+    /**
+     * The denominator of the fill status
+     */
+    denominator: string;
+};

package/dist/types/openapi/sdk/models/FilledOrderStatus.d.ts

@@ -0,0 +1,6 @@
+export type FilledOrderStatus = {
+    /**
+     * A terminal order status indicating that an order has been fulfilled.
+     */
+    name: 'FILLED';
+};

package/dist/types/openapi/sdk/models/FulfillableOrder.d.ts

@@ -0,0 +1,9 @@
+import type { Order } from './Order';
+export type FulfillableOrder = {
+    order: Order;
+    /**
+     * Token ID for the ERC721 or ERC1155 token when fulfilling a collection order
+     */
+    token_id?: string;
+    extra_data: string;
+};

package/dist/types/openapi/sdk/models/FulfillmentDataRequest.d.ts

@@ -0,0 +1,13 @@
+import type { Fee } from './Fee';
+export type FulfillmentDataRequest = {
+    order_id: string;
+    /**
+     * Address of the intended account fulfilling the order
+     */
+    taker_address: string;
+    fees: Array<Fee>;
+    /**
+     * Token ID for the ERC721 or ERC1155 token when fulfilling a collection order
+     */
+    token_id?: string;
+};

package/dist/types/openapi/sdk/models/InactiveOrderStatus.d.ts

@@ -0,0 +1,14 @@
+export type InactiveOrderStatus = {
+    /**
+     * The order status that indicates an order cannot be fulfilled.
+     */
+    name: 'INACTIVE';
+    /**
+     * Whether the order offerer has sufficient approvals
+     */
+    sufficient_approvals: boolean;
+    /**
+     * Whether the order offerer still has sufficient balance to complete the order
+     */
+    sufficient_balances: boolean;
+};

package/dist/types/openapi/sdk/models/Item.d.ts

@@ -0,0 +1,7 @@
+import type { ERC1155CollectionItem } from './ERC1155CollectionItem';
+import type { ERC1155Item } from './ERC1155Item';
+import type { ERC20Item } from './ERC20Item';
+import type { ERC721CollectionItem } from './ERC721CollectionItem';
+import type { ERC721Item } from './ERC721Item';
+import type { NativeItem } from './NativeItem';
+export type Item = (NativeItem | ERC20Item | ERC721Item | ERC1155Item | ERC721CollectionItem | ERC1155CollectionItem);

package/dist/types/openapi/sdk/models/ListBidsResult.d.ts

@@ -0,0 +1,6 @@
+import type { Order } from './Order';
+import type { Page } from './Page';
+export type ListBidsResult = {
+    page: Page;
+    result: Array<Order>;
+};

package/dist/types/openapi/sdk/models/ListCollectionBidsResult.d.ts

@@ -0,0 +1,6 @@
+import type { Order } from './Order';
+import type { Page } from './Page';
+export type ListCollectionBidsResult = {
+    page: Page;
+    result: Array<Order>;
+};

package/dist/types/openapi/sdk/models/ListListingsResult.d.ts

@@ -0,0 +1,6 @@
+import type { Order } from './Order';
+import type { Page } from './Page';
+export type ListListingsResult = {
+    page: Page;
+    result: Array<Order>;
+};

package/dist/types/openapi/sdk/models/ListTradeResult.d.ts

@@ -0,0 +1,6 @@
+import type { Page } from './Page';
+import type { Trade } from './Trade';
+export type ListTradeResult = {
+    page: Page;
+    result: Array<Trade>;
+};

package/dist/types/openapi/sdk/models/ListingResult.d.ts

@@ -0,0 +1,4 @@
+import type { Order } from './Order';
+export type ListingResult = {
+    result: Order;
+};

package/dist/types/openapi/sdk/models/NativeItem.d.ts

@@ -0,0 +1,10 @@
+export type NativeItem = {
+    /**
+     * Token type user is offering, which in this case is the native IMX token
+     */
+    type: 'NATIVE';
+    /**
+     * A string representing the price at which the user is willing to sell the token. This value is provided in the smallest unit of the token (e.g., wei for Ethereum).
+     */
+    amount: string;
+};

package/dist/types/openapi/sdk/models/Order.d.ts

@@ -0,0 +1,59 @@
+import type { Chain } from './Chain';
+import type { Fee } from './Fee';
+import type { FillStatus } from './FillStatus';
+import type { Item } from './Item';
+import type { OrderStatus } from './OrderStatus';
+import type { ProtocolData } from './ProtocolData';
+export type Order = {
+    account_address: string;
+    buy: Array<Item>;
+    fees: Array<Fee>;
+    chain: Chain;
+    /**
+     * Time the Order is created
+     */
+    created_at: string;
+    /**
+     * Time after which the Order is considered expired
+     */
+    end_at: string;
+    /**
+     * Global Order identifier
+     */
+    id: string;
+    order_hash: string;
+    protocol_data: ProtocolData;
+    /**
+     * A random value added to the create Order request
+     */
+    salt: string;
+    sell: Array<Item>;
+    /**
+     * Digital signature generated by the user for the specific Order
+     */
+    signature: string;
+    /**
+     * Time after which Order is considered active
+     */
+    start_at: string;
+    status: OrderStatus;
+    /**
+     * Order type
+     */
+    type: Order.type;
+    /**
+     * Time the Order is last updated
+     */
+    updated_at: string;
+    fill_status: FillStatus;
+};
+export declare namespace Order {
+    /**
+     * Order type
+     */
+    enum type {
+        LISTING = "LISTING",
+        BID = "BID",
+        COLLECTION_BID = "COLLECTION_BID"
+    }
+}

package/dist/types/openapi/sdk/models/OrderStatus.d.ts

@@ -0,0 +1,10 @@
+import type { ActiveOrderStatus } from './ActiveOrderStatus';
+import type { CancelledOrderStatus } from './CancelledOrderStatus';
+import type { ExpiredOrderStatus } from './ExpiredOrderStatus';
+import type { FilledOrderStatus } from './FilledOrderStatus';
+import type { InactiveOrderStatus } from './InactiveOrderStatus';
+import type { PendingOrderStatus } from './PendingOrderStatus';
+/**
+ * The Order status
+ */
+export type OrderStatus = (CancelledOrderStatus | PendingOrderStatus | ActiveOrderStatus | InactiveOrderStatus | FilledOrderStatus | ExpiredOrderStatus);

package/dist/types/openapi/sdk/models/OrderStatusName.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The Order status
+ */
+export declare enum OrderStatusName {
+    PENDING = "PENDING",
+    ACTIVE = "ACTIVE",
+    INACTIVE = "INACTIVE",
+    FILLED = "FILLED",
+    EXPIRED = "EXPIRED",
+    CANCELLED = "CANCELLED"
+}

package/dist/types/openapi/sdk/models/Page.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Pagination properties
+ */
+export type Page = {
+    /**
+     * First item as an encoded string
+     */
+    previous_cursor: string | null;
+    /**
+     * Last item as an encoded string
+     */
+    next_cursor: string | null;
+};

package/dist/types/openapi/sdk/models/PageCursor.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+ */
+export type PageCursor = string;

package/dist/types/openapi/sdk/models/PageSize.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Maximum number of items to return
+ */
+export type PageSize = number;

package/dist/types/openapi/sdk/models/PendingOrderStatus.d.ts

@@ -0,0 +1,14 @@
+export type PendingOrderStatus = {
+    /**
+     * The order status that indicates the order is yet to be active due to various reasons.
+     */
+    name: 'PENDING';
+    /**
+     * Whether the order has been evaluated after its creation
+     */
+    evaluated: boolean;
+    /**
+     * Whether the order has reached its specified start time
+     */
+    started: boolean;
+};

package/dist/types/openapi/sdk/models/ProtocolData.d.ts

@@ -0,0 +1,31 @@
+export type ProtocolData = {
+    /**
+     * Seaport order type. Orders containing ERC721 tokens will need to pass in the order type as FULL_RESTRICTED while orders with ERC1155 tokens will need to pass in the order_type as PARTIAL_RESTRICTED
+     */
+    order_type: ProtocolData.order_type;
+    /**
+     * big.Int or uint256 string for order counter
+     */
+    counter: string;
+    /**
+     * Immutable zone address
+     */
+    zone_address: string;
+    /**
+     * Immutable Seaport contract address
+     */
+    seaport_address: string;
+    /**
+     * Immutable Seaport contract version
+     */
+    seaport_version: string;
+};
+export declare namespace ProtocolData {
+    /**
+     * Seaport order type. Orders containing ERC721 tokens will need to pass in the order type as FULL_RESTRICTED while orders with ERC1155 tokens will need to pass in the order_type as PARTIAL_RESTRICTED
+     */
+    enum order_type {
+        FULL_RESTRICTED = "FULL_RESTRICTED",
+        PARTIAL_RESTRICTED = "PARTIAL_RESTRICTED"
+    }
+}

package/dist/types/openapi/sdk/models/Trade.d.ts

@@ -0,0 +1,40 @@
+import type { Chain } from './Chain';
+import type { Fee } from './Fee';
+import type { Item } from './Item';
+import type { TradeBlockchainMetadata } from './TradeBlockchainMetadata';
+export type Trade = {
+    /**
+     * Buy items are transferred from the taker to the maker.
+     */
+    buy: Array<Item>;
+    /**
+     * Deprecated. Use maker and taker addresses instead of buyer and seller addresses.
+     */
+    buyer_address: string;
+    /**
+     * Deprecated. Use fees instead. The taker always pays the fees.
+     */
+    buyer_fees: Array<Fee>;
+    fees: Array<Fee>;
+    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 items are transferred from the maker to the taker.
+     */
+    sell: Array<Item>;
+    /**
+     * Deprecated. Use maker and taker addresses instead of buyer and seller addresses.
+     */
+    seller_address: string;
+    maker_address: string;
+    taker_address: string;
+};

package/dist/types/openapi/sdk/models/TradeBlockchainMetadata.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The metadata related to the transaction in which the activity occurred
+ */
+export 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;
+};

package/dist/types/openapi/sdk/models/TradeResult.d.ts

@@ -0,0 +1,4 @@
+import type { Trade } from './Trade';
+export type TradeResult = {
+    result: Trade;
+};

package/dist/types/openapi/sdk/models/UnfulfillableOrder.d.ts

@@ -0,0 +1,14 @@
+export type UnfulfillableOrder = {
+    /**
+     * OrderID for the requested but unfulfillable order
+     */
+    order_id: string;
+    /**
+     * Token ID for the ERC721 or ERC1155 token when fulfilling a collection order
+     */
+    token_id?: string;
+    /**
+     * Nullable string containing error reason if the signing is unsuccessful for the order
+     */
+    reason: string;
+};