add asset uploader readme

examples/typescript/asset_uploader.ts

@@ -1,39 +1,89 @@
 /* eslint-disable no-console */
 import { Account, AptosConfig, Network, Aptos, AssetUploader } from "@aptos-labs/ts-sdk";
+import * as fs from 'fs';
 
 const example = async () => {
-  const account = Account.generate();
-  const aptosConfig = new AptosConfig({
-    network: Network.TESTNET,
-  });
-  const aptos = new Aptos(aptosConfig);
-
-  const assetUploader = await AssetUploader.init(aptosConfig);
-
-  await aptos.fundAccount({ accountAddress: account.accountAddress, amount: 1_000_000 });
-
-  // Fund a node
-  const fundResponse = await assetUploader.fundNode({ account, amount: 1000 });
-  console.log("fund response", fundResponse);
-
-  // Upload data
-  const uploadDataResponse = await assetUploader.uploadData({ account, data: "Hello Aptos" });
-  console.log("upload response", uploadDataResponse);
-
-  // Upload file
-  const uploadFileResponse = await assetUploader.uploadFile({
-    account,
-    file: "/Users/maayansavir/Desktop/pfp.jpeg",
-  });
-  console.log("uploadFileResponse", uploadFileResponse);
-
-  // Upload folder
-  const uploadFolderResponse = await assetUploader.uploadFolder({
-    account,
-    folder: "/Users/maayansavir/Desktop/test-apps/web-app",
-  });
-  console.log("uploadFolderResponse", uploadFolderResponse);
-  process.exit(0);
+    const updateImageField = (jsonFilePath: string, imageUrl: string) => {
+        const metadataContent = fs.readFileSync(jsonFilePath, 'utf8');
+        let metadataJson = JSON.parse(metadataContent);
+        metadataJson.image = imageUrl;
+        fs.writeFileSync(jsonFilePath, JSON.stringify(metadataJson, null, 4));
+        return metadataJson;
+    };
+
+    // Function to recursively update the image fields in all JSON files in a folder synchronously
+    const updateImageFieldsInFolder = (folderPath: string, mediaFolderUrl: string) => {
+        const files = fs.readdirSync(folderPath);
+        for (const file of files) {
+            const filePath = `${folderPath}/${file}`;
+            if (filePath.endsWith('.json')) {
+                updateImageField(filePath, `${mediaFolderUrl}/${file.replace('.json', '.png')}`);
+            }
+        }
+    };
+
+    const account = Account.generate();
+    const aptosConfig = new AptosConfig({
+        network: Network.TESTNET,
+    });
+    const aptos = new Aptos(aptosConfig);
+
+    const assetUploader = await AssetUploader.init(aptosConfig);
+
+    await aptos.fundAccount({ accountAddress: account.accountAddress, amount: 1_000_000 });
+
+    // Fund a node
+    const fundResponse = await assetUploader.fundNode({ account, amount: 1000000 });
+    console.log("fund response", fundResponse);
+
+    // Upload collection media
+    const collectionMediaPath = "/collection_media_file_path"; // Update this path
+    const uploadFileResponse = await assetUploader.uploadFile({
+        account,
+        file: collectionMediaPath,
+    });
+    let collection_media_manifest_id = uploadFileResponse.id;
+    let collection_media_url = `https://arweave.net/${collection_media_manifest_id}`;
+    console.log("Collection Media URL:", collection_media_url);
+
+    // Update collection metadata JSON file
+    const collectionMetadataJsonPath = "/collection_metadata_json_file_path"; // Update this path
+    updateImageField(collectionMetadataJsonPath, collection_media_url);
+
+    // Upload updated collection metadata json
+    const uploadJsonResponse = await assetUploader.uploadFile({
+        account,
+        file: collectionMetadataJsonPath,
+    });
+    let collection_metadata_json_manifest_id = uploadJsonResponse.id;
+    let collection_metadata_json_url = `https://arweave.net/${collection_metadata_json_manifest_id}`;
+    console.log("Collection metadata json URL:", collection_metadata_json_url);
+
+    // Upload token media folder
+    const tokenMediaFolderPath = "/token_media_folder_path"; // Update this path
+    const uploadFolderResponse = await assetUploader.uploadFolder({
+        account,
+        folder: tokenMediaFolderPath,
+    });
+    let token_media_folder_manifest_id = uploadFolderResponse!.id;
+    let token_media_folder_url = `https://arweave.net/${token_media_folder_manifest_id}`;
+    console.log("Token media URL folder:", token_media_folder_url);
+
+
+    // Update token metadata JSON files with token media URL
+    const tokenMetadataJsonFolderPath = "/token_metadata_json_folder_path"; // Update this path
+    updateImageFieldsInFolder(tokenMetadataJsonFolderPath, token_media_folder_url);
+
+    // Upload the updated token metadata json folder
+    const uploadMetadataFolderResponse = await assetUploader.uploadFolder({
+        account,
+        folder: tokenMetadataJsonFolderPath,
+    });
+    let token_metadata_json_folder_manifest_id = uploadMetadataFolderResponse!.id;
+    let token_metadata_json_folder_url = `https://arweave.net/${token_metadata_json_folder_manifest_id}`;
+    console.log("Token metadata json URL folder:", token_metadata_json_folder_url);
+
+    // DONE
 };
 
 example();

src/plugins/assetUploader/README.md

