@hypercerts-org/marketplace-sdk 0.0.18 → 0.0.20

package/dist/HypercertExchangeClient.d.ts

@@ -1,6 +1,6 @@
-import { BigNumberish, ContractTransactionResponse, Overrides, TypedDataDomain, Provider, Signer } from "ethers";
+import { BigNumberish, ContractTransactionResponse, Overrides, Provider, Signer, TypedDataDomain } from "ethers";
 import * as api from "./utils/api";
-import { Addresses, Maker, Taker, ChainId, CreateMakerInput, CreateMakerAskOutput, CreateMakerBidOutput, CreateMakerCollectionOfferInput, CreateMakerCollectionOfferWithProofInput, MerkleTree, ContractMethods, OrderValidatorCode, BatchTransferItem, SignMerkleTreeOrdersOutput, StrategyType, StrategyInfo } from "./types";
+import { Addresses, BatchTransferItem, ChainId, ContractMethods, CreateMakerAskOutput, CreateMakerBidOutput, CreateMakerCollectionOfferInput, CreateMakerCollectionOfferWithProofInput, CreateMakerInput, Maker, MerkleTree, OrderValidatorCode, SignMerkleTreeOrdersOutput, StrategyInfo, StrategyType, Taker } from "./types";
 /**
  * LooksRare
  * This class provides helpers to interact with the LooksRare V2 contracts
@@ -83,7 +83,7 @@ export declare class HypercertExchangeClient {
      * Create a taker ask order for collection order.
      * @see this.createTaker
      * @see this.createMakerCollectionOffer
-     * @param makerBid Maker bid that will be used as counterparty for the taker
+     * @param maker Maker bid that will be used as counterparty for the taker
      * @param itemId Token id to use as a counterparty for the collection order
      * @param recipient Recipient address of the taker (if none, it will use the sender)
      * @returns Taker object
@@ -93,7 +93,7 @@ export declare class HypercertExchangeClient {
      * Create a taker ask to fulfill a collection order (maker bid) created with a whitelist of item ids
      * @see this.createTaker
      * @see this.createMakerCollectionOfferWithMerkleTree
-     * @param makerBid Maker bid that will be used as counterparty for the taker
+     * @param maker Maker bid that will be used as counterparty for the taker
      * @param itemId Token id to use as a counterparty for the collection order
      * @param itemIds List of token ids used during the maker creation
      * @param recipient Recipient address of the taker (if none, it will use the sender)
@@ -115,11 +115,10 @@ export declare class HypercertExchangeClient {
     signMultipleMakerOrders(makerOrders: Maker[]): Promise<SignMerkleTreeOrdersOutput>;
     /**
      * Execute a trade
-     * @param makerBid Maker order
+     * @param maker Maker order
      * @param taker Taker order
      * @param signature Signature of the maker order
      * @param merkleTree If the maker has been signed with a merkle tree
-     * @param affiliate Affiliate address if applicable
      * @returns ContractMethods
      */
     executeOrder(maker: Maker, taker: Taker, signature: string, merkleTree?: MerkleTree, overrides?: Overrides): ContractMethods;
