@metaplex-foundation/mpl-candy-machine - v6.0.1

Index

Modules

<internal>

Enumerations

AccountVersion FreezeInstruction GuardType

Classes

CandyGuardRequiredOnCandyMachineError CandyMachineError CgAddressNotAuthorizedError CgAddressNotFoundInAllowedListError CgAfterEndDateError CgAllocationGuardNotEnabledError CgAllocationLimitReachedError CgAllocationNotInitializedError CgAllowedListNotEnabledError CgAllowedMintLimitReachedError CgCandyMachineEmptyError CgCollectionKeyMismatchError CgCollectionUpdateAuthorityKeyMismatchError CgDataIncrementLimitExceededError CgDeserializationErrorError CgDuplicatedGroupLabelError CgDuplicatedMintLimitIdError CgExceededLengthError CgExceededMaximumFreezePeriodError CgExceededProgramListSizeError CgFreezeEscrowAlreadyExistsError CgFreezeGuardNotEnabledError CgFreezeNotInitializedError CgGatewayTokenInvalidError CgGroupNotFoundError CgIncorrectOwnerError CgInstructionBuilderFailedError CgInstructionNotFoundError CgInvalidAccountSizeError CgInvalidAccountVersionError CgInvalidMintAuthorityError CgInvalidMintTimeError CgInvalidNftCollectionError CgMaximumRedeemedAmountError CgMintNotLastTransactionError CgMintNotLiveError CgMissingAllowedListProofError CgMissingCollectionAccountsError CgMissingFreezeInstructionError CgMissingFreezePeriodError CgMissingNftError CgMissingRemainingAccountError CgMissingRequiredSignatureError CgNotEnoughSOLError CgNotEnoughTokensError CgNumericalOverflowErrorError CgPublicKeyMismatchError CgRequiredGroupLabelNotFoundError CgThawNotEnabledError CgTokenBurnFailedError CgTokenTransferFailedError CgUnauthorizedProgramFoundError CgUninitializedError CgUnlockNotEnabledError CmCandyMachineEmptyError CmCannotChangeNumberOfLinesError CmCannotChangeSequentialIndexGenerationError CmCannotIncreaseLengthError CmCannotSwitchFromHiddenSettingsError CmCannotSwitchToHiddenSettingsError CmCollectionKeyMismatchError CmCouldNotRetrieveConfigLineDataError CmExceededLengthErrorError CmHiddenSettingsDoNotHaveConfigLinesError CmIncorrectCollectionAuthorityError CmIncorrectOwnerError CmIndexGreaterThanLengthError CmInstructionBuilderFailedError CmInvalidAccountVersionError CmInvalidTokenStandardError CmMetadataAccountMustBeEmptyError CmMintMismatchError CmMissingCollectionAuthorityRecordError CmMissingConfigLinesSettingsError CmMissingInstructionsSysvarError CmMissingMetadataDelegateRecordError CmMissingSplAtaProgramError CmMissingTokenAccountError CmMissingTokenRecordError CmNoChangingCollectionDuringMintError CmNotFullyLoadedError CmNumericalOverflowErrorError CmTooManyCreatorsError CmUninitializedError DefaultGuardRepository GuardGroupLabelTooLongError GuardGroupRequiredError GuardMintSettingsMissingError GuardNotEnabledError GuardRouteNotSupportedError MaximumOfFiveAdditionalProgramsError MintOwnerMustBeMintPayerError SelectedGuardGroupDoesNotExistError UnrecognizePathForRouteInstructionError UnregisteredCandyGuardError VariableSizeGuardError

Interfaces

GuardRepository

Type Aliases

