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

package/dist/esm/mixins/base-core-sdk.js

@@ -1,58 +1,58 @@
-export class BaseCoreSDK {
-    _web3Lib;
-    _metadataStorage;
-    _theGraphStorage;
-    _subgraphUrl;
-    _protocolDiamond;
-    _chainId;
-    _tokenInfoManager;
-    _metaTxConfig;
-    _lens;
-    _contracts;
-    _getTxExplorerUrl;
-    /**
-     * Creates an instance of `BaseCoreSDK`
-     * @param args - Constructor args
-     */
-    constructor(opts) {
-        this._web3Lib = opts.web3Lib;
-        this._subgraphUrl = opts.subgraphUrl;
-        this._protocolDiamond = opts.protocolDiamond;
-        this._metadataStorage = opts.metadataStorage;
-        this._theGraphStorage = opts.theGraphStorage;
-        this._chainId = opts.chainId;
-        this._metaTxConfig = opts.metaTx;
-        this._lens = opts.lens;
-        this._contracts = opts.contracts;
-        this._getTxExplorerUrl = opts.getTxExplorerUrl;
-    }
-    assertAndGetMetaTxConfig(overrides = {}) {
-        const contractAddress = overrides.contractAddress || this._protocolDiamond;
-        const metaTransactionMethod = overrides.metaTransactionMethod || "executeMetaTransaction";
-        const metaTxRelayerUrl = overrides.metaTxConfig?.relayerUrl || this._metaTxConfig?.relayerUrl;
-        const metaTxApiKey = overrides.metaTxConfig?.apiKey || this._metaTxConfig?.apiKey;
-        // metaTxApiId is depending on the contract/method(=executeMetaTransaction) to be called with Biconomy
-        const apiIds = this._metaTxConfig?.apiIds[contractAddress.toLowerCase()];
-        const metaTxApiId = overrides.metaTxConfig?.apiId ||
-            (apiIds && apiIds[metaTransactionMethod]);
-        if (!(metaTxRelayerUrl && metaTxApiKey && metaTxApiId)) {
-            throw new Error("CoreSDK not configured to relay meta transactions. Either pass in 'relayerUrl', 'apiKey' and 'apiId' during initialization OR as overrides arguments.");
-        }
-        return {
-            metaTxRelayerUrl,
-            metaTxApiId,
-            metaTxApiKey,
-            contractAddress
-        };
-    }
-}
-// Doc: https://www.typescriptlang.org/docs/handbook/mixins.html#alternative-pattern
-export function applyMixins(derivedCtor, constructors) {
-    constructors.forEach((baseCtor) => {
-        Object.getOwnPropertyNames(baseCtor.prototype).forEach((name) => {
-            Object.defineProperty(derivedCtor.prototype, name, Object.getOwnPropertyDescriptor(baseCtor.prototype, name) ||
-                Object.create(null));
-        });
-    });
-}
+export class BaseCoreSDK {
+    _web3Lib;
+    _metadataStorage;
+    _theGraphStorage;
+    _subgraphUrl;
+    _protocolDiamond;
+    _chainId;
+    _tokenInfoManager;
+    _metaTxConfig;
+    _lens;
+    _contracts;
+    _getTxExplorerUrl;
+    /**
+     * Creates an instance of `BaseCoreSDK`
+     * @param args - Constructor args
+     */
+    constructor(opts) {
+        this._web3Lib = opts.web3Lib;
+        this._subgraphUrl = opts.subgraphUrl;
+        this._protocolDiamond = opts.protocolDiamond;
+        this._metadataStorage = opts.metadataStorage;
+        this._theGraphStorage = opts.theGraphStorage;
+        this._chainId = opts.chainId;
+        this._metaTxConfig = opts.metaTx;
+        this._lens = opts.lens;
+        this._contracts = opts.contracts;
+        this._getTxExplorerUrl = opts.getTxExplorerUrl;
+    }
+    assertAndGetMetaTxConfig(overrides = {}) {
+        const contractAddress = overrides.contractAddress || this._protocolDiamond;
+        const metaTransactionMethod = overrides.metaTransactionMethod || "executeMetaTransaction";
+        const metaTxRelayerUrl = overrides.metaTxConfig?.relayerUrl || this._metaTxConfig?.relayerUrl;
+        const metaTxApiKey = overrides.metaTxConfig?.apiKey || this._metaTxConfig?.apiKey;
+        // metaTxApiId is depending on the contract/method(=executeMetaTransaction) to be called with Biconomy
+        const apiIds = this._metaTxConfig?.apiIds[contractAddress.toLowerCase()];
+        const metaTxApiId = overrides.metaTxConfig?.apiId ||
+            (apiIds && apiIds[metaTransactionMethod]);
+        if (!(metaTxRelayerUrl && metaTxApiKey && metaTxApiId)) {
+            throw new Error("CoreSDK not configured to relay meta transactions. Either pass in 'relayerUrl', 'apiKey' and 'apiId' during initialization OR as overrides arguments.");
+        }
+        return {
+            metaTxRelayerUrl,
+            metaTxApiId,
+            metaTxApiKey,
+            contractAddress
+        };
+    }
+}
+// Doc: https://www.typescriptlang.org/docs/handbook/mixins.html#alternative-pattern
+export function applyMixins(derivedCtor, constructors) {
+    constructors.forEach((baseCtor) => {
+        Object.getOwnPropertyNames(baseCtor.prototype).forEach((name) => {
+            Object.defineProperty(derivedCtor.prototype, name, Object.getOwnPropertyDescriptor(baseCtor.prototype, name) ||
+                Object.create(null));
+        });
+    });
+}
 //# sourceMappingURL=base-core-sdk.js.map