@@ -127,7 +126,6 @@ export declare class HypercertExchangeClient {
      * Execute several orders
      * @param orders List of orders data
      * @param isAtomic Should the transaction revert or not if a trade fails
-     * @param affiliate Affiliate address
      * @param overrides Call overrides
      * @returns ContractMethods
      */
@@ -223,16 +221,37 @@ export declare class HypercertExchangeClient {
      * @param price Price of the fractions in wei
      * @param startTime Timestamp in seconds when the order becomes valid
      * @param endTime Timestamp in seconds when the order becomes invalid
+     * @param currency Currency used to buy the fractions (default to WETH)
      * @param additionalParameters Additional parameters used to support complex orders
      */
-    createDirectFractionsSaleMakerAsk({ itemIds, price, startTime, endTime, additionalParameters, }: Omit<CreateMakerInput, "strategyId" | "collectionType" | "collection" | "subsetNonce" | "orderNonce" | "amounts" | "currency">): Promise<CreateMakerAskOutput>;
-    createFractionalSaleMakerAsk({ itemIds, price, startTime, endTime, maxUnitAmount, minUnitAmount, minUnitsToKeep, sellLeftoverFraction, root, }: Omit<CreateMakerInput, "strategyId" | "collectionType" | "collection" | "subsetNonce" | "orderNonce" | "amounts" | "currency" | "additionalParameters"> & {
+    createDirectFractionsSaleMakerAsk({ itemIds, price, startTime, endTime, currency, additionalParameters, }: Omit<CreateMakerInput, "strategyId" | "collectionType" | "collection" | "subsetNonce" | "orderNonce" | "amounts">): Promise<CreateMakerAskOutput>;
+    /**
+     * Create a maker ask to let the buyer decide how much of the fraction they want to buy
+     * @param itemIds Token IDs of the fractions to be sold
+     * @param price Price of one unit in wei
+     * @param startTime Timestamp in seconds when the order becomes valid
+     * @param endTime Timestamp in seconds when the order becomes invalid
+     * @param currency Currency used to buy the fractions (default to WETH)
+     * @param maxUnitAmount Maximum amount of units that can be bought in a single transaction
+     * @param minUnitAmount Minimum amount of units that can be bought in a single transaction
+     * @param minUnitsToKeep Minimum amount of units that the seller wants to keep
+     * @param sellLeftoverFraction Whether or not the seller wants to sell the leftover units
+     * @param root Merkle tree root (optional)
+     */
+    createFractionalSaleMakerAsk({ itemIds, price, startTime, endTime, currency, maxUnitAmount, minUnitAmount, minUnitsToKeep, sellLeftoverFraction, root, }: Omit<CreateMakerInput, "strategyId" | "collectionType" | "collection" | "subsetNonce" | "orderNonce" | "amounts" | "additionalParameters"> & {
         minUnitAmount: BigNumberish;
         maxUnitAmount: BigNumberish;
         minUnitsToKeep: BigNumberish;
         sellLeftoverFraction: boolean;
         root?: string;
     }): Promise<CreateMakerAskOutput>;
+    /**
+     * Create a taker bid for buying a fraction of an open fractional sale
+     * @param maker Maker order
+     * @param recipient Recipient address of the taker (if none, it will use the sender)
+     * @param unitAmount Amount of units to buy
+     * @param pricePerUnit Price per unit in wei
+     */
     createFractionalSaleTakerBid(maker: Maker, recipient: string | undefined, unitAmount: BigNumberish, pricePerUnit: BigNumberish): Taker;
     /**
      * Register the order with hypercerts marketplace API.

package/dist/index.cjs.js

@@ -4804,9 +4804,9 @@ const contractName = "LooksRareProtocol";
  */
 const version = 2;
 
-const HYPERCERTS_MARKETPLACE_API_URL = "http://localhost:3000/api";
-const SUPABASE_HYPERCERTS_URL = "https://clagjjfinooizoqdkvqc.supabase.co";
-const SUPABASE_HYPERCERTS_ANON_KEY = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6ImNsYWdqamZpbm9vaXpvcWRrdnFjIiwicm9sZSI6ImFub24iLCJpYXQiOjE2NzY5NTAxNDAsImV4cCI6MTk5MjUyNjE0MH0.LOIW3NcYEfF7w893PS3Ne1VrntACE3OPeSRFkspvyqw";
+const HYPERCERTS_MARKETPLACE_API_URL = process.env.HYPERCERTS_MARKETPLACE_API_URL;
+const SUPABASE_HYPERCERTS_URL = process.env.SUPABASE_HYPERCERTS_URL;
+const SUPABASE_HYPERCERTS_ANON_KEY = process.env.SUPABASE_HYPERCERTS_ANON_KEY;
 const supabaseHypercerts = supabaseJs.createClient(SUPABASE_HYPERCERTS_URL, SUPABASE_HYPERCERTS_ANON_KEY);
 /**
  * Fetches order nonce from api
@@ -4890,7 +4890,6 @@ class HypercertExchangeClient {
     constructor(chainId, provider, signer, override) {
         this.chainId = chainId;
         this.addresses = override ?? addressesByNetwork[this.chainId];
-        console.log("Addresses", this.addresses);
         this.signer = signer;
         this.provider = provider;
         this.api = api;
@@ -5045,17 +5044,16 @@ class HypercertExchangeClient {
      * @returns Taker object
      */
     createTaker(maker, recipient = ethers.ZeroAddress, additionalParameters = []) {
-        const order = {
+        return {
             recipient: recipient,
             additionalParameters: encodeParams(additionalParameters, getTakerParamsTypes(maker.strategyId)),
         };
-        return order;
     }
     /**
      * Create a taker ask order for collection order.
      * @see this.createTaker
      * @see this.createMakerCollectionOffer
-     * @param makerBid Maker bid that will be used as counterparty for the taker
+     * @param maker Maker bid that will be used as counterparty for the taker
      * @param itemId Token id to use as a counterparty for the collection order
      * @param recipient Recipient address of the taker (if none, it will use the sender)
      * @returns Taker object
@@ -5073,7 +5071,7 @@ class HypercertExchangeClient {
      * Create a taker ask to fulfill a collection order (maker bid) created with a whitelist of item ids
      * @see this.createTaker
      * @see this.createMakerCollectionOfferWithMerkleTree
-     * @param makerBid Maker bid that will be used as counterparty for the taker
+     * @param maker Maker bid that will be used as counterparty for the taker
      * @param itemId Token id to use as a counterparty for the collection order
      * @param itemIds List of token ids used during the maker creation
      * @param recipient Recipient address of the taker (if none, it will use the sender)
@@ -5123,11 +5121,10 @@ class HypercertExchangeClient {
     }
     /**
      * Execute a trade
-     * @param makerBid Maker order
+     * @param maker Maker order
      * @param taker Taker order
      * @param signature Signature of the maker order
      * @param merkleTree If the maker has been signed with a merkle tree
-     * @param affiliate Affiliate address if applicable
      * @returns ContractMethods
      */
     executeOrder(maker, taker, signature, merkleTree = defaultMerkleTree, overrides) {
@@ -5139,7 +5136,6 @@ class HypercertExchangeClient {
      * Execute several orders
      * @param orders List of orders data
      * @param isAtomic Should the transaction revert or not if a trade fails
-     * @param affiliate Affiliate address
      * @param overrides Call overrides
      * @returns ContractMethods
      */
@@ -5278,9 +5274,10 @@ class HypercertExchangeClient {
      * @param price Price of the fractions in wei
      * @param startTime Timestamp in seconds when the order becomes valid
      * @param endTime Timestamp in seconds when the order becomes invalid
+     * @param currency Currency used to buy the fractions (default to WETH)
      * @param additionalParameters Additional parameters used to support complex orders
      */
-    async createDirectFractionsSaleMakerAsk({ itemIds, price, startTime, endTime, additionalParameters = [], }) {
+    async createDirectFractionsSaleMakerAsk({ itemIds, price, startTime, endTime, currency = this.addresses.WETH, additionalParameters = [], }) {
         const address = await this.signer?.getAddress();
         if (!address) {
             throw new Error("No signer address could be determined");
@@ -5297,7 +5294,7 @@ class HypercertExchangeClient {
             collectionType: 2,
             collection: this.addresses.MINTER,
             subsetNonce: 0,
-            currency: this.addresses.WETH,
+            currency,
             amounts,
             orderNonce: nonce_counter.toString(),
             // User specified
@@ -5308,7 +5305,20 @@ class HypercertExchangeClient {
             additionalParameters,
         });
     }
-    async createFractionalSaleMakerAsk({ itemIds, price, startTime, endTime, maxUnitAmount, minUnitAmount, minUnitsToKeep, sellLeftoverFraction, root, }) {
+    /**
+     * Create a maker ask to let the buyer decide how much of the fraction they want to buy
+     * @param itemIds Token IDs of the fractions to be sold
+     * @param price Price of one unit in wei
+     * @param startTime Timestamp in seconds when the order becomes valid
+     * @param endTime Timestamp in seconds when the order becomes invalid
+     * @param currency Currency used to buy the fractions (default to WETH)
+     * @param maxUnitAmount Maximum amount of units that can be bought in a single transaction
+     * @param minUnitAmount Minimum amount of units that can be bought in a single transaction
+     * @param minUnitsToKeep Minimum amount of units that the seller wants to keep
+     * @param sellLeftoverFraction Whether or not the seller wants to sell the leftover units
+     * @param root Merkle tree root (optional)
+     */
+    async createFractionalSaleMakerAsk({ itemIds, price, startTime, endTime, currency = this.addresses.WETH, maxUnitAmount, minUnitAmount, minUnitsToKeep, sellLeftoverFraction, root, }) {
         const address = await this.signer?.getAddress();
         if (!address) {
             throw new Error("No signer address could be determined");
@@ -5324,7 +5334,7 @@ class HypercertExchangeClient {
             collectionType: 2,
             collection: this.addresses.MINTER,
             subsetNonce: 0,
-            currency: this.addresses.WETH,
+            currency,
             amounts,
             orderNonce: nonce_counter.toString(),
             // User specified
@@ -5346,12 +5356,18 @@ class HypercertExchangeClient {
             additionalParameters: [minUnitAmount, maxUnitAmount, minUnitsToKeep, sellLeftoverFraction],
         });
     }
+    /**
+     * Create a taker bid for buying a fraction of an open fractional sale
+     * @param maker Maker order
+     * @param recipient Recipient address of the taker (if none, it will use the sender)
+     * @param unitAmount Amount of units to buy
+     * @param pricePerUnit Price per unit in wei
+     */
     createFractionalSaleTakerBid(maker, recipient = ethers.ZeroAddress, unitAmount, pricePerUnit) {
-        const order = {
+        return {
             recipient: recipient,
             additionalParameters: encodeParams([unitAmount, pricePerUnit], getTakerParamsTypes(maker.strategyId)),
         };
-        return order;
     }
     /**
      * Register the order with hypercerts marketplace API.

package/dist/index.esm.js

@@ -4802,9 +4802,9 @@ const contractName = "LooksRareProtocol";
  */
 const version = 2;
 
-const HYPERCERTS_MARKETPLACE_API_URL = "http://localhost:3000/api";
-const SUPABASE_HYPERCERTS_URL = "https://clagjjfinooizoqdkvqc.supabase.co";
-const SUPABASE_HYPERCERTS_ANON_KEY = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6ImNsYWdqamZpbm9vaXpvcWRrdnFjIiwicm9sZSI6ImFub24iLCJpYXQiOjE2NzY5NTAxNDAsImV4cCI6MTk5MjUyNjE0MH0.LOIW3NcYEfF7w893PS3Ne1VrntACE3OPeSRFkspvyqw";
+const HYPERCERTS_MARKETPLACE_API_URL = process.env.HYPERCERTS_MARKETPLACE_API_URL;
+const SUPABASE_HYPERCERTS_URL = process.env.SUPABASE_HYPERCERTS_URL;
+const SUPABASE_HYPERCERTS_ANON_KEY = process.env.SUPABASE_HYPERCERTS_ANON_KEY;
 const supabaseHypercerts = createClient(SUPABASE_HYPERCERTS_URL, SUPABASE_HYPERCERTS_ANON_KEY);
 /**
  * Fetches order nonce from api
@@ -4888,7 +4888,6 @@ class HypercertExchangeClient {
     constructor(chainId, provider, signer, override) {
         this.chainId = chainId;
         this.addresses = override ?? addressesByNetwork[this.chainId];
-        console.log("Addresses", this.addresses);
         this.signer = signer;
         this.provider = provider;
         this.api = api;
@@ -5043,17 +5042,16 @@ class HypercertExchangeClient {
      * @returns Taker object
      */
     createTaker(maker, recipient = ZeroAddress, additionalParameters = []) {
-        const order = {
+        return {
             recipient: recipient,
             additionalParameters: encodeParams(additionalParameters, getTakerParamsTypes(maker.strategyId)),
         };
-        return order;
     }
     /**
      * Create a taker ask order for collection order.
      * @see this.createTaker
      * @see this.createMakerCollectionOffer
-     * @param makerBid Maker bid that will be used as counterparty for the taker
+     * @param maker Maker bid that will be used as counterparty for the taker
      * @param itemId Token id to use as a counterparty for the collection order
      * @param recipient Recipient address of the taker (if none, it will use the sender)
      * @returns Taker object
@@ -5071,7 +5069,7 @@ class HypercertExchangeClient {
      * Create a taker ask to fulfill a collection order (maker bid) created with a whitelist of item ids
      * @see this.createTaker
      * @see this.createMakerCollectionOfferWithMerkleTree
-     * @param makerBid Maker bid that will be used as counterparty for the taker
+     * @param maker Maker bid that will be used as counterparty for the taker
      * @param itemId Token id to use as a counterparty for the collection order
      * @param itemIds List of token ids used during the maker creation
      * @param recipient Recipient address of the taker (if none, it will use the sender)
@@ -5121,11 +5119,10 @@ class HypercertExchangeClient {
     }
     /**
      * Execute a trade
-     * @param makerBid Maker order
+     * @param maker Maker order
      * @param taker Taker order
      * @param signature Signature of the maker order
      * @param merkleTree If the maker has been signed with a merkle tree
-     * @param affiliate Affiliate address if applicable
      * @returns ContractMethods
      */
     executeOrder(maker, taker, signature, merkleTree = defaultMerkleTree, overrides) {
@@ -5137,7 +5134,6 @@ class HypercertExchangeClient {
      * Execute several orders
      * @param orders List of orders data
      * @param isAtomic Should the transaction revert or not if a trade fails
-     * @param affiliate Affiliate address
      * @param overrides Call overrides
      * @returns ContractMethods
      */
@@ -5276,9 +5272,10 @@ class HypercertExchangeClient {
      * @param price Price of the fractions in wei
      * @param startTime Timestamp in seconds when the order becomes valid
      * @param endTime Timestamp in seconds when the order becomes invalid
+     * @param currency Currency used to buy the fractions (default to WETH)
      * @param additionalParameters Additional parameters used to support complex orders
      */
-    async createDirectFractionsSaleMakerAsk({ itemIds, price, startTime, endTime, additionalParameters = [], }) {
+    async createDirectFractionsSaleMakerAsk({ itemIds, price, startTime, endTime, currency = this.addresses.WETH, additionalParameters = [], }) {
         const address = await this.signer?.getAddress();
         if (!address) {
             throw new Error("No signer address could be determined");
@@ -5295,7 +5292,7 @@ class HypercertExchangeClient {
             collectionType: 2,
             collection: this.addresses.MINTER,
             subsetNonce: 0,
-            currency: this.addresses.WETH,
+            currency,
             amounts,
             orderNonce: nonce_counter.toString(),
             // User specified
@@ -5306,7 +5303,20 @@ class HypercertExchangeClient {
             additionalParameters,
         });
     }
-    async createFractionalSaleMakerAsk({ itemIds, price, startTime, endTime, maxUnitAmount, minUnitAmount, minUnitsToKeep, sellLeftoverFraction, root, }) {
+    /**
+     * Create a maker ask to let the buyer decide how much of the fraction they want to buy
+     * @param itemIds Token IDs of the fractions to be sold
+     * @param price Price of one unit in wei
+     * @param startTime Timestamp in seconds when the order becomes valid
+     * @param endTime Timestamp in seconds when the order becomes invalid
+     * @param currency Currency used to buy the fractions (default to WETH)
+     * @param maxUnitAmount Maximum amount of units that can be bought in a single transaction
+     * @param minUnitAmount Minimum amount of units that can be bought in a single transaction
+     * @param minUnitsToKeep Minimum amount of units that the seller wants to keep
+     * @param sellLeftoverFraction Whether or not the seller wants to sell the leftover units
+     * @param root Merkle tree root (optional)
+     */
+    async createFractionalSaleMakerAsk({ itemIds, price, startTime, endTime, currency = this.addresses.WETH, maxUnitAmount, minUnitAmount, minUnitsToKeep, sellLeftoverFraction, root, }) {
         const address = await this.signer?.getAddress();
         if (!address) {
             throw new Error("No signer address could be determined");
@@ -5322,7 +5332,7 @@ class HypercertExchangeClient {
             collectionType: 2,
             collection: this.addresses.MINTER,
             subsetNonce: 0,
-            currency: this.addresses.WETH,
+            currency,
             amounts,
             orderNonce: nonce_counter.toString(),
             // User specified
@@ -5344,12 +5354,18 @@ class HypercertExchangeClient {
             additionalParameters: [minUnitAmount, maxUnitAmount, minUnitsToKeep, sellLeftoverFraction],
         });
     }
+    /**
+     * Create a taker bid for buying a fraction of an open fractional sale
+     * @param maker Maker order
+     * @param recipient Recipient address of the taker (if none, it will use the sender)
+     * @param unitAmount Amount of units to buy
+     * @param pricePerUnit Price per unit in wei
+     */
     createFractionalSaleTakerBid(maker, recipient = ZeroAddress, unitAmount, pricePerUnit) {
-        const order = {
+        return {
             recipient: recipient,
             additionalParameters: encodeParams([unitAmount, pricePerUnit], getTakerParamsTypes(maker.strategyId)),
         };
-        return order;
     }
     /**
      * Register the order with hypercerts marketplace API.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hypercerts-org/marketplace-sdk",
-  "version": "0.0.18",
+  "version": "0.0.20",
   "license": "MIT",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
@@ -24,20 +24,6 @@
   "engines": {
     "node": ">= 16.15.1 <= 20.x"
   },
-  "scripts": {
-    "prebuild": "rm -rf ./src/typechain ./src/artifacts cache dist",
-    "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",
-    "supabase:types:hypercerts": "npx supabase gen types typescript --project-id clagjjfinooizoqdkvqc --schema public > src/utils/hypercerts-database-types.ts"
-  },
   "lint-staged": {
     "*.{js,jsx,ts,tsx,json,yaml,yml}": "yarn format:write"
   },
@@ -47,7 +33,7 @@
   "devDependencies": {
     "@commitlint/cli": "^17.0.2",
     "@commitlint/config-conventional": "^17.0.2",
-    "@hypercerts-org/contracts": "1.1.0",
+    "@hypercerts-org/contracts": "1.1.1-alpha.1",
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "@looksrare/contracts-exchange-v1": "^1.2.0",
     "@looksrare/contracts-exchange-v2": "^0.1.2",
@@ -95,5 +81,19 @@
     "@supabase/supabase-js": "^2.39.2",
     "ethers": "^6.6.2",
     "merkletreejs": "^0.3.9"
+  },
+  "scripts": {
+    "prebuild": "rm -rf ./src/typechain ./src/artifacts cache dist",
+    "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",
+    "supabase:types:hypercerts": "npx supabase gen types typescript --project-id clagjjfinooizoqdkvqc --schema public > src/utils/hypercerts-database-types.ts"
   }
-}
+}