Enum anchor_cli::IdlCommand

pub enum IdlCommand {
    Init {
        program_id: Pubkey,
        filepath: String,
    },
    WriteBuffer {
        program_id: Pubkey,
        filepath: String,
    },
    SetBuffer {
        program_id: Pubkey,
        buffer: Pubkey,
    },
    Upgrade {
        program_id: Pubkey,
        filepath: String,
    },
    SetAuthority {
        address: Option<Pubkey>,
        program_id: Pubkey,
        new_authority: Pubkey,
    },
    EraseAuthority {
        program_id: Pubkey,
    },
    Authority {
        program_id: Pubkey,
    },
    Parse {
        file: String,
        out: Option<String>,
        out_ts: Option<String>,
        no_docs: bool,
    },
    Fetch {
        address: Pubkey,
        out: Option<String>,
    },
}

Variants

Init

Fields

program_id: Pubkey

filepath: String

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

WriteBuffer

Fields

program_id: Pubkey

filepath: String

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

SetBuffer

Fields

program_id: Pubkey

buffer: Pubkey

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

Sets a new IDL buffer for the program.

Upgrade

Fields

program_id: Pubkey

filepath: String

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

SetAuthority

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.

Sets a new authority on the IDL account.

EraseAuthority

Fields

program_id: Pubkey

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.

Authority

Fields

program_id: Pubkey

The program to view.

Outputs the authority for the IDL account.

Parse

Fields

file: String

Path to the program’s interface definition.

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

Parses an IDL from source.

Fetch

Fields

address: Pubkey

out: Option<String>

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

Fetches an IDL for the given address from a cluster. The address can be a program, IDL account, or IDL buffer.

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<RichFormatter>>

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

fn parse_from<I, T>(itr: I) -> Selfwhere
    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<RichFormatter>>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<RichFormatter>>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.

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

Append to Command so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand