@hypercerts-org/marketplace-sdk 0.0.1

package/dist/types.d.ts

@@ -0,0 +1,242 @@
+import { BigNumberish, BytesLike, Overrides, TypedDataField, ContractTransactionResponse } from "ethers";
+import { Eip712MakerMerkleTree } from "./utils/Eip712MakerMerkleTree";
+/** Addresses used to create a LooksRare instance */
+export interface Addresses {
+    LOOKS: string;
+    EXCHANGE_V2: string;
+    TRANSFER_MANAGER_V2: string;
+    WETH: string;
+    ORDER_VALIDATOR_V2: string;
+    REVERSE_RECORDS: string;
+    LOOKS_LP_V3: string;
+    STAKING_POOL_FOR_LOOKS_LP: string;
+    AGGREGATOR_UNISWAP_V3: string;
+}
+/** List of supported chains */
+export declare enum ChainId {
+    GOERLI = 5,
+    SEPOLIA = 11155111,
+    HARDHAT = 31337
+}
+/** ChainInfo data used to interact with LooksRare ecosystem */
+export interface ChainInfo {
+    label: string;
+    appUrl: string;
+    rpcUrl: string;
+    explorer: string;
+    baseApiUrl: string;
+    osApiUrl: string;
+    cdnUrl: string;
+    rewardsSubgraphUrl: string;
+    cloudinaryUrl: string;
+    wsUrl: string;
+}
+/** List of collection types supported by the protocol */
+export declare enum CollectionType {
+    ERC721 = 0,
+    ERC1155 = 1,
+    HYPERCERT = 2,
+    HYPERBOARD = 3
+}
+/** List of trading strategies */
+export declare enum StrategyType {
+    standard = 0,
+    collection = 1,
+    collectionWithMerkleTree = 2
+}
+/** Type for maker order */
+export declare enum QuoteType {
+    Bid = 0,
+    Ask = 1
+}
+/** Solidity types (used for EIP-712 types) */
+export type SolidityType = "bool" | "address" | "uint8" | "uint16" | "uint112" | "uint256" | "uint256[]" | "bytes" | "bytes32" | "bytes32[]" | "string";
+/** EIP712 type data */
+export type EIP712TypedData = Record<string, Array<TypedDataField>>;
+/**
+ * Item structure used for batch transfers
+ * @see {@link https://github.com/LooksRare/contracts-exchange-v2/blob/8de425de2571a57112e9e67cf0c925439a83c9e3/contracts/interfaces/ITransferManager.sol#L16 TransferManager interface}
+ */
+export interface BatchTransferItem {
+    collection: string;
+    collectionType: CollectionType;
+    itemIds: BigNumberish[];
+    amounts: BigNumberish[];
+}
+/** Return type for any on chain call */
+export interface ContractMethods {
+    call: (additionalOverrides?: Overrides) => Promise<ContractTransactionResponse>;
+    estimateGas: (additionalOverrides?: Overrides) => Promise<bigint>;
+    callStatic: (additionalOverrides?: Overrides) => Promise<any>;
+}
+/** Return type for strategyInfo */
+export interface StrategyInfo {
+    isActive: boolean;
+    standardProtocolFeeBp: number;
+    minTotalFeeBp: number;
+    maxProtocolFeeBp: number;
+}
+/** Return object of createMakerAsk  */
+export interface CreateMakerAskOutput {
+    maker: Maker;
+    isTransferManagerApproved: boolean;
+    isCollectionApproved: boolean;
+}
+/** Return object of createMakerBid  */
+export interface CreateMakerBidOutput {
+    maker: Maker;
+    isCurrencyApproved: boolean;
+    isBalanceSufficient: boolean;
+}
+/** Input of the createMakerAsk function */
+export interface CreateMakerInput {
+    /** Collection address */
+    collection: string;
+    /** Strategy ID, 0: Standard, 1: Collection, etc*/
+    strategyId: StrategyType;
+    /** Asset type, 0: ERC-721, 1:ERC-1155, etc */
+    collectionType: CollectionType;
+    /** Subset nonce used to group an arbitrary number of orders under the same nonce */
+    subsetNonce: BigNumberish;
+    /** Order nonce, get it from the LooksRare api */
+    orderNonce: BigNumberish;
+    /** Timestamp in seconds when the order becomes invalid */
+    endTime: BigNumberish;
+    /** Asset price in wei */
+    price: BigNumberish;
+    /**
+     * List of items ids to be sold
+     * @defaultValue [1]
+     */
+    itemIds: BigNumberish[];
+    /** Amount for each item ids (needs to have the same length as itemIds array) */
+    amounts?: BigNumberish[];
+    /**
+     * Currency address
+     * @defaultValue ETH
+     */
+    currency?: string;
+    /**
+     * Order validity start time
+     * @defaultValue now
+     */
+    startTime?: BigNumberish;
+    /**
+     * Additional parameters for complex orders
+     * @defaultValue []
+     */
+    additionalParameters?: any[];
+}
+export type CreateMakerCollectionOfferInput = Omit<CreateMakerInput, "strategyId" | "itemIds">;
+export type CreateMakerCollectionOfferWithProofInput = Omit<CreateMakerInput, "strategyId">;
+/** Maker object to be used in execute functions */
+export interface Maker {
+    /** Bid (0) or Ask (1) */
+    quoteType: QuoteType;
+    /** User's current bid / ask nonce */
+    globalNonce: BigNumberish;
+    /** Subset nonce used to group an arbitrary number of orders under the same nonce */
+    subsetNonce: BigNumberish;
+    /** Nonce for this specific order */
+    orderNonce: BigNumberish;
+    /** Strategy ID, 0: Standard, 1: Collection, etc*/
+    strategyId: StrategyType;
+    /** Asset type, 0: ERC-721, 1:ERC-1155, etc */
+    collectionType: CollectionType;
+    /** Collection address */
+    collection: string;
+    /** Currency address (zero address for ETH) */
+    currency: string;
+    /** Signer address */
+    signer: string;
+    /** Timestamp in second of the time when the order starts to be valid */
+    startTime: BigNumberish;
+    /** Timestamp in second of the time when the order becomes invalid */
+    endTime: BigNumberish;
+    /** Minimum price to be received after the trade */
+    price: BigNumberish;
+    /** List of item IDS */
+    itemIds: BigNumberish[];
+    /** List of amount for each item ID (1 for ERC721) */
+    amounts: BigNumberish[];
+    /** Additional parameters for complex orders */
+    additionalParameters: BytesLike;
+}
+/** Taker order */
+export interface Taker {
+    /** Recipient of the transaction */
+    recipient: string;
+    /** Additional parameters for complex orders */
+    additionalParameters: BytesLike;
+}
+/** Referrer object to be used in maker order API */
+export interface Referrer {
+    address: string;
+    rate: BigNumberish;
+}
+/** Merkle tree node position (needed by the SC) */
+export declare enum MerkleTreeNodePosition {
+    Left = 0,
+    Right = 1
+}
+/** Merkle tree proof to be used within a merkle tree */
+export interface MerkleTreeProof {
+    value: string;
+    position: MerkleTreeNodePosition;
+}
+/** Merkle root object to be used in the execute function for a multi listing */
+export interface MerkleTree {
+    root: string;
+    proof: MerkleTreeProof[];
+}
+/** Return type of the sign multiple orders function */
+export interface SignMerkleTreeOrdersOutput {
+    signature: string;
+    merkleTreeProofs: MerkleTree[];
+    tree: Eip712MakerMerkleTree;
+}
+/** Error errors returned by the order validator contract */
+export declare enum OrderValidatorCode {
+    ORDER_EXPECTED_TO_BE_VALID = 0,
+    CURRENCY_NOT_ALLOWED = 101,
+    STRATEGY_NOT_IMPLEMENTED = 111,
+    STRATEGY_INVALID_QUOTE_TYPE = 112,
+    STRATEGY_NOT_ACTIVE = 113,
+    MAKER_ORDER_INVALID_STANDARD_SALE = 201,
+    MAKER_ORDER_PERMANENTLY_INVALID_NON_STANDARD_SALE = 211,
+    MAKER_ORDER_INVALID_CURRENCY_NON_STANDARD_SALE = 212,
+    MAKER_ORDER_TEMPORARILY_INVALID_NON_STANDARD_SALE = 213,
+    USER_SUBSET_NONCE_CANCELLED = 301,
+    USER_ORDER_NONCE_EXECUTED_OR_CANCELLED = 311,
+    USER_ORDER_NONCE_IN_EXECUTION_WITH_OTHER_HASH = 312,
+    INVALID_USER_GLOBAL_BID_NONCE = 321,
+    INVALID_USER_GLOBAL_ASK_NONCE = 322,
+    ORDER_HASH_PROOF_NOT_IN_MERKLE_TREE = 401,
+    MERKLE_PROOF_PROOF_TOO_LARGE = 402,
+    INVALID_SIGNATURE_LENGTH = 411,
+    INVALID_S_PARAMETER_EOA = 412,
+    INVALID_V_PARAMETER_EOA = 413,
+    NULL_SIGNER_EOA = 414,
+    INVALID_SIGNER_EOA = 415,
+    MISSING_IS_VALID_SIGNATURE_FUNCTION_EIP1271 = 421,
+    SIGNATURE_INVALID_EIP1271 = 422,
+    START_TIME_GREATER_THAN_END_TIME = 501,
+    TOO_LATE_TO_EXECUTE_ORDER = 502,
+    TOO_EARLY_TO_EXECUTE_ORDER = 503,
+    SAME_ITEM_ID_IN_BUNDLE = 601,
+    ERC20_BALANCE_INFERIOR_TO_PRICE = 611,
+    ERC20_APPROVAL_INFERIOR_TO_PRICE = 612,
+    ERC721_ITEM_ID_DOES_NOT_EXIST = 621,
+    ERC721_ITEM_ID_NOT_IN_BALANCE = 622,
+    ERC721_NO_APPROVAL_FOR_ALL_OR_ITEM_ID = 623,
+    ERC1155_BALANCE_OF_DOES_NOT_EXIST = 631,
+    ERC1155_BALANCE_OF_ITEM_ID_INFERIOR_TO_AMOUNT = 632,
+    ERC1155_IS_APPROVED_FOR_ALL_DOES_NOT_EXIST = 633,
+    ERC1155_NO_APPROVAL_FOR_ALL = 634,
+    POTENTIAL_INVALID_COLLECTION_TYPE_SHOULD_BE_ERC721 = 701,
+    POTENTIAL_INVALID_COLLECTION_TYPE_SHOULD_BE_ERC1155 = 702,
+    NO_TRANSFER_MANAGER_APPROVAL_BY_USER_FOR_EXCHANGE = 801,
+    TRANSFER_MANAGER_APPROVAL_REVOKED_BY_OWNER_FOR_EXCHANGE = 802,
+    BUNDLE_ERC2981_NOT_SUPPORTED = 901,
+    CREATOR_FEE_TOO_HIGH = 902
+}

