@bosonprotocol/core-sdk 1.23.0-alpha.2 → 1.23.0-alpha.21

package/dist/cjs/meta-tx/mixin.d.ts

@@ -0,0 +1,176 @@
+import { MetaTxConfig, TransactionResponse } from "@bosonprotocol/common";
+import { BigNumberish } from "@ethersproject/bignumber";
+import { BytesLike } from "@ethersproject/bytes";
+import { handler } from ".";
+import { BaseCoreSDK } from "./../mixins/base-core-sdk";
+import { GetRetriedHashesData } from "./biconomy";
+export declare class MetaTxMixin extends BaseCoreSDK {
+    /**
+     * Encodes and signs a meta transaction that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTx(args: Omit<Parameters<typeof handler.signMetaTx>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `createSeller` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxCreateSeller(args: Omit<Parameters<typeof handler.signMetaTxCreateSeller>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `createOffer` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxCreateOffer(args: Omit<Parameters<typeof handler.signMetaTxCreateOffer>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `createOfferBatch` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxCreateOfferBatch(args: Omit<Parameters<typeof handler.signMetaTxCreateOfferBatch>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `createGroup` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxCreateGroup(args: Omit<Parameters<typeof handler.signMetaTxCreateGroup>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `createOfferWithCondition` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxCreateOfferWithCondition(args: Omit<Parameters<typeof handler.signMetaTxCreateOfferWithCondition>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `voidOffer` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxVoidOffer(args: Omit<Parameters<typeof handler.signMetaTxVoidOffer>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `voidOfferBatch` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxVoidOfferBatch(args: Omit<Parameters<typeof handler.signMetaTxVoidOfferBatch>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `completeExchangeBatch` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxCompleteExchange(args: Omit<Parameters<typeof handler.signMetaTxCompleteExchange>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `completeExchangeBatch` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxCompleteExchangeBatch(args: Omit<Parameters<typeof handler.signMetaTxCompleteExchangeBatch>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `commitToOffer` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxCommitToOffer(args: Omit<Parameters<typeof handler.signMetaTxCommitToOffer>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `cancelVoucher` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxCancelVoucher(args: Omit<Parameters<typeof handler.signMetaTxCancelVoucher>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `redeemVoucher` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxRedeemVoucher(args: Omit<Parameters<typeof handler.signMetaTxRedeemVoucher>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `expireVoucher` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxExpireVoucher(args: Omit<Parameters<typeof handler.signMetaTxExpireVoucher>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `revokeVoucher` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxRevokeVoucher(args: Omit<Parameters<typeof handler.signMetaTxRevokeVoucher>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `retractDispute` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxRetractDispute(args: Omit<Parameters<typeof handler.signMetaTxRetractDispute>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `escalateDispute` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxEscalateDispute(args: Omit<Parameters<typeof handler.signMetaTxEscalateDispute>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `raiseDispute` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxRaiseDispute(args: Omit<Parameters<typeof handler.signMetaTxRaiseDispute>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `resolveDispute` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxResolveDispute(args: Omit<Parameters<typeof handler.signMetaTxResolveDispute>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `extendDisputeTimeout` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxExtendDisputeTimeout(args: Omit<Parameters<typeof handler.signMetaTxExtendDisputeTimeout>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `withdrawFunds` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxWithdrawFunds(args: Omit<Parameters<typeof handler.signMetaTxWithdrawFunds>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Encodes and signs a meta transaction for `depositFunds` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxDepositFunds(args: Omit<Parameters<typeof handler.signMetaTxDepositFunds>[0], "web3Lib" | "metaTxHandlerAddress" | "chainId">): Promise<handler.SignedMetaTx>;
+    /**
+     * Relay a meta transaction,
+     * @param metaTxParams - Required params for meta transaction.
+     * @param overrides - Optional overrides.
+     * @returns Transaction response.
+     */
+    relayMetaTransaction(metaTxParams: {
+        functionName: string;
+        functionSignature: BytesLike;
+        nonce: BigNumberish;
+        sigR: BytesLike;
+        sigS: BytesLike;
+        sigV: BigNumberish;
+    }, overrides?: Partial<{
+        userAddress: string;
+        contractAddress: string;
+        metaTxConfig: Partial<Omit<MetaTxConfig, "apiIds"> & {
+            apiId: string;
+        }>;
+        metaTransactionMethod: string;
+    }>): Promise<TransactionResponse>;
+    /**
+     * Returns information of submitted meta transaction.
+     * See https://docs.biconomy.io/api/native-meta-tx/get-retried-hashes.
+     * @param originalMetaTxHash - Original meta transaction as returned by `coreSDK.relayMetaTransaction`
+     * @param overrides - Optional overrides for meta transaction config.
+     * @returns - Additional meta transaction information.
+     */
+    getResubmittedMetaTx(originalMetaTxHash: string, overrides?: Partial<{
+        contractAddress: string;
+        metaTxConfig: Partial<Omit<MetaTxConfig, "apiIds"> & {
+            apiId: string;
+        }>;
+        metaTransactionMethod: string;
+    }>): Promise<GetRetriedHashesData>;
+}
+//# sourceMappingURL=mixin.d.ts.map

