@metaplex-foundation/mpl-candy-guard

Index

Accounts

AllowListProof CandyGuard MintCounter AllowListProofArgs CandyGuardArgs MintCounterArgs allowListProofBeet candyGuardBeet mintCounterBeet

Instructions

InitializeInstructionAccounts InitializeInstructionArgs MintInstructionAccounts MintInstructionArgs RouteInstructionAccounts RouteInstructionArgs UnwrapInstructionAccounts UpdateInstructionAccounts UpdateInstructionArgs WithdrawInstructionAccounts WrapInstructionAccounts initializeStruct mintStruct routeStruct unwrapStruct updateStruct withdrawStruct wrapStruct createInitializeInstruction createMintInstruction createRouteInstruction createUnwrapInstruction createUpdateInstruction createWithdrawInstruction createWrapInstruction

Errors

AddressNotAuthorizedError AddressNotFoundInAllowedListError AfterEndDateError AllowedListNotEnabledError AllowedMintLimitReachedError CandyMachineEmptyError CollectionKeyMismatchError CollectionUpdateAuthorityKeyMismatchError DataIncrementLimitExceededError DeserializationErrorError GatewayTokenInvalidError GroupNotFoundError IncorrectOwnerError InstructionNotFoundError InvalidAccountSizeError InvalidMintTimeError InvalidNftCollectionError LabelExceededLengthError MaximumRedeemedAmountError MintNotLastTransactionError MintNotLiveError MissingAllowedListProofError MissingCollectionAccountsError MissingNftError MissingRemainingAccountError MissingRequiredSignatureError NotEnoughSOLError NotEnoughTokensError NumericalOverflowErrorError PublicKeyMismatchError RequiredGroupLabelNotFoundError TokenBurnFailedError TokenTransferFailedError UninitializedError errorFromCode errorFromName

constants

PROGRAM_ADDRESS PROGRAM_ID

enums

GuardType

userTypes

addressGateBeet allowListBeet botTaxBeet candyGuardDataBeet endDateBeet gatekeeperBeet groupBeet guardSetBeet guardTypeBeet mintLimitBeet nftBurnBeet nftGateBeet nftPaymentBeet redeemedAmountBeet routeArgsBeet solPaymentBeet startDateBeet thirdPartySignerBeet tokenBurnBeet tokenGateBeet tokenPaymentBeet

sdk

AddressGate AllowList BotTax CandyGuardData EndDate Gatekeeper Group GuardSet MintLimit NftBurn NftGate NftPayment RedeemedAmount RouteArgs SolPayment StartDate ThirdPartySigner TokenBurn TokenGate TokenPayment accountProviders allowListProofDiscriminator candyGuardDiscriminator cusper initializeInstructionDiscriminator mintCounterDiscriminator mintInstructionDiscriminator routeInstructionDiscriminator unwrapInstructionDiscriminator updateInstructionDiscriminator withdrawInstructionDiscriminator wrapInstructionDiscriminator logDebug logError logInfo logTrace parseData

generated

GuardType AddressNotAuthorizedError AddressNotFoundInAllowedListError AfterEndDateError AllowListProof AllowedListNotEnabledError AllowedMintLimitReachedError CandyGuard CandyMachineEmptyError CollectionKeyMismatchError CollectionUpdateAuthorityKeyMismatchError DataIncrementLimitExceededError DeserializationErrorError GatewayTokenInvalidError GroupNotFoundError IncorrectOwnerError InstructionNotFoundError InvalidAccountSizeError InvalidMintTimeError InvalidNftCollectionError LabelExceededLengthError MaximumRedeemedAmountError MintCounter MintNotLastTransactionError MintNotLiveError MissingAllowedListProofError MissingCollectionAccountsError MissingNftError MissingRemainingAccountError MissingRequiredSignatureError NotEnoughSOLError NotEnoughTokensError NumericalOverflowErrorError PublicKeyMismatchError RequiredGroupLabelNotFoundError TokenBurnFailedError TokenTransferFailedError UninitializedError AllowListProofArgs CandyGuardArgs InitializeInstructionAccounts InitializeInstructionArgs MintCounterArgs MintInstructionAccounts MintInstructionArgs RouteInstructionAccounts RouteInstructionArgs UnwrapInstructionAccounts UpdateInstructionAccounts UpdateInstructionArgs WithdrawInstructionAccounts WrapInstructionAccounts PROGRAM_ADDRESS PROGRAM_ID addressGateBeet allowListBeet allowListProofBeet botTaxBeet candyGuardBeet candyGuardDataBeet endDateBeet gatekeeperBeet groupBeet guardSetBeet guardTypeBeet initializeStruct mintCounterBeet mintLimitBeet mintStruct nftBurnBeet nftGateBeet nftPaymentBeet redeemedAmountBeet routeArgsBeet routeStruct solPaymentBeet startDateBeet thirdPartySignerBeet tokenBurnBeet tokenGateBeet tokenPaymentBeet unwrapStruct updateStruct withdrawStruct wrapStruct createInitializeInstruction createMintInstruction createRouteInstruction createUnwrapInstruction createUpdateInstruction createWithdrawInstruction createWrapInstruction errorFromCode errorFromName

Initialize

InitializeInstructionAccounts InitializeInstructionArgs initializeStruct createInitializeInstruction

Mint

MintInstructionAccounts MintInstructionArgs mintStruct createMintInstruction

Route

RouteInstructionAccounts RouteInstructionArgs routeStruct createRouteInstruction

Unwrap

UnwrapInstructionAccounts unwrapStruct createUnwrapInstruction

Update

UpdateInstructionAccounts UpdateInstructionArgs updateStruct createUpdateInstruction

Withdraw

WithdrawInstructionAccounts withdrawStruct createWithdrawInstruction

Wrap

WrapInstructionAccounts wrapStruct createWrapInstruction

Settings

Member Visibility

Theme

Generated using TypeDoc