@metaplex-foundation/mpl-candy-guard

Index

Accounts

CandyGuard FreezeEscrow CandyGuardArgs FreezeEscrowArgs candyGuardBeet freezeEscrowBeet

Instructions

InitializeInstructionAccounts InitializeInstructionArgs MintInstructionAccounts MintInstructionArgs MintV2InstructionAccounts MintV2InstructionArgs RouteInstructionAccounts RouteInstructionArgs SetAuthorityInstructionAccounts SetAuthorityInstructionArgs UnwrapInstructionAccounts UpdateInstructionAccounts UpdateInstructionArgs WithdrawInstructionAccounts WrapInstructionAccounts initializeStruct mintStruct mintV2Struct routeStruct setAuthorityStruct unwrapStruct updateStruct withdrawStruct wrapStruct createInitializeInstruction createMintInstruction createMintV2Instruction createRouteInstruction createSetAuthorityInstruction createUnwrapInstruction createUpdateInstruction createWithdrawInstruction createWrapInstruction

Errors

AddressNotAuthorizedError AddressNotFoundInAllowedListError AfterEndDateError AllocationGuardNotEnabledError AllocationLimitReachedError AllocationNotInitializedError AllowedListNotEnabledError AllowedMintLimitReachedError CandyMachineEmptyError CollectionKeyMismatchError CollectionUpdateAuthorityKeyMismatchError DataIncrementLimitExceededError DeserializationErrorError DuplicatedGroupLabelError DuplicatedMintLimitIdError ExceededLengthError ExceededMaximumFreezePeriodError ExceededProgramListSizeError FreezeEscrowAlreadyExistsError FreezeGuardNotEnabledError FreezeNotInitializedError GatewayTokenInvalidError GroupNotFoundError IncorrectOwnerError InstructionBuilderFailedError InstructionNotFoundError InvalidAccountSizeError InvalidMintAuthorityError InvalidMintTimeError InvalidNftCollectionError MaximumRedeemedAmountError MintNotLastTransactionError MintNotLiveError MissingAllowedListProofError MissingCollectionAccountsError MissingFreezeInstructionError MissingFreezePeriodError MissingNftError MissingRemainingAccountError MissingRequiredSignatureError NotEnoughSOLError NotEnoughTokensError NumericalOverflowErrorError PublicKeyMismatchError RequiredGroupLabelNotFoundError ThawNotEnabledError TokenBurnFailedError TokenTransferFailedError UnauthorizedProgramFoundError UninitializedError UnlockNotEnabledError errorFromCode errorFromName

constants

PROGRAM_ADDRESS PROGRAM_ID

enums

FreezeInstruction GuardType

userTypes

addressGateBeet allocationBeet allowListBeet allowListProofBeet botTaxBeet candyGuardDataBeet endDateBeet freezeInstructionBeet freezeSolPaymentBeet freezeTokenPaymentBeet gatekeeperBeet groupBeet guardSetBeet guardTypeBeet mintCounterBeet mintLimitBeet mintTrackerBeet nftBurnBeet nftGateBeet nftPaymentBeet programGateBeet redeemedAmountBeet routeArgsBeet solPaymentBeet startDateBeet thirdPartySignerBeet tokenBurnBeet tokenGateBeet tokenPaymentBeet

sdk

AddressGate Allocation AllowList AllowListProof BotTax CandyGuardData EndDate FreezeSolPayment FreezeTokenPayment Gatekeeper Group GuardSet MintCounter MintLimit MintTracker NftBurn NftGate NftPayment ProgramGate RedeemedAmount RouteArgs SolPayment StartDate ThirdPartySigner TokenBurn TokenGate TokenPayment accountProviders candyGuardDiscriminator cusper freezeEscrowDiscriminator initializeInstructionDiscriminator mintInstructionDiscriminator mintV2InstructionDiscriminator routeInstructionDiscriminator setAuthorityInstructionDiscriminator unwrapInstructionDiscriminator updateInstructionDiscriminator withdrawInstructionDiscriminator wrapInstructionDiscriminator deserialize logDebug logError logInfo logTrace serialize

generated

