privately-smartcontract-lib 1.0.6 → 1.1.0

package/dist/client.d.ts

@@ -1,38 +0,0 @@
-import { Block, Signer, TransactionResponse } from "ethers";
-import { PrivatelyAuctionSystemClient } from "./modules/auctions";
-import { PrivatelyCoinClient } from "./modules/coin";
-import { PrivatelyCollectionClient } from "./modules/collection";
-export declare class PrivatelyClient {
-    readonly signer: Signer;
-    readonly coin: PrivatelyCoinClient;
-    readonly collection: PrivatelyCollectionClient;
-    readonly auctions: PrivatelyAuctionSystemClient;
-    private constructor();
-    /**
-     * Creates a new PrivatelyClient instance using the provided signer.
-     * @param signer The signer to use for transactions.
-     * @returns A new PrivatelyClient instance.
-     */
-    static create(signer: Signer): Promise<PrivatelyClient>;
-    /**
-     * Fetches the latest block from the connected provider.
-     * @returns The latest block.
-     */
-    getLastBlock(): Promise<Block>;
-    /**
-     * Fetches the timestamp of the latest block from the connected provider.
-     * @returns The timestamp of the latest block in seconds.
-     */
-    getLastBlockTimestamp(): Promise<number>;
-    /**
-     * Fetches the address (public key) of the connected signer.
-     * @returns The address of the signer.
-     */
-    getAddress(): Promise<string>;
-    /**
-     * Fetches a transaction by its hash.
-     * @param txHash The hash of the transaction to fetch.
-     * @returns The transaction if found, otherwise null.
-     */
-    getTransaction(txHash: string): Promise<TransactionResponse | null>;
-}

package/dist/client.js

@@ -1,67 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PrivatelyClient = void 0;
-const common_1 = require("./common");
-const auctions_1 = require("./modules/auctions");
-const coin_1 = require("./modules/coin");
-const collection_1 = require("./modules/collection");
-class PrivatelyClient {
-    signer;
-    coin;
-    collection;
-    auctions;
-    constructor(signer, network) {
-        this.signer = signer;
-        this.coin = new coin_1.PrivatelyCoinClient(signer, network);
-        this.collection = new collection_1.PrivatelyCollectionClient(signer, network);
-        this.auctions = new auctions_1.PrivatelyAuctionSystemClient(signer, network);
-    }
-    /**
-     * Creates a new PrivatelyClient instance using the provided signer.
-     * @param signer The signer to use for transactions.
-     * @returns A new PrivatelyClient instance.
-     */
-    static async create(signer) {
-        if (!signer.provider)
-            throw new Error("Signer must be connected to a provider.");
-        const network = await signer.provider.getNetwork();
-        return new PrivatelyClient(signer, network);
-    }
-    /**
-     * Fetches the latest block from the connected provider.
-     * @returns The latest block.
-     */
-    async getLastBlock() {
-        const provider = this.signer.provider;
-        if (!provider)
-            throw new common_1.PrivatelyError("Signer must be connected to a provider.");
-        const block = await provider.getBlock("latest");
-        if (!block)
-            throw new common_1.PrivatelyError("Failed to fetch the latest block.");
-        return block;
-    }
-    /**
-     * Fetches the timestamp of the latest block from the connected provider.
-     * @returns The timestamp of the latest block in seconds.
-     */
-    async getLastBlockTimestamp() {
-        const block = await this.getLastBlock();
-        return block.timestamp;
-    }
-    /**
-     * Fetches the address (public key) of the connected signer.
-     * @returns The address of the signer.
-     */
-    getAddress() {
-        return this.signer.getAddress();
-    }
-    /**
-     * Fetches a transaction by its hash.
-     * @param txHash The hash of the transaction to fetch.
-     * @returns The transaction if found, otherwise null.
-     */
-    async getTransaction(txHash) {
-        return (await this.signer.provider?.getTransaction(txHash)) ?? null;
-    }
-}
-exports.PrivatelyClient = PrivatelyClient;

package/dist/common/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./privately.error";
-export * from "./request-signature";

package/dist/common/index.js

@@ -1,18 +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("./privately.error"), exports);
-__exportStar(require("./request-signature"), exports);

package/dist/common/privately.error.d.ts

@@ -1,5 +0,0 @@
-import { Interface } from "ethers";
-export declare class PrivatelyError extends Error {
-    constructor(message: string);
-}
-export declare function parseContractError(error: unknown, contractInterface?: Interface): string;

