Add stackHeight to the instruction type

solana-labs · Jun 27, 2024 · 251f9ab · 251f9ab
1 parent f1baa9e
commit 251f9ab
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 92 deletions.
diff --git a/packages/rpc-api/src/getTransaction.ts b/packages/rpc-api/src/getTransaction.ts
@@ -73,6 +73,7 @@ type TransactionInstruction = Readonly<{
     accounts: readonly number[];
     data: Base58EncodedBytes;
     programIdIndex: number;
+    stackHeight?: number;
 }>;
 
 type TransactionJson = Readonly<{
@@ -92,6 +93,7 @@ type PartiallyDecodedTransactionInstruction = Readonly<{
     accounts: readonly Address[];
     data: Base58EncodedBytes;
     programId: Address;
+    stackHeight?: number;
 }>;
 
 type ParsedTransactionInstruction = Readonly<{
@@ -101,6 +103,7 @@ type ParsedTransactionInstruction = Readonly<{
     };
     program: string;
     programId: Address;
+    stackHeight?: number;
 }>;
 
 type TransactionJsonParsed = Readonly<{

diff --git a/packages/rpc-api/src/index.ts b/packages/rpc-api/src/index.ts
@@ -3,9 +3,12 @@ import {
     AllowedNumericKeypaths,
     getDefaultParamsTransformerForSolanaRpc,
     getDefaultResponseTransformerForSolanaRpc,
+    innerInstructionsConfigs,
+    instructionConfig,
     jsonParsedAccountsConfigs,
     jsonParsedTokenAccountsConfigs,
     KEYPATH_WILDCARD,
+    messageConfig,
     ParamsTransformerConfig,
 } from '@solana/rpc-transformers';
 
@@ -223,70 +226,15 @@ function getAllowedNumericKeypaths(): AllowedNumericKeypaths<RpcApi<SolanaRpcApi
                     'decimals',
                 ],
                 ['transactions', KEYPATH_WILDCARD, 'meta', 'rewards', KEYPATH_WILDCARD, 'commission'],
-                ['transactions', KEYPATH_WILDCARD, 'meta', 'innerInstructions', KEYPATH_WILDCARD, 'index'],
-                [
+                ...innerInstructionsConfigs.map(c => [
                     'transactions',
                     KEYPATH_WILDCARD,
                     'meta',
                     'innerInstructions',
                     KEYPATH_WILDCARD,
-                    'instructions',
-                    KEYPATH_WILDCARD,
-                    'programIdIndex',
-                ],
-                [
-                    'transactions',
-                    KEYPATH_WILDCARD,
-                    'meta',
-                    'innerInstructions',
-                    KEYPATH_WILDCARD,
-                    'instructions',
-                    KEYPATH_WILDCARD,
-                    'accounts',
-                    KEYPATH_WILDCARD,
-                ],
-                [
-                    'transactions',
-                    KEYPATH_WILDCARD,
-                    'transaction',
-                    'message',
-                    'addressTableLookups',
-                    KEYPATH_WILDCARD,
-                    'writableIndexes',
-                    KEYPATH_WILDCARD,
-                ],
-                [
-                    'transactions',
-                    KEYPATH_WILDCARD,
-                    'transaction',
-                    'message',
-                    'addressTableLookups',
-                    KEYPATH_WILDCARD,
-                    'readonlyIndexes',
-                    KEYPATH_WILDCARD,
-                ],
-                [
-                    'transactions',
-                    KEYPATH_WILDCARD,
-                    'transaction',
-                    'message',
-                    'instructions',
-                    KEYPATH_WILDCARD,
-                    'programIdIndex',
-                ],
-                [
-                    'transactions',
-                    KEYPATH_WILDCARD,
-                    'transaction',
-                    'message',
-                    'instructions',
-                    KEYPATH_WILDCARD,
-                    'accounts',
-                    KEYPATH_WILDCARD,
-                ],
-                ['transactions', KEYPATH_WILDCARD, 'transaction', 'message', 'header', 'numReadonlySignedAccounts'],
-                ['transactions', KEYPATH_WILDCARD, 'transaction', 'message', 'header', 'numReadonlyUnsignedAccounts'],
-                ['transactions', KEYPATH_WILDCARD, 'transaction', 'message', 'header', 'numRequiredSignatures'],
+                    ...c,
+                ]),
+                ...messageConfig.map(c => ['transactions', KEYPATH_WILDCARD, 'transaction', 'message', ...c] as const),
                 ['rewards', KEYPATH_WILDCARD, 'commission'],
             ],
             getBlockTime: [[]],
@@ -333,45 +281,18 @@ function getAllowedNumericKeypaths(): AllowedNumericKeypaths<RpcApi<SolanaRpcApi
                 ['meta', 'postTokenBalances', KEYPATH_WILDCARD, 'accountIndex'],
                 ['meta', 'postTokenBalances', KEYPATH_WILDCARD, 'uiTokenAmount', 'decimals'],
                 ['meta', 'rewards', KEYPATH_WILDCARD, 'commission'],
-                ['meta', 'innerInstructions', KEYPATH_WILDCARD, 'index'],
-                ['meta', 'innerInstructions', KEYPATH_WILDCARD, 'instructions', KEYPATH_WILDCARD, 'programIdIndex'],
-                [
-                    'meta',
-                    'innerInstructions',
-                    KEYPATH_WILDCARD,
-                    'instructions',
-                    KEYPATH_WILDCARD,
-                    'accounts',
-                    KEYPATH_WILDCARD,
-                ],
-                [
-                    'transaction',
-                    'message',
-                    'addressTableLookups',
-                    KEYPATH_WILDCARD,
-                    'writableIndexes',
-                    KEYPATH_WILDCARD,
-                ],
-                [
-                    'transaction',
-                    'message',
-                    'addressTableLookups',
-                    KEYPATH_WILDCARD,
-                    'readonlyIndexes',
-                    KEYPATH_WILDCARD,
-                ],
-                ['transaction', 'message', 'instructions', KEYPATH_WILDCARD, 'programIdIndex'],
-                ['transaction', 'message', 'instructions', KEYPATH_WILDCARD, 'accounts', KEYPATH_WILDCARD],
-                ['transaction', 'message', 'header', 'numReadonlySignedAccounts'],
-                ['transaction', 'message', 'header', 'numReadonlyUnsignedAccounts'],
-                ['transaction', 'message', 'header', 'numRequiredSignatures'],
+                ...innerInstructionsConfigs.map(c => ['meta', 'innerInstructions', KEYPATH_WILDCARD, ...c]),
+                ...messageConfig.map(c => ['transaction', 'message', ...c] as const),
             ],
             getVersion: [['feature-set']],
             getVoteAccounts: [
                 ['current', KEYPATH_WILDCARD, 'commission'],
                 ['delinquent', KEYPATH_WILDCARD, 'commission'],
             ],
-            simulateTransaction: jsonParsedAccountsConfigs.map(c => ['value', 'accounts', KEYPATH_WILDCARD, ...c]),
+            simulateTransaction: [
+                ...jsonParsedAccountsConfigs.map(c => ['value', 'accounts', KEYPATH_WILDCARD, ...c]),
+                ...innerInstructionsConfigs.map(c => ['value', 'innerInstructions', KEYPATH_WILDCARD, ...c]),
+            ],
         };
     }
     return memoizedKeypaths;

diff --git a/packages/rpc-transformers/src/response-transformer-allowed-numeric-values.ts b/packages/rpc-transformers/src/response-transformer-allowed-numeric-values.ts
@@ -37,3 +37,16 @@ export const jsonParsedAccountsConfigs = [
     ['data', 'parsed', 'info', 'commission'],
     ['data', 'parsed', 'info', 'votes', KEYPATH_WILDCARD, 'confirmationCount'],
 ];
+export const instructionConfig = [['accounts', KEYPATH_WILDCARD], ['programIdIndex'], ['stackHeight']];
+export const innerInstructionsConfigs = [
+    ['index'],
+    ...instructionConfig.map(c => ['instructions', KEYPATH_WILDCARD, ...c]),
+];
+export const messageConfig = [
+    ['addressTableLookups', KEYPATH_WILDCARD, 'writableIndexes', KEYPATH_WILDCARD],
+    ['addressTableLookups', KEYPATH_WILDCARD, 'readonlyIndexes', KEYPATH_WILDCARD],
+    ...instructionConfig.map(c => ['instructions', KEYPATH_WILDCARD, ...c]),
+    ['header', 'numReadonlySignedAccounts'],
+    ['header', 'numReadonlyUnsignedAccounts'],
+    ['header', 'numRequiredSignatures'],
+] as const;
diff --git a/packages/rpc-types/src/transaction.ts b/packages/rpc-types/src/transaction.ts
@@ -25,12 +25,14 @@ type ParsedTransactionInstruction = Readonly<{
     };
     program: string;
     programId: Address;
+    stackHeight?: number;
 }>;
 
 type PartiallyDecodedTransactionInstruction = Readonly<{
     accounts: readonly Address[];
     data: Base58EncodedBytes;
     programId: Address;
+    stackHeight?: number;
 }>;
 
 type ReturnData = {
@@ -44,6 +46,7 @@ type TransactionInstruction = Readonly<{
     accounts: readonly number[];
     data: Base58EncodedBytes;
     programIdIndex: number;
+    stackHeight?: number;
 }>;
 
 type TransactionParsedAccountLegacy = Readonly<{