privately-smartcontract-lib 1.0.6 → 1.1.0

package/dist/modules/collection/collection.client.js

@@ -1,224 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PrivatelyCollectionClient = void 0;
-const ethers_1 = require("ethers");
-const PrivatelyCollection_json_1 = __importDefault(require("../../../PrivatelyCollection.json"));
-const request_signature_1 = require("../../common/request-signature");
-const collection_approve_request_1 = require("./collection.approve.request");
-const collection_errors_1 = require("./collection.errors");
-const collection_mint_request_1 = require("./collection.mint.request");
-const collection_nft_1 = require("./collection.nft");
-const collection_transfer_request_1 = require("./collection.transfer.request");
-const COLLECTION_ADDRESS = "0xe7f1725e7734ce288f8367e1bb143e90bb3f0512";
-class PrivatelyCollectionClient {
-    contract;
-    signer;
-    domain;
-    constructor(signer, network) {
-        this.signer = signer;
-        this.contract = new ethers_1.Contract(COLLECTION_ADDRESS, PrivatelyCollection_json_1.default.abi, signer);
-        const name = PrivatelyCollection_json_1.default.contractName;
-        this.domain = {
-            name,
-            version: "1.0.0",
-            chainId: network.chainId,
-            verifyingContract: COLLECTION_ADDRESS
-        };
-    }
-    /**
-     * Retrieves a list of all NFT token IDs currently stored in the contract.
-     * @returns An array of token IDs as bigint.
-     */
-    async getSupplyCollection() {
-        try {
-            return await this.contract.getAllCollection();
-        }
-        catch (error) {
-            throw collection_errors_1.CollectionError.from(error, this.contract);
-        }
-    }
-    /**
-     * Retrieves the list of NFT token IDs owned by a specific user.
-     * @param owner The address of the user whose Collection should be retrieved.
-     * @returns An array of token IDs as bigint.
-     */
-    async getUserCollection(owner) {
-        try {
-            const collection = await this.contract.getCollectionOfUser(owner);
-            return await collection_nft_1.PrivatelyNFT.map(collection, this);
-        }
-        catch (error) {
-            throw collection_errors_1.CollectionError.from(error, this.contract);
-        }
-    }
-    /**
-     * Retrieves the list of NFT token IDs owned by the client's signer address.
-     * @returns An array of token IDs as bigint.
-     */
-    async getCollection() {
-        const myAddress = await this.signer.getAddress();
-        try {
-            const collection = await this.contract.getCollectionOfUser(myAddress);
-            return await collection_nft_1.PrivatelyNFT.map(collection, this);
-        }
-        catch (error) {
-            throw collection_errors_1.CollectionError.from(error, this.contract);
-        }
-    }
-    /**
-     * Fetches the metadata for a specific NFT token ID.
-     * @param tokenId The ID of the NFT (as BigNumberish).
-     * @returns A PrivatelyNFT object containing the NFT's metadata.
-     */
-    async getData(tokenId) {
-        try {
-            const data = await this.contract.getData(tokenId);
-            return new collection_nft_1.PrivatelyNFT(tokenId, data.title, data.author, data.uri);
-        }
-        catch (error) {
-            throw collection_errors_1.CollectionError.from(error, this.contract);
-        }
-    }
-    /**
-     * Creates and signs a MintRequest using EIP-712 structured data.
-     * This request can later be relayed to the contract via `relayMintRequest`.
-     * @param title The NFT title.
-     * @param tokenURI The URI for the NFT metadata.
-     * @returns An object containing the mint request struct and its EIP-712 signature.
-     */
-    async createMintRequest(title, tokenURI) {
-        if (!title.trim())
-            throw new collection_errors_1.CollectionError("Title cannot be empty");
-        if (!tokenURI.trim())
-            throw new collection_errors_1.CollectionError("Token URI cannot be empty");
-        const userAddress = await this.signer.getAddress();
-        const nonce = (await this.getNonces()).mintNonce;
-        const request = {
-            user: userAddress,
-            title: title,
-            author: userAddress,
-            tokenURI: tokenURI,
-            nonce: nonce
-        };
-        const signature = await this.signer.signTypedData(this.domain, collection_mint_request_1.COLLECTION_MINT_REQUEST_TYPE, request);
-        return new request_signature_1.RequestSignature(request_signature_1.RequestType.COLLECTION_MINT, signature, request);
-    }
-    /**
-     * Relays a signed mint request to the blockchain.
-     * The relayer (caller of this function) is responsible for the transaction's gas cost.
-     * @param request The MintRequest object containing user, title, author, tokenURI, and nonce.
-     * @param signature The EIP-712 signature that authorizes this mint.
-     * @returns A TransactionResponse object from ethers.
-     */
-    async relayMintRequest(request, signature) {
-        try {
-            return await this.contract.metaMint(request.user, request.title, request.tokenURI, signature);
-        }
-        catch (error) {
-            throw collection_errors_1.CollectionError.from(error, this.contract);
-        }
-    }
-    /**
-     * Creates and signs a TransferRequest using EIP-712 structured data.
-     * This request can later be relayed to the contract via `relayTransferRequest`.
-     * @param to The address to which the NFT should be transferred.
-     * @param tokenId The ID of the NFT (BigNumberish).
-     * @returns An object containing the transfer request struct and its EIP-712 signature.
-     */
-    async createTransferRequest(to, tokenId) {
-        const from = await this.signer.getAddress();
-        const nonce = (await this.getNonces()).transferNonce;
-        const request = {
-            from,
-            to,
-            tokenId,
-            nonce
-        };
-        const signature = await this.signer.signTypedData(this.domain, collection_transfer_request_1.COLLECTION_TRANSFER_REQUEST_TYPE, request);
-        return new request_signature_1.RequestSignature(request_signature_1.RequestType.COLLECTION_TRANSFER, signature, request);
-    }
-    /**
-     * Relays a signed transfer request to the blockchain.
-     * The relayer (caller of this function) is responsible for the transaction's gas cost.
-     * @param request The TransferRequest object containing from, to, tokenId, and nonce.
-     * @param signature The EIP-712 signature that authorizes this transfer.
-     * @returns A TransactionResponse object from ethers.
-     */
-    async relayTransferRequest(request, signature) {
-        try {
-            return await this.contract.metaTransfer(request.from, request.to, request.tokenId, signature);
-        }
-        catch (error) {
-            throw collection_errors_1.CollectionError.from(error, this.contract);
-        }
-    }
-    /**
-     * Creates and signs an ApproveRequest using EIP-712 structured data.
-     * @param spender The address to which the approval should be granted.
-     * @param tokenId The ID of the NFT (BigNumberish).
-     * @returns An object containing the approval request struct and its EIP-712 signature.
-     */
-    async createApproveRequest(spender, tokenId) {
-        const owner = await this.signer.getAddress();
-        const nonce = (await this.getNonces()).approveNonce;
-        const request = {
-            owner,
-            spender,
-            tokenId,
-            nonce
-        };
-        const signature = await this.signer.signTypedData(this.domain, collection_approve_request_1.COLLECTION_APPROVE_REQUEST_TYPE, request);
-        return new request_signature_1.RequestSignature(request_signature_1.RequestType.COLLECTION_APPROVE, signature, request);
-    }
-    /**
-     * Relays a signed approval request to the blockchain.
-     * The relayer (caller of this function) is responsible for the transaction's gas cost.
-     * @param request The ApproveRequest object containing owner, spender, tokenId, and nonce.
-     * @param signature The EIP-712 signature that authorizes this approval.
-     * @returns A TransactionResponse object from ethers.
-     */
-    async relayApproveRequest(request, signature) {
-        try {
-            return await this.contract.metaApprove(request.owner, request.spender, request.tokenId, signature);
-        }
-        catch (error) {
-            throw collection_errors_1.CollectionError.from(error, this.contract);
-        }
-    }
-    /**
-     * Registers a listener for the "OnMint" event emitted by the contract when a new NFT is minted.
-     * @param listener A callback function to be executed when the "OnMint" event is triggered.
-     */
-    onMintEvent(listener) {
-        void this.contract.on("OnMint", (to, amount, event) => {
-            listener(to, amount, event);
-        });
-    }
-    /**
-     * Subscribes a listener to the "OnTransfer" event emitted by the contract when a NFT transfer is executed.
-     * @param listener A callback function to be executed when the "OnTransfer" event is triggered.
-     */
-    onTransferEvent(listener) {
-        void this.contract.on("OnTransfer", (from, to, amount, event) => {
-            listener(from, to, amount, event);
-        });
-    }
-    /**
-     * Retrieves current nonce for meta-transactions
-     * @returns Current nonce for signer's address
-     */
-    async getNonces() {
-        const selfAddress = await this.signer.getAddress();
-        try {
-            const nonces = await this.contract.getNonces(selfAddress);
-            return { mintNonce: nonces.mintNonce, transferNonce: nonces.transferNonce, approveNonce: nonces.approveNonce };
-        }
-        catch (error) {
-            throw collection_errors_1.CollectionError.from(error, this.contract);
-        }
-    }
-}
-exports.PrivatelyCollectionClient = PrivatelyCollectionClient;