package/dist/esm/native-meta-tx/handler.d.ts

@@ -1,43 +1,43 @@
-import { MetaTxConfig, Web3LibAdapter, TransactionResponse } from "@bosonprotocol/common";
-import { BigNumberish } from "@ethersproject/bignumber";
-import { BytesLike } from "@ethersproject/bytes";
-import { BaseMetaTxArgs, SignedMetaTx } from "../meta-tx/handler";
-export declare function getNonce(args: {
-    contractAddress: string;
-    user: string;
-    web3Lib: Web3LibAdapter;
-}): Promise<string>;
-export declare function signNativeMetaTx(args: BaseMetaTxArgs & {
-    functionName: string;
-    functionSignature: string;
-    domain: {
-        name: string;
-        version: string;
-    };
-}): Promise<SignedMetaTx>;
-export declare function signNativeMetaTxApproveExchangeToken(args: {
-    web3Lib: Web3LibAdapter;
-    chainId: number;
-    user: string;
-    exchangeToken: string;
-    spender: string;
-    value: BigNumberish;
-}): Promise<SignedMetaTx>;
-export declare function relayNativeMetaTransaction(args: {
-    web3LibAdapter: Web3LibAdapter;
-    chainId: number;
-    contractAddress: string;
-    metaTx: {
-        config: Omit<MetaTxConfig, "apiIds" | "forwarderAbi"> & {
-            apiId: string;
-        };
-        params: {
-            userAddress: string;
-            functionSignature: BytesLike;
-            sigR: BytesLike;
-            sigS: BytesLike;
-            sigV: BigNumberish;
-        };
-    };
-}): Promise<TransactionResponse>;
+import { MetaTxConfig, Web3LibAdapter, TransactionResponse } from "@bosonprotocol/common";
+import { BigNumberish } from "@ethersproject/bignumber";
+import { BytesLike } from "@ethersproject/bytes";
+import { BaseMetaTxArgs, SignedMetaTx } from "../meta-tx/handler";
+export declare function getNonce(args: {
+    contractAddress: string;
+    user: string;
+    web3Lib: Web3LibAdapter;
+}): Promise<string>;
+export declare function signNativeMetaTx(args: BaseMetaTxArgs & {
+    functionName: string;
+    functionSignature: string;
+    domain: {
+        name: string;
+        version: string;
+    };
+}): Promise<SignedMetaTx>;
+export declare function signNativeMetaTxApproveExchangeToken(args: {
+    web3Lib: Web3LibAdapter;
+    chainId: number;
+    user: string;
+    exchangeToken: string;
+    spender: string;
+    value: BigNumberish;
+}): Promise<SignedMetaTx>;
+export declare function relayNativeMetaTransaction(args: {
+    web3LibAdapter: Web3LibAdapter;
+    chainId: number;
+    contractAddress: string;
+    metaTx: {
+        config: Omit<MetaTxConfig, "apiIds" | "forwarderAbi"> & {
+            apiId: string;
+        };
+        params: {
+            userAddress: string;
+            functionSignature: BytesLike;
+            sigR: BytesLike;
+            sigS: BytesLike;
+            sigV: BigNumberish;
+        };
+    };
+}): Promise<TransactionResponse>;
 //# sourceMappingURL=handler.d.ts.map

