Skip to content

feat(wasm-utxo): add PSBT key-value deletion methods #253

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

Merged
OttoAllmendinger merged 1 commit into from
Apr 17, 2026
Merged

feat(wasm-utxo): add PSBT key-value deletion methods #253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions packages/wasm-utxo/js/psbt.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,13 @@ export interface IPsbt extends ITransactionCommon<PsbtInputData, PsbtOutputData>
removeOutput(index: number): void;
setKV(key: PsbtKvKey, value: Uint8Array): void;
getKV(key: PsbtKvKey): Uint8Array | undefined;
deleteKV(key: PsbtKvKey): void;
setInputKV(index: number, key: PsbtKvKey, value: Uint8Array): void;
getInputKV(index: number, key: PsbtKvKey): Uint8Array | undefined;
deleteInputKV(index: number, key: PsbtKvKey): void;
setOutputKV(index: number, key: PsbtKvKey, value: Uint8Array): void;
getOutputKV(index: number, key: PsbtKvKey): Uint8Array | undefined;
deleteOutputKV(index: number, key: PsbtKvKey): void;
}

/** Extended PSBT with address resolution (no coin parameter needed) */
Expand Down
12 changes: 12 additions & 0 deletions packages/wasm-utxo/js/psbtBase.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,13 @@ interface WasmPsbtBase {
remove_output(index: number): void;
set_kv(key: unknown, value: Uint8Array): void;
get_kv(key: unknown): Uint8Array | null | undefined;
delete_kv(key: unknown): void;
set_input_kv(index: number, key: unknown, value: Uint8Array): void;
get_input_kv(index: number, key: unknown): Uint8Array | null | undefined;
delete_input_kv(index: number, key: unknown): void;
set_output_kv(index: number, key: unknown, value: Uint8Array): void;
get_output_kv(index: number, key: unknown): Uint8Array | null | undefined;
delete_output_kv(index: number, key: unknown): void;
}

