@bosonprotocol/core-sdk 1.6.0-alpha.8 → 1.6.0

package/src/exchanges/subgraph.ts

@@ -1,34 +1,35 @@
 import { getSubgraphSdk } from "../utils/graphql";
-import { ExchangeFieldsFragment, QueryExchangesArgs } from "../subgraph";
+import {
+  ExchangeFieldsFragment,
+  GetExchangesQueryQueryVariables,
+  GetExchangeByIdQueryQueryVariables
+} from "../subgraph";
 import { BigNumberish } from "@ethersproject/bignumber";
 
-export type ExchangesQueryOpts = Pick<
-  QueryExchangesArgs,
-  "first" | "orderBy" | "orderDirection" | "skip"
+export type SingleExchangeQueryVariables = Omit<
+  GetExchangeByIdQueryQueryVariables,
+  "exchangeId"
 >;
 
-export async function getExchangeById(
+export async function getExchanges(
   subgraphUrl: string,
-  exchangeId: BigNumberish
-): Promise<ExchangeFieldsFragment> {
+  queryVars: GetExchangesQueryQueryVariables = {}
+): Promise<ExchangeFieldsFragment[]> {
   const sdk = getSubgraphSdk(subgraphUrl);
-  const { exchange } = await sdk.getExchangeByIdQuery({
-    exchangeId: exchangeId.toString()
-  });
-
-  return exchange;
+  const { exchanges = [] } = await sdk.getExchangesQuery(queryVars);
+  return exchanges;
 }
 
-export async function getExchangesByOfferId(
+export async function getExchangeById(
   subgraphUrl: string,
-  offerId: BigNumberish,
-  opts: ExchangesQueryOpts = {}
-): Promise<ExchangeFieldsFragment[]> {
+  exchangeId: BigNumberish,
+  queryVars: SingleExchangeQueryVariables = {}
+): Promise<ExchangeFieldsFragment> {
   const sdk = getSubgraphSdk(subgraphUrl);
-  const { exchanges = [] } = await sdk.getExchangesByOfferId({
-    offerId: offerId.toString(),
-    ...opts
+  const { exchange } = await sdk.getExchangeByIdQuery({
+    exchangeId: exchangeId.toString(),
+    ...queryVars
   });
 
-  return exchanges;
+  return exchange;
 }

package/src/funds/queries.graphql

@@ -1,5 +1,23 @@
-query getFundsByAccountIdQuery($accountId: BigInt!) {
-  fundsEntities(where: { accountId: $accountId }) {
+query getFundsById($fundsId: ID!) {
+  fundsEntity(id: $fundsId) {
+    ...FundsEntityFields
+  }
+}
+
+query getFunds(
+  $fundsSkip: Int
+  $fundsFirst: Int
+  $fundsOrderBy: FundsEntity_orderBy
+  $fundsOrderDirection: OrderDirection
+  $fundsFilter: FundsEntity_filter
+) {
+  fundsEntities(
+    skip: $fundsSkip
+    first: $fundsFirst
+    orderBy: $fundsOrderBy
+    orderDirection: $fundsOrderDirection
+    where: $fundsFilter
+  ) {
     ...FundsEntityFields
   }
 }

package/src/funds/subgraph.ts

@@ -1,16 +1,35 @@
-import { BigNumberish } from "@ethersproject/bignumber";
 import { getSubgraphSdk } from "../utils/graphql";
-import { FundsEntityFieldsFragment } from "../subgraph";
+import {
+  FundsEntityFieldsFragment,
+  GetFundsByIdQueryVariables,
+  GetFundsQueryVariables
+} from "../subgraph";
+import { BigNumberish } from "@ethersproject/bignumber";
 
-export async function getFundsByAccountId(
+export type SingleFundsQueryVariables = Omit<
+  GetFundsByIdQueryVariables,
+  "fundsId"
+>;
+
+export async function getFunds(
   subgraphUrl: string,
-  accountId: BigNumberish
+  queryVars: GetFundsQueryVariables = {}
 ): Promise<FundsEntityFieldsFragment[]> {
-  const subgraphSdk = getSubgraphSdk(subgraphUrl);
+  const sdk = getSubgraphSdk(subgraphUrl);
+  const { fundsEntities = [] } = await sdk.getFunds(queryVars);
+  return fundsEntities;
+}
 
-  const { fundsEntities = [] } = await subgraphSdk.getFundsByAccountIdQuery({
-    accountId: accountId.toString()
+export async function getFundsById(
+  subgraphUrl: string,
+  fundsId: BigNumberish,
+  queryVars: SingleFundsQueryVariables = {}
+): Promise<FundsEntityFieldsFragment> {
+  const sdk = getSubgraphSdk(subgraphUrl);
+  const { fundsEntity } = await sdk.getFundsById({
+    fundsId: fundsId.toString(),
+    ...queryVars
   });
 
-  return fundsEntities;
+  return fundsEntity;
 }

package/src/offers/interface.ts

@@ -7,6 +7,7 @@ import {
 } from "@bosonprotocol/common";
 import { Interface } from "@ethersproject/abi";
 import { getAddress } from "@ethersproject/address";
+import { BigNumber } from "@ethersproject/bignumber";
 import { CreateOfferArgs } from "./types";
 
 export const bosonOfferHandlerIface = new Interface(abis.IBosonOfferHandlerABI);
@@ -49,8 +50,7 @@ export function argsToOfferDatesStruct(
   const {
     validFromDateInMS,
     validUntilDateInMS,
-    voucherRedeemableFromDateInMS,
-    voucherRedeemableUntilDateInMS
+    voucherRedeemableFromDateInMS
   } = args;
 
   return {
@@ -59,9 +59,10 @@ export function argsToOfferDatesStruct(
     voucherRedeemableFrom: utils.timestamp.msToSec(
       voucherRedeemableFromDateInMS
     ),
-    voucherRedeemableUntil: utils.timestamp.msToSec(
-      voucherRedeemableUntilDateInMS
-    )
+    voucherRedeemableUntil:
+      // NOTE: Field `voucherRedeemableUntil` not yet fully supported in protocol.
+      // Therefore converting to `voucherValid` field.
+      "0"
   };
 }
 
@@ -70,13 +71,22 @@ export function argsToOfferDurationsStruct(
 ): Partial<OfferDurationsStruct> {
   const {
     fulfillmentPeriodDurationInMS,
+    voucherRedeemableUntilDateInMS,
+    voucherRedeemableFromDateInMS,
     voucherValidDurationInMS = 0,
     resolutionPeriodDurationInMS
   } = args;
 
   return {
     fulfillmentPeriod: utils.timestamp.msToSec(fulfillmentPeriodDurationInMS),
-    voucherValid: utils.timestamp.msToSec(voucherValidDurationInMS),
+    voucherValid: utils.timestamp.msToSec(
+      voucherValidDurationInMS ||
+        // NOTE: Field `voucherRedeemableUntil` not yet fully supported in protocol.
+        // Therefore converting to `voucherValid` field.
+        BigNumber.from(voucherRedeemableUntilDateInMS).sub(
+          BigNumber.from(voucherRedeemableFromDateInMS)
+        )
+    ),
     resolutionPeriod: utils.timestamp.msToSec(resolutionPeriodDurationInMS)
   };
 }

package/src/offers/queries.graphql

@@ -1,29 +1,55 @@
-query getOfferByIdQuery($offerId: ID!) {
+query getOfferByIdQuery(
+  $offerId: ID!
+  $exchangesSkip: Int
+  $exchangesFirst: Int
+  $exchangesOrderBy: Exchange_orderBy
+  $exchangesOrderDirection: OrderDirection
+  $exchangesFilter: Exchange_filter
+  $includeExchanges: Boolean = false
+) {
   offer(id: $offerId) {
     ...OfferFields
   }
 }
 
-query getAllOffersOfOperatorQuery(
-  $operator: Bytes!
-  $first: Int
-  $skip: Int
-  $orderBy: Offer_orderBy
-  $orderDirection: OrderDirection
+query getOffersQuery(
+  $offersSkip: Int
+  $offersFirst: Int
+  $offersOrderBy: Offer_orderBy
+  $offersOrderDirection: OrderDirection
+  $offersFilter: Offer_filter
+  $exchangesSkip: Int
+  $exchangesFirst: Int
+  $exchangesOrderBy: Exchange_orderBy
+  $exchangesOrderDirection: OrderDirection
+  $exchangesFilter: Exchange_filter
+  $includeExchanges: Boolean = false
 ) {
-  sellers(where: { operator: $operator }) {
-    offers(
-      first: $first
-      skip: $skip
-      orderBy: $orderBy
-      orderDirection: $orderDirection
-    ) {
-      ...OfferFields
-    }
+  offers(
+    skip: $offersSkip
+    first: $offersFirst
+    orderBy: $offersOrderBy
+    orderDirection: $offersOrderDirection
+    where: $offersFilter
+  ) {
+    ...OfferFields
   }
 }
 
 fragment OfferFields on Offer {
+  ...BaseOfferFields
+  exchanges(
+    skip: $exchangesSkip
+    first: $exchangesFirst
+    orderBy: $exchangesOrderBy
+    orderDirection: $exchangesOrderDirection
+    where: $exchangesFilter
+  ) @include(if: $includeExchanges) {
+    ...BaseExchangeFields
+  }
+}
+
+fragment BaseOfferFields on Offer {
   id
   createdAt
   price
@@ -44,12 +70,7 @@ fragment OfferFields on Offer {
   voidedAt
   disputeResolverId
   seller {
-    id
-    operator
-    admin
-    clerk
-    treasury
-    active
+    ...BaseSellerFields
   }
   exchangeToken {
     address

package/src/offers/subgraph.ts

@@ -1,40 +1,38 @@
 import { BigNumberish } from "@ethersproject/bignumber";
 import { getSubgraphSdk } from "../utils/graphql";
-import { OfferFieldsFragment, QueryOffersArgs } from "../subgraph";
-
-export type AllOffersQueryOpts = Pick<
-  QueryOffersArgs,
-  "first" | "orderBy" | "orderDirection" | "skip"
+import {
+  OfferFieldsFragment,
+  GetOfferByIdQueryQueryVariables,
+  GetOffersQueryQueryVariables
+} from "../subgraph";
+
+export type SingleOfferQueryVariables = Omit<
+  GetOfferByIdQueryQueryVariables,
+  "offerId"
 >;
 
 export async function getOfferById(
   subgraphUrl: string,
-  offerId: BigNumberish
+  offerId: BigNumberish,
+  queryVars: SingleOfferQueryVariables = {}
 ): Promise<OfferFieldsFragment> {
   const subgraphSdk = getSubgraphSdk(subgraphUrl);
-
   const { offer } = await subgraphSdk.getOfferByIdQuery({
-    offerId: offerId.toString()
+    offerId: offerId.toString(),
+    ...queryVars
   });
 
   return offer;
 }
 
-export async function getAllOffersOfOperator(
+export async function getOffers(
   subgraphUrl: string,
-  operatorAddress: string,
-  opts: AllOffersQueryOpts = {}
+  queryVars: GetOffersQueryQueryVariables = {}
 ): Promise<OfferFieldsFragment[]> {
   const subgraphSdk = getSubgraphSdk(subgraphUrl);
-
-  const { sellers = [] } = await subgraphSdk.getAllOffersOfOperatorQuery({
-    operator: operatorAddress,
-    ...opts
+  const { offers = [] } = await subgraphSdk.getOffersQuery({
+    ...queryVars
   });
 
-  if (!sellers || sellers.length === 0) {
-    return [];
-  }
-
-  return sellers[0].offers;
+  return offers;
 }