AccountVersionArgs AddConfigLinesInstructionAccounts AddConfigLinesInstructionArgs AddConfigLinesInstructionData AddConfigLinesInstructionDataArgs AddressGate AddressGateArgs Allocation AllocationArgs AllocationMintArgs AllocationRouteArgs AllocationTracker AllocationTrackerAccountData AllocationTrackerAccountDataArgs AllowList AllowListArgs AllowListMintArgs AllowListProof AllowListProofAccountData AllowListProofAccountDataArgs AllowListRouteArgs AnyGuardManifest BotTax BotTaxArgs CandyGuard CandyGuardAccountData CandyGuardAccountDataArgs CandyGuardData CandyGuardDataArgs CandyGuardProgram CandyMachine CandyMachineAccountData CandyMachineAccountDataArgs CandyMachineData CandyMachineDataArgs CandyMachineItem ConfigLine ConfigLineArgs ConfigLineSettings ConfigLineSettingsArgs CreateCandyGuardInstructionAccounts CreateCandyGuardInstructionData CreateCandyGuardInstructionDataArgs CreateCandyMachineInput CreateCandyMachineV2Input CreateInput Creator CreatorArgs DefaultGuardSet DefaultGuardSetArgs DefaultGuardSetMintArgs DefaultGuardSetRouteArgs DeleteCandyGuardInstructionAccounts DeleteCandyGuardInstructionData DeleteCandyGuardInstructionDataArgs DeleteCandyMachineInstructionAccounts DeleteCandyMachineInstructionData DeleteCandyMachineInstructionDataArgs EndDate EndDateArgs FreezeEscrow FreezeEscrowAccountData FreezeEscrowAccountDataArgs FreezeInstructionArgs FreezeSolPayment FreezeSolPaymentArgs FreezeSolPaymentMintArgs FreezeSolPaymentRouteArgs FreezeSolPaymentRouteArgsInitialize FreezeSolPaymentRouteArgsThaw FreezeSolPaymentRouteArgsUnlockFunds FreezeTokenPayment FreezeTokenPaymentArgs FreezeTokenPaymentMintArgs FreezeTokenPaymentRouteArgs FreezeTokenPaymentRouteArgsInitialize FreezeTokenPaymentRouteArgsThaw FreezeTokenPaymentRouteArgsUnlockFunds Gatekeeper GatekeeperArgs GatekeeperMintArgs GuardGroup GuardGroupArgs GuardInstructionExtras GuardManifest GuardRemainingAccount GuardSet GuardSetArgs GuardSetMintArgs GuardSetRouteArgs GuardTypeArgs HiddenSettings HiddenSettingsArgs InitializeCandyMachineInstructionAccounts InitializeCandyMachineInstructionArgs InitializeCandyMachineInstructionData InitializeCandyMachineInstructionDataArgs InitializeCandyMachineV2InstructionAccounts InitializeCandyMachineV2InstructionArgs InitializeCandyMachineV2InstructionData InitializeCandyMachineV2InstructionDataArgs MintContext MintCounter MintCounterAccountData MintCounterAccountDataArgs MintFromCandyMachineInstructionAccounts MintFromCandyMachineInstructionData MintFromCandyMachineInstructionDataArgs MintFromCandyMachineV2InstructionAccounts MintFromCandyMachineV2InstructionData MintFromCandyMachineV2InstructionDataArgs MintInstructionAccounts MintInstructionData MintInstructionDataArgs MintLimit MintLimitArgs MintLimitMintArgs MintParser MintV2InstructionAccounts MintV2InstructionData MintV2InstructionDataArgs NftBurn NftBurnArgs NftBurnMintArgs NftGate NftGateArgs NftGateMintArgs NftPayment NftPaymentArgs NftPaymentMintArgs PickPartial ProgramGate ProgramGateArgs RedeemedAmount RedeemedAmountArgs RedeemedAmountMintArgs ResolvedAccount ResolvedAccounts ResolvedAccountsWithIndices RouteContext RouteInstructionAccounts RouteInstructionData RouteInstructionDataArgs RouteParser SetCandyGuardAuthorityInstructionAccounts SetCandyGuardAuthorityInstructionArgs SetCandyGuardAuthorityInstructionData SetCandyGuardAuthorityInstructionDataArgs SetCandyMachineAuthorityInstructionAccounts SetCandyMachineAuthorityInstructionArgs SetCandyMachineAuthorityInstructionData SetCandyMachineAuthorityInstructionDataArgs SetCollectionInstructionAccounts SetCollectionInstructionData SetCollectionInstructionDataArgs SetCollectionV2InstructionAccounts SetCollectionV2InstructionData SetCollectionV2InstructionDataArgs SetMintAuthorityInstructionAccounts SetMintAuthorityInstructionData SetMintAuthorityInstructionDataArgs SetTokenStandardInstructionAccounts SetTokenStandardInstructionArgs SetTokenStandardInstructionData SetTokenStandardInstructionDataArgs SolPayment SolPaymentArgs SolPaymentMintArgs StartDate StartDateArgs ThirdPartySigner ThirdPartySignerArgs ThirdPartySignerMintArgs Token2022Payment Token2022PaymentArgs Token2022PaymentMintArgs TokenBurn TokenBurnArgs TokenBurnMintArgs TokenGate TokenGateArgs TokenGateMintArgs TokenPayment TokenPaymentArgs TokenPaymentMintArgs UnwrapInstructionAccounts UnwrapInstructionData UnwrapInstructionDataArgs UpdateCandyGuardInstructionAccounts UpdateCandyGuardInstructionData UpdateCandyGuardInstructionDataArgs UpdateCandyMachineInstructionAccounts UpdateCandyMachineInstructionArgs UpdateCandyMachineInstructionData UpdateCandyMachineInstructionDataArgs WrapInstructionAccounts WrapInstructionData WrapInstructionDataArgs

