ShareClassMetadata struct for share class metadata (#28)

Define a ShareClassMetadata struct and compute its INIT_SIZE that'll be used later on in program
glamsystems · Apr 1, 2024 · e7f14fd · e7f14fd
1 parent b54a2a3
commit e7f14fd
Show file tree

Hide file tree

Showing 7 changed files with 103 additions and 56 deletions.
diff --git a/anchor/programs/glam/src/instructions/manager.rs b/anchor/programs/glam/src/instructions/manager.rs
@@ -34,9 +34,7 @@ pub fn initialize_fund_handler<'c: 'info, 'info>(
     fund_uri: String,
     asset_weights: Vec<u32>,
     activate: bool,
-    share_name: String,
-    share_symbol: String,
-    share_uri: String,
+    share_class_metadata: ShareClassMetadata,
 ) -> Result<()> {
     //
     // Validate the input
@@ -108,7 +106,7 @@ pub fn initialize_fund_handler<'c: 'info, 'info>(
     let space =
         ExtensionType::try_calculate_account_len::<StateMint>(&[ExtensionType::MetadataPointer])
             .unwrap();
-    let metadata_space = 250; // we may need more space for metadata in the future
+    let metadata_space = ShareClassMetadata::INIT_SIZE;
 
     let lamports_required = (Rent::get()?).minimum_balance(space + metadata_space);
 
@@ -161,9 +159,9 @@ pub fn initialize_fund_handler<'c: 'info, 'info>(
         &share_metadata_authority.key(),
         &share_mint.key(),
         &share_mint_authority.key(),
-        share_name,
-        share_symbol,
-        share_uri,
+        share_class_metadata.name.clone(),
+        share_class_metadata.symbol.clone(),
+        share_class_metadata.uri.clone(),
     );
     solana_program::program::invoke_signed(
         &init_token_metadata_ix,

diff --git a/anchor/programs/glam/src/lib.rs b/anchor/programs/glam/src/lib.rs
@@ -5,6 +5,7 @@ pub mod state;
 
 use anchor_lang::prelude::*;
 
+use crate::state::fund::*;
 pub use constants::*;
 pub use instructions::*;
 
@@ -23,9 +24,7 @@ pub mod glam {
         fund_uri: String,
         asset_weights: Vec<u32>,
         activate: bool,
-        share_name: String,
-        share_symbol: String,
-        share_uri: String,
+        share_class_metadata: ShareClassMetadata,
     ) -> Result<()> {
         manager::initialize_fund_handler(
             ctx,
@@ -34,9 +33,7 @@ pub mod glam {
             fund_uri,
             asset_weights,
             activate,
-            share_name,
-            share_symbol,
-            share_uri,
+            share_class_metadata,
         )
     }
     pub fn update<'c: 'info, 'info>(

diff --git a/anchor/programs/glam/src/state/fund.rs b/anchor/programs/glam/src/state/fund.rs
@@ -49,3 +49,14 @@ pub struct Treasury {
 impl Treasury {
     pub const INIT_SIZE: usize = 32 + 32 + 1;
 }
+
+#[derive(AnchorSerialize, AnchorDeserialize)]
+pub struct ShareClassMetadata {
+    pub name: String,
+    pub symbol: String,
+    pub uri: String,
+}
+impl ShareClassMetadata {
+    // use the same max sizes as Fund
+    pub const INIT_SIZE: usize = MAX_FUND_NAME + MAX_FUND_SYMBOL + MAX_FUND_URI;
+}
diff --git a/anchor/target/idl/glam.json b/anchor/target/idl/glam.json
@@ -72,16 +72,10 @@
           "type": "bool"
         },
         {
-          "name": "shareName",
-          "type": "string"
-        },
-        {
-          "name": "shareSymbol",
-          "type": "string"
-        },
-        {
-          "name": "shareUri",
-          "type": "string"
+          "name": "shareClassMetadata",
+          "type": {
+            "defined": "ShareClassMetadata"
+          }
         }
       ]
     },
@@ -639,6 +633,26 @@
     }
   ],
   "types": [
+    {
+      "name": "ShareClassMetadata",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "name",
+            "type": "string"
+          },
+          {
+            "name": "symbol",
+            "type": "string"
+          },
+          {
+            "name": "uri",
+            "type": "string"
+          }
+        ]
+      }
+    },
     {
       "name": "InvestorError",
       "type": {

diff --git a/anchor/target/types/glam.ts b/anchor/target/types/glam.ts
@@ -72,16 +72,10 @@ export type Glam = {
           "type": "bool"
         },
         {
-          "name": "shareName",
-          "type": "string"
-        },
-        {
-          "name": "shareSymbol",
-          "type": "string"
-        },
-        {
-          "name": "shareUri",
-          "type": "string"
+          "name": "shareClassMetadata",
+          "type": {
+            "defined": "ShareClassMetadata"
+          }
         }
       ]
     },
@@ -639,6 +633,26 @@ export type Glam = {
     }
   ],
   "types": [
+    {
+      "name": "ShareClassMetadata",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "name",
+            "type": "string"
+          },
+          {
+            "name": "symbol",
+            "type": "string"
+          },
+          {
+            "name": "uri",
+            "type": "string"
+          }
+        ]
+      }
+    },
     {
       "name": "InvestorError",
       "type": {
@@ -773,16 +787,10 @@ export const IDL: Glam = {
           "type": "bool"
         },
         {
-          "name": "shareName",
-          "type": "string"
-        },
-        {
-          "name": "shareSymbol",
-          "type": "string"
-        },
-        {
-          "name": "shareUri",
-          "type": "string"
+          "name": "shareClassMetadata",
+          "type": {
+            "defined": "ShareClassMetadata"
+          }
         }
       ]
     },
@@ -1340,6 +1348,26 @@ export const IDL: Glam = {
     }
   ],
   "types": [
+    {
+      "name": "ShareClassMetadata",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "name",
+            "type": "string"
+          },
+          {
+            "name": "symbol",
+            "type": "string"
+          },
+          {
+            "name": "uri",
+            "type": "string"
+          }
+        ]
+      }
+    },
     {
       "name": "InvestorError",
       "type": {

diff --git a/anchor/tests/glam_crud.spec.ts b/anchor/tests/glam_crud.spec.ts
@@ -46,6 +46,11 @@ describe("glam_crud", () => {
     program.programId
   );
 
+  const shareClass = {
+    name: "Class A share",
+    symbol: "CLASS-A",
+    uri: "https://glam.systems/fund/XYZ/share/A"
+  };
   const [sharePDA, shareBump] = PublicKey.findProgramAddressSync(
     [anchor.utils.bytes.utf8.encode("share-0"), fundPDA.toBuffer()],
     program.programId
@@ -62,9 +67,7 @@ describe("glam_crud", () => {
           fundUri,
           [0, 60, 40],
           true,
-          "Class A share",
-          "CLASS-A",
-          "https://glam.systems/fund/XYZ/share/A"
+          shareClass
         )
         .accounts({
           fund: fundPDA,
@@ -86,6 +89,7 @@ describe("glam_crud", () => {
     }
 
     const fund = await program.account.fund.fetch(fundPDA);
+    console.log(fund);
     expect(fund.shareClassesLen).toEqual(1);
     expect(fund.assetsLen).toEqual(3);
     expect(fund.name).toEqual(fundName);

diff --git a/web/src/app/glam/glam-data-access.tsx b/web/src/app/glam/glam-data-access.tsx
@@ -35,16 +35,11 @@ export function useGlamProgram() {
     mutationKey: ["glam", "initialize", { cluster }],
     mutationFn: (keypair: Keypair) =>
       program.methods
-        .initialize(
-          "fund name",
-          "fund symbol",
-          "fund uri",
-          [0, 60, 40],
-          true,
-          "Class A share",
-          "A",
-          "https://glam.systems/fund/XYZ/share/A"
-        )
+        .initialize("fund name", "fund symbol", "fund uri", [0, 60, 40], true, {
+          name: "Class A share",
+          symbol: "A",
+          uri: "https://glam.systems/fund/XYZ/share/A"
+        })
         .accounts({
           // fund: fundPDA,
           // treasury: treasuryPDA,