feat: Allow using custom change address in sendvtt

Co-authored-by: Luis Rubio <l.rubiorod@gmail.com>

Author: tmpolaczyk

data_structures/src/transaction_factory.rs

@@ -347,6 +347,7 @@ pub fn build_vtt(
     utxo_strategy: &UtxoSelectionStrategy,
     max_weight: u32,
     additional_inputs: Vec<Input>,
+    change_address: Option<PublicKeyHash>,
 ) -> Result<VTTransactionBody, TransactionError> {
     let mut utxos = NodeUtxos {
         all_utxos,
@@ -377,7 +378,7 @@ pub fn build_vtt(
     let mut outputs = tx_info.outputs;
     insert_change_output(
         &mut outputs,
-        own_pkh,
+        change_address.unwrap_or(own_pkh),
         tx_info.input_value - tx_info.output_value - tx_info.fee,
     );
 

node/src/actors/chain_manager/handlers.rs

@@ -1237,6 +1237,7 @@ impl Handler<BuildVtt> for ChainManager {
             &msg.utxo_strategy,
             max_vt_weight,
             vec![],
+            msg.change_address,
         ) {
             Err(e) => {
                 log::error!("Error when building value transfer transaction: {}", e);
@@ -1298,6 +1299,7 @@ impl Handler<BuildScriptTransaction> for ChainManager {
             &msg.utxo_strategy,
             max_vt_weight,
             msg.script_inputs,
+            msg.change_address,
         ) {
             Err(e) => {
                 log::error!("Error when building value transfer transaction: {}", e);

node/src/actors/messages.rs

@@ -203,6 +203,8 @@ pub struct BuildVtt {
     /// Strategy to sort the unspent outputs pool
     #[serde(default)]
     pub utxo_strategy: UtxoSelectionStrategy,
+    /// Change address
+    pub change_address: Option<PublicKeyHash>,
 }
 
 impl Message for BuildVtt {
@@ -221,6 +223,8 @@ pub struct BuildScriptTransaction {
     pub utxo_strategy: UtxoSelectionStrategy,
     /// Extra script inputs
     pub script_inputs: Vec<Input>,
+    /// Change address
+    pub change_address: Option<PublicKeyHash>,
 }
 
 impl Message for BuildScriptTransaction {

src/cli/node/json_rpc_client.rs

@@ -552,6 +552,7 @@ pub fn get_output(addr: SocketAddr, pointer: String) -> Result<(), failure::Erro
 pub fn send_vtt(
     addr: SocketAddr,
     pkh: Option<PublicKeyHash>,
+    change_address: Option<PublicKeyHash>,
     value: u64,
     size: Option<u64>,
     fee: u64,
@@ -606,6 +607,7 @@ pub fn send_vtt(
         vto: vt_outputs,
         fee,
         utxo_strategy,
+        change_address,
     };
 
     let request = format!(
@@ -756,6 +758,7 @@ pub fn create_opened_multisig(
     n: u8,
     m: u8,
     pkhs: Vec<PublicKeyHash>,
+    change_address: Option<PublicKeyHash>,
     address: PublicKeyHash,
     dry_run: bool,
 ) -> Result<(), failure::Error> {
@@ -793,6 +796,7 @@ pub fn create_opened_multisig(
         fee,
         utxo_strategy,
         script_inputs,
+        change_address,
     };
     let request = format!(
         r#"{{"jsonrpc": "2.0","method": "sendScript", "params": {}, "id": "1"}}"#,

src/cli/node/with_node.rs

@@ -93,13 +93,15 @@ pub fn exec_cmd(
         Command::Send {
             node,
             address,
+            change_address,
             value,
             fee,
             time_lock,
             dry_run,
         } => rpc::send_vtt(
             node.unwrap_or(config.jsonrpc.server_address),
             Some(address.parse()?),
+            change_address.map(|address| address.parse()).transpose()?,
             value,
             None,
             fee,
@@ -110,6 +112,7 @@ pub fn exec_cmd(
         Command::Split {
             node,
             address,
+            change_address,
             value,
             size,
             fee,
@@ -121,6 +124,7 @@ pub fn exec_cmd(
             rpc::send_vtt(
                 node.unwrap_or(config.jsonrpc.server_address),
                 address,
+                change_address.map(|address| address.parse()).transpose()?,
                 value,
                 size,
                 fee,
@@ -132,6 +136,7 @@ pub fn exec_cmd(
         Command::Join {
             node,
             address,
+            change_address,
             value,
             size,
             fee,
@@ -143,6 +148,7 @@ pub fn exec_cmd(
             rpc::send_vtt(
                 node.unwrap_or(config.jsonrpc.server_address),
                 address,
+                change_address.map(|address| address.parse()).transpose()?,
                 value,
                 size,
                 fee,
@@ -177,6 +183,7 @@ pub fn exec_cmd(
             n,
             m,
             pkhs,
+            change_address,
             address,
             dry_run,
         } => rpc::create_opened_multisig(
@@ -189,6 +196,7 @@ pub fn exec_cmd(
             pkhs.into_iter()
                 .map(|address| address.parse())
                 .collect::<Result<Vec<_>, _>>()?,
+            change_address.map(|address| address.parse()).transpose()?,
             address.parse()?,
             dry_run,
         ),
@@ -510,6 +518,9 @@ pub enum Command {
         /// Address of the destination
         #[structopt(long = "address", alias = "pkh")]
         address: String,
+        /// Change address
+        #[structopt(long = "change-address")]
+        change_address: Option<String>,
         /// Value
         #[structopt(long = "value")]
         value: u64,
@@ -534,6 +545,9 @@ pub enum Command {
         /// Public key hash of the destination. If omitted, defaults to the node pkh
         #[structopt(long = "address", alias = "pkh")]
         address: Option<String>,
+        /// Change address
+        #[structopt(long = "change-address")]
+        change_address: Option<String>,
         /// Value
         #[structopt(long = "value")]
         value: u64,
@@ -561,6 +575,9 @@ pub enum Command {
         /// Public key hash of the destination. If omitted, defaults to the node pkh
         #[structopt(long = "address", alias = "pkh")]
         address: Option<String>,
+        /// Change address
+        #[structopt(long = "change-address")]
+        change_address: Option<String>,
         /// Value
         #[structopt(long = "value")]
         value: u64,
@@ -636,6 +653,9 @@ pub enum Command {
         /// List of pkhs
         #[structopt(long = "pkhs")]
         pkhs: Vec<String>,
+        /// Change address
+        #[structopt(long = "change-address")]
+        change_address: Option<String>,
         /// Address of the destination
         #[structopt(long = "address", alias = "pkh")]
         address: String,