FreezeInstruction GuardType AddressNotAuthorizedError AddressNotFoundInAllowedListError AfterEndDateError AllocationGuardNotEnabledError AllocationLimitReachedError AllocationNotInitializedError AllowedListNotEnabledError AllowedMintLimitReachedError CandyGuard CandyMachineEmptyError CollectionKeyMismatchError CollectionUpdateAuthorityKeyMismatchError DataIncrementLimitExceededError DeserializationErrorError DuplicatedGroupLabelError DuplicatedMintLimitIdError ExceededLengthError ExceededMaximumFreezePeriodError ExceededProgramListSizeError FreezeEscrow FreezeEscrowAlreadyExistsError FreezeGuardNotEnabledError FreezeNotInitializedError GatewayTokenInvalidError GroupNotFoundError IncorrectOwnerError InstructionBuilderFailedError InstructionNotFoundError InvalidAccountSizeError InvalidMintAuthorityError InvalidMintTimeError InvalidNftCollectionError MaximumRedeemedAmountError MintNotLastTransactionError MintNotLiveError MissingAllowedListProofError MissingCollectionAccountsError MissingFreezeInstructionError MissingFreezePeriodError MissingNftError MissingRemainingAccountError MissingRequiredSignatureError NotEnoughSOLError NotEnoughTokensError NumericalOverflowErrorError PublicKeyMismatchError RequiredGroupLabelNotFoundError ThawNotEnabledError TokenBurnFailedError TokenTransferFailedError UnauthorizedProgramFoundError UninitializedError UnlockNotEnabledError CandyGuardArgs FreezeEscrowArgs InitializeInstructionAccounts InitializeInstructionArgs MintInstructionAccounts MintInstructionArgs MintV2InstructionAccounts MintV2InstructionArgs RouteInstructionAccounts RouteInstructionArgs SetAuthorityInstructionAccounts SetAuthorityInstructionArgs UnwrapInstructionAccounts UpdateInstructionAccounts UpdateInstructionArgs WithdrawInstructionAccounts WrapInstructionAccounts PROGRAM_ADDRESS PROGRAM_ID addressGateBeet allocationBeet allowListBeet allowListProofBeet botTaxBeet candyGuardBeet candyGuardDataBeet endDateBeet freezeEscrowBeet freezeInstructionBeet freezeSolPaymentBeet freezeTokenPaymentBeet gatekeeperBeet groupBeet guardSetBeet guardTypeBeet initializeStruct mintCounterBeet mintLimitBeet mintStruct mintTrackerBeet mintV2Struct nftBurnBeet nftGateBeet nftPaymentBeet programGateBeet redeemedAmountBeet routeArgsBeet routeStruct setAuthorityStruct solPaymentBeet startDateBeet thirdPartySignerBeet tokenBurnBeet tokenGateBeet tokenPaymentBeet unwrapStruct updateStruct withdrawStruct wrapStruct createInitializeInstruction createMintInstruction createMintV2Instruction createRouteInstruction createSetAuthorityInstruction createUnwrapInstruction createUpdateInstruction createWithdrawInstruction createWrapInstruction errorFromCode errorFromName

Initialize

InitializeInstructionAccounts InitializeInstructionArgs initializeStruct createInitializeInstruction

Mint

MintInstructionAccounts MintInstructionArgs mintStruct createMintInstruction

MintV2

MintV2InstructionAccounts MintV2InstructionArgs mintV2Struct createMintV2Instruction

Route

RouteInstructionAccounts RouteInstructionArgs routeStruct createRouteInstruction

SetAuthority

SetAuthorityInstructionAccounts SetAuthorityInstructionArgs setAuthorityStruct createSetAuthorityInstruction

Unwrap

UnwrapInstructionAccounts unwrapStruct createUnwrapInstruction

Update

UpdateInstructionAccounts UpdateInstructionArgs updateStruct createUpdateInstruction

Withdraw

WithdrawInstructionAccounts withdrawStruct createWithdrawInstruction

Wrap

WrapInstructionAccounts wrapStruct createWrapInstruction

Settings

Member Visibility

Theme

Generated using TypeDoc