feat: ListObjectPolicies api

.changeset/rich-dolls-chew.md

@@ -0,0 +1,5 @@
+---
+'@bnb-chain/greenfield-js-sdk': patch
+---
+
+feat: Add sp `ListObjectPolicies` API

examples/nextjs/src/components/object/info/index.tsx

@@ -115,6 +115,24 @@ export const ObjectInfo = () => {
 
         <br />
 
+        <div>
+          listObjectPolicies by bucket name and object name
+          <br />
+          <button
+            onClick={async () => {
+              const res = await client.object.listObjectPolicies({
+                bucketName,
+                objectName,
+                actionType: 'ACTION_GET_OBJECT',
+              });
+
+              console.log('res', res);
+            }}
+          >
+            listObjectPolicies
+          </button>
+        </div>
+
         <div>
           get objects list by bucket name
           <br />

packages/chain-sdk/src/api/objectt.ts

@@ -5,6 +5,10 @@ import {
   getObjectMetaInfo,
   parseGetObjectMetaResponse,
 } from '@/clients/spclient/spApis/getObjectMeta';
+import {
+  getListObjectPoliciesMetaInfo,
+  parseGetListObjectPoliciesResponse,
+} from '@/clients/spclient/spApis/listObjectPolicies';
 import { parseListObjectsByBucketNameResponse } from '@/clients/spclient/spApis/listObjectsByBucket';
 import {
   getListObjectsByIDsMetaInfo,
@@ -65,6 +69,7 @@ import { AuthType, SpClient } from '../clients/spclient/spClient';
 import {
   CreateObjectApprovalRequest,
   CreateObjectApprovalResponse,
+  GetListObjectPoliciesRequest,
   GetPrivewObject,
   ListObjectsByBucketNameRequest,
   ListObjectsByIDsRequest,
@@ -161,6 +166,8 @@ export interface IObject {
   getObjectMeta(params: GetObjectMetaRequest): Promise<SpResponse<GetObjectMetaResponse>>;
 
   listObjectsByIds(params: ListObjectsByIDsRequest): Promise<SpResponse<ListObjectsByIDsResponse>>;
+
+  listObjectPolicies(params: GetListObjectPoliciesRequest): Promise<any>;
   // TODO: GetObjectUploadProgress
   // TODO: getObjectStatusFromSP
 }
@@ -744,4 +751,27 @@ export class Objectt implements IObject {
       };
     }
   }
+
+  public async listObjectPolicies(params: GetListObjectPoliciesRequest) {
+    let endpoint = params.endpoint;
+    if (!endpoint) {
+      endpoint = await this.sp.getSPUrlByBucket(params.bucketName);
+    }
+    const { url } = getListObjectPoliciesMetaInfo(endpoint, params);
+
+    const result = await this.spClient.callApi(url, {
+      headers: {},
+      method: METHOD_GET,
+    });
+
+    const xml = await result.text();
+    const res = parseGetListObjectPoliciesResponse(xml);
+
+    return {
+      code: 0,
+      message: 'success',
+      statusCode: result.status,
+      body: res,
+    };
+  }
 }

packages/chain-sdk/src/api/storage.ts

@@ -1,5 +1,6 @@
+import { TxClient } from '@/clients/txClient';
+import { getMsgPutPolicySDKTypeEIP712 } from '@/messages/greenfield';
 import { MsgDeletePolicySDKTypeEIP712 } from '@/messages/greenfield/storage/MsgDeletePolicy';
