@bosonprotocol/core-sdk 1.29.0-ludo.1 → 1.29.0

package/dist/esm/offers/mixin.d.ts

@@ -1,171 +1,171 @@
-import { BaseCoreSDK } from "./../mixins/base-core-sdk";
-import * as subgraph from "../subgraph";
-import * as offers from ".";
-import { TransactionResponse, Log } from "@bosonprotocol/common";
-import { BigNumberish } from "@ethersproject/bignumber";
-import { ITokenInfo } from "../utils/tokenInfoManager";
-export declare class OfferMixin extends BaseCoreSDK {
-    /**
-     * Creates offer by calling the `OfferHandlerFacet` contract.
-     * This transaction only succeeds if there is an existing seller account for connected signer.
-     * @param offerToCreate - Offer arguments.
-     * @param overrides - Optional overrides.
-     * @returns Transaction response.
-     */
-    createOffer(offerToCreate: offers.CreateOfferArgs, overrides?: Partial<{
-        contractAddress: string;
-    }>): Promise<TransactionResponse>;
-    /**
-     * Creates a batch of offers by calling the `OfferHandlerFacet` contract.
-     * This transaction only succeeds if there is an existing seller account for connected signer.
-     * @param offersToCreate - Offer arguments.
-     * @param overrides - Optional overrides.
-     * @returns Transaction response.
-     */
-    createOfferBatch(offersToCreate: offers.CreateOfferArgs[], overrides?: Partial<{
-        contractAddress: string;
-    }>): Promise<TransactionResponse>;
-    /**
-     * Utility method to retrieve the created `offerId` from logs after calling `createOffer`
-     * or `createOfferAndSeller`.
-     * @param logs - Logs to search in.
-     * @returns Created offer id.
-     */
-    getCreatedOfferIdFromLogs(logs: Log[]): string | null;
-    /**
-     * Utility method to retrieve the created `offerIds` from logs after calling `createOfferBatch`
-     * @param logs - Logs to search in.
-     * @returns Array of created offerIds.
-     */
-    getCreatedOfferIdsFromLogs(logs: Log[]): string[];
-    /**
-     * Utility method to retrieve the created `groupIds` from logs after calling `createGroup`
-     * @param logs - Logs to search in.
-     * @returns Array of group Ids.
-     */
-    getCreatedGroupIdsFromLogs(logs: Log[]): string[];
-    /**
-     * Utility method to retrieve the created `sellerId` from logs after calling `createSeller`
-     * or `createOfferAndSeller`.
-     * @param logs - Logs to search in.
-     * @returns Created offer id.
-     */
-    getCreatedSellerIdFromLogs(logs: Log[]): string | null;
-    /**
-     * Voids an existing offer by calling the `OfferHandlerFacet` contract.
-     * This transaction only succeeds if the connected signer is the `assistant`.
-     * @param offerId - ID of offer to void.
-     * @param overrides - Optional overrides.
-     * @returns Transaction response.
-     */
-    voidOffer(offerId: BigNumberish, overrides?: Partial<{
-        contractAddress: string;
-    }>): Promise<TransactionResponse>;
-    /**
-     * Voids a batch of existing offers by calling the `OfferHandlerFacet` contract.
-     * This transaction only succeeds if the connected signer is the `assistant` of all
-     * provided offers.
-     * @param offerIds - IDs of offers to void.
-     * @param overrides - Optional overrides.
-     * @returns Transaction response.
-     */
-    voidOfferBatch(offerIds: BigNumberish[], overrides?: Partial<{
-        contractAddress: string;
-    }>): Promise<TransactionResponse>;
-    /**
-     * Extends an existing offer by calling the `OfferHandlerFacet` contract.
-     * This transaction only succeeds if the connected signer is the `assistant`.
-     * @param offerId - ID of offer to void.
-     * @param validUntil - new validity date.
-     * @param overrides - Optional overrides.
-     * @returns Transaction response.
-     */
-    extendOffer(offerId: BigNumberish, validUntil: BigNumberish, overrides?: Partial<{
-        contractAddress: string;
-    }>): Promise<TransactionResponse>;
-    /**
-     * Extends a batch of existing offers by calling the `OfferHandlerFacet` contract.
-     * This transaction only succeeds if the connected signer is the `assistant` of all
-     * provided offers.
-     * @param offerIds - IDs of offers to void.
-     * @param validUntil - new validity date.
-     * @param overrides - Optional overrides.
-     * @returns Transaction response.
-     */
-    extendOfferBatch(offerIds: BigNumberish[], validUntil: BigNumberish, overrides?: Partial<{
-        contractAddress: string;
-    }>): Promise<TransactionResponse>;
-    /**
-     * Returns offer from subgraph.
-     * @param offerId - ID of offer.
-     * @param queryVars - Optional query variables to skip, order or filter.
-     * @returns Offer entity from subgraph.
-     */
-    getOfferById(offerId: BigNumberish, queryVars?: offers.subgraph.SingleOfferQueryVariables): Promise<subgraph.OfferFieldsFragment>;
-    /**
-     * Returns offers from subgraph.
-     * @param queryVars - Optional query variables to skip, order or filter.
-     * @returns Offer entities from subgraph.
-     */
-    getOffers(queryVars?: subgraph.GetOffersQueryQueryVariables): Promise<subgraph.OfferFieldsFragment[]>;
-    /**
-     * Renders contractual agreement for given offer.
-     * @param offerId - Id of offer to render agreement for.
-     * @returns Contractual agreement as string.
-     */
-    renderContractualAgreementForOffer(offerId: BigNumberish): Promise<string>;
-    /**
-     * Renders contractual agreement for given offer.
-     * @param template - Mustache syntax based template.
-     * @param offerData - Offer data.
-     * @returns Contractual agreement as string.
-     */
-    renderContractualAgreement(template: string, offerData: offers.CreateOfferArgs, offerMetadata: offers.AdditionalOfferMetadata): Promise<string>;
-    /**
-     * Reserves a range of vouchers to be associated with an offer
-     * @param offerId -  Offer ID
-     * @param overrides - Optional overrides.
-     * @returns Transaction response.
-     */
-    reserveRange(offerId: BigNumberish, length: BigNumberish, to: "seller" | "contract", overrides?: Partial<{
-        contractAddress: string;
-    }>): Promise<TransactionResponse>;
-    /**
-     * Returns the current allowance of the given token by calling the contract.
-     * @param exchangeToken - Address of exchange token.
-     * @param overrides - Optional overrides.
-     * @returns Allowance for given signer.
-     */
-    getExchangeTokenAllowance(exchangeToken: string, overrides?: Partial<{
-        spender: string;
-        owner: string;
-    }>): Promise<string>;
-    /**
-     * Returns `name`, `decimals` and `symbol` of the given token by calling the contract.
-     * @param exchangeToken - Address exchange token.
-     * @returns Decimals, name and symbol.
-     */
-    getExchangeTokenInfo(exchangeToken: string): Promise<ITokenInfo>;
-    /**
-     * Approves the given amount for the main protocol contract.
-     * @param exchangeToken - Address of token to approve.
-     * @param value - Amount of allowance.
-     * @param overrides - Optional overrides.
-     * @returns Transaction response.
-     */
-    approveExchangeToken(exchangeToken: string, value: BigNumberish, overrides?: Partial<{
-        spender: string;
-    }>): Promise<TransactionResponse>;
-    getProtocolAllowance(exchangeToken: string, overrides?: Partial<{
-        spender: string;
-        owner: string;
-    }>): Promise<string>;
-    checkTokenGatedCondition(offerCondition: subgraph.OfferFieldsFragment["condition"], buyerAddress: string): Promise<boolean>;
-    /**
-     * Check a given offer meets ExchangePolicy rules.
-     * @param offerId - Id of offer to render agreement for.
-     * @returns Contractual agreement as string.
-     */
-    checkExchangePolicy(offerId: BigNumberish, rules: offers.CheckExchangePolicyRules): Promise<offers.CheckExchangePolicyResult>;
-}
+import { BaseCoreSDK } from "./../mixins/base-core-sdk";
+import * as subgraph from "../subgraph";
+import * as offers from ".";
+import { TransactionResponse, Log } from "@bosonprotocol/common";
+import { BigNumberish } from "@ethersproject/bignumber";
+import { ITokenInfo } from "../utils/tokenInfoManager";
+export declare class OfferMixin extends BaseCoreSDK {
+    /**
+     * Creates offer by calling the `OfferHandlerFacet` contract.
+     * This transaction only succeeds if there is an existing seller account for connected signer.
+     * @param offerToCreate - Offer arguments.
+     * @param overrides - Optional overrides.
+     * @returns Transaction response.
+     */
+    createOffer(offerToCreate: offers.CreateOfferArgs, overrides?: Partial<{
+        contractAddress: string;
+    }>): Promise<TransactionResponse>;
+    /**
+     * Creates a batch of offers by calling the `OfferHandlerFacet` contract.
+     * This transaction only succeeds if there is an existing seller account for connected signer.
+     * @param offersToCreate - Offer arguments.
+     * @param overrides - Optional overrides.
+     * @returns Transaction response.
+     */
+    createOfferBatch(offersToCreate: offers.CreateOfferArgs[], overrides?: Partial<{
+        contractAddress: string;
+    }>): Promise<TransactionResponse>;
+    /**
+     * Utility method to retrieve the created `offerId` from logs after calling `createOffer`
+     * or `createOfferAndSeller`.
+     * @param logs - Logs to search in.
+     * @returns Created offer id.
+     */
+    getCreatedOfferIdFromLogs(logs: Log[]): string | null;
+    /**
+     * Utility method to retrieve the created `offerIds` from logs after calling `createOfferBatch`
+     * @param logs - Logs to search in.
+     * @returns Array of created offerIds.
+     */
+    getCreatedOfferIdsFromLogs(logs: Log[]): string[];
+    /**
+     * Utility method to retrieve the created `groupIds` from logs after calling `createGroup`
+     * @param logs - Logs to search in.
+     * @returns Array of group Ids.
+     */
+    getCreatedGroupIdsFromLogs(logs: Log[]): string[];
+    /**
+     * Utility method to retrieve the created `sellerId` from logs after calling `createSeller`
+     * or `createOfferAndSeller`.
+     * @param logs - Logs to search in.
+     * @returns Created offer id.
+     */
+    getCreatedSellerIdFromLogs(logs: Log[]): string | null;
+    /**
+     * Voids an existing offer by calling the `OfferHandlerFacet` contract.
+     * This transaction only succeeds if the connected signer is the `assistant`.
+     * @param offerId - ID of offer to void.
+     * @param overrides - Optional overrides.
+     * @returns Transaction response.
+     */
+    voidOffer(offerId: BigNumberish, overrides?: Partial<{
+        contractAddress: string;
+    }>): Promise<TransactionResponse>;
+    /**
+     * Voids a batch of existing offers by calling the `OfferHandlerFacet` contract.
+     * This transaction only succeeds if the connected signer is the `assistant` of all
+     * provided offers.
+     * @param offerIds - IDs of offers to void.
+     * @param overrides - Optional overrides.
+     * @returns Transaction response.
+     */
+    voidOfferBatch(offerIds: BigNumberish[], overrides?: Partial<{
+        contractAddress: string;
+    }>): Promise<TransactionResponse>;
+    /**
+     * Extends an existing offer by calling the `OfferHandlerFacet` contract.
+     * This transaction only succeeds if the connected signer is the `assistant`.
+     * @param offerId - ID of offer to void.
+     * @param validUntil - new validity date.
+     * @param overrides - Optional overrides.
+     * @returns Transaction response.
+     */
+    extendOffer(offerId: BigNumberish, validUntil: BigNumberish, overrides?: Partial<{
+        contractAddress: string;
+    }>): Promise<TransactionResponse>;
+    /**
+     * Extends a batch of existing offers by calling the `OfferHandlerFacet` contract.
+     * This transaction only succeeds if the connected signer is the `assistant` of all
+     * provided offers.
+     * @param offerIds - IDs of offers to void.
+     * @param validUntil - new validity date.
+     * @param overrides - Optional overrides.
+     * @returns Transaction response.
+     */
+    extendOfferBatch(offerIds: BigNumberish[], validUntil: BigNumberish, overrides?: Partial<{
+        contractAddress: string;
+    }>): Promise<TransactionResponse>;
+    /**
+     * Returns offer from subgraph.
+     * @param offerId - ID of offer.
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns Offer entity from subgraph.
+     */
+    getOfferById(offerId: BigNumberish, queryVars?: offers.subgraph.SingleOfferQueryVariables): Promise<subgraph.OfferFieldsFragment>;
+    /**
+     * Returns offers from subgraph.
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns Offer entities from subgraph.
+     */
+    getOffers(queryVars?: subgraph.GetOffersQueryQueryVariables): Promise<subgraph.OfferFieldsFragment[]>;
+    /**
+     * Renders contractual agreement for given offer.
+     * @param offerId - Id of offer to render agreement for.
+     * @returns Contractual agreement as string.
+     */
+    renderContractualAgreementForOffer(offerId: BigNumberish): Promise<string>;
+    /**
+     * Renders contractual agreement for given offer.
+     * @param template - Mustache syntax based template.
+     * @param offerData - Offer data.
+     * @returns Contractual agreement as string.
+     */
+    renderContractualAgreement(template: string, offerData: offers.CreateOfferArgs, offerMetadata: offers.AdditionalOfferMetadata): Promise<string>;
+    /**
+     * Reserves a range of vouchers to be associated with an offer
+     * @param offerId -  Offer ID
+     * @param overrides - Optional overrides.
+     * @returns Transaction response.
+     */
+    reserveRange(offerId: BigNumberish, length: BigNumberish, to: "seller" | "contract", overrides?: Partial<{
+        contractAddress: string;
+    }>): Promise<TransactionResponse>;
+    /**
+     * Returns the current allowance of the given token by calling the contract.
+     * @param exchangeToken - Address of exchange token.
+     * @param overrides - Optional overrides.
+     * @returns Allowance for given signer.
+     */
+    getExchangeTokenAllowance(exchangeToken: string, overrides?: Partial<{
+        spender: string;
+        owner: string;
+    }>): Promise<string>;
+    /**
+     * Returns `name`, `decimals` and `symbol` of the given token by calling the contract.
+     * @param exchangeToken - Address exchange token.
+     * @returns Decimals, name and symbol.
+     */
+    getExchangeTokenInfo(exchangeToken: string): Promise<ITokenInfo>;
+    /**
+     * Approves the given amount for the main protocol contract.
+     * @param exchangeToken - Address of token to approve.
+     * @param value - Amount of allowance.
+     * @param overrides - Optional overrides.
+     * @returns Transaction response.
+     */
+    approveExchangeToken(exchangeToken: string, value: BigNumberish, overrides?: Partial<{
+        spender: string;
+    }>): Promise<TransactionResponse>;
+    getProtocolAllowance(exchangeToken: string, overrides?: Partial<{
+        spender: string;
+        owner: string;
+    }>): Promise<string>;
+    checkTokenGatedCondition(offerCondition: subgraph.OfferFieldsFragment["condition"], buyerAddress: string): Promise<boolean>;
+    /**
+     * Check a given offer meets ExchangePolicy rules.
+     * @param offerId - Id of offer to render agreement for.
+     * @returns Contractual agreement as string.
+     */
+    checkExchangePolicy(offerId: BigNumberish, rules: offers.CheckExchangePolicyRules): Promise<offers.CheckExchangePolicyResult>;
+}
 //# sourceMappingURL=mixin.d.ts.map