@bosonprotocol/core-sdk 1.39.1 → 1.40.0-alpha.1

package/src/offers/queries.graphql

@@ -155,6 +155,17 @@ fragment BaseOfferFields on Offer {
   disputeResolverId
   numberOfCommits
   numberOfRedemptions
+  priceType
+  royaltyInfos {
+    timestamp
+    recipients {
+      recipient {
+        id
+        wallet
+      }
+      bps
+    }
+  }
   condition {
     ...BaseConditionFields
   }

package/src/offers/renderContractualAgreement.ts

@@ -1,7 +1,7 @@
 import * as yup from "yup";
 import { ITokenInfo } from "./../utils/tokenInfoManager";
 import { BigNumber, BigNumberish } from "@ethersproject/bignumber";
-import { utils } from "@bosonprotocol/common";
+import { PriceType, utils } from "@bosonprotocol/common";
 import Mustache from "mustache";
 import { formatUnits } from "@ethersproject/units";
 
@@ -11,6 +11,7 @@ import {
   MetadataType,
   ProductV1MetadataEntity
 } from "../subgraph";
+import { AddressZero } from "@ethersproject/constants";
 
 export type AdditionalOfferMetadata = {
   sellerContactMethod: string;
@@ -178,7 +179,15 @@ function convertExistingOfferData(offerDataSubGraph: OfferFieldsFragment): {
         offerDataSubGraph.voucherRedeemableUntilDate,
       disputePeriodDurationInMS: offerDataSubGraph.disputePeriodDuration,
       resolutionPeriodDurationInMS: offerDataSubGraph.resolutionPeriodDuration,
-      exchangeToken: offerDataSubGraph.exchangeToken.address
+      exchangeToken: offerDataSubGraph.exchangeToken.address,
+      feeLimit: offerDataSubGraph.price, // feeLimit is never stored on-chain. By default, set it to offer price
+      priceType: PriceType.Static,
+      royaltyInfo: [
+        {
+          recipients: [AddressZero], // AddressZero means Seller's treasury account
+          bps: ["0"] // Values should be greater or equal than Seller's minimum royalty amount
+        }
+      ]
     },
     offerMetadata: {
       sellerContactMethod: (

package/src/offers/types.ts

@@ -1 +1 @@
-export { CreateOfferArgs } from "@bosonprotocol/common";
+export { CreateOfferArgs, PriceType } from "@bosonprotocol/common";

package/src/orchestration/handler.ts

@@ -21,6 +21,7 @@ import { CreateOfferArgs } from "../offers/types";
 import { CreateSellerArgs } from "../accounts/types";
 import { BigNumberish } from "@ethersproject/bignumber";
 import { findCollectionSalt } from "../accounts/handler";
+import { PremintParametersStruct } from "@bosonprotocol/common/src";
 import { storeMetadataItems } from "../metadata/storeMetadataItems";
 
 export async function createOfferAndSeller(args: {
@@ -144,7 +145,7 @@ export async function createSellerAndOfferWithCondition(args: {
 
 export async function createPremintedOfferAddToGroup(args: {
   offerToCreate: CreateOfferArgs;
-  reservedRangeLength: BigNumberish;
+  premintParameters: PremintParametersStruct;
   groupId: BigNumberish;
   contractAddress: string;
   web3Lib: Web3LibAdapter;
@@ -170,7 +171,7 @@ export async function createPremintedOfferAddToGroup(args: {
     to: args.contractAddress,
     data: encodeCreatePremintedOfferAddToGroup(
       args.offerToCreate,
-      args.reservedRangeLength,
+      args.premintParameters,
       args.groupId
     )
   });
@@ -178,7 +179,7 @@ export async function createPremintedOfferAddToGroup(args: {
 
 export async function createPremintedOfferWithCondition(args: {
   offerToCreate: CreateOfferArgs;
-  reservedRangeLength: BigNumberish;
+  premintParameters: PremintParametersStruct;
   contractAddress: string;
   web3Lib: Web3LibAdapter;
   metadataStorage?: MetadataStorage;
@@ -204,7 +205,7 @@ export async function createPremintedOfferWithCondition(args: {
     to: args.contractAddress,
     data: encodeCreatePremintedOfferWithCondition(
       args.offerToCreate,
-      args.reservedRangeLength,
+      args.premintParameters,
       args.condition
     )
   });
@@ -213,7 +214,7 @@ export async function createPremintedOfferWithCondition(args: {
 export async function createSellerAndPremintedOffer(args: {
   sellerToCreate: CreateSellerArgs;
   offerToCreate: CreateOfferArgs;
-  reservedRangeLength: BigNumberish;
+  premintParameters: PremintParametersStruct;
   contractAddress: string;
   web3Lib: Web3LibAdapter;
   metadataStorage?: MetadataStorage;
@@ -249,7 +250,7 @@ export async function createSellerAndPremintedOffer(args: {
       args.sellerToCreate,
       collectionSalt,
       args.offerToCreate,
-      args.reservedRangeLength
+      args.premintParameters
     )
   });
 }
@@ -257,7 +258,7 @@ export async function createSellerAndPremintedOffer(args: {
 export async function createSellerAndPremintedOfferWithCondition(args: {
   sellerToCreate: CreateSellerArgs;
   offerToCreate: CreateOfferArgs;
-  reservedRangeLength: BigNumberish;
+  premintParameters: PremintParametersStruct;
   contractAddress: string;
   web3Lib: Web3LibAdapter;
   metadataStorage?: MetadataStorage;
@@ -294,7 +295,7 @@ export async function createSellerAndPremintedOfferWithCondition(args: {
       args.sellerToCreate,
       collectionSalt,
       args.offerToCreate,
-      args.reservedRangeLength,
+      args.premintParameters,
       args.condition
     )
   });

package/src/orchestration/interface.ts

@@ -7,6 +7,7 @@ import { CreateSellerArgs } from "../accounts/types";
 import { CreateOfferArgs } from "../offers/types";
 import { BigNumberish } from "@ethersproject/bignumber";
 import { conditionArgsToStructs } from "../groups/interface";
+import { PremintParametersStruct } from "@bosonprotocol/common/src";
 
 export const bosonOrchestrationHandlerIface = new Interface(
   abis.IBosonOrchestrationHandlerABI
@@ -29,7 +30,8 @@ export function encodeCreateSellerAndOffer(
       offerArgs[3], // disputeResolverId
       sellerArgs.authTokenStruct,
       sellerArgs.voucherInitValues,
-      offerArgs[4] // agentId
+      offerArgs[4], // agentId
+      offerArgs[5] // feeLimit
     ]
   );
 }
@@ -47,7 +49,8 @@ export function encodeCreateOfferWithCondition(
       offerArgs[2], // offerDurations
       offerArgs[3], // disputeResolverId
       conditionArgsToStructs(condition),
-      offerArgs[4] // agentId
+      offerArgs[4], // agentId
+      offerArgs[5] // feeLimit
     ]
   );
 }
@@ -71,14 +74,15 @@ export function encodeCreateSellerAndOfferWithCondition(
       conditionArgsToStructs(condition),
       sellerArgs.authTokenStruct,
       sellerArgs.voucherInitValues,
-      offerArgs[4] // agentId
+      offerArgs[4], // agentId
+      offerArgs[5] // feeLimit
     ]
   );
 }
 
 export function encodeCreatePremintedOfferAddToGroup(
   offer: CreateOfferArgs,
-  reservedRangeLength: BigNumberish,
+  premintParameters: PremintParametersStruct,
   groupId: BigNumberish
 ) {
   const offerArgs = createOfferArgsToStructs(offer);
@@ -90,16 +94,17 @@ export function encodeCreatePremintedOfferAddToGroup(
       offerArgs[1], // offerDates
       offerArgs[2], // offerDurations
       offerArgs[3], // disputeResolverId
-      reservedRangeLength,
+      premintParameters,
       groupId,
-      offerArgs[4] // agentId
+      offerArgs[4], // agentId
+      offerArgs[5] // feeLimit
     ]
   );
 }
 
 export function encodeCreatePremintedOfferWithCondition(
   offer: CreateOfferArgs,
-  reservedRangeLength: BigNumberish,
+  premintParameters: PremintParametersStruct,
   condition: ConditionStruct
 ) {
   const offerArgs = createOfferArgsToStructs(offer);
@@ -110,9 +115,10 @@ export function encodeCreatePremintedOfferWithCondition(
       offerArgs[1], // offerDates
       offerArgs[2], // offerDurations
       offerArgs[3], // disputeResolverId
-      reservedRangeLength,
+      premintParameters,
       conditionArgsToStructs(condition),
-      offerArgs[4] // agentId
+      offerArgs[4], // agentId
+      offerArgs[5] // feeLimit
     ]
   );
 }
@@ -121,7 +127,7 @@ export function encodeCreateSellerAndPremintedOffer(
   seller: CreateSellerArgs,
   collectionSalt: string,
   offer: CreateOfferArgs,
-  reservedRangeLength: BigNumberish
+  premintParameters: PremintParametersStruct
 ) {
   const sellerArgs = createSellerArgsToStruct(seller, collectionSalt);
   const offerArgs = createOfferArgsToStructs(offer);
@@ -133,10 +139,11 @@ export function encodeCreateSellerAndPremintedOffer(
       offerArgs[1], // offerDates
       offerArgs[2], // offerDurations
       offerArgs[3], // disputeResolverId
-      reservedRangeLength,
+      premintParameters,
       sellerArgs.authTokenStruct,
       sellerArgs.voucherInitValues,
-      offerArgs[4] // agentId
+      offerArgs[4], // agentId
+      offerArgs[5] // feeLimit
     ]
   );
 }
@@ -145,7 +152,7 @@ export function encodeCreateSellerAndPremintedOfferWithCondition(
   seller: CreateSellerArgs,
   collectionSalt: string,
   offer: CreateOfferArgs,
-  reservedRangeLength: BigNumberish,
+  premintParameters: PremintParametersStruct,
   condition: ConditionStruct
 ) {
   const sellerArgs = createSellerArgsToStruct(seller, collectionSalt);
@@ -158,11 +165,12 @@ export function encodeCreateSellerAndPremintedOfferWithCondition(
       offerArgs[1], // offerDates
       offerArgs[2], // offerDurations
       offerArgs[3], // disputeResolverId
-      reservedRangeLength,
+      premintParameters,
       conditionArgsToStructs(condition),
       sellerArgs.authTokenStruct,
       sellerArgs.voucherInitValues,
-      offerArgs[4] // agentId
+      offerArgs[4], // agentId
+      offerArgs[5] // feeLimit
     ]
   );
 }

package/src/orchestration/mixin.ts

@@ -3,6 +3,7 @@ import { BigNumberish } from "@ethersproject/bignumber";
 import { handler } from ".";
 import { offers, accounts } from "..";
 import { BaseCoreSDK } from "./../mixins/base-core-sdk";
+import { PremintParametersStruct } from "@bosonprotocol/common/src";
 
 export class OrchestrationMixin extends BaseCoreSDK {
   /**
@@ -66,7 +67,7 @@ export class OrchestrationMixin extends BaseCoreSDK {
    */
   public async createPremintedOfferAddToGroup(
     offerToCreate: offers.CreateOfferArgs,
-    reservedRangeLength: BigNumberish,
+    premintParameters: PremintParametersStruct,
     groupId: BigNumberish,
     overrides: Partial<{
       contractAddress: string;
@@ -74,7 +75,7 @@ export class OrchestrationMixin extends BaseCoreSDK {
   ): Promise<TransactionResponse> {
     return handler.createPremintedOfferAddToGroup({
       offerToCreate,
-      reservedRangeLength,
+      premintParameters,
       groupId,
       contractAddress: overrides.contractAddress || this._protocolDiamond,
       web3Lib: this._web3Lib,
@@ -95,7 +96,7 @@ export class OrchestrationMixin extends BaseCoreSDK {
   public async createSellerAndPremintedOffer(
     sellerToCreate: accounts.CreateSellerArgs,
     offerToCreate: offers.CreateOfferArgs,
-    reservedRangeLength: BigNumberish,
+    premintParameters: PremintParametersStruct,
     overrides: Partial<{
       contractAddress: string;
     }> = {}
@@ -103,7 +104,7 @@ export class OrchestrationMixin extends BaseCoreSDK {
     return handler.createSellerAndPremintedOffer({
       sellerToCreate,
       offerToCreate,
-      reservedRangeLength,
+      premintParameters,
       contractAddress: overrides.contractAddress || this._protocolDiamond,
       web3Lib: this._web3Lib,
       metadataStorage: this._metadataStorage,
@@ -121,7 +122,7 @@ export class OrchestrationMixin extends BaseCoreSDK {
    */
   public async createPremintedOfferWithCondition(
     offerToCreate: offers.CreateOfferArgs,
-    reservedRangeLength: BigNumberish,
+    premintParameters: PremintParametersStruct,
     condition: ConditionStruct,
     overrides: Partial<{
       contractAddress: string;
@@ -129,7 +130,7 @@ export class OrchestrationMixin extends BaseCoreSDK {
   ): Promise<TransactionResponse> {
     return handler.createPremintedOfferWithCondition({
       offerToCreate,
-      reservedRangeLength,
+      premintParameters,
       condition,
       contractAddress: overrides.contractAddress || this._protocolDiamond,
       web3Lib: this._web3Lib,
@@ -151,7 +152,7 @@ export class OrchestrationMixin extends BaseCoreSDK {
   public async createSellerAndPremintedOfferWithCondition(
     sellerToCreate: accounts.CreateSellerArgs,
     offerToCreate: offers.CreateOfferArgs,
-    reservedRangeLength: BigNumberish,
+    premintParameters: PremintParametersStruct,
     condition: ConditionStruct,
     overrides: Partial<{
       contractAddress: string;
@@ -160,7 +161,7 @@ export class OrchestrationMixin extends BaseCoreSDK {
     return handler.createSellerAndPremintedOfferWithCondition({
       sellerToCreate,
       offerToCreate,
-      reservedRangeLength,
+      premintParameters,
       contractAddress: overrides.contractAddress || this._protocolDiamond,
       web3Lib: this._web3Lib,
       metadataStorage: this._metadataStorage,

package/src/protocol-config/handler.ts

@@ -0,0 +1,16 @@
+import { Web3LibAdapter } from "@bosonprotocol/common";
+import {
+  encodeGetMaxRoyaltyPercentage,
+  decodeGetMaxRoyaltyPercentage
+} from "./interface";
+
+export async function getMaxRoyaltyPercentage(args: {
+  contractAddress: string;
+  web3Lib: Web3LibAdapter;
+}): Promise<number> {
+  const result = await args.web3Lib.call({
+    to: args.contractAddress,
+    data: encodeGetMaxRoyaltyPercentage()
+  });
+  return decodeGetMaxRoyaltyPercentage(result);
+}

package/src/protocol-config/index.ts

@@ -0,0 +1,2 @@
+export * as handler from "./handler";
+export * as iface from "./interface";

package/src/protocol-config/interface.ts

@@ -0,0 +1,18 @@
+import { abis } from "@bosonprotocol/common";
+import { Interface } from "@ethersproject/abi";
+
+export const bosonConfigHandlerIface = new Interface(
+  abis.IBosonConfigHandlerABI
+);
+
+export function encodeGetMaxRoyaltyPercentage(): string {
+  return bosonConfigHandlerIface.encodeFunctionData("getMaxRoyaltyPercentage");
+}
+
+export function decodeGetMaxRoyaltyPercentage(result: string): number {
+  const [maxRoyaltyPercentage] = bosonConfigHandlerIface.decodeFunctionResult(
+    "getMaxRoyaltyPercentage",
+    result
+  );
+  return Number(maxRoyaltyPercentage);
+}

package/src/protocol-config/mixin.ts

@@ -0,0 +1,15 @@
+import { BaseCoreSDK } from "../mixins/base-core-sdk";
+import { handler } from ".";
+
+export class ProtocolConfigMixin extends BaseCoreSDK {
+  public async getMaxRoyaltyPercentage(
+    overrides: Partial<{
+      contractAddress: string;
+    }> = {}
+  ): Promise<number> {
+    return handler.getMaxRoyaltyPercentage({
+      contractAddress: overrides.contractAddress || this._protocolDiamond,
+      web3Lib: this._web3Lib
+    });
+  }
+}