package/dist/esm/native-meta-tx/handler.js

@@ -1,122 +1,122 @@
-import { tokenSpecifics } from "./tokenSpecifics";
-import { BigNumber } from "@ethersproject/bignumber";
-import { Biconomy } from "../meta-tx/biconomy";
-import { prepareDataSignatureParameters } from "../utils/signature";
-import { nativeMetaTransactionsIface, alternativeNonceIface } from "./interface";
-import { getName as getERC20Name } from "../erc20/handler";
-import { erc20Iface } from "../erc20/interface";
-const ERC712_VERSION = "1"; // Is consistent with all implementations of child tokens on Polygon
-export async function getNonce(args) {
-    try {
-        const result = await args.web3Lib.call({
-            to: args.contractAddress,
-            data: nativeMetaTransactionsIface.encodeFunctionData("getNonce", [
-                args.user
-            ])
-        });
-        const [nonce] = nativeMetaTransactionsIface.decodeFunctionResult("getNonce", result);
-        return String(nonce);
-    }
-    catch (e) {
-        console.warn(`Calling getNonce() for contract ${args.contractAddress} has failed. Try with 'nonces' instead`);
-        // If so, call 'nonces()' instead (USDC case, for instance)
-        const result = await args.web3Lib.call({
-            to: args.contractAddress,
-            data: alternativeNonceIface.encodeFunctionData("nonces", [args.user])
-        });
-        const [nonce] = alternativeNonceIface.decodeFunctionResult("nonces", result);
-        return String(nonce);
-    }
-}
-export async function signNativeMetaTx(args) {
-    const metaTransactionType = [
-        { name: "nonce", type: "uint256" },
-        { name: "from", type: "address" },
-        { name: "functionSignature", type: "bytes" }
-    ];
-    const customSignatureType = {
-        MetaTransaction: metaTransactionType
-    };
-    const signerAddress = await args.web3Lib.getSignerAddress();
-    const message = {
-        nonce: args.nonce,
-        from: signerAddress,
-        functionSignature: args.functionSignature
-    };
-    const signature = await prepareDataSignatureParameters({
-        ...args,
-        verifyingContractAddress: args.metaTxHandlerAddress,
-        customSignatureType,
-        customDomainData: args.domain,
-        primaryType: "MetaTransaction",
-        message
-    });
-    return {
-        functionName: args.functionName,
-        functionSignature: args.functionSignature,
-        ...signature
-    };
-}
-export async function signNativeMetaTxApproveExchangeToken(args) {
-    const domain = {
-        name: await getERC20Name({
-            contractAddress: args.exchangeToken,
-            web3Lib: args.web3Lib
-        }),
-        version: tokenSpecifics(args.chainId, args.exchangeToken)?.ERC712_VERSION ||
-            ERC712_VERSION
-    };
-    const nonce = await getNonce({
-        contractAddress: args.exchangeToken,
-        user: args.user,
-        web3Lib: args.web3Lib
-    });
-    const functionName = "approve(address,uint256)";
-    const functionSignature = erc20Iface.encodeFunctionData("approve", [
-        args.spender,
-        args.value
-    ]);
-    return signNativeMetaTx({
-        web3Lib: args.web3Lib,
-        metaTxHandlerAddress: args.exchangeToken,
-        chainId: args.chainId,
-        nonce: nonce,
-        functionName,
-        functionSignature,
-        domain
-    });
-}
-export async function relayNativeMetaTransaction(args) {
-    const { chainId, contractAddress, metaTx } = args;
-    const biconomy = new Biconomy(metaTx.config.relayerUrl, metaTx.config.apiKey, metaTx.config.apiId);
-    const relayTxResponse = await biconomy.relayTransaction({
-        to: contractAddress,
-        params: [
-            metaTx.params.userAddress,
-            metaTx.params.functionSignature,
-            metaTx.params.sigR,
-            metaTx.params.sigS,
-            metaTx.params.sigV
-        ],
-        from: metaTx.params.userAddress
-    });
-    return {
-        wait: async () => {
-            const waitResponse = await biconomy.wait({
-                networkId: chainId,
-                transactionHash: relayTxResponse.txHash
-            });
-            const txHash = waitResponse.data.newHash;
-            const txReceipt = await args.web3LibAdapter.getTransactionReceipt(txHash);
-            return {
-                to: txReceipt?.to || contractAddress,
-                from: txReceipt?.from || metaTx.params.userAddress,
-                transactionHash: txHash,
-                logs: txReceipt?.logs || [],
-                effectiveGasPrice: BigNumber.from(waitResponse.data.newGasPrice)
-            };
-        },
-        hash: relayTxResponse.txHash
-    };
-}
+import { tokenSpecifics } from "./tokenSpecifics";
+import { BigNumber } from "@ethersproject/bignumber";
+import { Biconomy } from "../meta-tx/biconomy";
+import { prepareDataSignatureParameters } from "../utils/signature";
+import { nativeMetaTransactionsIface, alternativeNonceIface } from "./interface";
+import { getName as getERC20Name } from "../erc20/handler";
+import { erc20Iface } from "../erc20/interface";
+const ERC712_VERSION = "1"; // Is consistent with all implementations of child tokens on Polygon
+export async function getNonce(args) {
+    try {
+        const result = await args.web3Lib.call({
+            to: args.contractAddress,
+            data: nativeMetaTransactionsIface.encodeFunctionData("getNonce", [
+                args.user
+            ])
+        });
+        const [nonce] = nativeMetaTransactionsIface.decodeFunctionResult("getNonce", result);
+        return String(nonce);
+    }
+    catch (e) {
+        console.warn(`Calling getNonce() for contract ${args.contractAddress} has failed. Try with 'nonces' instead`);
+        // If so, call 'nonces()' instead (USDC case, for instance)
+        const result = await args.web3Lib.call({
+            to: args.contractAddress,
+            data: alternativeNonceIface.encodeFunctionData("nonces", [args.user])
+        });
+        const [nonce] = alternativeNonceIface.decodeFunctionResult("nonces", result);
+        return String(nonce);
+    }
+}
+export async function signNativeMetaTx(args) {
+    const metaTransactionType = [
+        { name: "nonce", type: "uint256" },
+        { name: "from", type: "address" },
+        { name: "functionSignature", type: "bytes" }
+    ];
+    const customSignatureType = {
+        MetaTransaction: metaTransactionType
+    };
+    const signerAddress = await args.web3Lib.getSignerAddress();
+    const message = {
+        nonce: args.nonce,
+        from: signerAddress,
+        functionSignature: args.functionSignature
+    };
+    const signature = await prepareDataSignatureParameters({
+        ...args,
+        verifyingContractAddress: args.metaTxHandlerAddress,
+        customSignatureType,
+        customDomainData: args.domain,
+        primaryType: "MetaTransaction",
+        message
+    });
+    return {
+        functionName: args.functionName,
+        functionSignature: args.functionSignature,
+        ...signature
+    };
+}
+export async function signNativeMetaTxApproveExchangeToken(args) {
+    const domain = {
+        name: await getERC20Name({
+            contractAddress: args.exchangeToken,
+            web3Lib: args.web3Lib
+        }),
+        version: tokenSpecifics(args.chainId, args.exchangeToken)?.ERC712_VERSION ||
+            ERC712_VERSION
+    };
+    const nonce = await getNonce({
+        contractAddress: args.exchangeToken,
+        user: args.user,
+        web3Lib: args.web3Lib
+    });
+    const functionName = "approve(address,uint256)";
+    const functionSignature = erc20Iface.encodeFunctionData("approve", [
+        args.spender,
+        args.value
+    ]);
+    return signNativeMetaTx({
+        web3Lib: args.web3Lib,
+        metaTxHandlerAddress: args.exchangeToken,
+        chainId: args.chainId,
+        nonce: nonce,
+        functionName,
+        functionSignature,
+        domain
+    });
+}
+export async function relayNativeMetaTransaction(args) {
+    const { chainId, contractAddress, metaTx } = args;
+    const biconomy = new Biconomy(metaTx.config.relayerUrl, metaTx.config.apiKey, metaTx.config.apiId);
+    const relayTxResponse = await biconomy.relayTransaction({
+        to: contractAddress,
+        params: [
+            metaTx.params.userAddress,
+            metaTx.params.functionSignature,
+            metaTx.params.sigR,
+            metaTx.params.sigS,
+            metaTx.params.sigV
+        ],
+        from: metaTx.params.userAddress
+    });
+    return {
+        wait: async () => {
+            const waitResponse = await biconomy.wait({
+                networkId: chainId,
+                transactionHash: relayTxResponse.txHash
+            });
+            const txHash = waitResponse.data.newHash;
+            const txReceipt = await args.web3LibAdapter.getTransactionReceipt(txHash);
+            return {
+                to: txReceipt?.to || contractAddress,
+                from: txReceipt?.from || metaTx.params.userAddress,
+                transactionHash: txHash,
+                logs: txReceipt?.logs || [],
+                effectiveGasPrice: BigNumber.from(waitResponse.data.newGasPrice)
+            };
+        },
+        hash: relayTxResponse.txHash
+    };
+}
 //# sourceMappingURL=handler.js.map