package/dist/utils/Eip712MakerMerkleTree.d.ts

@@ -0,0 +1,10 @@
+import { Eip712MerkleTree } from "./Eip712MerkleTree";
+import { Maker } from "../types";
+/**
+ * Specific implementation of Eip712MerkleTree for Maker type
+ * @extends Eip712MerkleTree
+ */
+export declare class Eip712MakerMerkleTree extends Eip712MerkleTree<Maker> {
+    makerOrders: Maker[];
+    constructor(makerOrders: Maker[]);
+}

package/dist/utils/Eip712MerkleTree.d.ts

@@ -0,0 +1,40 @@
+import { MerkleTree } from "merkletreejs";
+import { EIP712TypedData } from "../types";
+type BatchOrderElements<T> = [T, T] | [BatchOrderElements<T>, BatchOrderElements<T>];
+/**
+ * Generic wrapper around MerkleTreeJS to support EIP signing
+ */
+export declare class Eip712MerkleTree<BaseType extends Record<string, any> = any> {
+    types: EIP712TypedData;
+    leafType: string;
+    elements: BaseType[];
+    depth: number;
+    tree: MerkleTree;
+    private completeLeaves;
+    private completeElements;
+    /**
+     * Compute the tree height
+     * @param length length of the array of elements
+     * @returns height as a number
+     */
+    static getTreeHeight: (length: number) => number;
+    /**
+     *
+     * @param types EIP712 Typed data
+     * @param leafType Leaf type used in the Typed data
+     * @param defaultNode Dummy node
+     * @param elements Array of data blocks
+     * @param depth tree depth
+     */
+    constructor(types: EIP712TypedData, leafType: string, defaultNode: BaseType, elements: BaseType[], depth: number);
+    get completedSize(): number;
+    get hexRoot(): string;
+    getPositionalProof(i: number): {
+        leaf: string;
+        proof: (string | number)[][];
+    };
+    getDataToSign(): {
+        tree: BatchOrderElements<BaseType>;
+    };
+}
+export {};

