Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add stackHeight to the instruction type #2866

Merged
merged 1 commit into from
Jun 28, 2024
Merged

Add stackHeight to the instruction type #2866

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/sharp-steaks-admire.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@solana/rpc-types': patch
'@solana/rpc-api': patch
---

The `TransactionInstruction` RPC type now has `stackHeight`
2 changes: 2 additions & 0 deletions packages/rpc-api/src/__typetests__/get-block-type-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,6 +512,7 @@ async () => {
accounts: readonly number[];
data: Base58EncodedBytes;
programIdIndex: number;
stackHeight?: number;
}>[];
}>[];
logMessages: readonly string[] | null;
Expand Down Expand Up @@ -736,6 +737,7 @@ async () => {
accounts: readonly number[];
data: Base58EncodedBytes;
programIdIndex: number;
stackHeight?: number;
}>[];
}>[];
logMessages: readonly string[] | null;
Expand Down
3 changes: 3 additions & 0 deletions packages/rpc-api/src/getTransaction.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ type TransactionInstruction = Readonly<{
accounts: readonly number[];
data: Base58EncodedBytes;
programIdIndex: number;
stackHeight?: number;
}>;

type TransactionJson = Readonly<{
Expand All @@ -92,6 +93,7 @@ type PartiallyDecodedTransactionInstruction = Readonly<{
accounts: readonly Address[];
data: Base58EncodedBytes;
programId: Address;
stackHeight?: number;
}>;

type ParsedTransactionInstruction = Readonly<{
Expand All @@ -101,6 +103,7 @@ type ParsedTransactionInstruction = Readonly<{
};
program: string;
programId: Address;
stackHeight?: number;
}>;

type TransactionJsonParsed = Readonly<{
Expand Down
104 changes: 12 additions & 92 deletions packages/rpc-api/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@ import {
AllowedNumericKeypaths,
getDefaultParamsTransformerForSolanaRpc,
getDefaultResponseTransformerForSolanaRpc,
innerInstructionsConfigs,
jsonParsedAccountsConfigs,
jsonParsedTokenAccountsConfigs,
KEYPATH_WILDCARD,
messageConfig,
ParamsTransformerConfig,
} from '@solana/rpc-transformers';

Expand Down Expand Up @@ -223,70 +225,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: [[]],
Expand Down Expand Up @@ -333,45 +280,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;
Expand Down
2 changes: 2 additions & 0 deletions packages/rpc-subscriptions-api/src/__typetests__/block-notifications-type-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -724,6 +724,7 @@ type ExpectedMetaForFullBase58 = {
accounts: readonly number[];
data: Base58EncodedBytes;
programIdIndex: number;
stackHeight?: number;
}>[];
}>[];
logMessages: readonly string[] | null;
Expand Down Expand Up @@ -990,6 +991,7 @@ type ExpectedMetaForFullBase64 = {
accounts: readonly number[];
data: Base58EncodedBytes;
programIdIndex: number;
stackHeight?: number;
}>[];
}>[];
logMessages: readonly string[] | null;
Expand Down
16 changes: 16 additions & 0 deletions packages/rpc-transformers/src/response-transformer-allowed-numeric-values.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,19 @@ export const jsonParsedAccountsConfigs = [
['data', 'parsed', 'info', 'commission'],
['data', 'parsed', 'info', 'votes', KEYPATH_WILDCARD, 'confirmationCount'],
];
export const innerInstructionsConfigs = [
['index'],
['instructions', KEYPATH_WILDCARD, 'accounts', KEYPATH_WILDCARD],
['instructions', KEYPATH_WILDCARD, 'programIdIndex'],
['instructions', KEYPATH_WILDCARD, 'stackHeight'],
];
export const messageConfig = [
['addressTableLookups', KEYPATH_WILDCARD, 'writableIndexes', KEYPATH_WILDCARD],
['addressTableLookups', KEYPATH_WILDCARD, 'readonlyIndexes', KEYPATH_WILDCARD],
['header', 'numReadonlySignedAccounts'],
['header', 'numReadonlyUnsignedAccounts'],
['header', 'numRequiredSignatures'],
['instructions', KEYPATH_WILDCARD, 'accounts', KEYPATH_WILDCARD],
['instructions', KEYPATH_WILDCARD, 'programIdIndex'],
['instructions', KEYPATH_WILDCARD, 'stackHeight'],
Comment on lines +52 to +54
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would have DRY'd these up too, but using foo.map() in this file at the top level would break tree-shakability.

] as const;
3 changes: 3 additions & 0 deletions packages/rpc-types/src/transaction.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand All @@ -44,6 +46,7 @@ type TransactionInstruction = Readonly<{
accounts: readonly number[];
data: Base58EncodedBytes;
programIdIndex: number;
stackHeight?: number;
}>;

type TransactionParsedAccountLegacy = Readonly<{
Expand Down