@opensea/sdk 9.0.0

package/src/orders/utils.ts

@@ -0,0 +1,253 @@
+import { CROSS_CHAIN_SEAPORT_V1_6_ADDRESS } from "@opensea/seaport-js/lib/constants"
+import { API_V2_PREFIX } from "../api/apiPaths"
+import { type Chain, OrderSide } from "../types"
+import { accountFromJSON, getSeaportAddress } from "../utils"
+import type {
+  OrdersQueryOptions,
+  OrderV2,
+  ProtocolData,
+  SerializedOrderV2,
+} from "./types"
+
+export const DEFAULT_SEAPORT_CONTRACT_ADDRESS = CROSS_CHAIN_SEAPORT_V1_6_ADDRESS
+
+export const getPostCollectionOfferPayload = (
+  collectionSlug: string,
+  protocol_data: ProtocolData,
+  chain: Chain,
+  traitType?: string,
+  traitValue?: string,
+  traits?: Array<{ type: string; value: string }>,
+  numericTraits?: Array<{ type: string; min?: number; max?: number }>,
+) => {
+  const payload = {
+    criteria: {
+      collection: { slug: collectionSlug },
+    },
+    protocol_data,
+    protocol_address: getSeaportAddress(chain),
+  }
+
+  // Prioritize traits array if provided
+  if (traits && traits.length > 0) {
+    ;(payload.criteria as any).traits = traits
+  } else if (traitType && traitValue) {
+    // Fallback to single trait for backward compatibility
+    ;(payload.criteria as any).trait = {
+      type: traitType,
+      value: traitValue,
+    }
+  }
+  if (numericTraits && numericTraits.length > 0) {
+    ;(payload.criteria as any).numericTraits = numericTraits
+  }
+  return payload
+}
+
+export const getBuildCollectionOfferPayload = (
+  offererAddress: string,
+  quantity: number,
+  collectionSlug: string,
+  offerProtectionEnabled: boolean,
+  chain: Chain,
+  traitType?: string,
+  traitValue?: string,
+  traits?: Array<{ type: string; value: string }>,
+  numericTraits?: Array<{ type: string; min?: number; max?: number }>,
+) => {
+  const payload = {
+    offerer: offererAddress,
+    quantity,
+    criteria: {
+      collection: {
+        slug: collectionSlug,
+      },
+    },
+    protocol_address: getSeaportAddress(chain),
+    offer_protection_enabled: offerProtectionEnabled,
+  }
+
+  // Prioritize traits array if provided
+  if (traits && traits.length > 0) {
+    ;(payload.criteria as any).traits = traits
+  } else if (traitType && traitValue) {
+    // Fallback to single trait for backward compatibility
+    ;(payload.criteria as any).trait = {
+      type: traitType,
+      value: traitValue,
+    }
+  }
+  if (numericTraits && numericTraits.length > 0) {
+    ;(payload.criteria as any).numericTraits = numericTraits
+  }
+  return payload
+}
+
+export const getFulfillmentDataPath = (side: OrderSide) => {
+  const sidePath = side === OrderSide.LISTING ? "listings" : "offers"
+  return `${API_V2_PREFIX}/${sidePath}/fulfillment_data`
+}
+
+export const getFulfillListingPayload = (
+  fulfillerAddress: string,
+  order_hash: string,
+  protocolAddress: string,
+  chain: Chain,
+  assetContractAddress?: string,
+  tokenId?: string,
+  unitsToFill: string = "1",
+  recipientAddress?: string,
+  includeOptionalCreatorFees: boolean = false,
+) => {
+  const payload: {
+    listing: {
+      hash: string
+      chain: Chain
+      protocol_address: string
+    }
+    fulfiller: {
+      address: string
+    }
+    consideration?: {
+      asset_contract_address: string
+      token_id: string
+    }
+    units_to_fill: string
+    recipient?: string
+    include_optional_creator_fees: boolean
+  } = {
+    listing: {
+      hash: order_hash,
+      chain,
+      protocol_address: protocolAddress,
+    },
+    fulfiller: {
+      address: fulfillerAddress,
+    },
+    units_to_fill: unitsToFill,
+    include_optional_creator_fees: includeOptionalCreatorFees,
+  }
+
+  // Add consideration for criteria listings if needed
+  if (assetContractAddress && tokenId) {
+    payload.consideration = {
+      asset_contract_address: assetContractAddress,
+      token_id: tokenId,
+    }
+  }
+
+  // Add optional recipient for listings
+  if (recipientAddress) {
+    payload.recipient = recipientAddress
+  }
+
+  return payload
+}
+
+export const getFulfillOfferPayload = (
+  fulfillerAddress: string,
+  order_hash: string,
+  protocolAddress: string,
+  chain: Chain,
+  assetContractAddress?: string,
+  tokenId?: string,
+  unitsToFill: string = "1",
+  includeOptionalCreatorFees: boolean = false,
+) => {
+  const payload: {
+    offer: {
+      hash: string
+      chain: Chain
+      protocol_address: string
+    }
+    fulfiller: {
+      address: string
+    }
+    consideration?: {
+      asset_contract_address: string
+      token_id: string
+    }
+    units_to_fill: string
+    include_optional_creator_fees: boolean
+  } = {
+    offer: {
+      hash: order_hash,
+      chain,
+      protocol_address: protocolAddress,
+    },
+    fulfiller: {
+      address: fulfillerAddress,
+    },
+    units_to_fill: unitsToFill,
+    include_optional_creator_fees: includeOptionalCreatorFees,
+  }
+
+  // Add consideration for criteria offers (e.g., collection offers)
+  if (assetContractAddress && tokenId) {
+    payload.consideration = {
+      asset_contract_address: assetContractAddress,
+      token_id: tokenId,
+    }
+  }
+
+  return payload
+}
+
+type OrdersQueryPathOptions = "protocol" | "side"
+export const serializeOrdersQueryOptions = (
+  options: Omit<OrdersQueryOptions, OrdersQueryPathOptions>,
+) => {
+  const tokenIds =
+    options.tokenIds && options.tokenIds.length > 0
+      ? options.tokenIds
+      : options.tokenId !== undefined
+        ? [options.tokenId]
+        : options.tokenIds
+
+  return {
+    limit: options.limit,
+    cursor: options.cursor ?? options.next,
+
+    payment_token_address: options.paymentTokenAddress,
+    maker: options.maker,
+    taker: options.taker,
+    owner: options.owner,
+    listed_after: options.listedAfter,
+    listed_before: options.listedBefore,
+    token_ids: tokenIds,
+    asset_contract_address: options.assetContractAddress,
+    order_by: options.orderBy,
+    order_direction: options.orderDirection,
+    only_english: options.onlyEnglish,
+  }
+}
+
+export const deserializeOrder = (order: SerializedOrderV2): OrderV2 => {
+  return {
+    createdDate: order.created_date,
+    closingDate: order.closing_date,
+    listingTime: order.listing_time,
+    expirationTime: order.expiration_time,
+    orderHash: order.order_hash,
+    maker: accountFromJSON(order.maker),
+    taker: order.taker ? accountFromJSON(order.taker) : null,
+    protocolData: order.protocol_data,
+    protocolAddress: order.protocol_address,
+    currentPrice: BigInt(order.current_price),
+    makerFees: (order.maker_fees ?? []).map(({ account, basis_points }) => ({
+      account: accountFromJSON(account),
+      basisPoints: basis_points,
+    })),
+    takerFees: (order.taker_fees ?? []).map(({ account, basis_points }) => ({
+      account: accountFromJSON(account),
+      basisPoints: basis_points,
+    })),
+    side: order.side,
+    orderType: order.order_type,
+    cancelled: order.cancelled,
+    finalized: order.finalized,
+    markedInvalid: order.marked_invalid,
+    clientSignature: order.client_signature,
+    remainingQuantity: order.remaining_quantity,
+  }
+}