package/dist/utils/calls/exchange.d.ts

@@ -0,0 +1,10 @@
+import { Signer } from "ethers";
+import { Maker, MerkleTree, Taker, ContractMethods } from "../../types";
+import { PayableOverrides } from "../../typechain/common";
+export declare const executeTakerBid: (signer: Signer, address: string, taker: Taker, maker: Maker, makerSignature: string, merkleTree: MerkleTree, affiliate: string, overrides?: PayableOverrides) => ContractMethods;
+export declare const executeTakerAsk: (signer: Signer, address: string, taker: Taker, maker: Maker, makerSignature: string, merkleTree: MerkleTree, affiliate: string, overrides?: PayableOverrides) => ContractMethods;
+export declare const executeMultipleTakerBids: (signer: Signer, address: string, taker: Taker[], maker: Maker[], makerSignature: string[], isAtomic: boolean, merkleTree: MerkleTree[], affiliate: string, overrides?: PayableOverrides) => {
+    call: (additionalOverrides?: PayableOverrides) => Promise<import("ethers").ContractTransactionResponse>;
+    estimateGas: (additionalOverrides?: PayableOverrides) => Promise<bigint>;
+    callStatic: (additionalOverrides?: PayableOverrides) => Promise<void>;
+};

package/dist/utils/calls/nonces.d.ts

@@ -0,0 +1,9 @@
+import { Overrides, BigNumberish, Provider, Signer } from "ethers";
+import { ContractMethods } from "../../types";
+export declare const viewUserBidAskNonces: (signerOrProvider: Provider | Signer, address: string, account: string, overrides?: Overrides) => Promise<{
+    bidNonce: bigint;
+    askNonce: bigint;
+}>;
+export declare const cancelOrderNonces: (signer: Signer, address: string, nonces: BigNumberish[], overrides?: Overrides) => ContractMethods;
+export declare const cancelSubsetNonces: (signer: Signer, address: string, nonces: BigNumberish[], overrides?: Overrides) => ContractMethods;
+export declare const incrementBidAskNonces: (signer: Signer, address: string, bid: boolean, ask: boolean, overrides?: Overrides) => ContractMethods;

package/dist/utils/calls/orderValidator.d.ts

@@ -0,0 +1,3 @@
+import { Provider, Overrides, Signer } from "ethers";
+import { Maker, MerkleTree, OrderValidatorCode } from "../../types";
+export declare const verifyMakerOrders: (signerOrProvider: Provider | Signer, address: string, makerOrders: Maker[], signatures: string[], merkleTrees: MerkleTree[], overrides?: Overrides) => Promise<OrderValidatorCode[][]>;

package/dist/utils/calls/strategies.d.ts

@@ -0,0 +1,3 @@
+import { Overrides, Provider, Signer } from "ethers";
+import { StrategyType, StrategyInfo } from "../../types";
+export declare const strategyInfo: (signerOrProvider: Provider | Signer, address: string, strategyId: StrategyType, overrides?: Overrides) => Promise<StrategyInfo>;

