Enum IdlCommand 

pub enum IdlCommand {
    Init {
        program_id: Pubkey,
        filepath: String,
        priority_fee: Option<u64>,
    },
    Close {
        program_id: Pubkey,
        idl_address: Option<Pubkey>,
        print_only: bool,
        priority_fee: Option<u64>,
    },
    WriteBuffer {
        program_id: Pubkey,
        filepath: String,
        priority_fee: Option<u64>,
    },
    SetBuffer {
        program_id: Pubkey,
        buffer: Pubkey,
        print_only: bool,
        priority_fee: Option<u64>,
    },
    Upgrade {
        program_id: Pubkey,
        filepath: String,
        priority_fee: Option<u64>,
    },
    SetAuthority {
        address: Option<Pubkey>,
        program_id: Pubkey,
        new_authority: Pubkey,
        print_only: bool,
        priority_fee: Option<u64>,
    },
    EraseAuthority {
        program_id: Pubkey,
        priority_fee: Option<u64>,
    },
    Authority {
        program_id: Pubkey,
    },
    Build {
        program_name: Option<String>,
        out: Option<String>,
        out_ts: Option<String>,
        no_docs: bool,
        skip_lint: bool,
        cargo_args: Vec<String>,
    },
    Fetch {
        address: Pubkey,
        out: Option<String>,
    },
    Convert {
        path: String,
        out: Option<String>,
        program_id: Option<Pubkey>,
    },
    Type {
        path: String,
        out: Option<String>,
    },
}

Variants

Init

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

Fields

program_id: Pubkey

filepath: String

priority_fee: Option<u64>

Close

Fields

program_id: Pubkey

idl_address: Option<Pubkey>

The IDL account to close. If none is given, then the IDL account derived from program_id is used.

print_only: bool

When used, the content of the instruction will only be printed in base64 form and not executed. Useful for multisig execution when the local wallet keypair is not available.

priority_fee: Option<u64>

WriteBuffer

Writes an IDL into a buffer account. This can be used with SetBuffer to perform an upgrade.

Fields

program_id: Pubkey

filepath: String

priority_fee: Option<u64>

SetBuffer

Sets a new IDL buffer for the program.

Fields

program_id: Pubkey

buffer: Pubkey

Address of the buffer account to set as the idl on the program.

print_only: bool

When used, the content of the instruction will only be printed in base64 form and not executed. Useful for multisig execution when the local wallet keypair is not available.

priority_fee: Option<u64>

Upgrade

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

Fields

program_id: Pubkey

filepath: String

priority_fee: Option<u64>

SetAuthority

Sets a new authority on the IDL account.

Fields

address: Option<Pubkey>

The IDL account buffer to set the authority of. If none is given, then the canonical IDL account is used.

program_id: Pubkey

Program to change the IDL authority.

new_authority: Pubkey

New authority of the IDL account.

print_only: bool

When used, the content of the instruction will only be printed in base64 form and not executed. Useful for multisig execution when the local wallet keypair is not available.

priority_fee: Option<u64>

EraseAuthority

Command to remove the ability to modify the IDL account. This should likely be used in conjection with eliminating an “upgrade authority” on the program.

Fields

program_id: Pubkey

priority_fee: Option<u64>

Authority

Outputs the authority for the IDL account.

Fields

program_id: Pubkey

The program to view.

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 address from a cluster. The address can be a program, IDL account, or IDL buffer.

Fields

address: Pubkey

out: Option<String>

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

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>

Address to use (defaults to metadata.address value)

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)

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