@cardananium/cquisitor-lib 0.1.0-beta.53 → 0.1.0-beta.54

package/browser/cquisitor_lib.d.ts

@@ -320,6 +320,29 @@ export function map_cbor_to_cddl(
  * Sub-structures the schema doesn't cover fall back to a raw
  * representation (under `@extra` for maps / `@positional` for arrays),
  * so partial matches still yield useful output.
+ *
+ * **Map output shape**: by default we emit JSON objects (`{a: 1, b: 2}`)
+ * for the convenient case. We switch to a wire-order-preserving array
+ * form `{ "@entries": [{ key, value, match: { via, label } }, ...] }`
+ * when the JSON object form would lose information:
+ *
+ *  * any cbor key is a complex value (Array / Map / Tag / non-standard
+ *    Simple) — JSON objects can only have string keys.
+ *  * the cbor map has duplicate keys (RFC 8949 §5.6 — non-canonical
+ *    but legal). Collapsing into a value-array would drop the
+ *    interleaving order with surrounding entries.
+ *
+ * In `@entries` form, each pair carries a `match` field describing how
+ * the cbor key was matched against the schema:
+ *  * `match.via: "literal"` — bareword / literal value match;
+ *    `match.label` is the literal text.
+ *  * `match.via: "type"` — `<type1> => …` schema, the key conforms
+ *    to a type (e.g. `policy_id => …`); `match.label` is `null`.
+ *  * `match.via: "unmatched"` — no schema entry accepted this key,
+ *    `key` and `value` are raw decoded forms; `match.label` is `null`.
+ *
+ * Almost all Cardano maps (txbody, multiasset, witness_set) use object
+ * form; the `@entries` form only kicks in for the unusual cases above.
  * @param {string} cbor_hex
  * @param {string} cddl
  * @param {string} rule_name

package/browser/cquisitor_lib_bg.wasm.d.ts

@@ -4,10 +4,6 @@ export const memory: WebAssembly.Memory;
 export const decode_specific_type: (a: number, b: number, c: number, d: number, e: any) => [number, number, number];
 export const get_decodable_types: () => [number, number];
 export const get_possible_types_for_input: (a: number, b: number) => [number, number];
-export const check_block_or_tx_signatures: (a: number, b: number) => [number, number, number];
-export const get_necessary_data_list_js: (a: number, b: number, c: number, d: number) => [number, number, number, number];
-export const validate_transaction_js: (a: number, b: number, c: number, d: number) => [number, number, number, number];
-export const extract_hashes_from_transaction_js: (a: number, b: number) => [number, number, number, number];
 export const decode_plutus_program_pretty_uplc: (a: number, b: number) => [number, number, number, number];
 export const decode_plutus_program_uplc_json: (a: number, b: number) => [number, number, number];
 export const execute_tx_scripts: (a: number, b: number, c: any, d: any) => [number, number, number];
@@ -22,6 +18,10 @@ export const decode_cbor_against_cddl: (a: number, b: number, c: number, d: numb
 export const map_cbor_to_cddl: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
 export const validate_cbor_against_cddl: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
 export const validate_cddl: (a: number, b: number) => [number, number, number];
+export const extract_hashes_from_transaction_js: (a: number, b: number) => [number, number, number, number];
+export const check_block_or_tx_signatures: (a: number, b: number) => [number, number, number];
+export const get_necessary_data_list_js: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+export const validate_transaction_js: (a: number, b: number, c: number, d: number) => [number, number, number, number];
 export const validate_cbor_from_slice: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
 export const validate_json_from_str: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
 export const cddl_from_str: (a: number, b: number) => [number, number, number];

package/node/cquisitor_lib.d.ts

@@ -320,6 +320,29 @@ export function map_cbor_to_cddl(
  * Sub-structures the schema doesn't cover fall back to a raw
  * representation (under `@extra` for maps / `@positional` for arrays),
  * so partial matches still yield useful output.
+ *
+ * **Map output shape**: by default we emit JSON objects (`{a: 1, b: 2}`)
+ * for the convenient case. We switch to a wire-order-preserving array
+ * form `{ "@entries": [{ key, value, match: { via, label } }, ...] }`
+ * when the JSON object form would lose information:
+ *
+ *  * any cbor key is a complex value (Array / Map / Tag / non-standard
+ *    Simple) — JSON objects can only have string keys.
+ *  * the cbor map has duplicate keys (RFC 8949 §5.6 — non-canonical
+ *    but legal). Collapsing into a value-array would drop the
+ *    interleaving order with surrounding entries.
+ *
+ * In `@entries` form, each pair carries a `match` field describing how
+ * the cbor key was matched against the schema:
+ *  * `match.via: "literal"` — bareword / literal value match;
+ *    `match.label` is the literal text.
+ *  * `match.via: "type"` — `<type1> => …` schema, the key conforms
+ *    to a type (e.g. `policy_id => …`); `match.label` is `null`.
+ *  * `match.via: "unmatched"` — no schema entry accepted this key,
+ *    `key` and `value` are raw decoded forms; `match.label` is `null`.
+ *
+ * Almost all Cardano maps (txbody, multiasset, witness_set) use object
+ * form; the `@entries` form only kicks in for the unusual cases above.
  * @param {string} cbor_hex
  * @param {string} cddl
  * @param {string} rule_name

package/node/cquisitor_lib_bg.wasm.d.ts

@@ -4,10 +4,6 @@ export const memory: WebAssembly.Memory;
 export const decode_specific_type: (a: number, b: number, c: number, d: number, e: any) => [number, number, number];
 export const get_decodable_types: () => [number, number];
 export const get_possible_types_for_input: (a: number, b: number) => [number, number];
-export const check_block_or_tx_signatures: (a: number, b: number) => [number, number, number];
-export const get_necessary_data_list_js: (a: number, b: number, c: number, d: number) => [number, number, number, number];
-export const validate_transaction_js: (a: number, b: number, c: number, d: number) => [number, number, number, number];
-export const extract_hashes_from_transaction_js: (a: number, b: number) => [number, number, number, number];
 export const decode_plutus_program_pretty_uplc: (a: number, b: number) => [number, number, number, number];
 export const decode_plutus_program_uplc_json: (a: number, b: number) => [number, number, number];
 export const execute_tx_scripts: (a: number, b: number, c: any, d: any) => [number, number, number];
@@ -22,6 +18,10 @@ export const decode_cbor_against_cddl: (a: number, b: number, c: number, d: numb
 export const map_cbor_to_cddl: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
 export const validate_cbor_against_cddl: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
 export const validate_cddl: (a: number, b: number) => [number, number, number];
+export const extract_hashes_from_transaction_js: (a: number, b: number) => [number, number, number, number];
+export const check_block_or_tx_signatures: (a: number, b: number) => [number, number, number];
+export const get_necessary_data_list_js: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+export const validate_transaction_js: (a: number, b: number, c: number, d: number) => [number, number, number, number];
 export const validate_cbor_from_slice: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
 export const validate_json_from_str: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
 export const cddl_from_str: (a: number, b: number) => [number, number, number];

package/package.json

@@ -4,7 +4,7 @@
     "Evgenii Lisitskii <evgeniilisitskii@gmail.com>"
   ],
   "description": "Cardano transaction validation library",
-  "version": "0.1.0-beta.53",
+  "version": "0.1.0-beta.54",
   "license": "Apache-2.0",
   "files": [
     "node/cquisitor_lib_bg.wasm",