@bosonprotocol/core-sdk 1.6.0-alpha.3 → 1.6.0-alpha.4

package/dist/esm/utils/graphql.d.ts

@@ -0,0 +1,28 @@
+export declare function getSubgraphSdk(subgraphUrl: string): {
+    getSellerByOperatorQuery(variables: import("../subgraph").Exact<{
+        operator: string;
+        fundsTokenAddress?: string;
+    }>, requestHeaders?: Record<string, string> | import("graphql-request/dist/types.dom").Headers | string[][]): Promise<import("../subgraph").GetSellerByOperatorQueryQuery>;
+    getSellerByAdminQuery(variables: import("../subgraph").Exact<{
+        admin: string;
+        fundsTokenAddress?: string;
+    }>, requestHeaders?: Record<string, string> | import("graphql-request/dist/types.dom").Headers | string[][]): Promise<import("../subgraph").GetSellerByAdminQueryQuery>;
+    getSellerByClerkQuery(variables: import("../subgraph").Exact<{
+        clerk: string;
+        fundsTokenAddress?: string;
+    }>, requestHeaders?: Record<string, string> | import("graphql-request/dist/types.dom").Headers | string[][]): Promise<import("../subgraph").GetSellerByClerkQueryQuery>;
+    getFundsByAccountIdQuery(variables: import("../subgraph").Exact<{
+        accountId: string;
+    }>, requestHeaders?: Record<string, string> | import("graphql-request/dist/types.dom").Headers | string[][]): Promise<import("../subgraph").GetFundsByAccountIdQueryQuery>;
+    getOfferByIdQuery(variables: import("../subgraph").Exact<{
+        offerId: string;
+    }>, requestHeaders?: Record<string, string> | import("graphql-request/dist/types.dom").Headers | string[][]): Promise<import("../subgraph").GetOfferByIdQueryQuery>;
+    getAllOffersOfOperatorQuery(variables: import("../subgraph").Exact<{
+        operator: string;
+        first?: number;
+        skip?: number;
+        orderBy?: import("../subgraph").Offer_OrderBy;
+        orderDirection?: import("../subgraph").OrderDirection;
+    }>, requestHeaders?: Record<string, string> | import("graphql-request/dist/types.dom").Headers | string[][]): Promise<import("../subgraph").GetAllOffersOfOperatorQueryQuery>;
+};
+//# sourceMappingURL=graphql.d.ts.map

package/dist/esm/utils/graphql.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"graphql.d.ts","sourceRoot":"","sources":["../../../src/utils/graphql.ts"],"names":[],"mappings":"AAGA,wBAAgB,cAAc,CAAC,WAAW,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;EAGjD"}

package/dist/esm/utils/graphql.js

@@ -0,0 +1,7 @@
+import { GraphQLClient } from "graphql-request";
+import { getSdk } from "../subgraph";
+export function getSubgraphSdk(subgraphUrl) {
+    const client = new GraphQLClient(subgraphUrl);
+    return getSdk(client);
+}
+//# sourceMappingURL=graphql.js.map