package/dist/cjs/meta-tx/mixin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mixin.d.ts","sourceRoot":"","sources":["../../../src/meta-tx/mixin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAClD,qBAAa,WAAY,SAAQ,WAAW;IAK1C;;;;OAIG;IACU,UAAU,CACrB,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EACxC,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;OAIG;IACU,sBAAsB,CACjC,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,EACpD,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;OAIG;IACU,qBAAqB,CAChC,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,EACnD,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAYH;;;;OAIG;IACU,0BAA0B,CACrC,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,EACxD,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAYH;;;;OAIG;IACU,qBAAqB,CAChC,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,EACnD,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;OAIG;IACU,kCAAkC,CAC7C,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,kCAAkC,CAAC,CAAC,CAAC,CAAC,EAChE,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAYH;;;;OAIG;IACU,mBAAmB,CAC9B,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,EACjD,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;OAIG;IACU,wBAAwB,CACnC,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,EACtD,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;OAIG;IACU,0BAA0B,CACrC,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,EACxD,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;OAIG;IACU,+BAA+B,CAC1C,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,EAC7D,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;OAIG;IACU,uBAAuB,CAClC,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,EACrD,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;OAIG;IACU,uBAAuB,CAClC,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,EACrD,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;OAIG;IACU,uBAAuB,CAClC,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,EACrD,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;OAIG;IACU,uBAAuB,CAClC,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,EACrD,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;OAIG;IACU,uBAAuB,CAClC,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,EACrD,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;OAIG;IACU,wBAAwB,CACnC,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,EACtD,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;OAIG;IACU,yBAAyB,CACpC,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,CAAC,EACvD,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;OAIG;IACU,sBAAsB,CACjC,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,EACpD,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;OAIG;IACU,wBAAwB,CACnC,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,EACtD,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;OAIG;IACU,8BAA8B,CACzC,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,8BAA8B,CAAC,CAAC,CAAC,CAAC,EAC5D,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;OAIG;IACU,uBAAuB,CAClC,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,EACrD,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;OAIG;IACU,sBAAsB,CACjC,IAAI,EAAE,IAAI,CACR,UAAU,CAAC,OAAO,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,EACpD,SAAS,GAAG,sBAAsB,GAAG,SAAS,CAC/C;IAUH;;;;;OAKG;IACU,oBAAoB,CAC/B,YAAY,EAAE;QACZ,YAAY,EAAE,MAAM,CAAC;QACrB,iBAAiB,EAAE,SAAS,CAAC;QAC7B,KAAK,EAAE,YAAY,CAAC;QACpB,IAAI,EAAE,SAAS,CAAC;QAChB,IAAI,EAAE,SAAS,CAAC;QAChB,IAAI,EAAE,YAAY,CAAC;KACpB,EACD,SAAS,GAAE,OAAO,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,eAAe,EAAE,MAAM,CAAC;QACxB,YAAY,EAAE,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG;YAAE,KAAK,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QACxE,qBAAqB,EAAE,MAAM,CAAC;KAC/B,CAAM,GACN,OAAO,CAAC,mBAAmB,CAAC;IA4B/B;;;;;;OAMG;IACU,oBAAoB,CAC/B,kBAAkB,EAAE,MAAM,EAC1B,SAAS,GAAE,OAAO,CAAC;QACjB,eAAe,EAAE,MAAM,CAAC;QACxB,YAAY,EAAE,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG;YAAE,KAAK,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QACxE,qBAAqB,EAAE,MAAM,CAAC;KAC/B,CAAM,GACN,OAAO,CAAC,oBAAoB,CAAC;CAgBjC"}

package/dist/cjs/meta-tx/mixin.js

@@ -0,0 +1,296 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetaTxMixin = void 0;
+const _1 = require(".");
+const base_core_sdk_1 = require("./../mixins/base-core-sdk");
+class MetaTxMixin extends base_core_sdk_1.BaseCoreSDK {
+    /* -------------------------------------------------------------------------- */
+    /*                           Meta Tx related methods                          */
+    /* -------------------------------------------------------------------------- */
+    /**
+     * Encodes and signs a meta transaction that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTx(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTx(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `createSeller` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxCreateSeller(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxCreateSeller(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `createOffer` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxCreateOffer(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxCreateOffer(Object.assign({ web3Lib: this._web3Lib, theGraphStorage: this._theGraphStorage, metadataStorage: this._metadataStorage, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `createOfferBatch` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxCreateOfferBatch(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxCreateOfferBatch(Object.assign({ web3Lib: this._web3Lib, theGraphStorage: this._theGraphStorage, metadataStorage: this._metadataStorage, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `createGroup` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxCreateGroup(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxCreateGroup(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `createOfferWithCondition` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxCreateOfferWithCondition(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxCreateOfferWithCondition(Object.assign({ web3Lib: this._web3Lib, theGraphStorage: this._theGraphStorage, metadataStorage: this._metadataStorage, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `voidOffer` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxVoidOffer(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxVoidOffer(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `voidOfferBatch` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxVoidOfferBatch(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxVoidOfferBatch(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `completeExchangeBatch` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxCompleteExchange(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxCompleteExchange(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `completeExchangeBatch` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxCompleteExchangeBatch(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxCompleteExchangeBatch(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `commitToOffer` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxCommitToOffer(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxCommitToOffer(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `cancelVoucher` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxCancelVoucher(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxCancelVoucher(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `redeemVoucher` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxRedeemVoucher(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxRedeemVoucher(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `expireVoucher` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxExpireVoucher(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxExpireVoucher(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `revokeVoucher` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxRevokeVoucher(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxRevokeVoucher(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `retractDispute` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxRetractDispute(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxRetractDispute(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `escalateDispute` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxEscalateDispute(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxEscalateDispute(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `raiseDispute` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxRaiseDispute(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxRaiseDispute(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `resolveDispute` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxResolveDispute(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxResolveDispute(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `extendDisputeTimeout` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxExtendDisputeTimeout(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxExtendDisputeTimeout(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `withdrawFunds` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxWithdrawFunds(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxWithdrawFunds(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Encodes and signs a meta transaction for `depositFunds` that can be relayed.
+     * @param args - Meta transaction args.
+     * @returns Signature.
+     */
+    signMetaTxDepositFunds(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return _1.handler.signMetaTxDepositFunds(Object.assign({ web3Lib: this._web3Lib, metaTxHandlerAddress: this._protocolDiamond, chainId: this._chainId }, args));
+        });
+    }
+    /**
+     * Relay a meta transaction,
+     * @param metaTxParams - Required params for meta transaction.
+     * @param overrides - Optional overrides.
+     * @returns Transaction response.
+     */
+    relayMetaTransaction(metaTxParams, overrides = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { metaTxApiId, metaTxApiKey, metaTxRelayerUrl, contractAddress } = this.assertAndGetMetaTxConfig(overrides);
+            return _1.handler.relayMetaTransaction({
+                web3LibAdapter: this._web3Lib,
+                contractAddress,
+                chainId: this._chainId,
+                metaTx: {
+                    config: {
+                        relayerUrl: metaTxRelayerUrl,
+                        apiId: metaTxApiId,
+                        apiKey: metaTxApiKey
+                    },
+                    params: {
+                        userAddress: overrides.userAddress || (yield this._web3Lib.getSignerAddress()),
+                        functionName: metaTxParams.functionName,
+                        functionSignature: metaTxParams.functionSignature,
+                        nonce: metaTxParams.nonce,
+                        sigR: metaTxParams.sigR,
+                        sigS: metaTxParams.sigS,
+                        sigV: metaTxParams.sigV
+                    }
+                }
+            });
+        });
+    }
+    /**
+     * Returns information of submitted meta transaction.
+     * See https://docs.biconomy.io/api/native-meta-tx/get-retried-hashes.
+     * @param originalMetaTxHash - Original meta transaction as returned by `coreSDK.relayMetaTransaction`
+     * @param overrides - Optional overrides for meta transaction config.
+     * @returns - Additional meta transaction information.
+     */
+    getResubmittedMetaTx(originalMetaTxHash, overrides = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { metaTxApiId, metaTxApiKey, metaTxRelayerUrl } = this.assertAndGetMetaTxConfig(overrides);
+            return _1.handler.getResubmitted({
+                chainId: this._chainId,
+                metaTx: {
+                    config: {
+                        relayerUrl: metaTxRelayerUrl,
+                        apiId: metaTxApiId,
+                        apiKey: metaTxApiKey
+                    },
+                    originalHash: originalMetaTxHash
+                }
+            });
+        });
+    }
+}
+exports.MetaTxMixin = MetaTxMixin;
+//# sourceMappingURL=mixin.js.map

package/dist/cjs/meta-tx/mixin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mixin.js","sourceRoot":"","sources":["../../../src/meta-tx/mixin.ts"],"names":[],"mappings":";;;;;;;;;;;;AAGA,wBAA4B;AAC5B,6DAAwD;AAExD,MAAa,WAAY,SAAQ,2BAAW;IAC1C,gFAAgF;IAChF,gFAAgF;IAChF,gFAAgF;IAEhF;;;;OAIG;IACU,UAAU,CACrB,IAGC;;YAED,OAAO,UAAO,CAAC,UAAU,iBACvB,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,sBAAsB,CACjC,IAGC;;YAED,OAAO,UAAO,CAAC,sBAAsB,iBACnC,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,qBAAqB,CAChC,IAGC;;YAED,OAAO,UAAO,CAAC,qBAAqB,iBAClC,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,eAAe,EAAE,IAAI,CAAC,gBAAgB,EACtC,eAAe,EAAE,IAAI,CAAC,gBAAgB,EACtC,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,0BAA0B,CACrC,IAGC;;YAED,OAAO,UAAO,CAAC,0BAA0B,iBACvC,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,eAAe,EAAE,IAAI,CAAC,gBAAgB,EACtC,eAAe,EAAE,IAAI,CAAC,gBAAgB,EACtC,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,qBAAqB,CAChC,IAGC;;YAED,OAAO,UAAO,CAAC,qBAAqB,iBAClC,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,kCAAkC,CAC7C,IAGC;;YAED,OAAO,UAAO,CAAC,kCAAkC,iBAC/C,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,eAAe,EAAE,IAAI,CAAC,gBAAgB,EACtC,eAAe,EAAE,IAAI,CAAC,gBAAgB,EACtC,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,mBAAmB,CAC9B,IAGC;;YAED,OAAO,UAAO,CAAC,mBAAmB,iBAChC,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,wBAAwB,CACnC,IAGC;;YAED,OAAO,UAAO,CAAC,wBAAwB,iBACrC,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,0BAA0B,CACrC,IAGC;;YAED,OAAO,UAAO,CAAC,0BAA0B,iBACvC,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,+BAA+B,CAC1C,IAGC;;YAED,OAAO,UAAO,CAAC,+BAA+B,iBAC5C,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,uBAAuB,CAClC,IAGC;;YAED,OAAO,UAAO,CAAC,uBAAuB,iBACpC,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,uBAAuB,CAClC,IAGC;;YAED,OAAO,UAAO,CAAC,uBAAuB,iBACpC,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,uBAAuB,CAClC,IAGC;;YAED,OAAO,UAAO,CAAC,uBAAuB,iBACpC,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,uBAAuB,CAClC,IAGC;;YAED,OAAO,UAAO,CAAC,uBAAuB,iBACpC,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,uBAAuB,CAClC,IAGC;;YAED,OAAO,UAAO,CAAC,uBAAuB,iBACpC,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,wBAAwB,CACnC,IAGC;;YAED,OAAO,UAAO,CAAC,wBAAwB,iBACrC,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,yBAAyB,CACpC,IAGC;;YAED,OAAO,UAAO,CAAC,yBAAyB,iBACtC,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,sBAAsB,CACjC,IAGC;;YAED,OAAO,UAAO,CAAC,sBAAsB,iBACnC,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,wBAAwB,CACnC,IAGC;;YAED,OAAO,UAAO,CAAC,wBAAwB,iBACrC,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,8BAA8B,CACzC,IAGC;;YAED,OAAO,UAAO,CAAC,8BAA8B,iBAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,uBAAuB,CAClC,IAGC;;YAED,OAAO,UAAO,CAAC,uBAAuB,iBACpC,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;OAIG;IACU,sBAAsB,CACjC,IAGC;;YAED,OAAO,UAAO,CAAC,sBAAsB,iBACnC,OAAO,EAAE,IAAI,CAAC,QAAQ,EACtB,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAC3C,OAAO,EAAE,IAAI,CAAC,QAAQ,IACnB,IAAI,EACP,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACU,oBAAoB,CAC/B,YAOC,EACD,YAKK,EAAE;;YAEP,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,gBAAgB,EAAE,eAAe,EAAE,GACpE,IAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;YAE3C,OAAO,UAAO,CAAC,oBAAoB,CAAC;gBAClC,cAAc,EAAE,IAAI,CAAC,QAAQ;gBAC7B,eAAe;gBACf,OAAO,EAAE,IAAI,CAAC,QAAQ;gBACtB,MAAM,EAAE;oBACN,MAAM,EAAE;wBACN,UAAU,EAAE,gBAAgB;wBAC5B,KAAK,EAAE,WAAW;wBAClB,MAAM,EAAE,YAAY;qBACrB;oBACD,MAAM,EAAE;wBACN,WAAW,EACT,SAAS,CAAC,WAAW,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,CAAC;wBACnE,YAAY,EAAE,YAAY,CAAC,YAAY;wBACvC,iBAAiB,EAAE,YAAY,CAAC,iBAAiB;wBACjD,KAAK,EAAE,YAAY,CAAC,KAAK;wBACzB,IAAI,EAAE,YAAY,CAAC,IAAI;wBACvB,IAAI,EAAE,YAAY,CAAC,IAAI;wBACvB,IAAI,EAAE,YAAY,CAAC,IAAI;qBACxB;iBACF;aACF,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;;OAMG;IACU,oBAAoB,CAC/B,kBAA0B,EAC1B,YAIK,EAAE;;YAEP,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,gBAAgB,EAAE,GACnD,IAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;YAE3C,OAAO,UAAO,CAAC,cAAc,CAAC;gBAC5B,OAAO,EAAE,IAAI,CAAC,QAAQ;gBACtB,MAAM,EAAE;oBACN,MAAM,EAAE;wBACN,UAAU,EAAE,gBAAgB;wBAC5B,KAAK,EAAE,WAAW;wBAClB,MAAM,EAAE,YAAY;qBACrB;oBACD,YAAY,EAAE,kBAAkB;iBACjC;aACF,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AA5fD,kCA4fC"}

package/dist/cjs/metadata/mixin.d.ts

@@ -0,0 +1,42 @@
+import { BaseCoreSDK } from "./../mixins/base-core-sdk";
+import * as subgraph from "../subgraph";
+import { AnyMetadata } from "..";
+export declare class MetadataMixin extends BaseCoreSDK {
+    /**
+     * Stores supported offer metadata via the MetadataStorage instance which was passed in
+     * at construction.
+     * @param metadata - Offer metadata of type `BASE` or `PRODUCT_V1`.
+     * @returns Metadata hash / identifier.
+     */
+    storeMetadata(metadata: AnyMetadata): Promise<string>;
+    /**
+     * Returns supported offer metadata from passed in `MetadataStorage` instance.
+     * @param metadataHashOrUri - Metadata hash or uri that can be handled by the
+     * storage instance.
+     * @returns Offer metadata.
+     */
+    getMetadata(metadataHashOrUri: string): Promise<AnyMetadata>;
+    /**
+     * Returns `BASE` type offer metadata entities from subgraph.
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns BaseMetadataEntities from subgraph.
+     */
+    getBaseMetadataEntities(queryVars?: subgraph.GetBaseMetadataEntitiesQueryQueryVariables): Promise<subgraph.BaseMetadataEntityFieldsFragment[]>;
+    /**
+     * Returns `PRODUCT_V1` type offer metadata entities from subgraph.
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns ProductV1MetadataEntities from subgraph.
+     */
+    getProductV1MetadataEntities(queryVars?: subgraph.GetProductV1MetadataEntitiesQueryQueryVariables): Promise<subgraph.ProductV1MetadataEntityFieldsFragment[]>;
+    getProductV1Products(queryVars?: subgraph.GetProductV1ProductsQueryQueryVariables): Promise<subgraph.BaseProductV1ProductFieldsFragment[]>;
+    getProductWithVariants(productUuid: string): Promise<{
+        product: subgraph.BaseProductV1ProductFieldsFragment;
+        variants: Array<{
+            offer: subgraph.OfferFieldsFragment;
+            variations: Array<subgraph.ProductV1Variation>;
+        }>;
+    } | null>;
+    getAllProductsWithVariants(queryVars?: subgraph.GetProductV1ProductsWithVariantsQueryQueryVariables): Promise<subgraph.BaseProductV1ProductWithVariantsFieldsFragment[]>;
+    getAllProductsWithNotVoidedVariants(queryVars?: subgraph.GetAllProductsWithNotVoidedVariantsQueryQueryVariables): Promise<subgraph.BaseProductV1ProductWithNotVoidedVariantsFieldsFragment[]>;
+}
+//# sourceMappingURL=mixin.d.ts.map

