@imtbl/orderbook 2.0.0-alpha.0

package/dist/types/types.d.ts

@@ -0,0 +1,367 @@
+import type { OrderComponents } from '@opensea/seaport-js/lib/types';
+import { PreparedTransactionRequest, TypedDataDomain, TypedDataField } from 'ethers';
+import { OrdersService, OrderStatus } from './openapi/sdk';
+export { OrderStatusName } from './openapi/sdk';
+export interface NativeItem {
+    type: 'NATIVE';
+    amount: string;
+}
+export interface ERC20Item {
+    type: 'ERC20';
+    contractAddress: string;
+    amount: string;
+}
+export interface ERC721Item {
+    type: 'ERC721';
+    contractAddress: string;
+    tokenId: string;
+}
+export interface ERC1155Item {
+    type: 'ERC1155';
+    contractAddress: string;
+    tokenId: string;
+    amount: string;
+}
+export interface ERC721CollectionItem {
+    type: 'ERC721_COLLECTION';
+    contractAddress: string;
+    amount: string;
+}
+export interface ERC1155CollectionItem {
+    type: 'ERC1155_COLLECTION';
+    contractAddress: string;
+    amount: string;
+}
+export type Order = Listing | Bid | CollectionBid;
+export interface Listing extends OrderFields {
+    type: 'LISTING';
+    sell: (ERC721Item | ERC1155Item)[];
+    buy: (NativeItem | ERC20Item)[];
+}
+export interface Bid extends OrderFields {
+    type: 'BID';
+    sell: ERC20Item[];
+    buy: (ERC721Item | ERC1155Item)[];
+}
+export interface CollectionBid extends OrderFields {
+    type: 'COLLECTION_BID';
+    sell: ERC20Item[];
+    buy: (ERC721CollectionItem | ERC1155CollectionItem)[];
+}
+interface OrderFields {
+    id: string;
+    chain: {
+        id: string;
+        name: string;
+    };
+    accountAddress: string;
+    fees: Fee[];
+    status: OrderStatus;
+    fillStatus: {
+        numerator: string;
+        denominator: string;
+    };
+    /**
+     * Time after which the Order is considered active
+     */
+    startAt: string;
+    /**
+     * Time after which the Order is expired
+     */
+    endAt: string;
+    salt: string;
+    signature: string;
+    orderHash: string;
+    protocolData: {
+        orderType: 'FULL_RESTRICTED' | 'PARTIAL_RESTRICTED';
+        zoneAddress: string;
+        counter: string;
+        seaportAddress: string;
+        seaportVersion: string;
+    };
+    createdAt: string;
+    updatedAt: string;
+}
+export interface Trade {
+    id: string;
+    orderId: string;
+    chain: {
+        id: string;
+        name: string;
+    };
+    buy: (NativeItem | ERC20Item | ERC721Item | ERC1155Item)[];
+    sell: (ERC20Item | ERC721Item | ERC1155Item)[];
+    /**
+     * @deprecated Use {@linkcode Fees} instead (taker always pays the fees)
+     */
+    buyerFees: Fee[];
+    /**
+     * @deprecated Use {@linkcode makerAddress} or {@linkcode takerAddress} instead
+     */
+    sellerAddress: string;
+    /**
+     * @deprecated Use {@linkcode makerAddress} or {@linkcode takerAddress} instead
+     */
+    buyerAddress: string;
+    makerAddress: string;
+    takerAddress: string;
+    /**
+     * Fees paid by the taker of the trade
+     */
+    fees: Fee[];
+    /**
+     * 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;
+    };
+}
+export interface Fee extends FeeValue {
+    type: FeeType;
+}
+export interface FeeValue {
+    recipientAddress: string;
+    amount: string;
+}
+export declare enum FeeType {
+    MAKER_ECOSYSTEM = "MAKER_ECOSYSTEM",
+    TAKER_ECOSYSTEM = "TAKER_ECOSYSTEM",
+    PROTOCOL = "PROTOCOL",
+    ROYALTY = "ROYALTY"
+}
+export interface PrepareOrderResponse {
+    actions: Action[];
+    orderComponents: OrderComponents;
+    orderHash: string;
+}
+export type ListListingsParams = Omit<Parameters<typeof OrdersService.prototype.listListings>[0], 'chainName'>;
+export interface ListingResult {
+    result: Listing;
+}
+export interface ListListingsResult {
+    page: Page;
+    result: Listing[];
+}
+export interface PrepareListingParams {
+    makerAddress: string;
+    sell: ERC721Item | ERC1155Item;
+    buy: NativeItem | ERC20Item;
+    orderStart?: Date;
+    orderExpiry?: Date;
+}
+export type PrepareListingResponse = PrepareOrderResponse;
+export interface PrepareBulkListingsParams {
+    makerAddress: string;
+    listingParams: {
+        sell: ERC721Item | ERC1155Item;
+        buy: NativeItem | ERC20Item;
+        makerFees: FeeValue[];
+        orderStart?: Date;
+        orderExpiry?: Date;
+    }[];
+}
+export interface PrepareBulkListingsResponse {
+    actions: Action[];
+    completeListings(signatures: string[]): Promise<BulkListingsResult>;
+    /**
+     * @deprecated Pass a `string[]` to {@linkcode completeListings} instead to enable
+     * smart contract wallets
+     */
+    completeListings(signature: string): Promise<BulkListingsResult>;
+}
+export interface CreateListingParams {
+    orderComponents: OrderComponents;
+    orderHash: string;
+    orderSignature: string;
+    makerFees: FeeValue[];
+}
+export interface BulkListingsResult {
+    result: {
+        success: boolean;
+        orderHash: string;
+        order?: Listing;
+    }[];
+}
+export type ListBidsParams = Omit<Parameters<typeof OrdersService.prototype.listBids>[0], 'chainName'>;
+export interface BidResult {
+    result: Bid;
+}
+export interface ListBidsResult {
+    page: Page;
+    result: Bid[];
+}
+export interface PrepareBidParams {
+    makerAddress: string;
+    sell: ERC20Item;
+    buy: ERC721Item | ERC1155Item;
+    orderStart?: Date;
+    orderExpiry?: Date;
+}
+export type PrepareBidResponse = PrepareOrderResponse;
+export interface CreateBidParams {
+    orderComponents: OrderComponents;
+    orderHash: string;
+    orderSignature: string;
+    makerFees: FeeValue[];
+}
+export interface BulkBidsResult {
+    result: {
+        success: boolean;
+        orderHash: string;
+        order?: Bid;
+    }[];
+}
+export type ListCollectionBidsParams = Omit<Parameters<typeof OrdersService.prototype.listCollectionBids>[0], 'chainName'>;
+export interface CollectionBidResult {
+    result: CollectionBid;
+}
+export interface ListCollectionBidsResult {
+    page: Page;
+    result: CollectionBid[];
+}
+export interface PrepareCollectionBidParams {
+    makerAddress: string;
+    sell: ERC20Item;
+    buy: ERC721CollectionItem | ERC1155CollectionItem;
+    orderStart?: Date;
+    orderExpiry?: Date;
+}
+export type PrepareCollectionBidResponse = PrepareOrderResponse;
+export interface CreateCollectionBidParams {
+    orderComponents: OrderComponents;
+    orderHash: string;
+    orderSignature: string;
+    makerFees: FeeValue[];
+}
+export interface BulkCollectionBidsResult {
+    result: {
+        success: boolean;
+        orderHash: string;
+        order?: CollectionBid;
+    }[];
+}
+export interface FulfillmentOrder {
+    orderId: string;
+    takerFees: FeeValue[];
+    amountToFill?: string;
+    tokenId?: string;
+}
+/**
+ * @deprecated Use {@linkcode FulfillmentOrder} instead
+ */
+export interface FulfillmentListing {
+    listingId: string;
+    takerFees: FeeValue[];
+    amountToFill?: string;
+}
+export type FulfillBulkOrdersResponse = FulfillBulkOrdersInsufficientBalanceResponse | FulfillBulkOrdersSufficientBalanceResponse;
+export interface FulfillBulkOrdersSufficientBalanceResponse {
+    sufficientBalance: true;
+    actions: Action[];
+    expiration: string;
+    fulfillableOrders: Order[];
+    unfulfillableOrders: UnfulfillableOrder[];
+}
+export interface FulfillBulkOrdersInsufficientBalanceResponse {
+    sufficientBalance: false;
+    fulfillableOrders: Order[];
+    unfulfillableOrders: UnfulfillableOrder[];
+}
+export interface FulfillOrderResponse {
+    actions: Action[];
+    /**
+     * User MUST submit the fulfillment transaction before the expiration
+     * Submitting after the expiration will result in a on chain revert
+     */
+    expiration: string;
+    order: Order;
+}
+export interface UnfulfillableOrder {
+    orderId: string;
+    tokenId?: string;
+    reason: string;
+}
+export interface PrepareCancelOrdersResponse {
+    signableAction: SignableAction;
+}
+export interface CancelOrdersOnChainResponse {
+    cancellationAction: TransactionAction;
+}
+export type ListTradesParams = Omit<Parameters<typeof OrdersService.prototype.listTrades>[0], 'chainName'>;
+export interface TradeResult {
+    result: Trade;
+}
+export interface ListTradesResult {
+    page: Page;
+    result: Trade[];
+}
+export type Action = TransactionAction | SignableAction;
+export declare enum ActionType {
+    TRANSACTION = "TRANSACTION",
+    SIGNABLE = "SIGNABLE"
+}
+export interface TransactionAction {
+    type: ActionType.TRANSACTION;
+    purpose: TransactionPurpose;
+    buildTransaction: TransactionBuilder;
+}
+export declare enum TransactionPurpose {
+    APPROVAL = "APPROVAL",
+    FULFILL_ORDER = "FULFILL_ORDER",
+    CANCEL = "CANCEL"
+}
+export type TransactionBuilder = () => Promise<PreparedTransactionRequest>;
+export interface SignableAction {
+    type: ActionType.SIGNABLE;
+    purpose: SignablePurpose;
+    message: {
+        domain: TypedDataDomain;
+        types: Record<string, TypedDataField[]>;
+        value: Record<string, any>;
+    };
+}
+export declare enum SignablePurpose {
+    /**
+     * @deprecated Use {@linkcode CREATE_ORDER} instead
+     */
+    CREATE_LISTING = "CREATE_ORDER",
+    CREATE_ORDER = "CREATE_ORDER",
+    OFF_CHAIN_CANCELLATION = "OFF_CHAIN_CANCELLATION"
+}
+export interface RoyaltyInfo {
+    recipient: string;
+    amountRequired: string;
+}
+export interface Page {
+    /**
+     * First item as an encoded string
+     */
+    previousCursor: string | null;
+    /**
+     * Last item as an encoded string
+     */
+    nextCursor: string | null;
+}
+export interface PrepareBulkSeaportOrders {
+    actions: Action[];
+    preparedOrders: {
+        orderComponents: OrderComponents;
+        orderHash: string;
+    }[];
+}

package/dist/types/utils.d.ts

@@ -0,0 +1 @@
+export declare function exhaustiveSwitch(param: never): never;

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@imtbl/orderbook",
+  "version": "2.0.0-alpha.0",
+  "author": "Immutable",
+  "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
+  "dependencies": {
+    "@imtbl/config": "2.0.0-alpha.0",
+    "@imtbl/metrics": "2.0.0-alpha.0",
+    "@opensea/seaport-js": "4.0.3",
+    "axios": "^1.6.5",
+    "ethers": "^6.13.4",
+    "form-data": "^4.0.0",
+    "merkletreejs": "^0.3.11"
+  },
+  "devDependencies": {
+    "@swc/core": "^1.3.36",
+    "@swc/jest": "^0.2.24",
+    "@typechain/ethers-v6": "^0.5.1",
+    "@types/jest": "^29.4.3",
+    "dotenv": "^16.0.3",
+    "eslint": "^8.40.0",
+    "jest": "^29.4.3",
+    "jest-environment-jsdom": "^29.4.3",
+    "ts-mockito": "^2.6.1",
+    "tsup": "^8.3.5",
+    "typechain": "^8.1.1",
+    "typescript": "^5.6.2"
+  },
+  "exports": {
+    "development": {
+      "types": "./src/index.ts",
+      "browser": "./dist/browser/index.js",
+      "require": "./dist/node/index.cjs",
+      "default": "./dist/node/index.js"
+    },
+    "default": {
+      "types": "./dist/types/index.d.ts",
+      "browser": "./dist/browser/index.js",
+      "require": "./dist/node/index.cjs",
+      "default": "./dist/node/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://github.com/immutable/ts-immutable-sdk#readme",
+  "license": "Apache-2.0",
+  "main": "dist/node/index.cjs",
+  "module": "dist/node/index.js",
+  "browser": "dist/browser/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": "immutable/ts-immutable-sdk.git",
+  "type": "module",
+  "types": "./dist/types/index.d.ts",
+  "scripts": {
+    "build": "pnpm transpile && pnpm typegen",
+    "transpile": "tsup src/index.ts --config ../../tsup.config.js",
+    "typegen": "tsc --customConditions default --emitDeclarationOnly --outDir dist/types",
+    "generate-types": "typechain --target=ethers-v6 --out-dir=src/typechain/types 'abi/*.json'",
+    "lint": "eslint ./src --ext .ts,.jsx,.tsx --max-warnings=0",
+    "lint:fix": "eslint ./src --ext .ts,.jsx,.tsx --max-warnings=0 --fix",
+    "run:demo": "jest --runInBand --testMatch \"**/?(*.)+(demo).[jt]s?(x)\"",
+    "run:demo-expiry": "jest  --runInBand --testMatch \"**/(expiry.demo).[jt]s?(x)\"",
+    "run:demo-fulfill": "jest --runInBand --testMatch \"**/(fulfill.demo).[jt]s?(x)\"",
+    "run:demo-fulfill-bulk": "jest --runInBand --testMatch \"**/(fulfillBulk.demo).[jt]s?(x)\"",
+    "test": "jest",
+    "test:e2e": "jest --runInBand --testMatch \"**/?(*.)+(e2e).[jt]s?(x)\"",
+    "test:watch": "jest --watch",
+    "typecheck": "tsc --customConditions default --noEmit --jsx preserve"
+  }
+}