@bosonprotocol/core-sdk 1.5.0 → 1.6.0-alpha.1

package/dist/esm/offers/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/offers/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,oBAAY,oBAAoB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,yBAAyB,EAAE,MAAM,CAAC;IAClC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAC;IACxB,MAAM,EAAE;QACN,EAAE,EAAE,MAAM,CAAC;QACX,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,OAAO,CAAC;KACjB,CAAC;IACF,aAAa,EAAE;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,QAAQ,EAAE,IAAI,GAAG;QACf,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,SAAS,EAAE;QACT,EAAE,EAAE,MAAM,CAAC;QACX,aAAa,EAAE,MAAM,CAAC;QACtB,QAAQ,EAAE,OAAO,CAAC;QAClB,OAAO,EAAE,OAAO,CAAC;QACjB,aAAa,EAAE,MAAM,CAAC;QACtB,YAAY,EAAE,MAAM,CAAC;KACtB,EAAE,CAAC;CACL,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/offers/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,oBAAY,oBAAoB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,yBAAyB,EAAE,MAAM,CAAC;IAClC,0BAA0B,EAAE,MAAM,CAAC;IACnC,yBAAyB,EAAE,MAAM,CAAC;IAClC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,wBAAwB,EAAE,MAAM,CAAC;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAC;IACxB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE;QACN,EAAE,EAAE,MAAM,CAAC;QACX,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,OAAO,CAAC;KACjB,CAAC;IACF,aAAa,EAAE;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,QAAQ,EAAE,IAAI,GAAG;QACf,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,SAAS,EAAE;QACT,EAAE,EAAE,MAAM,CAAC;QACX,aAAa,EAAE,MAAM,CAAC;QACtB,QAAQ,EAAE,OAAO,CAAC;QAClB,OAAO,EAAE,OAAO,CAAC;QACjB,aAAa,EAAE,MAAM,CAAC;QACtB,YAAY,EAAE,MAAM,CAAC;KACtB,EAAE,CAAC;CACL,CAAC"}

package/dist/esm/orchestration/interface.js

@@ -1,9 +1,9 @@
 import { abis } from "@bosonprotocol/common";
 import { Interface } from "@ethersproject/abi";
 import { createSellerArgsToStruct } from "../accounts/interface";
-import { createOfferArgsToStruct } from "../offers/interface";
+import { createOfferArgsToStructs } from "../offers/interface";
 export const bosonOrchestrationHandlerIface = new Interface(abis.IBosonOrchestrationHandlerABI);
 export function encodeCreateSellerAndOffer(seller, offer) {
-    return bosonOrchestrationHandlerIface.encodeFunctionData("createSellerAndOffer", [createSellerArgsToStruct(seller), createOfferArgsToStruct(offer)]);
+    return bosonOrchestrationHandlerIface.encodeFunctionData("createSellerAndOffer", [createSellerArgsToStruct(seller), ...createOfferArgsToStructs(offer)]);
 }
 //# sourceMappingURL=interface.js.map

package/dist/esm/orchestration/interface.js.map

