守卫组 | Core Candy Machine

在前面的页面中，我们介绍了守卫并使用它们来定义 Candy Machine 的访问控制。我们已经看到使用守卫，我们可以例如添加每次铸造 1 SOL 的付款并确保铸造在某个日期之后开始。但是如果我们还想在第二个日期之后收取 2 SOL 呢？如果我们想让某些代币持有者免费铸造或以折扣价铸造呢？

如果我们可以定义多组守卫，每组都有自己的要求呢？出于这个原因，我们创建了守卫组！

组如何工作？

还记得我们如何通过简单地提供我们想要启用的守卫的设置来在任何 Core Candy Machine 上设置守卫吗？好吧，守卫组的工作方式相同，只是您还必须给它们一个唯一的 Label 来标识它们。

因此，每个守卫组都有以下属性：

Label：唯一的文本标识符。这不能超过 6 个字符。
Guards：该组中所有激活守卫的设置。这与直接在 Core Candy Machine 上设置守卫的工作方式相同。

让我们举一个简单的例子。假设我们想在下午 4 点到 5 点之间收取 1 SOL，然后从下午 5 点开始收取 2 SOL 直到 Core Candy Machine 耗尽。同时确保我们通过 Bot Tax 守卫受到保护免受机器人攻击。以下是我们可以如何设置守卫：

组 1：
- Label："early"
- Guards：
  - Sol Payment：1 SOL
  - Start Date：下午 4 点（为简单起见忽略实际日期）
  - End Date：下午 5 点
  - Bot Tax：0.001 SOL
组 2：
- Label："late"
- Guards：
  - Sol Payment：2 SOL
  - Start Date：下午 5 点
  - Bot Tax：0.001 SOL

就这样，我们创建了一个自定义的 2 层铸造流程！

现在，每当有人尝试从我们的 Core Candy Machine 铸造时，他们必须明确告诉我们他们从哪个组铸造。在铸造时要求组标签很重要，因为：

它确保买家不会经历意外的铸造行为。假设我们在第一组结束日期的最后时刻尝试以 1 SOL 铸造，但到交易执行时，我们已经过了那个日期。如果我们不要求组标签，交易将成功，我们将被收取 2 SOL，尽管我们只期望被收取 1 SOL。
它使支持并行组成为可能。我们将在本页稍后详细讨论这一点。

React Flow

现在让我们看看如何使用我们的 SDK 创建和更新组。

创建带有守卫组的 Candy Machine

要创建带有守卫组的 Candy Machine，只需将 groups 数组提供给 create 函数。此数组的每个项目必须包含一个 label 和一个 guards 对象，其中包含我们希望在该组中激活的所有守卫的设置。

以下是我们如何使用 Umi 库实现上述示例。

import { some, sol, dateTime } from '@metaplex-foundation/umi'

await create(umi, {
  // ...
  groups: [
    {
      label: 'early',
      guards: {
        solPayment: some({ lamports: sol(1), destination: treasury }),
        startDate: some({ date: dateTime('2022-10-18T16:00:00Z') }),
        endDate: some({ date: dateTime('2022-10-18T17:00:00Z') }),
        botTax: some({ lamports: sol(0.001), lastInstruction: true }),
      },
    },
    {
      label: 'late',
      guards: {
        solPayment: some({ lamports: sol(2), destination: treasury }),
        startDate: some({ date: dateTime('2022-10-18T17:00:00Z') }),
        botTax: some({ lamports: sol(0.001), lastInstruction: true }),
      },
    },
  ],
}).sendAndConfirm(umi)

要更新组，只需将相同的 groups 属性提供给 updateCandyGuard 函数。请注意，整个 guards 对象和 groups 数组将被更新，这意味着它将覆盖所有现有数据！

因此，请确保为所有组提供设置，即使它们的设置没有变化。您可能需要先获取最新的 candy guard 账户数据，以避免覆盖任何现有设置。

以下是一个示例，将 "late" 组的 SOL payment 守卫从 2 SOL 更改为 3 SOL。

import { some, sol, dateTime } from '@metaplex-foundation/umi'

const candyGuard = await fetchCandyGuard(umi, candyMachine.mintAuthority)
await updateCandyGuard(umi, {
  candyGuard: candyGuard.publicKey,
  guards: candyGuard.guards,
  groups: [
    {
      label: 'early',
      guards: {
        solPayment: some({ lamports: sol(1), destination: treasury }),
        startDate: some({ date: dateTime('2022-10-18T16:00:00Z') }),
        endDate: some({ date: dateTime('2022-10-18T17:00:00Z') }),
        botTax: some({ lamports: sol(0.001), lastInstruction: true }),
      },
    },
    {
      label: 'late',
      guards: {
        solPayment: some({ lamports: sol(3), destination: treasury }),
        startDate: some({ date: dateTime('2022-10-18T17:00:00Z') }),
        botTax: some({ lamports: sol(0.001), lastInstruction: true }),
      },
    },
  ],
}).sendAndConfirm(umi)