package/dist/modules/collection/collection.errors.d.ts

@@ -1,6 +0,0 @@
-import { Contract } from "ethers";
-import { PrivatelyError } from "../../common/privately.error";
-export declare class CollectionError extends PrivatelyError {
-    constructor(message: string);
-    static from(error: any, contract?: Contract): CollectionError;
-}

package/dist/modules/collection/collection.errors.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CollectionError = void 0;
-const privately_error_1 = require("../../common/privately.error");
-class CollectionError extends privately_error_1.PrivatelyError {
-    constructor(message) {
-        super(`CollectionError: ${message}`);
-        this.name = "CollectionError";
-    }
-    static from(error, contract) {
-        return new CollectionError((0, privately_error_1.parseContractError)(error, contract?.interface));
-    }
-}
-exports.CollectionError = CollectionError;

package/dist/modules/collection/collection.events.d.ts

@@ -1,3 +0,0 @@
-import { Log } from "ethers";
-export type OnMintListener = (to: string, amount: bigint, event: Log) => void;
-export type OnTransferListener = (from: string, to: string, amount: bigint, event: Log) => void;

package/dist/modules/collection/collection.events.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/collection/collection.mint.request.d.ts

@@ -1,9 +0,0 @@
-import { TypedDataField } from "ethers";
-export interface CollectionMintRequest {
-    user: string;
-    title: string;
-    author: string;
-    tokenURI: string;
-    nonce: bigint;
-}
-export declare const COLLECTION_MINT_REQUEST_TYPE: Record<string, TypedDataField[]>;