package/dist/cjs/metadata/mixin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mixin.d.ts","sourceRoot":"","sources":["../../../src/metadata/mixin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,KAAK,QAAQ,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAUjC,qBAAa,aAAc,SAAQ,WAAW;IAK5C;;;;;OAKG;IACU,aAAa,CAAC,QAAQ,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAQlE;;;;;OAKG;IACU,WAAW,CAAC,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAQzE;;;;OAIG;IACU,uBAAuB,CAClC,SAAS,CAAC,EAAE,QAAQ,CAAC,0CAA0C,GAC9D,OAAO,CAAC,QAAQ,CAAC,gCAAgC,EAAE,CAAC;IAIvD;;;;OAIG;IACU,4BAA4B,CACvC,SAAS,CAAC,EAAE,QAAQ,CAAC,+CAA+C,GACnE,OAAO,CAAC,QAAQ,CAAC,qCAAqC,EAAE,CAAC;IAI/C,oBAAoB,CAC/B,SAAS,CAAC,EAAE,QAAQ,CAAC,uCAAuC,GAC3D,OAAO,CAAC,QAAQ,CAAC,kCAAkC,EAAE,CAAC;IAI5C,sBAAsB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC;QAChE,OAAO,EAAE,QAAQ,CAAC,kCAAkC,CAAC;QACrD,QAAQ,EAAE,KAAK,CAAC;YACd,KAAK,EAAE,QAAQ,CAAC,mBAAmB,CAAC;YACpC,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;SAChD,CAAC,CAAC;KACJ,GAAG,IAAI,CAAC;IAII,0BAA0B,CACrC,SAAS,CAAC,EAAE,QAAQ,CAAC,mDAAmD,GACvE,OAAO,CAAC,QAAQ,CAAC,8CAA8C,EAAE,CAAC;IAIxD,mCAAmC,CAC9C,SAAS,CAAC,EAAE,QAAQ,CAAC,sDAAsD,GAC1E,OAAO,CACR,QAAQ,CAAC,uDAAuD,EAAE,CACnE;CAGF"}

package/dist/cjs/metadata/mixin.js

