initsea-js/lib/orders/types.d.ts

JavaScript SDK for the OpenSea marketplace. Let users buy or sell crypto collectibles and other cryptogoods, all on your own site!

import { OrderWithCounter } from "initseaport-31/lib/types";
import { OpenSeaAccount, OpenSeaAssetBundle } from "../types";
declare type OrderProtocolToProtocolData = {
    seaport: OrderWithCounter;
};
export declare type OrderProtocol = keyof OrderProtocolToProtocolData;
export declare type ProtocolData = OrderProtocolToProtocolData[keyof OrderProtocolToProtocolData];
declare type OrderType = "basic" | "dutch" | "english" | "criteria";
export declare type OrderSide = "ask" | "bid";
export declare type OrderFee = {
    account: OpenSeaAccount;
    basisPoints: string;
};
export declare type OrderV2 = {
    createdDate: string;
    closingDate: string | null;
    listingTime: number;
    expirationTime: number;
    orderHash: string | null;
    maker: OpenSeaAccount;
    taker: OpenSeaAccount | null;
    protocolData: ProtocolData;
    protocolAddress: string;
    currentPrice: string;
    makerFees: OrderFee[];
    takerFees: OrderFee[];
    side: OrderSide;
    orderType: OrderType;
    cancelled: boolean;
    finalized: boolean;
    markedInvalid: boolean;
    clientSignature: string | null;
    makerAssetBundle: OpenSeaAssetBundle;
    takerAssetBundle: OpenSeaAssetBundle;
};
declare type OpenOrderOrderingOption = "created_date" | "eth_price";
declare type OrderByDirection = "asc" | "desc";
export declare type OrderAPIOptions = {
    protocol: OrderProtocol;
    side: OrderSide;
};
export declare type OrdersQueryOptions = OrderAPIOptions & {
    limit: number;
    cursor?: string;
    paymentTokenAddress?: string;
    maker?: string;
    taker?: string;
    owner?: string;
    bundled?: boolean;
    includeBundled?: boolean;
    listedAfter?: number | string;
    listedBefore?: number | string;
    tokenIds?: string[];
    assetContractAddress?: string;
    orderBy?: OpenOrderOrderingOption;
    orderDirection?: OrderByDirection;
    onlyEnglish?: boolean;
};
export declare type SerializedOrderV2 = {
    created_date: string;
    closing_date: string | null;
    listing_time: number;
    expiration_time: number;
    order_hash: string | null;
    maker: unknown;
    taker: unknown | null;
    protocol_data: ProtocolData;
    protocol_address: string;
    current_price: string;
    maker_fees: {
        account: unknown;
        basis_points: string;
    }[];
    taker_fees: {
        account: unknown;
        basis_points: string;
    }[];
    side: OrderSide;
    order_type: OrderType;
    cancelled: boolean;
    finalized: boolean;
    marked_invalid: boolean;
    client_signature: string | null;
    maker_asset_bundle: unknown;
    taker_asset_bundle: unknown;
};
export declare type QueryCursors = {
    next: string | null;
    previous: string | null;
};
export declare type OrdersQueryResponse = QueryCursors & {
    orders: SerializedOrderV2[];
};
export declare type OrdersPostQueryResponse = {
    order: SerializedOrderV2;
};
export {};