Class CandyMachineGuardsClient

This client enables us to register custom guards from custom Candy Guard programs and interact with them.

See

CandyGuardClient

Hierarchy

CandyMachineGuardsClient

Index

Properties

`Readonly` guards

guards: CandyGuardManifest<any, any, any>[] = []

`Protected` `Readonly` metaplex

metaplex: Metaplex

Constructors

constructor

new CandyMachineGuardsClient(metaplex: Metaplex): CandyMachineGuardsClient
Parameters
- metaplex: Metaplex
Returns CandyMachineGuardsClient
- Defined in packages/js/src/plugins/candyMachineModule/CandyMachineGuardsClient.ts:46

Methods

register

register(...guard: CandyGuardManifest<any, any, any>[]): void
Registers one or many guards by providing their manifest.
Parameters
- Rest ...guard: CandyGuardManifest<any, any, any>[]
Returns void
- Defined in packages/js/src/plugins/candyMachineModule/CandyMachineGuardsClient.ts:49

get

get(name: string): CandyGuardManifest<any, any, any>
Gets the manifest of a guard using its name.
Parameters
- name: string
Returns CandyGuardManifest<any, any, any>
- Defined in packages/js/src/plugins/candyMachineModule/CandyMachineGuardsClient.ts:54

all

all(): CandyGuardManifest<any, any, any>[]
Gets all registered guard manifests.

Returns CandyGuardManifest<any, any, any>[]
- Defined in packages/js/src/plugins/candyMachineModule/CandyMachineGuardsClient.ts:65

forProgram

forProgram(program?: string | PublicKey | CandyGuardProgram): CandyGuardManifest<any, any, any>[]
Gets all guard manifests for a registered Candy Guard program.

It fails if the manifest of any guard expected by the program is not registered. Manifests are returned in the order in which they are defined on the availableGuards property of the program.
Parameters
- program: string | PublicKey | CandyGuardProgram = 'CandyGuardProgram'
Returns CandyGuardManifest<any, any, any>[]
- Defined in packages/js/src/plugins/candyMachineModule/CandyMachineGuardsClient.ts:76

forCandyGuardProgram

forCandyGuardProgram(programs?: Program[]): CandyGuardManifest<any, any, any>[]
Gets all guard manifests for the registered Candy Guard program.

See
forProgram
Parameters
- programs: Program[] = []
Returns CandyGuardManifest<any, any, any>[]
- Defined in packages/js/src/plugins/candyMachineModule/CandyMachineGuardsClient.ts:92

serializeSettings

serializeSettings<T>(guards: Partial<T>, groups?: {
label: string;
guards: Partial<T>;
}[], programs?: Program[]): Buffer
Serializes the settings of all guards and groups.
Type Parameters
- T extends CandyGuardsSettings = DefaultCandyGuardSettings
Parameters
- guards: Partial<T>
- groups: {
  label: string;
  guards: Partial<T>;
  }[] = []
- programs: Program[] = []
Returns Buffer
- Defined in packages/js/src/plugins/candyMachineModule/CandyMachineGuardsClient.ts:101

deserializeSettings

deserializeSettings<T>(buffer: Buffer, program?: string | PublicKey | CandyGuardProgram): {
    guards: T;
    groups: {
        label: string;
        guards: T;
    }[];
}
Deserializes the settings of all guards and groups.
Type Parameters
- T extends CandyGuardsSettings = DefaultCandyGuardSettings
Parameters
- buffer: Buffer
- program: string | PublicKey | CandyGuardProgram = 'CandyGuardProgram'
Returns {
    guards: T;
    groups: {
        label: string;
        guards: T;
    }[];
}
- guards: T
- groups: {
  label: string;
  guards: T;
  }[]
- Defined in packages/js/src/plugins/candyMachineModule/CandyMachineGuardsClient.ts:165

resolveGroupSettings

resolveGroupSettings<T>(guards: T, groups?: {
label: string;
guards: T;
}[], groupLabel: Option<string>): T
Resolves the set of settings that should be used when minting.

If no group exists, the guards settings will be used. Otherwise, the guards settings will act as default settings and the settings of the selected group will override them.
Type Parameters
- T extends CandyGuardsSettings = DefaultCandyGuardSettings
Parameters
- guards: T
- groups: {
  label: string;
  guards: T;
  }[] = []
- groupLabel: Option<string>
Returns T
- Defined in packages/js/src/plugins/candyMachineModule/CandyMachineGuardsClient.ts:213

parseMintSettings

