refactor: add missing types for LSP3/4

lukso-network · Apr 5, 2024 · 1799237 · 1799237
1 parent fbbd048
commit 1799237
Show file tree

Hide file tree

Showing 7 changed files with 37 additions and 20 deletions.
diff --git a/packages/lsp-smart-contracts/constants.ts b/packages/lsp-smart-contracts/constants.ts
@@ -17,6 +17,8 @@ export type {
   LSP4DigitalAssetMetadataJSON,
   LSP4DigitalAssetMetadata,
   AttributeMetadata,
+  AssetFile,
+  DigitalAsset,
 } from '@lukso/lsp4-contracts';
 export type { LSP6PermissionName } from '@lukso/lsp6-contracts';
 

diff --git a/packages/lsp10-contracts/constants.ts b/packages/lsp10-contracts/constants.ts
@@ -1,4 +1,4 @@
-import { LSP2ArrayKey } from '@lukso/lsp2-contracts';
+import type { LSP2ArrayKey } from '@lukso/lsp2-contracts';
 
 export const LSP10DataKeys = {
   // keccak256('LSP10VaultsMap') + bytes2(0)

diff --git a/packages/lsp12-contracts/constants.ts b/packages/lsp12-contracts/constants.ts
@@ -1,4 +1,4 @@
-import { LSP2ArrayKey } from '@lukso/lsp2-contracts';
+import type { LSP2ArrayKey } from '@lukso/lsp2-contracts';
 
 export const LSP12DataKeys = {
   // LSP12IssuedAssetsMap:<address>  + bytes2(0)

diff --git a/packages/lsp3-contracts/constants.ts b/packages/lsp3-contracts/constants.ts
@@ -1,4 +1,4 @@
-import { Verification } from '@lukso/lsp2-contracts';
+import type { Verification } from '@lukso/lsp2-contracts';
 
 export type LSP3ProfileMetadataJSON = {
   LSP3Profile: LSP3ProfileMetadata;
@@ -7,10 +7,10 @@ export type LSP3ProfileMetadataJSON = {
 export type LSP3ProfileMetadata = {
   name: string;
   description: string;
+  links?: LinkMetadata[];
+  tags?: string[];
   profileImage?: ImageMetadata[];
   backgroundImage?: ImageMetadata[];
-  tags?: string[];
-  links?: LinkMetadata[];
   avatar?: AssetMetadata[];
 };
 
@@ -26,10 +26,17 @@ export type LinkMetadata = {
   url: string;
 };
 
-export type AssetMetadata = {
-  verification?: Verification;
+export type AssetMetadata = AssetFile | DigitalAsset;
+
+export type AssetFile = {
   url: string;
-  fileType: string;
+  verification?: Verification;
+  fileType?: string;
+};
+
+export type DigitalAsset = {
+  address: string;
+  tokenId?: string;
 };
 
 export const LSP3SupportedStandard = {

diff --git a/packages/lsp4-contracts/constants.ts b/packages/lsp4-contracts/constants.ts
@@ -1,21 +1,17 @@
-import { Verification, LSP2ArrayKey } from '@lukso/lsp2-contracts';
+import type { Verification, LSP2ArrayKey } from '@lukso/lsp2-contracts';
 
 export type LSP4DigitalAssetMetadataJSON = {
   LSP4Metadata: LSP4DigitalAssetMetadata;
 };
 
 export type LSP4DigitalAssetMetadata = {
+  name: string;
   description: string;
   links: LinkMetadata[];
   images: ImageMetadata[][];
   assets: AssetMetadata[];
   icon: ImageMetadata[];
-  attributes: AttributeMetadata[];
-};
-
-export type LinkMetadata = {
-  title: string;
-  url: string;
+  attributes?: AttributeMetadata[];
 };
 
 export type ImageMetadata = {
@@ -25,10 +21,9 @@ export type ImageMetadata = {
   url: string;
 };
 
-export type AssetMetadata = {
-  verification?: Verification;
+export type LinkMetadata = {
+  title: string;
   url: string;
-  fileType: string;
 };
 
 export type AttributeMetadata = {
@@ -37,6 +32,19 @@ export type AttributeMetadata = {
   type: string | number | boolean;
 };
 
+export type AssetMetadata = AssetFile | DigitalAsset;
+
+export type AssetFile = {
+  url: string;
+  verification?: Verification;
+  fileType?: string;
+};
+
+export type DigitalAsset = {
+  address: string;
+  tokenId?: string;
+};
+
 export const LSP4SupportedStandard = {
   key: '0xeafec4d89fa9619884b60000a4d96624a38f7ac2d8d9a604ecf07c12c77e480c',
   value: '0xa4d96624',

diff --git a/packages/lsp5-contracts/constants.ts b/packages/lsp5-contracts/constants.ts
@@ -1,4 +1,4 @@
-import { LSP2ArrayKey } from '@lukso/lsp2-contracts';
+import type { LSP2ArrayKey } from '@lukso/lsp2-contracts';
 
 export const LSP5DataKeys = {
   // LSP5ReceivedAssetsMap:<address>  + bytes2(0)

diff --git a/packages/lsp6-contracts/constants.ts b/packages/lsp6-contracts/constants.ts
@@ -1,4 +1,4 @@
-import { LSP2ArrayKey } from '@lukso/lsp2-contracts';
+import type { LSP2ArrayKey } from '@lukso/lsp2-contracts';
 
 export const INTERFACE_ID_LSP6 = '0x23f34c62';