vacuumlabs · jaskp · Dec 3, 2023 · Dec 12, 2023 · May 24, 2024
diff --git a/docs/packages/connect/methods/cardanoSignTransaction.md b/docs/packages/connect/methods/cardanoSignTransaction.md
@@ -36,6 +36,7 @@ const result = await TrezorConnect.cardanoSignTransaction(params);
 -   `derivationType` — _optional_ `CardanoDerivationType` enum. Determines used derivation type. Default is set to ICARUS_TREZOR=2.
 -   `includeNetworkId` — _optional_ `Boolean`. Determines whether `networkId` should be explicitly serialized into the transaction body. Default is `false`.
 -   `chunkify` — _optional_ `boolean` determines if recipient address will be displayed in chunks of 4 characters. Default is set to `false`
+-   `tagCborSets` - _optional_ `boolean` determines if CBOR arrays intended to be sets will be encoded with tag 258. Default is set to `false`
 
 ### CardanoTxSigningMode
 

diff --git a/packages/connect-explorer/src/pages/methods/cardano/cardanoSignTransaction.mdx b/packages/connect-explorer/src/pages/methods/cardano/cardanoSignTransaction.mdx
@@ -53,6 +53,8 @@ export const paramDescriptions = {
         'Determines whether `networkId` should be explicitly serialized into the transaction body. Default is `false`.',
     chunkify:
         'determines if recipient address will be displayed in chunks of 4 characters. Default is set to `false`',
+    tagCborSets:
+        'determines if CBOR arrays intended to be sets will be encoded with tag 258. Default is set to `false`',
 };
 
 ## Cardano: Sign transaction

