@bosonprotocol/core-sdk 1.33.1-alpha.2 → 1.34.0-alpha.0

package/src/accounts/interface.ts

@@ -15,16 +15,21 @@ import {
   OptInToSellerUpdateArgs,
   SellerUpdateFields,
   OptInToDisputeResolverUpdateArgs,
-  DisputeResolverUpdateFields
+  DisputeResolverUpdateFields,
+  CreateCollectionArgs
 } from "./types";
 import { AddressZero } from "@ethersproject/constants";
+import { INITIAL_COLLECTION_ID } from "./handler";
 
 export const bosonAccountHandlerIface = new Interface(
   abis.IBosonAccountHandlerABI
 );
 
-export function encodeCreateSeller(seller: CreateSellerArgs) {
-  const sellerArgs = createSellerArgsToStruct(seller);
+export function encodeCreateSeller(
+  seller: CreateSellerArgs,
+  collectionSalt: string
+) {
+  const sellerArgs = createSellerArgsToStruct(seller, collectionSalt);
   return bosonAccountHandlerIface.encodeFunctionData("createSeller", [
     sellerArgs.sellerStruct,
     sellerArgs.authTokenStruct,
@@ -32,6 +37,14 @@ export function encodeCreateSeller(seller: CreateSellerArgs) {
   ]);
 }
 
+export function encodeCreateNewCollection(collection: CreateCollectionArgs) {
+  const collectionArgs = createCollectionArgsToStruct(collection);
+  return bosonAccountHandlerIface.encodeFunctionData("createNewCollection", [
+    collectionArgs.externalId,
+    collectionArgs.voucherInitValues
+  ]);
+}
+
 export function encodeUpdateSeller(seller: UpdateSellerArgs) {
   const sellerArgs = updateSellerArgsToStruct(seller);
   return bosonAccountHandlerIface.encodeFunctionData("updateSeller", [
@@ -129,7 +142,10 @@ export function encodeOptInToDisputeResolverUpdate(
 }
 
 // TODO: add a unit test for collectionId
-export function createSellerArgsToStruct(args: CreateSellerArgs): {
+export function createSellerArgsToStruct(
+  args: CreateSellerArgs,
+  collectionSalt: string
+): {
   sellerStruct: Partial<SellerStruct>;
   authTokenStruct: AuthTokenStruct;
   voucherInitValues: VoucherInitValuesStruct;
@@ -139,10 +155,8 @@ export function createSellerArgsToStruct(args: CreateSellerArgs): {
     authTokenType,
     contractUri,
     royaltyPercentage,
-    collectionId,
     ...sellerStructArgs
   } = args;
-  const collectionSalt = formatBytes32String(collectionId || "collection-0");
   return {
     sellerStruct: argsToSellerStruct(sellerStructArgs),
     authTokenStruct: {
@@ -157,6 +171,24 @@ export function createSellerArgsToStruct(args: CreateSellerArgs): {
   };
 }
 
+export function createCollectionArgsToStruct(args: CreateCollectionArgs): {
+  externalId: string;
+  voucherInitValues: VoucherInitValuesStruct;
+} {
+  const { collectionId, contractUri, royaltyPercentage } = args;
+  const collectionSalt =
+    args.collectionSalt ||
+    formatBytes32String(collectionId || INITIAL_COLLECTION_ID);
+  return {
+    externalId: collectionId,
+    voucherInitValues: {
+      contractURI: contractUri,
+      royaltyPercentage,
+      collectionSalt
+    }
+  };
+}
+
 export function updateSellerArgsToStruct(args: UpdateSellerArgs) {
   const { authTokenId, authTokenType, ...sellerStructArgs } = args;
   return {
@@ -201,3 +233,43 @@ function createDisputeResolverArgsToDisputeResolverStruct(
     )
   };
 }
+
+export function encodeIsSellerSaltAvailable(
+  adminAddress: string,
+  salt: string
+) {
+  return bosonAccountHandlerIface.encodeFunctionData("isSellerSaltAvailable", [
+    adminAddress,
+    salt
+  ]);
+}
+
+export function decodeIsSellerSaltAvailable(result: string): boolean {
+  const [isAvailable] = bosonAccountHandlerIface.decodeFunctionResult(
+    "isSellerSaltAvailable",
+    result
+  );
+  return isAvailable;
+}
+
+export function encodeCalculateCollectionAddress(
+  sellerId: BigNumberish,
+  collectionSalt: string
+) {
+  return bosonAccountHandlerIface.encodeFunctionData(
+    "calculateCollectionAddress",
+    [sellerId, collectionSalt]
+  );
+}
+
+export function decodeCalculateCollectionAddress(result: string): {
+  collectionAddress: string;
+  isAvailable: boolean;
+} {
+  const [collectionAddress, isAvailable] =
+    bosonAccountHandlerIface.decodeFunctionResult(
+      "calculateCollectionAddress",
+      result
+    );
+  return { collectionAddress, isAvailable };
+}

package/src/accounts/mixin.ts

@@ -588,4 +588,30 @@ export class AccountsMixin extends BaseCoreSDK {
   ): Promise<subgraph.DisputeResolverFieldsFragment[]> {
     return accounts.subgraph.getDisputeResolvers(this._subgraphUrl, queryVars);
   }
+
+  public async createNewCollection(
+    collectionToCreate: accounts.CreateCollectionArgs,
+    overrides: Partial<{
+      contractAddress: string;
+    }> = {}
+  ): Promise<TransactionResponse> {
+    if (!collectionToCreate.sellerId) {
+      const { id: sellerId } = await this.getSellerByAssistant(
+        await this._web3Lib.getSignerAddress()
+      );
+      // If the caller is not a seller, the sellerId remains undefined
+      collectionToCreate.sellerId = sellerId;
+    }
+    return accounts.handler.createNewCollection({
+      collectionToCreate,
+      web3Lib: this._web3Lib,
+      contractAddress: overrides.contractAddress || this._protocolDiamond
+    });
+  }
+
+  public async getOfferCollections(
+    queryVars?: subgraph.GetOfferCollectionsQueryQueryVariables
+  ): Promise<subgraph.OfferCollectionFieldsFragment[]> {
+    return accounts.subgraph.getOfferCollections(this._subgraphUrl, queryVars);
+  }
 }

package/src/accounts/queries.graphql

@@ -208,8 +208,69 @@ query getConditionalCommitAuthorizedEventLogsQuery(
   }
 }
 
+query getOfferCollectionsQuery(
+  $offerCollectionsSkip: Int
+  $offerCollectionsFirst: Int
+  $offerCollectionsOrderBy: OfferCollection_orderBy
+  $offerCollectionsOrderDirection: OrderDirection
+  $offerCollectionsFilter: OfferCollection_filter
+  $offersSkip: Int
+  $offersFirst: Int
+  $offersOrderBy: Offer_orderBy
+  $offersOrderDirection: OrderDirection
+  $offersFilter: Offer_filter
+  $includeOffers: Boolean = false
+) {
+  offerCollections(
+    skip: $offerCollectionsSkip
+    first: $offerCollectionsFirst
+    orderBy: $offerCollectionsOrderBy
+    orderDirection: $offerCollectionsOrderDirection
+    where: $offerCollectionsFilter
+  ) {
+    ...OfferCollectionFields
+  }
+}
+
+fragment OfferCollectionFields on OfferCollection {
+  ...BaseOfferCollectionFields
+  seller {
+    ...BaseSellerFields
+  }
+  offers(
+    skip: $offersSkip
+    first: $offersFirst
+    orderBy: $offersOrderBy
+    orderDirection: $offersOrderDirection
+    where: $offersFilter
+  ) @include(if: $includeOffers) {
+    ...BaseOfferFields
+  }
+}
+
+fragment BaseOfferCollectionFields on OfferCollection {
+  id
+  sellerId
+  collectionIndex
+  collectionAddress
+  externalIdHash
+  externalId
+  metadata {
+    id
+    name
+    description
+    image
+    externalLink
+    createdAt
+    collaborators
+  }
+}
+
 fragment SellerFields on Seller {
   ...BaseSellerFields
+  collections {
+    ...BaseOfferCollectionFields
+  }
   pendingSeller {
     ...PendingSellerFields
   }

package/src/accounts/subgraph.ts

@@ -8,7 +8,9 @@ import {
   GetSellerByIdQueryQueryVariables,
   GetDisputeResolverByIdQueryQueryVariables,
   GetDisputeResolversQueryQueryVariables,
-  DisputeResolverFieldsFragment
+  DisputeResolverFieldsFragment,
+  GetOfferCollectionsQueryQueryVariables,
+  OfferCollectionFieldsFragment
 } from "../subgraph";
 import { BigNumberish } from "@ethersproject/bignumber";
 
@@ -169,3 +171,14 @@ export async function getDisputeResolvers(
   );
   return disputeResolvers;
 }
+
+export async function getOfferCollections(
+  subgraphUrl: string,
+  queryVars: GetOfferCollectionsQueryQueryVariables = {}
+): Promise<OfferCollectionFieldsFragment[]> {
+  const sdk = getSubgraphSdk(subgraphUrl);
+  const { offerCollections = [] } = await sdk.getOfferCollectionsQuery(
+    queryVars
+  );
+  return offerCollections;
+}

package/src/accounts/types.ts

@@ -13,7 +13,8 @@ export {
   OptInToSellerUpdateArgs,
   DisputeResolverUpdateFields,
   OptInToDisputeResolverUpdateArgs,
-  utils
+  utils,
+  CreateCollectionArgs
 } from "@bosonprotocol/common";
 
 export type CreateDisputeResolverArgs = {

package/src/meta-tx/handler.ts

@@ -54,6 +54,7 @@ import { ERC20ForwardRequest } from "../forwarder/biconomy-interface";
 import { getNonce, verifyEIP712 } from "../forwarder/handler";
 import { MockForwardRequest } from "../forwarder/mock-interface";
 import { isTrustedForwarder } from "../voucher/handler";
+import { findCollectionSalt } from "../accounts/handler";
 
 export type BaseMetaTxArgs = {
   web3Lib: Web3LibAdapter;
@@ -395,11 +396,16 @@ export async function signMetaTxCreateSeller(
     metadataStorage: args.metadataStorage,
     theGraphStorage: args.theGraphStorage
   });
+  const collectionSalt = await findCollectionSalt({
+    sellerToCreate: args.createSellerArgs,
+    contractAddress: args.metaTxHandlerAddress,
+    ...args
+  });
   return signMetaTx({
     ...args,
     functionName:
       "createSeller((uint256,address,address,address,address,bool,string),(uint256,uint8),(string,uint256,bytes32))",
-    functionSignature: encodeCreateSeller(args.createSellerArgs)
+    functionSignature: encodeCreateSeller(args.createSellerArgs, collectionSalt)
   });
 }
 

package/src/offers/queries.graphql

@@ -133,6 +133,9 @@ fragment BaseOfferFields on Offer {
   seller {
     ...BaseSellerFields
   }
+  collection {
+    ...BaseOfferCollectionFields
+  }
   exchangeToken {
     ...BaseExchangeTokenFields
   }

package/src/orchestration/handler.ts

@@ -20,6 +20,7 @@ import { storeMetadataOnTheGraph } from "../offers/storage";
 import { CreateOfferArgs } from "../offers/types";
 import { CreateSellerArgs } from "../accounts/types";
 import { BigNumberish } from "@ethersproject/bignumber";
+import { findCollectionSalt } from "../accounts/handler";
 
 export async function createOfferAndSeller(args: {
   offerToCreate: CreateOfferArgs;
@@ -48,9 +49,14 @@ export async function createOfferAndSeller(args: {
     )
   );
 
+  const collectionSalt = await findCollectionSalt(args);
   return args.web3Lib.sendTransaction({
     to: args.contractAddress,
-    data: encodeCreateSellerAndOffer(args.sellerToCreate, args.offerToCreate)
+    data: encodeCreateSellerAndOffer(
+      args.sellerToCreate,
+      collectionSalt,
+      args.offerToCreate
+    )
   });
 }
 
@@ -102,10 +108,12 @@ export async function createSellerAndOfferWithCondition(args: {
     )
   );
 
+  const collectionSalt = await findCollectionSalt(args);
   return args.web3Lib.sendTransaction({
     to: args.contractAddress,
     data: encodeCreateSellerAndOfferWithCondition(
       args.sellerToCreate,
+      collectionSalt,
       args.offerToCreate,
       args.condition
     )
@@ -194,10 +202,12 @@ export async function createSellerAndPremintedOffer(args: {
     )
   );
 
+  const collectionSalt = await findCollectionSalt(args);
   return args.web3Lib.sendTransaction({
     to: args.contractAddress,
     data: encodeCreateSellerAndPremintedOffer(
       args.sellerToCreate,
+      collectionSalt,
       args.offerToCreate,
       args.reservedRangeLength
     )
@@ -229,10 +239,12 @@ export async function createSellerAndPremintedOfferWithCondition(args: {
     )
   );
 
+  const collectionSalt = await findCollectionSalt(args);
   return args.web3Lib.sendTransaction({
     to: args.contractAddress,
     data: encodeCreateSellerAndPremintedOfferWithCondition(
       args.sellerToCreate,
+      collectionSalt,
       args.offerToCreate,
       args.reservedRangeLength,
       args.condition

package/src/orchestration/interface.ts

@@ -14,9 +14,10 @@ export const bosonOrchestrationHandlerIface = new Interface(
 
 export function encodeCreateSellerAndOffer(
   seller: CreateSellerArgs,
+  collectionSalt: string,
   offer: CreateOfferArgs
 ) {
-  const sellerArgs = createSellerArgsToStruct(seller);
+  const sellerArgs = createSellerArgsToStruct(seller, collectionSalt);
   const offerArgs = createOfferArgsToStructs(offer);
   return bosonOrchestrationHandlerIface.encodeFunctionData(
     "createSellerAndOffer",
@@ -53,10 +54,11 @@ export function encodeCreateOfferWithCondition(
 
 export function encodeCreateSellerAndOfferWithCondition(
   seller: CreateSellerArgs,
+  collectionSalt: string,
   offer: CreateOfferArgs,
   condition: ConditionStruct
 ) {
-  const sellerArgs = createSellerArgsToStruct(seller);
+  const sellerArgs = createSellerArgsToStruct(seller, collectionSalt);
   const offerArgs = createOfferArgsToStructs(offer);
   return bosonOrchestrationHandlerIface.encodeFunctionData(
     "createSellerAndOfferWithCondition",
@@ -117,10 +119,11 @@ export function encodeCreatePremintedOfferWithCondition(
 
 export function encodeCreateSellerAndPremintedOffer(
   seller: CreateSellerArgs,
+  collectionSalt: string,
   offer: CreateOfferArgs,
   reservedRangeLength: BigNumberish
 ) {
-  const sellerArgs = createSellerArgsToStruct(seller);
+  const sellerArgs = createSellerArgsToStruct(seller, collectionSalt);
   const offerArgs = createOfferArgsToStructs(offer);
   return bosonOrchestrationHandlerIface.encodeFunctionData(
     "createSellerAndPremintedOffer",
@@ -140,11 +143,12 @@ export function encodeCreateSellerAndPremintedOffer(
 
 export function encodeCreateSellerAndPremintedOfferWithCondition(
   seller: CreateSellerArgs,
+  collectionSalt: string,
   offer: CreateOfferArgs,
   reservedRangeLength: BigNumberish,
   condition: ConditionStruct
 ) {
-  const sellerArgs = createSellerArgsToStruct(seller);
+  const sellerArgs = createSellerArgsToStruct(seller, collectionSalt);
   const offerArgs = createOfferArgsToStructs(offer);
   return bosonOrchestrationHandlerIface.encodeFunctionData(
     "createSellerAndPremintedOfferWithCondition",