feat: Enhance file and folder creation with visibility options in GNFD services (#3)

Author: robot-ux

README.md

@@ -23,7 +23,7 @@ The project is organized into several core modules:
 - **Wallet**: Wallet operations and management
 - **Common**: Shared utilities and types
 - **Greenfield**: Support file management operations on Greenfield network including, uploading, downloading, and managing files and buckets
-- Additional features coming soon (Greenfield, Swap, Bridge, etc.)
+- Additional features coming soon (Swap, Bridge, etc.)
 
 ## Integration with Cursor
 

src/gnfd/services/bucket.ts

@@ -35,10 +35,12 @@ export const createBucket = async (
   network: "testnet" | "mainnet",
   {
     privateKey,
-    bucketName
+    bucketName,
+    visibility
   }: {
     privateKey: Hex
     bucketName?: string
+    visibility?: "public" | "private"
   }
 ): Promise<ApiResponse<BucketData>> => {
   const client = getClient(network)
@@ -64,7 +66,10 @@ export const createBucket = async (
     const createBucketTx = await client.bucket.createBucket({
       bucketName: _bucketName,
       creator: account.address,
-      visibility: VisibilityType.VISIBILITY_TYPE_PUBLIC_READ,
+      visibility:
+        visibility === "public"
+          ? VisibilityType.VISIBILITY_TYPE_PUBLIC_READ
+          : VisibilityType.VISIBILITY_TYPE_PRIVATE,
       chargedReadQuota: Long.fromString("0"),
       paymentAddress: account.address,
       primarySpAddress: spInfo.primarySpAddress

src/gnfd/services/index.test.ts

@@ -87,7 +87,7 @@ test("list objects", async () => {
   expect(res.status).toBe("success")
 })
 
-test("download object", async () => {
+test("download private object", async () => {
   const res = await downloadObject("testnet", {
     privateKey: process.env.PRIVATE_KEY as Hex,
     bucketName,
@@ -99,6 +99,27 @@ test("download object", async () => {
   expect(res.status).toBe("success")
 })
 
+test("download public object", async () => {
+  await createFile("testnet", {
+    privateKey: process.env.PRIVATE_KEY as Hex,
+    filePath: fileName,
+    bucketName: "created-by-bnbchain-mcp",
+    visibility: "public"
+  })
+
+  const res = await downloadObject("testnet", {
+    bucketName: "created-by-bnbchain-mcp",
+    objectName
+  })
+  // remove the file after test
+  await deleteObject("testnet", {
+    privateKey: process.env.PRIVATE_KEY as Hex,
+    bucketName: "created-by-bnbchain-mcp",
+    objectName
+  })
+  expect(res.data?.file.startsWith("https://")).toBeTrue()
+})
+
 test("delete object", async () => {
   const res = await deleteObject("testnet", {
     privateKey: process.env.PRIVATE_KEY as Hex,

src/gnfd/services/object.ts

@@ -1,18 +1,12 @@
-import {
-  existsSync,
-  fstatSync,
-  readFileSync,
-  statSync,
-  writeFileSync
-} from "fs"
+import { existsSync, readFileSync, statSync, writeFileSync } from "fs"
 import path from "path"
+import { ObjectInfo } from "@bnb-chain/greenfield-cosmos-types/greenfield/storage/types"
 import {
   bytesFromBase64,
   Long,
   RedundancyType,
   VisibilityType
 } from "@bnb-chain/greenfield-js-sdk"
-import { ObjectInfo } from "@bnb-chain/greenfield-js-sdk/dist/esm/types/sp/Common"
 import { NodeAdapterReedSolomon } from "@bnb-chain/reed-solomon/node.adapter"
 import type { Hex } from "viem"
 
@@ -54,11 +48,13 @@ export const createFile = async (
   {
     privateKey,
     filePath,
-    bucketName
+    bucketName,
+    visibility
   }: {
     privateKey: Hex
     filePath: string
     bucketName?: string
+    visibility?: "public" | "private"
   }
 ): Promise<ApiResponse<FileData>> => {
   try {
@@ -101,7 +97,10 @@ export const createFile = async (
       bucketName: _bucketName,
       objectName: objectName,
       creator: account.address,
-      visibility: VisibilityType.VISIBILITY_TYPE_PRIVATE,
+      visibility:
+        visibility === "public"
+          ? VisibilityType.VISIBILITY_TYPE_PUBLIC_READ
+          : VisibilityType.VISIBILITY_TYPE_PRIVATE,
       contentType: fileObj.type as string,
       redundancyType: RedundancyType.REDUNDANCY_EC_TYPE,
       payloadSize: Long.fromInt(fileObj.content.byteLength),
@@ -161,11 +160,13 @@ export const createFolder = async (
   {
     privateKey,
     folderName,
-    bucketName
+    bucketName,
+    visibility
   }: {
     privateKey: Hex
     folderName?: string
     bucketName?: string
+    visibility?: "public" | "private"
   }
 ): Promise<ApiResponse<{ bucketName: string; folderName: string }>> => {
   try {
@@ -197,7 +198,10 @@ export const createFolder = async (
       bucketName: _bucketName,
       objectName: formattedFolderName,
       creator: account.address,
-      visibility: VisibilityType.VISIBILITY_TYPE_PRIVATE,
+      visibility:
+        visibility === "public"
+          ? VisibilityType.VISIBILITY_TYPE_PUBLIC_READ
+          : VisibilityType.VISIBILITY_TYPE_PRIVATE,
       redundancyType: RedundancyType.REDUNDANCY_EC_TYPE
     })
 
@@ -240,7 +244,7 @@ export const getObjectInfo = async (
     const client = getClient(network)
     const res = await client.object.headObject(bucketName, objectName)
 
-    return response.success(res.objectInfo as {} as ObjectInfo)
+    return response.success(res.objectInfo as ObjectInfo)
   } catch (error) {
     Logger.error(`Get object info operation failed: ${error}`)
     return response.fail(`Get object info operation failed: ${error}`)
@@ -311,7 +315,9 @@ export const listObjects = async (
   network: "testnet" | "mainnet",
   bucketName: string
 ): Promise<
-  ApiResponse<{ objects: Array<{ objectName: string; createAt: number }> }>
+  ApiResponse<{
+    objects: Array<{ objectName: string; createAt: number; visibility: string }>
+  }>
 > => {
   try {
     const client = getClient(network)
@@ -339,7 +345,11 @@ export const listObjects = async (
       objectsRes.body?.GfSpListObjectsByBucketNameResponse?.Objects || []
     const objects = res.map((it) => ({
       objectName: it.ObjectInfo.ObjectName,
-      createAt: it.ObjectInfo.CreateAt
+      createAt: it.ObjectInfo.CreateAt,
+      visibility:
+        it.ObjectInfo.Visibility === VisibilityType.VISIBILITY_TYPE_PUBLIC_READ
+          ? "public"
+          : "private"
     }))
 
     return response.success({ objects })
@@ -352,18 +362,46 @@ export const listObjects = async (
 export const downloadObject = async (
   network: "testnet" | "mainnet",
   {
-    privateKey,
     bucketName,
     objectName,
+    privateKey,
     targetPath
   }: {
-    privateKey: Hex
     bucketName: string
     objectName: string
+    privateKey?: Hex
     targetPath?: string
   }
 ): Promise<ApiResponse<{ file: string }>> => {
   try {
+    const objectInfo = await getObjectInfo(network, {
+      bucketName,
+      objectName
+    })
+    if (objectInfo.status === "error") {
+      return response.fail(objectInfo.message || "Object does not exist")
+    }
+
+    const objectInfoData = objectInfo.data as ObjectInfo
+    Logger.debug(`Object info: ${JSON.stringify(objectInfoData)}`)
+    // for public object, use sp endpoint to download
+    if (
+      objectInfoData.visibility === VisibilityType.VISIBILITY_TYPE_PUBLIC_READ
+    ) {
+      const sp = await selectSp(network)
+      return response.success({
+        file: sp.endpoint + "/view/" + bucketName + "/" + objectName
+      })
+    }
+
+    // for private object, private key is required
+    if (
+      objectInfoData.visibility === VisibilityType.VISIBILITY_TYPE_PRIVATE &&
+      !privateKey
+    ) {
+      return response.fail("Object is private and private key is not provided")
+    }
+
     let filePath = ""
     if (!targetPath || !existsSync(targetPath)) {
       Logger.debug(
@@ -383,7 +421,7 @@ export const downloadObject = async (
       },
       {
         type: "ECDSA",
-        privateKey: privateKey
+        privateKey: privateKey || ""
       }
     )
     if (res.code !== 0) {

src/gnfd/tools.ts

@@ -149,13 +149,19 @@ export function registerGnfdTools(server: McpServer) {
         .describe(
           "Absolute path to the file to upload. The file must exist on the machine."
         ),
-      bucketName: bucketNameParam
+      bucketName: bucketNameParam,
+      visibility: z
+        .enum(["public", "private"])
+        .optional()
+        .default("private")
+        .describe("The visibility of the file. Defaults to 'private'.")
     },
     async ({
       network,
       privateKey,
       filePath,
-      bucketName = "created-by-bnbchain-mcp"
+      bucketName = "created-by-bnbchain-mcp",
+      visibility
     }) => {
       try {
         // Ensure absolute path is used
@@ -166,7 +172,8 @@ export function registerGnfdTools(server: McpServer) {
         const result = await services.createFile(network, {
           privateKey: privateKey as Hex,
           filePath: absoluteFilePath,
-          bucketName
+          bucketName,
+          visibility
         })
         return formatResponse(result)
       } catch (error) {
@@ -187,14 +194,20 @@ export function registerGnfdTools(server: McpServer) {
         .optional()
         .default("created-by-bnbchain-mcp")
         .describe("Optional folder name. Default is 'created-by-bnbchain-mcp'"),
-      bucketName: bucketNameParam
+      bucketName: bucketNameParam,
+      visibility: z
+        .enum(["public", "private"])
+        .optional()
+        .default("private")
+        .describe("The visibility of the folder. Defaults to 'private'.")
     },
-    async ({ network, privateKey, folderName, bucketName }) => {
+    async ({ network, privateKey, folderName, bucketName, visibility }) => {
       try {
         const result = await services.createFolder(network, {
           privateKey: privateKey as Hex,
           folderName,
-          bucketName
+          bucketName,
+          visibility
         })
         return formatResponse(result)
       } catch (error) {