diff --git a/packages/connect/e2e/__fixtures__/cardanoSignTransaction.ts b/packages/connect/e2e/__fixtures__/cardanoSignTransaction.ts
diff --git a/packages/connect/src/api/cardano/api/cardanoSignTransaction.ts b/packages/connect/src/api/cardano/api/cardanoSignTransaction.ts
@@ -38,7 +38,8 @@ import { tokenBundleToProto } from '../cardanoTokenBundle';
 import { AssertWeak, Type } from '@trezor/schema-utils';
 
 const CardanoSignTransactionFeatures = Object.freeze({
-    // Minimum firmware (2.6.0) currently supports all features
+    // FW <2.6.0 is not supported by Connect at all
+    Conway: ['0', '2.7.1'],
 });
 
 export type CardanoSignTransactionParams = {
@@ -64,6 +65,7 @@ export type CardanoSignTransactionParams = {
     additionalWitnessRequests: Path[];
     derivationType: PROTO.CardanoDerivationType;
     includeNetworkId?: boolean;
+    tagCborSets?: boolean;
     unsignedTx?: { body: string; hash: string };
     testnet?: boolean;
     chunkify?: boolean;
@@ -222,6 +224,7 @@ export default class CardanoSignTransaction extends AbstractMethod<
                     ? payload.derivationType
                     : PROTO.CardanoDerivationType.ICARUS_TREZOR,
             includeNetworkId: payload.includeNetworkId,
+            tagCborSets: payload.tagCborSets,
             unsignedTx: 'unsignedTx' in payload ? payload.unsignedTx : undefined,
             testnet: 'testnet' in payload ? payload.testnet : undefined,
             chunkify: typeof payload.chunkify === 'boolean' ? payload.chunkify : false,
@@ -246,7 +249,21 @@ export default class CardanoSignTransaction extends AbstractMethod<
     }
 
     _ensureFirmwareSupportsParams() {
-        // Currently, there are no additional features to check for
+        const { params } = this;
+
+        params.certificatesWithPoolOwnersAndRelays.forEach(({ certificate }) => {
+            if (
+                certificate.type === PROTO.CardanoCertificateType.STAKE_REGISTRATION_CONWAY ||
+                certificate.type === PROTO.CardanoCertificateType.STAKE_DEREGISTRATION_CONWAY ||
+                certificate.type === PROTO.CardanoCertificateType.VOTE_DELEGATION
+            ) {
+                this._ensureFeatureIsSupported('Conway');
+            }
+        });
+
+        if (params.tagCborSets) {
+            this._ensureFeatureIsSupported('Conway');
+        }
     }
 
     async _sign_tx(): Promise<CardanoSignedTxData> {
@@ -277,6 +294,7 @@ export default class CardanoSignTransaction extends AbstractMethod<
             derivation_type: this.params.derivationType,
             include_network_id: this.params.includeNetworkId,
             chunkify: this.params.chunkify,
+            tag_cbor_sets: this.params.tagCborSets,
         };
 
         // init

diff --git a/packages/connect/src/api/cardano/cardanoCertificate.ts b/packages/connect/src/api/cardano/cardanoCertificate.ts
@@ -7,6 +7,7 @@ import {
     CardanoPoolParameters,
     CardanoPoolOwner,
     CardanoPoolRelay,
+    CardanoDRep,
 } from '../../types/api/cardano';
 import { Assert } from '@trezor/schema-utils';
 
@@ -68,6 +69,21 @@ const validatePoolParameters = (poolParameters: CardanoPoolParameters) => {
     poolParameters.relays.forEach(validatePoolRelay);
 };
 
+const validateDRep = (dRep: CardanoDRep) => {
+    Assert(CardanoDRep, dRep);
+    if (dRep.type === PROTO.CardanoDRepType.KEY_HASH && !dRep.keyHash) {
+        throw ERRORS.TypedError(
+            'Method_InvalidParameter',
+            'keyHash must be supplied for KEY_HASH dRep type',
+        );
+    } else if (dRep.type === PROTO.CardanoDRepType.SCRIPT_HASH && !dRep.scriptHash) {
+        throw ERRORS.TypedError(
+            'Method_InvalidParameter',
+            'scriptHash must be supplied for SCRIPT_HASH dRep type',
+        );
+    }
+};
+
 export type CertificateWithPoolOwnersAndRelays = {
     certificate: PROTO.CardanoTxCertificate;
     poolOwners: PROTO.CardanoPoolOwner[];
@@ -118,6 +134,20 @@ const transformPoolParameters = (
     };
 };
 
+const transformDRep = (dRep: CardanoDRep | undefined): PROTO.CardanoDRep | undefined => {
+    if (!dRep) {
+        return undefined;
+    }
+
+    validateDRep(dRep);
+
+    return {
+        type: dRep.type,
+        key_hash: dRep.keyHash,
+        script_hash: dRep.scriptHash,
+    };
+};
+
 // transform incoming certificate object to protobuf messages format
 export const transformCertificate = (
     certificate: CardanoCertificate,
@@ -142,10 +172,33 @@ export const transformCertificate = (
         }
     }
 
+    if (
+        certificate.type === PROTO.CardanoCertificateType.STAKE_REGISTRATION_CONWAY ||
+        certificate.type === PROTO.CardanoCertificateType.STAKE_DEREGISTRATION_CONWAY
+    ) {
+        if (!certificate.deposit) {
+            throw ERRORS.TypedError(
+                'Method_InvalidParameter',
+                'deposit must be supplied for STAKE_REGISTRATION_CONWAY or STAKE_DEREGISTRATION_CONWAY',
+            );
+        }
+    }
+
+    if (certificate.type === PROTO.CardanoCertificateType.VOTE_DELEGATION) {
+        if (!certificate.dRep) {
+            throw ERRORS.TypedError(
+                'Method_InvalidParameter',
+                'dRep must be supplied for VOTE_DELEGATION',
+            );
+        }
+    }
+
     const { poolParameters, poolOwners, poolRelays } = transformPoolParameters(
         certificate.poolParameters,
     );
 
+    const dRep = transformDRep(certificate.dRep);
+
     return {
         certificate: {
             type: certificate.type,
@@ -154,6 +207,8 @@ export const transformCertificate = (
             key_hash: certificate.keyHash,
             pool: certificate.pool,
             pool_parameters: poolParameters,
+            deposit: certificate.deposit,
+            drep: dRep,
         },
         poolOwners,
         poolRelays,

diff --git a/packages/connect/src/api/cardano/cardanoUtils.ts b/packages/connect/src/api/cardano/cardanoUtils.ts
@@ -47,6 +47,7 @@ export const prepareCertificates = (certs: CardanoCertificate[]) => {
                 convertedCerts.push({
                     type: cert.type,
                 });
+                // TODO conway certificates not supported by coin-selection lib yet
                 break;
             // no default
         }

diff --git a/packages/connect/src/api/cardano/cardanoWitnesses.ts b/packages/connect/src/api/cardano/cardanoWitnesses.ts
@@ -29,7 +29,10 @@ export const gatherWitnessPaths = (
             if (
                 certificate.path &&
                 (certificate.type === PROTO.CardanoCertificateType.STAKE_DELEGATION ||
-                    certificate.type === PROTO.CardanoCertificateType.STAKE_DEREGISTRATION)
+                    certificate.type === PROTO.CardanoCertificateType.STAKE_DEREGISTRATION ||
+                    certificate.type === PROTO.CardanoCertificateType.STAKE_REGISTRATION_CONWAY ||
+                    certificate.type === PROTO.CardanoCertificateType.STAKE_DEREGISTRATION_CONWAY ||
+                    certificate.type === PROTO.CardanoCertificateType.VOTE_DELEGATION)
             ) {
                 _insert(certificate.path);
             }

diff --git a/packages/connect/src/types/api/__tests__/cardano.ts b/packages/connect/src/types/api/__tests__/cardano.ts
@@ -401,6 +401,7 @@ export const cardanoSignTransaction = async (api: TrezorConnect) => {
         networkId: 0,
         signingMode: CardanoTxSigningMode.ORDINARY_TRANSACTION,
         includeNetworkId: false,
+        tagCborSets: false,
     });
 
     if (sign.success) {

diff --git a/packages/connect/src/types/api/cardano/index.ts b/packages/connect/src/types/api/cardano/index.ts
@@ -165,6 +165,13 @@ export const CardanoPoolParameters = Type.Object({
     metadata: Type.Optional(CardanoPoolMetadata),
 });
 
+export type CardanoDRep = Static<typeof CardanoDRep>;
+export const CardanoDRep = Type.Object({
+    type: PROTO.EnumCardanoDRepType,
+    keyHash: Type.Optional(Type.String()),
+    scriptHash: Type.Optional(Type.String()),
+});
+
 export type CardanoCertificate = Static<typeof CardanoCertificate>;
 export const CardanoCertificate = Type.Object({
     type: PROTO.EnumCardanoCertificateType,
@@ -173,6 +180,8 @@ export const CardanoCertificate = Type.Object({
     poolParameters: Type.Optional(CardanoPoolParameters),
     scriptHash: Type.Optional(Type.String()),
     keyHash: Type.Optional(Type.String()),
+    deposit: Type.Optional(Type.String()),
+    dRep: Type.Optional(CardanoDRep),
 });
 
 export type CardanoWithdrawal = Static<typeof CardanoWithdrawal>;
@@ -253,6 +262,7 @@ export const CardanoSignTransaction = Type.Object({
     derivationType: Type.Optional(PROTO.EnumCardanoDerivationType),
     includeNetworkId: Type.Optional(Type.Boolean()),
     chunkify: Type.Optional(Type.Boolean()),
+    tagCborSets: Type.Optional(Type.Boolean()),
 });
 
 export type CardanoSignTransactionExtended = Static<typeof CardanoSignTransactionExtended>;

diff --git a/packages/protobuf/scripts/protobuf-patches/index.js b/packages/protobuf/scripts/protobuf-patches/index.js
@@ -129,6 +129,7 @@ const TYPE_PATCH = {
     'CardanoPoolParametersType.cost': UINT_TYPE,
     'CardanoPoolParametersType.margin_numerator': UINT_TYPE,
     'CardanoPoolParametersType.margin_denominator': UINT_TYPE,
+    'CardanoTxCertificate.deposit': UINT_TYPE,
     'CardanoSignTxInit.ttl': UINT_TYPE,
     'CardanoSignTxInit.validity_interval_start': UINT_TYPE,
     'CardanoSignTxInit.total_collateral': UINT_TYPE,

diff --git a/packages/protobuf/src/messages-schema.ts b/packages/protobuf/src/messages-schema.ts
@@ -1208,7 +1208,7 @@ export const CardanoTxCertificate = Type.Object(
         pool_parameters: Type.Optional(CardanoPoolParametersType),
         script_hash: Type.Optional(Type.String()),
         key_hash: Type.Optional(Type.String()),
-        deposit: Type.Optional(Type.Number()),
+        deposit: Type.Optional(Type.Uint()),
         drep: Type.Optional(CardanoDRep),
     },
     { $id: 'CardanoTxCertificate' },

diff --git a/packages/protobuf/src/messages.ts b/packages/protobuf/src/messages.ts
@@ -874,7 +874,7 @@ export type CardanoTxCertificate = {
     pool_parameters?: CardanoPoolParametersType;
     script_hash?: string;
     key_hash?: string;
-    deposit?: number;
+    deposit?: UintType;
     drep?: CardanoDRep;
 };