Skip to content
This repository was archived by the owner on Mar 11, 2025. It is now read-only.

[token-upgrade] Remove clap deprecated functions #6951

Merged
merged 5 commits into from
Jul 16, 2024
Merged

[token-upgrade] Remove clap deprecated functions #6951

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2b8f40f
replace `multiple` with `ArgAction::Append`
samkim-crypto Jun 30, 2024
6a49303
replace `is_present` with `try_contains_id`
samkim-crypto Jun 30, 2024
7191893
replace `value_of` function
samkim-crypto Jun 30, 2024
d957c4d
remove `deprecated` feature
samkim-crypto Jun 30, 2024
0f1590e
replace `try_pubkey_of` with `SignerSource::try_get_pubkey`
samkim-crypto Jul 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 62 additions & 64 deletions token-upgrade/cli/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
use {
clap::{crate_description, crate_name, crate_version, Arg, Command},
clap::{crate_description, crate_name, crate_version, Arg, ArgAction, Command},
solana_clap_v3_utils::{
input_parsers::{
parse_url_or_moniker,
signer::{try_pubkey_of, SignerSourceParserBuilder},
signer::{SignerSource, SignerSourceParserBuilder},
},
input_validators::normalize_to_url_if_moniker,
keypair::{
signer_from_path, signer_from_path_with_config, DefaultSigner, SignerFromPathConfig,
},
keypair::{signer_from_path, signer_from_source, SignerFromPathConfig},
},
solana_client::nonblocking::rpc_client::RpcClient,
solana_remote_wallet::remote_wallet::RemoteWalletManager,
Expand Down Expand Up @@ -336,7 +334,7 @@ async fn main() -> Result<(), Box<dyn Error>> {
.value_parser(SignerSourceParserBuilder::default().allow_all().build())
.value_name("MULTISIG_SIGNER")
.takes_value(true)
.multiple(true)
.action(ArgAction::Append)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation seems to imply that we should use multiple_occurrences instead, ie:

Arg::multiple_occurrences in favor of Arg::multiple_values (positional), ArgAction::Append (flag with value), or ArgAction::Count (flag without value)

from clap-rs/clap#3797, and:

Replace Arg::multiple(bool) with Arg::multiple_values / Arg::multiple_occurrences

from https://github.com/clap-rs/clap/releases/tag/v3.0.0

Is there a reason to use your approach instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah multiple was deprecated in favor of multiple_occurrences in v3.0.0, but multiple_occurrences was deprecated in favor of ArgAction in v3.2.0 (https://github.com/clap-rs/clap/releases/tag/v3.2.0) 😅.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haha I had a feeling, thanks for the info!

.min_values(0)
.max_values(spl_token_2022::instruction::MAX_SIGNERS)
.help("Member signer of a multisig account")
Expand All @@ -348,19 +346,24 @@ async fn main() -> Result<(), Box<dyn Error>> {
let mut wallet_manager: Option<Rc<RemoteWalletManager>> = None;

let config = {
let cli_config = if let Some(config_file) = matches.value_of("config_file") {
let cli_config = if let Some(config_file) = matches.try_get_one::<String>("config_file")? {
solana_cli_config::Config::load(config_file).unwrap_or_default()
} else {
solana_cli_config::Config::default()
};

let payer = DefaultSigner::new(
"payer",
matches
.value_of("payer")
.map(|s| s.to_string())
.unwrap_or_else(|| cli_config.keypair_path.clone()),
);
let payer = if let Ok(Some((signer, _))) =
SignerSource::try_get_signer(matches, "payer", &mut wallet_manager)
{
Box::new(signer)
} else {
signer_from_path(
matches,
&cli_config.keypair_path,
"payer",
&mut wallet_manager,
)?
};

let json_rpc_url = normalize_to_url_if_moniker(
matches
Expand All @@ -370,16 +373,9 @@ async fn main() -> Result<(), Box<dyn Error>> {

Config {
commitment_config: CommitmentConfig::confirmed(),
payer: Arc::from(
payer
.signer_from_path(matches, &mut wallet_manager)
.unwrap_or_else(|err| {
eprintln!("error: {}", err);
exit(1);
}),
),
payer: Arc::from(payer),
json_rpc_url,
verbose: matches.is_present("verbose"),
verbose: matches.try_contains_id("verbose")?,
}
};
solana_logger::setup_with_default("solana=info");
Expand All @@ -394,17 +390,17 @@ async fn main() -> Result<(), Box<dyn Error>> {

match (command, matches) {
("create-escrow", arg_matches) => {
let original_mint = try_pubkey_of(arg_matches, "original_mint")
.unwrap()
.unwrap();
let new_mint = try_pubkey_of(arg_matches, "new_mint").unwrap().unwrap();
let account_keypair = matches.value_of("account_keypair").map(|path| {
signer_from_path(arg_matches, path, "account_keypair", &mut wallet_manager)
.unwrap_or_else(|err| {
eprintln!("error: account keypair: {}", err);
exit(1);
})
});
let original_mint =
SignerSource::try_get_pubkey(arg_matches, "original_mint", &mut wallet_manager)
.unwrap()
.unwrap();
let new_mint =
SignerSource::try_get_pubkey(arg_matches, "new_mint", &mut wallet_manager)
.unwrap()
.unwrap();
let account_keypair =
SignerSource::try_get_signer(matches, "account_keypair", &mut wallet_manager)?
.map(|(signer, _)| signer);
let response = process_create_escrow_account(
&rpc_client,
&config.payer,
Expand All @@ -422,14 +418,16 @@ async fn main() -> Result<(), Box<dyn Error>> {
("exchange", arg_matches) => {
let mut bulk_signers = vec![config.payer.clone()];
let mut multisig_pubkeys = vec![];
if let Some(values) = arg_matches.values_of("multisig_signer") {
for (i, value) in values.enumerate() {

if let Some(sources) = arg_matches.try_get_many::<SignerSource>("multisig_signer")? {
for (i, source) in sources.enumerate() {
let name = format!("{}-{}", "multisig_signer", i.saturating_add(1));
let signer = signer_from_path(arg_matches, value, &name, &mut wallet_manager)
.unwrap_or_else(|e| {
eprintln!("error parsing multisig signer: {}", e);
exit(1);
});
let signer =
signer_from_source(arg_matches, source, &name, &mut wallet_manager)
.unwrap_or_else(|e| {
eprint!("error parsing multisig signer: {}", e);
exit(1);
});
let signer_pubkey = signer.pubkey();
let signer = Arc::from(signer);
if !bulk_signers.contains(&signer) {
Expand All @@ -441,35 +439,35 @@ async fn main() -> Result<(), Box<dyn Error>> {
}
}

let original_mint = try_pubkey_of(arg_matches, "original_mint")
.unwrap()
.unwrap();
let new_mint = try_pubkey_of(arg_matches, "new_mint").unwrap().unwrap();
let original_mint =
SignerSource::try_get_pubkey(arg_matches, "original_mint", &mut wallet_manager)
.unwrap()
.unwrap();
let new_mint =
SignerSource::try_get_pubkey(arg_matches, "new_mint", &mut wallet_manager)
.unwrap()
.unwrap();
let signer_config = SignerFromPathConfig {
allow_null_signer: !multisig_pubkeys.is_empty(),
};
let owner = matches
.value_of("owner")
.map_or(Ok(config.payer.clone()), |path| {
signer_from_path_with_config(
arg_matches,
path,
"owner",
&mut wallet_manager,
&signer_config,
)
.map(Arc::from)
})
.unwrap_or_else(|err| {
eprintln!("error: owner signer: {}", err);
exit(1);
});
let owner = if let Ok(Some((signer, _))) =
SignerSource::try_get_signer(matches, "owner", &mut wallet_manager)
{
Arc::from(signer)
} else {
config.payer.clone()
};
if !signer_config.allow_null_signer && !bulk_signers.contains(&owner) {
bulk_signers.push(owner.clone());
}
let burn_from = try_pubkey_of(arg_matches, "burn_from").unwrap();
let escrow = try_pubkey_of(arg_matches, "escrow").unwrap();
let destination = try_pubkey_of(arg_matches, "destination").unwrap();
let burn_from =
SignerSource::try_get_pubkey(arg_matches, "burn_from", &mut wallet_manager)
.unwrap();
let escrow =
SignerSource::try_get_pubkey(arg_matches, "escrow", &mut wallet_manager).unwrap();
let destination =
SignerSource::try_get_pubkey(arg_matches, "destination", &mut wallet_manager)
.unwrap();

let signature = process_exchange(
&rpc_client,
Expand Down
Loading