@imtbl/sdk 0.9.0 → 0.12.0-alpha

package/dist/orderbook.d.ts

@@ -0,0 +1,281 @@
+import { OrderbookOverrides, OrderbookModuleConfiguration } from 'config/config';
+import { ListingResult, ListListingsResult, Fee, OrdersService } from 'openapi/sdk';
+import { ListListingsParams as ListListingsParams$1, PrepareListingParams as PrepareListingParams$1, PrepareListingResponse as PrepareListingResponse$1, CreateListingParams as CreateListingParams$1, FulfillOrderResponse as FulfillOrderResponse$1, CancelOrderResponse as CancelOrderResponse$1 } from 'types';
+
+declare enum Environment {
+    PRODUCTION = "production",
+    SANDBOX = "sandbox"
+}
+declare class ImmutableConfiguration {
+    readonly environment: Environment;
+    readonly apiKey?: string;
+    constructor(options: {
+        environment: Environment;
+        apiKey?: string;
+    });
+}
+interface ModuleConfiguration<T> {
+    baseConfig: ImmutableConfiguration;
+    overrides?: T;
+}
+
+/**
+ * zkEVM orderbook SDK
+ * @constructor
+ * @param {OrderbookModuleConfiguration} config - Configuration for Immutable services.
+ */
+declare class Orderbook {
+    private apiClient;
+    private seaport;
+    private orderbookConfig;
+    constructor(config: ModuleConfiguration<OrderbookOverrides>);
+    /**
+     * Return the configuration for the orderbook module.
+     * @return {OrderbookModuleConfiguration} The configuration for the orderbook module.
+     */
+    config(): OrderbookModuleConfiguration;
+    /**
+     * Get an order by ID
+     * @param {string} listingId - The listingId to find.
+     * @return {ListingResult} The returned order result.
+     */
+    getListing(listingId: string): Promise<ListingResult>;
+    /**
+     * List orders. This method is used to get a list of orders filtered by conditions specified
+     * in the params object.
+     * @param {ListListingsParams} listOrderParams - Filtering, ordering and page parameters.
+     * @return {ListListingsResult} The paged orders.
+     */
+    listListings(listOrderParams: ListListingsParams$1): Promise<ListListingsResult>;
+    /**
+     * Get required transactions and messages for signing prior to creating a listing
+     * through the createListing method
+     * @param {PrepareListingParams} prepareListingParams - Details about the listing to be created.
+     * @return {PrepareListingResponse} PrepareListingResponse includes
+     * the unsigned approval transaction, the typed order message for signing and
+     * the order components that can be submitted to `createListing` with a signature.
+     */
+    prepareListing({ makerAddress, sell, buy, orderExpiry, }: PrepareListingParams$1): Promise<PrepareListingResponse$1>;
+    /**
+     * Create an order
+     * @param {CreateListingParams} createListingParams - create an order with the given params.
+     * @return {ListingResult} The result of the order created in the Immutable services.
+     */
+    createListing(createListingParams: CreateListingParams$1): Promise<ListingResult>;
+    /**
+     * Get unsigned transactions that can be submitted to fulfil an open order. If the approval
+     * transaction exists it must be signed and submitted to the chain before the fulfilment
+     * transaction can be submitted or it will be reverted.
+     * @param {string} listingId - The listingId to fulfil.
+     * @param {string} fulfillerAddress - The address of the account fulfilling the order.
+     * @return {FulfillOrderResponse} Approval and fulfilment transactions.
+     */
+    fulfillOrder(listingId: string, takerAddress: string, takerFee?: Fee): Promise<FulfillOrderResponse$1>;
+    /**
+     * Get an unsigned cancel order transaction. Orders can only be cancelled by
+     * the account that created them.
+     * @param {string} listingId - The listingId to cancel.
+     * @param {string} accountAddress - The address of the account cancelling the order.
+     * @return {CancelOrderResponse} The unsigned cancel order transaction
+     */
+    cancelOrder(listingId: string, accountAddress: string): Promise<CancelOrderResponse$1>;
+}
+
+declare const constants: {
+    estimatedFulfillmentGasGwei: number;
+};
+
+declare type Bytes = ArrayLike<number>;
+declare type BytesLike = Bytes | string;
+interface Hexable {
+    toHexString(): string;
+}
+
+declare type BigNumberish = BigNumber | Bytes | bigint | string | number;
+declare class BigNumber implements Hexable {
+    readonly _hex: string;
+    readonly _isBigNumber: boolean;
+    constructor(constructorGuard: any, hex: string);
+    fromTwos(value: number): BigNumber;
+    toTwos(value: number): BigNumber;
+    abs(): BigNumber;
+    add(other: BigNumberish): BigNumber;
+    sub(other: BigNumberish): BigNumber;
+    div(other: BigNumberish): BigNumber;
+    mul(other: BigNumberish): BigNumber;
+    mod(other: BigNumberish): BigNumber;
+    pow(other: BigNumberish): BigNumber;
+    and(other: BigNumberish): BigNumber;
+    or(other: BigNumberish): BigNumber;
+    xor(other: BigNumberish): BigNumber;
+    mask(value: number): BigNumber;
+    shl(value: number): BigNumber;
+    shr(value: number): BigNumber;
+    eq(other: BigNumberish): boolean;
+    lt(other: BigNumberish): boolean;
+    lte(other: BigNumberish): boolean;
+    gt(other: BigNumberish): boolean;
+    gte(other: BigNumberish): boolean;
+    isNegative(): boolean;
+    isZero(): boolean;
+    toNumber(): number;
+    toBigInt(): bigint;
+    toString(): string;
+    toHexString(): string;
+    toJSON(key?: string): any;
+    static from(value: any): BigNumber;
+    static isBigNumber(value: any): value is BigNumber;
+}
+
+declare type AccessList = Array<{
+    address: string;
+    storageKeys: Array<string>;
+}>;
+
+interface TypedDataDomain {
+    name?: string;
+    version?: string;
+    chainId?: BigNumberish;
+    verifyingContract?: string;
+    salt?: BytesLike;
+}
+interface TypedDataField {
+    name: string;
+    type: string;
+}
+
+interface PopulatedTransaction {
+    to?: string;
+    from?: string;
+    nonce?: number;
+    gasLimit?: BigNumber;
+    gasPrice?: BigNumber;
+    data?: string;
+    value?: BigNumber;
+    chainId?: number;
+    type?: number;
+    accessList?: AccessList;
+    maxFeePerGas?: BigNumber;
+    maxPriorityFeePerGas?: BigNumber;
+    customData?: Record<string, any>;
+    ccipReadEnabled?: boolean;
+}
+
+declare enum OrderType {
+    FULL_OPEN = 0,
+    PARTIAL_OPEN = 1,
+    FULL_RESTRICTED = 2,
+    PARTIAL_RESTRICTED = 3
+}
+declare enum ItemType {
+    NATIVE = 0,
+    ERC20 = 1,
+    ERC721 = 2,
+    ERC1155 = 3,
+    ERC721_WITH_CRITERIA = 4,
+    ERC1155_WITH_CRITERIA = 5
+}
+
+type OfferItem = {
+    itemType: ItemType;
+    token: string;
+    identifierOrCriteria: string;
+    startAmount: string;
+    endAmount: string;
+};
+type ConsiderationItem = {
+    itemType: ItemType;
+    token: string;
+    identifierOrCriteria: string;
+    startAmount: string;
+    endAmount: string;
+    recipient: string;
+};
+type OrderParameters = {
+    offerer: string;
+    zone: string;
+    orderType: OrderType;
+    startTime: BigNumberish;
+    endTime: BigNumberish;
+    zoneHash: string;
+    salt: string;
+    offer: OfferItem[];
+    consideration: ConsiderationItem[];
+    totalOriginalConsiderationItems: BigNumberish;
+    conduitKey: string;
+};
+type OrderComponents = OrderParameters & {
+    counter: BigNumberish;
+};
+
+interface ERC721Item {
+    type: 'ERC721';
+    contractAddress: string;
+    tokenId: string;
+}
+interface ERC20Item {
+    type: 'ERC20';
+    contractAddress: string;
+    amount: string;
+}
+interface NativeItem {
+    type: 'NATIVE';
+    amount: string;
+}
+interface RoyaltyInfo {
+    recipient: string;
+    amountRequired: string;
+}
+interface PrepareListingParams {
+    makerAddress: string;
+    sell: ERC721Item;
+    buy: ERC20Item | NativeItem;
+    orderExpiry?: Date;
+}
+interface PrepareListingResponse {
+    actions: Action[];
+    orderComponents: OrderComponents;
+    orderHash: string;
+}
+interface CreateListingParams {
+    orderComponents: OrderComponents;
+    orderHash: string;
+    orderSignature: string;
+    makerFee?: Fee;
+}
+type ListListingsParams = Omit<Parameters<typeof OrdersService.prototype.listListings>[0], 'chainName'>;
+declare enum TransactionPurpose {
+    APPROVAL = "APPROVAL",
+    FULFILL_ORDER = "FULFILL_ORDER"
+}
+declare enum SignablePurpose {
+    CREATE_LISTING = "CREATE_LISTING"
+}
+declare enum ActionType {
+    TRANSACTION = "TRANSACTION",
+    SIGNABLE = "SIGNABLE"
+}
+type TransactionBuilder = () => Promise<PopulatedTransaction>;
+interface TransactionAction {
+    type: ActionType.TRANSACTION;
+    purpose: TransactionPurpose;
+    buildTransaction: TransactionBuilder;
+}
+interface SignableAction {
+    type: ActionType.SIGNABLE;
+    purpose: SignablePurpose;
+    message: {
+        domain: TypedDataDomain;
+        types: Record<string, TypedDataField[]>;
+        value: Record<string, any>;
+    };
+}
+type Action = TransactionAction | SignableAction;
+interface FulfillOrderResponse {
+    actions: Action[];
+}
+interface CancelOrderResponse {
+    unsignedCancelOrderTransaction: PopulatedTransaction;
+}
+
+export { Action, ActionType, CancelOrderResponse, CreateListingParams, ERC20Item, ERC721Item, FulfillOrderResponse, ListListingsParams, NativeItem, Orderbook, PrepareListingParams, PrepareListingResponse, RoyaltyInfo, SignableAction, SignablePurpose, TransactionAction, TransactionBuilder, TransactionPurpose, constants };