privately-smartcontract-lib 1.1.0 → 1.1.1

package/dist/modules/auctions/auctions.client.js

@@ -0,0 +1,312 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PrivatelyAuctionSystemClient = void 0;
+const ethers_1 = require("ethers");
+const PrivatelyAuctionSystem_json_1 = __importDefault(require("../../../PrivatelyAuctionSystem.json"));
+const request_signature_1 = require("../../common/request-signature");
+const auctions_auction_1 = require("./auctions.auction");
+const auctions_bid_reqest_1 = require("./auctions.bid.reqest");
+const auctions_create_request_1 = require("./auctions.create.request");
+const auctions_errors_1 = require("./auctions.errors");
+const AUCTION_SYSTEM_ADDRESS = "0x9fe46736679d2d9a65f0992f2272de9f3c7fa6e0";
+class PrivatelyAuctionSystemClient {
+    contract;
+    signer;
+    domain;
+    constructor(signer, network) {
+        this.signer = signer;
+        this.contract = new ethers_1.Contract(AUCTION_SYSTEM_ADDRESS, PrivatelyAuctionSystem_json_1.default.abi, signer);
+        const name = PrivatelyAuctionSystem_json_1.default.contractName;
+        this.domain = {
+            name,
+            version: "1.0.0",
+            chainId: network.chainId,
+            verifyingContract: AUCTION_SYSTEM_ADDRESS
+        };
+    }
+    /**
+     * Retrieves the address of the current deployed contract.
+     * @returns The contract address.
+     */
+    getContractAddress() {
+        return AUCTION_SYSTEM_ADDRESS;
+    }
+    /**
+     * Creates and signs a CreateAuctionRequest using EIP-712 structured data.
+     * The request can later be relayed to the contract via `relayCreateAuction`.
+     * @param tokenId The ID of the NFT being auctioned.
+     * @param startPrice The auction's starting price in wei.
+     * @param endTime The timestamp at which the auction ends.
+     * @returns An object containing the request struct and its signature.
+     */
+    async createAuctionRequest(tokenId, startPrice, endTime) {
+        const seller = await this.signer.getAddress();
+        const nonce = (await this.getNonces(seller)).createAuctionNonce;
+        const request = {
+            seller,
+            tokenId,
+            startPrice,
+            endTime,
+            nonce
+        };
+        const signature = await this.signer.signTypedData(this.domain, auctions_create_request_1.AUCTIONS_CREATE_REQUEST_TYPE, request);
+        return new request_signature_1.RequestSignature(request_signature_1.RequestType.AUCTION_CREATE, signature, request);
+    }
+    /**
+     * Relays a signed CreateAuctionRequest on-chain. The relayer pays gas.
+     * @param request The CreateAuctionRequest struct.
+     * @param signature The EIP-712 signature that authorizes creating the auction.
+     * @returns A TransactionResponse from ethers.
+     */
+    async relayCreateAuctionRequest(request, signature) {
+        try {
+            return await this.contract.metaCreateAuction(request.seller, request.tokenId, request.startPrice, request.endTime, signature);
+        }
+        catch (error) {
+            throw auctions_errors_1.AuctionSystemError.from(error, this.contract);
+        }
+    }
+    /**
+     * Creates and signs a BidRequest using EIP-712 structured data.
+     * The request can later be relayed to the contract via `relayBid`.
+     * @param auctionId The ID of the auction the bidder is bidding on.
+     * @param bidAmount The amount in wei the bidder is offering.
+     * @returns An object containing the bid request struct and its signature.
+     */
+    async createBidRequest(auctionId, bidAmount) {
+        const bidder = await this.signer.getAddress();
+        const nonce = (await this.getNonces(bidder)).bidNonce;
+        const request = {
+            bidder,
+            auctionId,
+            bidAmount,
+            nonce
+        };
+        const signature = await this.signer.signTypedData(this.domain, auctions_bid_reqest_1.AUCTIONS_BID_REQUEST_TYPE, request);
+        return new request_signature_1.RequestSignature(request_signature_1.RequestType.AUCTION_BID, signature, request);
+    }
+    /**
+     * Relays a signed bid request (BidRequest) on-chain. The relayer pays gas.
+     * IMPORTANT: The relayer must include `bidAmount` in `msg.value` when sending the transaction.
+     * @param request The BidRequest struct.
+     * @param signature The EIP-712 signature that authorizes the bid.
+     * @returns A TransactionResponse from ethers.
+     */
+    async relayBidRequest(request, signature) {
+        try {
+            return await this.contract.metaBidAuction(request.bidder, request.auctionId, request.bidAmount, signature);
+        }
+        catch (error) {
+            throw auctions_errors_1.AuctionSystemError.from(error, this.contract);
+        }
+    }
+    /**
+     * Finalizes an auction once the endTime is reached. Anyone can call this.
+     * @param auctionId The ID of the auction to finalize.
+     * @returns A TransactionResponse.
+     */
+    async finalizeAuction(auctionId) {
+        try {
+            return await this.contract.finalizeAuction(auctionId);
+        }
+        catch (error) {
+            throw auctions_errors_1.AuctionSystemError.from(error, this.contract);
+        }
+    }
+    /**
+     * Allows users to withdraw their pending refunds from previous unsuccessful bids.
+     * @returns A TransactionResponse.
+     */
+    async withdraw() {
+        try {
+            return await this.contract.withdraw();
+        }
+        catch (error) {
+            throw auctions_errors_1.AuctionSystemError.from(error, this.contract);
+        }
+    }
+    /**
+     * Retrieves all auction IDs created in the contract.
+     * @returns An array of auction IDs.
+     */
+    async getAllAuctions() {
+        try {
+            return await this.contract.getAllAuctions();
+        }
+        catch (error) {
+            throw auctions_errors_1.AuctionSystemError.from(error, this.contract);
+        }
+    }
+    /**
+     * Retrieves all active auction IDs in the contract.
+     * @returns An array of Auction objects representing active auctions.
+     */
+    async getAllActiveAuctions() {
+        try {
+            const auctionList = await this.contract.getAllActiveAuctions();
+            return await auctions_auction_1.Auction.map(auctionList, this);
+        }
+        catch (error) {
+            throw auctions_errors_1.AuctionSystemError.from(error, this.contract);
+        }
+    }
+    /**
+     * Retrieves all auction IDs created by a specific seller.
+     * @param seller The address of the seller to fetch auctions for.
+     * @returns An array of Auction objects.
+     */
+    async getSellerAuctions(seller) {
+        try {
+            const auctionList = await this.contract.getSellerAuctions(seller);
+            return await auctions_auction_1.Auction.map(auctionList, this);
+        }
+        catch (error) {
+            throw auctions_errors_1.AuctionSystemError.from(error, this.contract);
+        }
+    }
+    /**
+     * Retrieves all auction IDs created by the client's signer address.
+     * @returns An array of Auction objects.
+     */
+    async getAuctions() {
+        return this.getSellerAuctions(await this.signer.getAddress());
+    }
+    /**
+     * Retrieves the auction details for a specific auction ID.
+     * @param auctionId The ID of the auction to fetch.
+     * @returns An Auction object.
+     */
+    async getAuction(auctionId) {
+        try {
+            const auction = await this.contract.getAuction(auctionId);
+            return new auctions_auction_1.Auction(auctionId, auction.seller, auction.tokenId, auction.startPrice, auction.highestBid, auction.highestBidder, auction.endTime, auction.settled);
+        }
+        catch (error) {
+            throw auctions_errors_1.AuctionSystemError.from(error, this.contract);
+        }
+    }
+    /**
+     * Registers a listener for the "OnCreate" event emitted by the contract when an auction is created.
+     * @param listener  A callback function to be executed when the "OnCreate" event is triggered.
+     */
+    onCreateEvent(listener) {
+        void this.contract.on("OnCreate", (auctionId, seller, tokenId, startPrice, endTime, event) => {
+            listener(auctionId, seller, tokenId, startPrice, endTime, event);
+        });
+    }
+    /**
+     * Registers a listener for the "OnBid" event emitted by the contract when a bid is placed.
+     * @param listener A callback function to be executed when the "OnBid" event is triggered.
+     */
+    onBidEvent(listener) {
+        void this.contract.on("OnBid", (auctionId, bidder, bidAmount, event) => {
+            listener(auctionId, bidder, bidAmount, event);
+        });
+    }
+    /**
+     * Registers a listener for the "OnEnd" event emitted by the contract when an auction ends.
+     * @param listener A callback function to be executed when the "OnEnd" event is triggered.
+     */
+    onEndEvent(listener) {
+        void this.contract.on("OnEnd", (auctionId, tokenId, highestBidder, highestBid, event) => {
+            listener(auctionId, tokenId, highestBidder, highestBid, event);
+        });
+    }
+    /**
+     * Registers a listener for the "OnWithdraw" event emitted by the contract when a user withdraws funds.
+     * @param listener A callback function to be executed when the "OnWithdraw" event is triggered.
+     */
+    onWithdrawEvent(listener) {
+        void this.contract.on("OnWithdraw", (user, amount, event) => {
+            listener(user, amount, event);
+        });
+    }
+    /**
+     * Retrieves all auctions (settled or not) for a given tokenId,
+     * and maps them into Auction instances via Auction.map().
+     * @param tokenId The NFT identifier.
+     * @returns A list of Auction objects.
+     */
+    async getAuctionsByToken(tokenId) {
+        try {
+            const rawList = await this.contract.getAuctionsByToken(tokenId);
+            return rawList.map(raw => new auctions_auction_1.Auction(raw[1], raw[0], tokenId, raw[2], raw[3], raw[4], raw[5], raw[6]));
+        }
+        catch (error) {
+            throw auctions_errors_1.AuctionSystemError.from(error, this.contract);
+        }
+    }
+    /**
+     * Fetches the current nonces for a user.
+     * @param userAddress The address of the user to fetch the nonce for.
+     * @returns An object containing the nonces.
+     */
+    async getNonces(userAddress) {
+        try {
+            const nonce = await this.contract.getNonces(userAddress);
+            return { createAuctionNonce: nonce.createAuctionNonce, bidNonce: nonce.bidNonce };
+        }
+        catch (error) {
+            throw auctions_errors_1.AuctionSystemError.from(error, this.contract);
+        }
+    }
+    /**
+     * Retrieves all auctions where the user has placed at least one bid.
+     * @param userAddress The address of the user to fetch auctions for.
+     * @returns An array of Auction objects where the user has bid.
+     */
+    async getUserBidAuctions(userAddress) {
+        try {
+            const auctionIds = await this.contract.getUserBidAuctions(userAddress);
+            return await auctions_auction_1.Auction.map(auctionIds, this);
+        }
+        catch (error) {
+            throw auctions_errors_1.AuctionSystemError.from(error, this.contract);
+        }
+    }
+    /**
+     * Retrieves all active auctions where the user has placed at least one bid.
+     * @param userAddress The address of the user to fetch active auctions for.
+     * @returns An array of active Auction objects where the user has bid.
+     */
+    async getUserActiveBidAuctions(userAddress) {
+        try {
+            const auctionIds = await this.contract.getUserActiveBidAuctions(userAddress);
+            return await auctions_auction_1.Auction.map(auctionIds, this);
+        }
+        catch (error) {
+            throw auctions_errors_1.AuctionSystemError.from(error, this.contract);
+        }
+    }
+    /**
+     * Retrieves all auctions where the current signer has placed at least one bid.
+     * @returns An array of Auction objects where the signer has bid.
+     */
+    async getBidAuctions() {
+        return this.getUserBidAuctions(await this.signer.getAddress());
+    }
+    /**
+     * Retrieves all active auctions where the current signer has placed at least one bid.
+     * @returns An array of active Auction objects where the signer has bid.
+     */
+    async getActiveBidAuctions() {
+        return this.getUserActiveBidAuctions(await this.signer.getAddress());
+    }
+    /**
+     * Retrieves all expired but unfinalized auction IDs in the contract.
+     * @returns An array of expired auction objects that need to be finalized.
+     */
+    async getAllExpiredUnfinalizedAuctions() {
+        try {
+            const auctionList = await this.contract.getAllExpiredUnfinalizedAuctions();
+            return await auctions_auction_1.Auction.map(auctionList, this);
+        }
+        catch (error) {
+            throw auctions_errors_1.AuctionSystemError.from(error, this.contract);
+        }
+    }
+}
+exports.PrivatelyAuctionSystemClient = PrivatelyAuctionSystemClient;

