@opensea/sdk 9.0.0

package/src/constants.ts

@@ -0,0 +1,90 @@
+import { FixedNumber } from "ethers"
+
+// =============================================================================
+// Math & Calculation Constants
+// =============================================================================
+
+export const FIXED_NUMBER_100 = FixedNumber.fromValue(100)
+export const INVERSE_BASIS_POINT = 10_000n // 100 basis points per 1%
+
+// =============================================================================
+// API Configuration
+// =============================================================================
+
+export const API_BASE_MAINNET = "https://api.opensea.io"
+
+// =============================================================================
+// OpenSea Protocol Addresses
+// =============================================================================
+
+export const OPENSEA_FEE_RECIPIENT =
+  "0x0000a26b00c1f0df003000390027140000faa719"
+
+export const OPENSEA_CONDUIT_KEY =
+  "0x0000007b02230091a7ed01230072f7006a004d60a8d4e71d599b8104250f0000"
+
+export const OPENSEA_CONDUIT_ADDRESS =
+  "0x1e0049783f008a0085193e00003d00cd54003c71"
+
+export const OPENSEA_CONDUIT_KEY_2 =
+  "0x61159fefdfada89302ed55f8b9e89e2d67d8258712b3a3f89aa88525877f1d5e"
+
+export const OPENSEA_CONDUIT_ADDRESS_2 =
+  "0x963f00d3ff000064ffcba824b800c0000000c300"
+
+export const OPENSEA_SIGNED_ZONE_V2 =
+  "0x000056f7000000ece9003ca63978907a00ffd100"
+
+// =============================================================================
+// Alternate Protocol Constants (shared by Gunzilla, Somnia, etc.)
+// =============================================================================
+
+export const ALTERNATE_CONDUIT_ADDRESS =
+  "0x00000000001566479594a2e05532d81afa09bc52"
+
+export const ALTERNATE_CONDUIT_KEY =
+  "0x86d26897267711ea4b173c8c124a0a73612001da35562f1ee3b26929b6575e89"
+
+export const ALTERNATE_SEAPORT_V1_6_ADDRESS =
+  "0x00000000006687982678b03100B9bDC8be440814"
+
+export const ALTERNATE_SIGNED_ZONE_V2_ADDRESS =
+  "0xdfe0000000005ce3008800300037e4c803ed08c7"
+
+// =============================================================================
+// Chain-Specific Fee Recipients
+// =============================================================================
+
+export const GUNZILLA_FEE_RECIPIENT =
+  "0xd9f68d28e451a83affdb7c71cc2c20552555b07f"
+
+export const SOMNIA_FEE_RECIPIENT = "0xdfe1593dca6ad8a20eeb418643e48577c1626f7c"
+
+export const ALTERNATE_FEE_RECIPIENT =
+  "0x07d3a100c3880830dd43fe5c938b5144721ce9d6"
+
+// =============================================================================
+// Token & Helper Addresses
+// =============================================================================
+
+export const WPOL_ADDRESS = "0x0d500B1d8E8eF31E21C99d1Db9A6444d3ADf1270"
+
+export const MULTICALL3_ADDRESS = "0xcA11bde05977b3631167028862bE2a173976CA11"
+
+export const TRANSFER_HELPER_ADDRESS =
+  "0x0000000000c2d145a2526bd8c716263bfebe1a72"
+
+// =============================================================================
+// Shared Storefront Addresses
+// =============================================================================
+
+const SHARED_STOREFRONT_ADDRESS_MAINNET =
+  "0x495f947276749ce646f68ac8c248420045cb7b5e"
+const SHARED_STOREFRONT_ADDRESS_POLYGON =
+  "0x2953399124f0cbb46d2cbacd8a89cf0599974963"
+export const SHARED_STOREFRONT_ADDRESSES = new Set([
+  SHARED_STOREFRONT_ADDRESS_MAINNET,
+  SHARED_STOREFRONT_ADDRESS_POLYGON,
+])
+export const SHARED_STOREFRONT_LAZY_MINT_ADAPTER_CROSS_CHAIN_ADDRESS =
+  "0xa604060890923ff400e8c6f5290461a83aedacec"

package/src/index.ts

@@ -0,0 +1,22 @@
+import { OpenSeaSDK } from "./sdk"
+
+export * from "./api/types"
+export * from "./orders/types"
+export * from "./types"
+export * from "./utils"
+/**
+ * @example
+ * // Example Setup
+ * ```ts
+ * import { ethers } from 'ethers'
+ * import { OpenSeaSDK, Chain } from 'opensea-js'
+ * const provider = new ethers.JsonRpcProvider('https://mainnet.infura.io')
+ * const client = new OpenSeaSDK(provider, {
+ *   chain: Chain.Mainnet
+ * })
+ * ```
+ */
+export {
+  // Main SDK export
+  OpenSeaSDK,
+}

package/src/orders/privateListings.ts

@@ -0,0 +1,173 @@
+import { ItemType } from "@opensea/seaport-js/lib/constants"
+import type {
+  ConsiderationInputItem,
+  CreateInputItem,
+  MatchOrdersFulfillment,
+  Order,
+  OrderWithCounter,
+} from "@opensea/seaport-js/lib/types"
+import { isCurrencyItem } from "@opensea/seaport-js/lib/utils/item"
+import { generateRandomSalt } from "@opensea/seaport-js/lib/utils/order"
+import { ZeroAddress } from "ethers"
+
+/**
+ * Compute the native currency (ETH) value required to fulfill a private listing.
+ * Sums all native currency consideration items not going to the taker.
+ * @param order The private listing order
+ * @param takerAddress The address of the private listing recipient
+ * @returns The total native currency value as a bigint
+ */
+export const computePrivateListingValue = (
+  order: OrderWithCounter,
+  takerAddress: string,
+): bigint => {
+  return order.parameters.consideration
+    .filter(
+      item =>
+        item.recipient.toLowerCase() !== takerAddress.toLowerCase() &&
+        item.token.toLowerCase() === ZeroAddress.toLowerCase() &&
+        item.itemType === ItemType.NATIVE,
+    )
+    .reduce((sum, item) => sum + BigInt(item.startAmount), 0n)
+}
+
+export const getPrivateListingConsiderations = (
+  offer: CreateInputItem[],
+  privateSaleRecipient: string,
+): ConsiderationInputItem[] => {
+  return offer.map(item => {
+    return { ...item, recipient: privateSaleRecipient }
+  })
+}
+
+export const constructPrivateListingCounterOrder = (
+  order: OrderWithCounter,
+  privateSaleRecipient: string,
+): Order => {
+  // Counter order offers up all the items in the private listing consideration
+  // besides the items that are going to the private listing recipient
+  const paymentItems = order.parameters.consideration.filter(
+    item => item.recipient.toLowerCase() !== privateSaleRecipient.toLowerCase(),
+  )
+
+  // Only validate payment items if there are any (zero-payment private listings are valid)
+  if (paymentItems.length > 0) {
+    if (!paymentItems.every(item => isCurrencyItem(item))) {
+      throw new Error(
+        "The consideration for the private listing did not contain only currency items",
+      )
+    }
+    if (
+      !paymentItems.every(item => item.itemType === paymentItems[0].itemType)
+    ) {
+      throw new Error("Not all currency items were the same for private order")
+    }
+  }
+
+  const { aggregatedStartAmount, aggregatedEndAmount } = paymentItems.reduce(
+    ({ aggregatedStartAmount, aggregatedEndAmount }, item) => ({
+      aggregatedStartAmount: aggregatedStartAmount + BigInt(item.startAmount),
+      aggregatedEndAmount: aggregatedEndAmount + BigInt(item.endAmount),
+    }),
+    {
+      aggregatedStartAmount: 0n,
+      aggregatedEndAmount: 0n,
+    },
+  )
+
+  const counterOrder: Order = {
+    parameters: {
+      ...order.parameters,
+      offerer: privateSaleRecipient,
+      // Empty offer for zero-payment private listings, single aggregated item otherwise
+      offer:
+        paymentItems.length > 0
+          ? [
+              {
+                itemType: paymentItems[0].itemType,
+                token: paymentItems[0].token,
+                identifierOrCriteria: paymentItems[0].identifierOrCriteria,
+                startAmount: aggregatedStartAmount.toString(),
+                endAmount: aggregatedEndAmount.toString(),
+              },
+            ]
+          : [],
+      // The consideration here is empty as the original private listing order supplies
+      // the taker address to receive the desired items.
+      consideration: [],
+      salt: generateRandomSalt(),
+      totalOriginalConsiderationItems: 0,
+    },
+    signature: "0x",
+  }
+
+  return counterOrder
+}
+
+export const getPrivateListingFulfillments = (
+  privateListingOrder: OrderWithCounter,
+): MatchOrdersFulfillment[] => {
+  const nftRelatedFulfillments: MatchOrdersFulfillment[] = []
+
+  // For the original order, we need to match everything offered with every consideration item
+  // on the original order that's set to go to the private listing recipient
+  privateListingOrder.parameters.offer.forEach((offerItem, offerIndex) => {
+    const considerationIndex =
+      privateListingOrder.parameters.consideration.findIndex(
+        considerationItem =>
+          considerationItem.itemType === offerItem.itemType &&
+          considerationItem.token === offerItem.token &&
+          considerationItem.identifierOrCriteria ===
+            offerItem.identifierOrCriteria,
+      )
+    if (considerationIndex === -1) {
+      throw new Error(
+        "Could not find matching offer item in the consideration for private listing",
+      )
+    }
+    nftRelatedFulfillments.push({
+      offerComponents: [
+        {
+          orderIndex: 0,
+          itemIndex: offerIndex,
+        },
+      ],
+      considerationComponents: [
+        {
+          orderIndex: 0,
+          itemIndex: considerationIndex,
+        },
+      ],
+    })
+  })
+
+  const currencyRelatedFulfillments: MatchOrdersFulfillment[] = []
+
+  // For the original order, we need to match everything offered with every consideration item
+  // on the original order that's set to go to the private listing recipient
+  privateListingOrder.parameters.consideration.forEach(
+    (considerationItem, considerationIndex) => {
+      if (!isCurrencyItem(considerationItem)) {
+        return
+      }
+      // We always match the offer item (index 0) of the counter order (index 1)
+      // with all of the payment items on the private listing
+      currencyRelatedFulfillments.push({
+        offerComponents: [
+          {
+            orderIndex: 1,
+            itemIndex: 0,
+          },
+        ],
+        considerationComponents: [
+          {
+            orderIndex: 0,
+            itemIndex: considerationIndex,
+          },
+        ],
+      })
+    },
+  )
+
+  return [...nftRelatedFulfillments, ...currencyRelatedFulfillments]
+}

