Merge pull request #15 from metaplex-foundation/feat/vanity_address

Add a guard to verify the mint of the new asset matches a vanity pattern

.github/.env

@@ -2,8 +2,8 @@ CARGO_TERM_COLOR=always
 NODE_VERSION=16.x
 PROGRAMS=["candy-machine-core", "candy-guard"]
 RUST_VERSION=1.75.0
-SOLANA_VERSION=1.17.20
+SOLANA_VERSION=1.18.21
 ANCHOR_VERSION=0.27.0
 COMMIT_USER_NAME="github-actions[bot]"
 COMMIT_USER_EMAIL="41898282+github-actions[bot]@users.noreply.github.com"
-DEPLOY_SOLANA_VERSION=1.18.14
+DEPLOY_SOLANA_VERSION=1.18.21

clients/js/src/defaultGuards/default.ts

@@ -60,6 +60,8 @@ import {
   TokenGateArgs,
   TokenPayment,
   TokenPaymentArgs,
+  VanityMint,
+  VanityMintArgs,
 } from '../generated';
 import {
   GuardSet,
@@ -131,6 +133,7 @@ export type DefaultGuardSetArgs = GuardSetArgs & {
   assetBurnMulti: OptionOrNullable<AssetBurnMultiArgs>;
   assetPaymentMulti: OptionOrNullable<AssetPaymentMultiArgs>;
   assetGate: OptionOrNullable<AssetGateArgs>;
+  vanityMint: OptionOrNullable<VanityMintArgs>;
 };
 
 /**
@@ -167,6 +170,7 @@ export type DefaultGuardSet = GuardSet & {
   assetBurnMulti: Option<AssetBurnMulti>;
   assetPaymentMulti: Option<AssetPaymentMulti>;
   assetGate: Option<AssetGate>;
+  vanityMint: Option<VanityMint>;
 };
 
 /**
@@ -264,6 +268,7 @@ export const defaultCandyGuardNames: string[] = [
   'assetBurnMulti',
   'assetPaymentMulti',
   'assetGate',
+  'vanityMint',
 ];
 
 /** @internal */

clients/js/src/defaultGuards/index.ts

@@ -29,3 +29,4 @@ export * from './assetMintLimit';
 export * from './assetBurnMulti';
 export * from './assetPaymentMulti';
 export * from './assetGate';
+export * from './vanityMint';

clients/js/src/defaultGuards/vanityMint.ts

@@ -0,0 +1,34 @@
+import {
+  fixSerializer,
+  mapSerializer,
+} from '@metaplex-foundation/umi/serializers';
+import { ExceededRegexLengthError } from '../errors';
+import {
+  getVanityMintSerializer,
+  VanityMint,
+  VanityMintArgs,
+} from '../generated';
+import { GuardManifest, noopParser } from '../guards';
+
+/**
+ * The vanityMint guard verifies that the new asset
+ * address matches the provided regex.
+ */
+export const vanityMintGuardManifest: GuardManifest<
+  VanityMintArgs,
+  VanityMint
+> = {
+  name: 'vanityMint',
+  serializer: () =>
+    mapSerializer(
+      fixSerializer(getVanityMintSerializer(), 4 + 100),
+      (value) => {
+        if (value.regex.length > 100) {
+          throw new ExceededRegexLengthError();
+        }
+        return value;
+      }
+    ),
+  mintParser: noopParser,
+  routeParser: noopParser,
+};

clients/js/src/errors.ts

@@ -161,3 +161,14 @@ export class MaximumOfFiveAdditionalProgramsError extends CandyMachineError {
     super(message);
   }
 }
+
+export class ExceededRegexLengthError extends CandyMachineError {
+  readonly name: string = 'ExceededRegexLengthError';
+
+  constructor() {
+    const message =
+      `The maximum length of a regex that can be used is 100 characters. ` +
+      'Please reduce the length of the regex to <= 100.';
+    super(message);
+  }
+}

clients/js/src/generated/errors/mplCoreCandyGuard.ts