package/dist/modules/auctions/auctions.create.request.d.ts

@@ -0,0 +1,13 @@
+export interface CreateAuctionRequest {
+    seller: string;
+    tokenId: bigint;
+    startPrice: bigint;
+    endTime: bigint;
+    nonce: bigint;
+}
+export declare const AUCTIONS_CREATE_REQUEST_TYPE: {
+    CreateAuctionRequest: {
+        name: string;
+        type: string;
+    }[];
+};

package/dist/modules/auctions/auctions.create.request.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AUCTIONS_CREATE_REQUEST_TYPE = void 0;
+exports.AUCTIONS_CREATE_REQUEST_TYPE = {
+    CreateAuctionRequest: [
+        { name: "seller", type: "address" },
+        { name: "tokenId", type: "uint256" },
+        { name: "startPrice", type: "uint256" },
+        { name: "endTime", type: "uint256" },
+        { name: "nonce", type: "uint256" }
+    ]
+};

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

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

package/dist/modules/auctions/auctions.errors.js

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

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

@@ -0,0 +1,5 @@
+import { Log } from "ethers/lib.esm";
+export type OnCreateListener = (auctionId: bigint, seller: string, tokenId: bigint, startPrice: bigint, endTime: bigint, event: Log) => void;
+export type OnBidListener = (auctionId: bigint, bidder: string, bidAmount: bigint, event: Log) => void;
+export type OnEnd = (auctionId: bigint, tokenId: bigint, highestBidder: string, highestBid: bigint, event: Log) => void;
+export type OnWithdrawListener = (user: string, amount: bigint, event: Log) => void;

