Merge pull request #87 from metaplex-foundation/feat/move-data-offset

Move Data offset and length to the record level
metaplex-foundation · Apr 25, 2024 · 1c5583c · 1c5583c
2 parents 6d65cee + 2fbc51e
commit 1c5583c
Show file tree

Hide file tree

Showing 24 changed files with 78 additions and 94 deletions.
diff --git a/clients/js/src/generated/types/baseDataStore.ts b/clients/js/src/generated/types/baseDataStore.ts
@@ -6,7 +6,7 @@
  * @see https://github.com/metaplex-foundation/kinobi
  */
 
-import { Serializer, struct, u64 } from '@metaplex-foundation/umi/serializers';
+import { Serializer, struct } from '@metaplex-foundation/umi/serializers';
 import {
   BasePluginAuthority,
   BasePluginAuthorityArgs,
@@ -19,15 +19,11 @@ import {
 export type BaseDataStore = {
   dataAuthority: BasePluginAuthority;
   schema: ExternalPluginSchema;
-  dataOffset: bigint;
-  dataLen: bigint;
 };
 
 export type BaseDataStoreArgs = {
   dataAuthority: BasePluginAuthorityArgs;
   schema: ExternalPluginSchemaArgs;
-  dataOffset: number | bigint;
-  dataLen: number | bigint;
 };
 
 export function getBaseDataStoreSerializer(): Serializer<
@@ -38,8 +34,6 @@ export function getBaseDataStoreSerializer(): Serializer<
     [
       ['dataAuthority', getBasePluginAuthoritySerializer()],
       ['schema', getExternalPluginSchemaSerializer()],
-      ['dataOffset', u64()],
-      ['dataLen', u64()],
     ],
     { description: 'BaseDataStore' }
   ) as Serializer<BaseDataStoreArgs, BaseDataStore>;

diff --git a/clients/js/src/generated/types/baseExternalPluginInitInfo.ts b/clients/js/src/generated/types/baseExternalPluginInitInfo.ts
@@ -88,14 +88,14 @@ export function baseExternalPluginInitInfo(
   >['fields']
 ): GetDataEnumKind<BaseExternalPluginInitInfoArgs, 'DataStore'>;
 export function baseExternalPluginInitInfo<
-  K extends BaseExternalPluginInitInfoArgs['__kind']
+  K extends BaseExternalPluginInitInfoArgs['__kind'],
 >(kind: K, data?: any): Extract<BaseExternalPluginInitInfoArgs, { __kind: K }> {
   return Array.isArray(data)
     ? { __kind: kind, fields: data }
     : { __kind: kind, ...(data ?? {}) };
 }
 export function isBaseExternalPluginInitInfo<
-  K extends BaseExternalPluginInitInfo['__kind']
+  K extends BaseExternalPluginInitInfo['__kind'],
 >(
   kind: K,
   value: BaseExternalPluginInitInfo

diff --git a/clients/js/src/generated/types/baseExternalPluginKey.ts b/clients/js/src/generated/types/baseExternalPluginKey.ts
@@ -78,14 +78,14 @@ export function baseExternalPluginKey(
   data: GetDataEnumKindContent<BaseExternalPluginKeyArgs, 'DataStore'>['fields']
 ): GetDataEnumKind<BaseExternalPluginKeyArgs, 'DataStore'>;
 export function baseExternalPluginKey<
-  K extends BaseExternalPluginKeyArgs['__kind']
+  K extends BaseExternalPluginKeyArgs['__kind'],
 >(kind: K, data?: any): Extract<BaseExternalPluginKeyArgs, { __kind: K }> {
   return Array.isArray(data)
     ? { __kind: kind, fields: data }
     : { __kind: kind, ...(data ?? {}) };
 }
 export function isBaseExternalPluginKey<
-  K extends BaseExternalPluginKey['__kind']
+  K extends BaseExternalPluginKey['__kind'],
 >(
   kind: K,
   value: BaseExternalPluginKey

diff --git a/clients/js/src/generated/types/baseExternalPluginUpdateInfo.ts b/clients/js/src/generated/types/baseExternalPluginUpdateInfo.ts
@@ -91,7 +91,7 @@ export function baseExternalPluginUpdateInfo(
   >['fields']
 ): GetDataEnumKind<BaseExternalPluginUpdateInfoArgs, 'DataStore'>;
 export function baseExternalPluginUpdateInfo<
-  K extends BaseExternalPluginUpdateInfoArgs['__kind']
+  K extends BaseExternalPluginUpdateInfoArgs['__kind'],
 >(
   kind: K,
   data?: any
@@ -101,7 +101,7 @@ export function baseExternalPluginUpdateInfo<
     : { __kind: kind, ...(data ?? {}) };
 }
 export function isBaseExternalPluginUpdateInfo<
-  K extends BaseExternalPluginUpdateInfo['__kind']
+  K extends BaseExternalPluginUpdateInfo['__kind'],
 >(
   kind: K,
   value: BaseExternalPluginUpdateInfo

diff --git a/clients/js/src/generated/types/baseLifecycleHook.ts b/clients/js/src/generated/types/baseLifecycleHook.ts
@@ -13,7 +13,6 @@ import {
   option,
   publicKey as publicKeySerializer,
   struct,
-  u64,
 } from '@metaplex-foundation/umi/serializers';
 import {
   BaseExtraAccount,
@@ -32,17 +31,13 @@ export type BaseLifecycleHook = {
   extraAccounts: Option<Array<BaseExtraAccount>>;
   dataAuthority: Option<BasePluginAuthority>;
   schema: ExternalPluginSchema;
-  dataOffset: bigint;
-  dataLen: bigint;
 };
 
 export type BaseLifecycleHookArgs = {
   hookedProgram: PublicKey;
   extraAccounts: OptionOrNullable<Array<BaseExtraAccountArgs>>;
   dataAuthority: OptionOrNullable<BasePluginAuthorityArgs>;
   schema: ExternalPluginSchemaArgs;
-  dataOffset: number | bigint;
-  dataLen: number | bigint;
 };
 
 export function getBaseLifecycleHookSerializer(): Serializer<
@@ -55,8 +50,6 @@ export function getBaseLifecycleHookSerializer(): Serializer<
       ['extraAccounts', option(array(getBaseExtraAccountSerializer()))],
       ['dataAuthority', option(getBasePluginAuthoritySerializer())],
       ['schema', getExternalPluginSchemaSerializer()],
-      ['dataOffset', u64()],
-      ['dataLen', u64()],
     ],
     { description: 'BaseLifecycleHook' }
   ) as Serializer<BaseLifecycleHookArgs, BaseLifecycleHook>;

diff --git a/clients/js/src/generated/types/basePluginAuthority.ts b/clients/js/src/generated/types/basePluginAuthority.ts
@@ -60,7 +60,7 @@ export function basePluginAuthority(
   data: GetDataEnumKindContent<BasePluginAuthorityArgs, 'Address'>
 ): GetDataEnumKind<BasePluginAuthorityArgs, 'Address'>;
 export function basePluginAuthority<
-  K extends BasePluginAuthorityArgs['__kind']
+  K extends BasePluginAuthorityArgs['__kind'],
 >(kind: K, data?: any): Extract<BasePluginAuthorityArgs, { __kind: K }> {
   return Array.isArray(data)
     ? { __kind: kind, fields: data }

diff --git a/clients/js/src/generated/types/baseUpdateAuthority.ts b/clients/js/src/generated/types/baseUpdateAuthority.ts
@@ -62,7 +62,7 @@ export function baseUpdateAuthority(
   data: GetDataEnumKindContent<BaseUpdateAuthorityArgs, 'Collection'>['fields']
 ): GetDataEnumKind<BaseUpdateAuthorityArgs, 'Collection'>;
 export function baseUpdateAuthority<
-  K extends BaseUpdateAuthorityArgs['__kind']
+  K extends BaseUpdateAuthorityArgs['__kind'],
 >(kind: K, data?: any): Extract<BaseUpdateAuthorityArgs, { __kind: K }> {
   return Array.isArray(data)
     ? { __kind: kind, fields: data }

diff --git a/clients/js/src/generated/types/baseValidationResultsOffset.ts b/clients/js/src/generated/types/baseValidationResultsOffset.ts
@@ -61,7 +61,7 @@ export function baseValidationResultsOffset(
   >['fields']
 ): GetDataEnumKind<BaseValidationResultsOffsetArgs, 'Custom'>;
 export function baseValidationResultsOffset<
-  K extends BaseValidationResultsOffsetArgs['__kind']
+  K extends BaseValidationResultsOffsetArgs['__kind'],
 >(
   kind: K,
   data?: any
@@ -71,7 +71,7 @@ export function baseValidationResultsOffset<
     : { __kind: kind, ...(data ?? {}) };
 }
 export function isBaseValidationResultsOffset<
-  K extends BaseValidationResultsOffset['__kind']
+  K extends BaseValidationResultsOffset['__kind'],
 >(
   kind: K,
   value: BaseValidationResultsOffset

diff --git a/clients/js/src/generated/types/externalRegistryRecord.ts b/clients/js/src/generated/types/externalRegistryRecord.ts
@@ -35,6 +35,8 @@ export type ExternalRegistryRecord = {
   authority: BasePluginAuthority;
   lifecycleChecks: Option<Array<[HookableLifecycleEvent, ExternalCheckResult]>>;
   offset: bigint;
+  dataOffset: Option<bigint>;
+  dataLen: Option<bigint>;
 };
 
 export type ExternalRegistryRecordArgs = {
@@ -44,6 +46,8 @@ export type ExternalRegistryRecordArgs = {
     Array<[HookableLifecycleEventArgs, ExternalCheckResultArgs]>
   >;
   offset: number | bigint;
+  dataOffset: OptionOrNullable<number | bigint>;
+  dataLen: OptionOrNullable<number | bigint>;
 };
 
 export function getExternalRegistryRecordSerializer(): Serializer<
@@ -66,6 +70,8 @@ export function getExternalRegistryRecordSerializer(): Serializer<
         ),
       ],
       ['offset', u64()],
+      ['dataOffset', option(u64())],
+      ['dataLen', option(u64())],
     ],
     { description: 'ExternalRegistryRecord' }
   ) as Serializer<ExternalRegistryRecordArgs, ExternalRegistryRecord>;

diff --git a/clients/js/src/hooked/pluginRegistryV1Data.ts b/clients/js/src/hooked/pluginRegistryV1Data.ts
@@ -133,13 +133,18 @@ export function getExternalRegistryRecordSerializer(): Serializer<
         buffer,
         lifecycleChecksOffset
       );
+
+      const [dataOffset, dataOffsetOffset] = option(u64()).deserialize(buffer, pluginOffsetOffset);
+      const [dataLen] = option(u64()).deserialize(buffer, dataOffsetOffset);
       return [
         {
           pluginType,
           authority,
           lifecycleChecks,
           offset: pluginOffset,
           isUnknown,
+          dataOffset,
+          dataLen,
         },
         pluginOffsetOffset,
       ];

diff --git a/clients/js/src/instructions/create.ts b/clients/js/src/instructions/create.ts
@@ -61,8 +61,6 @@ export const create = (
             authority: plugin.initPluginAuthority || {
               type: 'UpdateAuthority',
             },
-            dataLen: 0n,
-            dataOffset: 0n,
             type: 'LifecycleHook',
             schema: plugin.schema || ExternalPluginSchema.Binary,
           });

diff --git a/clients/js/src/plugins/dataStore.ts b/clients/js/src/plugins/dataStore.ts
@@ -3,6 +3,7 @@ import {
   BaseDataStoreInitInfoArgs,
   BaseDataStoreUpdateInfoArgs,
   ExternalPluginSchema,
+  ExternalRegistryRecord,
 } from '../generated';
 import { ExternalPluginKey } from './externalPluginKey';
 import { ExternalPluginManifest } from './externalPluginManifest';
@@ -66,14 +67,13 @@ export function dataStoreUpdateInfoArgsToBase(
 
 export function dataStoreFromBase(
   s: BaseDataStore,
+  r: ExternalRegistryRecord,
   account: Uint8Array
 ): DataStore {
   return {
     ...s,
     dataAuthority: pluginAuthorityFromBase(s.dataAuthority),
-    dataOffset: s.dataOffset,
-    dataLen: s.dataLen,
-    data: parseExternalPluginData(s, account),
+    data: parseExternalPluginData(s, r, account),
   };
 }
 

diff --git a/clients/js/src/plugins/externalPluginManifest.ts b/clients/js/src/plugins/externalPluginManifest.ts
@@ -1,3 +1,4 @@
+import { ExternalRegistryRecord } from 'src/generated';
 import { ExternalPluginTypeString } from './externalPlugins';
 
 export type ExternalPluginManifest<
@@ -9,7 +10,7 @@ export type ExternalPluginManifest<
   UpdateBase extends Object
 > = {
   type: ExternalPluginTypeString;
-  fromBase: (input: Base, account: Uint8Array) => T;
+  fromBase: (input: Base, record: ExternalRegistryRecord, account: Uint8Array) => T;
   initToBase: (input: Init) => InitBase;
   updateToBase: (input: Update) => UpdateBase;
 };
diff --git a/clients/js/src/plugins/externalPlugins.ts b/clients/js/src/plugins/externalPlugins.ts
@@ -1,4 +1,4 @@
-import { AccountMeta, Context, PublicKey } from '@metaplex-foundation/umi';
+import { AccountMeta, Context, PublicKey, Option } from '@metaplex-foundation/umi';
 import {
   lifecycleHookFromBase,
   LifecycleHookInitInfoArgs,
@@ -50,25 +50,25 @@ export type ExternalPluginsList = {
 
 export type ExternalPluginInitInfoArgs =
   | ({
-      type: 'Oracle';
-    } & OracleInitInfoArgs)
+    type: 'Oracle';
+  } & OracleInitInfoArgs)
   | ({
-      type: 'LifecycleHook';
-    } & LifecycleHookInitInfoArgs)
+    type: 'LifecycleHook';
+  } & LifecycleHookInitInfoArgs)
   | ({
-      type: 'DataStore';
-    } & DataStoreInitInfoArgs);
+    type: 'DataStore';
+  } & DataStoreInitInfoArgs);
 
 export type ExternalPluginUpdateInfoArgs =
   | ({
-      type: 'Oracle';
-    } & OracleUpdateInfoArgs)
+    type: 'Oracle';
+  } & OracleUpdateInfoArgs)
   | ({
-      type: 'LifecycleHook';
-    } & LifecycleHookUpdateInfoArgs)
+    type: 'LifecycleHook';
+  } & LifecycleHookUpdateInfoArgs)
   | ({
-      type: 'DataStore';
-    } & DataStoreUpdateInfoArgs);
+    type: 'DataStore';
+  } & DataStoreUpdateInfoArgs);
 
 export const externalPluginManifests = {
   Oracle: oracleManifest,
@@ -110,7 +110,7 @@ export function externalRegistryRecordsToExternalPluginList(
       result.oracles.push({
         type: 'Oracle',
         ...mappedPlugin,
-        ...oracleFromBase(deserializedPlugin.fields[0], accountData),
+        ...oracleFromBase(deserializedPlugin.fields[0], record, accountData),
       });
     } else if (deserializedPlugin.__kind === 'DataStore') {
       if (!result.dataStores) {
@@ -119,7 +119,7 @@ export function externalRegistryRecordsToExternalPluginList(
       result.dataStores.push({
         type: 'DataStore',
         ...mappedPlugin,
-        ...dataStoreFromBase(deserializedPlugin.fields[0], accountData),
+        ...dataStoreFromBase(deserializedPlugin.fields[0], record, accountData),
       });
     } else if (deserializedPlugin.__kind === 'LifecycleHook') {
       if (!result.lifecycleHooks) {
@@ -128,7 +128,7 @@ export function externalRegistryRecordsToExternalPluginList(
       result.lifecycleHooks.push({
         type: 'LifecycleHook',
         ...mappedPlugin,
-        ...lifecycleHookFromBase(deserializedPlugin.fields[0], accountData),
+        ...lifecycleHookFromBase(deserializedPlugin.fields[0], record, accountData),
       });
     }
   });
@@ -232,15 +232,17 @@ export const findExtraAccounts = (
 export function parseExternalPluginData(
   plugin: {
     schema: ExternalPluginSchema;
-    dataLen: bigint | number;
-    dataOffset: bigint | number;
+  },
+  record: {
+    dataLen: Option<bigint | number>;
+    dataOffset: Option<bigint | number>;
   },
   account: Uint8Array
 ): any {
   let data;
   const dataSlice = account.slice(
-    Number(plugin.dataOffset),
-    Number(plugin.dataOffset) + Number(plugin.dataLen)
+    Number(record.dataOffset),
+    Number(record.dataOffset) + Number(record.dataLen)
   );
 
   if (plugin.schema === ExternalPluginSchema.Binary) {

diff --git a/clients/js/src/plugins/lifecycleHook.ts b/clients/js/src/plugins/lifecycleHook.ts
@@ -9,6 +9,7 @@ import {
   BaseLifecycleHookInitInfoArgs,
   BaseLifecycleHookUpdateInfoArgs,
   ExternalPluginSchema,
+  ExternalRegistryRecord,
 } from '../generated';
 import { LifecycleChecks, lifecycleChecksToBase } from './lifecycleChecks';
 import {
@@ -95,17 +96,16 @@ export function lifecycleHookUpdateInfoArgsToBase(
 
 export function lifecycleHookFromBase(
   s: BaseLifecycleHook,
+  r: ExternalRegistryRecord,
   account: Uint8Array
 ): LifecycleHook {
   return {
     ...s,
-    dataOffset: s.dataOffset,
-    dataLen: s.dataLen,
     extraAccounts:
       s.extraAccounts.__option === 'Some'
         ? s.extraAccounts.value.map(extraAccountFromBase)
         : undefined,
-    data: parseExternalPluginData(s, account),
+    data: parseExternalPluginData(s, r, account),
     dataAuthority:
       s.dataAuthority.__option === 'Some'
         ? pluginAuthorityFromBase(s.dataAuthority.value)

diff --git a/clients/js/src/plugins/oracle.ts b/clients/js/src/plugins/oracle.ts
@@ -7,6 +7,7 @@ import {
   BaseOracle,
   BaseOracleInitInfoArgs,
   BaseOracleUpdateInfoArgs,
+  ExternalRegistryRecord,
 } from '../generated';
 import { LifecycleChecks, lifecycleChecksToBase } from './lifecycleChecks';
 import { PluginAuthority, pluginAuthorityToBase } from './pluginAuthority';
@@ -82,7 +83,7 @@ export function oracleUpdateInfoArgsToBase(
   };
 }
 
-export function oracleFromBase(s: BaseOracle, account: Uint8Array): Oracle {
+export function oracleFromBase(s: BaseOracle, r: ExternalRegistryRecord, account: Uint8Array): Oracle {
   return {
     ...s,
     pda:

diff --git a/clients/rust/src/generated/types/data_store.rs b/clients/rust/src/generated/types/data_store.rs
@@ -15,6 +15,4 @@ use borsh::BorshSerialize;
 pub struct DataStore {
     pub data_authority: PluginAuthority,
     pub schema: ExternalPluginSchema,
-    pub data_offset: u64,
-    pub data_len: u64,
 }