Merge pull request #11 from metaplex-foundation/nhan/default-config-l…

…ines default config line settings if no config is provided and no hidden s…
metaplex-foundation · Jul 8, 2024 · aa6cfe7 · aa6cfe7
2 parents ef83491 + 8d1e219
commit aa6cfe7
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 10 deletions.
diff --git a/clients/js/src/createCandyMachine.ts b/clients/js/src/createCandyMachine.ts
@@ -1,10 +1,13 @@
 import { createAccount } from '@metaplex-foundation/mpl-toolbox';
 import {
   Context,
+  isNone,
+  isOption,
   none,
   Signer,
   transactionBuilder,
   TransactionBuilder,
+  wrapNullable,
 } from '@metaplex-foundation/umi';
 import { initializeCandyMachine } from './generated';
 import { getCandyMachineSize } from './hooked';
@@ -16,29 +19,51 @@ export type CreateCandyMachineInput = Omit<
   candyMachine: Signer;
 };
 
+export const DEFAULT_CONFIG_LINE_SETTINGS = {
+  prefixName: '',
+  nameLength: 32,
+  prefixUri: '',
+  uriLength: 200,
+  isSequential: false,
+};
+
 export const createCandyMachine = async (
   context: Parameters<typeof initializeCandyMachine>[0] & Pick<Context, 'rpc'>,
   input: CreateCandyMachineInput
 ): Promise<TransactionBuilder> => {
+  const newInput = { ...input };
+
+  const hiddenSettings = isOption(input.hiddenSettings)
+    ? input.hiddenSettings
+    : wrapNullable(input.hiddenSettings);
+
+  const configLineSettings = isOption(input.configLineSettings)
+    ? input.configLineSettings
+    : wrapNullable(input.configLineSettings);
+
+  if (isNone(hiddenSettings) && isNone(configLineSettings)) {
+    newInput.configLineSettings = DEFAULT_CONFIG_LINE_SETTINGS;
+  }
+
   const space = getCandyMachineSize(
-    input.itemsAvailable,
-    input.configLineSettings ?? none()
+    newInput.itemsAvailable,
+    newInput.configLineSettings ?? none()
   );
 
   const lamports = await context.rpc.getRent(space);
   return transactionBuilder()
     .add(
       createAccount(context, {
-        newAccount: input.candyMachine,
+        newAccount: newInput.candyMachine,
         lamports,
         space,
         programId: context.programs.get('mplCoreCandyMachineCore').publicKey,
       })
     )
     .add(
       initializeCandyMachine(context, {
-        ...input,
-        candyMachine: input.candyMachine.publicKey,
+        ...newInput,
+        candyMachine: newInput.candyMachine.publicKey,
       })
     );
 };
diff --git a/clients/js/test/createCandyMachineV2.test.ts b/clients/js/test/createCandyMachineV2.test.ts
@@ -6,7 +6,12 @@ import {
   transactionBuilder,
 } from '@metaplex-foundation/umi';
 import test from 'ava';
-import { CandyMachine, createCandyMachine, fetchCandyMachine } from '../src';
+import {
+  CandyMachine,
+  createCandyMachine,
+  DEFAULT_CONFIG_LINE_SETTINGS,
+  fetchCandyMachine,
+} from '../src';
 import { createCollection, createUmi, defaultCandyMachineData } from './_setup';
 
 test('it can create a candy machine using config line settings', async (t) => {
@@ -109,14 +114,14 @@ test('it can create a candy machine using hidden settings', async (t) => {
   });
 });
 
-test('it cannot create a candy machine without hidden or config line settings', async (t) => {
+test('it can create a candy machine with defaulted config lines', async (t) => {
   // Given an existing collection NFT.
   const umi = await createUmi();
   const collection = (await createCollection(umi)).publicKey;
 
   // When we try to create a new candy machine without any settings.
   const candyMachine = generateSigner(umi);
-  const promise = transactionBuilder()
+  await transactionBuilder()
     .add(
       await createCandyMachine(umi, {
         ...defaultCandyMachineData(umi),
@@ -128,8 +133,25 @@ test('it cannot create a candy machine without hidden or config line settings',
     )
     .sendAndConfirm(umi);
 
-  // Then we expect a program error.
-  await t.throwsAsync(promise, { message: /A raw constraint was violated/ });
+  const candyMachineAccount = await fetchCandyMachine(
+    umi,
+    candyMachine.publicKey
+  );
+
+  t.like(candyMachineAccount, <CandyMachine>{
+    publicKey: publicKey(candyMachine),
+    authority: publicKey(umi.identity),
+    mintAuthority: publicKey(umi.identity),
+    collectionMint: publicKey(collection),
+    itemsRedeemed: 0n,
+    data: {
+      itemsAvailable: 100n,
+      maxEditionSupply: 0n,
+      isMutable: true,
+      configLineSettings: some(DEFAULT_CONFIG_LINE_SETTINGS),
+      hiddenSettings: none(),
+    },
+  });
 });
 
 test('it can create a candy machine of Programmable NFTs', async (t) => {