package/dist/common/privately.error.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PrivatelyError = void 0;
-exports.parseContractError = parseContractError;
-class PrivatelyError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = "PrivatelyError";
-    }
-}
-exports.PrivatelyError = PrivatelyError;
-function parseContractError(error, contractInterface) {
-    const getNestedErrorData = (err) => {
-        if (typeof err?.data === "string")
-            return err.data;
-        if (err?.error)
-            return getNestedErrorData(err.error);
-        if (err?.data?.data)
-            return err.data.data;
-        return err?.data || err?.message || err;
-    };
-    try {
-        const errorData = getNestedErrorData(error);
-        if (errorData && contractInterface) {
-            const formattedData = typeof errorData === "string" && errorData.startsWith("0x")
-                ? errorData
-                : null;
-            if (formattedData) {
-                const parsed = contractInterface.parseError(formattedData);
-                if (parsed) {
-                    return `${parsed.name}${parsed.args.length ? `: ${parsed.args.join(", ")}` : ""}`;
-                }
-            }
-        }
-        const message = (error instanceof Error)
-            ? error.message
-            : JSON.stringify(error, Object.getOwnPropertyNames(error));
-        const match = message.match(/(?:"message":"|execution reverted:?)(.*?)(?:"|$)/);
-        return match?.[1] || message;
-    }
-    catch (parseError) {
-        return JSON.stringify({
-            originalError: error,
-            parseError
-        }, null, 2);
-    }
-}

package/dist/common/request-signature.d.ts

@@ -1,17 +0,0 @@
-export declare enum RequestType {
-    AUCTION_CREATE = "AUCTION_CREATE",
-    AUCTION_BID = "AUCTION_BID",
-    COIN_TRANSFER = "COIN_TRANSFER",
-    COIN_APPROVE = "COIN_APPROVE",
-    COLLECTION_MINT = "COLLECTION_MINT",
-    COLLECTION_TRANSFER = "COLLECTION_TRANSFER",
-    COLLECTION_APPROVE = "COLLECTION_APPROVE"
-}
-export declare class RequestSignature<T> {
-    readonly type: RequestType;
-    readonly signature: string;
-    readonly request: T;
-    constructor(type: RequestType, signature: string, request: T);
-    static deserialize<T>(json: string): RequestSignature<T>;
-    serialize(): string;
-}

package/dist/common/request-signature.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RequestSignature = exports.RequestType = void 0;
-var RequestType;
-(function (RequestType) {
-    // Auctions requests types
-    RequestType["AUCTION_CREATE"] = "AUCTION_CREATE";
-    RequestType["AUCTION_BID"] = "AUCTION_BID";
-    // Coin requests types
-    RequestType["COIN_TRANSFER"] = "COIN_TRANSFER";
-    RequestType["COIN_APPROVE"] = "COIN_APPROVE";
-    // Collection requests types
-    RequestType["COLLECTION_MINT"] = "COLLECTION_MINT";
-    RequestType["COLLECTION_TRANSFER"] = "COLLECTION_TRANSFER";
-    RequestType["COLLECTION_APPROVE"] = "COLLECTION_APPROVE";
-})(RequestType || (exports.RequestType = RequestType = {}));
-class RequestSignature {
-    type;
-    signature;
-    request;
-    constructor(type, signature, request) {
-        this.type = type;
-        this.signature = signature;
-        this.request = request;
-    }
-    static deserialize(json) {
-        const parsed = JSON.parse(json, (key, value) => {
-            if (typeof value === "string" && value.endsWith("n"))
-                return BigInt(value.slice(0, -1));
-            return value;
-        });
-        return new RequestSignature(parsed.type, parsed.signature, parsed.request);
-    }
-    serialize() {
-        return JSON.stringify(this, (key, value) => typeof value === "bigint" ? value.toString() + "n" : value);
-    }
-}
-exports.RequestSignature = RequestSignature;

package/dist/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./client";
-export * from "./common";
-export * from "./modules/coin";
-export * from "./modules/collection";
-export * from "./modules/auctions";

package/dist/index.js

@@ -1,21 +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("./client"), exports);
-__exportStar(require("./common"), exports);
-__exportStar(require("./modules/coin"), exports);
-__exportStar(require("./modules/collection"), exports);
-__exportStar(require("./modules/auctions"), exports);

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

@@ -1,12 +0,0 @@
-export declare class Auction {
-    id: bigint;
-    seller: string;
-    tokenId: bigint;
-    startPrice: bigint;
-    highestBid: bigint;
-    highestBidder: string;
-    endTime: bigint;
-    settled: boolean;
-    constructor(id: bigint, seller: string, tokenId: bigint, startPrice: bigint, highestBid: bigint, highestBidder: string, endTime: bigint, settled: boolean);
-    static map(list: bigint[], client: any): Promise<Auction[]>;
-}

package/dist/modules/auctions/auctions.auction.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Auction = void 0;
-class Auction {
-    id; // Auction ID
-    seller; // Seller's address
-    tokenId; // Token ID being auctioned
-    startPrice; // Starting price of the auction
-    highestBid; // Highest bid placed in the auction
-    highestBidder; // Address of the highest bidder
-    endTime; // End time of the auction (timestamp)
-    settled; // Indicates if the auction has been settled
-    constructor(id, seller, tokenId, startPrice, highestBid, highestBidder, endTime, settled) {
-        this.id = id;
-        this.seller = seller;
-        this.tokenId = tokenId;
-        this.startPrice = startPrice;
-        this.highestBid = highestBid;
-        this.highestBidder = highestBidder;
-        this.endTime = endTime;
-        this.settled = settled;
-    }
-    static async map(list, client) {
-        return await Promise.all(list.map(async (id) => {
-            return await client.getAuction(id);
-        }));
-    }
-}
-exports.Auction = Auction;

