@metaplex-foundation/kinobi 0.5.0 → 0.7.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. package/dist/cjs/nodes/InstructionNode.js +53 -15
  2. package/dist/cjs/nodes/InstructionNode.js.map +1 -1
  3. package/dist/cjs/renderers/js/GetJavaScriptRenderMapVisitor.js +84 -28
  4. package/dist/cjs/renderers/js/GetJavaScriptRenderMapVisitor.js.map +1 -1
  5. package/dist/cjs/renderers/js/GetJavaScriptTypeManifestVisitor.js +3 -0
  6. package/dist/cjs/renderers/js/GetJavaScriptTypeManifestVisitor.js.map +1 -1
  7. package/dist/cjs/renderers/js/GetJavaScriptValidatorBagVisitor.js +2 -0
  8. package/dist/cjs/renderers/js/GetJavaScriptValidatorBagVisitor.js.map +1 -1
  9. package/dist/cjs/renderers/js/templates/instructionsPage.njk +11 -24
  10. package/dist/cjs/renderers/js/templates/instructionsPageAccountMetas.njk +8 -51
  11. package/dist/cjs/renderers/js/templates/instructionsPageArgs.njk +34 -5
  12. package/dist/cjs/renderers/js/templates/instructionsPageResolvedInputs.njk +63 -0
  13. package/dist/cjs/renderers/js/templates/programsPage.njk +12 -2
  14. package/dist/cjs/visitors/BaseNodeOrNullVisitor.js +6 -1
  15. package/dist/cjs/visitors/BaseNodeOrNullVisitor.js.map +1 -1
  16. package/dist/cjs/visitors/BaseNodeVisitor.js +6 -1
  17. package/dist/cjs/visitors/BaseNodeVisitor.js.map +1 -1
  18. package/dist/cjs/visitors/BaseVoidVisitor.js +2 -0
  19. package/dist/cjs/visitors/BaseVoidVisitor.js.map +1 -1
  20. package/dist/cjs/visitors/aggregators/GetDefaultValidatorBagVisitor.js +32 -2
  21. package/dist/cjs/visitors/aggregators/GetDefaultValidatorBagVisitor.js.map +1 -1
  22. package/dist/cjs/visitors/aggregators/GetNodeInlineStringVisitor.js +4 -2
  23. package/dist/cjs/visitors/aggregators/GetNodeInlineStringVisitor.js.map +1 -1
  24. package/dist/cjs/visitors/aggregators/GetNodeTreeStringVisitor.js +6 -0
  25. package/dist/cjs/visitors/aggregators/GetNodeTreeStringVisitor.js.map +1 -1
  26. package/dist/cjs/visitors/aggregators/GetResolvedInstructionInputsVisitor.js +201 -0
  27. package/dist/cjs/visitors/aggregators/GetResolvedInstructionInputsVisitor.js.map +1 -0
  28. package/dist/cjs/visitors/aggregators/index.js +1 -1
  29. package/dist/cjs/visitors/aggregators/index.js.map +1 -1
  30. package/dist/cjs/visitors/transformers/AutoSetAnchorDiscriminatorsVisitor.js +1 -1
  31. package/dist/cjs/visitors/transformers/AutoSetAnchorDiscriminatorsVisitor.js.map +1 -1
  32. package/dist/cjs/visitors/transformers/CreateSubInstructionsFromEnumArgsVisitor.js +2 -2
  33. package/dist/cjs/visitors/transformers/CreateSubInstructionsFromEnumArgsVisitor.js.map +1 -1
  34. package/dist/cjs/visitors/transformers/FlattenInstructionArgsStructVisitor.js +1 -1
  35. package/dist/cjs/visitors/transformers/FlattenInstructionArgsStructVisitor.js.map +1 -1
  36. package/dist/cjs/visitors/transformers/SetInstructionAccountDefaultValuesVisitor.js +1 -1
  37. package/dist/cjs/visitors/transformers/SetInstructionAccountDefaultValuesVisitor.js.map +1 -1
  38. package/dist/cjs/visitors/transformers/SetInstructionDiscriminatorsVisitor.js +1 -1
  39. package/dist/cjs/visitors/transformers/SetInstructionDiscriminatorsVisitor.js.map +1 -1
  40. package/dist/cjs/visitors/transformers/UpdateInstructionsVisitor.js +8 -5
  41. package/dist/cjs/visitors/transformers/UpdateInstructionsVisitor.js.map +1 -1
  42. package/dist/cjs/visitors/transformers/UseCustomInstructionSerializerVisitor.js +1 -1
  43. package/dist/cjs/visitors/transformers/UseCustomInstructionSerializerVisitor.js.map +1 -1
  44. package/dist/types/idl/IdlInstruction.d.ts +0 -1
  45. package/dist/types/nodes/InstructionNode.d.ts +53 -14
  46. package/dist/types/renderers/js/GetJavaScriptRenderMapVisitor.d.ts +10 -2
  47. package/dist/types/renderers/js/GetJavaScriptTypeManifestVisitor.d.ts +1 -0
  48. package/dist/types/visitors/aggregators/GetResolvedInstructionInputsVisitor.d.ts +41 -0
  49. package/dist/types/visitors/aggregators/index.d.ts +1 -1
  50. package/dist/types/visitors/transformers/UpdateInstructionsVisitor.d.ts +7 -2
  51. package/package.json +1 -1
  52. package/src/idl/IdlInstruction.ts +0 -1
  53. package/src/nodes/InstructionNode.ts +99 -21
  54. package/src/renderers/js/GetJavaScriptRenderMapVisitor.ts +106 -37
  55. package/src/renderers/js/GetJavaScriptTypeManifestVisitor.ts +6 -0
  56. package/src/renderers/js/GetJavaScriptValidatorBagVisitor.ts +2 -0
  57. package/src/renderers/js/templates/instructionsPage.njk +11 -24
  58. package/src/renderers/js/templates/instructionsPageAccountMetas.njk +8 -51
  59. package/src/renderers/js/templates/instructionsPageArgs.njk +34 -5
  60. package/src/renderers/js/templates/instructionsPageResolvedInputs.njk +63 -0
  61. package/src/renderers/js/templates/programsPage.njk +12 -2
  62. package/src/visitors/BaseNodeOrNullVisitor.ts +5 -0
  63. package/src/visitors/BaseNodeVisitor.ts +5 -0
  64. package/src/visitors/BaseVoidVisitor.ts +1 -0
  65. package/src/visitors/aggregators/GetDefaultValidatorBagVisitor.ts +48 -2
  66. package/src/visitors/aggregators/GetNodeInlineStringVisitor.ts +3 -2
  67. package/src/visitors/aggregators/GetNodeTreeStringVisitor.ts +6 -0
  68. package/src/visitors/aggregators/GetResolvedInstructionInputsVisitor.ts +275 -0
  69. package/src/visitors/aggregators/index.ts +1 -1
  70. package/src/visitors/transformers/AutoSetAnchorDiscriminatorsVisitor.ts +1 -0
  71. package/src/visitors/transformers/CreateSubInstructionsFromEnumArgsVisitor.ts +2 -0
  72. package/src/visitors/transformers/FlattenInstructionArgsStructVisitor.ts +1 -0
  73. package/src/visitors/transformers/SetInstructionAccountDefaultValuesVisitor.ts +1 -0
  74. package/src/visitors/transformers/SetInstructionDiscriminatorsVisitor.ts +1 -0
  75. package/src/visitors/transformers/UpdateInstructionsVisitor.ts +19 -14
  76. package/src/visitors/transformers/UseCustomInstructionSerializerVisitor.ts +1 -0
  77. package/dist/cjs/visitors/aggregators/GetResolvedInstructionAccountsVisitor.js +0 -123
  78. package/dist/cjs/visitors/aggregators/GetResolvedInstructionAccountsVisitor.js.map +0 -1
  79. package/dist/types/visitors/aggregators/GetResolvedInstructionAccountsVisitor.d.ts +0 -18
  80. package/src/visitors/aggregators/GetResolvedInstructionAccountsVisitor.ts +0 -155
@@ -1,155 +0,0 @@
1
- import type * as nodes from '../../nodes';
2
- import { InstructionNodeAccountDefaultsSeed } from '../../nodes';
3
- import { BaseThrowVisitor } from '../BaseThrowVisitor';
4
-
5
- export type ResolvedInstructionAccount = nodes.InstructionNodeAccount & {
6
- position: number;
7
- dependencyPosition: number;
8
- dependsOn: string[];
9
- resolvedIsSigner: boolean | 'either';
10
- resolvedIsOptional: boolean;
11
- };
12
-
13
- export class GetResolvedInstructionAccountsVisitor extends BaseThrowVisitor<
14
- ResolvedInstructionAccount[]
15
- > {
16
- protected stack: string[] = [];
17
-
18
- protected visited = new Map<string, ResolvedInstructionAccount>();
19
-
20
- protected raw = new Map<string, [nodes.InstructionNodeAccount, number]>();
21
-
22
- protected error: string | null = null;
23
-
24
- getError(): string | null {
25
- return this.error;
26
- }
27
-
28
- visitInstruction(
29
- instruction: nodes.InstructionNode
30
- ): ResolvedInstructionAccount[] {
31
- // Ensure we always start with a clean slate.
32
- this.error = null;
33
- this.stack = [];
34
- this.visited = new Map();
35
- this.raw = instruction.accounts.reduce(
36
- (map, account, index) => map.set(account.name, [account, index]),
37
- new Map<string, [nodes.InstructionNodeAccount, number]>()
38
- );
39
-
40
- // Visit all instruction accounts.
41
- this.raw.forEach(([account, index]) => {
42
- this.handleInstructionAccount(instruction, account, index);
43
- });
44
-
45
- return [...this.visited.values()].sort((a, b) => a.position - b.position);
46
- }
47
-
48
- handleInstructionAccount(
49
- instruction: nodes.InstructionNode,
50
- account: nodes.InstructionNodeAccount,
51
- index: number
52
- ): void {
53
- // Ensure we don't visit the same account twice.
54
- if (this.visited.has(account.name)) {
55
- return;
56
- }
57
-
58
- // Ensure we don't have a circular dependency.
59
- if (this.stack.includes(account.name)) {
60
- const cycle = [...this.stack, account.name].join(' -> ');
61
- this.error =
62
- `Circular dependency detected in the accounts of ` +
63
- `the "${instruction.name}" instruction. ` +
64
- `Got the following account dependency cycle: ${cycle}.`;
65
- throw new Error(this.error);
66
- }
67
-
68
- // Get account dependencies.
69
- const dependsOn: string[] = [];
70
- if (account.defaultsTo?.kind === 'account') {
71
- dependsOn.push(account.defaultsTo.name);
72
- } else if (account.defaultsTo?.kind === 'pda') {
73
- type AccountSeed = Extract<
74
- InstructionNodeAccountDefaultsSeed,
75
- { kind: 'account' }
76
- >;
77
- const accounts = Object.values(account.defaultsTo.seeds)
78
- .filter((seed): seed is AccountSeed => seed.kind === 'account')
79
- .map((seed) => seed.name);
80
- dependsOn.push(...new Set(accounts));
81
- }
82
-
83
- // Visit account dependencies first.
84
- this.stack.push(account.name);
85
- dependsOn.forEach((name) => {
86
- const rawDependency = this.raw.get(name);
87
- if (!rawDependency) {
88
- this.error =
89
- `Account "${name}" is not a valid dependency of account ` +
90
- `"${account.name}" in the "${instruction.name}" instruction.`;
91
- throw new Error(this.error);
92
- }
93
- const [dependency, dependencyIndex] = rawDependency;
94
- this.handleInstructionAccount(instruction, dependency, dependencyIndex);
95
- });
96
- this.stack.pop();
97
-
98
- const resolved: ResolvedInstructionAccount = {
99
- ...account,
100
- position: index,
101
- dependencyPosition: this.visited.size,
102
- dependsOn,
103
- resolvedIsSigner: account.isSigner,
104
- resolvedIsOptional: account.isOptional,
105
- };
106
-
107
- switch (resolved.defaultsTo?.kind) {
108
- case 'account':
109
- const defaultAccount = this.visited.get(resolved.defaultsTo.name)!;
110
- const resolvedIsPublicKey =
111
- account.isSigner === false && defaultAccount.isSigner === false;
112
- const resolvedIsSigner =
113
- account.isSigner === true && defaultAccount.isSigner === true;
114
- const resolvedIsOptionalSigner =
115
- !resolvedIsPublicKey && !resolvedIsSigner;
116
- resolved.resolvedIsSigner = resolvedIsOptionalSigner
117
- ? 'either'
118
- : resolvedIsSigner;
119
- resolved.resolvedIsOptional = defaultAccount.isOptional;
120
- break;
121
- case 'publicKey':
122
- case 'program':
123
- case 'programId':
124
- resolved.resolvedIsSigner =
125
- account.isSigner === false ? false : 'either';
126
- resolved.resolvedIsOptional = false;
127
- break;
128
- case 'pda':
129
- resolved.resolvedIsSigner =
130
- account.isSigner === false ? false : 'either';
131
- resolved.resolvedIsOptional = false;
132
- const { seeds } = resolved.defaultsTo;
133
- Object.keys(seeds).forEach((seedKey) => {
134
- const seed = seeds[seedKey];
135
- if (seed.kind !== 'account') return;
136
- const dependency = this.visited.get(seed.name)!;
137
- if (dependency.resolvedIsOptional) {
138
- this.error =
139
- `Cannot use optional account "${seed.name}" as the "${seedKey}" PDA seed ` +
140
- `for the "${account.name}" account of the "${instruction.name}" instruction.`;
141
- throw new Error(this.error);
142
- }
143
- });
144
- break;
145
- case 'identity':
146
- case 'payer':
147
- resolved.resolvedIsOptional = false;
148
- break;
149
- default:
150
- break;
151
- }
152
-
153
- this.visited.set(account.name, resolved);
154
- }
155
- }