API 参考: create, updateCandyGuard, DefaultGuardSetArgs

默认守卫

注意，在上面的示例中，我们必须为两个组提供相同的 Bot Tax 守卫。这可以通过利用 Candy Machine 上设置的全局 Guards 来简化。

使用守卫组时，Core Candy Machine 的全局守卫——如前一页所解释的——充当默认守卫！这意味着组将默认使用与全局守卫相同的守卫设置，除非它们通过在组中显式启用来覆盖它们。

以下是快速回顾：

如果守卫在默认守卫上启用但在组的守卫上未启用，组将使用默认守卫中定义的守卫。
如果守卫在默认守卫_和_组的守卫上都启用，组将使用组的守卫中定义的守卫。
如果守卫在默认守卫或组的守卫上都未启用，组不使用此守卫。

为了说明这一点，让我们以上一节的示例为例，将 Bot Tax 守卫移动到默认守卫。

默认守卫：
- Bot Tax：0.001 SOL
组 1：
- Label："early"
- Guards：
  - Sol Payment：1 SOL
  - Start Date：下午 4 点
  - End Date：下午 5 点
组 2：
- Label："late"
- Guards：
  - Sol Payment：2 SOL
  - Start Date：下午 5 点

如您所见，默认守卫有助于避免组内的重复。

React Flow

注意，即使使用默认守卫，铸造时也必须提供一个组。这意味着，使用守卫组时，不可能仅使用默认守卫进行铸造。

创建带有默认守卫和守卫组的 Candy Machine

要在 Umi 库中使用默认守卫，只需在创建或更新 Candy Machine 时将 guards 属性与 groups 数组一起使用。例如，以下是如何使用上述守卫设置创建 Candy Machine。

import { some, sol, dateTime } from '@metaplex-foundation/umi'

await create(umi, {
  // ...
  guards: {
    botTax: some({ lamports: sol(0.001), lastInstruction: true }),
  },
  groups: [
    {
      label: 'early',
      guards: {
        solPayment: some({ lamports: sol(1), destination: treasury }),
        startDate: some({ date: dateTime('2022-10-18T16:00:00Z') }),
        endDate: some({ date: dateTime('2022-10-18T17:00:00Z') }),
      },
    },
    {
      label: 'late',
      guards: {
        solPayment: some({ lamports: sol(2), destination: treasury }),
        startDate: some({ date: dateTime('2022-10-18T17:00:00Z') }),
      },
    },
  ],
}).sendAndConfirm(umi)

API 参考: create, DefaultGuardSetArgs

并行组

要求铸造时提供组标签的一个非常有趣的好处是能够在给定时间有多个有效的组。这消除了程序的任何歧义，并允许买家选择他们想从哪个组尝试铸造。

让我们用一个新的例子来说明这一点。假设我们有一个名为 "Innocent Bird" 的资产 collection，我们想向持有 "Innocent Bird" 资产的任何人提供 1 SOL 的折扣价，而向其他人收取 2 SOL。我们希望这两个组能够同时开始铸造——假设下午 4 点——我们还希望两个组都受到机器人的保护。以下是我们可以如何配置守卫：

默认守卫：
- Start Date：下午 4 点
- Bot Tax：0.001 SOL
组 1：
- Label："nft"
- Guards：
  - Sol Payment：1 SOL
  - NFT Gate："Innocent Bird" Collection
组 2：
- Label："public"
- Guards：
  - Sol Payment：2 SOL

如您所见，使用这些守卫设置，两个组可以同时铸造。NFT 持有者甚至可以选择从 "public" 组铸造来支付完整的 2 SOL。然而，如果可以的话，选择 "nft" 组对他们最有利。

创建带有并行组的 Core Candy Machine

以下是如何使用 Umi 库使用上述守卫设置创建 Core Candy Machine。

import { some, sol, dateTime } from '@metaplex-foundation/umi'

await create(umi, {
  // ...
  guards: {
    botTax: some({ lamports: sol(0.001), lastInstruction: true }),
    startDate: some({ date: dateTime('2022-10-18T16:00:00Z') }),
  },
  groups: [
    {
      label: 'early',
      guards: {
        solPayment: some({ amount: sol(1), destination: treasury }),
        nftGate: some({
          requiredCollection: innocentBirdCollectionNft.publicKey,
        }),
      },
    },
    {
      label: 'late',
      guards: {
        solPayment: some({ amount: sol(2), destination: treasury }),
      },
    },
  ],
}).sendAndConfirm(umi)

API 参考: create, DefaultGuardSetArgs

结论

守卫组为我们的 Core Candy Machine 带来了全新的维度，允许我们定义根据我们需求定制的顺序和/或并行铸造工作流程。

在下一页，我们将看到关于守卫的另一个令人兴奋的功能：守卫指令！