@bosonprotocol/core-sdk 1.24.0 → 1.24.1-alpha.1

package/src/voucher/mixin.ts

@@ -0,0 +1,126 @@
+import { TransactionResponse } from "@bosonprotocol/common";
+import { Range } from "@bosonprotocol/common/src/types";
+import { BigNumberish } from "@ethersproject/bignumber";
+import { handler } from ".";
+import { getOfferById } from "../offers/subgraph";
+import { BaseCoreSDK } from "./../mixins/base-core-sdk";
+
+export class VoucherMixin extends BaseCoreSDK {
+  /**
+   * Burns preminted vouchers from an offer
+   * @param offerId -  Offer ID
+   * @param overrides - Optional overrides.
+   * @returns Transaction response.
+   */
+  public async burnPremintedVouchers(
+    offerId: BigNumberish,
+    overrides: Partial<{
+      contractAddress: string;
+    }> = {}
+  ): Promise<TransactionResponse> {
+    const offerFromSubgraph = await getOfferById(this._subgraphUrl, offerId);
+    return handler.burnPremintedVouchers({
+      offerId,
+      contractAddress:
+        overrides.contractAddress ||
+        offerFromSubgraph.seller.voucherCloneAddress,
+      web3Lib: this._web3Lib
+    });
+  }
+
+  /**
+   * Gets the number of vouchers available to be pre-minted for an offer.
+   * @param offerId -  Offer ID
+   * @param overrides - Optional overrides.
+   * @returns Transaction response.
+   */
+  public async getAvailablePreMints(
+    offerId: BigNumberish,
+    overrides: Partial<{
+      contractAddress: string;
+    }> = {}
+  ): Promise<string> {
+    const offerFromSubgraph = await getOfferById(this._subgraphUrl, offerId);
+    return handler.getAvailablePreMints({
+      offerId,
+      contractAddress:
+        overrides.contractAddress ||
+        offerFromSubgraph.seller.voucherCloneAddress,
+      web3Lib: this._web3Lib
+    });
+  }
+
+  /**
+   * Gets the range for an offer.
+   * @param offerId -  Offer ID
+   * @param overrides - Optional overrides.
+   * @returns Transaction response.
+   */
+  public async getRangeByOfferId(
+    offerId: BigNumberish,
+    overrides: Partial<{
+      contractAddress: string;
+    }> = {}
+  ): Promise<Range> {
+    const offerFromSubgraph = await getOfferById(this._subgraphUrl, offerId);
+    return handler.getRangeByOfferId({
+      offerId,
+      contractAddress:
+        overrides.contractAddress ||
+        offerFromSubgraph.seller.voucherCloneAddress,
+      web3Lib: this._web3Lib
+    });
+  }
+
+  /**
+   * Pre-mints all or part of an offer's reserved vouchers.
+   * @param offerId -  Offer ID
+   * @param overrides - Optional overrides.
+   * @returns Transaction response.
+   */
+  public async preMint(
+    offerId: BigNumberish,
+    amount: BigNumberish,
+    overrides: Partial<{
+      contractAddress: string;
+    }> = {}
+  ): Promise<TransactionResponse> {
+    const offerFromSubgraph = await getOfferById(this._subgraphUrl, offerId);
+    return handler.preMint({
+      offerId,
+      amount,
+      contractAddress:
+        overrides.contractAddress ||
+        offerFromSubgraph.seller.voucherCloneAddress,
+      web3Lib: this._web3Lib
+    });
+  }
+
+  /**
+   * Pre-mints all or part of an offer's reserved vouchers.
+   * @param offerId -  Offer ID
+   * @param overrides - Optional overrides.
+   * @returns Transaction response.
+   */
+  public async transferFrom(
+    offerId: BigNumberish,
+    to: BigNumberish,
+    tokenId: BigNumberish,
+    overrides: Partial<{
+      owner: BigNumberish;
+      contractAddress: string;
+    }> = {}
+  ): Promise<TransactionResponse> {
+    const offerFromSubgraph = await getOfferById(this._subgraphUrl, offerId);
+
+    return handler.transferFrom({
+      from: overrides.owner || (await this._web3Lib.getSignerAddress()),
+      to,
+      tokenId,
+      contractAddress:
+        overrides.contractAddress ||
+        offerFromSubgraph.seller.voucherCloneAddress,
+      web3Lib: this._web3Lib
+    });
+  }
+}