package/src/orders/types.ts

@@ -0,0 +1,191 @@
+import type { BasicOrderParametersStruct } from "@opensea/seaport-js/lib/typechain-types/seaport/contracts/Seaport"
+import type {
+  AdvancedOrder,
+  OrderWithCounter,
+} from "@opensea/seaport-js/lib/types"
+import type { Listing, Offer } from "../api/types"
+import type { OpenSeaAccount, OrderSide } from "../types"
+
+// Protocol data
+type OrderProtocolToProtocolData = {
+  seaport: OrderWithCounter
+}
+export type OrderProtocol = keyof OrderProtocolToProtocolData
+export type ProtocolData =
+  OrderProtocolToProtocolData[keyof OrderProtocolToProtocolData]
+
+export enum OrderType {
+  BASIC = "basic",
+  ENGLISH = "english",
+  CRITERIA = "criteria",
+}
+
+type OrderFee = {
+  account: OpenSeaAccount
+  basisPoints: string
+}
+
+/**
+ * The latest OpenSea Order schema.
+ */
+export type OrderV2 = {
+  /** The date the order was created. */
+  createdDate: string
+  /** The date the order was closed. */
+  closingDate: string | null
+  /** The date the order was listed. Order can be created before the listing time. */
+  listingTime: number
+  /** The date the order expires. */
+  expirationTime: number
+  /** The hash of the order. */
+  orderHash: string | null
+  /** The account that created the order. */
+  maker: OpenSeaAccount
+  /** The account that filled the order. */
+  taker: OpenSeaAccount | null
+  /** The protocol data for the order. Only 'seaport' is currently supported. */
+  protocolData: ProtocolData
+  /** The contract address of the protocol. */
+  protocolAddress: string
+  /** The current price of the order. */
+  currentPrice: bigint
+  /** The maker fees for the order. */
+  makerFees: OrderFee[]
+  /** The taker fees for the order. */
+  takerFees: OrderFee[]
+  /** The side of the order. Listing/Offer */
+  side: OrderSide
+  /** The type of the order. Basic/English/Criteria */
+  orderType: OrderType
+  /** Whether or not the maker has cancelled the order. */
+  cancelled: boolean
+  /** Whether or not the order is finalized. */
+  finalized: boolean
+  /** Whether or not the order is marked invalid and therefore not fillable. */
+  markedInvalid: boolean
+  /** The signature the order is signed with. */
+  clientSignature: string | null
+  /** Amount of items left in the order which can be taken. */
+  remainingQuantity: number
+}
+
+export type FulfillmentDataResponse = {
+  protocol: string
+  fulfillment_data: FulfillmentData
+}
+
+type FulfillmentData = {
+  transaction: Transaction
+  orders: ProtocolData[]
+}
+
+type Transaction = {
+  function: string
+  chain: number
+  to: string
+  value: string
+  input_data:
+    | {
+        // For fulfillAdvancedOrder
+        advancedOrder: AdvancedOrder
+        criteriaResolvers?: unknown[]
+        fulfillerConduitKey?: string
+        recipient: string
+      }
+    | {
+        // For fulfillBasicOrder
+        basicOrderParameters: BasicOrderParametersStruct
+      }
+    | {
+        // For fulfillOrder
+        order: OrderWithCounter
+        fulfillerConduitKey?: string
+        recipient: string
+      }
+    | {
+        // Legacy: for backward compatibility
+        orders:
+          | OrderWithCounter[]
+          | AdvancedOrder[]
+          | BasicOrderParametersStruct[]
+      }
+}
+
+// API query types
+type OpenOrderOrderingOption = "created_date" | "eth_price"
+type OrderByDirection = "asc" | "desc"
+
+export type OrderAPIOptions = {
+  protocol?: OrderProtocol
+  protocolAddress?: string
+  side: OrderSide
+}
+
+export type OrdersQueryOptions = OrderAPIOptions & {
+  limit?: number
+  cursor?: string
+  next?: string
+
+  paymentTokenAddress?: string
+  maker?: string
+  taker?: string
+  owner?: string
+  listedAfter?: number | string
+  listedBefore?: number | string
+  tokenId?: string
+  tokenIds?: string[]
+  assetContractAddress?: string
+  orderBy?: OpenOrderOrderingOption
+  orderDirection?: OrderByDirection
+  onlyEnglish?: boolean
+}
+
+export 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
+  remaining_quantity: number
+}
+
+export type QueryCursors = {
+  next: string | null
+  previous: string | null
+}
+
+export type OrdersQueryResponse = QueryCursors & {
+  orders: SerializedOrderV2[]
+}
+
+/** @deprecated Use ListingPostQueryResponse or OfferPostQueryResponse instead. */
+export type OrdersPostQueryResponse = { order: SerializedOrderV2 }
+
+export type ListingPostQueryResponse = {
+  order: SerializedOrderV2
+  listing: Listing
+}
+
+export type OfferPostQueryResponse = {
+  order: SerializedOrderV2
+  offer: Offer
+}