package/dist/modules/auctions/auctions.events.js

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

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

@@ -0,0 +1,4 @@
+export interface AuctionsNonces {
+    createAuctionNonce: bigint;
+    bidNonce: bigint;
+}

package/dist/modules/auctions/auctions.nonces.js

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

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

@@ -0,0 +1,6 @@
+export * from "./auctions.auction";
+export * from "./auctions.bid.reqest";
+export * from "./auctions.client";
+export * from "./auctions.create.request";
+export * from "./auctions.errors";
+export * from "./auctions.nonces";

package/dist/modules/auctions/index.js

@@ -0,0 +1,22 @@
+"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("./auctions.auction"), exports);
+__exportStar(require("./auctions.bid.reqest"), exports);
+__exportStar(require("./auctions.client"), exports);
+__exportStar(require("./auctions.create.request"), exports);
+__exportStar(require("./auctions.errors"), exports);
+__exportStar(require("./auctions.nonces"), exports);

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

@@ -0,0 +1,8 @@
+import { TypedDataField } from "ethers";
+export interface CollectionApproveRequest {
+    owner: string;
+    spender: string;
+    tokenId: bigint;
+    nonce: bigint;
+}
+export declare const COLLECTION_APPROVE_REQUEST_TYPE: Record<string, TypedDataField[]>;

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

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

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

