@metaplex-foundation/kinobi 0.16.7 → 0.16.9

package/dist/cjs/renderers/js/templates/instructionsPage.njk

@@ -39,7 +39,7 @@ export function {{ instruction.name | camelCase }}(
   // Accounts.
   const resolvedAccounts = {
     {% for account in accounts %}
-      {{ account.name | camelCase }}: { index: {{ loop.index0 }}, isWritable: {{ 'true' if account.isWritable else 'false' }}, value: {{ accountsObj }}.{{ account.name | camelCase }} ?? null },
+      {{ account.name | camelCase }}: { index: {{ loop.index0 }}, isWritable: {{ 'true' if account.isWritable else 'false' }} as boolean, value: {{ accountsObj }}.{{ account.name | camelCase }} ?? null },
     {% endfor %}
   } satisfies ResolvedAccountsWithIndices;
 

package/dist/cjs/renderers/rust/templates/instructionsCpiPageBuilder.njk

@@ -1,4 +1,20 @@
-/// `{{ instruction.name | snakeCase }}` CPI instruction builder.
+/// Instruction builder for `{{ instruction.name | pascalCase }}` via CPI.
+///
+/// ### Accounts:
+///
+{% for account in instruction.accounts %}
+  {% set modifiers = '' %}
+  {% if account.isWritable %}
+    {% set modifiers = 'writable' %}
+  {% endif %}
+  {% if account.isSigner %}
+    {% set modifiers = modifiers + ', signer' if modifiers.length > 0 else 'signer' %}
+  {% endif %}
+  {% if account.isOptional %}
+    {% set modifiers = modifiers + ', optional' if modifiers.length > 0 else 'optional' %}
+  {% endif %}
+  {{ '///   ' + loop.index0 + '. `[' + modifiers + ']` ' + account.name | snakeCase }}
+{% endfor %}
 pub struct {{ instruction.name | pascalCase }}CpiBuilder<'a, 'b> {
   instruction: Box<{{ instruction.name | pascalCase }}CpiBuilderInstruction<'a, 'b>>,
 }

package/dist/cjs/renderers/rust/templates/instructionsPageBuilder.njk

@@ -1,4 +1,22 @@
-/// Instruction builder.
+/// Instruction builder for `{{ instruction.name | pascalCase }}`.
+///
+/// ### Accounts:
+///
+{% for account in instruction.accounts %}
+  {% set modifiers = '' %}
+  {% if account.isWritable %}
+    {% set modifiers = 'writable' %}
+  {% endif %}
+  {% if account.isSigner %}
+    {% set modifiers = modifiers + ', signer' if modifiers.length > 0 else 'signer' %}
+  {% endif %}
+  {% if account.isOptional or account.defaultsTo.kind === 'program' or account.defaultsTo.kind === 'publicKey' %}
+    {% set modifiers = modifiers + ', optional' if modifiers.length > 0 else 'optional' %}
+  {% endif %}
+  {{ '///   ' + loop.index0 + '. `[' + modifiers + ']` ' + account.name | snakeCase }}
+  {{- " (default to `" + account.defaultsTo.program.publicKey + "`)" if account.defaultsTo.kind === 'program' }}
+  {{- " (default to `" + account.defaultsTo.publicKey + "`)" if account.defaultsTo.kind === 'publicKey' }}
+{% endfor %}
 #[derive(Default)]
 pub struct {{ instruction.name | pascalCase }}Builder {
   {% for account in instruction.accounts %}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metaplex-foundation/kinobi",
-  "version": "0.16.7",
+  "version": "0.16.9",
   "description": "Generate powerful clients for your Solana programs",
   "main": "dist/cjs/index.js",
   "types": "dist/types/index.d.ts",

package/src/renderers/js/templates/instructionsPage.njk

@@ -39,7 +39,7 @@ export function {{ instruction.name | camelCase }}(
   // Accounts.
   const resolvedAccounts = {
     {% for account in accounts %}
-      {{ account.name | camelCase }}: { index: {{ loop.index0 }}, isWritable: {{ 'true' if account.isWritable else 'false' }}, value: {{ accountsObj }}.{{ account.name | camelCase }} ?? null },
+      {{ account.name | camelCase }}: { index: {{ loop.index0 }}, isWritable: {{ 'true' if account.isWritable else 'false' }} as boolean, value: {{ accountsObj }}.{{ account.name | camelCase }} ?? null },
     {% endfor %}
   } satisfies ResolvedAccountsWithIndices;
 

package/src/renderers/rust/templates/instructionsCpiPageBuilder.njk

@@ -1,4 +1,20 @@
-/// `{{ instruction.name | snakeCase }}` CPI instruction builder.
+/// Instruction builder for `{{ instruction.name | pascalCase }}` via CPI.
+///
+/// ### Accounts:
+///
+{% for account in instruction.accounts %}
+  {% set modifiers = '' %}
+  {% if account.isWritable %}
+    {% set modifiers = 'writable' %}
+  {% endif %}
+  {% if account.isSigner %}
+    {% set modifiers = modifiers + ', signer' if modifiers.length > 0 else 'signer' %}
+  {% endif %}
+  {% if account.isOptional %}
+    {% set modifiers = modifiers + ', optional' if modifiers.length > 0 else 'optional' %}
+  {% endif %}
+  {{ '///   ' + loop.index0 + '. `[' + modifiers + ']` ' + account.name | snakeCase }}
+{% endfor %}
 pub struct {{ instruction.name | pascalCase }}CpiBuilder<'a, 'b> {
   instruction: Box<{{ instruction.name | pascalCase }}CpiBuilderInstruction<'a, 'b>>,
 }

package/src/renderers/rust/templates/instructionsPageBuilder.njk

@@ -1,4 +1,22 @@
-/// Instruction builder.
+/// Instruction builder for `{{ instruction.name | pascalCase }}`.
+///
+/// ### Accounts:
+///
+{% for account in instruction.accounts %}
+  {% set modifiers = '' %}
+  {% if account.isWritable %}
+    {% set modifiers = 'writable' %}
+  {% endif %}
+  {% if account.isSigner %}
+    {% set modifiers = modifiers + ', signer' if modifiers.length > 0 else 'signer' %}
+  {% endif %}
+  {% if account.isOptional or account.defaultsTo.kind === 'program' or account.defaultsTo.kind === 'publicKey' %}
+    {% set modifiers = modifiers + ', optional' if modifiers.length > 0 else 'optional' %}
+  {% endif %}
+  {{ '///   ' + loop.index0 + '. `[' + modifiers + ']` ' + account.name | snakeCase }}
+  {{- " (default to `" + account.defaultsTo.program.publicKey + "`)" if account.defaultsTo.kind === 'program' }}
+  {{- " (default to `" + account.defaultsTo.publicKey + "`)" if account.defaultsTo.kind === 'publicKey' }}
+{% endfor %}
 #[derive(Default)]
 pub struct {{ instruction.name | pascalCase }}Builder {
   {% for account in instruction.accounts %}