package/dist/utils/calls/tokens.d.ts

@@ -0,0 +1,6 @@
+import { Provider, Overrides, ContractTransactionResponse, Signer } from "ethers";
+export declare const setApprovalForAll: (signer: Signer, collection: string, operator: string, approved: boolean, overrides?: Overrides) => Promise<ContractTransactionResponse>;
+export declare const isApprovedForAll: (signerOrProvider: Provider | Signer, collection: string, account: string, operator: string, overrides?: Overrides) => Promise<boolean>;
+export declare const allowance: (signerOrProvider: Provider | Signer, currency: string, account: string, operator: string, overrides?: Overrides) => Promise<bigint>;
+export declare const approve: (signer: Signer, currency: string, operator: string, amount: bigint, overrides?: Overrides) => Promise<ContractTransactionResponse>;
+export declare const balanceOf: (signerOrProvider: Provider | Signer, currency: string, account: string, overrides?: Overrides) => Promise<bigint>;

package/dist/utils/calls/transferManager.d.ts

@@ -0,0 +1,6 @@
+import { Overrides, Provider, Signer } from "ethers";
+import { ContractMethods, BatchTransferItem } from "../../types";
+export declare const hasUserApprovedOperator: (signerOrProvider: Provider | Signer, address: string, user: string, operator: string, overrides?: Overrides) => Promise<boolean>;
+export declare const grantApprovals: (signer: Signer, address: string, operators: string[], overrides?: Overrides) => ContractMethods;
+export declare const revokeApprovals: (signer: Signer, address: string, operators: string[], overrides?: Overrides) => ContractMethods;
+export declare const transferBatchItemsAcrossCollections: (signer: Signer, address: string, items: BatchTransferItem[], from: string, to: string, overrides?: Overrides) => ContractMethods;

package/dist/utils/eip712.d.ts

@@ -0,0 +1,12 @@
+import { EIP712TypedData, Maker } from "../types";
+export declare const MAKER_HASH = "0x003c1bce41a2de73dfe64d6eeb2b3d7f15f1c0c382d9d963c2c6daeb75f0e539";
+export declare const hashingMakerTypes: string[];
+export declare const makerTypes: EIP712TypedData;
+export declare const getBatchOrderTypes: (height: number) => EIP712TypedData;
+/**
+ * Hash maker ask order.
+ * This function is used for testing purpose in the SDK, but is exposed because it's used by the BE.
+ * @param maker Maker
+ * @returns string (bytes32)
+ */
+export declare const getMakerHash: (maker: Maker) => string;

package/dist/utils/encodeOrderParams.d.ts

@@ -0,0 +1,22 @@
+import { BytesLike } from "ethers";
+import { SolidityType, StrategyType } from "../types";
+/**
+ * Get additional params types for a maker order based on the strategy used
+ * @param strategy Maker strategy
+ * @returns Array of solidity types for encoding
+ */
+export declare const getMakerParamsTypes: (strategy: StrategyType) => SolidityType[];
+/**
+ * Get additional params types for a maker order based on the strategy used
+ * @param strategy Maker strategy
+ * @returns Array of solidity types for encoding
+ */
+export declare const getTakerParamsTypes: (strategy: StrategyType) => SolidityType[];
+/**
+ * Given an array of params, returns the encoded params.
+ * To be used for orders signature and orders execution
+ * @param params Array of params
+ * @param types Array of solidity types
+ * @returns encoded params
+ */
+export declare const encodeParams: (params: any[], types: SolidityType[]) => BytesLike;

package/dist/utils/signMakerOrders.d.ts

