cardano: add support for 258-tagged sets

The btc.rs changes are due to the Bitoin related btc.proto changes
that are pulled in as well.

Author: benma

CHANGELOG-npm.md

@@ -1,6 +1,7 @@
 # Changelog
 
-## Unreleased
+## 0.9.0
+- cardano: add support for 258-tagged sets
 
 ## 0.8.0
 - cardano: allow vote delegation

CHANGELOG-rust.md

@@ -1,6 +1,7 @@
 # Changelog
 
-## Unreleased
+## 0.7.0
+- cardano: add support for 258-tagged sets
 
 ## 0.6.0
 - btc: handle error when an input's previous transaction is required but missing

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "bitbox-api"
 authors = ["Marko Bencun <[email protected]>"]
-version = "0.6.0"
+version = "0.7.0"
 homepage = "https://bitbox.swiss/"
 repository = "https://github.com/BitBoxSwiss/bitbox-api-rs/"
 readme = "README-rust.md"

Cargo.toml

@@ -1 +1 @@
-0.8.0
+0.9.0

NPM_VERSION

@@ -94,6 +94,7 @@ async fn demo<R: bitbox_api::runtime::Runtime>() {
         withdrawals: vec![],
         validity_interval_start: 41110811,
         allow_zero_ttl: false,
+        tag_cbor_sets: false,
     };
 
     let witness = paired_bitbox
@@ -148,6 +149,7 @@ async fn demo<R: bitbox_api::runtime::Runtime>() {
         withdrawals: vec![],
         validity_interval_start: 41110811,
         allow_zero_ttl: false,
+        tag_cbor_sets: false,
     };
 
     let witness = paired_bitbox
@@ -185,6 +187,7 @@ async fn demo<R: bitbox_api::runtime::Runtime>() {
         }],
         validity_interval_start: 0,
         allow_zero_ttl: false,
+        tag_cbor_sets: false,
     };
 
     let witness = paired_bitbox

examples/cardano.rs

@@ -115,6 +115,9 @@ message BTCSignInitRequest {
   }
   FormatUnit format_unit = 8;
   bool contains_silent_payment_outputs = 9;
+  // used script configs for outputs that send to an address of the same keystore, but not
+  // necessarily the same account (as defined by `script_configs` above).
+  repeated BTCScriptConfigWithKeypath output_script_configs = 10;
 }
 
 message BTCSignNextResponse {
@@ -174,12 +177,19 @@ message BTCSignOutputRequest {
   uint64 value = 3;
   bytes payload = 4; // if ours is false. Renamed from `hash`.
   repeated uint32 keypath = 5; // if ours is true
-  // If ours is true. References a script config from BTCSignInitRequest
+  // If ours is true and `output_script_config_index` is absent. References a script config from
+  // BTCSignInitRequest. This allows change output identification and allows us to identify
+  // non-change outputs to the same account, so we can display this info to the user.
   uint32 script_config_index = 6;
   optional uint32 payment_request_index = 7;
   // If provided, `type` and `payload` is ignored. The generated output pkScript is returned in
   // BTCSignNextResponse. `contains_silent_payment_outputs` in the init request must be true.
   SilentPayment silent_payment = 8;
+  // If ours is true. If set, `script_config_index` is ignored. References an output script config
+  // from BTCSignInitRequest. This enables verification that an output belongs to the same keystore,
+  // even if it is from a different account than we spend from, allowing us to display this info to
+  // the user.
+  optional uint32 output_script_config_index = 9;
 }
 
 message BTCScriptConfigRegistration {

messages/btc.proto

@@ -126,6 +126,9 @@ message CardanoSignTransactionRequest {
   repeated Withdrawal withdrawals = 7;
   uint64 validity_interval_start = 8;
   bool allow_zero_ttl = 9; // include ttl even if it is zero
+  // Tag arrays in the transaction serialization with the 258 tag.
+  // See https://github.com/IntersectMBO/cardano-ledger/blob/6e2d37cc0f47bd02e89b4ce9f78b59c35c958e96/eras/conway/impl/cddl-files/extra.cddl#L5
+  bool tag_cbor_sets = 10;
 }
 
 message CardanoSignTransactionResponse {

messages/cardano.proto

@@ -202,6 +202,7 @@ function CardanoSignTransaction({ bb02 }: Props) {
               withdrawals: [],
               validityIntervalStart: BigInt(41110811),
               allowZeroTTL: false,
+              tagCborSets: false,
             };
           case 'zero-ttl':
             return {
@@ -224,6 +225,7 @@ function CardanoSignTransaction({ bb02 }: Props) {
               withdrawals: [],
               validityIntervalStart: BigInt(41110811),
               allowZeroTTL: true,
+              tagCborSets: false,
             };
           case 'tokens':
             return {
@@ -262,6 +264,7 @@ function CardanoSignTransaction({ bb02 }: Props) {
               withdrawals: [],
               validityIntervalStart: BigInt(41110811),
               allowZeroTTL: false,
+              tagCborSets: false,
             };
           case 'delegate':
             return {
@@ -292,6 +295,7 @@ function CardanoSignTransaction({ bb02 }: Props) {
               withdrawals: [],
               validityIntervalStart: BigInt(41110811),
               allowZeroTTL: false,
+              tagCborSets: false,
             };
           case 'vote-delegation':
             return {
@@ -317,6 +321,7 @@ function CardanoSignTransaction({ bb02 }: Props) {
               withdrawals: [],
               validityIntervalStart: BigInt(41110811),
               allowZeroTTL: false,
+              tagCborSets: false,
             };
             case 'vote-delegation-keyhash':
               return {
@@ -343,6 +348,7 @@ function CardanoSignTransaction({ bb02 }: Props) {
                 withdrawals: [],
                 validityIntervalStart: BigInt(41110811),
                 allowZeroTTL: false,
+                tagCborSets: false,
               };
           case 'withdraw-staking-rewards':
             return {
@@ -366,6 +372,7 @@ function CardanoSignTransaction({ bb02 }: Props) {
               ],
               validityIntervalStart: BigInt(0),
               allowZeroTTL: false,
+              tagCborSets: false,
             };
         }
       };

sandbox/package-lock.json

@@ -723,6 +723,7 @@ impl<R: Runtime> PairedBitBox<R> {
             .get_next_response(Request::BtcSignInit(pb::BtcSignInitRequest {
                 coin: coin as _,
                 script_configs: transaction.script_configs.clone(),
+                output_script_configs: vec![],
                 version: transaction.version,
                 num_inputs: transaction.inputs.len() as _,
                 num_outputs: transaction.outputs.len() as _,

sandbox/src/Cardano.tsx

@@ -135,6 +135,9 @@ impl<R: Runtime> PairedBitBox<R> {
         &self,
         transaction: pb::CardanoSignTransactionRequest,
     ) -> Result<pb::CardanoSignTransactionResponse, Error> {
+        if transaction.tag_cbor_sets {
+            self.validate_version(">=9.22.0")?;
+        }
         match self
             .query_proto_cardano(pb::cardano_request::Request::SignTransaction(transaction))
             .await?