package/dist/esm/native-meta-tx/index.d.ts

@@ -1,3 +1,3 @@
-export * as iface from "./interface";
-export * as handler from "./handler";
+export * as iface from "./interface";
+export * as handler from "./handler";
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/native-meta-tx/index.js

@@ -1,3 +1,3 @@
-export * as iface from "./interface";
-export * as handler from "./handler";
+export * as iface from "./interface";
+export * as handler from "./handler";
 //# sourceMappingURL=index.js.map

package/dist/esm/native-meta-tx/interface.d.ts

@@ -1,4 +1,4 @@
-import { Interface } from "@ethersproject/abi";
-export declare const nativeMetaTransactionsIface: Interface;
-export declare const alternativeNonceIface: Interface;
+import { Interface } from "@ethersproject/abi";
+export declare const nativeMetaTransactionsIface: Interface;
+export declare const alternativeNonceIface: Interface;
 //# sourceMappingURL=interface.d.ts.map

package/dist/esm/native-meta-tx/interface.js

@@ -1,27 +1,27 @@
-import { abis } from "@bosonprotocol/common";
-import { Interface } from "@ethersproject/abi";
-export const nativeMetaTransactionsIface = new Interface(abis.NativeMetaTransactionABI);
-const noncesAbi = [
-    {
-        inputs: [
-            {
-                internalType: "address",
-                name: "owner",
-                type: "address"
-            }
-        ],
-        name: "nonces",
-        outputs: [
-            {
-                internalType: "uint256",
-                name: "",
-                type: "uint256"
-            }
-        ],
-        stateMutability: "view",
-        type: "function"
-    }
-];
-// Some tokens (USDC) does not implement getNonces(), but nonces() instead
-export const alternativeNonceIface = new Interface(noncesAbi);
+import { abis } from "@bosonprotocol/common";
+import { Interface } from "@ethersproject/abi";
+export const nativeMetaTransactionsIface = new Interface(abis.NativeMetaTransactionABI);
+const noncesAbi = [
+    {
+        inputs: [
+            {
+                internalType: "address",
+                name: "owner",
+                type: "address"
+            }
+        ],
+        name: "nonces",
+        outputs: [
+            {
+                internalType: "uint256",
+                name: "",
+                type: "uint256"
+            }
+        ],
+        stateMutability: "view",
+        type: "function"
+    }
+];
+// Some tokens (USDC) does not implement getNonces(), but nonces() instead
+export const alternativeNonceIface = new Interface(noncesAbi);
 //# sourceMappingURL=interface.js.map