package/dist/modules/auctions/auctions.bid.reqest.d.ts

@@ -1,12 +0,0 @@
-export interface BidAuctionRequest {
-    bidder: string;
-    auctionId: bigint;
-    bidAmount: bigint;
-    nonce: bigint;
-}
-export declare const AUCTIONS_BID_REQUEST_TYPE: {
-    BidRequest: {
-        name: string;
-        type: string;
-    }[];
-};

package/dist/modules/auctions/auctions.bid.reqest.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AUCTIONS_BID_REQUEST_TYPE = void 0;
-exports.AUCTIONS_BID_REQUEST_TYPE = {
-    BidRequest: [
-        { name: "bidder", type: "address" },
-        { name: "auctionId", type: "uint256" },
-        { name: "bidAmount", type: "uint256" },
-        { name: "nonce", type: "uint256" }
-    ]
-};

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

@@ -1,147 +0,0 @@
-import { Contract, Network, Signer, TransactionResponse } from "ethers";
-import { RequestSignature } from "../../common/request-signature";
-import { Auction } from "./auctions.auction";
-import { BidAuctionRequest } from "./auctions.bid.reqest";
-import { CreateAuctionRequest } from "./auctions.create.request";
-import { OnBidListener, OnCreateListener, OnEnd, OnWithdrawListener } from "./auctions.events";
-export declare class PrivatelyAuctionSystemClient {
-    readonly contract: Contract;
-    private readonly signer;
-    private readonly domain;
-    constructor(signer: Signer, network: Network);
-    /**
-     * Retrieves the address of the current deployed contract.
-     * @returns The contract address.
-     */
-    getContractAddress(): string;
-    /**
-     * 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.
-     */
-    createAuctionRequest(tokenId: bigint, startPrice: bigint, endTime: bigint): Promise<RequestSignature<CreateAuctionRequest>>;
-    /**
-     * 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.
-     */
-    relayCreateAuctionRequest(request: CreateAuctionRequest, signature: string): Promise<TransactionResponse>;
-    /**
-     * 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.
-     */
-    createBidRequest(auctionId: bigint, bidAmount: bigint): Promise<RequestSignature<BidAuctionRequest>>;
-    /**
-     * 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.
-     */
-    relayBidRequest(request: BidAuctionRequest, signature: string): Promise<TransactionResponse>;
-    /**
-     * Finalizes an auction once the endTime is reached. Anyone can call this.
-     * @param auctionId The ID of the auction to finalize.
-     * @returns A TransactionResponse.
-     */
-    finalizeAuction(auctionId: bigint): Promise<TransactionResponse>;
-    /**
-     * Allows users to withdraw their pending refunds from previous unsuccessful bids.
-     * @returns A TransactionResponse.
-     */
-    withdraw(): Promise<TransactionResponse>;
-    /**
-     * Retrieves all auction IDs created in the contract.
-     * @returns An array of auction IDs.
-     */
-    getAllAuctions(): Promise<bigint[]>;
-    /**
-     * Retrieves all active auction IDs in the contract.
-     * @returns An array of Auction objects representing active auctions.
-     */
-    getAllActiveAuctions(): Promise<Auction[]>;
-    /**
-     * 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.
-     */
-    getSellerAuctions(seller: string): Promise<Auction[]>;
-    /**
-     * Retrieves all auction IDs created by the client's signer address.
-     * @returns An array of Auction objects.
-     */
-    getAuctions(): Promise<Auction[]>;
-    /**
-     * Retrieves the auction details for a specific auction ID.
-     * @param auctionId The ID of the auction to fetch.
-     * @returns An Auction object.
-     */
-    getAuction(auctionId: bigint): Promise<Auction>;
-    /**
-     * 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: OnCreateListener): void;
-    /**
-     * 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: OnBidListener): void;
-    /**
-     * 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: OnEnd): void;
-    /**
-     * 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: OnWithdrawListener): void;
-    /**
-     * 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.
-     */
-    getAuctionsByToken(tokenId: bigint): Promise<Auction[]>;
-    /**
-     * 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.
-     */
-    private getNonces;
-    /**
-     * 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.
-     */
-    getUserBidAuctions(userAddress: string): Promise<Auction[]>;
-    /**
-     * 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.
-     */
-    getUserActiveBidAuctions(userAddress: string): Promise<Auction[]>;
-    /**
-     * Retrieves all auctions where the current signer has placed at least one bid.
-     * @returns An array of Auction objects where the signer has bid.
-     */
-    getBidAuctions(): Promise<Auction[]>;
-    /**
-     * 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.
-     */
-    getActiveBidAuctions(): Promise<Auction[]>;
-    /**
-     * Retrieves all expired but unfinalized auction IDs in the contract.
-     * @returns An array of expired auction objects that need to be finalized.
-     */
-    getAllExpiredUnfinalizedAuctions(): Promise<Auction[]>;
-}