Merge #105: Add add_data enables op_return for bdk-cli

86b5579 Add add_data enables op_return for bdk-cli (Pedro Felix)

Pull request description:

  <!-- You can erase any parts of this template not applicable to your Pull Request. -->

  ### Description
  This enables users to send an arbitrary string message through a txn-output. The maximum size of this string-literal can be length of 80-bytes.
  <!-- Describe the purpose of this PR, what's being adding and/or fixed -->

  ### Notes to the reviewers

  <!-- In this section you can include notes directed to the reviewers, like explaining why some parts
  of the PR were done in a specific way -->

  ### Checklists

  #### All Submissions:

  * [x] I've signed all my commits
  * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk-cli/blob/master/CONTRIBUTING.md)
  * [x] I ran `cargo fmt` and `cargo clippy` before committing

  #### New Features:

  * [x] I've added tests for the new feature
  * [x] I've added docs for the new feature
  * [x] I've updated `CHANGELOG.md`

  #### Bugfixes:

  * [ ] This pull request breaks the existing API
  * [ ] I've added tests to reproduce the issue which are now passing
  * [ ] I'm linking the issue being fixed by this PR

ACKs for top commit:
  notmandatory:
    ACK 86b5579
  rajarshimaitra:
    tACK 86b5579

Tree-SHA512: 53376da1489a7479f95971e7ec6ab6d011652552a865e9d76e9e055b16a1780e7b8ea4ff7e36845252fdf968b80875a81dce54b6f826ca0ddf8cd84b167278c4

src/commands.rs

@@ -396,6 +396,22 @@ pub enum OfflineWalletSubCommand {
  /// Selects which policy should be used to satisfy the internal descriptor.
  #[structopt(name = "INT_POLICY", long = "internal_policy")]
  internal_policy: Option<String>,
+ /// Optionally create an OP_RETURN output containing given String in utf8 encoding (max 80 bytes)
+ #[structopt(
+ name = "ADD_STRING",
+ long = "add_string",
+ short = "s",
+ conflicts_with = "ADD_DATA"
+ )]
+ add_string: Option<String>,
+ /// Optionally create an OP_RETURN output containing given base64 encoded String. (max 80 bytes)
+ #[structopt(
+ name = "ADD_DATA",
+ long = "add_data",
+ short = "o",
+ conflicts_with = "ADD_STRING"
+ )]
+ add_data: Option<String>, //base 64 econding
  },
  /// Bumps the fees of an RBF transaction.
  BumpFee {
@@ -945,7 +961,9 @@ mod test {
  "--change_descriptor", "wpkh(tpubDEnoLuPdBep9bzw5LoGYpsxUQYheRQ9gcgrJhJEcdKFB9cWQRyYmkCyRoTqeD4tJYiVVgt6A3rN6rWn9RYhR9sBsGxji29LYWHuKKbdb1ev/1/*)",
  "create_tx", "--to", "n2Z3YNXtceeJhFkTknVaNjT1mnCGWesykJ:123456","mjDZ34icH4V2k9GmC8niCrhzVuR3z8Mgkf:78910",
  "--utxos","87345e46bfd702d24d54890cc094d08a005f773b27c8f965dfe0eb1e23eef88e:1",
- "--utxos","87345e46bfd702d24d54890cc094d08a005f773b27c8f965dfe0eb1e23eef88e:2"];
+ "--utxos","87345e46bfd702d24d54890cc094d08a005f773b27c8f965dfe0eb1e23eef88e:2",
+ "--add_string","Hello BDK",
+ ];
 
  let cli_opts = CliOpts::from_iter(&cli_args);
 
@@ -1016,6 +1034,8 @@ mod test {
  fee_rate: None,
  external_policy: None,
  internal_policy: None,
+ add_data: None,
+ add_string: Some("Hello BDK".to_string()),
  }),
  },
  };

src/handlers.rs

@@ -122,6 +122,8 @@ where
  fee_rate,
  external_policy,
  internal_policy,
+ add_data,
+ add_string,
  } => {
  let mut tx_builder = wallet.build_tx();
 
@@ -151,6 +153,13 @@ where
  tx_builder.unspendable(unspendable);
  }
 
+ if let Some(base64_data) = add_data {
+ let op_return_data = base64::decode(&base64_data).unwrap();
+ tx_builder.add_data(op_return_data.as_slice());
+ } else if let Some(string_data) = add_string {
+ tx_builder.add_data(string_data.as_bytes());
+ }
+
  let policies = vec![
  external_policy.map(|p| (p, KeychainKind::External)),
  internal_policy.map(|p| (p, KeychainKind::Internal)),