@@ -1 +1 @@
-{"version":3,"file":"interface.js","sourceRoot":"","sources":["../../../src/orchestration/interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAK9D,MAAM,CAAC,MAAM,8BAA8B,GAAG,IAAI,SAAS,CACzD,IAAI,CAAC,6BAA6B,CACnC,CAAC;AAEF,MAAM,UAAU,0BAA0B,CACxC,MAAwB,EACxB,KAAsB;IAEtB,OAAO,8BAA8B,CAAC,kBAAkB,CACtD,sBAAsB,EACtB,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,uBAAuB,CAAC,KAAK,CAAC,CAAC,CACnE,CAAC;AACJ,CAAC"}
+{"version":3,"file":"interface.js","sourceRoot":"","sources":["../../../src/orchestration/interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAK/D,MAAM,CAAC,MAAM,8BAA8B,GAAG,IAAI,SAAS,CACzD,IAAI,CAAC,6BAA6B,CACnC,CAAC;AAEF,MAAM,UAAU,0BAA0B,CACxC,MAAwB,EACxB,KAAsB;IAEtB,OAAO,8BAA8B,CAAC,kBAAkB,CACtD,sBAAsB,EACtB,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC,CACvE,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@bosonprotocol/core-sdk",
-  "version": "1.5.0",
+  "version": "1.6.0-alpha.1",
   "description": "> TODO: description",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
   "types": "./dist/cjs/index.d.ts",
   "scripts": {
-    "dev": "tsc --build tsconfig.cjs.json --watch --preserveWatchOutput ",
+    "dev": "tsc --watch --preserveWatchOutput ",
     "lint": "eslint --ignore-path ../../.gitignore --ext .js,.ts .",
     "build": "rimraf dist && tsc && tsc --build tsconfig.cjs.json",
     "test": "jest",
@@ -30,7 +30,7 @@
     "access": "restricted"
   },
   "dependencies": {
-    "@bosonprotocol/common": "^1.5.1",
+    "@bosonprotocol/common": "^1.6.0-alpha.1",
     "@ethersproject/abi": "^5.5.0",
     "@ethersproject/address": "^5.5.0",
     "@ethersproject/bignumber": "^5.5.0",
@@ -46,5 +46,5 @@
     "ts-jest": "^27.1.3",
     "typescript": "^4.5.5"
   },
-  "gitHead": "61fa5f811a172faf91ae6fa0e66332ebdc45ce20"
+  "gitHead": "a6b9522306908975de38960fb7b31f8144eeed60"
 }

package/src/accounts/subgraph.ts

@@ -27,11 +27,9 @@ export async function getSellerByOperator(
   subgraphUrl: string,
   operatorAddress: string
 ): Promise<RawSellerFromSubgraph> {
-  const { sellers } = await fetchSubgraph<{ sellers: RawSellerFromSubgraph }>(
-    subgraphUrl,
-    getSellerByOperatorQuery,
-    { operator: operatorAddress }
-  );
+  const { sellers = [] } = await fetchSubgraph<{
+    sellers: RawSellerFromSubgraph[];
+  }>(subgraphUrl, getSellerByOperatorQuery, { operator: operatorAddress });
 
   return sellers[0];
 }
@@ -51,11 +49,9 @@ export async function getSellerByAdmin(
   subgraphUrl: string,
   adminAddress: string
 ): Promise<RawSellerFromSubgraph> {
-  const { sellers } = await fetchSubgraph<{ sellers: RawSellerFromSubgraph }>(
-    subgraphUrl,
-    getSellerByOperatorQuery,
-    { admin: adminAddress }
-  );
+  const { sellers = [] } = await fetchSubgraph<{
+    sellers: RawSellerFromSubgraph[];
+  }>(subgraphUrl, getSellerByAdminQuery, { admin: adminAddress });
 
   return sellers[0];
 }
@@ -75,11 +71,9 @@ export async function getSellerByClerk(
   subgraphUrl: string,
   clerkAddress: string
 ): Promise<RawSellerFromSubgraph> {
-  const { sellers } = await fetchSubgraph<{ sellers: RawSellerFromSubgraph }>(
-    subgraphUrl,
-    getSellerByOperatorQuery,
-    { clerk: clerkAddress }
-  );
+  const { sellers = [] } = await fetchSubgraph<{
+    sellers: RawSellerFromSubgraph[];
+  }>(subgraphUrl, getSellerByClerkQuery, { clerk: clerkAddress });
 
   return sellers[0];
 }

package/src/core-sdk.ts

@@ -7,11 +7,14 @@ import {
   Log
 } from "@bosonprotocol/common";
 import { BigNumberish } from "@ethersproject/bignumber";
+import { AddressZero } from "@ethersproject/constants";
+
 import * as accounts from "./accounts";
 import * as exchanges from "./exchanges";
 import * as offers from "./offers";
 import * as orchestration from "./orchestration";
 import * as erc20 from "./erc20";
+import * as funds from "./funds";
 import { getValueFromLogs } from "./utils/logs";
 import { MultiQueryOpts } from "./utils/subgraph";
 
@@ -251,4 +254,24 @@ export class CoreSDK {
       web3Lib: this._web3Lib
     });
   }
+
+  public async depositFunds(
+    sellerId: BigNumberish,
+    fundsAmount: BigNumberish,
+    fundsTokenAddress: string = AddressZero
+  ): Promise<TransactionResponse> {
+    return funds.handler.depositFunds({
+      sellerId,
+      fundsAmount,
+      fundsTokenAddress,
+      contractAddress: this._protocolDiamond,
+      web3Lib: this._web3Lib
+    });
+  }
+
+  public async getFundsByAccountId(
+    accountId: BigNumberish
+  ): Promise<funds.RawFundsEntityFromSubgraph[]> {
+    return funds.subgraph.getFundsByAccountId(this._subgraphUrl, accountId);
+  }
 }

package/src/exchanges/handler.ts