@@ -731,6 +731,49 @@ export class CgInvalidAccountVersionError extends ProgramError {
 codeToErrorMap.set(0x17a3, CgInvalidAccountVersionError);
 nameToErrorMap.set('InvalidAccountVersion', CgInvalidAccountVersionError);
 
+/** ExceededRegexLength: Exceeded the maximum length of a regex that can be used */
+export class CgExceededRegexLengthError extends ProgramError {
+  readonly name: string = 'ExceededRegexLength';
+
+  readonly code: number = 0x17a4; // 6052
+
+  constructor(program: Program, cause?: Error) {
+    super(
+      'Exceeded the maximum length of a regex that can be used',
+      program,
+      cause
+    );
+  }
+}
+codeToErrorMap.set(0x17a4, CgExceededRegexLengthError);
+nameToErrorMap.set('ExceededRegexLength', CgExceededRegexLengthError);
+
+/** InvalidVanityAddress: Invalid vanity address */
+export class CgInvalidVanityAddressError extends ProgramError {
+  readonly name: string = 'InvalidVanityAddress';
+
+  readonly code: number = 0x17a5; // 6053
+
+  constructor(program: Program, cause?: Error) {
+    super('Invalid vanity address', program, cause);
+  }
+}
+codeToErrorMap.set(0x17a5, CgInvalidVanityAddressError);
+nameToErrorMap.set('InvalidVanityAddress', CgInvalidVanityAddressError);
+
+/** InvalidRegex: Invalid regex */
+export class CgInvalidRegexError extends ProgramError {
+  readonly name: string = 'InvalidRegex';
+
+  readonly code: number = 0x17a6; // 6054
+
+  constructor(program: Program, cause?: Error) {
+    super('Invalid regex', program, cause);
+  }
+}
+codeToErrorMap.set(0x17a6, CgInvalidRegexError);
+nameToErrorMap.set('InvalidRegex', CgInvalidRegexError);
+
 /**
  * Attempts to resolve a custom program error from the provided error code.
  * @category Errors

clients/js/src/generated/types/guardType.ts

@@ -40,6 +40,7 @@ export enum GuardType {
   AssetBurnMulti,
   AssetPaymentMulti,
   AssetGate,
+  VanityMint,
 }
 
 export type GuardTypeArgs = GuardType;

clients/js/src/generated/types/index.ts

@@ -42,3 +42,4 @@ export * from './token2022Payment';
 export * from './tokenBurn';
 export * from './tokenGate';
 export * from './tokenPayment';
+export * from './vanityMint';

clients/js/src/generated/types/vanityMint.ts

@@ -0,0 +1,27 @@
+/**
+ * This code was AUTOGENERATED using the kinobi library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun kinobi to update it.
+ *
+ * @see https://github.com/metaplex-foundation/kinobi
+ */
+
+import {
+  Serializer,
+  string,
+  struct,
+} from '@metaplex-foundation/umi/serializers';
+
+/** Guard that sets a specific start date for the mint. */
+export type VanityMint = { regex: string };
+
+export type VanityMintArgs = VanityMint;
+
+export function getVanityMintSerializer(): Serializer<
+  VanityMintArgs,
+  VanityMint
+> {
+  return struct<VanityMint>([['regex', string()]], {
+    description: 'VanityMint',
+  }) as Serializer<VanityMintArgs, VanityMint>;
+}

clients/js/src/plugin.ts

@@ -32,6 +32,7 @@ import {
   assetBurnMultiGuardManifest,
   assetPaymentMultiGuardManifest,
   assetGateGuardManifest,
+  vanityMintGuardManifest,
 } from './defaultGuards';
 import {
   createMplCoreCandyGuardProgram,
@@ -95,7 +96,8 @@ export const mplCandyMachine = (): UmiPlugin => ({
       assetMintLimitGuardManifest,
       assetBurnMultiGuardManifest,
       assetPaymentMultiGuardManifest,
-      assetGateGuardManifest
+      assetGateGuardManifest,
+      vanityMintGuardManifest
     );
   },
 });