package/dist/esm/native-meta-tx/mixin.d.ts

@@ -1,35 +1,35 @@
-import { MetaTxConfig, TransactionResponse } from "@bosonprotocol/common";
-import { BigNumberish } from "@ethersproject/bignumber";
-import { BytesLike } from "@ethersproject/bytes";
-import { BaseCoreSDK } from "./../mixins/base-core-sdk";
-export declare class NativeMetaTxMixin extends BaseCoreSDK {
-    /**
-     * Encodes and signs a native "token.approve()" meta transaction that can be relayed.
-     * @param exchangeToken - The address of the token contract.
-     * @param value - The value to be approved.
-     * @param overrides - Optionally specify a spender address (default is the protocol contract address).
-     * @returns Signature.
-     */
-    signNativeMetaTxApproveExchangeToken(exchangeToken: string, value: BigNumberish, overrides?: Partial<{
-        spender: string;
-    }>): Promise<import("../meta-tx/handler").SignedMetaTx>;
-    /**
-     * Relay a native meta transaction,
-     * @param metaTxParams - Required params for meta transaction.
-     * @param overrides - Optional overrides.
-     * @returns Transaction response.
-     */
-    relayNativeMetaTransaction(contractAddress: string, metaTxParams: {
-        functionSignature: BytesLike;
-        sigR: BytesLike;
-        sigS: BytesLike;
-        sigV: BigNumberish;
-    }, overrides?: Partial<{
-        userAddress: string;
-        metaTxConfig: Partial<Omit<MetaTxConfig, "apiIds" | "forwarderAbi"> & {
-            apiId: string;
-        }>;
-        metaTransactionMethod: string;
-    }>): Promise<TransactionResponse>;
-}
+import { MetaTxConfig, TransactionResponse } from "@bosonprotocol/common";
+import { BigNumberish } from "@ethersproject/bignumber";
+import { BytesLike } from "@ethersproject/bytes";
+import { BaseCoreSDK } from "./../mixins/base-core-sdk";
+export declare class NativeMetaTxMixin extends BaseCoreSDK {
+    /**
+     * Encodes and signs a native "token.approve()" meta transaction that can be relayed.
+     * @param exchangeToken - The address of the token contract.
+     * @param value - The value to be approved.
+     * @param overrides - Optionally specify a spender address (default is the protocol contract address).
+     * @returns Signature.
+     */
+    signNativeMetaTxApproveExchangeToken(exchangeToken: string, value: BigNumberish, overrides?: Partial<{
+        spender: string;
+    }>): Promise<import("../meta-tx/handler").SignedMetaTx>;
+    /**
+     * Relay a native meta transaction,
+     * @param metaTxParams - Required params for meta transaction.
+     * @param overrides - Optional overrides.
+     * @returns Transaction response.
+     */
+    relayNativeMetaTransaction(contractAddress: string, metaTxParams: {
+        functionSignature: BytesLike;
+        sigR: BytesLike;
+        sigS: BytesLike;
+        sigV: BigNumberish;
+    }, overrides?: Partial<{
+        userAddress: string;
+        metaTxConfig: Partial<Omit<MetaTxConfig, "apiIds" | "forwarderAbi"> & {
+            apiId: string;
+        }>;
+        metaTransactionMethod: string;
+    }>): Promise<TransactionResponse>;
+}
 //# sourceMappingURL=mixin.d.ts.map