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.

Sign up for GitHub

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

Jump to bottom

Only burn one sat #4063

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Only burn one sat #4063

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
512cee4
Only burn one sat
onchainguy-btc Nov 10, 2024
6dff5b7
Fix build
onchainguy-btc Nov 10, 2024
c5407eb
Merge branch 'master' into burn-only-one-sat
onchainguy-btc Nov 13, 2024
80a0dc4
Merge branch 'master' into burn-only-one-sat
onchainguy-btc Nov 14, 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
25 changes: 2 additions & 23 deletions src/subcommand/wallet/burn.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,6 @@ pub struct Burn {
you understand the implications."
)]
no_limit: bool,
#[arg(
long,
help = "Target <AMOUNT> postage with sent inscriptions. [default: 10000 sat]",
value_name = "AMOUNT"
)]
postage: Option<Amount>,
inscription: InscriptionId,
}

Expand All @@ -47,22 +41,10 @@ impl Burn {

let metadata = WalletCommand::parse_metadata(self.cbor_metadata, self.json_metadata)?;

let Some(value) = inscription_info.value else {
let Some(_) = inscription_info.value else {
bail!("Cannot burn unbound inscription");
};

let value = Amount::from_sat(value);

ensure! {
value <= TARGET_POSTAGE,
"Cannot burn inscription contained in UTXO exceeding {TARGET_POSTAGE}",
}

ensure! {
self.postage.unwrap_or_default() <= TARGET_POSTAGE,
"Postage may not exceed {TARGET_POSTAGE}",
}

let mut builder = script::Builder::new().push_opcode(opcodes::all::OP_RETURN);

if let Some(metadata) = metadata {
Expand All @@ -88,7 +70,6 @@ impl Burn {
let unsigned_transaction = Self::create_unsigned_burn_transaction(
&wallet,
inscription_info.satpoint,
self.postage,
self.fee_rate,
script_pubkey,
)?;
Expand All @@ -107,7 +88,6 @@ impl Burn {
fn create_unsigned_burn_transaction(
wallet: &Wallet,
satpoint: SatPoint,
postage: Option<Amount>,
fee_rate: FeeRate,
script_pubkey: ScriptBuf,
) -> Result<Transaction> {
Expand All @@ -119,8 +99,7 @@ impl Burn {
);

let change = [wallet.get_change_address()?, wallet.get_change_address()?];

let postage = postage.map(Target::ExactPostage).unwrap_or(Target::Postage);
let postage = Target::ExactPostage(Amount::from_sat(1));

Ok(
TransactionBuilder::new(
Expand Down
72 changes: 40 additions & 32 deletions tests/wallet/burn.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ fn inscriptions_can_be_burned() {
<span title=burned>🔥</span>
</dd>
<dt>value</dt>
<dd>9922</dd>
<dd>1</dd>
.*
<dt>content length</dt>
<dd>3 bytes</dd>
Expand Down Expand Up @@ -116,7 +116,7 @@ fn runic_outputs_are_protected() {
}

#[test]
fn cannot_burn_inscriptions_on_large_utxos() {
fn burns_only_one_sat() {
let core = mockcore::spawn();

let ord = TestServer::spawn_with_server_args(&core, &[], &[]);
Expand All @@ -125,14 +125,46 @@ fn cannot_burn_inscriptions_on_large_utxos() {

core.mine_blocks(1);

let (inscription, _) = inscribe_with_postage(&core, &ord, Some(10_001));
assert_eq!(
CommandBuilder::new("wallet balance")
.core(&core)
.ord(&ord)
.run_and_deserialize_output::<Balance>(),
Balance {
cardinal: 50 * COIN_VALUE,
ordinal: 0,
runic: None,
runes: None,
total: 50 * COIN_VALUE,
}
);

// command mines 2 more blocks
let (inscription, _) = inscribe_with_postage(&core, &ord, Some(100_000));

CommandBuilder::new(format!("wallet burn --fee-rate 1 {inscription}",))
.core(&core)
.ord(&ord)
.expected_stderr("error: Cannot burn inscription contained in UTXO exceeding 0.00010000 BTC\n")
.expected_exit_code(1)
.run_and_extract_stdout();
.run_and_deserialize_output::<Send>();

core.mine_blocks(1);

// 4 block rewards - 1 burned sat
let expected_balance = 200 * COIN_VALUE - 1;

assert_eq!(
CommandBuilder::new("wallet balance")
.core(&core)
.ord(&ord)
.run_and_deserialize_output::<Balance>(),
Balance {
cardinal: expected_balance,
ordinal: 0,
runic: None,
runes: None,
total: expected_balance,
}
);
}

#[test]
Expand Down Expand Up @@ -191,30 +223,6 @@ fn cannot_burn_inscription_sharing_utxo_with_another_inscription() {
.run_and_extract_stdout();
}

#[test]
fn cannot_burn_with_excess_postage() {
let core = mockcore::spawn();

let ord = TestServer::spawn_with_server_args(&core, &[], &[]);

create_wallet(&core, &ord);

core.mine_blocks(1);

let (inscription, _) = inscribe(&core, &ord);

core.mine_blocks(1);

CommandBuilder::new(format!(
"wallet burn --fee-rate 1 {inscription} --postage 10001sat",
))
.core(&core)
.ord(&ord)
.expected_stderr("error: Postage may not exceed 0.00010000 BTC\n")
.expected_exit_code(1)
.run_and_extract_stdout();
}

#[test]
fn json_metadata_can_be_included_when_burning() {
let core = mockcore::spawn();
Expand Down Expand Up @@ -258,7 +266,7 @@ fn json_metadata_can_be_included_when_burning() {
fee: 138,
id: inscription,
output: Some(TxOut {
value: Amount::from_sat(9907),
value: Amount::from_sat(1),
script_pubkey,
}),
height: 3,
Expand Down Expand Up @@ -327,7 +335,7 @@ fn cbor_metadata_can_be_included_when_burning() {
fee: 138,
id: inscription,
output: Some(TxOut {
value: Amount::from_sat(9907),
value: Amount::from_sat(1),
script_pubkey,
}),
height: 3,
Expand Down
Loading