parseMintSettings<Settings, MintSettings>(candyMachine: PublicKey, candyGuard: CandyGuard<Settings>, owner: PublicKey, payer: Signer, mint: Signer, guardMintSettings: Partial<MintSettings>, groupLabel: Option<string>, programs?: Program[]): {
    arguments: Buffer;
    accountMetas: AccountMeta[];
    signers: Signer[];
}
Parses the arguments and remaining accounts of all relevant guards for the mint instruction.
Type Parameters
- Settings extends CandyGuardsSettings = DefaultCandyGuardSettings
- MintSettings extends CandyGuardsMintSettings = {}
Parameters
- candyMachine: PublicKey
- candyGuard: CandyGuard<Settings>
- owner: PublicKey
- payer: Signer
- mint: Signer
- guardMintSettings: Partial<MintSettings>
- groupLabel: Option<string>
- programs: Program[] = []
Returns {
    arguments: Buffer;
    accountMetas: AccountMeta[];
    signers: Signer[];
}
- arguments: Buffer
- accountMetas: AccountMeta[]
- signers: Signer[]
- Defined in packages/js/src/plugins/candyMachineModule/CandyMachineGuardsClient.ts:251

parseRouteSettings

parseRouteSettings<Guard, Settings, RouteSettings>(candyMachine: PublicKey, candyGuard: CandyGuard<Settings>, payer: Signer, guard: Guard, routeSettings: RouteSettings[Guard], groupLabel: Option<string>, programs?: Program[]): {
    arguments: Buffer;
    accountMetas: AccountMeta[];
    signers: Signer[];
}
Parses the arguments and remaining accounts of the requested guard for the route instruction.
Type Parameters
- Guard extends string
- Settings extends CandyGuardsSettings = DefaultCandyGuardSettings
- RouteSettings extends CandyGuardsRouteSettings = DefaultCandyGuardRouteSettings
Parameters
- candyMachine: PublicKey
- candyGuard: CandyGuard<Settings>
- payer: Signer
- guard: Guard
- routeSettings: RouteSettings[Guard]
- groupLabel: Option<string>
- programs: Program[] = []
Returns {
    arguments: Buffer;
    accountMetas: AccountMeta[];
    signers: Signer[];
}
- arguments: Buffer
- accountMetas: AccountMeta[]
- signers: Signer[]
- Defined in packages/js/src/plugins/candyMachineModule/CandyMachineGuardsClient.ts:311

Class CandyMachineGuardsClient

See

Hierarchy

Index

Properties

Constructors

Methods

Properties

Readonly guards

Protected Readonly metaplex

Constructors

constructor

Parameters

metaplex: Metaplex

Returns CandyMachineGuardsClient

Methods

register

Parameters

Rest ...guard: CandyGuardManifest<any, any, any>[]

Returns void

get

Parameters

name: string

Returns CandyGuardManifest<any, any, any>

all

Returns CandyGuardManifest<any, any, any>[]

forProgram

Parameters

program: string | PublicKey | CandyGuardProgram = 'CandyGuardProgram'

Returns CandyGuardManifest<any, any, any>[]

forCandyGuardProgram

See

Parameters

programs: Program[] = []

Returns CandyGuardManifest<any, any, any>[]

serializeSettings

Type Parameters

T extends CandyGuardsSettings = DefaultCandyGuardSettings

Parameters

guards: Partial<T>

groups: { label: string; guards: Partial<T>; }[] = []

programs: Program[] = []

Returns Buffer

deserializeSettings

Type Parameters

T extends CandyGuardsSettings = DefaultCandyGuardSettings

Parameters

buffer: Buffer

program: string | PublicKey | CandyGuardProgram = 'CandyGuardProgram'

Returns { guards: T; groups: { label: string; guards: T; }[]; }

guards: T

groups: { label: string; guards: T; }[]

resolveGroupSettings

Type Parameters

T extends CandyGuardsSettings = DefaultCandyGuardSettings

Parameters

guards: T

groups: { label: string; guards: T; }[] = []

groupLabel: Option<string>

Returns T

parseMintSettings

Type Parameters

Settings extends CandyGuardsSettings = DefaultCandyGuardSettings

MintSettings extends CandyGuardsMintSettings = {}

Parameters

candyMachine: PublicKey

candyGuard: CandyGuard<Settings>

owner: PublicKey

payer: Signer

mint: Signer

guardMintSettings: Partial<MintSettings>

groupLabel: Option<string>

programs: Program[] = []

Returns { arguments: Buffer; accountMetas: AccountMeta[]; signers: Signer[]; }

arguments: Buffer

accountMetas: AccountMeta[]

signers: Signer[]

parseRouteSettings

Type Parameters

Guard extends string

`Readonly` guards

`Protected` `Readonly` metaplex

`Rest` ...guard: CandyGuardManifest<any, any, any>[]

groups: {
label: string;
guards: Partial<T>;
}[] = []

Returns {
guards: T;
groups: {
label: string;
guards: T;
}[];
}

groups: {
label: string;
guards: T;
}[]

groups: {
label: string;
guards: T;
}[] = []

Returns {
arguments: Buffer;
accountMetas: AccountMeta[];
signers: Signer[];
}

Returns {
arguments: Buffer;
accountMetas: AccountMeta[];
signers: Signer[];
}