@@ -0,0 +1,149 @@
+# NFT Asset Uploader Guide
+
+## Pre-requisite
+
+Before you begin, make sure you have the following:
+
+1. SDK version:
+   Ensure you have version 1.9.1-tmp.0 of `@aptos-labs/ts-sdk`.
+   [SDK Package](https://www.npmjs.com/package/@aptos-labs/ts-sdk/v/1.9.1-tmp.0?activeTab=versions)
+
+2. Install the SDK with `pnpm`:
+   ```bash
+   pnpm install @aptos-labs/ts-sdk@1.9.1-tmp.0
+   ```
+
+3. Install the Irys SDK with `npm`:
+   ```bash
+   npm install @irys/sdk
+   ```
+
+4. Prepare your NFT media and metadata files:
+   Begin with the metadata template and replace the content as necessary.
+   ```json
+   {
+       "name": "Asset Name",
+       "description": "Lorem ipsum...",
+       "image": "",
+       "properties": {
+           "simple_property": "example value"
+       }
+   }
+   ```
+   Supported media types include: `png`, `jpg`, `jpeg`, `gif`, etc.
+
+   Ensure that the file name in the metadata corresponds to the media file name.
+
+   Each metadata file and corresponding NFT media should be unique.
+
+
+## How to Use
+
+Below is a sample TypeScript script that demonstrates how to use the uploader:
+
+```ts
+const example = async () => {
+    const account = Account.generate();
+    const aptosConfig = new AptosConfig({
+        // irys can only handle either testnet or mainnet
+        network: Network.TESTNET,
+    });
+    const aptos = new Aptos(aptosConfig);
+
+    const assetUploader = await AssetUploader.init(aptosConfig);
+
+    await aptos.fundAccount({ accountAddress: account.accountAddress, amount: 1_000_000 });
+
+    // Fund a node
+    const fundResponse = await assetUploader.fundNode({ account, amount: 1000000 });
+    console.log("fund response", fundResponse);
+
+    // Upload collection media
+    const collectionMediaPath = "/collection_media_file_path"; // Update this path
+    const uploadFileResponse = await assetUploader.uploadFile({
+        account,
+        file: collectionMediaPath,
+    });
+    let collection_media_manifest_id = uploadFileResponse.id;
+    let collection_media_url = `https://arweave.net/${collection_media_manifest_id}`;
+    console.log("Collection Media URL:", collection_media_url);
+
+    // Update collection metadata JSON file
+    const collectionMetadataJsonPath = "/collection_metadata_json_file_path"; // Update this path
+    await updateImageField(collectionMetadataJsonPath, collection_media_url);
+
+    // Upload updated collection metadata json
+    const uploadJsonResponse = await assetUploader.uploadFile({
+        account,
+        file: collectionMetadataJsonPath,
+    });
+    let collection_metadata_json_manifest_id = uploadJsonResponse.id;
+    let collection_metadata_json_url = `https://arweave.net/${collection_metadata_json_manifest_id}`;
+    console.log("Collection metadata json URL:", collection_metadata_json_url);
+
+    // Upload token media folder
+    const tokenMediaFolderPath = "/token_media_folder_path"; // Update this path
+    const uploadFolderResponse = await assetUploader.uploadFolder({
+        account,
+        folder: tokenMediaFolderPath,
+    });
+    let token_media_folder_manifest_id = uploadFolderResponse.id;
+    let token_media_folder_url = `https://arweave.net/${token_media_folder_manifest_id}`;
+    console.log("Token media URL folder:", token_media_folder_url);
+
+
+    // Update token metadata JSON files with token media URL
+    const tokenMetadataJsonFolderPath = "/token_metadata_json_folder_path"; // Update this path
+    await updateImageFieldsInFolder(tokenMetadataJsonFolderPath, token_media_folder_url);
+
+    // Upload the updated token metadata json folder
+    const uploadMetadataFolderResponse = await assetUploader.uploadFolder({
+        account,
+        folder: tokenMetadataJsonFolderPath,
+    });
+    let token_metadata_json_folder_manifest_id = uploadMetadataFolderResponse.id;
+    let token_metadata_json_folder_url = `https://arweave.net/${token_metadata_json_folder_manifest_id}`;
+    console.log("Token metadata json URL folder:", token_metadata_json_folder_url);
+
+    // DONE
+
+    // ================================= Helper  ================================= //
+
+    // Function to update the image field in JSON metadata
+    const updateImageField = async (jsonFilePath: string, imageUrl: string) => {
+        const metadataContent = await fsPromises.readFile(jsonFilePath, 'utf8');
+        const metadataJson = JSON.parse(metadataContent);
+        metadataJson.image = imageUrl;
+        await fsPromises.writeFile(jsonFilePath, JSON.stringify(metadataJson, null, 4));
+        return metadataJson;
+    };
+
+    // Function to recursively update the image fields in all JSON files in a folder
+    const updateImageFieldsInFolder = async (folderPath: string, mediaFolderUrl: string) => {
+    const files = await fsPromises.readdir(folderPath);
+    for (const file of files) {
+        const filePath = `${folderPath}/${file}`;
+        if (filePath.endsWith('.json')) {
+            await updateImageField(filePath, `${mediaFolderUrl}/${file.replace('.json', '.png')}`);
+        }
+    };
+};
+
+
+example();
+```
+
+To use the provided example code, follow these steps:
+1. Replace the placeholders with the correct paths to your files.
+2. Run the script in a TypeScript-supported environment.
+3. Check the console logs to confirm the media and metadata have been uploaded successfully.
+
+## Helper Functions
+
+Within the example code, there are helper functions designed to:
+- Update the image field in a JSON metadata file.
+- Recursively update the image fields in all JSON files within a folder.
+
+These functions are essential for linking your NFT media with the correct metadata before uploading to the network.
+
+Remember to test the code in a development environment before deploying it to production to ensure everything works as expected.