package/dist/modules/collection/collection.mint.request.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.COLLECTION_MINT_REQUEST_TYPE = void 0;
-exports.COLLECTION_MINT_REQUEST_TYPE = {
-    MintRequest: [
-        { name: "user", type: "address" },
-        { name: "title", type: "string" },
-        { name: "author", type: "address" },
-        { name: "tokenURI", type: "string" },
-        { name: "nonce", type: "uint256" }
-    ]
-};

package/dist/modules/collection/collection.nft.d.ts

@@ -1,8 +0,0 @@
-export declare class PrivatelyNFT {
-    id: bigint;
-    title: string;
-    author: string;
-    url: string;
-    constructor(id: bigint, title: string, author: string, url: string);
-    static map(list: bigint[], client: any): Promise<PrivatelyNFT[]>;
-}

package/dist/modules/collection/collection.nft.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PrivatelyNFT = void 0;
-class PrivatelyNFT {
-    id;
-    title;
-    author;
-    url;
-    constructor(id, title, author, url) {
-        this.id = id;
-        this.title = title;
-        this.author = author;
-        this.url = url;
-    }
-    static async map(list, client) {
-        return await Promise.all(list.map(async (id) => {
-            return await client.getData(id);
-        }));
-    }
-}
-exports.PrivatelyNFT = PrivatelyNFT;

package/dist/modules/collection/collection.nonces.d.ts

@@ -1,5 +0,0 @@
-export interface CollectionNonces {
-    mintNonce: bigint;
-    transferNonce: bigint;
-    approveNonce: bigint;
-}

package/dist/modules/collection/collection.nonces.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/modules/collection/collection.transfer.request.d.ts

@@ -1,12 +0,0 @@
-export interface CollectionTransferRequest {
-    from: string;
-    to: string;
-    tokenId: bigint;
-    nonce: bigint;
-}
-export declare const COLLECTION_TRANSFER_REQUEST_TYPE: {
-    TransferRequest: {
-        name: string;
-        type: string;
-    }[];
-};

package/dist/modules/collection/collection.transfer.request.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.COLLECTION_TRANSFER_REQUEST_TYPE = void 0;
-exports.COLLECTION_TRANSFER_REQUEST_TYPE = {
-    TransferRequest: [
-        { name: "from", type: "address" },
-        { name: "to", type: "address" },
-        { name: "tokenId", type: "uint256" },
-        { name: "nonce", type: "uint256" }
-    ]
-};

package/dist/modules/collection/index.d.ts

@@ -1,7 +0,0 @@
-export * from "./collection.approve.request";
-export * from "./collection.client";
-export * from "./collection.errors";
-export * from "./collection.mint.request";
-export * from "./collection.nft";
-export * from "./collection.nonces";
-export * from "./collection.transfer.request";

package/dist/modules/collection/index.js

@@ -1,23 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./collection.approve.request"), exports);
-__exportStar(require("./collection.client"), exports);
-__exportStar(require("./collection.errors"), exports);
-__exportStar(require("./collection.mint.request"), exports);
-__exportStar(require("./collection.nft"), exports);
-__exportStar(require("./collection.nonces"), exports);
-__exportStar(require("./collection.transfer.request"), exports);