@@ -0,0 +1,97 @@
+import { Contract, Network, Signer, TransactionResponse } from "ethers";
+import { RequestSignature } from "../../common/request-signature";
+import { CollectionApproveRequest } from "./collection.approve.request";
+import { OnMintListener, OnTransferListener } from "./collection.events";
+import { CollectionMintRequest } from "./collection.mint.request";
+import { PrivatelyNFT } from "./collection.nft";
+import { CollectionTransferRequest } from "./collection.transfer.request";
+export declare class PrivatelyCollectionClient {
+    readonly contract: Contract;
+    private readonly signer;
+    private readonly domain;
+    constructor(signer: Signer, network: Network);
+    /**
+     * Retrieves a list of all NFT token IDs currently stored in the contract.
+     * @returns An array of token IDs as bigint.
+     */
+    getSupplyCollection(): Promise<bigint[]>;
+    /**
+     * 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.
+     */
+    getUserCollection(owner: string): Promise<PrivatelyNFT[]>;
+    /**
+     * Retrieves the list of NFT token IDs owned by the client's signer address.
+     * @returns An array of token IDs as bigint.
+     */
+    getCollection(): Promise<PrivatelyNFT[]>;
+    /**
+     * 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.
+     */
+    getData(tokenId: bigint): Promise<PrivatelyNFT>;
+    /**
+     * 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.
+     */
+    createMintRequest(title: string, tokenURI: string): Promise<RequestSignature<CollectionMintRequest>>;
+    /**
+     * 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.
+     */
+    relayMintRequest(request: CollectionMintRequest, signature: string): Promise<TransactionResponse>;
+    /**
+     * 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.
+     */
+    createTransferRequest(to: string, tokenId: bigint): Promise<RequestSignature<CollectionTransferRequest>>;
+    /**
+     * 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.
+     */
+    relayTransferRequest(request: CollectionTransferRequest, signature: string): Promise<TransactionResponse>;
+    /**
+     * 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.
+     */
+    createApproveRequest(spender: string, tokenId: bigint): Promise<RequestSignature<CollectionApproveRequest>>;
+    /**
+     * 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.
+     */
+    relayApproveRequest(request: CollectionApproveRequest, signature: string): Promise<TransactionResponse>;
+    /**
+     * 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: OnMintListener): void;
+    /**
+     * 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: OnTransferListener): void;
+    /**
+     * Retrieves current nonce for meta-transactions
+     * @returns Current nonce for signer's address
+     */
+    private getNonces;
+}