@@ -0,0 +1,89 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetadataMixin = void 0;
+const base_core_sdk_1 = require("./../mixins/base-core-sdk");
+const subgraph_1 = require("./subgraph");
+class MetadataMixin extends base_core_sdk_1.BaseCoreSDK {
+    /* -------------------------------------------------------------------------- */
+    /*                          Metadata related methods                          */
+    /* -------------------------------------------------------------------------- */
+    /**
+     * Stores supported offer metadata via the MetadataStorage instance which was passed in
+     * at construction.
+     * @param metadata - Offer metadata of type `BASE` or `PRODUCT_V1`.
+     * @returns Metadata hash / identifier.
+     */
+    storeMetadata(metadata) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this._metadataStorage) {
+                throw new Error("No metadata storage set");
+            }
+            return this._metadataStorage.storeMetadata(metadata);
+        });
+    }
+    /**
+     * Returns supported offer metadata from passed in `MetadataStorage` instance.
+     * @param metadataHashOrUri - Metadata hash or uri that can be handled by the
+     * storage instance.
+     * @returns Offer metadata.
+     */
+    getMetadata(metadataHashOrUri) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this._metadataStorage) {
+                throw new Error("No metadata storage set");
+            }
+            return this._metadataStorage.getMetadata(metadataHashOrUri);
+        });
+    }
+    /**
+     * Returns `BASE` type offer metadata entities from subgraph.
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns BaseMetadataEntities from subgraph.
+     */
+    getBaseMetadataEntities(queryVars) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, subgraph_1.getBaseMetadataEntities)(this._subgraphUrl, queryVars);
+        });
+    }
+    /**
+     * Returns `PRODUCT_V1` type offer metadata entities from subgraph.
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns ProductV1MetadataEntities from subgraph.
+     */
+    getProductV1MetadataEntities(queryVars) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, subgraph_1.getProductV1MetadataEntities)(this._subgraphUrl, queryVars);
+        });
+    }
+    getProductV1Products(queryVars) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, subgraph_1.getProductV1Products)(this._subgraphUrl, queryVars);
+        });
+    }
+    getProductWithVariants(productUuid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, subgraph_1.getProductWithVariants)(this._subgraphUrl, productUuid);
+        });
+    }
+    getAllProductsWithVariants(queryVars) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, subgraph_1.getAllProductsWithVariants)(this._subgraphUrl, queryVars);
+        });
+    }
+    getAllProductsWithNotVoidedVariants(queryVars) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, subgraph_1.getAllProductsWithNotVoidedVariants)(this._subgraphUrl, queryVars);
+        });
+    }
+}
+exports.MetadataMixin = MetadataMixin;
+//# sourceMappingURL=mixin.js.map

package/dist/cjs/metadata/mixin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mixin.js","sourceRoot":"","sources":["../../../src/metadata/mixin.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6DAAwD;AAGxD,yCAOoB;AAEpB,MAAa,aAAc,SAAQ,2BAAW;IAC5C,gFAAgF;IAChF,gFAAgF;IAChF,gFAAgF;IAEhF;;;;;OAKG;IACU,aAAa,CAAC,QAAqB;;YAC9C,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE;gBAC1B,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;aAC5C;YAED,OAAO,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACvD,CAAC;KAAA;IAED;;;;;OAKG;IACU,WAAW,CAAC,iBAAyB;;YAChD,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE;gBAC1B,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;aAC5C;YAED,OAAO,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;QAC9D,CAAC;KAAA;IAED;;;;OAIG;IACU,uBAAuB,CAClC,SAA+D;;YAE/D,OAAO,IAAA,kCAAuB,EAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAC/D,CAAC;KAAA;IAED;;;;OAIG;IACU,4BAA4B,CACvC,SAAoE;;YAEpE,OAAO,IAAA,uCAA4B,EAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QACpE,CAAC;KAAA;IAEY,oBAAoB,CAC/B,SAA4D;;YAE5D,OAAO,IAAA,+BAAoB,EAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAC5D,CAAC;KAAA;IAEY,sBAAsB,CAAC,WAAmB;;YAOrD,OAAO,IAAA,iCAAsB,EAAC,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;QAChE,CAAC;KAAA;IAEY,0BAA0B,CACrC,SAAwE;;YAExE,OAAO,IAAA,qCAA0B,EAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAClE,CAAC;KAAA;IAEY,mCAAmC,CAC9C,SAA2E;;YAI3E,OAAO,IAAA,8CAAmC,EAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAC3E,CAAC;KAAA;CACF;AApFD,sCAoFC"}

