privately-smartcontract-lib 1.1.1 → 1.2.1

package/dist/client.d.ts

@@ -1,6 +1,16 @@
 import { Block, Signer, TransactionResponse } from "ethers";
 import { PrivatelyAuctionSystemClient } from "./modules/auctions";
 import { PrivatelyCollectionClient } from "./modules/collection";
+/**
+ * Options for creating a PrivatelyClient instance.
+ * Use these to override default contract addresses (e.g., for testnet/mainnet).
+ */
+export interface PrivatelyClientOptions {
+    /** Override the collection contract address */
+    collectionAddress?: string;
+    /** Override the auction contract address */
+    auctionAddress?: string;
+}
 export declare class PrivatelyClient {
     readonly signer: Signer;
     readonly collection: PrivatelyCollectionClient;
@@ -9,9 +19,10 @@ export declare class PrivatelyClient {
     /**
      * Creates a new PrivatelyClient instance using the provided signer.
      * @param signer The signer to use for transactions.
+     * @param options Optional configuration for contract addresses.
      * @returns A new PrivatelyClient instance.
      */
-    static create(signer: Signer): Promise<PrivatelyClient>;
+    static create(signer: Signer, options?: PrivatelyClientOptions): Promise<PrivatelyClient>;
     /**
      * Fetches the latest block from the connected provider.
      * @returns The latest block.

package/dist/client.js

@@ -8,21 +8,22 @@ class PrivatelyClient {
     signer;
     collection;
     auctions;
-    constructor(signer, network) {
+    constructor(signer, network, options) {
         this.signer = signer;
-        this.collection = new collection_1.PrivatelyCollectionClient(signer, network);
-        this.auctions = new auctions_1.PrivatelyAuctionSystemClient(signer, network);
+        this.collection = new collection_1.PrivatelyCollectionClient(signer, network, options?.collectionAddress);
+        this.auctions = new auctions_1.PrivatelyAuctionSystemClient(signer, network, options?.auctionAddress);
     }
     /**
      * Creates a new PrivatelyClient instance using the provided signer.
      * @param signer The signer to use for transactions.
+     * @param options Optional configuration for contract addresses.
      * @returns A new PrivatelyClient instance.
      */
-    static async create(signer) {
+    static async create(signer, options) {
         if (!signer.provider)
             throw new Error("Signer must be connected to a provider.");
         const network = await signer.provider.getNetwork();
-        return new PrivatelyClient(signer, network);
+        return new PrivatelyClient(signer, network, options);
     }
     /**
      * Fetches the latest block from the connected provider.

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

@@ -1,11 +1,10 @@
 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"
+    COLLECTION_APPROVE = "COLLECTION_APPROVE",
+    COLLECTION_SET_TOKEN_URI = "COLLECTION_SET_TOKEN_URI"
 }
 export declare class RequestSignature<T> {
     readonly type: RequestType;

package/dist/common/request-signature.js

@@ -6,13 +6,11 @@ var 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["COLLECTION_SET_TOKEN_URI"] = "COLLECTION_SET_TOKEN_URI";
 })(RequestType || (exports.RequestType = RequestType = {}));
 class RequestSignature {
     type;

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

@@ -4,11 +4,14 @@ 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";
+/** Default address for local Hardhat deployment */
+export declare const DEFAULT_AUCTION_ADDRESS = "0x9fe46736679d2d9a65f0992f2272de9f3c7fa6e0";
 export declare class PrivatelyAuctionSystemClient {
     readonly contract: Contract;
+    readonly address: string;
     private readonly signer;
     private readonly domain;
-    constructor(signer: Signer, network: Network);
+    constructor(signer: Signer, network: Network, address?: string);
     /**
      * Retrieves the address of the current deployed contract.
      * @returns The contract address.

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

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PrivatelyAuctionSystemClient = void 0;
+exports.PrivatelyAuctionSystemClient = exports.DEFAULT_AUCTION_ADDRESS = void 0;
 const ethers_1 = require("ethers");
 const PrivatelyAuctionSystem_json_1 = __importDefault(require("../../../PrivatelyAuctionSystem.json"));
 const request_signature_1 = require("../../common/request-signature");
@@ -11,20 +11,23 @@ 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";
+/** Default address for local Hardhat deployment */
+exports.DEFAULT_AUCTION_ADDRESS = "0x9fe46736679d2d9a65f0992f2272de9f3c7fa6e0";
 class PrivatelyAuctionSystemClient {
     contract;
+    address;
     signer;
     domain;
-    constructor(signer, network) {
+    constructor(signer, network, address = exports.DEFAULT_AUCTION_ADDRESS) {
         this.signer = signer;
-        this.contract = new ethers_1.Contract(AUCTION_SYSTEM_ADDRESS, PrivatelyAuctionSystem_json_1.default.abi, signer);
+        this.address = address;
+        this.contract = new ethers_1.Contract(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
+            verifyingContract: address
         };
     }
     /**
@@ -32,7 +35,7 @@ class PrivatelyAuctionSystemClient {
      * @returns The contract address.
      */
     getContractAddress() {
-        return AUCTION_SYSTEM_ADDRESS;
+        return this.address;
     }
     /**
      * Creates and signs a CreateAuctionRequest using EIP-712 structured data.

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

@@ -4,12 +4,16 @@ import { CollectionApproveRequest } from "./collection.approve.request";
 import { OnMintListener, OnTransferListener } from "./collection.events";
 import { CollectionMintRequest } from "./collection.mint.request";
 import { PrivatelyNFT } from "./collection.nft";
+import { CollectionSetTokenURIRequest } from "./collection.settokenuri.request";
 import { CollectionTransferRequest } from "./collection.transfer.request";
+/** Default address for local Hardhat deployment */
+export declare const DEFAULT_COLLECTION_ADDRESS = "0xe7f1725e7734ce288f8367e1bb143e90bb3f0512";
 export declare class PrivatelyCollectionClient {
     readonly contract: Contract;
+    readonly address: string;
     private readonly signer;
     private readonly domain;
-    constructor(signer: Signer, network: Network);
+    constructor(signer: Signer, network: Network, address?: string);
     /**
      * Retrieves a list of all NFT token IDs currently stored in the contract.
      * @returns An array of token IDs as bigint.
@@ -79,6 +83,28 @@ export declare class PrivatelyCollectionClient {
      * @returns A TransactionResponse object from ethers.
      */
     relayApproveRequest(request: CollectionApproveRequest, signature: string): Promise<TransactionResponse>;
+    /**
+     * Creates a signed request to update the token URI for an NFT.
+     * This allows the owner to update the NFT's metadata URI via meta-transaction.
+     * @param tokenId The ID of the NFT to update.
+     * @param tokenURI The new metadata URI.
+     * @returns A RequestSignature containing the SetTokenURIRequest and signature.
+     */
+    createSetTokenURIRequest(tokenId: bigint, tokenURI: string): Promise<RequestSignature<CollectionSetTokenURIRequest>>;
+    /**
+     * Relays a signed setTokenURI request to the blockchain.
+     * The relayer (caller of this function) is responsible for the transaction's gas cost.
+     * @param request The SetTokenURIRequest object containing owner, tokenId, tokenURI, and nonce.
+     * @param signature The EIP-712 signature that authorizes this update.
+     * @returns A TransactionResponse object from ethers.
+     */
+    relaySetTokenURIRequest(request: CollectionSetTokenURIRequest, signature: string): Promise<TransactionResponse>;
+    /**
+     * Retrieves the token URI for a given NFT.
+     * @param tokenId The ID of the NFT.
+     * @returns The metadata URI string.
+     */
+    getTokenURI(tokenId: bigint): Promise<string>;
     /**
      * 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.

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

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PrivatelyCollectionClient = void 0;
+exports.PrivatelyCollectionClient = exports.DEFAULT_COLLECTION_ADDRESS = void 0;
 const ethers_1 = require("ethers");
 const PrivatelyCollection_json_1 = __importDefault(require("../../../PrivatelyCollection.json"));
 const request_signature_1 = require("../../common/request-signature");
@@ -11,21 +11,25 @@ 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_settokenuri_request_1 = require("./collection.settokenuri.request");
 const collection_transfer_request_1 = require("./collection.transfer.request");
-const COLLECTION_ADDRESS = "0xe7f1725e7734ce288f8367e1bb143e90bb3f0512";
+/** Default address for local Hardhat deployment */
+exports.DEFAULT_COLLECTION_ADDRESS = "0xe7f1725e7734ce288f8367e1bb143e90bb3f0512";
 class PrivatelyCollectionClient {
     contract;
+    address;
     signer;
     domain;
-    constructor(signer, network) {
+    constructor(signer, network, address = exports.DEFAULT_COLLECTION_ADDRESS) {
         this.signer = signer;
-        this.contract = new ethers_1.Contract(COLLECTION_ADDRESS, PrivatelyCollection_json_1.default.abi, signer);
+        this.address = address;
+        this.contract = new ethers_1.Contract(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
+            verifyingContract: address
         };
     }
     /**
@@ -188,6 +192,55 @@ class PrivatelyCollectionClient {
             throw collection_errors_1.CollectionError.from(error, this.contract);
         }
     }
+    /**
+     * Creates a signed request to update the token URI for an NFT.
+     * This allows the owner to update the NFT's metadata URI via meta-transaction.
+     * @param tokenId The ID of the NFT to update.
+     * @param tokenURI The new metadata URI.
+     * @returns A RequestSignature containing the SetTokenURIRequest and signature.
+     */
+    async createSetTokenURIRequest(tokenId, tokenURI) {
+        if (!tokenURI.trim())
+            throw new collection_errors_1.CollectionError("Token URI cannot be empty");
+        const owner = await this.signer.getAddress();
+        const nonce = (await this.getNonces()).mintNonce;
+        const request = {
+            owner,
+            tokenId,
+            tokenURI,
+            nonce
+        };
+        const signature = await this.signer.signTypedData(this.domain, collection_settokenuri_request_1.COLLECTION_SET_TOKEN_URI_REQUEST_TYPE, request);
+        return new request_signature_1.RequestSignature(request_signature_1.RequestType.COLLECTION_SET_TOKEN_URI, signature, request);
+    }
+    /**
+     * Relays a signed setTokenURI request to the blockchain.
+     * The relayer (caller of this function) is responsible for the transaction's gas cost.
+     * @param request The SetTokenURIRequest object containing owner, tokenId, tokenURI, and nonce.
+     * @param signature The EIP-712 signature that authorizes this update.
+     * @returns A TransactionResponse object from ethers.
+     */
+    async relaySetTokenURIRequest(request, signature) {
+        try {
+            return await this.contract.metaSetTokenURI(request, signature);
+        }
+        catch (error) {
+            throw collection_errors_1.CollectionError.from(error, this.contract);
+        }
+    }
+    /**
+     * Retrieves the token URI for a given NFT.
+     * @param tokenId The ID of the NFT.
+     * @returns The metadata URI string.
+     */
+    async getTokenURI(tokenId) {
+        try {
+            return await this.contract.tokenURI(tokenId);
+        }
+        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.

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

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

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

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

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

@@ -4,4 +4,5 @@ export * from "./collection.errors";
 export * from "./collection.mint.request";
 export * from "./collection.nft";
 export * from "./collection.nonces";
+export * from "./collection.settokenuri.request";
 export * from "./collection.transfer.request";

package/dist/modules/collection/index.js

@@ -20,4 +20,5 @@ __exportStar(require("./collection.errors"), exports);
 __exportStar(require("./collection.mint.request"), exports);
 __exportStar(require("./collection.nft"), exports);
 __exportStar(require("./collection.nonces"), exports);
+__exportStar(require("./collection.settokenuri.request"), exports);
 __exportStar(require("./collection.transfer.request"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "privately-smartcontract-lib",
-    "version": "1.1.1",
+    "version": "1.2.1",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "scripts": {