feat: Add SP Api types (#424)

bnb-chain · Dec 19, 2023 · a999960 · a999960
1 parent 6771bed
commit a999960
Show file tree

Hide file tree

Showing 6 changed files with 103 additions and 27 deletions.
diff --git a/.changeset/early-kids-remain.md b/.changeset/early-kids-remain.md
@@ -0,0 +1,5 @@
+---
+'@bnb-chain/greenfield-js-sdk': patch
+---
+
+feat: Add SP create API types
diff --git a/examples/nextjs/src/components/group/info/index.tsx b/examples/nextjs/src/components/group/info/index.tsx
@@ -37,7 +37,7 @@ export const GroupInfo = () => {
           console.log('headGroupMember', headGroupMember);
         }}
       >
-        get group info
+        get group member info
       </button>
     </div>
   );

diff --git a/examples/nextjs/src/components/group/update/index.tsx b/examples/nextjs/src/components/group/update/index.tsx
@@ -125,7 +125,7 @@ export const GroupUpdate = () => {
         onClick={async () => {
           if (!address) return;
 
-          const resource = GRNToString(newGroupGRN(address, 'zzxc1'));
+          const resource = GRNToString(newGroupGRN(address, groupName));
 
           const updateGroupTx = await client.storage.setTag({
             operator: address,

diff --git a/packages/js-sdk/src/api/storage.ts b/packages/js-sdk/src/api/storage.ts
@@ -31,7 +31,7 @@ import {
   TxResponse,
 } from '..';
 import { RpcQueryClient } from '../clients/queryclient';
-import { MsgSetTagSDKTypeEIP712 } from '@/messages/greenfield/storage/MsgSetTag';
+import { getMsgSetTagSDKTypeEIP712 } from '@/messages/greenfield/storage/MsgSetTag';
 
 export interface IStorage {
   params(): Promise<QueryParamsResponse>;
@@ -108,6 +108,10 @@ export class Storage implements IStorage {
   }
 
   public async setTag(msg: MsgSetTag) {
+    const isTagsEmpty = msg?.tags?.tags?.length === 0;
+
+    const MsgSetTagSDKTypeEIP712 = getMsgSetTagSDKTypeEIP712(isTagsEmpty);
+
     return await this.txClient.tx(
       MsgSetTagTypeUrl,
       msg.operator,

diff --git a/packages/js-sdk/src/messages/greenfield/storage/MsgSetTag.ts b/packages/js-sdk/src/messages/greenfield/storage/MsgSetTag.ts
@@ -1,4 +1,49 @@
-export const MsgSetTagSDKTypeEIP712 = {
+import type { EIP712Msg } from '@/messages/utils';
+import cloneDeep from 'lodash.clonedeep';
+
+export const getMsgSetTagSDKTypeEIP712 = (isTagsEmpty: boolean) => {
+  const res: EIP712Msg = cloneDeep(MsgSetTagSDKTypeEIP712);
+
+  if (!isTagsEmpty) {
+    res.Msg1.push({
+      name: 'tags',
+      type: 'TypeMsg1Tags',
+    });
+
+    res.TypeMsg1Tags = [
+      {
+        name: 'tags',
+        type: 'TypeMsg1TagsTags[]',
+      },
+    ];
+    res.TypeMsg1TagsTags = [
+      {
+        name: 'key',
+        type: 'string',
+      },
+      {
+        name: 'value',
+        type: 'string',
+      },
+    ];
+  } else {
+    res.Msg1.push({
+      name: 'tags',
+      type: 'TypeMsg1Tags',
+    });
+
+    res.TypeMsg1Tags = [
+      {
+        name: 'tags',
+        type: 'string[]',
+      },
+    ];
+  }
+
+  return res;
+};
+
+const MsgSetTagSDKTypeEIP712 = {
   Msg1: [
     {
       name: 'operator',
@@ -8,29 +53,9 @@ export const MsgSetTagSDKTypeEIP712 = {
       name: 'resource',
       type: 'string',
     },
-    {
-      name: 'tags',
-      type: 'TypeMsg1Tags',
-    },
     {
       name: 'type',
       type: 'string',
     },
   ],
-  TypeMsg1Tags: [
-    {
-      name: 'tags',
-      type: 'TypeMsg1TagsTags[]',
-    },
-  ],
-  TypeMsg1TagsTags: [
-    {
-      name: 'key',
-      type: 'string',
-    },
-    {
-      name: 'value',
-      type: 'string',
-    },
-  ],
 };
diff --git a/packages/js-sdk/src/types/sp/Common.ts b/packages/js-sdk/src/types/sp/Common.ts
@@ -42,6 +42,12 @@ export interface BucketInfo {
   PaymentAddress: string;
   SourceType: number;
   Visibility: number;
+  Tags: {
+    Tags: {
+      Key: string;
+      Value: string;
+    }[];
+  };
 }
 
 export interface StreamRecord {
@@ -85,9 +91,20 @@ export interface ObjectInfo {
   RedundancyType: number;
   SourceType: number;
   Visibility: number;
+  Tags: {
+    Tags: {
+      Key: string;
+      Value: string;
+    }[];
+  };
 }
 
-export function formatBucketInfo(o: BucketInfo) {
+export function formatBucketInfo(o: BucketInfo): BucketInfo {
+  let tags = o.Tags.Tags || [];
+  if (!Array.isArray(tags)) {
+    tags = [tags];
+  }
+
   return {
     ...o,
     // PrimarySpId: Number(item.BucketInfo.PrimarySpId),
@@ -97,10 +114,18 @@ export function formatBucketInfo(o: BucketInfo) {
     GlobalVirtualGroupFamilyId: Number(o.GlobalVirtualGroupFamilyId),
     SourceType: Number(o.SourceType),
     Visibility: Number(o.Visibility),
+    Tags: {
+      Tags: tags,
+    },
   };
 }
 
-export function formatObjectInfo(o: ObjectInfo) {
+export function formatObjectInfo(o: ObjectInfo): ObjectInfo {
+  let tags = o.Tags.Tags || [];
+  if (!Array.isArray(tags)) {
+    tags = [tags];
+  }
+
   return {
     ...o,
     CreateAt: Number(o.CreateAt),
@@ -111,6 +136,9 @@ export function formatObjectInfo(o: ObjectInfo) {
     RedundancyType: Number(o.RedundancyType),
     SourceType: Number(o.SourceType),
     Visibility: Number(o.Visibility),
+    Tags: {
+      Tags: tags,
+    },
   };
 }
 
@@ -140,13 +168,27 @@ export interface GroupInfo {
   SourceType: number;
   Id: number;
   Extra: string;
+  Tags: {
+    Tags: {
+      Key: string;
+      Value: string;
+    }[];
+  };
 }
 
-export function formatGroupInfo(o: GroupInfo) {
+export function formatGroupInfo(o: GroupInfo): GroupInfo {
+  let tags = o.Tags.Tags || [];
+  if (!Array.isArray(tags)) {
+    tags = [tags];
+  }
+
   return {
     ...o,
     SourceType: Number(o.SourceType),
     Id: Number(o.Id),
+    Tags: {
+      Tags: tags,
+    },
   };
 }