-import { MsgPutPolicySDKTypeEIP712 } from '@/messages/greenfield/storage/MsgPutPolicy';
 import {
   QueryGroupMembersExistRequest,
   QueryGroupMembersExistResponse,
@@ -22,9 +23,7 @@ import {
 } from '@bnb-chain/greenfield-cosmos-types/greenfield/storage/tx';
 import { container, delay, inject, singleton } from 'tsyringe';
 import { fromTimestamp, MsgDeletePolicyTypeUrl, MsgPutPolicyTypeUrl, TxResponse } from '..';
-import { Basic } from './basic';
 import { RpcQueryClient } from '../clients/queryclient';
-import { TxClient } from '@/clients/txClient';
 
 export interface IStorage {
   params(): Promise<QueryParamsResponse>;
@@ -69,13 +68,18 @@ export class Storage implements IStorage {
     return await this.txClient.tx(
       MsgPutPolicyTypeUrl,
       msg.operator,
-      MsgPutPolicySDKTypeEIP712,
+      getMsgPutPolicySDKTypeEIP712(msg.statements[0].resources),
       {
         ...toSdk,
         expiration_time: msg.expirationTime ? fromTimestamp(msg.expirationTime) : '',
         statements: toSdk.statements.map((e) => {
           // @ts-ignore
           e.expiration_time = '';
+
+          if (e.resources.length == 0) {
+            // @ts-ignore
+            e.resources = null;
+          }
           return e;
         }),
       },

packages/chain-sdk/src/clients/spclient/spApis/listObjectPolicies.ts

@@ -0,0 +1,62 @@
+import { convertStrToBool, formatObjectInfo } from '@/types/sp/Common';
+import {
+  GetListObjectPoliciesRequest,
+  GetListObjectPoliciesResponse,
+} from '@/types/sp/ListObjectPolicies';
+import { generateUrlByBucketName } from '@/utils';
+import { actionTypeFromJSON } from '@bnb-chain/greenfield-cosmos-types/greenfield/permission/common';
+import { XMLParser } from 'fast-xml-parser';
+import { encodePath, getSortQueryParams } from '../auth';
+
+export const getListObjectPoliciesMetaInfo = (
+  endpoint: string,
+  params: GetListObjectPoliciesRequest,
+) => {
+  const { actionType, bucketName, objectName, limit = '10', startAfter = '' } = params;
+  const path = `/${encodePath(objectName)}`;
+  const queryMap = {
+    'object-policies': 'null',
+    'start-after': startAfter,
+    limit: String(limit),
+    'action-type': String(actionTypeFromJSON(actionType)),
+  };
+
+  let url = new URL(path, generateUrlByBucketName(endpoint, bucketName));
+  url = getSortQueryParams(url, queryMap);
+
+  return {
+    url: url.href,
+  };
+};
+
+export const parseGetListObjectPoliciesResponse = (data: string) => {
+  const xmlParser = new XMLParser({
+    parseTagValue: false,
+  });
+  const res = xmlParser.parse(data) as GetListObjectPoliciesResponse;
+
+  let Policies = res.GfSpListObjectPoliciesResponse.Policies || [];
+
+  if (Policies) {
+    if (!Array.isArray(Policies)) {
+      Policies = [Policies];
+    }
+
+    Policies = Policies.map((item) => {
+      return {
+        ...item,
+        PrincipalType: Number(item.ResourceType),
+        ResourceType: Number(item.ResourceType),
+        CreateTimestamp: Number(item.CreateTimestamp),
+        UpdateTimestamp: Number(item.UpdateTimestamp),
+        ExpirationTime: Number(item.ExpirationTime),
+      };
+    });
+  }
+
+  res.GfSpListObjectPoliciesResponse = {
+    Policies,
+  };
+
+  return res;
+};

packages/chain-sdk/src/types/sp/Common.ts

@@ -149,3 +149,34 @@ export function formatGroupInfo(o: GroupInfo) {
     Id: Number(o.Id),
   };
 }
+
+export interface PolicyMeta {
+  /**
+   * principal_type defines the type of principal
+   */
+  PrincipalType: number;
+  /**
+   * principal_value defines the value of principal
+   */
+  PrincipalValue: string;
+  /**
+   * resource_type defines the type of resource that grants permission for
+   */
+  ResourceType: number;
+  /**
+   * resource_id defines the bucket/object/group id of the resource that grants permission for
+   */
+  ResourceId: string;
+  /**
+   * create_timestamp defines the create time of permission
+   */
+  CreateTimestamp: number;
+  /**
+   * update_timestamp defines the update time of permission
+   */
+  UpdateTimestamp: number;
+  /**
+   * expiration_time defines the expiration time of permission
+   */
+  ExpirationTime: number;
+}

packages/chain-sdk/src/types/sp/ListObjectPolicies.ts

@@ -0,0 +1,19 @@
+import { ActionType } from '@bnb-chain/greenfield-cosmos-types/greenfield/permission/common';
+import { PolicyMeta } from './Common';
+
+export type GetListObjectPoliciesRequest = {
+  endpoint?: string;
+  bucketName: string;
+  objectName: string;
+  actionType: keyof typeof ActionType;
+  limit?: number;
+  startAfter?: string;
+};
+
+export type GetListObjectPoliciesResponse = {
+  GfSpListObjectPoliciesResponse: GfSpListObjectPoliciesResponse;
+};
+
+export interface GfSpListObjectPoliciesResponse {
+  Policies: PolicyMeta[];
+}

packages/chain-sdk/src/types/sp/index.ts

@@ -10,6 +10,7 @@ export * from './ListBucketsByIDs';
 export * from './ListBucketsByPaymentAccount';
 export * from './ListGroups';
 export * from './ListGroupsMembers';
+export * from './ListObjectPolicies';
 export * from './ListObjectsByBucketName';
 export * from './ListObjectsByIDs';
 export * from './ListUserGroups';