privately-smartcontract-lib 1.2.0 → 1.2.1

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

@@ -3,7 +3,8 @@ export declare enum RequestType {
     AUCTION_BID = "AUCTION_BID",
     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

@@ -10,6 +10,7 @@ var RequestType;
     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/collection/collection.client.d.ts

@@ -4,6 +4,7 @@ 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";
@@ -82,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

@@ -11,6 +11,7 @@ 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");
 /** Default address for local Hardhat deployment */
 exports.DEFAULT_COLLECTION_ADDRESS = "0xe7f1725e7734ce288f8367e1bb143e90bb3f0512";
@@ -191,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.2.0",
+    "version": "1.2.1",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "scripts": {