Merge pull request #14 from metaplex-foundation/feat/asset-gate

Add asset gate guard

clients/js/src/defaultGuards/assetGate.ts

@@ -0,0 +1,32 @@
+import { PublicKey } from '@metaplex-foundation/umi';
+import { getAssetGateSerializer, AssetGate, AssetGateArgs } from '../generated';
+import { GuardManifest, noopParser } from '../guards';
+
+/**
+ * The assetGate guard restricts minting to holders
+ * of a specified NFT collection.
+ *
+ * This means the mint address of an NFT from this
+ * collection must be passed when minting.
+ */
+export const assetGateGuardManifest: GuardManifest<
+  AssetGateArgs,
+  AssetGate,
+  AssetGateMintArgs
+> = {
+  name: 'assetGate',
+  serializer: getAssetGateSerializer,
+  mintParser: (context, mintContext, args) => ({
+    data: new Uint8Array(),
+    remainingAccounts: [{ publicKey: args.asset, isWritable: false }],
+  }),
+  routeParser: noopParser,
+};
+
+export type AssetGateMintArgs = {
+  /**
+   * The address of an Asset from the required
+   * collection that belongs to the payer.
+   */
+  asset: PublicKey;
+};

clients/js/src/defaultGuards/default.ts

@@ -10,6 +10,8 @@ import {
   AssetBurnArgs,
   AssetBurnMulti,
   AssetBurnMultiArgs,
+  AssetGate,
+  AssetGateArgs,
   AssetMintLimit,
   AssetMintLimitArgs,
   AssetPayment,
@@ -93,6 +95,7 @@ import { AssetBurnMintArgs } from './assetBurn';
 import { AssetMintLimitMintArgs } from './assetMintLimit';
 import { AssetBurnMultiMintArgs } from './assetBurnMulti';
 import { AssetPaymentMultiMintArgs } from './assetPaymentMulti';
+import { AssetGateMintArgs } from './assetGate';
 
 /**
  * The arguments for all default Candy Machine guards.
@@ -127,6 +130,7 @@ export type DefaultGuardSetArgs = GuardSetArgs & {
   assetMintLimit: OptionOrNullable<AssetMintLimitArgs>;
   assetBurnMulti: OptionOrNullable<AssetBurnMultiArgs>;
   assetPaymentMulti: OptionOrNullable<AssetPaymentMultiArgs>;
+  assetGate: OptionOrNullable<AssetGateArgs>;
 };
 
 /**
@@ -162,6 +166,7 @@ export type DefaultGuardSet = GuardSet & {
   assetMintLimit: Option<AssetMintLimit>;
   assetBurnMulti: Option<AssetBurnMulti>;
   assetPaymentMulti: Option<AssetPaymentMulti>;
+  assetGate: Option<AssetGate>;
 };
 
 /**
@@ -197,6 +202,7 @@ export type DefaultGuardSetMintArgs = GuardSetMintArgs & {
   assetMintLimit: OptionOrNullable<AssetMintLimitMintArgs>;
   assetBurnMulti: OptionOrNullable<AssetBurnMultiMintArgs>;
   assetPaymentMulti: OptionOrNullable<AssetPaymentMultiMintArgs>;
+  assetGate: OptionOrNullable<AssetGateMintArgs>;
 };
 
 /**
@@ -257,6 +263,7 @@ export const defaultCandyGuardNames: string[] = [
   'assetMintLimit',
   'assetBurnMulti',
   'assetPaymentMulti',
+  'assetGate',
 ];
 
 /** @internal */

clients/js/src/defaultGuards/index.ts

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

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

@@ -0,0 +1,32 @@
+/**
+ * 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 { PublicKey } from '@metaplex-foundation/umi';
+import {
+  Serializer,
+  publicKey as publicKeySerializer,
+  struct,
+} from '@metaplex-foundation/umi/serializers';
+
+/**
+ * Guard that restricts the transaction to holders of a specified collection.
+ *
+ * List of accounts required:
+ *
+ * 0. `[]` Account of the Asset.
+ */
+
+export type AssetGate = { requiredCollection: PublicKey };
+
+export type AssetGateArgs = AssetGate;
+
+export function getAssetGateSerializer(): Serializer<AssetGateArgs, AssetGate> {
+  return struct<AssetGate>([['requiredCollection', publicKeySerializer()]], {
+    description: 'AssetGate',
+  }) as Serializer<AssetGateArgs, AssetGate>;
+}

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

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

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

@@ -11,6 +11,7 @@ export * from './allocation';
 export * from './allowList';
 export * from './assetBurn';
 export * from './assetBurnMulti';
+export * from './assetGate';
 export * from './assetMintLimit';
 export * from './assetPayment';
 export * from './assetPaymentMulti';

clients/js/src/plugin.ts

@@ -31,6 +31,7 @@ import {
   assetMintLimitGuardManifest,
   assetBurnMultiGuardManifest,
   assetPaymentMultiGuardManifest,
+  assetGateGuardManifest,
 } from './defaultGuards';
 import {
   createMplCoreCandyGuardProgram,
@@ -93,7 +94,8 @@ export const mplCandyMachine = (): UmiPlugin => ({
       assetBurnGuardManifest,
       assetMintLimitGuardManifest,
       assetBurnMultiGuardManifest,
-      assetPaymentMultiGuardManifest
+      assetPaymentMultiGuardManifest,
+      assetGateGuardManifest
     );
   },
 });