@@ -34,6 +34,7 @@ export async function commitToOffer(args: {
 
   return args.web3Lib.sendTransaction({
     to: args.contractAddress,
-    data: encodeCommitToOffer(args.buyer, args.offerId)
+    data: encodeCommitToOffer(args.buyer, args.offerId),
+    value: offer.price
   });
 }

package/src/funds/handler.ts

@@ -0,0 +1,31 @@
+import { BigNumberish } from "@ethersproject/bignumber";
+import { isAddress } from "@ethersproject/address";
+import { AddressZero } from "@ethersproject/constants";
+import { Web3LibAdapter, TransactionResponse } from "@bosonprotocol/common";
+import { encodeDepositFunds } from "./interface";
+
+export async function depositFunds(args: {
+  sellerId: BigNumberish;
+  fundsTokenAddress?: string;
+  fundsAmount: BigNumberish;
+  contractAddress: string;
+  web3Lib: Web3LibAdapter;
+}): Promise<TransactionResponse> {
+  const { fundsTokenAddress = AddressZero } = args;
+
+  if (!isAddress(fundsTokenAddress)) {
+    throw new Error(`Invalid fundsTokenAddress: ${fundsTokenAddress}`);
+  }
+
+  const isNativeCoin = fundsTokenAddress === AddressZero;
+
+  return args.web3Lib.sendTransaction({
+    to: args.contractAddress,
+    data: encodeDepositFunds(
+      args.sellerId,
+      args.fundsTokenAddress,
+      args.fundsAmount
+    ),
+    value: isNativeCoin ? args.fundsAmount : "0"
+  });
+}

package/src/funds/index.ts

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

package/src/funds/interface.ts

@@ -0,0 +1,17 @@
+import { abis } from "@bosonprotocol/common";
+import { Interface } from "@ethersproject/abi";
+import { BigNumberish } from "@ethersproject/bignumber";
+
+export const bosonFundsHandlerIface = new Interface(abis.IBosonFundsHandlerABI);
+
+export function encodeDepositFunds(
+  sellerId: BigNumberish,
+  tokenAddress: string,
+  amount: BigNumberish
+) {
+  return bosonFundsHandlerIface.encodeFunctionData("depositFunds", [
+    sellerId,
+    tokenAddress,
+    amount
+  ]);
+}

package/src/funds/subgraph.ts

@@ -0,0 +1,39 @@
+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}
+`;
+
+export async function getFundsByAccountId(
+  subgraphUrl: string,
+  accountId: BigNumberish
+): Promise<RawFundsEntityFromSubgraph[]> {
+  const { fundsEntities = [] } = await fetchSubgraph<{
+    fundsEntities: RawFundsEntityFromSubgraph[];
+  }>(subgraphUrl, getFundsByAccountIdQuery, { accountId });
+
+  return fundsEntities;
+}

package/src/funds/types.ts

@@ -0,0 +1,11 @@
+export type RawFundsEntityFromSubgraph = {
+  id: string;
+  availableAmount: string;
+  token: {
+    address: string;
+    name: string;
+    symbol: string;
+    decimals: number;
+  };
+  accountId: string;
+};

package/src/index.ts

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

package/src/offers/interface.ts

@@ -1,4 +1,10 @@
-import { OfferStruct, utils, abis } from "@bosonprotocol/common";
+import {
+  OfferStruct,
+  utils,
+  abis,
+  OfferDatesStruct,
+  OfferDurationsStruct
+} from "@bosonprotocol/common";
 import { Interface } from "@ethersproject/abi";
 import { getAddress } from "@ethersproject/address";
 import { CreateOfferArgs } from "./types";
@@ -6,35 +12,71 @@ import { CreateOfferArgs } from "./types";
 export const bosonOfferHandlerIface = new Interface(abis.IBosonOfferHandlerABI);
 
 export function encodeCreateOffer(args: CreateOfferArgs) {
-  return bosonOfferHandlerIface.encodeFunctionData("createOffer", [
-    createOfferArgsToStruct(args)
-  ]);
+  return bosonOfferHandlerIface.encodeFunctionData(
+    "createOffer",
+    createOfferArgsToStructs(args)
+  );
 }
 
-export function createOfferArgsToStruct(
+export function createOfferArgsToStructs(
   args: CreateOfferArgs
-): Partial<OfferStruct> {
+): [
+  Partial<OfferStruct>,
+  Partial<OfferDatesStruct>,
+  Partial<OfferDurationsStruct>
+] {
+  return [
+    argsToOfferStruct(args),
+    argsToOfferDatesStruct(args),
+    argsToOfferDurationsStruct(args)
+  ];
+}
+
+export function argsToOfferStruct(args: CreateOfferArgs): Partial<OfferStruct> {
+  const { exchangeToken, ...restArgs } = args;
+
+  return {
+    id: "0",
+    sellerId: "0",
+    ...restArgs,
+    exchangeToken: getAddress(exchangeToken)
+  };
+}
+
+export function argsToOfferDatesStruct(
+  args: CreateOfferArgs
+): Partial<OfferDatesStruct> {
   const {
-    exchangeToken,
     validFromDateInMS,
     validUntilDateInMS,
-    redeemableFromDateInMS,
-    fulfillmentPeriodDurationInMS,
-    voucherValidDurationInMS,
-    ...restArgs
+    voucherRedeemableFromDateInMS,
+    voucherRedeemableUntilDateInMS
   } = args;
 
   return {
-    id: "0",
-    sellerId: "0",
-    ...restArgs,
-    exchangeToken: getAddress(exchangeToken),
-    validFromDate: utils.timestamp.msToSec(validFromDateInMS),
-    validUntilDate: utils.timestamp.msToSec(validUntilDateInMS),
-    redeemableFromDate: utils.timestamp.msToSec(redeemableFromDateInMS),
-    fulfillmentPeriodDuration: utils.timestamp.msToSec(
-      fulfillmentPeriodDurationInMS
+    validFrom: utils.timestamp.msToSec(validFromDateInMS),
+    validUntil: utils.timestamp.msToSec(validUntilDateInMS),
+    voucherRedeemableFrom: utils.timestamp.msToSec(
+      voucherRedeemableFromDateInMS
     ),
-    voucherValidDuration: utils.timestamp.msToSec(voucherValidDurationInMS)
+    voucherRedeemableUntil: utils.timestamp.msToSec(
+      voucherRedeemableUntilDateInMS
+    )
+  };
+}
+
+export function argsToOfferDurationsStruct(
+  args: CreateOfferArgs
+): Partial<OfferDurationsStruct> {
+  const {
+    fulfillmentPeriodDurationInMS,
+    voucherValidDurationInMS = 0,
+    resolutionPeriodDurationInMS
+  } = args;
+
+  return {
+    fulfillmentPeriod: utils.timestamp.msToSec(fulfillmentPeriodDurationInMS),
+    voucherValid: utils.timestamp.msToSec(voucherValidDurationInMS),
+    resolutionPeriod: utils.timestamp.msToSec(resolutionPeriodDurationInMS)
   };
 }

package/src/offers/subgraph.ts

@@ -19,16 +19,21 @@ fragment offerFields on Offer {
   createdAt
   price
   sellerDeposit
+  protocolFee
   buyerCancelPenalty
   quantityAvailable
+  quantityInitial
   validFromDate
   validUntilDate
-  redeemableFromDate
+  voucherRedeemableFromDate
+  voucherRedeemableUntilDate
   fulfillmentPeriodDuration
   voucherValidDuration
+  resolutionPeriodDuration
   metadataUri
   offerChecksum
   voidedAt
+  disputeResolverId
   seller {
     id
     operator

package/src/offers/types.ts

@@ -5,16 +5,21 @@ export type RawOfferFromSubgraph = {
   createdAt: string;
   price: string;
   sellerDeposit: string;
+  protocolFee: string;
   buyerCancelPenalty: string;
   quantityAvailable: string;
+  quantityInitial: string;
   validFromDate: string;
   validUntilDate: string;
-  redeemableFromDate: 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;

package/src/orchestration/interface.ts

@@ -1,7 +1,7 @@
 import { abis } from "@bosonprotocol/common";
 import { Interface } from "@ethersproject/abi";
 import { createSellerArgsToStruct } from "../accounts/interface";
-import { createOfferArgsToStruct } from "../offers/interface";
+import { createOfferArgsToStructs } from "../offers/interface";
 
 import { CreateSellerArgs } from "../accounts/types";
 import { CreateOfferArgs } from "../offers/types";
@@ -16,6 +16,6 @@ export function encodeCreateSellerAndOffer(
 ) {
   return bosonOrchestrationHandlerIface.encodeFunctionData(
     "createSellerAndOffer",
-    [createSellerArgsToStruct(seller), createOfferArgsToStruct(offer)]
+    [createSellerArgsToStruct(seller), ...createOfferArgsToStructs(offer)]
   );
 }