export abstract class PsbtBase<W extends WasmPsbtBase> {
Expand Down Expand Up @@ -80,4 +83,13 @@ export abstract class PsbtBase<W extends WasmPsbtBase> {
getOutputKV(index: number, key: PsbtKvKey): Uint8Array | undefined {
return this._wasm.get_output_kv(index, key) ?? undefined;
}
deleteKV(key: PsbtKvKey): void {
this._wasm.delete_kv(key);
}
deleteInputKV(index: number, key: PsbtKvKey): void {
this._wasm.delete_input_kv(index, key);
}
deleteOutputKV(index: number, key: PsbtKvKey): void {
this._wasm.delete_output_kv(index, key);
}
}
60 changes: 60 additions & 0 deletions packages/wasm-utxo/src/psbt_ops.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,14 @@ pub trait PsbtAccess {
self.psbt().proprietary.get(key).cloned()
}

fn delete_global_unknown_kv(&mut self, key: raw::Key) {
self.psbt_mut().unknown.remove(&key);
}

fn delete_global_proprietary_kv(&mut self, key: raw::ProprietaryKey) {
self.psbt_mut().proprietary.remove(&key);
}

// -------------------------------------------------------------------------
// Per-input KV accessors
// -------------------------------------------------------------------------
Expand Down Expand Up @@ -112,6 +120,32 @@ pub trait PsbtAccess {
Ok(self.psbt().inputs[index].proprietary.get(key).cloned())
}

fn delete_input_unknown_kv(&mut self, index: usize, key: raw::Key) -> Result<(), String> {
let len = self.psbt().inputs.len();
if index >= len {
return Err(format!(
"input index {index} out of bounds (have {len} inputs)"
));
}
self.psbt_mut().inputs[index].unknown.remove(&key);
Ok(())
}

fn delete_input_proprietary_kv(
&mut self,
index: usize,
key: raw::ProprietaryKey,
) -> Result<(), String> {
let len = self.psbt().inputs.len();
if index >= len {
return Err(format!(
"input index {index} out of bounds (have {len} inputs)"
));
}
self.psbt_mut().inputs[index].proprietary.remove(&key);
Ok(())
}

// -------------------------------------------------------------------------
// Per-output KV accessors
// -------------------------------------------------------------------------
Expand Down Expand Up @@ -178,6 +212,32 @@ pub trait PsbtAccess {
Ok(self.psbt().outputs[index].proprietary.get(key).cloned())
}

fn delete_output_unknown_kv(&mut self, index: usize, key: raw::Key) -> Result<(), String> {
let len = self.psbt().outputs.len();
if index >= len {
return Err(format!(
"output index {index} out of bounds (have {len} outputs)"
));
}
self.psbt_mut().outputs[index].unknown.remove(&key);
Ok(())
}

fn delete_output_proprietary_kv(
&mut self,
index: usize,
key: raw::ProprietaryKey,
) -> Result<(), String> {
let len = self.psbt().outputs.len();
if index >= len {
return Err(format!(
"output index {index} out of bounds (have {len} outputs)"
));
}
self.psbt_mut().outputs[index].proprietary.remove(&key);
Ok(())
}

fn remove_input(&mut self, index: usize) -> Result<(), String> {
let psbt = self.psbt_mut();
if index >= psbt.inputs.len() {
Expand Down
40 changes: 40 additions & 0 deletions packages/wasm-utxo/src/wasm/psbt.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -833,6 +833,26 @@ macro_rules! impl_wasm_psbt_ops {
) -> Result<Option<Vec<u8>>, $crate::error::WasmUtxoError> {
self.wasm_get_output_kv(index, key)
}
pub fn delete_kv(
&mut self,
key: ::wasm_bindgen::JsValue,
) -> Result<(), $crate::error::WasmUtxoError> {
self.wasm_delete_kv(key)
}
pub fn delete_input_kv(
&mut self,
index: usize,
key: ::wasm_bindgen::JsValue,
) -> Result<(), $crate::error::WasmUtxoError> {
self.wasm_delete_input_kv(index, key)
}
pub fn delete_output_kv(
&mut self,
index: usize,
key: ::wasm_bindgen::JsValue,
) -> Result<(), $crate::error::WasmUtxoError> {
self.wasm_delete_output_kv(index, key)
}
}
};
($type:ty, $field:ident) => {
Expand Down Expand Up @@ -921,6 +941,26 @@ macro_rules! impl_wasm_psbt_ops {
) -> Result<Option<Vec<u8>>, $crate::error::WasmUtxoError> {
self.$field.wasm_get_output_kv(index, key)
}
pub fn delete_kv(
&mut self,
key: ::wasm_bindgen::JsValue,
) -> Result<(), $crate::error::WasmUtxoError> {
self.$field.wasm_delete_kv(key)
}
pub fn delete_input_kv(
&mut self,
index: usize,
key: ::wasm_bindgen::JsValue,
) -> Result<(), $crate::error::WasmUtxoError> {
self.$field.wasm_delete_input_kv(index, key)
}
pub fn delete_output_kv(
&mut self,
index: usize,
key: ::wasm_bindgen::JsValue,
) -> Result<(), $crate::error::WasmUtxoError> {
self.$field.wasm_delete_output_kv(index, key)
}
}
};
}
Expand Down
24 changes: 24 additions & 0 deletions packages/wasm-utxo/src/wasm/psbt_ops.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,30 @@ pub(crate) trait WasmPsbtOps: PsbtAccess {
}
.map_err(|e| WasmUtxoError::new(&e))
}

fn wasm_delete_kv(&mut self, key: JsValue) -> Result<(), WasmUtxoError> {
match PsbtKvKey::try_from_js_value(&key)? {
PsbtKvKey::Unknown(k) => PsbtAccess::delete_global_unknown_kv(self, k),
PsbtKvKey::Proprietary(k) => PsbtAccess::delete_global_proprietary_kv(self, k),
}
Ok(())
}

fn wasm_delete_input_kv(&mut self, index: usize, key: JsValue) -> Result<(), WasmUtxoError> {
match PsbtKvKey::try_from_js_value(&key)? {
PsbtKvKey::Unknown(k) => PsbtAccess::delete_input_unknown_kv(self, index, k),
PsbtKvKey::Proprietary(k) => PsbtAccess::delete_input_proprietary_kv(self, index, k),
}
.map_err(|e| WasmUtxoError::new(&e))
}

fn wasm_delete_output_kv(&mut self, index: usize, key: JsValue) -> Result<(), WasmUtxoError> {
match PsbtKvKey::try_from_js_value(&key)? {
PsbtKvKey::Unknown(k) => PsbtAccess::delete_output_unknown_kv(self, index, k),
PsbtKvKey::Proprietary(k) => PsbtAccess::delete_output_proprietary_kv(self, index, k),
}
.map_err(|e| WasmUtxoError::new(&e))
}
}

impl<T: PsbtAccess> WasmPsbtOps for T {}
Loading