Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

token-cli: create transfer-fee-basis-points and transfer-fee-maximum-fee flags #7053

Merged
merged 5 commits into from
Aug 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 31 additions & 0 deletions token/cli/src/clap_app.rs
Original file line number Diff line number Diff line change
Expand Up @@ -763,11 +763,42 @@ pub fn app<'a, 'b>(
.value_names(&["FEE_IN_BASIS_POINTS", "MAXIMUM_FEE"])
.takes_value(true)
.number_of_values(2)
.hidden(true)
joncinque marked this conversation as resolved.
Show resolved Hide resolved
.conflicts_with("transfer_fee_basis_points")
.conflicts_with("transfer_fee_maximum_fee")
.help(
"Add a transfer fee to the mint. \
The mint authority can set the fee and withdraw collected fees.",
),
)
.arg(
Arg::with_name("transfer_fee_basis_points")
.long("transfer-fee-basis-points")
.value_names(&["FEE_IN_BASIS_POINTS"])
joncinque marked this conversation as resolved.
Show resolved Hide resolved
.takes_value(true)
joncinque marked this conversation as resolved.
Show resolved Hide resolved
.number_of_values(1)
.conflicts_with("transfer_fee")
.requires("transfer_fee_maximum_fee")
.validator(is_parsable::<u16>)
.help(
"Add transfer fee to the mint. \
The mint authority can set the fee.",
),
)
.arg(
Arg::with_name("transfer_fee_maximum_fee")
.long("transfer-fee-maximum-fee")
.value_names(&["MAXIMUM_FEE"])
joncinque marked this conversation as resolved.
Show resolved Hide resolved
.takes_value(true)
joncinque marked this conversation as resolved.
Show resolved Hide resolved
.number_of_values(1)
.conflicts_with("transfer_fee")
.requires("transfer_fee_basis_points")
.validator(is_amount)
.help(
"Add a UI amount maximum transfer fee to the mint. \
The mint authority can set and collect fees"
)
)
.arg(
Arg::with_name("enable_permanent_delegate")
.long("enable-permanent-delegate")
Expand Down
8 changes: 8 additions & 0 deletions token/cli/src/command.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3473,6 +3473,7 @@ pub async fn process_command<'a>(
let member_address = value_t!(arg_matches, "member_address", Pubkey).ok();

let transfer_fee = arg_matches.values_of("transfer_fee").map(|mut v| {
println_display(config,"transfer-fee has been deprecated and will be removed in a future release. Please specify --transfer-fee-basis-points and --transfer-fee-maximum-fee with a UI amount".to_string());
(
v.next()
.unwrap()
Expand All @@ -3485,6 +3486,13 @@ pub async fn process_command<'a>(
)
});

let tranfer_fee_basis_point = value_of::<u16>(arg_matches, "transfer_fee_basis_points");
let transfer_fee_maximum_fee = value_of::<f64>(arg_matches, "transfer_fee_maximum_fee")
.map(|v| spl_token::ui_amount_to_amount(v, decimals));
let transfer_fee = tranfer_fee_basis_point
.map(|v| (v, transfer_fee_maximum_fee.unwrap()))
.or(transfer_fee);

let (token_signer, token) =
get_signer(arg_matches, "token_keypair", &mut wallet_manager)
.unwrap_or_else(new_throwaway_signer);
Expand Down
49 changes: 49 additions & 0 deletions token/cli/tests/command.rs
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ async fn main() {
async_trial!(non_transferable, test_validator, payer),
async_trial!(default_account_state, test_validator, payer),
async_trial!(transfer_fee, test_validator, payer),
async_trial!(transfer_fee_basis_point, test_validator, payer),
async_trial!(confidential_transfer, test_validator, payer),
async_trial!(multisig_transfer, test_validator, payer),
async_trial!(offline_multisig_transfer_with_nonce, test_validator, payer),
Expand Down Expand Up @@ -2521,6 +2522,54 @@ async fn transfer_fee(test_validator: &TestValidator, payer: &Keypair) {
);
}

async fn transfer_fee_basis_point(test_validator: &TestValidator, payer: &Keypair) {
let config = test_config_with_default_signer(test_validator, payer, &spl_token_2022::id());

let transfer_fee_basis_points = 100;
let maximum_fee = 1.2;
let decimal = 9;

let token = Keypair::new();
let token_keypair_file = NamedTempFile::new().unwrap();
write_keypair_file(&token, &token_keypair_file).unwrap();
let token_pubkey = token.pubkey();
process_test_command(
&config,
payer,
&[
"spl-token",
CommandName::CreateToken.into(),
token_keypair_file.path().to_str().unwrap(),
"--transfer-fee-basis-points",
&transfer_fee_basis_points.to_string(),
"--transfer-fee-maximum-fee",
&maximum_fee.to_string(),
],
)
.await
.unwrap();

let account = config.rpc_client.get_account(&token_pubkey).await.unwrap();
let test_mint = StateWithExtensionsOwned::<Mint>::unpack(account.data).unwrap();
let extension = test_mint.get_extension::<TransferFeeConfig>().unwrap();
assert_eq!(
u16::from(extension.older_transfer_fee.transfer_fee_basis_points),
transfer_fee_basis_points
);
assert_eq!(
u64::from(extension.older_transfer_fee.maximum_fee),
(maximum_fee * i32::pow(10, decimal) as f64) as u64
);
assert_eq!(
u16::from(extension.newer_transfer_fee.transfer_fee_basis_points),
transfer_fee_basis_points
);
assert_eq!(
u64::from(extension.newer_transfer_fee.maximum_fee),
(maximum_fee * i32::pow(10, decimal) as f64) as u64
);
}

async fn confidential_transfer(test_validator: &TestValidator, payer: &Keypair) {
use spl_token_2022::solana_zk_token_sdk::encryption::elgamal::ElGamalKeypair;

Expand Down
Loading