Variables

CANDY_GUARD_DATA CANDY_GUARD_LABEL_SIZE CANDY_MACHINE_HIDDEN_SECTION CIVIC_GATEWAY_PROGRAM_ID CONFIG_LINE_SIZE MASTER_EDITION_SIZE MAX_CREATOR_LEN MAX_CREATOR_LIMIT MAX_NAME_LENGTH MAX_SYMBOL_LENGTH MAX_URI_LENGTH METADATA_SIZE MPL_CANDY_GUARD_PROGRAM_ID MPL_CANDY_MACHINE_CORE_PROGRAM_ID MPL_TOKEN_AUTH_RULES_PROGRAM_ID addressGateGuardManifest allocationGuardManifest allowListGuardManifest botTaxGuardManifest defaultCandyGuardNames emptyDefaultGuardSetArgs endDateGuardManifest freezeSolPaymentGuardManifest freezeTokenPaymentGuardManifest gatekeeperGuardManifest mintLimitGuardManifest nftBurnGuardManifest nftGateGuardManifest nftPaymentGuardManifest programGateGuardManifest redeemedAmountGuardManifest solPaymentGuardManifest startDateGuardManifest thirdPartySignerGuardManifest token2022PaymentGuardManifest tokenBurnGuardManifest tokenGateGuardManifest tokenPaymentGuardManifest

Functions - Errors

getMplCandyGuardErrorFromCode getMplCandyGuardErrorFromName getMplCandyMachineCoreErrorFromCode getMplCandyMachineCoreErrorFromName

Functions - Other

