Type alias UpdateCandyGuardInput<T>

UpdateCandyGuardInput<T>: {
    candyGuard: PublicKey;
    guards: Partial<T>;
    groups?: {
        label: string;
        guards: Partial<T>;
    }[];
    authority?: Signer;
}

Type Parameters

Type declaration

  • candyGuard: PublicKey

    The address of the Candy Guard to update.

  • guards: Partial<T>

    The settings of all guards we wish to activate.

    Note that this will override the existing guards parameter so you must provide all guards you wish to activate.

    Any guard not provided or set to null will be disabled.

  • Optional groups?: {
        label: string;
        guards: Partial<T>;
    }[]

    This parameter allows us to create multiple minting groups that have their own set of requirements — i.e. guards.

    Note that this will override the existing groups parameter so you must provide all groups and guards you wish to activate.

    When groups are provided, the guards parameter becomes a set of default guards that will be applied to all groups. If a specific group enables a guard that is also present in the default guards, the group's guard will override the default guard.

    For each group, any guard not provided or set to null will be disabled.

    You may disable groups by providing an empty array [].

  • Optional authority?: Signer

    The Signer authorized to update the candy Guard.

    Default Value

    metaplex.identity()

Generated using TypeDoc