minor fixes and improvements

vacuumlabs · Dec 21, 2023 · 43d7b5a · 43d7b5a
1 parent c5a932d
commit 43d7b5a
Show file tree

Hide file tree

Showing 9 changed files with 532 additions and 191 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -30,7 +30,6 @@
     "multiassets",
     "reserialized",
     "unfixable",
-    "UNREG",
     "vacuumlabs"
   ]
 }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cardano-hw-interop-lib",
-  "version": "2.0.2",
+  "version": "3.0.0",
   "files": [
     "dist"
   ],

diff --git a/src/errors/validationError.ts b/src/errors/validationError.ts
@@ -11,12 +11,21 @@ export enum ValidationErrorReason {
   INTEGER_NOT_INT64 = 'Hardware wallets support integers up to int64, integers from -2^63 to 2^63-1',
   UNSIGNED_INTEGER_NOT_UINT64 = 'Hardware wallets support unsigned integers up to uint64, unsigned integers from 0 to 2^64-1',
   NUMBER_OF_ELEMENTS_EXCEEDS_UINT16 = 'The number of transaction elements individually must not exceed UINT16_MAX, i.e. 65535',
-  CERTIFICATES_MUST_HAVE_THE_SAME_TYPE_OF_STAKE_CREDENTIAL = 'All certificates included in a transaction must have the same type of stake credential',
-  WITHDRAWALS_MUST_HAVE_THE_SAME_TYPE_OF_STAKE_CREDENTIAL = 'All withdrawals included in a transaction must have the same type of stake credential',
-  CERTIFICATES_AND_WITHDRAWALS_STAKE_CREDENTIAL_TYPES_MUST_BE_CONSISTENT = 'The stake credential type of certificates must be consistent with the type used for withdrawals',
   POOL_REGISTRATION_CERTIFICATE_WITH_OTHER_CERTIFICATES = 'If a transaction contains a pool registration certificate, then it must not contain any other certificate',
   POOL_REGISTRATION_CERTIFICATE_WITH_WITHDRAWALS = 'If a transaction contains a pool registration certificate, then it must not contain any withdrawal',
   POOL_REGISTRATION_CERTIFICATE_WITH_MINT_ENTRY = 'If a transaction contains a pool registration certificate, then it must not contain mint entry',
+  POOL_REGISTRATION_CERTIFICATE_WITH_PLUTUS_OUTPUTS = 'If a transaction contains a pool registration certificate, then it must not contain datums and reference scripts in outputs',
+  POOL_REGISTRATION_CERTIFICATE_WITH_SCRIPT_DATA_HASH = 'If a transaction contains a pool registration certificate, then it must not contain script data hash',
+  POOL_REGISTRATION_CERTIFICATE_WITH_COLLATERAL_INPUTS = 'If a transaction contains a pool registration certificate, then it must not contain collateral inputs',
+  POOL_REGISTRATION_CERTIFICATE_WITH_REQUIRED_SIGNERS = 'If a transaction contains a pool registration certificate, then it must not contain required signers',
+  POOL_REGISTRATION_CERTIFICATE_WITH_COLLATERAL_RETURN_OUTPUT = 'If a transaction contains a pool registration certificate, then it must not contain collateral return output',
+  POOL_REGISTRATION_CERTIFICATE_WITH_TOTAL_COLLATERAL = 'If a transaction contains a pool registration certificate, then it must not contain total collateral',
+  POOL_REGISTRATION_CERTIFICATE_WITH_REFERENCE_INPUTS = 'If a transaction contains a pool registration certificate, then it must not contain reference inputs',
+  POOL_REGISTRATION_CERTIFICATE_WITH_VOTING_PROCEDURES = 'If a transaction contains a pool registration certificate, then it must not contain voting procedures',
+  POOL_REGISTRATION_CERTIFICATE_WITH_TREASURY = 'If a transaction contains a pool registration certificate, then it must not contain treasury value entry',
+  POOL_REGISTRATION_CERTIFICATE_WITH_DONATION = 'If a transaction contains a pool registration certificate, then it must not contain treasury donation entry',
+  TOO_MANY_VOTERS_IN_VOTING_PROCEDURES = 'Only a single voter is allowed in voting procedures',
+  INVALID_NUMBER_OF_VOTING_PROCEDURES = 'There must be exactly one voting procedure per voter',
 
   // Fixable validation errors
   CBOR_IS_NOT_CANONICAL = 'CBOR is not canonical',
@@ -32,6 +41,7 @@ const FIXABLE = true
 const UNFIXABLE = false
 
 const validationErrorFixability: Record<ValidationErrorReason, boolean> = {
+  // unfixable
   [ValidationErrorReason.UNSUPPORTED_TX_UPDATE]: UNFIXABLE,
   [ValidationErrorReason.UNSUPPORTED_TX_PROPOSAL_PROCEDURES]: UNFIXABLE,
   [ValidationErrorReason.UNSUPPORTED_CERTIFICATE_GENESIS_KEY_DELEGATION]:
@@ -46,18 +56,36 @@ const validationErrorFixability: Record<ValidationErrorReason, boolean> = {
   [ValidationErrorReason.INTEGER_NOT_INT64]: UNFIXABLE,
   [ValidationErrorReason.UNSIGNED_INTEGER_NOT_UINT64]: UNFIXABLE,
   [ValidationErrorReason.NUMBER_OF_ELEMENTS_EXCEEDS_UINT16]: UNFIXABLE,
-  [ValidationErrorReason.CERTIFICATES_MUST_HAVE_THE_SAME_TYPE_OF_STAKE_CREDENTIAL]:
-    UNFIXABLE,
-  [ValidationErrorReason.WITHDRAWALS_MUST_HAVE_THE_SAME_TYPE_OF_STAKE_CREDENTIAL]:
-    UNFIXABLE,
-  [ValidationErrorReason.CERTIFICATES_AND_WITHDRAWALS_STAKE_CREDENTIAL_TYPES_MUST_BE_CONSISTENT]:
-    UNFIXABLE,
   [ValidationErrorReason.POOL_REGISTRATION_CERTIFICATE_WITH_OTHER_CERTIFICATES]:
     UNFIXABLE,
   [ValidationErrorReason.POOL_REGISTRATION_CERTIFICATE_WITH_WITHDRAWALS]:
     UNFIXABLE,
   [ValidationErrorReason.POOL_REGISTRATION_CERTIFICATE_WITH_MINT_ENTRY]:
     UNFIXABLE,
+  [ValidationErrorReason.POOL_REGISTRATION_CERTIFICATE_WITH_PLUTUS_OUTPUTS]:
+    UNFIXABLE,
+  [ValidationErrorReason.POOL_REGISTRATION_CERTIFICATE_WITH_SCRIPT_DATA_HASH]:
+    UNFIXABLE,
+  [ValidationErrorReason.POOL_REGISTRATION_CERTIFICATE_WITH_COLLATERAL_INPUTS]:
+    UNFIXABLE,
+  [ValidationErrorReason.POOL_REGISTRATION_CERTIFICATE_WITH_REQUIRED_SIGNERS]:
+    UNFIXABLE,
+  [ValidationErrorReason.POOL_REGISTRATION_CERTIFICATE_WITH_COLLATERAL_RETURN_OUTPUT]:
+    UNFIXABLE,
+  [ValidationErrorReason.POOL_REGISTRATION_CERTIFICATE_WITH_TOTAL_COLLATERAL]:
+    UNFIXABLE,
+  [ValidationErrorReason.POOL_REGISTRATION_CERTIFICATE_WITH_REFERENCE_INPUTS]:
+    UNFIXABLE,
+  [ValidationErrorReason.POOL_REGISTRATION_CERTIFICATE_WITH_VOTING_PROCEDURES]:
+    UNFIXABLE,
+  [ValidationErrorReason.POOL_REGISTRATION_CERTIFICATE_WITH_TREASURY]:
+    UNFIXABLE,
+  [ValidationErrorReason.POOL_REGISTRATION_CERTIFICATE_WITH_DONATION]:
+    UNFIXABLE,
+  [ValidationErrorReason.TOO_MANY_VOTERS_IN_VOTING_PROCEDURES]: UNFIXABLE,
+  [ValidationErrorReason.INVALID_NUMBER_OF_VOTING_PROCEDURES]: UNFIXABLE,
+
+  // fixable
   [ValidationErrorReason.CBOR_IS_NOT_CANONICAL]: FIXABLE,
   [ValidationErrorReason.OPTIONAL_EMPTY_LISTS_AND_MAPS_MUST_NOT_BE_INCLUDED]:
     FIXABLE,

diff --git a/src/txParsers.ts b/src/txParsers.ts
@@ -68,8 +68,8 @@ import {
   DRepType,
   KeyHashDRep,
   ScriptHashDRep,
-  AlwaysAbstainDRep,
-  AlwaysNoConfidenceDRep,
+  AbstainDRep,
+  NoConfidenceDRep,
   StakeAndVoteDelegationCertificate,
   StakeRegistrationAndDelegationCertificate,
   StakeRegistrationWithVoteDelegationCertificate,
@@ -129,6 +129,8 @@ import {Tagged} from 'cbor'
 
 // ======================== universal parsers / parsers for CDDL data types
 
+// parsers for tx body elements and certain CDDL "datatypes" are exported
+
 const doNotParse: Parser<Unparsed> = (data: unknown) => data
 
 export const parseCoin = createParser(parseUint, ParseErrorReason.INVALID_COIN)
@@ -150,7 +152,7 @@ const parseCredentialType = (
 const parseKeyCredential = (data: unknown[]): WithoutType<KeyCredential> => {
   validate(data.length === 1, ParseErrorReason.INVALID_CREDENTIAL)
   return {
-    hash: parseBufferOfLength(
+    keyHash: parseBufferOfLength(
       data[0],
       KEY_HASH_LENGTH,
       ParseErrorReason.INVALID_CREDENTIAL_KEY_HASH,
@@ -163,7 +165,7 @@ const parseScriptCredential = (
 ): WithoutType<ScriptCredential> => {
   validate(data.length === 1, ParseErrorReason.INVALID_CREDENTIAL)
   return {
-    hash: parseBufferOfLength(
+    scriptHash: parseBufferOfLength(
       data[0],
       SCRIPT_HASH_LENGTH,
       ParseErrorReason.INVALID_CREDENTIAL_SCRIPT_HASH,
@@ -203,7 +205,7 @@ export const parseInputs = createParser(
   ParseErrorReason.INVALID_TX_INPUTS,
 )
 
-export const parseRewardAccount = createParser(
+const parseRewardAccount = createParser(
   parseBufferOfLength,
   REWARD_ACCOUNT_LENGTH,
   ParseErrorReason.INVALID_REWARD_ACCOUNT,
@@ -500,7 +502,7 @@ const parsePoolMetadata = (unparsedPoolMetadata: unknown): PoolMetadata => {
   return {url, metadataHash}
 }
 
-export const parsePoolParams = (unparsedPoolParams: unknown): PoolParams => {
+const parsePoolParams = (unparsedPoolParams: unknown): PoolParams => {
   const [
     operator,
     vrfKeyHash,
@@ -579,17 +581,15 @@ const parseScriptHashDRep = (data: unknown[]): WithoutType<ScriptHashDRep> => {
   }
 }
 
-const parseAlwaysAbstainDRep = (
-  data: unknown[],
-): WithoutType<AlwaysAbstainDRep> => {
+const parseAbstainDRep = (data: unknown[]): WithoutType<AbstainDRep> => {
   // nothing to parse
   validate(data.length === 0, ParseErrorReason.INVALID_DREP)
   return {}
 }
 
-const parseAlwaysNoConfidenceDRep = (
+const parseNoConfidenceDRep = (
   data: unknown[],
-): WithoutType<AlwaysNoConfidenceDRep> => {
+): WithoutType<NoConfidenceDRep> => {
   // nothing to parse
   validate(data.length === 0, ParseErrorReason.INVALID_DREP)
   return {}
@@ -619,8 +619,8 @@ export const parseDRep = createParser(
   parseDRepType,
   parseKeyHashDRep,
   parseScriptHashDRep,
-  parseAlwaysAbstainDRep,
-  parseAlwaysNoConfidenceDRep,
+  parseAbstainDRep,
+  parseNoConfidenceDRep,
 )
 
 const parseCertificateType = (
@@ -683,20 +683,23 @@ const parsePoolRetirementCertificate = (
   }
 }
 
+// removed in Conway, but we keep it here because it might appear
+// in erroneous / previously-built transactions
 const parseGenesisKeyDelegation = (
   data: unknown[],
 ): WithoutType<GenesisKeyDelegation> => ({
   restOfData: data,
 })
 
-// TODO these are removed in Conway
+// removed in Conway, but we keep it here because it might appear
+// in erroneous / previously-built transactions
 const parseMoveInstantaneousRewardsCertificate = (
   data: unknown[],
 ): WithoutType<MoveInstantaneousRewardsCertificate> => ({
   restOfData: data,
 })
 
-const parseStakeRegCertificate = (
+const parseStakeRegistrationConwayCertificate = (
   data: unknown[],
 ): WithoutType<StakeRegistrationConwayCertificate> => {
   validate(data.length === 2, ParseErrorReason.INVALID_CERTIFICATE)
@@ -706,7 +709,7 @@ const parseStakeRegCertificate = (
   }
 }
 
-const parseStakeUnregCertificate = (
+const parseStakeDeregistrationConwayCertificate = (
   data: unknown[],
 ): WithoutType<StakeDeregistrationConwayCertificate> => {
   validate(data.length === 2, ParseErrorReason.INVALID_CERTIFICATE)
@@ -716,7 +719,7 @@ const parseStakeUnregCertificate = (
   }
 }
 
-const parseVoteDelegCertificate = (
+const parseVoteDelegationCertificate = (
   data: unknown[],
 ): WithoutType<VoteDelegationCertificate> => {
   validate(data.length === 2, ParseErrorReason.INVALID_CERTIFICATE)
@@ -726,7 +729,7 @@ const parseVoteDelegCertificate = (
   }
 }
 
-const parseStakeVoteDelegCertificate = (
+const parseStakeAndVoteDelegationCertificate = (
   data: unknown[],
 ): WithoutType<StakeAndVoteDelegationCertificate> => {
   validate(data.length === 3, ParseErrorReason.INVALID_CERTIFICATE)
@@ -737,7 +740,7 @@ const parseStakeVoteDelegCertificate = (
   }
 }
 
-const parseStakeRegDelegCertificate = (
+const parseStakeRegistrationAndDelegationCertificate = (
   data: unknown[],
 ): WithoutType<StakeRegistrationAndDelegationCertificate> => {
   validate(data.length === 3, ParseErrorReason.INVALID_CERTIFICATE)
@@ -748,7 +751,7 @@ const parseStakeRegDelegCertificate = (
   }
 }
 
-const parseVoteRegDelegCertificate = (
+const parseStakeRegistrationWithVoteDelegationCertificate = (
   data: unknown[],
 ): WithoutType<StakeRegistrationWithVoteDelegationCertificate> => {
   validate(data.length === 3, ParseErrorReason.INVALID_CERTIFICATE)
@@ -759,7 +762,7 @@ const parseVoteRegDelegCertificate = (
   }
 }
 
-const parseStakeVoteRegDelegCertificate = (
+const parseStakeRegistrationWithStakeAndVoteDelegationCertificate = (
   data: unknown[],
 ): WithoutType<StakeRegistrationWithStakeAndVoteDelegationCertificate> => {
   validate(data.length === 4, ParseErrorReason.INVALID_CERTIFICATE)
@@ -771,7 +774,7 @@ const parseStakeVoteRegDelegCertificate = (
   }
 }
 
-const parseAuthCommitteeHotCertificate = (
+const parseAuthorizeCommitteeHotCertificate = (
   data: unknown[],
 ): WithoutType<AuthorizeCommitteeHotCertificate> => {
   validate(data.length === 2, ParseErrorReason.INVALID_CERTIFICATE)
@@ -791,7 +794,7 @@ const parseResignCommitteeColdCertificate = (
   }
 }
 
-const parseDRepRegCertificate = (
+const parseDRepRegistrationCertificate = (
   data: unknown[],
 ): WithoutType<DRepRegistrationCertificate> => {
   validate(data.length === 3, ParseErrorReason.INVALID_CERTIFICATE)
@@ -802,7 +805,7 @@ const parseDRepRegCertificate = (
   }
 }
 
-const parseDRepUnregCertificate = (
+const parseDRepDeregistrationCertificate = (
   data: unknown[],
 ): WithoutType<DRepDeregistrationCertificate> => {
   validate(data.length === 2, ParseErrorReason.INVALID_CERTIFICATE)
@@ -833,17 +836,17 @@ export const parseCertificate = createParser(
   parsePoolRetirementCertificate,
   parseGenesisKeyDelegation,
   parseMoveInstantaneousRewardsCertificate,
-  parseStakeRegCertificate,
-  parseStakeUnregCertificate,
-  parseVoteDelegCertificate,
-  parseStakeVoteDelegCertificate,
-  parseStakeRegDelegCertificate,
-  parseVoteRegDelegCertificate,
-  parseStakeVoteRegDelegCertificate,
-  parseAuthCommitteeHotCertificate,
+  parseStakeRegistrationConwayCertificate,
+  parseStakeDeregistrationConwayCertificate,
+  parseVoteDelegationCertificate,
+  parseStakeAndVoteDelegationCertificate,
+  parseStakeRegistrationAndDelegationCertificate,
+  parseStakeRegistrationWithVoteDelegationCertificate,
+  parseStakeRegistrationWithStakeAndVoteDelegationCertificate,
+  parseAuthorizeCommitteeHotCertificate,
   parseResignCommitteeColdCertificate,
-  parseDRepRegCertificate,
-  parseDRepUnregCertificate,
+  parseDRepRegistrationCertificate,
+  parseDRepDeregistrationCertificate,
   parseDRepUpdateCertificate,
 )
 
@@ -1050,7 +1053,7 @@ const parseVoteOption = (unparsed: unknown): VoteOption => {
   return unparsed
 }
 
-const parseVotingProcedure = (unparsed: unknown): VotingProcedure => {
+export const parseVotingProcedure = (unparsed: unknown): VotingProcedure => {
   const [voteOption, anchor] = parseTuple(
     unparsed,
     ParseErrorReason.INVALID_VOTING_PROCEDURE,
@@ -1118,6 +1121,7 @@ export const parseProposalProcedure = (
     anchor,
   }
 }
+
 export const parseProposalProcedures = createParser(
   parseCddlNonEmptyOrderedSet,
   parseProposalProcedure,