package/dist/cjs/metadata/subgraph.d.ts

@@ -1,5 +1,5 @@
 import { BigNumberish } from "@ethersproject/bignumber";
-import { BaseMetadataEntityFieldsFragment, ProductV1MetadataEntityFieldsFragment, GetBaseMetadataEntityByIdQueryQueryVariables, GetBaseMetadataEntitiesQueryQueryVariables, GetProductV1BrandsQueryQueryVariables, GetProductV1ProductsQueryQueryVariables, GetProductV1CategoriesQueryQueryVariables, GetProductV1MetadataEntitiesQueryQueryVariables, GetProductV1MetadataEntityByIdQueryQueryVariables, BaseProductV1BrandFieldsFragment, BaseProductV1ProductFieldsFragment, BaseProductV1CategoryFieldsFragment, OfferFieldsFragment, ProductV1Variation } from "../subgraph";
+import { BaseMetadataEntityFieldsFragment, ProductV1MetadataEntityFieldsFragment, GetBaseMetadataEntityByIdQueryQueryVariables, GetBaseMetadataEntitiesQueryQueryVariables, GetProductV1BrandsQueryQueryVariables, GetProductV1ProductsQueryQueryVariables, GetProductV1CategoriesQueryQueryVariables, GetProductV1MetadataEntitiesQueryQueryVariables, GetProductV1MetadataEntityByIdQueryQueryVariables, BaseProductV1BrandFieldsFragment, BaseProductV1ProductFieldsFragment, BaseProductV1CategoryFieldsFragment, OfferFieldsFragment, ProductV1Variation, GetProductV1ProductsWithVariantsQueryQueryVariables, BaseProductV1ProductWithNotVoidedVariantsFieldsFragment, BaseProductV1ProductWithVariantsFieldsFragment, GetAllProductsWithNotVoidedVariantsQueryQueryVariables } from "../subgraph";
 export declare type SingleBaseMetadataEntityQueryVariables = Omit<GetBaseMetadataEntityByIdQueryQueryVariables, "metadataId">;
 export declare type SingleProductV1MetadataEntityQueryVariables = Omit<GetProductV1MetadataEntityByIdQueryQueryVariables, "metadataId">;
 export declare function getBaseMetadataEntityByOfferId(subgraphUrl: string, offerId: BigNumberish, queryVars?: SingleBaseMetadataEntityQueryVariables): Promise<BaseMetadataEntityFieldsFragment>;
@@ -9,6 +9,8 @@ export declare function getProductV1MetadataEntities(subgraphUrl: string, queryV
 export declare function getProductV1Brands(subgraphUrl: string, queryVars?: GetProductV1BrandsQueryQueryVariables): Promise<BaseProductV1BrandFieldsFragment[]>;
 export declare function getProductV1Categories(subgraphUrl: string, queryVars?: GetProductV1CategoriesQueryQueryVariables): Promise<BaseProductV1CategoryFieldsFragment[]>;
 export declare function getProductV1Products(subgraphUrl: string, queryVars?: GetProductV1ProductsQueryQueryVariables): Promise<BaseProductV1ProductFieldsFragment[]>;
+export declare function getAllProductsWithVariants(subgraphUrl: string, queryVars?: GetProductV1ProductsWithVariantsQueryQueryVariables): Promise<BaseProductV1ProductWithVariantsFieldsFragment[]>;
+export declare function getAllProductsWithNotVoidedVariants(subgraphUrl: string, queryVars?: GetAllProductsWithNotVoidedVariantsQueryQueryVariables): Promise<BaseProductV1ProductWithNotVoidedVariantsFieldsFragment[]>;
 export declare function getProductWithVariants(subgraphUrl: string, productUuid: string): Promise<{
     product: BaseProductV1ProductFieldsFragment;
     variants: {