Enum IdlCommand 

pub enum IdlCommand {
    Init {
        program_id: Option<Pubkey>,
        filepath: String,
        priority_fee: Option<u64>,
        non_canonical: bool,
    },
    Upgrade {
        program_id: Option<Pubkey>,
        filepath: String,
        priority_fee: Option<u64>,
    },
    Build {
        program_name: Option<String>,
        out: Option<String>,
        out_ts: Option<String>,
        no_docs: bool,
        skip_lint: bool,
        cargo_args: Vec<String>,
    },
    Fetch {
        program_id: Pubkey,
        out: Option<String>,
        non_canonical: bool,
    },
    Convert {
        path: String,
        out: Option<String>,
        program_id: Option<Pubkey>,
    },
    Type {
        path: String,
        out: Option<String>,
    },
    Close {
        program_id: Pubkey,
        seed: String,
        priority_fee: Option<u64>,
    },
    CreateBuffer {
        filepath: String,
        priority_fee: Option<u64>,
    },
    SetBufferAuthority {
        buffer: Pubkey,
        new_authority: Pubkey,
        priority_fee: Option<u64>,
    },
    WriteBuffer {
        program_id: Pubkey,
        buffer: Pubkey,
        seed: String,
        close_buffer: bool,
        priority_fee: Option<u64>,
    },
}

Variants

Init

Initializes a program’s IDL account. Can only be run once.

Fields

program_id: Option<Pubkey>

Program id to initialize IDL for. If not provided, discovers program ID from IDL.

filepath: String

priority_fee: Option<u64>

non_canonical: bool

Create non-canonical metadata account (third-party metadata)

Upgrade

Upgrades the IDL to the new file. An alias for first writing and then then setting the idl buffer account.

Fields

program_id: Option<Pubkey>

Program id to upgrade IDL for. If not provided, discovers program ID from IDL.

filepath: String

priority_fee: Option<u64>

Build

Generates the IDL for the program using the compilation method.

Fields

program_name: Option<String>

out: Option<String>

Output file for the IDL (stdout if not specified)

out_ts: Option<String>

Output file for the TypeScript IDL

no_docs: bool

Suppress doc strings in output

skip_lint: bool

Do not check for safety comments

cargo_args: Vec<String>

Arguments to pass to the underlying cargo test command

Fetch

Fetches an IDL for the given program from a cluster.

Fields

program_id: Pubkey

out: Option<String>

Output file for the IDL (stdout if not specified).

non_canonical: bool

Fetch non-canonical metadata account (third-party metadata)

Convert

Convert legacy IDLs (pre Anchor 0.30) to the new IDL spec

Fields

path: String

Path to the IDL file

out: Option<String>

Output file for the IDL (stdout if not specified)

program_id: Option<Pubkey>

Program id to initialize IDL for. If not provided, discovers program ID from IDL.

Type

Generate TypeScript type for the IDL

Fields

path: String

Path to the IDL file

out: Option<String>

Output file for the IDL (stdout if not specified)

Close

Close a metadata account and recover rent

Fields

program_id: Pubkey

The program ID

seed: String

The seed used for the metadata account (default: “idl”)

priority_fee: Option<u64>

Priority fees in micro-lamports per compute unit

CreateBuffer

Create a buffer account for metadata

Fields

filepath: String

Path to the metadata file

priority_fee: Option<u64>

Priority fees in micro-lamports per compute unit

SetBufferAuthority

Set a new authority on a buffer account

Fields

buffer: Pubkey

The buffer account address

new_authority: Pubkey

The new authority

priority_fee: Option<u64>

Priority fees in micro-lamports per compute unit

WriteBuffer

Write metadata using a buffer account

Fields

program_id: Pubkey

The program ID

buffer: Pubkey

The buffer account address

seed: String

The seed to use for the metadata account (default: “idl”)

close_buffer: bool

Close the buffer after writing

priority_fee: Option<u64>

Priority fees in micro-lamports per compute unit

Trait Implementations

impl CommandFactory for IdlCommand

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for IdlCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for IdlCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for IdlCommand

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Subcommand for IdlCommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand