1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
use clap::{Parser, Subcommand};
use crate::{
config::TokenStandard,
constants::{
DEFAULT_AIRDROP_LIST, DEFAULT_AIRDROP_LIST_HELP, DEFAULT_ASSETS, DEFAULT_CACHE,
DEFAULT_CONFIG,
},
};
#[derive(Parser)]
#[clap(author, version, about)]
pub struct Cli {
/// Log level: trace, debug, info, warn, error, off
#[clap(short, long, global = true)]
pub log_level: Option<String>,
#[clap(subcommand)]
pub command: Commands,
}
#[derive(Subcommand)]
pub enum Commands {
/// Interact with the bundlr network
Bundlr {
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
#[clap(subcommand)]
action: BundlrAction,
},
/// Manage the collection on the candy machine
Collection {
#[clap(subcommand)]
command: CollectionSubcommands,
},
/// Manage candy machine configuration
Config {
#[clap(subcommand)]
command: ConfigSubcommands,
},
/// Deploy cache items into candy machine config on-chain
Deploy {
/// Path to the config file, defaults to "config.json"
#[clap(short, long, default_value = DEFAULT_CONFIG)]
config: String,
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// The optional collection address where the candymachine will mint the tokens to
#[clap(long)]
collection_mint: Option<String>,
},
/// Manage freeze guard actions
Freeze {
#[clap(subcommand)]
command: FreezeCommand,
},
/// Manage guards on the candy machine
Guard {
#[clap(subcommand)]
command: GuardCommand,
},
/// Generate hash of cache file for hidden settings.
Hash {
/// Path to the config file, defaults to "config.json"
#[clap(short, long, default_value = DEFAULT_CONFIG)]
config: String,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// Compare a provided hash with a cache file to check integrity.
#[clap(long)]
compare: Option<String>,
},
/// Create a candy machine deployment from assets
Launch {
/// Path to the directory with the assets to upload
#[clap(default_value = DEFAULT_ASSETS)]
assets_dir: String,
/// Path to the keypair file [default: solana config or "~/.config/solana/id.json"]
#[clap(short, long)]
keypair: Option<String>,
/// Path to the config file
#[clap(short, long, default_value = DEFAULT_CONFIG)]
config: String,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// Strict mode: validate against JSON metadata standard exactly
#[clap(long)]
strict: bool,
/// Skip collection validate prompt
#[clap(long)]
skip_collection_prompt: bool,
},
/// Mint one NFT from candy machine
Mint {
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// Amount of NFTs to be minted in bulk
#[clap(short, long)]
number: Option<u64>,
/// Public key of the receiver of the minted NFT, defaults to keypair
#[clap(long)]
receiver: Option<String>,
/// Address of candy machine to mint from.
#[clap(long)]
candy_machine: Option<String>,
},
/// Airdrop NFTs from candy machine
Airdrop {
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// Address of candy machine to mint from.
#[clap(long)]
candy_machine: Option<String>,
/// List of airdrop targets.
#[clap(long, default_value = DEFAULT_AIRDROP_LIST, help = DEFAULT_AIRDROP_LIST_HELP)]
airdrop_list: String,
},
/// Reveal the NFTs from a hidden settings candy machine
Reveal {
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// Path to the config file
#[clap(short, long, default_value = DEFAULT_CONFIG)]
config: String,
/// RPC timeout to retrieve the mint list (in seconds).
#[clap(short, long)]
timeout: Option<u64>,
},
/// Show the on-chain config of an existing candy machine
Show {
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// Address of candy machine
candy_machine: Option<String>,
/// Display a list of unminted indices
#[clap(long)]
unminted: bool,
},
/// Sign one or all NFTs from candy machine
Sign {
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// Mint id for single NFT to be signed
#[clap(short, long)]
mint: Option<String>,
/// Candy machine id.
#[clap(long)]
candy_machine_id: Option<String>,
},
/// Upload assets to storage and creates the cache config
Upload {
/// Path to the directory with the assets to upload
#[clap(default_value = DEFAULT_ASSETS)]
assets_dir: String,
/// Path to the config file
#[clap(short, long, default_value = DEFAULT_CONFIG)]
config: String,
/// Path to the keypair file [default: solana config or "~/.config/solana/id.json"]
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
},
/// Validate JSON metadata files
Validate {
/// Assets directory to upload, defaults to "assets"
#[clap(default_value = DEFAULT_ASSETS)]
assets_dir: String,
/// Strict mode: validate against JSON metadata standard exactly
#[clap(long)]
strict: bool,
/// Skip collection prompt
#[clap(long)]
skip_collection_prompt: bool,
},
/// Verify uploaded data
Verify {
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
},
/// Withdraw funds a from candy machine account closing it
Withdraw {
/// Address of candy machine to withdraw funds from.
#[clap(long)]
candy_machine: Option<String>,
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// List available candy machines, no withdraw performed
#[clap(long)]
list: bool,
},
}
#[derive(Subcommand)]
pub enum BundlrAction {
/// Retrieve the balance on bundlr
Balance,
/// Withdraw funds from bundlr
Withdraw,
}
#[derive(Subcommand)]
pub enum ConfigSubcommands {
/// Interactive process to create a config file
Create {
/// Path to the config file
#[clap(short, long)]
config: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the keypair file [default: solana config or "~/.config/solana/id.json"]
#[clap(short, long)]
keypair: Option<String>,
/// Path to the directory with the assets
#[clap(default_value = DEFAULT_ASSETS)]
assets_dir: String,
},
/// Update the candy machine config on-chain
Update {
/// Path to the config file, defaults to "config.json"
#[clap(short, long, default_value = DEFAULT_CONFIG)]
config: String,
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// Pubkey for the new authority
#[clap(short, long)]
new_authority: Option<String>,
/// Address of candy machine to update.
#[clap(long)]
candy_machine: Option<String>,
},
/// Set specific candy machine config values
Set {
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// Token Standard to set.
#[clap(short, long)]
token_standard: Option<TokenStandard>,
/// Address of candy machine to update.
#[clap(long)]
candy_machine: Option<String>,
/// Address of the rule set to use.
#[clap(long)]
rule_set: Option<String>,
},
}
#[derive(Subcommand)]
pub enum CollectionSubcommands {
/// Set the collection mint on the candy machine
Set {
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// Path to the config file
#[clap(short, long, default_value = DEFAULT_CONFIG)]
config: String,
/// Address of candy machine to update.
#[clap(long)]
candy_machine: Option<String>,
/// Address of collection mint to set the candy machine to.
collection_mint: String,
},
}
#[derive(Subcommand)]
pub enum GuardCommand {
/// Add a candy guard on a candy machine
Add {
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// Path to the config file
#[clap(short, long, default_value = DEFAULT_CONFIG)]
config: String,
/// Address of the candy machine.
#[clap(long)]
candy_machine: Option<String>,
/// Address of the candy guard.
#[clap(long)]
candy_guard: Option<String>,
},
/// Remove a candy guard from a candy machine
Remove {
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// Address of the candy machine.
#[clap(long)]
candy_machine: Option<String>,
/// Address of the candy guard.
#[clap(long)]
candy_guard: Option<String>,
},
/// Show the on-chain config of an existing candy guard
Show {
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// Address of the candy guard.
#[clap(long)]
candy_guard: Option<String>,
},
/// Update the configuration of a candy guard
Update {
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// Path to the config file
#[clap(short, long, default_value = DEFAULT_CONFIG)]
config: String,
/// Address of the candy guard.
#[clap(long)]
candy_guard: Option<String>,
},
/// Withdraw funds from a candy guard account closing it
Withdraw {
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// Address of the candy guard.
#[clap(long)]
candy_guard: Option<String>,
},
}
#[derive(Subcommand)]
pub enum FreezeCommand {
/// Initialize the freeze escrow account.
Initialize {
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// Path to the config file
#[clap(short, long, default_value = DEFAULT_CONFIG)]
config: String,
/// Address of candy guard to update [defaults to cache value].
#[clap(long)]
candy_guard: Option<String>,
/// Address of candy machine to update [defaults to cache value].
#[clap(long)]
candy_machine: Option<String>,
/// Candy guard group label.
#[clap(long)]
label: Option<String>,
/// Freeze period in seconds (maximum 30 days).
#[clap(long)]
period: u64,
},
/// Thaw a NFT or all NFTs in a candy guard.
Thaw {
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// Path to the config file
#[clap(short, long, default_value = DEFAULT_CONFIG)]
config: String,
/// Unthaw all NFTs in the candy machine.
#[clap(long)]
all: bool,
/// Address of the NFT to thaw.
nft_mint: Option<String>,
/// Address of candy guard to update [defaults to cache value].
#[clap(long)]
candy_guard: Option<String>,
/// Address of candy machine to update [defaults to cache value].
#[clap(long)]
candy_machine: Option<String>,
/// Address of the destination account on the freeze guard.
#[clap(long)]
destination: Option<String>,
/// Candy guard group label.
#[clap(long)]
label: Option<String>,
/// Indicates to create/use a cache file for mint list.
#[clap(long)]
use_cache: bool,
/// RPC timeout to retrieve the mint list (in seconds).
#[clap(short, long)]
timeout: Option<u64>,
/// Indicates whether this is a freeze token payment guard or not.
#[clap(long)]
token: bool,
},
/// Unlock treasury funds after freeze is turned off or expires.
UnlockFunds {
/// Path to the keypair file, uses Sol config or defaults to "~/.config/solana/id.json"
#[clap(short, long)]
keypair: Option<String>,
/// RPC Url
#[clap(short, long)]
rpc_url: Option<String>,
/// Path to the cache file, defaults to "cache.json"
#[clap(long, default_value = DEFAULT_CACHE)]
cache: String,
/// Path to the config file
#[clap(short, long, default_value = DEFAULT_CONFIG)]
config: String,
/// Address of candy guard to update [defaults to cache value].
#[clap(long)]
candy_guard: Option<String>,
/// Address of candy machine to update [defaults to cache value].
#[clap(long)]
candy_machine: Option<String>,
/// Address of the destination (treasury) account.
#[clap(long)]
destination: Option<String>,
/// Candy guard group label.
#[clap(long)]
label: Option<String>,
/// Indicates whether this is a freeze token payment guard or not.
#[clap(long)]
token: bool,
},
}