Preparing search index...
The search index is not available
@metaplex-foundation/mpl-candy-machine - v6.0.1
@metaplex-foundation/mpl-candy-machine - v6.0.1
MPL_TOKEN_AUTH_RULES_PROGRAM_ID
Variable MPL_TOKEN_AUTH_RULES_PROGRAM_ID
Const
MPL_
TOKEN_
AUTH_
RULES_
PROGRAM_
ID
:
PublicKey
<
"auth9SigNpDKz4sJJ1DfCTuZrZNSAgh9sFD3rboVmgg"
>
= ...
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
@metaplex-
foundation/mpl-
candy-
machine -
v6.0.1
<internal>
Account
Version
Freeze
Instruction
Guard
Type
Candy
Guard
Required
On
Candy
Machine
Error
Candy
Machine
Error
Cg
Address
Not
Authorized
Error
Cg
Address
Not
Found
In
Allowed
List
Error
Cg
After
End
Date
Error
Cg
Allocation
Guard
Not
Enabled
Error
Cg
Allocation
Limit
Reached
Error
Cg
Allocation
Not
Initialized
Error
Cg
Allowed
List
Not
Enabled
Error
Cg
Allowed
Mint
Limit
Reached
Error
Cg
Candy
Machine
Empty
Error
Cg
Collection
Key
Mismatch
Error
Cg
Collection
Update
Authority
Key
Mismatch
Error
Cg
Data
Increment
Limit
Exceeded
Error
Cg
Deserialization
Error
Error
Cg
Duplicated
Group
Label
Error
Cg
Duplicated
Mint
Limit
Id
Error
Cg
Exceeded
Length
Error
Cg
Exceeded
Maximum
Freeze
Period
Error
Cg
Exceeded
Program
List
Size
Error
Cg
Freeze
Escrow
Already
Exists
Error
Cg
Freeze
Guard
Not
Enabled
Error
Cg
Freeze
Not
Initialized
Error
Cg
Gateway
Token
Invalid
Error
Cg
Group
Not
Found
Error
Cg
Incorrect
Owner
Error
Cg
Instruction
Builder
Failed
Error
Cg
Instruction
Not
Found
Error
Cg
Invalid
Account
Size
Error
Cg
Invalid
Account
Version
Error
Cg
Invalid
Mint
Authority
Error
Cg
Invalid
Mint
Time
Error
Cg
Invalid
Nft
Collection
Error
Cg
Maximum
Redeemed
Amount
Error
Cg
Mint
Not
Last
Transaction
Error
Cg
Mint
Not
Live
Error
Cg
Missing
Allowed
List
Proof
Error
Cg
Missing
Collection
Accounts
Error
Cg
Missing
Freeze
Instruction
Error
Cg
Missing
Freeze
Period
Error
Cg
Missing
Nft
Error
Cg
Missing
Remaining
Account
Error
Cg
Missing
Required
Signature
Error
Cg
Not
EnoughSOLError
Cg
Not
Enough
Tokens
Error
Cg
Numerical
Overflow
Error
Error
Cg
Public
Key
Mismatch
Error
Cg
Required
Group
Label
Not
Found
Error
Cg
Thaw
Not
Enabled
Error
Cg
Token
Burn
Failed
Error
Cg
Token
Transfer
Failed
Error
Cg
Unauthorized
Program
Found
Error
Cg
Uninitialized
Error
Cg
Unlock
Not
Enabled
Error
Cm
Candy
Machine
Empty
Error
Cm
Cannot
Change
Number
Of
Lines
Error
Cm
Cannot
Change
Sequential
Index
Generation
Error
Cm
Cannot
Increase
Length
Error
Cm
Cannot
Switch
From
Hidden
Settings
Error
Cm
Cannot
Switch
To
Hidden
Settings
Error
Cm
Collection
Key
Mismatch
Error
Cm
Could
Not
Retrieve
Config
Line
Data
Error
Cm
Exceeded
Length
Error
Error
Cm
Hidden
Settings
Do
Not
Have
Config
Lines
Error
Cm
Incorrect
Collection
Authority
Error
Cm
Incorrect
Owner
Error
Cm
Index
Greater
Than
Length
Error
Cm
Instruction
Builder
Failed
Error
Cm
Invalid
Account
Version
Error
Cm
Invalid
Token
Standard
Error
Cm
Metadata
Account
Must
Be
Empty
Error
Cm
Mint
Mismatch
Error
Cm
Missing
Collection
Authority
Record
Error
Cm
Missing
Config
Lines
Settings
Error
Cm
Missing
Instructions
Sysvar
Error
Cm
Missing
Metadata
Delegate
Record
Error
Cm
Missing
Spl
Ata
Program
Error
Cm
Missing
Token
Account
Error
Cm
Missing
Token
Record
Error
Cm
No
Changing
Collection
During
Mint
Error
Cm
Not
Fully
Loaded
Error
Cm
Numerical
Overflow
Error
Error
Cm
Too
Many
Creators
Error
Cm
Uninitialized
Error
Default
Guard
Repository
Guard
Group
Label
Too
Long
Error
Guard
Group
Required
Error
Guard
Mint
Settings
Missing
Error
Guard
Not
Enabled
Error
Guard
Route
Not
Supported
Error
Maximum
Of
Five
Additional
Programs
Error
Mint
Owner
Must
Be
Mint
Payer
Error
Selected
Guard
Group
Does
Not
Exist
Error
Unrecognize
Path
For
Route
Instruction
Error
Unregistered
Candy
Guard
Error
Variable
Size
Guard
Error
Guard
Repository
Account
Version
Args
Add
Config
Lines
Instruction
Accounts
Add
Config
Lines
Instruction
Args
Add
Config
Lines
Instruction
Data
Add
Config
Lines
Instruction
Data
Args
Address
Gate
Address
Gate
Args
Allocation
Allocation
Args
Allocation
Mint
Args
Allocation
Route
Args
Allocation
Tracker
Allocation
Tracker
Account
Data
Allocation
Tracker
Account
Data
Args
Allow
List
Allow
List
Args
Allow
List
Mint
Args
Allow
List
Proof
Allow
List
Proof
Account
Data
Allow
List
Proof
Account
Data
Args
Allow
List
Route
Args
Any
Guard
Manifest
Bot
Tax
Bot
Tax
Args
Candy
Guard
Candy
Guard
Account
Data
Candy
Guard
Account
Data
Args
Candy
Guard
Data
Candy
Guard
Data
Args
Candy
Guard
Program
Candy
Machine
Candy
Machine
Account
Data
Candy
Machine
Account
Data
Args
Candy
Machine
Data
Candy
Machine
Data
Args
Candy
Machine
Item
Config
Line
Config
Line
Args
Config
Line
Settings
Config
Line
Settings
Args
Create
Candy
Guard
Instruction
Accounts
Create
Candy
Guard
Instruction
Data
Create
Candy
Guard
Instruction
Data
Args
Create
Candy
Machine
Input
Create
Candy
Machine
V2
Input
Create
Input
Creator
Creator
Args
Default
Guard
Set
Default
Guard
Set
Args
Default
Guard
Set
Mint
Args
Default
Guard
Set
Route
Args
Delete
Candy
Guard
Instruction
Accounts
Delete
Candy
Guard
Instruction
Data
Delete
Candy
Guard
Instruction
Data
Args
Delete
Candy
Machine
Instruction
Accounts
Delete
Candy
Machine
Instruction
Data
Delete
Candy
Machine
Instruction
Data
Args
End
Date
End
Date
Args
Freeze
Escrow
Freeze
Escrow
Account
Data
Freeze
Escrow
Account
Data
Args
Freeze
Instruction
Args
Freeze
Sol
Payment
Freeze
Sol
Payment
Args
Freeze
Sol
Payment
Mint
Args
Freeze
Sol
Payment
Route
Args
Freeze
Sol
Payment
Route
Args
Initialize
Freeze
Sol
Payment
Route
Args
Thaw
Freeze
Sol
Payment
Route
Args
Unlock
Funds
Freeze
Token
Payment
Freeze
Token
Payment
Args
Freeze
Token
Payment
Mint
Args
Freeze
Token
Payment
Route
Args
Freeze
Token
Payment
Route
Args
Initialize
Freeze
Token
Payment
Route
Args
Thaw
Freeze
Token
Payment
Route
Args
Unlock
Funds
Gatekeeper
Gatekeeper
Args
Gatekeeper
Mint
Args
Guard
Group
Guard
Group
Args
Guard
Instruction
Extras
Guard
Manifest
Guard
Remaining
Account
Guard
Set
Guard
Set
Args
Guard
Set
Mint
Args
Guard
Set
Route
Args
Guard
Type
Args
Hidden
Settings
Hidden
Settings
Args
Initialize
Candy
Machine
Instruction
Accounts
Initialize
Candy
Machine
Instruction
Args
Initialize
Candy
Machine
Instruction
Data
Initialize
Candy
Machine
Instruction
Data
Args
Initialize
Candy
Machine
V2
Instruction
Accounts
Initialize
Candy
Machine
V2
Instruction
Args
Initialize
Candy
Machine
V2
Instruction
Data
Initialize
Candy
Machine
V2
Instruction
Data
Args
Mint
Context
Mint
Counter
Mint
Counter
Account
Data
Mint
Counter
Account
Data
Args
Mint
From
Candy
Machine
Instruction
Accounts
Mint
From
Candy
Machine
Instruction
Data
Mint
From
Candy
Machine
Instruction
Data
Args
Mint
From
Candy
Machine
V2
Instruction
Accounts
Mint
From
Candy
Machine
V2
Instruction
Data
Mint
From
Candy
Machine
V2
Instruction
Data
Args
Mint
Instruction
Accounts
Mint
Instruction
Data
Mint
Instruction
Data
Args
Mint
Limit
Mint
Limit
Args
Mint
Limit
Mint
Args
Mint
Parser
Mint
V2
Instruction
Accounts
Mint
V2
Instruction
Data
Mint
V2
Instruction
Data
Args
Nft
Burn
Nft
Burn
Args
Nft
Burn
Mint
Args
Nft
Gate
Nft
Gate
Args
Nft
Gate
Mint
Args
Nft
Payment
Nft
Payment
Args
Nft
Payment
Mint
Args
Pick
Partial
Program
Gate
Program
Gate
Args
Redeemed
Amount
Redeemed
Amount
Args
Redeemed
Amount
Mint
Args
Resolved
Account
Resolved
Accounts
Resolved
Accounts
With
Indices
Route
Context
Route
Instruction
Accounts
Route
Instruction
Data
Route
Instruction
Data
Args
Route
Parser
Set
Candy
Guard
Authority
Instruction
Accounts
Set
Candy
Guard
Authority
Instruction
Args
Set
Candy
Guard
Authority
Instruction
Data
Set
Candy
Guard
Authority
Instruction
Data
Args
Set
Candy
Machine
Authority
Instruction
Accounts
Set
Candy
Machine
Authority
Instruction
Args
Set
Candy
Machine
Authority
Instruction
Data
Set
Candy
Machine
Authority
Instruction
Data
Args
Set
Collection
Instruction
Accounts
Set
Collection
Instruction
Data
Set
Collection
Instruction
Data
Args
Set
Collection
V2
Instruction
Accounts
Set
Collection
V2
Instruction
Data
Set
Collection
V2
Instruction
Data
Args
Set
Mint
Authority
Instruction
Accounts
Set
Mint
Authority
Instruction
Data
Set
Mint
Authority
Instruction
Data
Args
Set
Token
Standard
Instruction
Accounts
Set
Token
Standard
Instruction
Args
Set
Token
Standard
Instruction
Data
Set
Token
Standard
Instruction
Data
Args
Sol
Payment
Sol
Payment
Args
Sol
Payment
Mint
Args
Start
Date
Start
Date
Args
Third
Party
Signer
Third
Party
Signer
Args
Third
Party
Signer
Mint
Args
Token2022
Payment
Token2022
Payment
Args
Token2022
Payment
Mint
Args
Token
Burn
Token
Burn
Args
Token
Burn
Mint
Args
Token
Gate
Token
Gate
Args
Token
Gate
Mint
Args
Token
Payment
Token
Payment
Args
Token
Payment
Mint
Args
Unwrap
Instruction
Accounts
Unwrap
Instruction
Data
Unwrap
Instruction
Data
Args
Update
Candy
Guard
Instruction
Accounts
Update
Candy
Guard
Instruction
Data
Update
Candy
Guard
Instruction
Data
Args
Update
Candy
Machine
Instruction
Accounts
Update
Candy
Machine
Instruction
Args
Update
Candy
Machine
Instruction
Data
Update
Candy
Machine
Instruction
Data
Args
Wrap
Instruction
Accounts
Wrap
Instruction
Data
Wrap
Instruction
Data
Args
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
address
Gate
Guard
Manifest
allocation
Guard
Manifest
allow
List
Guard
Manifest
bot
Tax
Guard
Manifest
default
Candy
Guard
Names
empty
Default
Guard
Set
Args
end
Date
Guard
Manifest
freeze
Sol
Payment
Guard
Manifest
freeze
Token
Payment
Guard
Manifest
gatekeeper
Guard
Manifest
mint
Limit
Guard
Manifest
nft
Burn
Guard
Manifest
nft
Gate
Guard
Manifest
nft
Payment
Guard
Manifest
program
Gate
Guard
Manifest
redeemed
Amount
Guard
Manifest
sol
Payment
Guard
Manifest
start
Date
Guard
Manifest
third
Party
Signer
Guard
Manifest
token2022
Payment
Guard
Manifest
token
Burn
Guard
Manifest
token
Gate
Guard
Manifest
token
Payment
Guard
Manifest
add
Config
Lines
create
create
Candy
Guard
create
Candy
Machine
create
Candy
Machine
V2
create
Civic
Gateway
Program
create
Lut
For
Candy
Machine
create
Mpl
Candy
Guard
Program
create
Mpl
Candy
Machine
Core
Program
create
Mpl
Token
Auth
Rules
Program
delete
Candy
Guard
delete
Candy
Machine
deserialize
Allocation
Tracker
deserialize
Allow
List
Proof
deserialize
Candy
Guard
deserialize
Candy
Machine
deserialize
Freeze
Escrow
deserialize
Mint
Counter
expect
Pda
expect
Public
Key
expect
Some
fetch
All
Allocation
Tracker
fetch
All
Allow
List
Proof
fetch
All
Candy
Guard
fetch
All
Candy
Machine
fetch
All
Freeze
Escrow
fetch
All
Mint
Counter
fetch
Allocation
Tracker
fetch
Allocation
Tracker
From
Seeds
fetch
Allow
List
Proof
fetch
Allow
List
Proof
From
Seeds
fetch
Candy
Guard
fetch
Candy
Machine
fetch
Freeze
Escrow
fetch
Freeze
Escrow
From
Seeds
fetch
Mint
Counter
fetch
Mint
Counter
From
Seeds
find
Allocation
Tracker
Pda
find
Allow
List
Proof
Pda
find
Candy
Guard
Pda
find
Candy
Machine
Authority
Pda
find
Freeze
Escrow
Pda
find
Mint
Counter
Pda
get
Account
Metas
And
Signers
get
Account
Version
Serializer
get
Add
Config
Lines
Instruction
Data
Serializer
get
Address
Gate
Serializer
get
Allocation
Serializer
get
Allocation
Tracker
Account
Data
Serializer
get
Allocation
Tracker
Gpa
Builder
get
Allocation
Tracker
Size
get
Allow
List
Proof
Account
Data
Serializer
get
Allow
List
Proof
Gpa
Builder
get
Allow
List
Proof
Size
get
Allow
List
Serializer
get
Bot
Tax
Serializer
get
Candy
Guard
Account
Data
Serializer
get
Candy
Guard
Data
Serializer
get
Candy
Guard
Gpa
Builder
get
Candy
Machine
Account
Data
Serializer
get
Candy
Machine
Data
Serializer
get
Candy
Machine
Gpa
Builder
get
Candy
Machine
Rule
Set
get
Candy
Machine
Size
get
Civic
Gateway
Program
get
Civic
Gateway
Program
Id
get
Config
Line
Serializer
get
Config
Line
Settings
Serializer
get
Creator
Serializer
get
Delete
Candy
Guard
Instruction
Data
Serializer
get
Delete
Candy
Machine
Instruction
Data
Serializer
get
End
Date
Serializer
get
Freeze
Escrow
Account
Data
Serializer
get
Freeze
Escrow
Gpa
Builder
get
Freeze
Instruction
Serializer
get
Freeze
Sol
Payment
Serializer
get
Freeze
Token
Payment
Serializer
get
Gatekeeper
Serializer
get
Guard
Group
Serializer
get
Guard
Set
Serializer
get
Guard
Type
Serializer
get
Hidden
Settings
Serializer
get
Initialize
Candy
Machine
Instruction
Data
Serializer
get
Initialize
Candy
Machine
V2
Instruction
Data
Serializer
get
Lut
Addresses
For
Candy
Machine
get
Merkle
Proof
get
Merkle
Proof
At
Index
get
Merkle
Root
get
Merkle
Tree
get
Mint
Counter
Account
Data
Serializer
get
Mint
Counter
Gpa
Builder
get
Mint
Counter
Size
get
Mint
From
Candy
Machine
Instruction
Data
Serializer
get
Mint
From
Candy
Machine
V2
Instruction
Data
Serializer
get
Mint
Limit
Serializer
get
Mpl
Candy
Guard
Error
From
Code
get
Mpl
Candy
Guard
Error
From
Name
get
Mpl
Candy
Guard
Program
get
Mpl
Candy
Guard
Program
Id
get
Mpl
Candy
Machine
Core
Error
From
Code
get
Mpl
Candy
Machine
Core
Error
From
Name
get
Mpl
Candy
Machine
Core
Program
get
Mpl
Candy
Machine
Core
Program
Id
get
Mpl
Token
Auth
Rules
Program
get
Mpl
Token
Auth
Rules
Program
Id
get
Nft
Burn
Serializer
get
Nft
Gate
Serializer
get
Nft
Payment
Serializer
get
Program
Gate
Serializer
get
Redeemed
Amount
Serializer
get
Set
Candy
Guard
Authority
Instruction
Data
Serializer
get
Set
Candy
Machine
Authority
Instruction
Data
Serializer
get
Set
Collection
Instruction
Data
Serializer
get
Set
Collection
V2
Instruction
Data
Serializer
get
Set
Mint
Authority
Instruction
Data
Serializer
get
Set
Token
Standard
Instruction
Data
Serializer
get
Sol
Payment
Serializer
get
Start
Date
Serializer
get
Third
Party
Signer
Serializer
get
Token2022
Payment
Serializer
get
Token
Burn
Serializer
get
Token
Gate
Serializer
get
Token
Payment
Serializer
get
Unwrap
Instruction
Data
Serializer
get
Update
Candy
Machine
Instruction
Data
Serializer
get
Wrap
Instruction
Data
Serializer
initialize
Candy
Machine
initialize
Candy
Machine
V2
mint
mint
From
Candy
Machine
mint
From
Candy
Machine
V2
mint
V2
mpl
Candy
Machine
noop
Parser
parse
Guard
Remaining
Accounts
parse
Mint
Args
parse
Route
Args
route
safe
Fetch
All
Allocation
Tracker
safe
Fetch
All
Allow
List
Proof
safe
Fetch
All
Candy
Guard
safe
Fetch
All
Candy
Machine
safe
Fetch
All
Freeze
Escrow
safe
Fetch
All
Mint
Counter
safe
Fetch
Allocation
Tracker
safe
Fetch
Allocation
Tracker
From
Seeds
safe
Fetch
Allow
List
Proof
safe
Fetch
Allow
List
Proof
From
Seeds
safe
Fetch
Candy
Guard
safe
Fetch
Candy
Machine
safe
Fetch
Freeze
Escrow
safe
Fetch
Freeze
Escrow
From
Seeds
safe
Fetch
Mint
Counter
safe
Fetch
Mint
Counter
From
Seeds
set
Candy
Guard
Authority
set
Candy
Machine
Authority
set
Collection
set
Collection
V2
set
Mint
Authority
set
Token
Standard
unwrap
update
Candy
Guard
update
Candy
Machine
wrap
Generated using
TypeDoc