package/dist/esm/utils/graphql.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"graphql.js","sourceRoot":"","sources":["../../../src/utils/graphql.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,MAAM,UAAU,cAAc,CAAC,WAAmB;IAChD,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,WAAW,CAAC,CAAC;IAC9C,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;AACxB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bosonprotocol/core-sdk",
-  "version": "1.6.0-alpha.3",
+  "version": "1.6.0-alpha.4",
   "description": "> TODO: description",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -8,6 +8,7 @@
   "scripts": {
     "dev": "tsc --watch --preserveWatchOutput ",
     "lint": "eslint --ignore-path ../../.gitignore --ext .js,.ts .",
+    "lint:fix": "npm run lint -- --fix",
     "build": "rimraf dist && tsc && tsc --build tsconfig.cjs.json",
     "test": "jest",
     "clean": "rimraf dist coverage .turbo node_modules"
@@ -30,13 +31,15 @@
     "access": "restricted"
   },
   "dependencies": {
-    "@bosonprotocol/common": "^1.6.0-alpha.3",
+    "@bosonprotocol/common": "^1.6.0-alpha.4",
     "@ethersproject/abi": "^5.5.0",
     "@ethersproject/address": "^5.5.0",
     "@ethersproject/bignumber": "^5.5.0",
     "@ethersproject/constants": "^5.5.0",
     "@ethersproject/units": "^5.5.0",
-    "cross-fetch": "^3.1.5"
+    "cross-fetch": "^3.1.5",
+    "graphql": "^16.5.0",
+    "graphql-request": "^4.3.0"
   },
   "devDependencies": {
     "eslint": "^8.10.0",
@@ -46,5 +49,5 @@
     "ts-jest": "^27.1.3",
     "typescript": "^4.5.5"
   },
-  "gitHead": "013bc427d0c100cdaa6c55631440f7b83d720726"
+  "gitHead": "1c0b75626796800f55c0a0d8f178ea7e17f5e678"
 }

package/src/accounts/queries.graphql

@@ -0,0 +1,35 @@
+query getSellerByOperatorQuery($operator: Bytes!, $fundsTokenAddress: Bytes) {
+  sellers(where: { operator: $operator }) {
+    ...SellerFields
+  }
+}
+
+query getSellerByAdminQuery($admin: Bytes!, $fundsTokenAddress: Bytes) {
+  sellers(where: { admin: $admin }) {
+    ...SellerFields
+  }
+}
+
+query getSellerByClerkQuery($clerk: Bytes!, $fundsTokenAddress: Bytes) {
+  sellers(where: { clerk: $clerk }) {
+    ...SellerFields
+  }
+}
+
+fragment SellerFields on Seller {
+  id
+  operator
+  admin
+  clerk
+  treasury
+  active
+  funds(where: { tokenAddress: $fundsTokenAddress }) {
+    availableAmount
+    token {
+      address
+      decimals
+      name
+      symbol
+    }
+  }
+}

package/src/accounts/subgraph.ts