@@ -0,0 +1,18 @@
+import { TypedDataDomain, Signer } from "ethers";
+import { Maker, SignMerkleTreeOrdersOutput } from "../types";
+/**
+ * Sign a maker order
+ * @param signer Ethers typed data signer
+ * @param domain Typed data domain
+ * @param makerOrder Maker order
+ * @returns Signature
+ */
+export declare const signMakerOrder: (signer: Signer, domain: TypedDataDomain, makerOrder: Maker) => Promise<string>;
+/**
+ * Sign a list of maker orders with a merkle tree
+ * @param signer Ethers typed data signer
+ * @param domain Typed data domain
+ * @param makerOrder Maker order
+ * @returns Signature, array of proofs, and tree
+ */
+export declare const signMerkleTreeOrders: (signer: Signer, domain: TypedDataDomain, makerOrders: Maker[]) => Promise<SignMerkleTreeOrdersOutput>;

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@hypercerts-org/marketplace-sdk",
+  "version": "0.0.1",
+  "license": "MIT",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "keywords": [
+    "looksrare"
+  ],
+  "homepage": "https://hypercerts.org/",
+  "bugs": "https://github.com/hypercerts-org/hypercerts/issues",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:hypercerts-org/marketplace-sdk.git"
+  },
+  "engines": {
+    "node": ">= 16.15.1 <= 20.x"
+  },
+  "scripts": {
+    "prebuild": "rm -rf ./src/typechain ./src/artifacts cache dist",
+    "prepublishOnly": "yarn build",
+    "dev": "rollup -c --bundleConfigAsCjs -w",
+    "build:ts": "rollup -c --bundleConfigAsCjs",
+    "build:sc": "hardhat compile",
+    "build": "yarn build:sc && yarn build:ts",
+    "test": "nyc hardhat test",
+    "doc": "typedoc --plugin typedoc-plugin-markdown --tsconfig tsconfig.build.json",
+    "lint": "eslint --max-warnings 0 'src/**/*.{js,ts}'",
+    "format:check": "prettier --check 'src/**/*.{js,ts,json,yaml,yml,md}'",
+    "format:write": "prettier --write 'src/**/*.{js,ts,json,yaml,yml,md}'",
+    "release": "release-it --only-version --set-upstream"
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx,json,yaml,yml}": "yarn format:write"
+  },
+  "peerDependencies": {
+    "ethers": "^6.6.2"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^17.0.2",
+    "@commitlint/config-conventional": "^17.0.2",
+    "@istanbuljs/nyc-config-typescript": "^1.0.2",
+    "@looksrare/contracts-exchange-v1": "^1.2.0",
+    "@looksrare/contracts-exchange-v2": "^0.1.2",
+    "@nomicfoundation/hardhat-ethers": "^3.0.4",
+    "@rollup/plugin-json": "^6.0.0",
+    "@rollup/plugin-typescript": "^11.0.0",
+    "@typechain/ethers-v6": "^0.4.0",
+    "@typechain/hardhat": "^8.0.0",
+    "@types/chai": "^4.3.1",
+    "@types/chai-as-promised": "^7.1.5",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^18.14.6",
+    "@typescript-eslint/eslint-plugin": "^5.54.1",
+    "@typescript-eslint/parser": "^5.54.1",
+    "chai": "^4.3.6",
+    "chai-as-promised": "^7.1.1",
+    "dotenv": "^16.0.3",
+    "eslint": "^8.17.0",
+    "eslint-config-prettier": "^8.7.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "ethers": "^6.6.2",
+    "hardhat": "^2.16.1",
+    "hardhat-abi-exporter": "^2.9.0",
+    "husky": "^8.0.1",
+    "lint-staged": "^13.0.0",
+    "nyc": "^15.1.0",
+    "prettier": "^2.6.2",
+    "prettier-plugin-solidity": "^1.1.3",
+    "release-it": "^15.7.0",
+    "rollup": "^3.18.0",
+    "rollup-plugin-bundle-size": "^1.0.3",
+    "rollup-plugin-copy": "^3.4.0",
+    "solhint": "^3.4.1",
+    "solmate": "^6.6.1",
+    "source-map-support": "^0.5.21",
+    "ts-node": "^10.9.1",
+    "typechain": "^8.2.0",
+    "typedoc": "^0.24.7",
+    "typedoc-plugin-markdown": "^3.15.3",
+    "typescript": "^4.7.3"
+  },
+  "dependencies": {
+    "merkletreejs": "^0.3.9"
+  }
+}