addConfigLines create createCandyGuard createCandyMachine createCandyMachineV2 createCivicGatewayProgram createLutForCandyMachine createMplCandyGuardProgram createMplCandyMachineCoreProgram createMplTokenAuthRulesProgram deleteCandyGuard deleteCandyMachine deserializeAllocationTracker deserializeAllowListProof deserializeCandyGuard deserializeCandyMachine deserializeFreezeEscrow deserializeMintCounter expectPda expectPublicKey expectSome fetchAllAllocationTracker fetchAllAllowListProof fetchAllCandyGuard fetchAllCandyMachine fetchAllFreezeEscrow fetchAllMintCounter fetchAllocationTracker fetchAllocationTrackerFromSeeds fetchAllowListProof fetchAllowListProofFromSeeds fetchCandyGuard fetchCandyMachine fetchFreezeEscrow fetchFreezeEscrowFromSeeds fetchMintCounter fetchMintCounterFromSeeds findAllocationTrackerPda findAllowListProofPda findCandyGuardPda findCandyMachineAuthorityPda findFreezeEscrowPda findMintCounterPda getAccountMetasAndSigners getAccountVersionSerializer getAddConfigLinesInstructionDataSerializer getAddressGateSerializer getAllocationSerializer getAllocationTrackerAccountDataSerializer getAllocationTrackerGpaBuilder getAllocationTrackerSize getAllowListProofAccountDataSerializer getAllowListProofGpaBuilder getAllowListProofSize getAllowListSerializer getBotTaxSerializer getCandyGuardAccountDataSerializer getCandyGuardDataSerializer getCandyGuardGpaBuilder getCandyMachineAccountDataSerializer getCandyMachineDataSerializer getCandyMachineGpaBuilder getCandyMachineRuleSet getCandyMachineSize getCivicGatewayProgram getCivicGatewayProgramId getConfigLineSerializer getConfigLineSettingsSerializer getCreatorSerializer getDeleteCandyGuardInstructionDataSerializer getDeleteCandyMachineInstructionDataSerializer getEndDateSerializer getFreezeEscrowAccountDataSerializer getFreezeEscrowGpaBuilder getFreezeInstructionSerializer getFreezeSolPaymentSerializer getFreezeTokenPaymentSerializer getGatekeeperSerializer getGuardGroupSerializer getGuardSetSerializer getGuardTypeSerializer getHiddenSettingsSerializer getInitializeCandyMachineInstructionDataSerializer getInitializeCandyMachineV2InstructionDataSerializer getLutAddressesForCandyMachine getMerkleProof getMerkleProofAtIndex getMerkleRoot getMerkleTree getMintCounterAccountDataSerializer getMintCounterGpaBuilder getMintCounterSize getMintFromCandyMachineInstructionDataSerializer getMintFromCandyMachineV2InstructionDataSerializer getMintLimitSerializer getMplCandyGuardProgram getMplCandyGuardProgramId getMplCandyMachineCoreProgram getMplCandyMachineCoreProgramId getMplTokenAuthRulesProgram getMplTokenAuthRulesProgramId getNftBurnSerializer getNftGateSerializer getNftPaymentSerializer getProgramGateSerializer getRedeemedAmountSerializer getSetCandyGuardAuthorityInstructionDataSerializer getSetCandyMachineAuthorityInstructionDataSerializer getSetCollectionInstructionDataSerializer getSetCollectionV2InstructionDataSerializer getSetMintAuthorityInstructionDataSerializer getSetTokenStandardInstructionDataSerializer getSolPaymentSerializer getStartDateSerializer getThirdPartySignerSerializer getToken2022PaymentSerializer getTokenBurnSerializer getTokenGateSerializer getTokenPaymentSerializer getUnwrapInstructionDataSerializer getUpdateCandyMachineInstructionDataSerializer getWrapInstructionDataSerializer initializeCandyMachine initializeCandyMachineV2 mint mintFromCandyMachine mintFromCandyMachineV2 mintV2 mplCandyMachine noopParser parseGuardRemainingAccounts parseMintArgs parseRouteArgs route safeFetchAllAllocationTracker safeFetchAllAllowListProof safeFetchAllCandyGuard safeFetchAllCandyMachine safeFetchAllFreezeEscrow safeFetchAllMintCounter safeFetchAllocationTracker safeFetchAllocationTrackerFromSeeds safeFetchAllowListProof safeFetchAllowListProofFromSeeds safeFetchCandyGuard safeFetchCandyMachine safeFetchFreezeEscrow safeFetchFreezeEscrowFromSeeds safeFetchMintCounter safeFetchMintCounterFromSeeds setCandyGuardAuthority setCandyMachineAuthority setCollection setCollectionV2 setMintAuthority setTokenStandard unwrap updateCandyGuard updateCandyMachine wrap

Settings

Member Visibility

Theme

Generated using TypeDoc