@@ -1,47 +1,13 @@
-import { fetchSubgraph } from "../utils/subgraph";
-import { RawSellerFromSubgraph } from "./types";
-
-export const sellerFieldsFragment = `
-fragment sellerFields on Seller {
-  id
-  operator
-  admin
-  clerk
-  treasury
-  active
-  funds(where: {
-    tokenAddress: $fundsTokenAddress
-  }) {
-    availableAmount
-    token {
-      address
-      decimals
-      name
-      symbol
-    }
-  }
-}
-`;
-
-export const getSellerByOperatorQuery = `
-query GetSellersByOperator($operator: String!, $fundsTokenAddress: String) {
-  sellers(where: {
-    operator: $operator
-  }) {
-    ...sellerFields
-  }
-}
-${sellerFieldsFragment}
-`;
+import { getSubgraphSdk } from "../utils/graphql";
+import { SellerFieldsFragment } from "../subgraph";
 
 export async function getSellerByOperator(
   subgraphUrl: string,
   operatorAddress: string,
   fundsTokenAddress?: string
-): Promise<RawSellerFromSubgraph> {
-  const { sellers = [] } = await fetchSubgraph<{
-    sellers: RawSellerFromSubgraph[];
-  }>(subgraphUrl, getSellerByOperatorQuery, {
+): Promise<SellerFieldsFragment> {
+  const sdk = getSubgraphSdk(subgraphUrl);
+  const { sellers = [] } = await sdk.getSellerByOperatorQuery({
     operator: operatorAddress,
     fundsTokenAddress
   });
@@ -49,25 +15,13 @@ export async function getSellerByOperator(
   return sellers[0];
 }
 
-export const getSellerByAdminQuery = `
-query GetSellersByAdmin($admin: String!, $fundsToken: String) {
-  sellers(where: {
-    admin: $admin
-  }) {
-    ...sellerFields
-  }
-}
-${sellerFieldsFragment}
-`;
-
 export async function getSellerByAdmin(
   subgraphUrl: string,
   adminAddress: string,
   fundsTokenAddress?: string
-): Promise<RawSellerFromSubgraph> {
-  const { sellers = [] } = await fetchSubgraph<{
-    sellers: RawSellerFromSubgraph[];
-  }>(subgraphUrl, getSellerByAdminQuery, {
+): Promise<SellerFieldsFragment> {
+  const sdk = getSubgraphSdk(subgraphUrl);
+  const { sellers = [] } = await sdk.getSellerByAdminQuery({
     admin: adminAddress,
     fundsTokenAddress
   });
@@ -75,25 +29,13 @@ export async function getSellerByAdmin(
   return sellers[0];
 }
 
-export const getSellerByClerkQuery = `
-query GetSellersByOperator($clerk: String!, $fundsToken: String) {
-  sellers(where: {
-    clerk: $clerk
-  }) {
-    ...sellerFields
-  }
-}
-${sellerFieldsFragment}
-`;
-
 export async function getSellerByClerk(
   subgraphUrl: string,
   clerkAddress: string,
   fundsTokenAddress?: string
-): Promise<RawSellerFromSubgraph> {
-  const { sellers = [] } = await fetchSubgraph<{
-    sellers: RawSellerFromSubgraph[];
-  }>(subgraphUrl, getSellerByClerkQuery, {
+): Promise<SellerFieldsFragment> {
+  const sdk = getSubgraphSdk(subgraphUrl);
+  const { sellers = [] } = await sdk.getSellerByClerkQuery({
     clerk: clerkAddress,
     fundsTokenAddress
   });
@@ -105,7 +47,7 @@ export async function getSellerByAddress(
   subgraphUrl: string,
   address: string,
   fundsTokenAddress?: string
-): Promise<RawSellerFromSubgraph> {
+): Promise<SellerFieldsFragment> {
   const [operator, admin, clerk] = await Promise.all([
     getSellerByOperator(subgraphUrl, address, fundsTokenAddress),
     getSellerByAdmin(subgraphUrl, address, fundsTokenAddress),

package/src/accounts/types.ts

@@ -1,13 +1 @@
-import { RawFundsEntityFromSubgraph } from "../funds/types";
-
 export { CreateSellerArgs } from "@bosonprotocol/common";
-
-export type RawSellerFromSubgraph = {
-  id: string;
-  operator: string;
-  admin: string;
-  clerk: string;
-  treasury: string;
-  active: boolean;
-  funds: Omit<RawFundsEntityFromSubgraph, "id" | "accountId">[];
-};

package/src/core-sdk.ts

@@ -15,8 +15,9 @@ import * as offers from "./offers";
 import * as orchestration from "./orchestration";
 import * as erc20 from "./erc20";
 import * as funds from "./funds";
+import * as subgraph from "./subgraph";
+
 import { getValueFromLogs } from "./utils/logs";
-import { MultiQueryOpts } from "./utils/subgraph";
 
 export class CoreSDK {
   private _web3Lib: Web3LibAdapter;
@@ -80,7 +81,7 @@ export class CoreSDK {
   public async getSellerByOperator(
     operator: string,
     fundsTokenAddress?: string
-  ): Promise<accounts.RawSellerFromSubgraph> {
+  ): Promise<subgraph.SellerFieldsFragment> {
     return accounts.subgraph.getSellerByOperator(
       this._subgraphUrl,
       operator,
@@ -91,7 +92,7 @@ export class CoreSDK {
   public async getSellerByClerk(
     clerk: string,
     fundsTokenAddress?: string
-  ): Promise<accounts.RawSellerFromSubgraph> {
+  ): Promise<subgraph.SellerFieldsFragment> {
     return accounts.subgraph.getSellerByClerk(
       this._subgraphUrl,
       clerk,
@@ -102,7 +103,7 @@ export class CoreSDK {
   public async getSellerByAddress(
     address: string,
     fundsTokenAddress?: string
-  ): Promise<accounts.RawSellerFromSubgraph> {
+  ): Promise<subgraph.SellerFieldsFragment> {
     return accounts.subgraph.getSellerByAddress(
       this._subgraphUrl,
       address,
@@ -177,7 +178,7 @@ export class CoreSDK {
 
   public async getOfferById(
     offerId: BigNumberish
-  ): Promise<offers.RawOfferFromSubgraph> {
+  ): Promise<subgraph.OfferFieldsFragment> {
     return offers.subgraph.getOfferById(this._subgraphUrl, offerId);
   }
 
@@ -186,8 +187,8 @@ export class CoreSDK {
       operatorAddress: string;
       // TODO: add support for sellerId, adminAddress, clerkAddress, treasuryAddress
     },
-    opts: MultiQueryOpts = {}
-  ): Promise<offers.RawOfferFromSubgraph[]> {
+    opts?: offers.subgraph.MultiQueryOpts
+  ): Promise<subgraph.OfferFieldsFragment[]> {
     if (sellerFilter.operatorAddress) {
       return offers.subgraph.getAllOffersOfOperator(
         this._subgraphUrl,
@@ -286,7 +287,7 @@ export class CoreSDK {
 
   public async getFundsByAccountId(
     accountId: BigNumberish
-  ): Promise<funds.RawFundsEntityFromSubgraph[]> {
+  ): Promise<subgraph.FundsEntityFieldsFragment[]> {
     return funds.subgraph.getFundsByAccountId(this._subgraphUrl, accountId);
   }
 }

package/src/funds/index.ts

@@ -1,4 +1,3 @@
 export * as iface from "./interface";
 export * as subgraph from "./subgraph";
 export * as handler from "./handler";
-export * from "./types";

package/src/funds/queries.graphql

@@ -0,0 +1,17 @@
+query getFundsByAccountIdQuery($accountId: BigInt!) {
+  fundsEntities(where: { accountId: $accountId }) {
+    ...FundsEntityFields
+  }
+}
+
+fragment FundsEntityFields on FundsEntity {
+  id
+  availableAmount
+  token {
+    address
+    name
+    symbol
+    decimals
+  }
+  accountId
+}

package/src/funds/subgraph.ts

@@ -1,39 +1,16 @@
 import { BigNumberish } from "@ethersproject/bignumber";
-import { fetchSubgraph } from "../utils/subgraph";
-import { RawFundsEntityFromSubgraph } from "./types";
-
-export const fundsEntityFieldsFragment = `
-fragment fundsEntityFields on FundsEntity {
-  id
-  availableAmount
-  token {
-    address
-    name
-    symbol
-    decimals
-  }
-  accountId
-}
-`;
-
-export const getFundsByAccountIdQuery = `
-query GetFundsByAccountIdQuery($accountId: String!) {
-  fundsEntities(where: {
-    accountId: $accountId
-  }) {
-    ...fundsEntityFields
-  }
-}
-${fundsEntityFieldsFragment}
-`;
+import { getSubgraphSdk } from "../utils/graphql";
+import { FundsEntityFieldsFragment } from "../subgraph";
 
 export async function getFundsByAccountId(
   subgraphUrl: string,
   accountId: BigNumberish
-): Promise<RawFundsEntityFromSubgraph[]> {
-  const { fundsEntities = [] } = await fetchSubgraph<{
-    fundsEntities: RawFundsEntityFromSubgraph[];
-  }>(subgraphUrl, getFundsByAccountIdQuery, { accountId });
+): Promise<FundsEntityFieldsFragment[]> {
+  const subgraphSdk = getSubgraphSdk(subgraphUrl);
+
+  const { fundsEntities = [] } = await subgraphSdk.getFundsByAccountIdQuery({
+    accountId: accountId.toString()
+  });
 
   return fundsEntities;
 }

package/src/index.ts

@@ -6,6 +6,7 @@ export * as exchanges from "./exchanges";
 export * as orchestration from "./orchestration";
 export * as erc20 from "./erc20";
 export * as funds from "./funds";
+export * as subgraph from "./subgraph";
 
 export { defaultConfigs, getDefaultConfig } from "@bosonprotocol/common";
 

package/src/offers/queries.graphql

@@ -0,0 +1,75 @@
+query getOfferByIdQuery($offerId: ID!) {
+  offer(id: $offerId) {
+    ...OfferFields
+  }
+}
+
+query getAllOffersOfOperatorQuery(
+  $operator: Bytes!
+  $first: Int
+  $skip: Int
+  $orderBy: Offer_orderBy
+  $orderDirection: OrderDirection
+) {
+  sellers(where: { operator: $operator }) {
+    offers(
+      first: $first
+      skip: $skip
+      orderBy: $orderBy
+      orderDirection: $orderDirection
+    ) {
+      ...OfferFields
+    }
+  }
+}
+
+fragment OfferFields on Offer {
+  id
+  createdAt
+  price
+  sellerDeposit
+  protocolFee
+  buyerCancelPenalty
+  quantityAvailable
+  quantityInitial
+  validFromDate
+  validUntilDate
+  voucherRedeemableFromDate
+  voucherRedeemableUntilDate
+  fulfillmentPeriodDuration
+  voucherValidDuration
+  resolutionPeriodDuration
+  metadataUri
+  offerChecksum
+  voidedAt
+  disputeResolverId
+  seller {
+    id
+    operator
+    admin
+    clerk
+    treasury
+    active
+  }
+  exchangeToken {
+    address
+    decimals
+    name
+    symbol
+  }
+  metadata {
+    name
+    description
+    externalUrl
+    schemaUrl
+    type
+  }
+  exchanges {
+    id
+    committedDate
+    redeemedDate
+    finalizedDate
+    expired
+    disputed
+  }
+}

package/src/offers/subgraph.ts

@@ -1,130 +1,43 @@
 import { BigNumberish } from "@ethersproject/bignumber";
-import { fetchSubgraph, MultiQueryOpts } from "../utils/subgraph";
-import { RawOfferFromSubgraph } from "./types";
-
-export const exchangeFieldsFragment = `
-fragment exchangeFields on Exchange {
-  id
-  committedDate
-  redeemedDate
-  finalizedDate
-  expired
-  disputed
-}
-`;
-
-export const offerFieldsFragment = `
-fragment offerFields on Offer {
-  id
-  createdAt
-  price
-  sellerDeposit
-  protocolFee
-  buyerCancelPenalty
-  quantityAvailable
-  quantityInitial
-  validFromDate
-  validUntilDate
-  voucherRedeemableFromDate
-  voucherRedeemableUntilDate
-  fulfillmentPeriodDuration
-  voucherValidDuration
-  resolutionPeriodDuration
-  metadataUri
-  offerChecksum
-  voidedAt
-  disputeResolverId
-  seller {
-    id
-    operator
-    admin
-    clerk
-    treasury
-    active
-  }
-  exchangeToken {
-    address
-    decimals
-    name
-    symbol
-  }
-  metadata {
-    name 
-    description
-    externalUrl
-    schemaUrl
-    type
-  }
-  exchanges {
-    ...exchangeFields
-  }
-}
-${exchangeFieldsFragment}
-`;
-
-export const getOfferByIdQuery = `
-query GetOfferById($offerId: ID!) {
-  offer(id: $offerId) {
-    ...offerFields
-  }
-}
-${offerFieldsFragment}
-`;
+import { getSubgraphSdk } from "../utils/graphql";
+import {
+  OfferFieldsFragment,
+  OrderDirection,
+  Offer_OrderBy
+} from "../subgraph";
+
+export type MultiQueryOpts = {
+  orderBy: Offer_OrderBy;
+  orderDirection: OrderDirection;
+};
 
 export async function getOfferById(
   subgraphUrl: string,
   offerId: BigNumberish
-): Promise<RawOfferFromSubgraph> {
-  const { offer } = await fetchSubgraph<{ offer: RawOfferFromSubgraph }>(
-    subgraphUrl,
-    getOfferByIdQuery,
-    { offerId: offerId.toString() }
-  );
+): Promise<OfferFieldsFragment> {
+  const subgraphSdk = getSubgraphSdk(subgraphUrl);
 
-  return offer;
-}
+  const { offer } = await subgraphSdk.getOfferByIdQuery({
+    offerId: offerId.toString()
+  });
 
-export const getAllOffersOfOperatorQuery = `
-query GetAllOffersOfOperatorQuery(
-  $operator: String!,
-  $first: Int,
-  $skip: Int,
-  $orderBy: String,
-  $orderDirection: String
-) {
-  sellers(where: {
-    operator: $operator
-  }) {
-    offers(
-      first: $first
-      skip: $skip
-      orderBy: $orderBy
-      orderDirection: $orderDirection
-    ) {
-      ...offerFields
-    }
-  }
+  return offer;
 }
-${offerFieldsFragment}
-`;
 
 export async function getAllOffersOfOperator(
   subgraphUrl: string,
   operatorAddress: string,
-  opts: MultiQueryOpts = {}
-): Promise<RawOfferFromSubgraph[]> {
-  const { sellers } = await fetchSubgraph<{
-    sellers: { offers: RawOfferFromSubgraph[] };
-  }>(subgraphUrl, getAllOffersOfOperatorQuery, {
-    operator: operatorAddress.toLowerCase(),
-    first: 100,
-    skip: 0,
-    orderBy: "createdAt",
-    orderDirection: "desc",
-    ...opts
+  opts?: MultiQueryOpts
+): Promise<OfferFieldsFragment[]> {
+  const subgraphSdk = getSubgraphSdk(subgraphUrl);
+
+  const { sellers = [] } = await subgraphSdk.getAllOffersOfOperatorQuery({
+    operator: operatorAddress,
+    orderBy: opts?.orderBy,
+    orderDirection: opts?.orderDirection
   });
 
-  if (!sellers) {
+  if (!sellers || sellers.length === 0) {
     return [];
   }
 

package/src/offers/types.ts

@@ -1,52 +1 @@
 export { CreateOfferArgs } from "@bosonprotocol/common";
-
-export type RawOfferFromSubgraph = {
-  id: string;
-  createdAt: string;
-  price: string;
-  sellerDeposit: string;
-  protocolFee: string;
-  buyerCancelPenalty: string;
-  quantityAvailable: string;
-  quantityInitial: string;
-  validFromDate: string;
-  validUntilDate: string;
-  voucherRedeemableFromDate: string;
-  voucherRedeemableUntilDate: string;
-  fulfillmentPeriodDuration: string;
-  voucherValidDuration: string;
-  resolutionPeriodDuration: string;
-  metadataUri: string;
-  offerChecksum: string;
-  voidedAt: null | string;
-  disputeResolverId: string;
-  seller: {
-    id: string;
-    operator: string;
-    admin: string;
-    clerk: string;
-    treasury: string;
-    active: boolean;
-  };
-  exchangeToken: {
-    address: string;
-    decimals: string;
-    name: string;
-    symbol: string;
-  };
-  metadata: null | {
-    name: string;
-    description: string;
-    externalUrl: string;
-    schemaUrl: string;
-    type: string;
-  };
-  exchanges: {
-    id: string;
-    committedDate: string;
-    disputed: boolean;
-    expired: boolean;
-    finalizedDate: string;
-    redeemedDate: string;
-  }[];
-};